get_credential_by_id
Retrieve credential details by ID to access stored authentication information in Alteryx Server for workflow management and data integration tasks.
Instructions
Get the details of an existing credential
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| credential_id | Yes |
Implementation Reference
- src/tools.py:714-720 (handler)The core handler function that executes the tool logic by calling the Alteryx credentials API to retrieve the credential details by ID and formatting the response with pprint.
def get_credential_by_id(self, credential_id: str): """Get the details of an existing credential.""" try: api_response = self.credentials_api.credentials_get_credential(credential_id) return pprint.pformat(api_response) except ApiException as e: return f"Error: {e}" - src/mcp_server.py:340-344 (registration)Registers the get_credential_by_id tool with the MCP server using the @app.tool() decorator, which delegates execution to the handler in the tools class.
@self.app.tool() def get_credential_by_id(credential_id: str): """Get the details of an existing credential""" return self.tools.get_credential_by_id(credential_id)