PUT /tenant-management/api/admin/users/{id}

As of Version product version 2020 Winter | component version 1.0

Request Method PUT

Response Format HTTP status code

Description

Updates the data of the user specified by id with the data passed in the request body in JSON format.

As of version 2021 Autumn, this endpoint does not allow for the assignment of the role YUUVIS_SYSTEM_INTEGRATOR to a user. If this role is passed as an entry of the roles list, the endpoint will return an error.

Required user role: YUUVIS_TENANT_ADMIN

Meaning of the response status codes:

HTTP Status Code Meaning

200 OK Successful, the data for the specified user have been updated.

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

PUT /tenant-management/api/admin/users/a99a0bb1-2345-6c77-8901-22dee3f4a567 HTTP/1.1

{
  "email": "example@exampleprovider.de",
  "userName": "mrexample",
  "firstName": "Examplename",
  "lastName": "Examplesurname",
  "roles": ["role1","role2"],
  "groups": ["mygroup","specialgroup","group2"],
  "enabled": true,
  "createdTimestamp": 1555069963564
}

Response Example

200 OK

no response body