Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
This section outlines the endpoints and parameters of the V1 API and provides examples of requests, payloads, and responses. The endpoints documented in this section are for the V1 API. The V2 API is documented in the previous section.
Any endpoints or attributes that are not documented are for internal purposes and should not be used.
The endpoints throughout this section are organized by workflow.
Audience: All Immuta Users
Content Summary: Calls to the Immuta API require authentication. This page includes the API key authentication endpoint, request and response parameters, and example requests and responses for API authentication.
There are two methods for making an authenticated request to the Immuta API.
Generate an API key.
Pass your API key in the Authorization header when making a request.
Generate an API key.
Make a request to the authentication
endpoint to receive a bearer token.
Include the bearer token in the Authorization header when making a request. This token should be used for multiple requests until it expires. Once a token expires, users must authenticate again to get a new token. When a request uses an expired token, the request will return with a 401
status code.
Generate your API key on the API Keys tab on your profile page and save the API key somewhere secure.
You will pass this API key in the authorization header when you make a request, as illustrated in the example below:
Generate your API key on the API Keys tab on your profile page and save the API key somewhere secure.
Save your API key in a .json file.
Make the following request to the authentication
endpoint:
You will receive a response that includes your bearer token. Pass that bearer token in the Authorization header when you make a request, as illustrated in the example below:
This page illustrates how to check the status of the Fingerprint service using the fingerprint
endpoint.
Additional fields may be included in some responses you receive; however, these attributes are for internal purposes and are therefore undocumented.
GET
/fingerprint/status
Get the status of the Fingerprint service.
The following request gets the status of the Fingerprint service.
This page describes the activity
endpoint of the Immuta API, which allows you to view your activity notifications.
Additional fields may be included in some responses you receive; however, these attributes are for internal purposes and are therefore undocumented.
GET
/activity
View your activity notification feed.
This example request gets 5 activities for the current user and sorts them in descending order.
GET
/activity/hasUnread
Determine whether you have unread activity notifications.
This request determines whether or not the requesting user has unread activities.
Attribute | Description |
---|
: View your activity notifications.
: Check the status of the Fingerprint service.
: Manage users and their permissions, groups, and attributes.
: Manage and view licenses in Immuta.
: Configure custom sensitive data discovery rules and tags.
: Create and search for tags.
: Create webhooks that are triggered by events that happen in the system.
Method | Path | Purpose |
---|
Attribute | Description | Required |
---|
Attribute | Description |
---|
Attribute | Description |
---|