Skip to content

You are viewing documentation for Immuta version 2021.3.

For the latest version, view our documentation for Immuta SaaS or the latest self-hosted version.

Governance API

Audience: Data Governors

Content Summary: This page describes the governance endpoint of the Immuta API and its request and response parameters used to manage purposes.

Note

Additional fields may be included in some responses you receive; however, these attributes are for internal purposes and are therefore undocumented.

Governance Workflow

  1. Create a purpose.
  2. Search for purposes.
  3. Update purposes.
  4. Delete purposes.

Create a Purpose

Endpoint

Method Path Purpose
POST /governance/purpose Create a purpose.

Query Parameters

None.

Payload Parameters

Attribute Description Required
Name string The purpose name. Yes
Id integer The ID of the purpose. No
Acknowledgement string The purpose acknowledgement. No
Description string The purpose description. No
DisplayAcknowledgement boolean When true, the acknowledgement text will display for users when they are prompted to agree to use the data in the project only for that purpose. Default is true. No
Deleted boolean If true, the purpose has been deleted. No
Subpurposes array A list of the sub-purposes. No
PolicyMetadata array Information including the values for kAnonNoiseReduction, allowUnmaskedKAnon, adjustmentCertificationText, isHED, and adjustmentRequiresDataSourceTag. No
Staged boolean If true, the purpose is staged. No

Response Parameters

Attribute Description
ID integer The purpose ID.
Name string The purpose name.
Acknowledgement string The purpose acknowledgement.
Description string The purpose description.
AddedByProfile integer The profile ID of the user who created the purpose.
DisplayAcknowledgement boolean When true, the acknowledgement text is displayed for users when they are prompted to agree to use the data in the project only for that purpose.
Deleted boolean If true, the purpose has been deleted.
Subpurposes array A list of the sub-purposes.
PolicyMetadata array Information including the values for kAnonNoiseReduction, allowUnmaskedKAnon, adjustmentCertificationText, isHED, and adjustmentRequiresDataSourceTag.
Staged boolean If true, the purpose is staged.
CreatedAt timestamp The date the purpose was created.
UpdatedAt timestamp The date the purpose was last updated.

Request Example

This example request with the payload below creates a new purpose.

curl \
    --request POST \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer dea464c07bd07300095caa8" \
    --data @example-payload.json \
    https://demo.immuta.com/governance/purpose

Payload Example

{
  "name": "Compliance Requirement #2"
}

Response Example

{
  "id": 10,
  "name": "Compliance Requirement #2",
  "acknowledgement": null,
  "description": null,
  "addedByProfile": 2,
  "displayAcknowledgement": true,
  "deleted": false,
  "systemGenerated": false,
  "policyMetadata": null,
  "createdAt": "2021-10-04T15:52:38.060Z",
  "updatedAt": "2021-10-04T15:52:38.060Z",
  "subpurposes": []
}

Search Purposes

Method Path Purpose
GET /governance/purpose Search for purposes.
GET /governance/purpose/{purposeId} Get a purpose by ID.

Search All Purposes

Endpoint

Method Path Purpose
GET /governance/purpose Search for purposes.

Query Parameters

Attribute Description Required
Offset integer Used in combination with size to fetch pages. No
Size integer The number of results to return per page. No
NoLimit boolean When true, the number of results to return per page will not be limited to the number defined by size. Default is false. No
SortField string Used to sort results by field. Default is name. No
SortOrder string Sorts results by order, which must be asc or desc. Default is asc. No
SearchText string Search for purpose names by text. No
Root string Restrict results to provided root or sub-purposes of root. No
StrictSearch boolean When true, will search for a complete match of the whole string provided in searchText. No
GetAffectedCount boolean If true, returns the count of projects with each purpose. No
IncludeDeleted boolean If true, includes deleted purposes in the results. No

Response Parameters

Attribute Description
Count integer The number of results.
Purposes array Information on each purpose returned, including id, name, acknowledgement, description, subpurposes, policyMetadata, the creation date, and the staged status.

Request Example

This example request returns a list of all of the purposes.

curl \
    --request GET \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer dea464c07bd07300095caa8" \
    https://demo.immuta.com/governance/purpose

Response Example

{
  "purposes": [
    {
      "id": 1,
      "name": "Re-identification Prohibited",
      "acknowledgement": "I agree to use the data associated with this project for the stated purpose of the project, and for that purpose only, as listed in the project's homepage, and to refrain from sharing that data outside of the project or Immuta. I also agree not to re-identify or take any steps to re-identify the individuals whose personal information is contained in the data sources attached to the project. In the event that these individuals have been identified or that I discover risks that I believe could lead to their identification, I agree to immediately notify the project owner or governance team and take immediate action to address and mitigate such risks. I further agree to refrain from contacting any individuals who might be identified.",
      "description": null,
      "addedByProfile": 1,
      "displayAcknowledgement": true,
      "deleted": false,
      "systemGenerated": true,
      "policyMetadata": null,
      "createdAt": "2021-08-16T20:25:44.423Z",
      "updatedAt": "2021-09-30T00:36:25.215Z"
    },
    {
      "id": 3,
      "name": "Re-identification Prohibited.CCPA",
      "acknowledgement": "I agree to use the data associated with this project for the stated purpose of the project, and for that purpose only, as listed in the project's homepage, and to refrain from sharing that data outside of the project or Immuta. I also agree not to re-identify or take any steps to re-identify the individuals whose personal information is contained in the data sources attached to the project. In the event that these individuals have been identified or that I discover risks that I believe could lead to their identification, I agree to immediately notify the project owner or governance team and take immediate action to address and mitigate such risks. I further agree to refrain from contacting any individuals who might be identified.",
      "description": null,
      "addedByProfile": 1,
      "displayAcknowledgement": true,
      "deleted": false,
      "systemGenerated": true,
      "policyMetadata": null,
      "createdAt": "2021-08-16T20:25:44.443Z",
      "updatedAt": "2021-09-30T00:36:25.250Z"
    },
    {
      "id": 2,
      "name": "Re-identification Prohibited.Safe Harbor Method",
      "acknowledgement": "I agree to use the data associated with this project for the stated purpose of the project, and for that purpose only, as listed in the project's homepage, and to refrain from sharing that data outside of the project or Immuta. I also agree not to re-identify or take any steps to re-identify the individuals whose health information is contained in the data sources attached to the project. In the event that these individuals have been identified or that I discover risks that I believe could lead to their identification, I agree to immediately notify the project owner or governance team and take immediate action to address and mitigate such risks. I further agree to refrain from contacting any individuals who might be identified.",
      "description": null,
      "addedByProfile": 1,
      "displayAcknowledgement": true,
      "deleted": false,
      "systemGenerated": true,
      "policyMetadata": null,
      "createdAt": "2021-08-16T20:25:44.434Z",
      "updatedAt": "2021-09-30T00:36:25.234Z"
    },
    {
      "id": 4,
      "name": "Use Case Outside De-identification",
      "acknowledgement": "I agree to use the data associated with this project for the stated purpose of the project, and for that purpose only, as listed in the project's homepage, and to refrain from sharing that data outside of the project or Immuta. In the event that I discover risks that I believe could lead to unauthorized access, I agree to immediately notify the project owner or governance team and take immediate action to address and mitigate such risks.",
      "description": null,
      "addedByProfile": 1,
      "displayAcknowledgement": true,
      "deleted": false,
      "systemGenerated": true,
      "policyMetadata": null,
      "createdAt": "2021-08-16T20:25:44.452Z",
      "updatedAt": "2021-09-30T00:36:25.270Z"
    }
  ],
  "count": 4
}

Search Purposes by ID

Endpoint

Method Path Purpose
GET /governance/purpose/{purposeId} Get a purpose by ID.

Query Parameters

Attribute Description Required
PurposeId integer The purpose ID. Yes
IncludeSubpurposes boolean If true, sub-purposes will be included in the results. No

Response Parameters

Attribute Description
ID integer The purpose ID.
Name string The purpose name.
Acknowledgement string The purpose acknowledgement.
Description string The purpose description.
AddedByProfile integer The profile ID of the user who created the purpose.
DisplayAcknowledgement boolean When true, the acknowledgement text is displayed for users when they are prompted to agree to use the data in the project only for that purpose.
Deleted boolean If true, the purpose has been deleted.
Subpurposes array A list of the sub-purposes.
PolicyMetadata array Information including the values for kAnonNoiseReduction, allowUnmaskedKAnon, adjustmentCertificationText, isHED, and adjustmentRequiresDataSourceTag.
Staged boolean If true, the purpose is staged.
CreatedAt timestamp The date the purpose was created.
UpdatedAt timestamp The date the purpose was last updated.

Request Example

This example request returns information on the purpose with the ID 1, including its sub-purposes.

curl \
    --request GET \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer dea464c07bd07300095caa8" \
    https://demo.immuta.com/governance/purpose/1?includeSubpurposes=true

Response Example

{
  "name": "Re-identification Prohibited",
  "acknowledgement": "I agree to use the data associated with this project for the stated purpose of the project, and for that purpose only, as listed in the project's homepage, and to refrain from sharing that data outside of the project or Immuta. I also agree not to re-identify or take any steps to re-identify the individuals whose personal information is contained in the data sources attached to the project. In the event that these individuals have been identified or that I discover risks that I believe could lead to their identification, I agree to immediately notify the project owner or governance team and take immediate action to address and mitigate such risks. I further agree to refrain from contacting any individuals who might be identified.",
  "description": null,
  "addedByProfile": 1,
  "displayAcknowledgement": true,
  "deleted": false,
  "systemGenerated": true,
  "policyMetadata": null,
  "id": 1,
  "createdAt": "2021-08-16T20:25:44.423Z",
  "updatedAt": "2021-09-30T00:36:25.215Z",
  "addedBy": "Immuta System Account",
  "projectCount": 1,
  "projects": [
    1
  ],
  "subpurposes": [
    {
      "id": 3,
      "name": "Re-identification Prohibited.CCPA",
      "acknowledgement": "I agree to use the data associated with this project for the stated purpose of the project, and for that purpose only, as listed in the project's homepage, and to refrain from sharing that data outside of the project or Immuta. I also agree not to re-identify or take any steps to re-identify the individuals whose personal information is contained in the data sources attached to the project. In the event that these individuals have been identified or that I discover risks that I believe could lead to their identification, I agree to immediately notify the project owner or governance team and take immediate action to address and mitigate such risks. I further agree to refrain from contacting any individuals who might be identified.",
      "description": null,
      "addedByProfile": 1,
      "displayAcknowledgement": true,
      "deleted": false,
      "systemGenerated": true,
      "policyMetadata": null,
      "createdAt": "2021-08-16T20:25:44.443Z",
      "updatedAt": "2021-09-30T00:36:25.250Z",
      "projectCount": 0,
      "projects": [],
      "addedBy": "Immuta System Account"
    },
    {
      "id": 2,
      "name": "Re-identification Prohibited.Safe Harbor Method",
      "acknowledgement": "I agree to use the data associated with this project for the stated purpose of the project, and for that purpose only, as listed in the project's homepage, and to refrain from sharing that data outside of the project or Immuta. I also agree not to re-identify or take any steps to re-identify the individuals whose health information is contained in the data sources attached to the project. In the event that these individuals have been identified or that I discover risks that I believe could lead to their identification, I agree to immediately notify the project owner or governance team and take immediate action to address and mitigate such risks. I further agree to refrain from contacting any individuals who might be identified.",
      "description": null,
      "addedByProfile": 1,
      "displayAcknowledgement": true,
      "deleted": false,
      "systemGenerated": true,
      "policyMetadata": null,
      "createdAt": "2021-08-16T20:25:44.434Z",
      "updatedAt": "2021-09-30T00:36:25.234Z",
      "addedBy": "Immuta System Account",
      "projectCount": 0,
      "projects": []
    }
  ]
}

Update a Purpose

Endpoint

Method Path Purpose
PUT /governance/purpose/{purposeId} Update a purpose.

Query Parameters

Attribute Description Required
PurposeID integer The purpose ID. Yes

Payload Parameters

Attribute Description Required
Name string The purpose name. No
Acknowledgement string The purpose acknowledgement. No
Description string The purpose description. No
DisplayAcknowledgement boolean When true, the acknowledgement text will display for users when they are prompted to agree to use the data in the project only for that purpose. Default is true. No
ReAcknowledge boolean When true, users will have to re-acknowledge the purpose after it is updated. No
ApplyToSubpurposes boolean It true, the updates will be applied to the sub-purposes. No
PolicyMetadata array Information including the values for kAnonNoiseReduction, allowUnmaskedKAnon, adjustmentCertificationText, isHED, and adjustmentRequiresDataSourceTag. No

Response Parameters

Attribute Description
ID integer The purpose ID.
Name string The purpose name.
Acknowledgement string The purpose acknowledgement.
Description string The purpose description.
AddedByProfile integer The profile ID of the user who created the purpose.
DisplayAcknowledgement boolean When true, the acknowledgement text is displayed for users when they are prompted to agree to use the data in the project only for that purpose.
Deleted boolean If true, the purpose has been deleted.
Subpurposes array A list of the sub-purposes.
PolicyMetadata array Information including the values for kAnonNoiseReduction, allowUnmaskedKAnon, adjustmentCertificationText, isHED, and adjustmentRequiresDataSourceTag.
Staged boolean If true, the purpose is staged.
CreatedAt timestamp The date the purpose was created.
UpdatedAt timestamp The date the purpose was last updated.

Request Example

This example request with the payload below will update the description of the purpose with the ID 8.

curl \
    --request PUT \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer dea464c07bd07300095caa8" \
    --data @example-payload.json \
    https://demo.immuta.com/governance/purpose/8

Payload Example

{
  "description": "This requirement has been amended to include an updated model."
}

Response Example

{
  "id": 8,
  "name": "Compliance Requirement #1",
  "acknowledgement": null,
  "description": "This requirement has been amended to include an updated model.",
  "addedByProfile": 2,
  "displayAcknowledgement": true,
  "deleted": false,
  "systemGenerated": false,
  "policyMetadata": null,
  "createdAt": "2021-10-01T21:08:00.517Z",
  "updatedAt": "2021-10-04T14:21:59.834Z"
}

Delete a Purpose

Endpoint

Method Path Purpose
DELETE /governance/purpose/{purposeId} Delete the purpose with the given ID and its associated sub-purposes.

Query Parameters

Attribute Description Required
PurposeID integer The purpose ID. Yes

Response Parameters

Attribute Description
ID integer The purpose ID.
Name string The purpose name.
Acknowledgement string The purpose acknowledgement.
Description string The purpose description.
AddedByProfile integer The profile ID of the user who created the purpose.
DisplayAcknowledgement boolean When true, the acknowledgement text is displayed for users when they are prompted to agree to use the data in the project only for that purpose.
Deleted boolean If true, the purpose has been deleted.
Subpurposes array A list of the sub-purposes.
PolicyMetadata array Information including the values for kAnonNoiseReduction, allowUnmaskedKAnon, adjustmentCertificationText, isHED, and adjustmentRequiresDataSourceTag.
Staged boolean If true, the purpose is staged.
CreatedAt timestamp The date the purpose was created.
UpdatedAt timestamp The date the purpose was last updated.

Request Example

This example request deletes the purpose with the ID 8.

curl \
    --request DELETE \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer dea464c07bd07300095caa8" \
    https://demo.immuta.com/governance/purpose/8

Response Example

[
  {
    "id": 8,
    "name": "Compliance Requirement #1",
    "acknowledgement": null,
    "description": "This requirement has been amended to include an updated model.",
    "addedByProfile": 2,
    "displayAcknowledgement": true,
    "deleted": true,
    "systemGenerated": false,
    "policyMetadata": null,
    "createdAt": "2021-10-01T21:08:00.517Z",
    "updatedAt": "2021-10-04T14:27:07.203Z"
  }
]