POST /api-tm/system/tenants/{tenant}/users

As of Version product version 2020 Winter | component version 1.0

Request Method POST

Response Format JSON

Description

Create 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 the parameter email is recommended. The specified email 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.

The user is created with the Keycloak settings shown in the screenshot below under Required User Actions (click to enlarge). Hence, the new user has to register by setting a password and other user data. The invitation via email guides the new user to the registration portal.

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.

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.

POST /api-tm/system/tenants/{tenant}/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

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