...
| Excerpt |
|---|
These endpoints can be used with the role YUUVIS_SYSTEM_INTEGRATOR for role, group and user management for a tenant and to create and delete tenants in Keycloak. |
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/system/** endpoints in the authentication-prod.yml configuration file.
The endpoints are used by the ARCHITECT Servicethat provides yuuvis® architect. If you want to use this service, do not change the default access condition that is matched with the YUUVIS_SYSTEM_INTEGRATOR role.
| HTTP Method as of product version | Purpose | Response Format | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Manage Tenant Creation Profile | |||||||||||
| GET 2020 Winter | Retrieve the Keycloak System Settings | JSON |
/tenant-management/api/system/info | ||||||||
| POST 2020 Winter | Update the Profile | HTTP status code |
/tenant-management/api/system/profile | ||||||||
| GET 2020 Winter | Retrieve the Profile | JSON |
/tenant-management/api/system/profile | ||||||||
Manage Tenants | |||||||||||
| POST 2020 Winter | Create a Tenant | HTTP status code |
/tenant-management/api/system/tenants | ||||||||
| PUT 2020 Winter | Update the Data of a Tenant | HTTP status code | Update the data of the tenant specified by | ||||||||
| GET 2020 Winter | Retrieve the Tenant data | JSON |
/tenant-management/api/system/tenants/{tenant} | ||||||||
| GET 2020 Winter | Retrieve the Data of all Tenants | JSON |
/tenant-management/api/system/tenants | ||||||||
| DELETE 2020 Winter | Delete a Tenant | JSON |
/tenant-management/api/system/tenants/{tenant} | ||||||||
| PATCH 2021 Summer | Update a Tenant | HTTP status code |
/tenant-management/api/system/tenants/{tenant} | ||||||||
| GET 2020 Winter | Retrieve the Number of Users | TXT |
/tenant-management/api/system/tenants/{tenant}/users/count | ||||||||
| POST 2020 Winter | Create a User | JSON |
/tenant-management/api/system/tenants/{tenant}/users | ||||||||
| PUT 2020 Winter | Update the Data of a User | HTTP status code |
/tenant-management/api/system/tenants/{tenant}/users/{id} | ||||||||
GET | Request a List of Users | JSON |
/tenant-management/api/system/tenants/{tenant}/users | ||||||||
| GET 2020 Winter | Retrieve the Data of a User | JSON |
/tenant-management/api/system/tenants/{tenant}/users/{id} | ||||||||
| DELETE 2020 Winter | Delete a User | HTTP status code |
/tenant-management/api/system/tenants/{tenant}/users/{id} | ||||||||
| GET 2020 Winter | Retrieve the Roles | JSON |
/tenant-management/api/system/tenants/{tenant}/roles | ||||||||
| POST 2021 Autumn | Create a Role | JSON |
/tenant-management/api/system/tenants/{tenant}/roles | ||||||||
| DELETE 2021 Autumn | Delete a Role | JSON |
/tenant-management/api/system/tenants/{tenant}/role/{name} | ||||||||
| GET 2021 Autumn | Retrieve the Groups | JSON |
/tenant-management/api/system/tenants/{tenant}/groups | ||||||||
| POST 2021 Autumn | Create a Group | JSON |
/tenant-management/api/system/tenants/{tenant}/groups | ||||||||
| GET 2021 Autumn | Retrieve a Group | JSON |
/tenant-management/api/system/tenants/{tenant}/groups/{id} | ||||||||
| PUT 2021 Autumn | Update a Group | JSON |
/tenant-management/api/system/tenants/{tenant}/groups/{id} | ||||||||
| DELETE 2021 Autumn | Delete a Group | HTTP status code |
/tenant-management/api/system/tenants/{tenant}/groups/{id} | ||||||||
GET deprecated as of 2023 Autumn | Retrieve the Current Metrics | JSON | Reads the current metrics of the specified tenant./tenant-management/api/system/tenants/{tenant}/metrics | ||||||||