Connected Accounts

Revoke a connected account at the provider

Changed on

Best-effort upstream revocation. On success, the connection transitions to REVOKED. Returns 400 when the toolkit does not support programmatic revocation, 409 when the connection is not in a revokable state, 500 when every upstream dispatch fails.

post/api/v3.1/connected_accounts/{nanoid}/revoke

Request

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

Path parameters

nanoidstring connectedAccountId required

The unique identifier of the connected account

Response

Connection revoked. revoked_tokens reports which subjects were killed at the provider on this call; an empty array indicates the connection was already revoked.

revoked_tokensstring[] required

Tokens revoked at the provider on this call. Empty array means the connection was already revoked (no upstream dispatch).

Example response

{
  "revoked_tokens": [
    "access_token",
    "refresh_token"
  ],
  "connected_account": {
    "id": "ca_1a2b3c4d5e6f",
    "status": "REVOKED"
  }
}

Changes

  • 98956f31abf3Revision changes
    • info

      api operation id postV3_1ConnectedAccountsByNanoidRevoke removed and replaced with postConnectedAccountsByNanoidRevoke

    • info

      api tag Authentication removed

  • 589a7d115a5eRevision changes
    • info

      the endpoint scheme security CookieAuth was removed from the API

    • info

      the endpoint scheme security UserApiKeyAuth was removed from the API