Sign in

v1

latestOpenAPI 3.0.12026-07-226992320.0 KB
Integration Auth

Get Integration Auth

Retrieves the full details of a single auth record by authId. Returns the auth type, credential metadata, and associated integration. Sensitive credential values are not returned after creation.

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

Path parameters

integrationIdstring required

Unique identifier for the integration

authIdstring required

Unique identifier for the auth record

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