Sign in
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}

Path parameters

zoneIdstring required

Zone ID

roleIdstring required

Role ID

Request body

descriptionstring nullable

Human-readable description (set to null to unset)

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

Changed in 2 of the 23 revisions of this API.4

  • d65d51379d933See the full diff
    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      the identifier response's property pattern ^[a-z0-9]+(?:[-_][a-z0-9]+)*$ was added for the status 200

      response-property-pattern-added

  • 7e0e4fa2e16f1See the full diff
    • ○

      endpoint added

      endpoint-added