system-controller Endpoints (TENANT-MANAGEMENT)

These endpoints can be used for role, group and user management for a tenant and to create and delete tenants in Keycloak.

They are provided by the TENANT-MANAGEMENT service.

The access to the endpoints has to be limited to administrative users as specified with the permission for /tenant-management/api/system/** endpoints in the authentication-prod.yml configuration file.

The endpoints are used by the ARCHITECT Service that provides yuuvis® architect. If you want to use this service, do not change the default access condition that is matched with the YUUVIS_SYSTEM_INTEGRATOR role.

HTTP Method
as of product version
PurposeResponse FormatDescription

Manage Tenant Creation Profile

GET
2020 Winter
Retrieve the Keycloak System SettingsJSON

Retrieves the top-level representation of the identity provider Keycloak.
/tenant-management/api/system/info

POST
2020 Winter
Update the ProfileHTTP 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.
/tenant-management/api/system/profile

GET
2020 Winter
Retrieve the ProfileJSON

Retrieves the profile data to be used when creating new tenants. Reads the tenant creation profile.
/tenant-management/api/system/profile


Manage Tenants

POST
2020 Winter
Create a TenantHTTP 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. 
/tenant-management/api/system/tenants

PUT
2020 Winter
Update the Data of a TenantHTTP 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

Retrieves the top-level representation of the Keycloak realm specified by tenant. It will not include nested information like User and Client representations. Reads the tenant data of the specified tenant
/tenant-management/api/system/tenants/{tenant}

GET
2020 Winter
Retrieve the Data of all TenantsJSON

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. 
/tenant-management/api/system/tenants

DELETE
2020 Winter
Delete TenantJSON
PATCH
2021 Summer
UpdateTenantHTTP status code

Update a new tenant with the values for the corresponding parameters specified in JSON format.
/tenant-management/api/system/tenants/{tenant}

GET
2020 Winter
Retrieve the Number of UsersTXT

Retrieves the number of all users of the specified tenant
/tenant-management/api/system/tenants/{tenant}/users/count

POST
2020 Winter
Create  a UserJSON

Creates a new user with the given properties for the specified tenant.
/tenant-management/api/system/tenants/{tenant}/users

PUT
2020 Winter
Update the Data of a UserHTTP status code

Update the data of the user specified by tenant and id.
/tenant-management/api/system/tenants/{tenant}/users/{id}

GET
2020 Winter

Request a List of UsersJSON

Retrieves a list of all users of the specified tenant. As 2021 Autumn, the list can be filtered by applying query parameters.
/tenant-management/api/system/tenants/{tenant}/users

GET
2020 Winter
Retrieve the Data of a UserJSON

Retrieves the data of the user specified by tenant and id.
/tenant-management/api/system/tenants/{tenant}/users/{id}

DELETE
2020 Winter
Delete a UserHTTP status code

Deletes the user specified by id of the specified tenant.
/tenant-management/api/system/tenants/{tenant}/users/{id}

GET
2020 Winter
Retrieve the RolesJSON

Gets all roles of the specified tenant
/tenant-management/api/system/tenants/{tenant}/roles

POST
2021 Autumn
Create  a RoleJSON

Creates a new role for the specified tenant with the properties specified in JSON format in the request body.
/tenant-management/api/system/tenants/{tenant}/roles

DELETE
2021 Autumn
Delete a RoleJSON

Deletes the role specified by name for the specified tenant.
/tenant-management/api/system/tenants/{tenant}/role/{name}

GET
2021 Autumn
Retrieve the GroupsJSON

Retrieves all groups of the specified tenant with the assigned roles and members.
/tenant-management/api/system/tenants/{tenant}/groups

POST
2021 Autumn
Create  a GroupJSON

Creates a new group with the given properties for the specified tenant.
/tenant-management/api/system/tenants/{tenant}/groups

GET
2021 Autumn
Retrieve a GroupJSON

Retrieves the group specified by id of the specified tenant with the assigned roles and members.
/tenant-management/api/system/tenants/{tenant}/groups/{id}

PUT
2021 Autumn
UpdateGroupJSON

Updates the data of the group specified by id that is given for the specified tenant.
/tenant-management/api/system/tenants/{tenant}/groups/{id}

DELETE
2021 Autumn
Delete GroupHTTP status code

Deletes the group specified by id in the specified tenant.
/tenant-management/api/system/tenants/{tenant}/groups/{id}

GET
2021 Summer
Retrieve the Current Metrics JSONReads the current metrics of the specified tenant.
/tenant-management/api/system/tenants/{tenant}/metrics