Versions Compared

Old Version 25

changes.mady.by.user Technische Redaktion

Saved on

compared with

New Version 26

changes.mady.by.user Technische Redaktion

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Page Properties
hiddentrue
idrDOC

Product Version
Report Note
AssigneeMartin

Resources & Remarks

  • Version 2.4 - options" ...  "synchronousContentAnalysis": true (OKTO-4309)

Modification History

NameDateProduct VersionAction
Antje08 FEB 20212.4New page properties macro.
Antje12 FEB 20212020 WinterrDOC
Agnieszka15 FEB 20212020 WinterrLANG



As of Versionproduct version 2020 Winter | component version 1.0
Request MethodPOST
Response FormatJSON
Description


Excerpt
Creates a new user with the given properties.


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 the parameter email specifying the email parameter  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.

It is recommended to deactivate users instead of deleting them. Their user names might be required for compliance issuesreasons.

The user is New users are created with the Keycloak settings shown in the screenshot below (click to enlarge). The first steps the created user has to do are actions newly created users have to carry out are specified under Required User Actions the entries . In this configuration, these are Update Password  and   Update Profile. Hence, the new user has users have to register by setting a password and other user data. An  invitation via email guides the new user The URL to the registration portalpage is specified in the e-mail invitation.

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 CodeMeaning
201 CREATEDSuccessful, the user has been created with the specified properties.
401 UNAUTHORIZEDThe call was unauthorized.


Request Example

Will be introduced with the Release Candidate with the tag 1.1.0-rc2: If the password is not set, but email e-mail and the withInvitation withInvitation call parameter is given with are defined as true, an e-mail invitation mail invitation is sent by Keycloak to the given address by Keycloak.

Panel

POST /api-tm/admin/users?withInvitation%20=true HTTP/1.1

{
  "email": "example@exampleprovider.de"
  "username":: "mrexample",
, "firstName":: "Examplename",
, "lastName":: "Examplesurname",
  "roles": ["role1","role2"],
  "enabled": true,
  "password": "asecurepassword"
}


Response Example


Panel

{
  "id": "a00a0bb1-1234-5c66-7890-00fbb1c1a222"
}