Users are the admins who interact with the Prospero platform. Users can belong to more than one Organization.
End-users (i.e., bookers, schedule viewers, etc.) do not possess User accounts.
Update a User
Updates the specified User by setting the values of the fields passed. Any fields not provided will be left unchanged. By design, you cannot change a User's id.
path Parameters
userIdstring · uuid · requiredThe id of the
User.
Request Body
idstring · uuid · readOnlyThe globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnlyAn ISO 8601-compliant datetime string, formatted
YYYY-MM-DDThh:mm:ssZ.lastUpdatedAtstring · date-time · readOnlyAn ISO 8601-compliant datetime string, formatted
YYYY-MM-DDThh:mm:ssZ.fullNamestringDisplayed in the admin app and email notifications.
emailstring · emailUsed for authentication and email notifications.
photoIdstring · uuidThe UUID of an image stored in Cloudflare Images.
orgIdsstring[] · readOnlyThe ids of the
OrganizationstheUseris a member of.accountStatusinteger · enumThe status of the
User'saccount. Active accounts can login and access the Prospero API. Deactivated accounts cannot login nor access the Prospero API.0 =
ACTIVE, 1 =DEACTIVATEDEnum values:01onboardedboolean · readOnlyWhether the
Userhas completed the initial onboarding process.Usersthat are not onboarded will not be able to access the admin application without completing onboarding.authorizationobjectThe permission levels for access to the admin application and Prospero API.
googleobjectGoogle integration settings.
microsoftobject · readOnlyMicrosoft integration settings.
Responses
The updated User.
userobject