HTTP Method
as of product version | Purpose | Response Format | Description |
|---|
GET
2020 Winter
| Retrieve the Tenant data | JSON | | Insert excerpt |
|---|
| GET /tenant-management/api/admin/tenant |
|---|
| GET /tenant-management/api/admin/tenant |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/admin/tenant |
GET
2020 Winter
| Retrieve the Number of Users | TXT | | Insert excerpt |
|---|
| GET /tenant-management/api/admin/users/count |
|---|
| GET /tenant-management/api/admin/users/count |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/admin/users/count |
POST
2020 Winter
| Create a User | JSON | | Insert excerpt |
|---|
| POST /tenant-management/api/admin/users |
|---|
| POST /tenant-management/api/admin/users |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/admin/users |
POST
2020 Winter
| Create a User via CSV | JSON | 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 User | JSON | | Insert excerpt |
|---|
| GET /tenant-management/api/admin/users/{id} |
|---|
| GET /tenant-management/api/admin/users/{id} |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/admin/users/{id} |
PUT
2020 Winter
| Update the Data of a User | HTTP status code | | Insert excerpt |
|---|
| PUT /tenant-management/api/admin/users/{id} |
|---|
| PUT /tenant-management/api/admin/users/{id} |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/admin/users/{id} |
DELETE
2020 Winter
| Delete a User | HTTP status code | | Insert excerpt |
|---|
| DELETE /tenant-management/api/admin/users/{id} |
|---|
| DELETE /tenant-management/api/admin/users/{id} |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/admin/users/{id} |
GET
2020 Winter
| Retrieve a List of Users | JSON | | Insert excerpt |
|---|
| GET /tenant-management/api/admin/users |
|---|
| GET /tenant-management/api/admin/users |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/admin/users |
GET
2020 Winter
| Retrieve the Roles | JSON | | Insert excerpt |
|---|
| GET /tenant-management/api/admin/roles |
|---|
| GET /tenant-management/api/admin/roles |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/admin/roles |
POST
2021 Autumn
| Create a Role | JSON | | Insert excerpt |
|---|
| POST /tenant-management/api/admin/roles |
|---|
| POST /tenant-management/api/admin/roles |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/admin/roles |
DELETE
2021 Autumn
| Delete a Role | JSON | | Insert excerpt |
|---|
| DELETE /tenant-management/api/admin/roleroles/{name} |
|---|
| DELETE /tenant-management/api/admin/roleroles/{name} |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/admin/role/{name} |
GET
2021 Autumn
| Retrieve the Groups | JSON | | Insert excerpt |
|---|
| GET /tenant-management/api/admin/groups |
|---|
| GET /tenant-management/api/admin/groups |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/admin/groups |
POST
2021 Autumn
| Create a Group | JSON | | Insert excerpt |
|---|
| POST /tenant-management/api/admin/groups |
|---|
| POST /tenant-management/api/admin/groups |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/admin/groups |
GET
2021 Autumn
| Retrieve a Group | JSON | | Insert excerpt |
|---|
| GET /tenant-management/api/admin/groups/{id} |
|---|
| GET /tenant-management/api/admin/groups/{id} |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/admin/groups/{id} |
PUT
2021 Autumn
| Update a Group | JSON | | Insert excerpt |
|---|
| PUT /tenant-management/api/admin/groups/{id} |
|---|
| PUT /tenant-management/api/admin/groups/{id} |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/admin/groups/{id}
|
DELETE
2021 Autumn | Delete a Group | JSON | | Insert excerpt |
|---|
| DELETE /tenant-management/api/admin/groups/{id} |
|---|
| DELETE /tenant-management/api/admin/groups/{id} |
|---|
| nopanel | true |
|---|
|
/tenant-management/api/admin/groups/{id} |
GET
2021 Spring
deprecated as of 2023 Autumn | Retrieve the Current Metrics | JSON | Reads the current metrics of the specified tenant.
/tenant-management/api/admin/metrics |