Britive platform release 2026.09.02 is now live in production.

Press CTRL+K to open search

Checkout credentials for a given tool id or name

Prev Next
Post
/api/mcp-manager/access/{toolIdentifier}/checkout
Security
HTTP
Type bearer
Path parameters
toolIdentifier
stringRequired

Tool id or name of the tool.

Body parameters
object
userId
string
Responses
200

Checkout successful

Expand All
object
responseDtos
Array of object (McpCheckoutResponseDto)
object
txId
string

Transaction ID for Britive credential checkout (APP_PROFILE, RESOURCE_PROFILE, SECRET). Absent for type=OAUTH -- use the provider accessToken directly.

type
string

Credential type. OAUTH for downstream OAuth servers; APP_PROFILE, RESOURCE_PROFILE, SECRET or CUSTOM for Britive checkout.

provider
object

For OAUTH: accessToken, mcpEndpoint, tokenType, expiresAt. For Britive types: provider-specific metadata.

property*
object additionalProperties
status
string

Present when the checkout cannot proceed immediately. oauth_required means the user must obtain an OAuth token for this server (call GET /oauth//token) before retrying checkout.

backendId
string

Server identifier. Present when status=oauth_required so the caller knows which backend to request a token for.

202

OAuth consent required -- call GET /oauth//token to obtain a token.

Expand All
object
responseDtos
Array of object (McpCheckoutResponseDto)
object
txId
string

Transaction ID for Britive credential checkout (APP_PROFILE, RESOURCE_PROFILE, SECRET). Absent for type=OAUTH -- use the provider accessToken directly.

type
string

Credential type. OAUTH for downstream OAuth servers; APP_PROFILE, RESOURCE_PROFILE, SECRET or CUSTOM for Britive checkout.

provider
object

For OAUTH: accessToken, mcpEndpoint, tokenType, expiresAt. For Britive types: provider-specific metadata.

property*
object additionalProperties
status
string

Present when the checkout cannot proceed immediately. oauth_required means the user must obtain an OAuth token for this server (call GET /oauth//token) before retrying checkout.

backendId
string

Server identifier. Present when status=oauth_required so the caller knows which backend to request a token for.

404

Not Found