Versions Compared

Old Version 19

changes.mady.by.user Team Kolibri

Saved on

compared with

New Version 20

changes.mady.by.user Technische Redaktion

Saved on

Key

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


Page Properties
hiddentrue


Status

Status
colourGreen
titleFinished

Priority1
Note
AssigneeMartin Bartonitz

Ressources

Remarks

History

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

...

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

Create a new user with the given properties.
Required: user with role YUUVIS_TENANT_ADMIN role

HintsNotes:

  • 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 users instead of deletion if his name is deleting them if their names are needed in case of compliance requirements.
Request Example

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

Panel

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

{
  "email": "bartonitz@optimal-systems.de"
  "username":: "bartonitz",
, "firstName":: "Martin",
, "lastName":: "Bartonitz",
  "roles": ["role1","role2"],
  "enabled": true,
  "password": "asecurepassword"
}


Result Example


Panel

{
  "id": "a69a0eb6-3662-4c00-8096-38fbb2c4a922"
}


Responses
Meaning of the response status codes:

201 CREATED

The user with his properties has been created

401 UNAUTHORIZED

The call was unauthorized

...