Everything within this section is only visible while editing. Use Page Properties ID "STUB", "REFACTURE", "PROGRESS", "rDEV", "rDOC", "rLANG" and "DONE".

Everything contained within the table is displayed in the (INTERNAL) Reports page.

Product Version2.4
Report Notepublished, ongoing work
AssigneeMartin

Resources & Remarks

Modification History

Add a new line to this table and fill it whenever you edit the page.

NameDateProduct VersionAction
Antje08 JUN 20212021 Autumnpage created
Antje14 JUL 20222022 Autumnadd default role YUUVIS_MANAGE_SETTINGS



These endpoints can be used for role, group and user management in Keycloak within the own tenant. Administrative tenant-specific information can be retrieved as well.


They are provided by the TENANT-MANAGEMENT service.

The access to the endpoints has to be limited to administrative users as specified with the permission for /tenant-management/api/admin/** endpoints in the authentication-prod.yml configuration file.

The endpoints are used by the ARCHITECT Service that provides yuuvis® architect. If you want to use this service, do not change the default access condition that is matched with the YUUVIS_TENANT_ADMIN role.

As of 2022 Autumn, in the default configuration, users with the YUUVIS_MANAGE_SETTINGS role are allowed to manage users of their own tenant as well. They have access to all endpoints /tenant-management/api/admin/users/**. However, the following operations are not allowed for them:

HTTP Method
as of product version		PurposeResponse FormatDescription
GET
2020 Winter
Retrieve the Tenant data JSON


/tenant-management/api/admin/tenant

GET
2020 Winter
Retrieve the Number of Users TXT


/tenant-management/api/admin/users/count

POST
2020 Winter
Create a UserJSON


/tenant-management/api/admin/users

POST
2020 Winter
Create a User via CSVJSON

Creates users listed in a CSV-based file.
/api-tm/admin/users/batchcreate

Note: Keycloak does not offer an API for creating more than one user in one call. So you may want to create multiple users one by one by yourself.

GET
2020 Winter		Retrieve a UserJSON


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

PUT
2020 Winter
Update the Data of a UserHTTP status code


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

DELETE
2020 Winter
Delete a UserHTTP status code


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

GET
2020 Winter

Retrieve a List of UsersJSON


/tenant-management/api/admin/users

GET
2020 Winter
Retrieve the RolesJSON


/tenant-management/api/admin/roles

POST
2021 Autumn
Create a RoleJSON


/tenant-management/api/admin/roles

DELETE
2021 Autumn
Delete a RoleJSON


/tenant-management/api/admin/role/{name}

GET
2021 Autumn
Retrieve the GroupsJSON


/tenant-management/api/admin/groups

POST
2021 Autumn
Create a GroupJSON


/tenant-management/api/admin/groups

GET
2021 Autumn
Retrieve a GroupJSON


/tenant-management/api/admin/groups/{id}

PUT
2021 Autumn
Update a GroupJSON


/tenant-management/api/admin/groups/{id}

DELETE
2021 Autumn		Delete a GroupJSON


/tenant-management/api/admin/groups/{id}

GET
2021 Spring

deprecated as of 2023 Autumn

Retrieve the Current Metrics JSONReads the current metrics of the specified tenant.
/tenant-management/api/admin/metrics