Skip to content
Docs
Roles
Update

Update role

API Reference
Zones
Roles

Update role

zones.roles.update(strrole_id, RoleUpdateParams**kwargs) -> Role
PATCH/zones/{zoneId}/roles/{roleId}

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

ParametersExpand Collapse
zone_id: str
role_id: str
description: Optional[str]

Human-readable description (set to null to unset)

maxLength1000
ReturnsExpand Collapse
class Role: …

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

id: str

Unique identifier of the role

created_at: datetime

Entity creation timestamp

formatdate-time
identifier: str

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.

minLength1
maxLength255
owner_type: Literal["platform", "customer"]

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.

Accepts one of the following:
"platform"
"customer"
updated_at: datetime

Entity update timestamp

formatdate-time
zone_id: str

Zone this role belongs to

description: Optional[str]

Human-readable description

maxLength1000

Update role

import os
from keycardai_api import KeycardAPI

client = KeycardAPI(
    api_key=os.environ.get("KEYCARD_API_API_KEY"),  # This is the default and can be omitted
)
role = client.zones.roles.update(
    role_id="roleId",
    zone_id="zoneId",
)
print(role.id)
{
  "id": "id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "identifier": "identifier",
  "owner_type": "platform",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "zone_id": "zone_id",
  "description": "description"
}
Returns Examples
{
  "id": "id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "identifier": "identifier",
  "owner_type": "platform",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "zone_id": "zone_id",
  "description": "description"
}