These endpoints can be used with the role YUUVIS_TENANT_ADMIN for role, group and user management. Administrative tenant-specific information can be retrieved as well.
| HTTP Method as of product version | Purpose | Response Format | Description |
|---|---|---|---|
| GET 2020 Winter | Retrieve the Tenant data | JSON | Retrieves the tenant data as given in the Keycloak identity provider for the tenant of the calling user. |
| GET 2020 Winter | Retrieve the Number of Users | TXT | Retrieves the number of all users of the tenant. |
| POST 2020 Winter | Create a User | JSON | Creates a new user with the given properties. |
| POST 2020 Winter | Create a User via CSV | JSON | Creates users listed in a CSV-based file. 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 | Retrieves the data of the user specified by |
| PUT 2020 Winter | Update the Data of a User | HTTP status code | Updates the data of the user specified by |
| DELETE 2020 Winter | Delete a User | HTTP status code | Deletes the user specified by |
GET | Retrieve a List of Users | JSON | Retrieves a list of all users. As 2021 Autumn, the list can be filtered by applying query parameters. |
| GET 2020 Winter | Retrieve the Roles | JSON | Gets all roles. |
| POST 2021 Autumn | Create a Role | JSON | Error rendering macro 'excerpt-include' : No link could be created for 'POST /tenant-management/api/admin/roles'. /tenant-management/api/admin/roles |
| DELETE 2021 Autumn | Delete a Role | JSON | Error rendering macro 'excerpt-include' : No link could be created for 'DELETE /tenant-management/api/admin/role/{name}'. /tenant-management/api/admin/role/{name} |
| GET 2021 Autumn | Retrieve the Groups | JSON | Error rendering macro 'excerpt-include' : No link could be created for 'GET /tenant-management/api/admin/groups'. /tenant-management/api/admin/groups |
| POST 2021 Autumn | Create a Group | JSON | Error rendering macro 'excerpt-include' : No link could be created for 'POST /tenant-management/api/admin/groups'. /tenant-management/api/admin/groups |
| PUT 2021 Autumn | Update a Group | JSON | Error rendering macro 'excerpt-include' : No link could be created for 'PUT /tenant-management/api/admin/groups/{id}'. /tenant-management/api/admin/groups/{id} |
| DELETE 2021 Autumn | Delete a Group | JSON | Error rendering macro 'excerpt-include' : No link could be created for 'DELETE /tenant-management/api/admin/groups/{id}'. /tenant-management/api/admin/groups/{id} |
| GET 2021 Spring | Retrieve the Current Metrics | JSON | Reads the current metrics of the specified tenant. /tenant-management/api/admin/metrics |