| Excerpt |
|---|
| Create Creates a new user with the given properties for the specified tenant. |
Required user role: YUUVIS_TENANT_ADMIN
The properties for the new user are passed in JSON format. In the response, the user ID is returned again in JSON format.
The only required parameter is username, but specifying the email parameter email is recommended. The specified email e-mail address is used for invitation after creation and in the scenario of a forgotten password.The option to disable a user is the recommended alternative instead of a deletion. The username to invite users after they have been created and in case they have forgotten their password. If no SMTP parameters are set for a new user, no invitation e-mail can be sent. The currently logged-in user will be informed.
It is recommended to deactivate users instead of deleting them. Their user names might be required for compliance issuesreasons.
New users are forced to set a new password while following the link in the invitation email as well as to update his user data, as can be seen in the Required User Actions in this Keycloak add user dialog.
Image Removedcreated with the Keycloak settings shown in the screenshot below (click to enlarge). The first actions newly created users have to carry out are specified under Required User Actions. In this configuration, these are Update Password and Update Profile. Hence, new users have to register by setting a password and other user data. The URL to the registration page is specified in the e-mail invitation.
Image Added
yuuvis® Momentum client as reference implementation displays the user's name in the following format: lastName, firstName (username).
Meaning of the response status codes:
| HTTP Status Code | Meaning |
|---|
201 CREATED | Successful, the user with the specified properties has been created. |
401 UNAUTHORIZED | The call was unauthorized. |
409 CONFLICT | At least one of the following situations occurred: - The username is not unique.
- The email address is not unique.
- The email address or password must be set.
- The role {ROLE_NAME} was not found.
- The group {GROUP_NAME} was not found.
|