1. Docs
  2. API Reference
  3. Switch the Environment's organizations container on or off

Switch the Environment's organizations container on or off

PUT/api/v1/access-model/organizations

Switches the organizations container of the request's Environment on or off with { enabled }. The container is independent of the access model: a flat Environment holds one membership role per identity per organization, a hierarchy Environment hangs its tree beneath each organization. Enabling reserves the tier directly under the root for organizations, so it returns 409 while nodes already sit there (revert to flat first) and 400 while a hierarchy schema is not rooted at organization. Disabling returns 409 while organizations remain (delete them first) or while a hierarchy schema is configured (revert to flat first). A no-op when the setting is unchanged. Emits environment.organizations_enabled or environment.organizations_disabled.

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.

Requires permission hierarchy.manageHierarchy

Create, update, and delete hierarchy nodes. A scoped API key must hold it as a scope; a full-access key holds every scope within its Environment except the named-only and account scopes; a developer's token needs the Console capability that covers it. A credential without it is refused with 403.

Headers

  • X-Canopy-Environment

    The id of the Environment this request acts in. Required with an account API key, which belongs to the Account and names its Environment per request; an Environment key may send it only to name its own Environment. A missing header for an account key answers `400` (`api_key.environment_required`), one naming no Environment of the key's Account `400` (`api_key.environment_not_found`), and one naming another Environment than an Environment key's own `400` (`api_key.environment_mismatch`).

Request body

application/json

enabledboolean Required

`true` to reserve the tier under the root for organizations; `false` to switch the container off (requires an empty container and a flat Environment).

Responses

application/json

  • dataEnvironmentResponseDto*

application/json

  • errorApiErrorBodyDto*

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, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs. A request refused by an authorization check answers 403 with the code authorization.denied, and its data names the denial_reason and the permission checked.

403authorization.deniedForbidden
When it happens

The credential does not hold the permission this operation checks: a scoped API key without the scope, a developer without the Console capability that covers it, or a permission granted somewhere other than the node the request targets. The error's data names the permission.

Remediation

Add the permission named in the Authentication section to the key's scopes, or ask an account administrator to grant the covering capability, then retry. For a node-scoped operation, make sure the grant reaches the node you are acting on.

Returned object

EnvironmentResponseDtoView all properties on this resource
Request
curl -X PUT "https://auth.canopy-io.com/api/v1/access-model/organizations" \
  -H "X-Canopy-Environment: value" \
  -H "X-API-Key: $CANOPY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": false
  }'
Response
{
  "data": {
    "id": "string",
    "application_id": "string",
    "name": "string",
    "slug": "string",
    "is_production": false,
    "settings": {},
    "version": 0,
    "created_at": "2026-04-20T12:00:00.000Z",
    "updated_at": "2026-04-20T12:00:00.000Z"
  }
}
 Related endpoints
GETGet the Environment's access model
PUTSwitch the Environment's access model
POSTRevert this Environment from hierarchy to flat
 Was this page helpful?

Tell us how we can improve this guide.

Canopy