Update a Role |
Updates an existing role.
|
Note: For more information about this command, including descriptions of any path and request parameters, request body schema, response codes and schemas, and payload examples, refer to the online API reference for this command at the following web page: |
URI
https://bartendercloud.com/api/security/roles
|
Note: The bartendercloud.com domain that is referenced in the URI must be replaced with the contents of the DataCenterURI claim that is extracted from your access token. For more information, refer to Extracting the DataCenterURI Claim. |
Path Parameters
None.
Query Parameters
None.
Request Body Schema
RoleId
Type: String (or null)
Specifies the role identification.
BuiltIn
Type: Boolean
Specifies whether the role is a built-in BarTender Cloud role. True if the role is a built-in; false if otherwise.
Name
Type: String (or null)
Specifies the role name.
Description
Type: String (or null)
Specifies the role description.
Permissions
Type: Array of integers <int32> (or null)
Specifies the permissions for the role.