Skip to main content
POST
Oauth Authorize

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspace
string
required

Slug of the workspace the request acts in

Maximum string length: 120
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Body

application/json

Start a sign-in for one MCP instance or one catalog API.

auto uses the operator's platform app when one serves the provider, else registers AgentArea with it (RFC 7591). custom uses an OAuth app the workspace registered with the provider, and overrides either.

catalog_item_id
string<uuid> | null

Catalog API to connect; the connection is created by this request.

client_id
string | null
Required string length: 1 - 512
client_id_secret_id
string<uuid> | null

Existing user-owned workspace secret containing the OAuth client ID.

client_secret
string | null
Required string length: 1 - 4096
client_secret_secret_id
string<uuid> | null

Existing user-owned workspace secret containing the OAuth client secret.

credential_mode
enum<string>
default:auto
Available options:
auto,
custom
instance_id
string<uuid> | null

MCP instance to sign in to.

return_to
string
default:""
Maximum string length: 2048
scopes
string[] | null

Scopes to ask for, among the preflight's scopes; omitted asks for its default_scopes.

Minimum array length: 1

Response

Successful Response

authorize_url
string
required
connection_id
string<uuid>
required