update_role
Modify an existing role's details such as display name, description, external authentication ID, and permissions in BookStack.
Instructions
Update an existing role
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| description | No | Role description | |
| display_name | No | Display name for the role | |
| external_auth_id | No | External authentication ID | |
| id | Yes | Role ID | |
| permissions | No | Array of permission names to assign to the role (replaces existing) |
Input Schema (JSON Schema)
{
"properties": {
"description": {
"description": "Role description",
"type": "string"
},
"display_name": {
"description": "Display name for the role",
"type": "string"
},
"external_auth_id": {
"description": "External authentication ID",
"type": "string"
},
"id": {
"description": "Role ID",
"type": "number"
},
"permissions": {
"description": "Array of permission names to assign to the role (replaces existing)",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"id"
],
"type": "object"
}