Auth Configs

Get single authentication configuration by ID

Changed on

Retrieves detailed information about a specific authentication configuration using its unique identifier.

get/api/v3.1/auth_configs/{nanoid}

Request

  • Base URL
    https://backend.composio.dev
  • URL
    https://backend.composio.dev/api/v3.1/auth_configs/{nanoid}
  • Auth
    • API key in header x-api-key
    • or API key in header x-user-api-key

Path parameters

nanoidstring authConfigId required

The unique identifier of the authentication configuration to retrieve

Response

Successfully fetched auth config

idstring authConfigId required

The unique ID of the authentication configuration

uuidstring required

The UUID of the authentication configuration (for backward compatibility)

type'default' | 'custom' required

The type of the authentication configuration (custom or default)

namestring required

The display name of the authentication configuration

auth_scheme'OAUTH2' | 'OAUTH1' | 'API_KEY' | 'BASIC' | 'BILLCOM_AUTH' | 'BEARER_TOKEN' | 'GOOGLE_SERVICE_ACCOUNT' | 'NO_AUTH' | 'BASIC_WITH_JWT' | 'CALCOM_AUTH' | 'SERVICE_ACCOUNT' | 'SAML' | 'DCR_OAUTH' | 'CIMD_OAUTH' | 'S2S_OAUTH2'

The authentication scheme used (e.g., OAuth2, API Key, etc.)

is_composio_managedboolean

Whether this authentication configuration is managed by Composio or the user

credentialsobject

The authentication credentials (tokens, keys, etc.) - may be partially hidden for security

status'ENABLED' | 'DISABLED' required

Current status of the authentication configuration

created_bystring

The identifier of the user who created the auth config

created_atstring

ISO 8601 date-time when the auth config was created

last_updated_atstring

ISO 8601 date-time when the auth config was last updated

no_of_connectionsnumber required

The number of active connections using this auth config

restrict_to_following_toolsstring[]

List of tool slugs this auth config is restricted to use with. DEPRECATED: use Get required scopes to resolve the scopes for the tools you need, then pass those scopes in credentials.scopes.

shared_credentialsobject

Shared credentials that will be inherited by all connected accounts using this auth config. DEPRECATED: use shared_connection_fields instead. It takes the same value and behaves the same way.

shared_connection_fieldsobject

Connection field values inherited by every connected account created under this auth config. Same value as shared_credentials; secret values are redacted.

is_enabled_for_tool_routerboolean

Whether this auth config is enabled for tool router

Changes

  • 98956f31abf3Revision changes
    • breaking

      the / response's property type changed from no type to object for status

    • warning

      added the new CIMD_OAUTH enum value to the response property for the response status

    • info

      api operation id getV3_1AuthConfigsByNanoid removed and replaced with getAuthConfigsByNanoid

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      response property shared_credentials deprecated

    • info

      response property tool_access_config deprecated

    • info

      response property tool_access_config/tools_available_for_execution deprecated

    • info

      response property tool_access_config/tools_for_connected_account_creation deprecated

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

  • 1d3aac1128efRevision changes
    • warning

      removed the optional property from the response with the status