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": {},
  "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

API Key is required in header. You can find it in the settings

Path Parameters

​
integrationId
string
required

Unique identifier for the integration

Body

application/json

Request body to register authentication credentials for a third-party integration. Only populate the fields relevant to the chosen authType — all other credential fields will be ignored.

​
authType
enum<string>
required

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"

​
token
string

The bearer token or JWT access token value. Required when authType is BEARER_TOKEN. Sent as 'Authorization: Bearer ' on every outbound request.

Example:

"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."

​
username
string

The username for Basic authentication. Required when authType is BASIC_AUTH. Combined with password and Base64-encoded into the Authorization header.

Maximum string length: 256
Example:

"api_user@example.com"

​
password
string

The password for Basic authentication. Required when authType is BASIC_AUTH. Combined with username and Base64-encoded into the Authorization header.

Maximum string length: 512
Example:

"s3cretP@ssword"

​
apiKey
object

Describes how an API key is attached to outbound requests. Provide the header or query-param name, the secret value, and the injection position.

Example:
{
  "key": "X-API-KEY",
  "value": "<secret>",
  "position": "header"
}
​
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"
  }
]

Response

OK

​
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>

Authentication strategy

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

"api_key"

​
headers
object

Headers to be sent with the request

​
createdAt
string<date-time>

Timestamp when the record was created

​
updatedAt
string<date-time>

Timestamp when the record was last updated