|
Property
|
Description
|
Usage
|
Valid Values
|
|
"name"
|
The name of the role.
|
Required
|
System Administrator | User | Tenant Administrator | custom_role
custom_role is the name of a role created by an administrator.
|
|
"tenantId"
|
The ID of the tenant to which the role belongs. If not specified, the role is created in the tenant to which the user belongs.
|
Optional
|
A valid tenant ID.
|
|
"description"
|
The description of the role.
|
Optional
|
System Administrator role has all permissions. This role cannot be deleted, and only the users associated with it via the "users" property can be modified. Other properties, such as "name" and "permissions," cannot be modified.
User role has all permissions associated with a user who might query data sources directly. This role cannot be deleted, and only the users associated with it via the "users" property can be modified. Other properties, such as "name" and "permissions," cannot be modified.
Tenant Administrator role has user permissions and permissions associated with provisioning users. This role cannot be deleted, and only the users associated with it via the "users" property can be modified. Other properties, such as "name" and "permissions," cannot be modified.
Optionally, administrators can provide a description for any roles they create.
|
|
"permissions"
|
A list of permissions associated with the role.
|
Required
|
A comma-separated list of permission IDs. See Administrator Permissions API for details.
While this property must be included in the request payload, an empty array can be passed.
|
|
"users"
|
A list of users granted the role.
|
Required
|
A comma-separated list of user IDs.
Note: The users property must be included in the payload, but an empty array can be passed.
|