Versions Compared

Key

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


Page Properties
hiddentrue
idrDOC

Product Version
Report Note
AssigneeMartin

Resources & Remarks

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

Modification History

NameDateProduct VersionAction
Antje08 FEB 20212.4New page properties macro.
Antje16 FEB 20212020 WinterrDOC
Agnieszka17 FEB 20212020 WinterrLANG
Antje04 JUN 20212021 Autumngroups added


...

As of Versionproduct version 2020 Winter | component version 1.0
Request MethodPOST
Response FormatJSON
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_SYSTEM_INTEGRATOR role.

>> >> AUTHENTICATION Service
Description


Excerpt
Update the data of the user specified by tenant and id.


The properties for the new user are passed in JSON format.

The specified e-mail address is used in case users have forgotten their password.

It is recommended to deactivate users instead of deleting them. Their user names might be required for compliance reasons.

yuuvis® Momentum client as reference implementation displays the user's name in the following format: lastName, firstName (username).

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).

Meaning of the response status codes:


HTTP Status CodeMeaning
200 OKSuccessful, the data of the user with the specified tenant and id have been updated.
401 UNAUTHORIZEDThe call was unauthorized.
404 NOT FOUNDThe user with the id was not found.
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/tenants/myTenant/users/a69a0eb6-3662-4c00-8096-38fbb2c4a922 HTTP/1.1

Code Block
languageyml
{
  "email": "firstexample@exampleprovider.de"
  "userName": "mrexample",
  "firstName": "Examplename",
  "lastName": "Examplesurname", 
  "roles": ["YUUVIS_DEFAULT","YUUVIS_CREATE_OBJECT"],
  "groups": ["group1","group4"],
  "enabled": true
}


Response Example

200 OK

no response body

...