Delete every organization
/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/organizationsDeletes every live organization in the Environment the way the single delete does: memberships and every assignment beneath each organization are removed, pending invitations bound to the organization or its tree are revoked, and each organization is soft-deleted with its subtree. Member identities are untouched. This is the step before switching the container off. Responds 204 No Content, requires the hierarchy.manage permission, and emits organization.deleted_all with the counts.
Authentication
AuthorizationJWT access token. Never send alongside X-API-Key: a request carrying both is refused.
env_organizations.manageDeveloper ConsoleSwitch the organizations container on and off and create, rename, and delete organizations. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.
Responses
Every organization deleted with its memberships, pending invitations, and subtree
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}/applications/{appSlug}/environments/{envSlug}/organizations" \ -H "Authorization: Bearer $CANOPY_TOKEN"
HTTP/1.1 204 Every organization deleted with its memberships, pending invitations, and subtree (empty body)
Tell us how we can improve this guide.