The users role assignments endpoint implements functions to create, read, and delete the role assignments associated with user resources. For more information about roles and the permissions associated with each role, see Roles.
Role assignments are defined by the role itself, and at a more granular level by the scope
attribute associated with the role assignment. The role assignment scope identifies the type of platform resource that defines the scope, and the id
of the specific resource to which the scope applies. The following sample shows the scope
attribute, which includes the resource type
and id
attributes. In this case, the scope is restricted to the environment resource identified by its id
.
{
"scope": {
"id": "d928aa51-c194-4333-9cf5-0fd0c9b7d62f",
"type": "ENVIRONMENT"
}
}
Role assignment scope types include:
Organization
This scope type designates an organization resource as the assignment scope of the role.
Environment
This scope designates an environment resource as the assignment scope of the role.
Population
This scope designates a population resource as the assignment scope of the role. The maximum number of roles you can assign is 250.
Property | Type | Required? | Mutable? | Description |
---|---|---|---|---|
environment.id |
String | N/A | Read-only | Specifies the environment associated with the user. |
id |
String | N/A | Read-only | Specifies the user role assignment ID. |
readOnly |
Boolean | Optional | Mutable | Specifies whether this role assignment can be deleted by the current actor. |
role.id |
String | Required | Mutable | Specifies the role ID. |
scope.id |
String | Required | Mutable | Specifies the role assignment scope ID. |
scope.type |
String | Required | Mutable | Specifies the type of resource defining the scope of the Role assignment. Options are ORGANIZATION , ENVIRONMENT , and POPULATION . |
Code | Message |
---|---|
200 | Successful operation. |
201 | Successfully created. |
204 | Successfully removed. No content. |
400 | The request could not be completed. |
401 | You do not have access to this resource. |
404 | The requested resource was not found. |