Remove a domain claim

DELETE

/portal/v1/accounts/{accountSlug}/sso/domains/{domain}

Removes a domain claim from the Account; any connection routing on that domain stops matching it on the next login. Emits an sso.domain.removed audit row and returns 204; responds 404 when no claim with that domain exists in the Account.

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

domainstring Required

Responses

Delete a domain claim. Connections listing it stop routing for that domain on the next login.

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.

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/{accountSlug}/sso/domains/value" \
  -H "Authorization: Bearer $CANOPY_TOKEN"

Response

HTTP/1.1 204 Delete a domain claim. Connections listing it stop routing for that domain on the next login.

(empty body)

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
DELETEUnbind an end-user connection from an Environment
GETList the organizations an end-user connection is bound to
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

Was this page helpful?

Tell us how we can improve this guide.