Tenant Management Endpoints
- Technische Redaktion
These endpoints can be used for role and user management for a tenant and to create and delete tenants.
This API is provided by the TENANT-MANAGEMENT Service and expects the corresponding requirements.
A Swagger-UI supports calling the API endpoints manually for testing: https://<domain>/tenant-management/swagger-ui.html.
Endpoint Overview
To use this API for user management, you must have the required roles as mentioned below. This means that you must have specific authorizations. To use this API to create and delete tenants, you must be a system integrator.
Endpoints for System Integrators
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.
| HTTP Method as of product version | Purpose | Response Format | Description |
|---|---|---|---|
Manage Tenant Creation Profile | |||
| GET 2020 Winter | Retrieve the Keycloak System Settings | JSON | Retrieves the top-level representation of the identity provider Keycloak. |
| POST 2020 Winter | Update the Profile | HTTP status code | Updates the tenant creation profile that is used while creating a tenant of a customer with all the information that should be set up, e.g., additional roles, users, schema and client settings. Each SaaS application has its own tenant creation profile. |
| GET 2020 Winter | Retrieve the Profile | JSON | Retrieves the profile data to be used when creating new tenants. Reads the tenant creation profile. |
Manage Tenants | |||
| POST 2020 Winter | Create a Tenant | HTTP status code | Creates a new tenant with the values for the corresponding parameters specified in JSON format. Required settings for Keycloak and yuuvis® Momentum core are passed as well as custom (= product application) settings. |
| GET 2020 Winter | Retrieve the Data of all Tenants | JSON | Retrieves the top-level representation of all realms. It will not include nested information like User and Client representations. Reads the list of all tenants. |
| GET 2020 Winter | Retrieve the Tenant data | JSON | Retrieves the top-level representation of the Keycloak realm specified by |
| DELETE 2020 Winter | Delete a Tenant | JSON | Deletes the specified |
| GET 2020 Winter | Retrieve Metrics of a Tenant | JSON | Retrieves the current metrics of the specified |
GET | Request a List of Roles | JSON | Gets all roles of the specified |
GET | Request a List of Users | JSON | Retrieves a list of all users of the specified |
| POST 2020 Winter | Create a User | JSON | Creates a new user with the given properties for the specified tenant. |
| GET 2020 Winter | Retrieve the Data of a User | JSON | Retrieves the data of the user specified by |
| PUT 2020 Winter | Update the Data of a User | HTTP status code | Update the data of the user specified by |
| DELETE 2020 Winter | Delete a User | HTTP status code | Deletes the specified user of the specified tenant. |
| GET 2020 Winter | Retrieve the Number of Users | TXT | Retrieves the number of all users of the specified |
Endpoints for Tenant Administrators
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 Metrics | JSON | Retrieves the current metrics of the |
| GET 2020 Winter | Retrieve the Roles | JSON | Gets all roles. |
| 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 | Retrieve a List of Users | JSON | Retrieves a list of all users. As 2021 Autumn, the list can be filtered by applying query parameters. |
| POST 2020 Winter | Create a User | JSON | Creates a new user with the given properties. |
| 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 2020 Winter | Retrieve the Number of Users | TXT | Retrieves the number of all users of the tenant. |