Versions Compared

Old Version 8

changes.mady.by.user Team Kolibri

Saved on

compared with

New Version Current

changes.mady.by.user Technische Redaktion

Saved on

Key

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


Statusstatus
Page Properties
hiddentrue
id
rDOC

colourYellow
titleDraft
Priority1
Product Version
Report Note
AssigneeMartin
Bartonitz

Ressources

Resources & Remarks

History

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

Modification History

NameDateProduct VersionAction
Antje08 FEB 20212.4New page properties macro.
Antje12 FEB 20212020 WinterrDOC
Antje04 JUN 20212021 Autumngroups added
Antje12 JUL 20222022 Autumnadd YUUVIS_MANAGE_SETTINGS default role



Update
Meaning of the response status codes:

200 OK

The data of the user with the id has been updated

401 UNAUTHORIZED

The call was unauthorized
As of Versionproduct version 2020 Winter | component version 1.0
Request MethodPOSTPUT
Response FormatJSONDescriptionHTTP status code
Required Permission

Available if listed in authorization.accesses in authentication-prod.yml and the specified access condition is matched. In the default configuration, access is granted via the YUUVIS_TENANT_ADMIN and YUUVIS_MANAGE_SETTINGS (as of 2022 Autumn) roles.

>> AUTHENTICATION Service
DescriptionResponses


Excerpt
Updates the data of the user
with the id.
Required: user with role YUUVIS_TENANT_ADMIN
Request Example
Panel

PUT /api-tm/admin/users/05c979a5-1d05-4815-889d-f7bc005d227b HTTP/1.1

{
  "email": "bartonitz@optimal-systems.de"
  "userName":: "bartonitz",
, "firstName":: "Martin",
, "lastName":: "Bartonitz",
  "enabled": true
}

Todo: document "roles"

Result Example

no result

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.

As of version 2022 Summer, the deactivation of users leads to an invalidation of all their active sessions (if the enabled property is changed to false).

As of 2022 Autumn, in the default configuration, users with the YUUVIS_MANAGE_SETTINGS role are allowed to use the endpoint as well. However, they are not allowed to assign the roles YUUVIS_TENANT_ADMIN or YUUVIS_SYSTEM_INTEGRATOR or to update the data of users with at least one of those roles.

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

Code Block
languageyml
{
  "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