Create an API client

The secret is returned ONCE, in this response, and is stored only as a hash. There is no way to read it back — a lost secret has to be rotated.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 128
string
required
length between 8 and 256
string
enum
required

Validated against the assignable roles rather than the full enum, so this
MANAGER-gated route cannot mint a cross-tenant SUPER_ADMIN credential.

Allowed:
string
length ≤ 200
uri
string
length between 16 and 256
events
array of strings
length ≥ 1
events
Responses

400

The payload failed validation, or the clientId is taken.

401

Missing, malformed or unrecognised Basic credentials.

403

Authenticated, but the client's role does not permit this, or it is not attached to the patient.

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json