v1
protected
mcp-oauth-connect

Oauth Authorize

Initiate MCP OAuth flow and return the URL to send the user to.

  1. Look up the MCP instance's remote URL
  2. Discover the authorization server (RFC 9728 → RFC 8414)
  3. Register dynamically (RFC 7591), or take the workspace's own OAuth app
  4. Persist the client credentials on an auth config
  5. Generate PKCE pair and state, and build the authorization URL
post/v1/workspaces/{workspace}/mcp-oauth/authorize

Path parameters

workspacestring required

Slug of the workspace the request acts in

Slug of the workspace the request acts in

Request body

client_idstring nullable
client_id_secret_idstring uuid nullable

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

client_secretstring nullable
client_secret_secret_idstring uuid nullable

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

credential_mode'auto' | 'custom'
instance_idstring uuid required
return_tostring

Response

Successful Response

object required

Changes

Changed in 1 of the 45 revisions of this API.1