Unbind an end-user connection from an Environment
/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.
Authentication
AuthorizationJWT access token. Never send alongside X-API-Key: a request carrying both is refused.
sso.manageSecurityManage 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
idstring Required environmentIdstring Required Responses
Remove the binding; that Environment stops routing to this connection.
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.
account.capability_requiredForbiddenThe signed-in user's administrator roles do not grant the capability this endpoint requires.
Ask an account administrator to grant a role carrying the capability named in the Authentication section, then retry.
curl -X DELETE "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/sso/connections/value/environments/value" \ -H "Authorization: Bearer $CANOPY_TOKEN"
HTTP/1.1 204 Remove the binding; that Environment stops routing to this connection. (empty body)
Tell us how we can improve this guide.