1. Docs
  2. API Reference
  3. Unbind an end-user connection from an Environment

Unbind an end-user connection from an Environment

DELETE/portal/v1/accounts/{accountSlug}/sso/connections/{id}/environments/{environmentId}

Removes the binding between an end_user SSO connection and an Environment, leaving both records intact. Emits an sso.connection.environment.unlinked audit row and returns 204; responds 404 when the binding does not exist, and 409 (sso.environment_link_owned_cannot_unlink) when an organization in that Environment set the connection up itself, since it stays linked there: disable or delete it instead.

Authentication

Bearer TokenAuthorization

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

Requires capability sso.manageSecurity

Manage SSO connections, domains, and directory sync. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Path Parameters

accountSlugstring Required

The Account's slug. An unknown one answers 404.

idstring Required
environmentIdstring Required

Responses

Remove the binding; that Environment stops routing to this connection.

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.

403account.capability_requiredForbidden
When it happens

The signed-in user's administrator roles do not grant the capability this endpoint requires.

Remediation

Ask an account administrator to grant a role carrying the capability named in the Authentication section, then retry.

Request
curl -X DELETE "https://auth.canopy-io.com/portal/v1/accounts/value/sso/connections/value/environments/value" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
HTTP/1.1 204 Remove the binding; that Environment stops routing to this connection.

(empty body)
 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
POSTLink an OAuth client to an end-user connection
PATCHUpdate an OAuth-client link
DELETEUnlink an OAuth client from a connection
GETList Environment bindings for an end-user connection
POSTBind an end-user connection to an Environment
PATCHUpdate an Environment binding
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 an OAuth client's SSO connection links
GETList Environments reachable by SSO
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