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": [
    {
      "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

​
authId
string
required

Unique identifier for the auth record

Body

application/json

Request body to partially update an existing authentication credential record. Only fields included in the request body are updated — omitted fields are left unchanged. The authType set at creation time is permanent and cannot be changed via this endpoint. Provide only the credential fields that match the original authType.

​
token
string

Replacement bearer token. Applicable only when the auth record was originally created with authType BEARER_TOKEN. Overwrites the previously stored token. The system will use this new value on all subsequent outbound requests. Omit this field to leave the existing token unchanged.

Example:

"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...updated"

​
username
string

Replacement username for Basic authentication. Applicable only when the auth record was originally created with authType BASIC_AUTH. Can be updated independently — omitting this field leaves the existing username unchanged.

Maximum string length: 256
Example:

"new_api_user@example.com"

​
password
string

Replacement password for Basic authentication. Applicable only when the auth record was originally created with authType BASIC_AUTH. Can be updated independently — omitting this field leaves the existing password unchanged.

Maximum string length: 512
Example:

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

Replacement list of static headers attached to every outbound request for this auth record. Pass a non-empty list to overwrite all existing headers with the new set. 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>

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