Skip to main content

​
Overview

To authenticate with Pigment, you need:
  1. API Key — a Pigment API key with the scopes your integration needs (Modeling metadata to list applications).
This guide will show you how to create one.

​
Prerequisites

  • A Pigment account that can manage API keys in Workspace settings. If you don’t have a workspace, start a free trial.

​
Step 1: Create an API key

  1. Sign in to Pigment.
  2. In the left sidebar, click Settings, then click API Keys under Workspace settings.
Pigment Settings sidebar with API Keys highlighted under Workspace settings
  1. On the API Keys management page, click + Create API key.
Pigment API Keys management page with the Create API key button highlighted
  1. Enter a Name, keep or change the Expiration date, and tick the Scopes your integration needs, then click Generate:
    • Modeling metadata for the metadata endpoints (applications, blocks, views and import configurations).
    • Import or Export for the import and export endpoints.
    • Files for the File Storage endpoints and Data Flows for the Data Flow endpoints.
    One key can have several scopes. Tick Modeling metadata too if the app you connect to needs to list your applications.
Pigment Create API Key dialog with a name, an expiration date and the Modeling metadata scope ticked
  1. Copy the key with the copy icon.
Pigment dialog confirming the API key was generated, with the copy icon highlighted
Pigment shows the key only once. Copy it before you close the dialog. The key inherits the workspace, data visibility and permissions of the user who created it.
To call the Audit Logs API, a Security Admin creates an Audit logs API key the same way. Keys in the old format with dashes must be regenerated.

​
Step 2: Enter your API key in the Connect UI

  1. Open the form where you need to authenticate with Pigment.
  2. Paste your API key in the API Key field.
  3. Submit the form. The connection is saved without checking the key: if the key is wrong, the first API request returns an authentication error.
Pigment Connect UI form with the API Key field You are now connected to Pigment.