OrganizationMeResponseDto

Example

JSON

{
  "administers_organization": false,
  "access_roots": [
    {
      "node_id": "string",
      "name": "string",
      "node_type": "string",
      "path": [
        "string"
      ]
    }
  ],
  "structure_roots": [
    {
      "node_id": "string",
      "name": "string",
      "node_type": "string",
      "path": [
        "string"
      ]
    }
  ],
  "roles_roots": [
    {
      "node_id": "string",
      "name": "string",
      "node_type": "string",
      "path": [
        "string"
      ]
    }
  ],
  "has_hierarchy": false
}

Properties

5 properties 5 required

administers_organization boolean Required

Holds `canopy:organization.manage` at the organization node, or is the developer's key

access_roots array of OrganizationAuthorityRootDto Required

The topmost nodes where `canopy:access.manage` is held inside the organization; the organization node when `administers_organization`

structure_roots array of OrganizationAuthorityRootDto Required

The same for `canopy:structure.manage`, a key no role carries yet; always empty

roles_roots array of OrganizationAuthorityRootDto Required

The same for `canopy:roles.manage`, a key no role carries yet; always empty

has_hierarchy boolean Required

Whether the Environment's schema allows nodes beneath an organization; false in a flat Environment, where the organization is its only node

Was this page helpful?

Tell us how we can improve this guide.