ListUserGroups

GET

/api/v2/user-groups

Query Parameters

`pageSize`integer

The maximum number of user groups to return. The service may return fewer than this value. If unspecified, at most 50 will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Format: "int64"

`pageToken`string

A page token, received from a previous ListUserGroups call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListUserGroups must match the call that provided the page token.

`filter`string

A Common Expression Language (CEL, https://github.com/google/cel-spec) filter string. Available tag variables are:

name

`orderBy`string

How to order the retrieved user groups. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are:

created_date
modified_date

curl -X GET "<API_URL>/api/v2/user-groups?pageSize=0&pageToken=string&filter=string&orderBy=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "userGroups": [
    {
      "userGroupId": "string",
      "name": "string",
      "roleId": "string",
      "isDefault": true,
      "resources": {
        "assetIds": [
          "string"
        ],
        "allAssets": true
      },
      "userIds": [
        "string"
      ]
    }
  ],
  "nextPageToken": "string"
}

Query Parameters

pageSizeinteger

pageTokenstring

filterstring

orderBystring

Response

`pageSize`integer

`pageToken`string

`filter`string

`orderBy`string