Auth Connections
Update an auth connection
Every field is optional, so editing the allowlist does not force the secret to be re-entered: omitting clientSecret leaves the stored one alone. Changing the secret drops the cached access token, so a rotation takes effect on the next call without a deploy.
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.
Every field optional. Omitting clientSecret leaves the stored one alone.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/api/auth-connections/string" \ -H "Content-Type: application/json" \ -d '{ "allowedHosts": [ "gateway.example.com", "gateway2.example.com" ] }'{ "success": true, "data": { "_id": "6ab3d1f2c4e5a60123456789", "name": "Spring Underwriting", "type": "oauth2_client_credentials_dpop", "tokenUrl": "https://auth.example.com/oauth2/token", "clientId": "client-abc", "scopes": [ "underwriting.read" ], "allowedHosts": [ "gateway.example.com" ], "authorizationScheme": "DPoP", "jwkThumbprint": "5MBNqyGaaNaWVo3c-W7Q5HorbYFA6tHxRlglvb7JDBI", "isActive": true }}