Sign in

Permission states

Get a data subject’s permission state (based on identityId)

Action Endpoint Description
GET /privacy/v2/projects/{project_id}/identities/{identityId}/states Get the permission state for a user based on identityId. This represents the accumulation of all permissions given for data subject within a project.

Response schema for permission state

This section specifies the schema for a data subject’s permission state

Field Type Description Comments
projectId String The Id of the project
identityId String The identityId of the data subject
purposes JSON object A JSON object defining the purposes, data items and third parties structure the data subject has given permission to See own schema for this section below
updated timestamp The time any item or property on this state was last updated  

This section specifies the purposes section of the schema

Field Type Description Comments
referenceId String The internal identifier your service has for this item.
purposeId String The internal ID for this purpose
status String The permission status for this purpose Important:
A denied permission on the purpose will affect all data items and parties belonging to this purpose
dataGroups JSON object A list of data objects linked to this purpose See own schema for this section below
processors Array An array of JSON objects containing the parties that are processors of personal data related to this processing purpose and the status for each See own schema for this section below
recipients Array An array of JSON objects containing the parties that are recipients of personal data related to this processing purpose and the status for each See own schema for this section below
version String Version of this purpose See own schema for this section below
requestId String The ID of the privacy request that affected this purpose status This can be used to look up the privacy request details that resulted in this state change. As an example, in order to look up the internalReference values.
updated timestamp The time the purpose, or an element on the purpose, was last updated  

This section specifies the dataGroups section of the schema

Field Type Description Comments
requestId String The ID of the privacy request that affected this data group status This can be used to look up the privacy request details that resulted in this state change. As an example, in order to look up the internalReference values.
status String The permission status for this data group
dataGroupId String The internal ID for this data group
referenceId String The internal identifier your service has for this group.  

This section specifies the processors and recipients section of the schema

Field Type Description Comments
requestId String The ID of the privacy request that affected this party status This can be used to look up the privacy request details that resulted in this state change. As an example, in order to look up the internalReference values.
status String The permission status for this party
dataGroupId String The internal ID for this party
referenceId String The internal identifier your service has for this party  

Example request for a user permission state

GET /v2/projects/{projectId}/identities/{identityId}/states

{
  "projectId": "7fba66c8-9a67-4a06-8d70-7e5dffe9109d",
  "updated": "1969-07-16T09:32:50.052Z",
  "identityId": "fda8ec3d-3260-44c9-8f84-e15a418dfa05",
  "purposes": [
    {
      "referenceId": "anIdentifier",
      "updated": "1969-07-16T09:32:50.052Z",
      "status": "approved",
      "version": "1.0.0",
      "purposeId": "9d5df04e-3e7c-46a5-9440-8114206dcb52",
      "dataGroups": [
        {
          "referenceId": "anIdentifier",
          "status": "approved",
          "dataGroupId": "3a8c23ab-d171-404f-9fd7-b13f1283f646",
          "requestId": "a81661ff-2fa8-45a6-81d9-e160b10b222d"
        
      ],
      "processors": [
        {
          "referenceId": "anIdentifier",
          "status": "approved",
          "partyId": "3a8c23ab-d171-404f-9fd7-b13f1283f646",
          "requestId": "a1427c49-74f5-4837-b779-229a197c0a27"
        
      ],
      "recipients": [
        {
          "referenceId": "anIdentifier",
          "status": "approved",
          "partyId": "3a8c23ab-d171-404f-9fd7-b13f1283f646",
          "requestId": "04c9abc8-2094-4944-ae3b-a6bb9f71a696"
        
      ]
    }
  ]
}