Skip to main content
POST
/
v1
/
integrations
/
{integrationId}
/
auth
Create Integration Auth
curl --request POST \
  --url https://api.sigmamind.ai/v1/integrations/{integrationId}/auth \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "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"
    }
  ]
}
'
{
  "authId": "auth_P3kNz7Yv1Qm9",
  "integrationId": "intg_AuUKK371Spr5",
  "authType": "API_KEY",
  "headers": [
    {
      "key": "X-Request-Source",
      "value": "sigmamind"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.sigmamind.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Authenticate every request by passing your API key in the X-API-Key header. To get your key, go to Dashboard → API Keys and create or copy your Production API key.

Path Parameters

​
integrationId
string
required

Unique identifier for the integration

Body

application/json

Defines authentication credentials for a third-party integration. Use this to tell the system how to authenticate outbound API requests. Select an authType and provide only the fields required for that type. All other fields will be ignored. This configuration is applied automatically to every request made using this integration.

​
authType
enum<string>
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.

Available options:
NO_AUTH,
BASIC_AUTH,
BEARER_TOKEN,
API_KEY
Example:

"API_KEY"

​
token
string

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

Example:

"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."

​
username
string

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

Maximum string length: 256
Example:

"api_user@example.com"

​
password
string

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

Example:

"s3cretP@ssword"

​
apiKey
object

Defines how an API key is attached to outgoing requests. Use this when the API requires a key in headers or query parameters.

Example:
{
  "key": "X-API-KEY",
  "value": "<secret>",
  "position": "header"
}
​
headers
object[]

Optional static headers that will be included in every outgoing request. Useful for fixed metadata or required headers that do not change per request. These are applied in addition to authentication headers.

Example:
[
  {
    "key": "X-Request-Source",
    "value": "sigmamind"
  }
]

Response

Created

​
authId
string

Unique identifier for the auth record

Example:

"auth_P3kNz7Yv1Qm9"

​
integrationId
string

Unique identifier of the parent integration

Example:

"intg_AuUKK371Spr5"

​
authType
enum<string>

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.

Available options:
NO_AUTH,
BASIC_AUTH,
BEARER_TOKEN,
API_KEY
Example:

"API_KEY"

​
headers
object

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.

Example:
[
  {
    "key": "X-Request-Source",
    "value": "sigmamind"
  }
]
​
createdAt
string<date-time>

Timestamp when the record was created

​
updatedAt
string<date-time>

Timestamp when the record was last updated