Sign in

v1

latestOpenAPI 3.0.12026-07-226992320.0 KB
Integration Auth

Create Integration Auth

Creates and stores authentication credentials for an integration. Supports three auth types: API Key, Basic auth, and Bearer token. Returns the created auth record including its authId, which is required for subsequent get, update, and delete calls.

post/v1/integrations/{integrationId}/auth

Path parameters

integrationIdstring required

Unique identifier for the integration

Request body

authType'NO_AUTH' | 'BASIC_AUTH' | 'BEARER_TOKEN' | 'API_KEY' required

Specifies the authentication method used for outgoing requests. Choose based on how the target API expects credentials: API_KEY → when a key must be sent via header or query parameter. BEARER_TOKEN → when a token is sent in the Authorization header. BASIC_AUTH → when username/password is required. NO_AUTH → when no authentication is needed. This field determines which other fields must be provided.

tokenstring

Access token used for Bearer authentication. Required only when authType is BEARER_TOKEN. Automatically added to requests as: Authorization: Bearer <token>.

usernamestring

Username used for Basic authentication. Required only when authType is BASIC_AUTH. Combined with password and encoded into the Authorization header.

passwordstring

Password used for Basic authentication. Required only when authType is BASIC_AUTH. Combined with username and encoded into the Authorization header.

Example request

{
  "authType": "API_KEY",
  "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "username": "api_user@example.com",
  "password": "s3cretP@ssword",
  "apiKey": {
    "key": "X-API-KEY",
    "value": "<secret>",
    "position": "header"
  },
  "headers": [
    {
      "key": "X-Request-Source",
      "value": "sigmamind"
    }
  ]
}

Response

Created

authIdstring

Unique identifier for the auth record

integrationIdstring

Unique identifier of the parent integration

authType'NO_AUTH' | 'BASIC_AUTH' | 'BEARER_TOKEN' | 'API_KEY'

The authentication strategy this credential set uses. Determines which credential fields are required: API_KEY — provide the apiKey object (key name, secret value, and position). BEARER_TOKEN — provide the token field. BASIC_AUTH — provide username and password fields. NO_AUTH — no credential fields required.

headersobject

Optional list of static HTTP headers attached to every outbound request under this auth. Applied on top of any headers defined at the integration or tool level. Useful for fixed metadata headers required by the third-party API.

createdAtstring date-time

Timestamp when the record was created

updatedAtstring date-time

Timestamp when the record was last updated

Example response

{
  "authId": "auth_P3kNz7Yv1Qm9",
  "integrationId": "intg_AuUKK371Spr5",
  "authType": "API_KEY"
}