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

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/access-control/roles
  • Auth
    • HTTP basic
    • or API key in header Authorization

Request body

descriptionstring
displayNamestring
globalboolean
groupstring
hiddenboolean
namestring
uidstring
versioninteger

Response

(empty)

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

Changes

No recorded changes to this operation across all 2 revisions of this API.