M3m3ter-com
OrgUsers

Retrieve OrgUser Groups

Changed on

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

Request

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

inheritedboolean

Indicates whether or not to include inherited Groups.

  • TRUE - includes inherited groups.
  • FALSE - excludes inherited groups.

NOTE: See explanation above for details on how to use this parameter.

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

idstring required

The UUID of the entity.

versioninteger

The version number:

  • Create: On initial Create to insert a new entity, the version is set at 1 in the response.
  • Update: On successful Update, the version is incremented by 1 in the response.
namestring

The name of the Resource Group.

dtCreatedstring date-time

The date and time (in ISO-8601 format) when the Resource Group was created.

dtLastModifiedstring date-time

The date and time (in ISO-8601 format) when the Resource Group was last modified.

createdBystring

The unique identifier (UUID) of the user who created this Resource Group.

lastModifiedBystring

The unique identifier (UUID) of the user who last modified this Resource Group.

Changes

  • 85c514abc692Revision changes
    • breaking

      the response's property type changed from no type to object for status

    • info

      added the new optional query request parameter inherited

  • ac93d1a9e6d9Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added subschema #2 to the response body allOf list for the response status