/api/v2/purposeRequired Immuta permission: GOVERNANCE
name: A basic purposename: Purpose Hierarchy
acknowledgement: The root acknowledgement
subpurposes:
- name: Purpose Hierarchy.Child 1
acknowledgement: Override the root acknowledgement
subpurposes:
- name: Purpose Hierarchy.Child 1.Grandchild 1
The body of the request contains the purpose details. The following attributes are available:
subpurposes arrayThe subpurposes array allows you to define a hierarchy of purposes, where each subpurpose can have its own acknowledgement and can be used to further categorize data usage. Each subpurpose can itself have a subpurposes array, allowing for nested hierarchies.
dryRun boolean
If true, no updates will actually be made.
false
reAcknowledgeRequired boolean
If true, will require all users of any projects using this purpose to re-acknowledge any updated acknowledgement statements.
false
name string
The name of the purpose.
Required
description string
A short description for the purpose.
Optional
acknowledgement string
The acknowledgement that users must agree to when joining a project with this purpose. If not provided, the system default will be used.
Optional
subpurposes array
The subpurposes of the purpose.
name string
The name of the subpurpose.
Required
acknowledgement string
The acknowledgement that users must agree to when joining a project with this subpurpose. If not provided, the system default will be used.
Optional
subpurposes array
Nested subpurposes.
Optional
Optional