ONonetrust
User Groups

Get List of User Groups

Changed on

Use this API to retrieve a list of user groups.

get/api/access/v1/user-groups

Request

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

Query parameters

filtersstring

Filter criteria for the results.

pageinteger

The page number to retrieve.

sizeinteger

The number of records per page.

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

Sort order for the results.

Response

OK

emptyboolean

Indicates whether the result set is empty.

firstboolean

Indicates whether this is the first page.

lastboolean

Indicates whether this is the last page.

numberinteger

The current page number.

numberOfElementsinteger

The number of records in the current page.

sizeinteger

The total number of records across all pages.

totalElementsinteger

The total number of pages available.

totalPagesinteger

The pagination details for this response.

pageableobject

The pagination details for this response.

Example response

{
  "content": [
    {
      "userGroupId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Administrators",
      "description": "Group for system administrators",
      "createdBy": "123e4567-e89b-12d3-a456-426614174001",
      "createdDate": "2022-05-01T12:34:56Z",
      "lastModifiedBy": "123e4567-e89b-12d3-a456-426614174001",
      "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