...
| 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 tenant. | ||||||||||||||
| 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 | |||||||||||
| Insert excerpt | POST /tenant-management/api/system/tenants/{tenant}/roles | POST /tenant-management/api/system/tenants/{tenant}/roles | |||||||||||||||
| nopanel | true | DELETE 2021 Autumn | Delete a Role | JSON | |||||||||||||
| Insert excerpt | DELETE /tenant-management/api/system/tenants/{tenant}/role/{name} | DELETE /tenant-management/api/system/tenants/{tenant}/role/{name} | |||||||||||||||
| nopanel | true | GET 2021 Autumn | Retrieve the Groups | JSON | |||||||||||||
| Insert excerpt | GET /tenant-management/api/system/tenants/{tenant}/groups | GET /tenant-management/api/system/tenants/{tenant}/groups | |||||||||||||||
| nopanel | true | POST 2021 Autumn | Create a Group | JSON | |||||||||||||
| Insert excerpt | POST /tenant-management/api/system/tenants/{tenant}/groups | POST /tenant-management/api/system/tenants/{tenant}/groups | |||||||||||||||
| nopanel | true | PUT 2021 Autumn | Update a Group | JSON | |||||||||||||
| Insert excerpt | PUT /tenant-management/api/system/tenants/{tenant}/groups/{id} | PUT /tenant-management/api/system/tenants/{tenant}/groups/{id} | |||||||||||||||
| nopanel | true | DELETE 2021 Autumn | Delete a Group | HTTP status code | |||||||||||||
| Insert excerpt | DELETE /tenant-management/api/system/tenants/{tenant}/groups/{id} | DELETE /tenant-management/api/system/tenants/{tenant}/groups/{id} | |||||||||||||||
| nopanel | true | ||||||||||||||||
| GET 2021 Summer | Retrieve the Current Metrics | JSON | Reads the current metrics of the specified tenant. /tenant-management/api/system/tenants/{tenant}/metrics | ||||||||||||||