Revoke an SDK connection

Monotonically revokes an app-owned SDK connection and terminates connection-authorized access. Internal enforcement artifacts are not exposed on the public API.

POST/api/sdk/v1/connections/{connectionId}:revoke

Monotonically revokes an app-owned SDK connection and terminates connection-authorized access. Internal enforcement artifacts are not exposed on the public API.

Authorization

platformApiKey

AuthorizationBearer <token>

CuraeAI Platform API key using the format Bearer . Keys are opaque credentials such as cae_live_..., not JWTs.

In: header

Path Parameters

connectionId*string

Header Parameters

Idempotency-Key*string

Required idempotency key for safe connection-revoke retries.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

reason?string

Response Body

`application/json`

`application/problem+json`

curl -X POST "https://example.com/api/sdk/v1/connections/497f6eca-6276-4993-bfeb-53cbbbba6f08:revoke" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

{  "connection": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "customerAccountId": "d8c60791-7301-441c-98e8-5bea9a162d9b",    "appUserId": "string",    "status": "PENDING",    "dataPackages": [      "clinical_summary"    ],    "authorizedAt": "2019-08-24T14:15:22Z",    "expiresAt": "2019-08-24T14:15:22Z",    "revokedAt": "2019-08-24T14:15:22Z",    "actionRequiredReason": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "revokedNow": true}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "code": "string",  "details": {},  "retryable": true}