v2

latestOpenAPI 3.1.12026-08-078549932.4 MB
Users

Update an existing user's profile

put/Users/{id}

Path parameters

idstring required

User ID (Firebase UID)

Request body

firstNamestring nullable
lastNamestring nullable
displayNamestring nullable
typeinteger
roleIdstring nullable
mentorIdstring nullable
clearMentorboolean nullable
deaNumberstring nullable
licenseNumberstring nullable
licenseStatestring nullable
usdaNumberstring nullable
deaLicenseExpiryDatestring date-time nullable
stateLicenseExpiryDatestring date-time nullable
usdaLicenseExpiryDatestring date-time nullable
signatureImagestring nullable

The provider's stored signature as a data:image/...;base64, data URL. Send an empty string to clear the signature, a data URL to set it, or omit to leave unchanged.

defaultExamTemplateIdstring nullable

Provider's selected default exam template id. Send empty string to clear (use built-in 7-system view) or omit to leave unchanged.

Response

Updated user profile

idstring
emailstring
displayNamestring nullable
firstNamestring
lastNamestring
typeinteger
createdAtstring date-time
updatedAtstring date-time nullable
lastLoginAtstring date-time nullable
isActiveboolean
roleIdstring nullable
roleNamestring nullable
permissionsstring[] nullable
invitedAtstring date-time nullable
passwordResetRequiredboolean
mentorIdstring nullable
mentorNamestring nullable
mentorshipStartDatestring date-time nullable
isMentorshipActiveboolean
isPrimaryProviderboolean
deaNumberstring nullable
licenseNumberstring nullable
licenseStatestring nullable
usdaNumberstring nullable
deaLicenseExpiryDatestring date-time nullable
stateLicenseExpiryDatestring date-time nullable
usdaLicenseExpiryDatestring date-time nullable
signatureImagestring nullable

The provider's stored signature as a data:image/...;base64, data URL, applied to generated documents (e.g. the vaccine certificate). Null when none on file.

defaultExamTemplateIdstring nullable

Provider's selected default exam template id, or null to use the built-in 7-system view.