KEkeycardai
Zone Roles

Get role

Changed on

Returns details of a specific role by ID

get/zones/{zoneId}/roles/{roleId}

Request

  • Base URL
    https://docs.keycard.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://docs.keycard.ai/zones/{zoneId}/roles/{roleId}
  • Auth
    • HTTP bearer
    • or OAuth 2
      Client credentials
      Token URL: /service-account-token

Path parameters

zoneIdstring required

Zone ID

roleIdstring required

Role ID

Response

A role that can be assigned to users within a zone.

idstring required

Unique identifier of the role

zone_idstring required

Zone this role belongs to

identifierstring required

Role identifier: a lowercase slug (letters and digits separated by single hyphens or underscores), unique per owner type within a zone. Role identifiers surface in policy evaluation, so the slug restriction keeps them unambiguous in policy text.

descriptionstring nullable

Human-readable description

owner_type'platform' | 'customer' required

Who owns this role. Platform-owned roles are managed by Keycard and cannot be modified or deleted via the API; customer-owned roles are user-created.

created_atstring date-time required

Entity creation timestamp

updated_atstring date-time required

Entity update timestamp

Changes