List Group

List the groups.

GET /v1/groups

List Group

cURL

curl --request GET \
  --url https://iam.eu.confidence.dev/v1/groups \
  --header 'Authorization: Bearer <token>'

200

{
  "groups": [
    {
      "displayName": "<string>",
      "groupType": {},
      "createTime": {},
      "updateTime": {},
      "creator": "<string>",
      "updater": "<string>",
      "identity": "<string>",
      "name": "<string>",
      "description": "<string>",
      "labels": [
        {}
      ],
      "owner": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

pageSize · object

The maximum number of groups to fetch.

pageToken · string

Token used for pagination.

filter · string

Filtering for groups, follows the lucene query string format for example 'name: "groups/abc"', see Group type for available fields.

Response

200 - application/json

OK

groups · object[] · required

List of groups.

Show child attributes

nextPageToken · string

A token that can be used to fetch more groups, empty if no more groups are available.