1. Docs
  2. API Reference
  3. SetupSummaryItemDto

SetupSummaryItemDto

Example

JSON
{
  "application_id": "string",
  "application_slug": "string",
  "environment_id": "string",
  "environment_slug": "string",
  "has_permissions": false,
  "has_roles": false,
  "has_role_permissions": false,
  "is_complete": false,
  "nodes_count": 0,
  "roles_count": 0,
  "permissions_count": 0,
  "identities_count": 0
}

Properties

12 properties 12 required

application_id string Required
application_slug string Required
environment_id string Required
environment_slug string Required
has_permissions boolean Required

≥ 1 custom permission in the env

has_roles boolean Required

≥ 1 custom (non-system) role in the env

has_role_permissions boolean Required

≥ 1 role-permission mapping on a custom role in the env

is_complete boolean Required

True when all three has_* flags are true

nodes_count number Required

Hierarchy nodes in the env

roles_count number Required

Custom (non-system) roles in the env

permissions_count number Required

Custom (source = 'custom') permissions in the env

identities_count number Required

Distinct identities with ≥ 1 role assignment on a node in this env

Was this page helpful?

Tell us how we can improve this guide.

Canopy