Sign in

v1

latestOpenAPI 3.0.12026-07-226992320.0 KB
Integration Auth

Update Integration Auth

Partially updates an existing auth record by authId. Only fields provided in the request body are updated — omitted fields remain unchanged. Returns the updated auth record.

patch/v1/integrations/{integrationId}/auth/{authId}

Path parameters

integrationIdstring required

Unique identifier for the integration

authIdstring required

Unique identifier for the auth record

Request body

tokenstring

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.

usernamestring

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.

passwordstring

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.

Example request

{
  "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"
    }
  ]
}

Response

OK

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"
}