Skip to main content
PATCH
Disable a credential
A connection can hold several sets of EHR credentials. Disabling one takes it out of rotation without removing it, so you can re-enable it later. Sessions already running on that credential are not interrupted. credentialId is the UUID of the credential set. Account events carry it as credential_id, so you can disable the exact credential an event reports on — see Account Events. A connection must always keep one active credential set, so disabling the last one returns 409.

Example Request

Example Response

Last Active Credential

Authorizations

client_id
string
header
required
client_secret
string
header
required
access_token
string
header
required

Path Parameters

credentialId
string
required

Credential set ID (UUID).

Example:

"3f1c2a5e-9b7d-4c21-8f0a-6d5e4b3a2c10"

Response

Credential disabled

success
boolean
required
Example:

true

message
string
required
Example:

"Credential disabled"