Authentication

Authenticate to the Governance app or Request app API

Govern app API

There are two methods for making an authenticated request to the Governance API. Select a tab below for instructions.

  1. Generate your API key on the API Keys tab on your profile page and save the API key somewhere secure.

  2. You will pass this API key in the authorization header when you make a request, as illustrated in the example below:

    curl \
        --request GET \
        --header "Content-Type: application/json" \
        --header "Authorization: 846e9e43c86a4ct1be14290d95127d13f" \
        https://your-immuta-url.immuta.com/data/connection/123456789

Request app API

Immuta uses JWTs to match users with their tenants. The JWTs contain this metadata in the claims, which is required for the request context in the Request app API.

Generate a personal access token (PAT)

In the Request app,

  1. Click Generate new token.

  2. Enter a description and set an expiration. You may select No expiration from the dropdown.

  3. Click Generate new token.

  4. The new PAT will be displayed. Store this token somewhere secure; it is only presented once and cannot be retrieved again later.

  5. To use your generated PAT, insert it as the Bearer token for your API calls:

    curl -L \
      --url '{correct base path from above}/api/access-agreement' \
      --header 'Authorization: Bearer <your-PAT>'

Last updated

Was this helpful?