Create Role
Create a new role in the system.
HTTP Method | URL | Requires Auth |
---|---|---|
|
|
This endpoint doesn't update existing roles. See Update Role.
You can't create new roles with the same name as existing roles. For example, it is not possible to create a new role with the name
admin
.The scope can either be
Users
orSubscriptions
.
Body Parameters
Key | Example Value | Description |
---|---|---|
|
| The name of the new role. |
|
| The scope of the new role. The default value is |
|
| A description for the new role. |
|
| Whether the role should have mandatory 2FA. The default value is |
Example Call
Example Response
Success
Error
Any of the following errors can occur:
Authorization: Requires an authentication token for the request to be made.
Invalid Role Properties: Occurs when the required payload arguments are not provided when making the request.
Duplicate Role Names: This occurs when the role's name already exists on the workspace.
Change Log
Version | Description |
---|---|
0.70.0 | Added |
3.15.0 | Is no longer used to update roles |
6.0.0 | Moved to enteprise edition. |
Last updated