HTTP Method
as of product version | Purpose | Response Format | Description |
|---|
| Manage Tenant Creation Profile |
GET
2020 Winter
| Retrieve the Keycloak System Settings | JSON | | Insert excerpt |
|---|
| GET /tenant-management/api/system/info |
|---|
| GET /tenant-management/api/system/info |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/system/info |
POST
2020 Winter
| Update the Profile | HTTP status code | | Insert excerpt |
|---|
| POST /tenant-management/api/system/profile |
|---|
| POST /tenant-management/api/system/profile |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/system/profile |
GET
2020 Winter
| Retrieve the Profile | JSON | | Insert excerpt |
|---|
| GET /tenant-management/api/system/profile |
|---|
| GET /tenant-management/api/system/profile |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/system/profile |
| Manage Tenants |
POST
2020 Winter
| Create a Tenant | HTTP status code | | Insert excerpt |
|---|
| POST /tenant-management/api/system/tenants |
|---|
| POST /tenant-management/api/system/tenants |
|---|
| nopanel | true |
|---|
|
/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.
/tenant-management/api/system/tenants/{tenant} |
GET
2020 Winter
| Retrieve the Tenant data | JSON | | Insert excerpt |
|---|
| GET /tenant-management/api/system/tenants/{tenant} |
|---|
| GET /tenant-management/api/system/tenants/{tenant} |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/system/tenants/{tenant} |
GET
2020 Winter
| Retrieve the Data of all Tenants | JSON | | Insert excerpt |
|---|
| GET /tenant-management/api/system/tenants |
|---|
| GET /tenant-management/api/system/tenants |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/system/tenants |
DELETE
2020 Winter
| Delete a Tenant | JSON | | Insert excerpt |
|---|
| DELETE /tenant-management/api/system/tenants/{tenant} |
|---|
| DELETE /tenant-management/api/system/tenants/{tenant} |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/system/tenants/{tenant} |
PATCH
2021 Summer | Update a Tenant | HTTP status code | | Insert excerpt |
|---|
| PATCH /tenant-management/api/system/tenants/{tenant} |
|---|
| PATCH /tenant-management/api/system/tenants/{tenant} |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/system/tenants/{tenant} |
GET
2020 Winter
| Retrieve the Number of Users | TXT | | Insert excerpt |
|---|
| GET /tenant-management/api/system/tenants/{tenant}/users/count |
|---|
| GET /tenant-management/api/system/tenants/{tenant}/users/count |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/system/tenants/{tenant}/users/count |
POST
2020 Winter
| Create a User | JSON | | Insert excerpt |
|---|
| POST /tenant-management/api/system/tenants/{tenant}/users |
|---|
| POST /tenant-management/api/system/tenants/{tenant}/users |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/system/tenants/{tenant}/users |
PUT
2020 Winter
| Update the Data of a User | HTTP status code | | Insert excerpt |
|---|
| PUT /tenant-management/api/system/tenants/{tenant}/users/{id} |
|---|
| PUT /tenant-management/api/system/tenants/{tenant}/users/{id} |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/system/tenants/{tenant}/users/{id} |
GET
2020 Winter
| Request a List of Users | JSON | | Insert excerpt |
|---|
| GET /tenant-management/api/system/tenants/{tenant}/users |
|---|
| GET /tenant-management/api/system/tenants/{tenant}/users |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/system/tenants/{tenant}/users |
GET
2020 Winter
| Retrieve the Data of a User | JSON | | Insert excerpt |
|---|
| GET /tenant-management/api/system/tenants/{tenant}/users/{id} |
|---|
| GET /tenant-management/api/system/tenants/{tenant}/users/{id} |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/system/tenants/{tenant}/users/{id} |
DELETE
2020 Winter
| Delete a User | HTTP status code | | Insert excerpt |
|---|
| DELETE /tenant-management/api/system/tenants/{tenant}/users/{id} |
|---|
| DELETE /tenant-management/api/system/tenants/{tenant}/users/{id} |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/system/tenants/{tenant}/users/{id} |
GET
2020 Winter
| Retrieve the Roles | JSON | | Insert excerpt |
|---|
| GET /tenant-management/api/system/tenants/{tenant}/roles |
|---|
| GET /tenant-management/api/system/tenants/{tenant}/roles |
|---|
| nopanel | true |
|---|
|
/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 |
|---|
|
/tenant-management/api/system/tenants/{tenant}/roles |
DELETE
2021 Autumn | Delete a Role | JSON | | Insert excerpt |
|---|
| DELETE /tenant-management/api/system/tenants/{tenant}/roleroles/{name} |
|---|
| DELETE /tenant-management/api/system/tenants/{tenant}/roleroles/{name} |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/system/tenants/{tenant}/role/{name} |
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 |
|---|
|
/tenant-management/api/system/tenants/{tenant}/groups |
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 |
|---|
|
/tenant-management/api/system/tenants/{tenant}/groups |
GET
2021 Autumn | Retrieve a Group | JSON | | Insert excerpt |
|---|
| GET /tenant-management/api/system/tenants/{tenant}/groups/{id} |
|---|
| GET /tenant-management/api/system/tenants/{tenant}/groups/{id} |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/system/tenants/{tenant}/groups/{id} |
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 |
|---|
|
/tenant-management/api/system/tenants/{tenant}/groups/{id} |
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 |
|---|
|
/tenant-management/api/system/tenants/{tenant}/groups/{id} |
GET
2021 Summer
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 |