Revert this Environment from hierarchy to flat

POST

/api/v1/access-model/revert-to-flat

Collapses the request's Environment, in hierarchy mode, back to flat. Without organizations: surviving assignments are rebased onto the single root node and de-duplicated by identity and role (with effective-date windows merged so no identity loses access), expired assignments are dropped, and all non-root nodes are deleted bottom-up. With organizations enabled: the organizations and their memberships stay untouched, the nodes beneath them are deleted bottom-up, and the assignments made at those nodes are dropped (assignments_dropped_scoped) rather than widened to the organization or the root. Either way the hierarchy_schema is cleared and the access model is set to flat. Returns 200 with the summary; 400 when the Environment is already flat. Emits an application.hierarchy_reverted audit event.

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`).

Responses

application/json

dataRevertToFlatResponseDto*

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

RevertToFlatResponseDtoView all properties on this resource

Request

curl -X POST "https://auth.canopy-io.com/api/v1/access-model/revert-to-flat" \
  -H "X-Canopy-Environment: value" \
  -H "X-API-Key: $CANOPY_API_KEY"

Response

{
  "data": {
    "assignments_moved": 0,
    "assignments_deduplicated": 0,
    "assignments_expired_dropped": 0,
    "assignments_dropped_scoped": 0,
    "nodes_deleted": 0,
    "organizations_preserved": 0,
    "schema_cleared": false
  }
}

GETGet the Environment's access model
PUTSwitch the Environment's access model
PUTSwitch the Environment's organizations container on or off

Was this page helpful?

Tell us how we can improve this guide.