Rename a role
Requires MANAGE_ROLES. The everyone role cannot be renamed. User assignments and channel overwrites are migrated to the new ID. The preferred request field is newRoleID; name is accepted as a compatibility alias.
Request
POST http://localhost:8989/api/roles/{roleID}/rename
Path parameters
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| roleID | string | Role identifier. |
Required |
Request body
The request body takes a complete Rename Role Request resource, containing the following writable properties:
{
"name": "string",
"newRoleID": "string"
}Properties
| Name | Type | Description | Additional |
|---|---|---|---|
| name | string | Managed Identifier | Optional |
| newRoleID | string | Managed Identifier | Optional |
Authorisation
This request requires the use of one of following authorisation methods:
API key
.
Response
The following HTTP status codes may be returned, optionally with a response resource.
| Status code | Description | Resource |
|---|---|---|
| 200 | OK Role renamed. |
Role Mutation Response |
| 400 | Bad Request The request is invalid, references a missing resource, or conflicts with existing state. |
Error Response |
| 401 | Unauthorized The Authorization header is missing or malformed. |
Error Response |
| 403 | Forbidden The token is invalid or expired, or the requester lacks a required permission. |
Error Response |
| 500 | Internal Server Error The server could not complete the operation. |
Error Response |