Create an M2M client

Create a new M2M Client. M2M Clients are used to access Oystehr APIs from scripts and server-side code like Zambda Functions.

Access Policy Action: App:CreateM2MClient
Access Policy Resource: IAM:M2MClient

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

A name for the M2M Client to help you differentiate it from other M2M Clients in the project.

string

A description of the M2M Client to help you differentiate it from other M2M Clients in the project.

accessPolicy
object

An access policy to assign to this M2M Client

roles
array of uuids

A list of Role IDs to assign to the M2M client. If the accessPolicy property is not provided this property is required and may not be empty.

roles
string

An URL of JWK set used for getting an access token by signed authentication JWT

string

A relative reference to a FHIR relative reference of the format Patient/{uuidV4}. Resource type must be one of Patient, Practitioner, Device.

Responses

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