Skip to main content
PATCH
/
v1
/
integrations
/
{integrationId}
/
auth
/
{authId}
Update Integration Auth
curl --request PATCH \
  --url https://api.sigmamind.ai/v1/integrations/{integrationId}/auth/{authId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...updated",
  "username": "new_api_user@example.com",
  "password": "newS3cretP@ssword",
  "apiKey": {
    "key": "X-API-KEY",
    "value": "<secret>",
    "position": "header"
  },
  "headers": [
    [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ]
  ]
}
'
{
  "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

​
authId
string
required

Unique identifier for the auth record

Body

application/json

Request body to partially update an existing auth credential record. Only the fields provided will be updated — omitted fields remain unchanged. Credential fields (token, username, password, apiKey) are patched within the existing authType; the authType itself cannot be changed after creation.

​
token
string

Updated bearer token value. Only applicable when the auth record was created with authType BEARER_TOKEN. Replaces the previously stored token.

Example:

"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...updated"

​
username
string

Updated username for Basic authentication. Only applicable when the auth record was created with authType BASIC_AUTH.

Maximum string length: 256
Example:

"new_api_user@example.com"

​
password
string

Updated password for Basic authentication. Only applicable when the auth record was created with authType BASIC_AUTH.

Maximum string length: 512
Example:

"newS3cretP@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[]

Replaces the complete list of static headers for this auth record. Pass a non-empty list to overwrite existing headers. Pass an empty list [] to remove all headers. Omit this field entirely to leave existing headers unchanged.

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