roles
Update role
Updates a role. The same rule as creating a role applies: you cannot add or remove a permission you do not hold yourself. Only a signed-in account owner can take full ownership away from a role that people hold; an API key cannot. On a built-in role, only the name, color and description change; its permissions, features and scope stay fixed.
Notes.
- permissions, features and scope are stored as sent: the handler does not check their shape, so a malformed value is stored and read back as it was written.
- builtIn in the body is ignored.
- On the built-in Owner role, permissions, features and scope are ignored without an error; only name, color, description and character change. The other built-in roles edit like custom roles, except that permissions cannot be "all" (422).
patch/v1/roles/{id}
Request
- Base URL: https://api.brixsignage.com
- URL: https://api.brixsignage.com/v1/roles/{id}
- Auth: HTTP bearer
Path parameters
idstring required
Role id.
Request body
Response
Success.
Changes
No recorded changes to this operation across all 2 revisions of this API.