...
The POST and PUT endpoints allow for the deactivation of users. In object histories, the username of deactivated users is displayed further on. The In the client framework components, the username is still reserved by the Web-API Gateway as the user still exists in the corresponding tenant. In order to reuse the username of deactivated users for a new users, you may append -disabled
to the original username. Thus, the deactivated user can still be identified in the object history and the username can be reused at the same time.
...
Property | Type | in Creation Request Bodies | in Update Request Bodies | in Response Bodies | Description |
---|---|---|---|---|---|
id | string | Ignored. | Ignored. | Included. | The ID of the user for identification in the identity management system and in yuuvis® Momentum. |
email | string | Required if invitation via email is desired. | Optional, unchanged if not specified. | Included if available. | The e-mail address of the user. |
firstName | string | Optional. | Optional, unchanged if not specified. | Included if available. | The first name of the user. |
lastName | string | Optional. | Optional, unchanged if not specified. | Included if available. | The last name of the user. |
roles | list of string role names | Optional. | Optional, unchanged if not specified. Note: Changes can be applied also by assigning/removing groups. | Included if available. Includes roles assigned via groups if available. | A list of roles defined in the identity management system that are assigned to the user. |
groups | list of string group names | Optional. | Optional, removed from data set if not specified. | Included if available. | A list of groups defined in the identity management system in which the assigned user is a member. |
username | string | Required. | Optional, unchanged if not specified. | Included. | The username of the user. |
enabled | boolean | Optional, default: true. | Optional, unchanged if not specified. | Included. | Specifies whether the user is allowed to log in (true ) or not (false ). |
createdTimestamp | datetime / stringin ISO format | Ignored. | Ignored. | Included. | Date and time of user creation in the identity provider. |
User Account Data Sets
For each user account represented in a request or response body, its properties are specified in JSON format. The order of the individual properties within one data set is arbitrary.
...