Page Properties | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
Resources & Remarks
Modification History
|
...
As of Version | product version 2020 Winter | component version 1.0 | ||||||||
---|---|---|---|---|---|---|---|---|---|
Request Method | POST | ||||||||
Response Format | JSON | ||||||||
Description |
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 The option to disable a user is the recommended alternative instead of a deletion. The username might be required for compliance issues. 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. The user is created with the Keycloak settings shown in the screenshot below under Required User Actions (click to enlarge). Hence, the new user has to register by setting a password and other user data. The invitation via email guides the new user to the registration portal. yuuvis® Momentum client as reference implementation displays the user's name in the following format: Meaning of the response status codes:
| ||||||||
Request Example | Will come with Release Candidate with tag 1.1.0-rc2: If the password is not set but email and the call parameter withInvitation is given with true an invitation email is sent by Keycloak to the given address.
| ||||||||
Response Example |
|