1. Docs
  2. API Reference
  3. OrganizationRoleDetailResponseDto

OrganizationRoleDetailResponseDto

Example

JSON
{
  "id": "string",
  "name": "string",
  "scope": "environment",
  "organization_node_id": "string",
  "organization_name": "string",
  "template_id": "string",
  "description": "string",
  "is_system_role": false,
  "system_key": "string",
  "is_active": false,
  "created_at": "2026-04-20T12:00:00.000Z",
  "updated_at": "2026-04-20T12:00:00.000Z",
  "version": 0,
  "permission_count": 0,
  "member_count": 0,
  "administers": false,
  "permissions": [
    {
      "id": "string",
      "application_id": "string",
      "key": "string",
      "name": "string",
      "description": "string",
      "category": "string",
      "source": "system",
      "created_at": "2026-04-20T12:00:00.000Z",
      "version": 0
    }
  ],
  "holder_count": 0,
  "pending_invite_count": 0
}

Properties

19 properties 11 required

id string Required
name string Required
scope enum Required

`environment`: assignable in every organization. `organization`: belongs to the organization `organization_node_id` names and is held only inside it.

Enumenvironmentorganization
organization_node_id string Optional

The organization this role belongs to; null for an Environment role.

nullable
organization_name string Optional

The name of the organization this role belongs to. Populated on list responses; null for an Environment role.

nullable
template_id string Optional

The organization role template this role was copied from; null for a role made by hand, or once its template is deleted.

nullable
description string Optional
nullable
is_system_role boolean Required
system_key string Optional
nullable
is_active boolean Required
created_at string Required
format: date-time
updated_at string Required
format: date-time
version number Required

Optimistic-lock version. Send back as the `If-Match` header when updating to detect concurrent edits.

permission_count number Optional

Number of permissions currently assigned to this role. Populated on list responses; omitted on single-role responses where the join isn't computed.

member_count number Optional

Number of distinct identities assigned this role. Populated on list responses; omitted on single-role responses where the join isn't computed.

administers boolean Optional

Whether the role carries `canopy:organization.manage`, `canopy:access.manage` or `canopy:roles.manage`, which an organization's integration may never hold. Populated on list responses.

permissions array of PermissionResponseDto Required
holder_count number Required

How many people in the organization hold this role at the organization node or anywhere beneath it, each counted once

pending_invite_count number Required

How many of the organization's pending invitations offer this role; deleting the role revokes them

Was this page helpful?

Tell us how we can improve this guide.

Canopy