BEbeyondidentity
Users

List all groups for a user

To list all groups for a user, send a GET request to /v2/users/$USER_ID/groups.

NOTE: This only returns groups that the user is a direct member of.

The response will have up to 1000 items. The response will be empty if the page size is not specified (i.e., the default). By default, the list is in ascending order by create_time. The maximum and default page sizes are subject to change.

When paginating, use the skip parameter as the offset.

get/v2/users/{user_id}/groups

Request

Path parameters

user_idstring required
Example:25f94daf-63d8-4b40-b0ea-4843971d1d8e

A unique identifier for a user.

Query parameters

page_sizeinteger

The number of items returned per page. The response may include this exact number or fewer. If omitting this value, the response returns the default number of results the method allows.

skipinteger

Number of items to skip. This is the zero-based index of the first result.

Response

The response is a JSON object with groups and total_size keys. <br />

  • groups is set to an array of group objects containing standard group attributes.
  • total_size is set to the total number of items matched by the list request. If more items are to be returned by the requested query, make another request using the skip query parameter.
total_sizeinteger required

The total number of results returned by the operation. This value may be larger than the number of resources returned, such as when returning a single page where multiple pages are available.

Example response

{
  "groups": [
    {
      "id": "25f94daf-63d8-4b40-b0ea-4843971d1d8e",
      "create_time": "2022-04-12T05:53:07.119Z",
      "update_time": "2022-06-16T14:31:03.770Z",
      "tenant_id": "acme-corp",
      "name": "Acme Group",
      "description": "Members of the Acme Group",
      "source": "scim"
    }
  ],
  "total_size": 1000
}

Changes

No recorded changes to this operation across all 1 revision of this API.