The Provider object

The Provider object.

NameTypeDescription
idUUIDA unique identifier.
gender"MALE" | "FEMALE"?
first_namestring
last_namestring
phonestring?The phone number of the provider, in E.164 format.
emailstring?The email of the provider. It will be used to authenticate the provider.
prefixstring?
titlestring?
timezonestring?
roles"ADMINISTRATOR" | "PRACTITIONER" | "REVIEWER"[]
biographystring?The biography of the provider.
metadataJSON?You can use this parameter to attach key-value data to the object. All values must be of type string.
ephemeral_avatar_urlundefined?The ephemeral URL pointing to the provider's avatar, if it has been defined by the provider in the Console. This url is read-only as it is automatically and periodically updated for security reasons.
self_login_enabledboolean

Example

{
  "id": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6",
  "gender": "FEMALE",
  "first_name": "Jane",
  "last_name": "Doe",
  "phone": "+33612356789",
  "email": "example_string",
  "prefix": "Pr",
  "title": "Professor",
  "timezone": "Europe/Paris",
  "roles": [
    "ADMINISTRATOR"
  ],
  "biography": "Dr John Doe, MD is a graduate of George Washington University School of Medicine.",
  "metadata": {
    "example_key": "example_string"
  },
  "ephemeral_avatar_url": {
    "url": "https://example.com",
    "expires_at": "2022-06-24T14:36:22"
  },
  "self_login_enabled": true
}