ONonetrust
User Groups V2

Get List of User Groups

Changed on

Use this API to retrieve a list of user groups, with support for pagination and filtering.

get/api/access/v2/user-groups

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/access/v2/user-groups
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: USER, USER_GROUP_READ

Query parameters

pageinteger

The page number for the results to be retrieved.

sizeinteger

The number of records to be retrieved per page.

sort'name,asc' | 'name,desc' | 'description,asc' | 'description,desc' | 'createdDate,asc' | 'createdDate,desc' | 'lastModifiedDate,asc'

The sorting criteria in the format: property,(asc|desc). The default sort order is ascending. Multiple sort criteria are supported.

filtersstring

The filters to apply to the user groups.

Response

User groups retrieved successfully

emptyboolean

The flag to check if the result list is empty.

firstboolean

The flag to check if this is the first page.

lastboolean

The flag to check if this is the last page.

numberinteger

The current page number (0-based).

numberOfElementsinteger

The number of elements on the current page.

sizeinteger

The page size.

totalElementsinteger

The total number of elements across all pages.

totalPagesinteger

The total number of pages.

pageableobject

The pagination information with page number (0-based, min: 0) and page size (min: 1).

Example response

{
  "content": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "My User Group",
      "description": "User group used for grouping users",
      "createdBy": "52b6b7df-9e69-4d6f-9fd3-75c1d4626366",
      "createdDate": "2022-05-01T12:34:56Z",
      "lastModifiedBy": "52b6b7df-9e69-4d6f-9fd3-75c1d4626366",
      "lastModifiedDate": "2022-05-01T12:34:56Z"
    }
  ],
  "numberOfElements": 1,
  "size": 20,
  "totalElements": 1,
  "totalPages": 1,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 20,
    "paged": true,
    "sort": [
      {
        "ascending": true,
        "descending": false,
        "direction": "ASC",
        "ignoreCase": false,
        "nullHandling": "NATIVE",
        "property": "name"
      }
    ],
    "unpaged": false
  }
}

Changes

  • df80c4b8e947Revision changes
    • info

      the security scope USER_GROUP_READ was added to the endpoint's security scheme Platform-AccessManagement_OAUTH2