Update role
Update a custom role. System roles cannot be updated. Use to modify permissions or metadata.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | UUID | Yes | Role identifier |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
displayName | string | No | Human-readable display name (1-100 chars) |
description | string | No | Role description (max 500 chars) |
permissions | array of string | No | Array of permission IDs (min 1 item if provided) |
Use Cases
- Add or remove permissions from custom role
- Update role name or description
- Adjust role for changing requirements
Required Permission
roles:update
Update role
Update a custom role. System roles cannot be updated. Use to modify permissions or metadata.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | UUID | Yes | Role identifier |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
displayName | string | No | Human-readable display name (1-100 chars) |
description | string | No | Role description (max 500 chars) |
permissions | array of string | No | Array of permission IDs (min 1 item if provided) |
Use Cases
- Add or remove permissions from custom role
- Update role name or description
- Adjust role for changing requirements
Required Permission
roles:update