AGagentarea
v1
protected
oauth-connect

Oauth Authorize

Changed on

Start a sign-in and return the provider's authorization URL to send the user to.

post/v1/workspaces/{workspace}/oauth/authorize

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Path parameters

workspacestring required

Slug of the workspace the request acts in

Request body

catalog_item_idstring uuid nullable

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

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 nullable

MCP instance to sign in to.

return_tostring

Response

Successful Response

authorize_urlstring required
connection_idstring uuid required

Changes