v22

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-01140308542.4 KB

Zone Roles

Update role

Updates a customer-owned role's description. The identifier is immutable, and platform-owned roles cannot be modified.

patch/zones/{zoneId}/roles/{roleId}

zoneIdstring required

Zone ID

roleIdstring required

Role ID

descriptionstring nullable

Human-readable description (set to null to unset)

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

Opaque role identifier. Treated as an opaque identifier by the API and unique within a zone.

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