This endpoint allows users with the "Platform management: Users" permission to add a user to their organization. This is a synchronous call that returns the user ID of the created user in the response.
A user can be added to SafetyCulture with or without a password. In both cases, the request would send the new user an email to notify that they've been added to the organization.
If no password is given when a user is added, the user calling the API can indicate in the request if they would like the added user to set a password the first time they access SafetyCulture or to not set a password at all (e.g. for user that are to access SafetyCulture only via single sign-on).
Upon successful addition of a user:
- If a password was submitted for that user in the request, the user will receive an email with a link to the SafetyCulture login screen so that user can sign in with the provisioned password to access SafetyCulture.
- If no password was submitted for that user in the the
Add Userrequest and thereset_password_requiredflag was set totruefor that user in the request,
then that user receives an email notifying them they have been added to the organization and inviting them to access SafetyCulture in their default web browser. Clicking the link takes the user to a page asking them to set a password in order to continue. - If no password was submitted for that user in the the
Add Userand thereset_password_requiredflag was set tofalsefor that user in the request (the default behaviour),
then that user receives an email notifying them they have been added to the organization and inviting them to access SafetyCulture in their default web browser. Clicking the link takes the user straight into a single-sign-on page to login with their company credentials in order to access SafetyCulture.
Special cases:
If the user was added to the organization earlier and was de-activated or removed,
then adding the user via the API will cause an email to be sent to the user asking the user to re-activate their account.
If the user added to the organization already existed in SafetyCulture, any password provided with the Add User request will be ignored. The user will still be able to log in to SafetyCulture with their old password.
Administrator users can only add users to the organization that they belong to.
It may take a few seconds until a newly added user is visible by other endpoints like those used to List group or organization users.