Remove one of the organization's domain claims

DELETE

/api/v1/organizations/{id}/domains/{domain}

Removes a domain claim from the organization; the bound connection stops routing and admitting that domain on the next login. Emits an sso.domain.removed audit row and returns 204; responds 404 when the organization holds no claim for that domain.

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.

Path Parameters

idstring Required

domainstring Required

Responses

Delete the claim. Sign-ins for that domain stop routing to the organization's connection on the next attempt.

application/json

errorApiErrorBodyDto*

application/json

errorApiErrorBodyDto*

application/json

errorApiErrorBodyDto*

Request

curl -X DELETE "https://auth.canopy-io.com/api/v1/organizations/value/domains/value" \
  -H "X-API-Key: $CANOPY_API_KEY"

Response

HTTP/1.1 204 Delete the claim. Sign-ins for that domain stop routing to the organization's connection on the next attempt.

(empty body)

GETList organizations
POSTCreate an organization
DELETEDelete every organization
GETGet an organization
PATCHUpdate an organization
DELETEDelete an organization
GETGet an organization's authentication policy
PATCHUpdate an organization's authentication policy
POSTRegenerate the organization's SSO recovery codes
POSTStart a test sign-in on the organization's connection
GETRead the organization's test sign-in
GETList the organization's domain claims
POSTClaim a domain for the organization
POSTVerify one of the organization's domains
GETList an organization's SSO connections
POSTBind an SSO connection to an organization
DELETEUnbind an SSO connection from an organization
GETList an organization's members
POSTAdd a member to an organization
PATCHChange a member's role
DELETERemove a member from an organization
GETList an organization's invitations
POSTInvite a member into an organization
GETList the roles an organization may assign
DELETERevoke an organization invitation
GETGet an organization's SSO connection
POSTSet up an organization's SSO connection
PATCHChange an organization's SSO connection
DELETERemove an organization's SSO connection
POSTActivate an organization's SSO connection
POSTDisable an organization's SSO connection
POSTImport the identity provider's SAML metadata
GETGet the service-provider values for an organization's SSO connection

Was this page helpful?

Tell us how we can improve this guide.