oauth

connect OAuth using client credentials

post/w/{workspace}/oauth/connect_client_credentials/{client}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/w/{workspace}/oauth/connect_client_credentials/{client}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Path parameters

workspacestring required
clientstring required

OAuth client name

Request body

scopesstring[]
cc_client_idstring

OAuth client ID. Omit to use the credentials configured on the provider's instance OAuth entry.

cc_client_secretstring

OAuth client secret. Omit to use the credentials configured on the provider's instance OAuth entry.

cc_instancestring

Instance name for built-in providers whose client-credentials token URL is instance-templated; substituted into the fixed-host registry template server-side. The token URL is never caller-supplied.

cc_token_urlstring

Bring-your-own token endpoint override. Only honored together with cc_client_id/cc_client_secret and mutually exclusive with cc_instance; rejected on the shared-instance path.

Response

OAuth token response

access_tokenstring required
expires_ininteger
refresh_tokenstring
scopestring[]
grant_typestring

Changes

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