BEbeyondidentity
Groups

List Groups for a Realm

To list all groups for a realm, send a GET request to /v1/tenants/$TENANT_ID/realms/$REALM_ID/groups.

The response will contain at most 200 items and may contain a page token to query the remaining items. If page size is not specified, the response will contain 20 items. There is no defined ordering of the list of groups in the response. Note that the maximum and default page sizes are subject to change.

When paginating, the page size is maintained by the page token but may be overridden on subsequent requests. The skip is not maintained by the page token and must be specified on each subsequent request.

Page tokens expire after one week. Requests which specify an expired page token will result in undefined behavior.

get/v1/tenants/{tenant_id}/realms/{realm_id}/groups

Request

Path parameters

tenant_idstring required
Example:000176d94fd7b4d1

A unique identifier for a tenant.

realm_idstring required
Example:19a95130480dfa79

A unique identifier for a realm.

Query parameters

page_sizeinteger

Number of items returned per page. The response will include at most this many results but may include fewer. If this value is omitted, the response will return the default number of results allowed by the method.

page_tokenstring

Token to retrieve the subsequent page of the previous request. All other parameters to the list endpoint should match the original request that provided this token unless otherwise specified.

skipinteger

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

Response

The response will be a JSON object with keys for groups and total_size. groups will be set to an array of group objects, each of which contains the standard group attributes. total_size will be set to the total number of items matched by the list request. If there are more items to be returned by the requested query, the response will also contain a key called next_page_token.

total_sizeinteger required

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.

next_page_tokenstring

Token used to fetch the next set of results. If this field is omitted, there are no subsequent pages.

Example response

{
  "groups": [
    {
      "id": "81490afab171aef0",
      "realm_id": "7df92e4a38ba0993",
      "tenant_id": "0001b42d80372976",
      "display_name": "Realm Administrators",
      "description": "A group of realm administrators.",
      "create_time": "2022-03-14T03:42:52.905657Z",
      "update_time": "2022-06-14T05:55:23.823187Z"
    }
  ],
  "total_size": 1000
}

Changes

No recorded changes to this operation across all 2 revisions of this API.