...
| API Section | Required User Role | Available User Management Endpoints | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
operations on any tenant in the system | YUUVIS_SYSTEM_INTEGRATOR |
| |||||||||
| GET /tenant-management/api/system/tenants/{tenant}/users |
| ||||||||||
| POST /tenant-management/api/system/tenants/{tenant}/users |
| ||||||||||
| GET /tenant-management/api/system/tenants/{tenant}/users/{id} |
| ||||||||||
| PUT /tenant-management/api/system/tenants/{tenant}/users/{id} |
| ||||||||||
| DELETE /tenant-management/api/system/tenants/{tenant}/users/{id} |
| ||||||||||
operations on the own tenant | YUUVIS_TENANT_ADMIN | GET /tenant-management/api/admin/users/count |
| ||||||||
| GET /tenant-management/api/admin/users |
| ||||||||||
| POST /tenant-management/api/admin/users |
| ||||||||||
| GET /tenant-management/api/admin/users/{id} |
| ||||||||||
| PUT /tenant-management/api/admin/users/{id} |
| ||||||||||
| DELETE /tenant-management/api/admin/users/{id} |
| ||||||||||
operations on the own tenant | The endpoints are available for every logged-in user. | GET /tenant-management/api/idm/me |
| ||||||||
| GET /tenant-management/api/idm/roles/{role}/users |
| ||||||||||
| GET /tenant-management/api/idm/users |
| ||||||||||
| GET /tenant-management/api/idm/users/{id} |
|
The POST and PUT endpoints allow for the deactivation of users. In object histories, the username of deactivated users is displayed further on. The username is still reserved 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.
User Account Properties
The following properties for user accounts can be managed via the Tenant Management API.
...
| Code Block | ||
|---|---|---|
| ||
[
{
"id": "406b5a28-7a8b-4c36-a569-df7bff480375",
"firstName": "Heinrich",
"lastName": "Schuetzel",
"roles": [
"YUUVIS_SYSTEM_INTEGRATOR",
"YUUVIS_DEFAULT",
"YUUVIS_TENANT_ADMIN",
"HR_MANAGER",
"YUUVIS_CREATE_OBJECT",
"YUUVIS_MANAGE_SETTINGS"
],
"username": "newuser5",
"enabled": true,
"createdTimestamp": 1622122631393
},
{
"id": "320c67d0-b88b-4e99-852a-b938f4b38cd7",
"email": "kammer@segelreisen.de",
"firstName": "Hannes",
"lastName": "Kammer",
"roles": [
"YUUVIS_SYSTEM_INTEGRATOR",
"YUUVIS_DEFAULT",
"YUUVIS_TENANT_ADMIN",
"YUUVIS_CREATE_OBJECT",
"YUUVIS_MANAGE_SETTINGS",
"YUUVIS_AI_PIPELINE",
"COMPLIANCE_MANAGER",
"YUUVIS_AI_PREDICT"
],
"groups": [
"onlyoffice"
],
"username": "kammer",
"enabled": true,
"createdTimestamp": 1591957723730
},
{
"id": "a6f5e1aa-ff42-4140-b9ec-5de4cc61f1a9",
"email": "schwimmer@segelreisen.de",
"firstName": "Klaus",
"lastName": "Schwimmer",
"roles": [
"YUUVIS_SYSTEM_INTEGRATOR",
"YUUVIS_DEFAULT",
"INVOICE_MANAGER",
"YUUVIS_TENANT_ADMIN",
"HR_MANAGER",
"YUUVIS_AIINVOICE",
"EMAIL_WITHOUT_ACL",
"QA_MEMBER_AREA2",
"uma_authorization",
"YUUVIS_CREATE_OBJECT",
"TEAMS_MANAGER",
"PHOTOARCHIVE_MANAGER",
"YUUVIS_MANAGE_SETTINGS",
"QA_MANAGER",
"ACL_ALL_USERS",
"YUUVIS_AI_PIPELINE",
"QA_MEMBER_AREA1",
"COMPLIANCE_MANAGER",
"YUUVIS_AI_PREDICT",
"offline_access"
],
"username": "klaus",
"enabled": true,
"createdTimestamp": 1606820894094
}
] |
Graphical User Interfaces
yuuvis® architect
The User management view of yuuvis® architect provides a graphical interface for administrative users in order to manage users belonging to their tenant. Individual users can be edited or deleted and users can be added. New users will be invited via e-mail to set up their passwords.
>> User Management
yuuvis® management console
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
>> yuuvis® management console
User Settings Management
The USERSERVICE manages user-related data and provides CRUD (create, read, update, delete) operations on it. Its endpoints are provided in an own API.
>> User Settings Endpoints
...