Sign in

Data groups

Data groups objects represent overarching business objects that contain one or more data items. Data groups defines a group of data objects that are accessed by your service, contains personal data and is subject for one or several processing purposes.

Create a data group

Creates a data group that can be referenced in purposes

POST /privacy/v2/projects/{project_id}/dataGroups

Update a data group

Update a specific data group. Important: Updating a data group may invalidate already given permissions by data subjects for purposes that affect this data group.

PUT /privacy/v2/projects/{project_id}/dataGroups/{datagroup_id}

Delete a data group

Delete a data group Important: Deleting a data group may invalidate already given permissions by data subjects for purposes that affect this data group.

DELETE /privacy/v2/projects/{project_id}/dataGroups/{datagroup_id}

Get a data group

Return a specific data group

GET /privacy/v2/projects/{project_id}/dataGroups/{datagroup_id}

Get a list of dataGroups

Returns an object that contains a list of dataGroups. Each item has the same format as you get from GET /privacy/v2/dataGroup/{datagroup_id}

GET /privacy/v2/projects/{project_id}/dataGroups

Schema

This section specifies the data group schema

Parameters
Field Type Description Comments
projectId string The ID of the project
dataGroupId string The data group ID generated by us
referenceId string The internal identifier your service has for this data group.
type enum The data group type in URN format, like u:oidc:profile
title JSON object An array of translations objects containing the title to be used to name this data group Displayed to the data subject in end-user portal interactions and dialogues
description JSON object An array of translations objects containing the description to be used to describe this data group Displayed to the data subject in end-user portal interactions and dialogues
erasable boolean Boolean flag specifying if this data group is subject for requests for erasure (right to be forgotten)
portable boolean Boolean flag specifying if this data group is subject to data portability requests (must adhere to standard export formats)
accessible boolean Boolean flag specifying if this data group is subject to requests for access/download
created timestamp The time this data group was created
updated timestamp The time this data group was last updated  
Response
{
  "purposeId": "9d5df04e-3e7c-46a5-9440-8114206dcb52",
  "projectId": "7fba66c8-9a67-4a06-8d70-7e5dffe9109d",
  "referenceId": "anIdentifier",
  "title": [
    {
      "language": "en-US",
      "text": "The title of the item"
    }
  ],
  "description": [
    {
      "language": "en-US",
      "text": "The description of the item"
    }
  ],
  "retention": [
    {
      "language": "en-US",
      "text": "The retention policy of the item"
    }
  ],
  "dataSharing": [
    {
      "language": "en-US",
      "text": "The description of the data sharing items."
    }
  ],
  "version": "1.0.0",
  "legalGround": "ic",
  "objectionType": "evaluate",
  "category": [
    "improvePerformance"
  ],
  "onLogin": true,
  "dataGroups": [
    {
      "dataGroupId": "4056dfca-a4bf-4829-a13f-7cf30ddb6a68"
    }
  ],
  "controllers": [
    {
      "description": [
        {
          "language": "en-US",
          "text": "The description of the item"
        }
      ],
      "partyId": "3a8c23ab-d171-404f-9fd7-b13f1283f646"
    }
  ],
  "processors": [
    {
      "description": [
        {
          "language": "en-US",
          "text": "The description of the item"
        }
      ],
      "partyId": "3a8c23ab-d171-404f-9fd7-b13f1283f646"
    }
  ],
  "recipients": [
    {
      "description": [
        {
          "language": "en-US",
          "text": "The description of the item"
        }
      ],
      "partyId": "3a8c23ab-d171-404f-9fd7-b13f1283f646"
    }
  ],
  "created": "1969-07-16T09:32:50.052Z",
  "updated": "1969-07-16T09:32:50.052Z"
}