Page Comparison

Page Properties

hidden	true
id	rDOC

Product Version
Report Note
Assignee	Martin

Resources & Remarks

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

Modification History

Name	Date	Product Version	Action
Antje	08 FEB 2021	2.4	New page properties macro.
Antje	12 FEB 2021	2020 Winter	rDOC
Agnieszka	15 FEB 2021	2020 Winter	rLANG

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 Version product version 2020 Winter | component version 1.0

Request Method POST

Response Format JSON

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 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 might be required for compliance issues.

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 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.

Request Example

Will come 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

language	yml


  "email": "example@exampleprovider.de"

,
  "username"

:

: "mrexample",

,


  "firstName":

:

 "Examplename",

,


  "lastName":

:

 "Examplesurname",


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


  "enabled": true,


  "password": "asecurepassword"

Response Example

panel

Code Block

language

yml


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

Versions Compared

Old Version 14

New Version Current

Key