Auth Connections
Test the credentials
Performs a real client-credentials token request against the gateway, bypassing the cache, so a bad credential is found here rather than inside a customer-facing workflow run. The token itself is never returned; the response carries only whether it worked and when it expires. The outcome is also stored for the health display.
Authorization
bearerAuth In: header
Path Parameters
The connection id. Must be an ObjectId.
^[a-f\d]{24}$Query Parameters
Organization to act on. Defaults to the caller's own when omitted or empty. Only a SUPERADMIN may name a different one; an ADMIN doing so is refused with 403, and a value that is not an ObjectId is refused with 400 rather than falling back to the caller's own organization.
^[a-f\d]{24}$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
No fields. The connection under test is named in the path.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/auth-connections/string/test" \ -H "Content-Type: application/json" \ -d '{}'{ "success": true, "data": { "ok": true, "expiresAt": "2026-09-24T11:00:00.000Z", "tokenType": "DPoP" }}