Versions Compared

Old Version 13

changes.mady.by.user Technische Redaktion

Saved on

compared with

New Version 14

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



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


Excerpt
Create a new user with the given properties for the specified tenant.


Required : user with role: YUUVIS_TENANT_ADMIN

Hints:

Only username is mandatory but

The properties for the new user are passed in JSON format.

The only required parameter is username, but the parameter email is recommended. The specified email address is used for invitation after creation and in the scenario of a forgotten password.

The

reference client shows the user data in this format:

option to disable a user is the recommended alternative instead of a deletion. The username might be required for compliance issues.

yuuvis® Momentum client as reference implementation displays the user's name in the following 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

    .

    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.


    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.

    Panel

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

    {
      "email": "bartonitz@optimal-systemsexample@exampleprovider.de"
      "username":: "bartonitzmrexample",
    , "firstName":: "    MartinExamplename",
    , "lastName":: "BartonitzExamplesurname",
      "roles": ["role1","role2"],
      "enabled": true,
      "password": "asecurepassword"
    }


    Result Response Example


    Panel

    {
      "id": "a69a0eb6a00a0bb1-36621234-4c005c66-80967890-38fbb2c4a92200fbb1c1a222"
    }

    		Responses
    Meaning of the response status codes:

    201 CREATED

    The user with his properties has been created

    401 UNAUTHORIZED

    The call was unauthorized