v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

User Groups V2

Get List of Users in User Group

Use this API to retrieve a paginated list of members in a specified user group.

get/api/access/v2/user-groups/{groupId}/members

Path parameters

groupIdstring uuid required

The unique identifier of the user group.

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'

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

Response

Members retrieved successfully

emptyboolean

Flag to check if the result list is empty or not

firstboolean

Flag to check if this is the first page

lastboolean

Flag to check if this is the last page

numberinteger

Current page number (0-based)

numberOfElementsinteger

Number of elements in the current page

sizeinteger

Page size

totalElementsinteger

Total number of elements across all pages

totalPagesinteger

Total number of pages

pageableobject

Pagination information with page number (0-based, min: 0) and page size (min: 1)

Example response

{
  "content": [
    {
      "fullName": "John Doe",
      "email": "jdoe@onetrust.com",
      "memberId": "123e4567-e89b-12d3-a456-426614174001",
      "enabled": true,
      "createdBy": "123e4567-e89b-12d3-a456-426614174001",
      "createdDate": "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
  }
}