1. Docs
  2. API Reference
  3. Link an OAuth client to an end-user connection

Link an OAuth client to an end-user connection

POST/api/v1/sso/connections/{id}/oauth-clients/{clientId}

Links an end_user SSO connection to one of the Account's OAuth clients, storing the per-client placement config from the body. Every referenced placement target (each node and the default_role_id) must belong to the OAuth client's Environment, otherwise 400; setting is_default clears any other default for the same client in the same transaction. Returns 400 if the connection is not end_user-scope, 404 if the connection or client is not in the Account, emits an sso.connection.oauth_client.linked audit row, and returns 201.

Authentication

Bearer TokenAuthorization Option A

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

API KeyX-API-Key Option B

API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.

Requires permission sso.manageAccount

Create, update, and delete SSO connections, verified domains and SCIM tokens. A scoped API key must hold it as a scope; a full-access key holds every scope within its Environment except the named-only and account scopes; a developer's token needs the Console capability that covers it. A credential without it is refused with 403.

Path Parameters

idstring Required
clientIdstring Required

The OAuth client's `client_id`, as `/api/v1/oauth-clients` names it

Request body

application/json

is_defaultboolean Optional

Send every user of this client no verified domain routes straight to the IdP. At most one per client, and only in an Environment without organizations; refused with 409 once organizations are on, and on a connection an organization owns.

default_hierarchy_node_idstring Optional

Node a JIT'd identity lands at when no claim rule matches.

claim_node_mappingClaimNodeRuleDto[] Optional
default_role_idstring Optional

Role assigned to a JIT'd identity at the resolved node.

Responses

application/json

  • dataOAuthClientLinkResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs. A request refused by an authorization check answers 403 with the code authorization.denied, and its data names the denial_reason and the permission checked.

403authorization.deniedForbidden
When it happens

The credential does not hold the permission this operation checks: a scoped API key without the scope, a developer without the Console capability that covers it, or a permission granted somewhere other than the node the request targets. The error's data names the permission.

Remediation

Add the permission named in the Authentication section to the key's scopes, or ask an account administrator to grant the covering capability, then retry. For a node-scoped operation, make sure the grant reaches the node you are acting on.

Returned object

OAuthClientLinkResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/api/v1/sso/connections/value/oauth-clients/value" \
  -H "X-API-Key: $CANOPY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "is_default": false,
    "default_hierarchy_node_id": "string",
    "claim_node_mapping": [
      {
        "claim": "string",
        "value": "string",
        "node_id": "string",
        "is_array_match": false
      }
    ],
    "default_role_id": "string"
  }'
Response
{
  "data": {
    "oauth_client_id": "string",
    "client_id": {},
    "sso_connection_id": "string",
    "is_default": false,
    "default_hierarchy_node_id": "string",
    "claim_node_mapping": [
      {
        "claim": "string",
        "value": "string",
        "node_id": "string",
        "is_array_match": false
      }
    ],
    "default_role_id": "string",
    "created_at": "2026-04-20T12:00:00.000Z"
  }
}
 Related endpoints
GETList SSO connections
POSTCreate an SSO connection
GETGet an SSO connection
PATCHUpdate an SSO connection
DELETEDelete an SSO connection
POSTActivate an SSO connection
POSTDisable an SSO connection
GETList OAuth-client links for an end-user connection
PATCHUpdate an OAuth-client link
DELETEUnlink an OAuth client from a connection
GETList an OAuth client's SSO connection links
GETList Environments reachable by SSO
GETList Environment bindings for an end-user connection
POSTBind an end-user connection to an Environment
PATCHUpdate an Environment binding
DELETEUnbind an end-user connection from an Environment
GETList the organizations an end-user connection is bound to
POSTStart a test sign-in
GETRead a test sign-in
GETList a connection's recent login attempts
GETList SSO domain claims
POSTClaim a domain for admin SSO
POSTVerify a claimed domain
DELETERemove a domain claim
 Was this page helpful?

Tell us how we can improve this guide.

Canopy