Versions Compared

Old Version 13

changes.mady.by.user Technische Redaktion

Saved on

compared with

New Version Current

changes.mady.by.user Technische Redaktion

Saved on

Key

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


Page Properties
hiddentrue
idDONErDOC

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



Will come with Release Candidate with POST /api-tm

to the specified address by Keycloak.

POST /tenant-management/api/system/tenants/{tenant}/users?withInvitation=true HTTP/1.1

If the parameter withInvitation is not given the default is "true".

Beginning with 2021 Autumn Alpha 4: 
POST /tenant-management/api/system/tenants/{tenant}/users?

withInvitation%20

withInvitation=true

HTTP

&temporaryPassword=false HTTP/1.1

If the temporaryPassword parameter is not specified, the default is "true".

As of Versionproduct version 2.4 2020 Winter | component version 1.0
Request MethodPOST
Response FormatJSON
Required Permission

Available if listed in authorization.accesses in authentication-prod.yml and the specified access condition is matched. In the default configuration, access is granted via the YUUVIS_SYSTEM_INTEGRATOR role.

>> AUTHENTICATION Service
Description


Excerpt
Create
Creates a new user with the given properties for the specified tenant.
Required: user with role YUUVIS_TENANT_ADMIN

Hints:

  • Only username is mandatory but email is recommended.
  • The reference client shows the user data in this format: lastName, firstName (username)
  • email is used when the user clicks 'Password forgotten' on the login dialog or in case of an invitation after creation.
  • It is recommended to disable a user instead of deletion if his name is needed in case of compliance requirements.
Request Example


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 is recommended. The specified e-mail address is used 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 reasons.

New users are created 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 CodeMeaning
201 CREATEDSuccessful, the user with the specified properties has been created.
401 UNAUTHORIZEDThe 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.


Request Example

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

Panel
Code Block
languageyml
{


  "email": "
bartonitz@optimal-systems
example@exampleprovider.de"

,
  "username":
:
 "
bartonitz
mrexample",

,

  "firstName":
:
 "
Martin
Examplename",

,

  "lastName"
:
: "
Bartonitz
Examplesurname",


  "roles": ["role1","role2"],
  "groups": ["group3","group1","group5"],


  "enabled": true,


  "password": "asecurepassword"


}


Result Response Example
Meaning of the response status codes:

201 CREATED

The user with his properties has been created

401 UNAUTHORIZED

The call was unauthorized


Panelcode
languageyml
{


  "id": "
a69a0eb6
a00a0bb1-
3662
1234-
4c00
5c66-
8096
7890-
38fbb2c4a922
00fbb1c1a222"

}
Responses

}