1. Docs
  2. API Reference
  3. AdminRoleResponseDto

AdminRoleResponseDto

Example

JSON
{
  "id": "string",
  "name": "string",
  "description": "string",
  "is_system": false,
  "system_key": "string",
  "is_active": false,
  "scope": "account",
  "capabilities": [
    "string"
  ],
  "assignment_count": 0,
  "created_at": "2026-04-20T12:00:00.000Z",
  "updated_at": "2026-04-20T12:00:00.000Z"
}

Properties

11 properties 9 required

id string Required
name string Required
description string Optional
nullable
is_system boolean Required

Platform-seeded role versus custom

system_key string Optional

Stable identifier for a platform-seeded role; null for custom roles

nullable
is_active boolean Required
scope enum Required

Whether the role is granted account-wide or within one Environment

Enumaccountenvironment
capabilities array of string Required

Capability keys the role grants

assignment_count number Required

Live grants of this role across the whole Account, not just one Environment

created_at string Required
format: date-time
updated_at string Required
format: date-time
Was this page helpful?

Tell us how we can improve this guide.

Canopy