Skip to main content
GET
/
api
/
v2
/
user-groups
ListUserGroups
curl --request GET \
  --url https://your-sift-api-url.com/api/v2/user-groups \
  --header 'Authorization: Bearer <token>'
{
  "userGroups": [
    {
      "name": "<string>",
      "isDefault": true,
      "isExternal": true,
      "userGroupId": "<string>",
      "roleId": "<string>",
      "resources": {
        "allAssets": true,
        "assetIds": [
          "<string>"
        ]
      },
      "userIds": [
        "<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
integer<int64>

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.

​
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 name, created_date, and modified_date. If left empty, items are ordered by name in ascending order (A-Z). For more information about the format of this field, read this Example: "created_date desc,modified_date"

Response

A successful response.

​
userGroups
object[]
required
​
nextPageToken
string

A token, which can be sent as page_token to retrieve the next page. If this field is empty, there are no subsequent pages.