API

Modify a user's group and role assignments

put
https://{hostname}/identity-management/v3/user-admin/ui-identities//auth-grants

This operation edits what groups a user has access to, and how the user interacts with the objects in those groups.

Path Params
string
required

Unique identifier for each user. To get this value, run the List users operation.

Query Params
string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Roles assigned to the user. You need to assign at least one role to the user, and each group allows only one role. Account level roles are optional.

The user's role assignments, per group. Provide either this or the cloneFrom.

integer
required
≥ 0

Unique identifier for each group. To get this value, run the List groups operation.

string
length ≥ 1

Descriptive label for the group.

boolean

Blocks a user's access to a group.

string
length ≥ 1

Descriptive label for the role to convey its use.

integer | null
required
≥ 1

Unique identifier for each role. To get this value, run the List roles operation. You need to assign at least one role to a user, with only one role allowed for the user per group. Setting the value to null in POST leaves the default role: either unassigned or cascaded from a parent group. For PUT, it clears the current assignment and reverts it to the default role.

string
length ≥ 1

Descriptive label for the role.

subGroups
array of objects
length ≥ 0

Children of the parent group. Permissions cascade downward from parent to child unless the child group's isBlocked is true.

subGroups
Response

Updated 4 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago