API Reference

Invite a User

post
https://project-api.zapehr.com/v1/user/invite

Invite a User to the Project. Users are the people who log into the Applications you configure for securing the apps you build on top of Oystehr.

Access Policy Action: App:CreateUser
Access Policy Resource: App:User

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

A name for the User to help you differentiate them from other Users in the project. Defaults to the User's email or phone number if not provided.

string | null
required

The User's email address.

string | null

The User's phone number.

accessPolicy
object

The User's inline access policy. Either this or the roles property must be set. If both are set, the inline access policy is merged with the access policies defined by "roles"

ssoData
object

ssoData contains information about the user from a third-party SSO identity provider. For example, if you send a upn or other information in a SAML payload, it is stored here. It is only populated if the User authenticated via SSO with a third-party identity provider.

uuid
required

The application ID to which you want to invite a user

resource
object
required

A valid Patient or Practitioner FHIR Resource which will be created and become the User's 'profile'.

roles
array of uuids

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

roles
string

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

Responses

Updated about 1 year ago

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

Updated about 1 year ago