Immuta As Code (Public Preview)
Audience: Data Engineers
Content Summary: This feature allows Data Engineers to manage policies as code, providing a way to track, approve, and easily update data sources and their associated policies. This page details the endpoints, methods, query parameters, and payload definitions for creating data sources, policies, projects, and purposes.
Immuta as Code Benefits
-
Reduces Complexity. The data source API has been simplified to only require the connection information in most instances and one endpoint for all database technologies.
-
Maintains Less State. Whether updating or creating, the same endpoint is used, and the same data is passed. No ids are required, so no additional state is required.
-
Requires Fewer Steps. Only an API key is required; no additional authentication step is required before using the API.
-
Integrates with Git. Define data sources and policies in files that can be tracked in Git and easily pushed to Immuta. Both JSON and YAML are supported for more flexibility. (For example, use YAML to add comments in files.)
Authentication
Before using the Immuta API, users need to authenticate with an API key. To generate an API key, complete the following steps in the Immuta UI.
- Click your initial in the top right corner of the screen and select Profile.
- Go to the API Keys tab and then click Generate Key.
- Complete the required fields in the modal and click Create.
-
Pass the key that is provided in the Authorization header:
curl --data-binary project.yaml -H "Authorization: ${IMMUTA_API_KEY}" -H "Content-Type: text/plain" https:/<immuta-url>/api/v2/project
Endpoints and Details
All of the API endpoints described below take either JSON or YAML, and the endpoint and payload are the same for both creating and updating data sources, policies, projects, and purposes.
Create a Data Source
Endpoint
| Method | Path |
|---|---|
| POST | /api/v2/data |
Query Parameters
| Parameter | Description |
|---|---|
| dryRun | boolean If true, no updates will actually be made. Default: false |
| wait | number The number of seconds to wait for data sources to be created before returning. Anything less than 0 will wait indefinitely. Default: 0 |
Payload
| Attribute | Description |
|---|---|
| connectionKey | string A key/name to uniquely identify this collection of data sources |
| connection | object Connection information |
| nameTemplate (optional) | object Supply a template to override naming conventions. Will use the system default if not supplied |
| options (optional) | object Override options for these sources. If not provided, system defaults will all be used |
| sources (optional) | object Configure which sources are created. If not provided, all sources from the given connection will be created |
Note: See Data Source Request Payload Examples for payload details.
Create a Policy
Endpoint
| Method | Path |
|---|---|
| POST | /api/v2/policy |
Query Parameters
| Parameter | Description |
|---|---|
| dryRun | boolean If true, no updates will actually be made. Default: false |
| reCertify | boolean If true (and if the certification has changed), someone will need to re-certify this policy on all impacted data sources. Default: false |
Payload
| Attribute | Description |
|---|---|
| policyKey | string A key/name to uniquely identify this policy |
| name | string The name of the policy |
| type | subscription or data The type of policy |
| actions | object The actual rules for this policy (see examples) |
| ownerRestrictions (optional) | object[] Object identifying the entities to which this global policy should be restricted |
| circumstances (optional) | object When this policy should get applied |
| circumstanceOperator (optional) | all or any Specify whether "all" of the circumstances must be met for the policy to be applied, or just "any" of them |
| staged (optional) | boolean Whether or not this global policy is in a staged status. Default: false |
| certification (optional) | object Certification information for the global policy |
Note: See Policy Request Payload Examples for payload details.
Request Payload Examples
Create a Project
Endpoint
| Method | Path |
|---|---|
| POST | /api/v2/project |
Query Parameters
| Parameter | Description |
|---|---|
| dryRun | boolean If true, no updates will actually be made. Default: false |
| deleteDataSourcesOnWorkspaceDelete | boolean If true, will delete all data and the data sources associated with a project workspace when the workspace is deleted. Default: false |
Payload
| Attribute | Description |
|---|---|
| projectKey | string A key/name to uniquely identify this project |
| name | string The name of the project |
| description (optional) | string A short description for this project |
| documentation (optional) | object Markdown-supported documentation for this project |
| allowedMaskedJoins (optional) | boolean If true, will allow joining on masked columns between data sources in this project. Only certain policies allow masked join. Default: false |
| purposes (optional) | string[] The list of purposes to add to this project |
| datasources (optional) | string[] The list of data sources to add to this project |
| subscriptionPolicy (optional) | object The policy for which users can subscribe to this project. Default: manual subscription policy |
| workspace (optional) | object If this is a workspace project, this is the workspace configuration. The project will automatically be equalized |
| equalization (optional) | boolean If true, will normalize all users to the same entitlements so that everyone sees the same data. Default: false |
| tags (optional) | string[] Tags to add to the project |
Note: See Project Request Payload Examples for payload details.
Create a Purpose
Endpoint
| Method | Path |
|---|---|
| POST | /api/v2/purpose |
Query Parameters
| Parameter | Description |
|---|---|
| dryRun | boolean If true, no updates will actually be made. Default: false |
| reAcknowledgeRequired | boolean If true, will require all users of any projects using this purpose to re-acknowledge any updated acknowledgement statements. Default: false |
Payload
| Attribute | Description |
|---|---|
| name | string The name of the purpose |
| description (optional) | string A short description for this purpose |
| acknowledgement (optional) | string The acknowledgement that users must agree to when joining a project with this purpose. If not provided, the system default will be used |
| kAnonNoiseReduction (optional) | string The level of reduction allowed when doing policy adjustments on data sources in projects with this purpose |
Note: See Purposes Request Payload Examples for payload details.
Request Payload Examples