v1

latestOpenAPI 3.0.32026-07-14314472448.6 KB
access_control
enterprise

Create a new custom role.

Creates a new custom role and maps given permissions to that role. Note that roles with the same prefix as Fixed Roles can’t be created.

You need to have a permission with action roles:write and scope permissions:type:delegate. permissions:type:delegate scope ensures that users can only create custom roles with the same, or a subset of permissions which the user has. For example, if a user does not have required permissions for creating users, they won’t be able to create a custom role which allows to do that. This is done to prevent escalation of privileges.

post/access-control/roles

Request body

descriptionstring
displayNamestring
globalboolean
groupstring
hiddenboolean
namestring
uidstring

Response

(empty)

createdstring date-time required
delegatableboolean
descriptionstring required
displayNamestring required
globalboolean
groupstring required
hiddenboolean
mappedboolean
namestring required
uidstring required
updatedstring date-time required
versioninteger required