Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

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

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

Hints:

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

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 HTTP/1.1

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

Todo: document "roles"

Result Example

{
  "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

  • No labels