Auth Connections

Get one auth connection

GET
/api/auth-connections/{connectionId}

Scoped to the organization, so a connection belonging to another one reads as 404 rather than 403. Credentials are not included.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

connectionId*string

The connection id. Must be an ObjectId.

Match^[a-f\d]{24}$

Query Parameters

organizationId?string

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.

Match^[a-f\d]{24}$

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/auth-connections/string"
{  "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  }}