ONonetrust
Data Subject Groups

Get List of Data Subject Groups

Use this API to retrieve a list of all Data Subject Groups. The response will include the Data Subject Group ID, number of data subjects, and details of the primary data subjects in the group.

get/api/consentmanager/v2/linkedidentitygroups

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/consentmanager/v2/linkedidentitygroups
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: CONSENT, CONSENT_READ

Query parameters

displayOrganizationsboolean

Include organization information for Data Subject Groups

pageinteger

Results page you want to retrieve (0..N).

sizeinteger
Example:20

Number of records per page.

sort'lastModifiedDate,asc' | 'lastModifiedDate,desc' | 'lastUpdatedDate,asc' | 'lastUpdatedDate,desc' | 'expiryDate,asc' | 'expiryDate,desc' | 'addedDate,asc' | 'addedDate,desc' | 'createdDate,asc' | 'createdDate,desc'
Example:createdDate,desc

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

Headers

primaryDataSubjectIdentifierstring
Example:user@example.com

In order to retrieve a list of Linked Identity Groups whose primary identifier is equal to the primaryDataSubjectIdentifier header value

primaryDataSubjectIdentifierTypestring
Example:Email

In order to retrieve a list of Linked Identity Groups whose primary identifier type is equal to the primaryDataSubjectIdentifierType header value

requestContinuationstring

Token for pagination

Response

OK - Successfully retrieved Data Subject Groups.

emptyboolean

The flag to check if the entity is empty or not.

firstboolean

The flag to check if the entity is first entity or not.

lastboolean

The flag to check if the entity is last entity or not.

numberinteger

The number associated with the result.

numberOfElementsinteger

Total number of elements in the result.

totalPagesinteger

Total number of pages in the result list.

totalElementsinteger

Total number of elements in the result.

sizeinteger

Size of the result list.

Example response

{
  "content": [
    {
      "id": "b0a6b5da-4ea2-4a9f-a25a-fb3e212efc30",
      "numberOfDataSubjects": 6,
      "createdDate": "2020-05-30T10:52:30.974Z",
      "lastModifiedDate": "2020-05-30T12:23:42.145Z",
      "primaryDataSubjects": [
        {
          "id": "c43a9190-ffd6-4be3-aeff-95b46d0fa59f",
          "identifier": "example@otprivacy.com",
          "identifierType": "Email"
        }
      ],
      "organizations": [
        "550e8400-e29b-41d4-a716-446655440000",
        "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
      ],
      "primaryDataSubjectId": "c43a9190-ffd6-4be3-aeff-95b46d0fa59f",
      "primaryDataSubjectIdentifier": "example@otprivacy.com",
      "primaryDataSubjectIdentifierType": "Email",
      "groupName": "Customer Group A"
    }
  ],
  "first": true,
  "numberOfElements": 20,
  "totalPages": 5,
  "totalElements": 50,
  "size": 20
}

Changes

No recorded changes to this operation across all 1 revision of this API.