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

Owned by Technische Redaktion
Nov 12, 2021
1 min read
As of Versionproduct version 2020 Winter | component version 1.0
Request MethodPUT
Response FormatHTTP 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 YUUVIS_SYSTEM_INTEGRATOR role 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 CodeMeaning
200 OKSuccessful, the data for the specified user have been updated.
401 UNAUTHORIZEDThe call was unauthorized.
409 CONFLICT

At least one of the following situations occurred:

  • The user name is not unique.
  • The e-mail address is not unique.
  • The e-mail 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