Remove a custom auth domain

DELETE

/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/auth-domain

Revokes the domain's certificate and deletes it. The Environment falls back to serving auth from the platform host.

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.

Responses

Custom auth domain removed

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}/applications/{appSlug}/environments/{envSlug}/auth-domain" \
  -H "Authorization: Bearer $CANOPY_TOKEN"

Response

HTTP/1.1 204 Custom auth domain removed

(empty body)

GETGet the environment's custom auth domain
POSTAdd a custom auth domain
POSTVerify a custom auth domain's DNS

Was this page helpful?

Tell us how we can improve this guide.