Connectors

Claim connector OAuth flow

Redeems the connector grant parked by the browser callback. Persistence is bound to the authenticated user that started the flow.

post/v1/connections/{name}/claim

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /v1/connections/{name}/claim
  • Auth: HTTP bearer

Path parameters

namestring required

Connector slug.

Example:canvas

Connector slug, for example canvas, corinthian, or wispr.

Request body

statestring required

Opaque one-time OAuth state/session ticket.

Example request

{
  "state": "state_abc123"
}

Response

Connector connected.

audiencestring

Audience accepted by the product resource server.

connectedboolean required

Whether the connector is now connected.

connectionIdstring

Stable connection UUID used in product-side revocation checks.

connectorstring

Connector slug.

scopesstring[]

Scopes granted by the completed consent flow.

Example response

{
  "audience": "mcp:canvas",
  "connected": true,
  "connectionId": "123e4567-e89b-12d3-a456-426614174000",
  "connector": "canvas",
  "scopes": [
    "canvas:invoices.read"
  ]
}

Changes

No recorded changes to this operation across all 50 revisions of this API.