OrgUsers
Retrieve OrgUser Groups
Retrieve a list of User Groups for an OrgUser.
Retrieves a list of all User Groups that a specific user belongs to within an Organization. The list can be paginated for easier management.
Notes:
- User Groups as Resource Groups. A User Group is a Resource Group - one used to group resources of type user. You can use the Create ResourceGroup call detailed in the ResourceGroup section to create a User Resource Group, and then use the Add Item and Remove Item calls to manage which Users belong to the User Resource Group.
- Using the inherited parameter for the Retrieve OrgUser Groups call. Resource Groups can be nested, which means a User Resource Group can contain another User Resource Group as a member. You can use the inherited parameter with this Retrieve OrgUser Groups call as a QUERY PARAMETER to control which User Resource Groups are returned:
- If the user specified belongs to a User Resource Group that is nested as part of another User Resource Group:
- If inherited = TRUE, then any Groups the user belongs to AND any parent Groups those Groups belong to as nested Groups are returned.
- If inherited = FALSE, then only those User Resource Groups to which the user belongs are returned.
get/organizations/{orgId}/users/{id}/usergroups
Path parameters
orgIdstring required
The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.
idstring required
The unique identifier (UUID) of the user.
Query parameters
pageSizeinteger
Specifies the maximum number of User Groups to retrieve per page.
nextTokenstring
The nextToken for multi-page retrievals. It is used to fetch the next page of User Groups in a paginated list.
Response
Returns a list of User Groups