1. Docs
  2. API Reference
  3. RoleResponseDto

RoleResponseDto

Example

JSON
{
  "id": "string",
  "application_id": "string",
  "name": "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
}

Properties

12 properties 8 required

id string Required
application_id string Required
name string Required
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.

Was this page helpful?

Tell us how we can improve this guide.

Canopy