TENANT-MANAGEMENT Service

Owned by Technische Redaktion
Nov 12, 2021
1 min read

Service providing endpoints for role and user management for a tenant and to create and delete tenants.

Table of Contents

Characteristics

Service Nametenant-management
Port Range8080
Profilesprod,oauth2
Helm Chartmanagement
Public APITenant Management Endpoints

Function

Provides tenant management functionality used by yuuvis® architect and yuuvis® management console.

Provides the API:

>> Tenant Management Endpoints

Requirements

In addition to the yuuvis® Momentum core services, API-TM service has further requirements.

  • The service can be used only if Keycloak is connected as the identity provider and role management system for yuuvis® Momentum.

Configuration

  • First, create an initial Keycloak realm. Then create a user with the YUUVS_SYSTEM_INTEGRATOR role within this realm.
  • Users calling endpoints of the system controller need the YUUVIS_SYSTEM_INTEGRATOR role.
  • Users calling endpoints of the admin controller need the YUUVIS_TENANT_ADMIN role and must be a member of the Keycloak realm that is created when creating a yuuvis® tenant.
  • Before creating the first tenant, the profile has to be saved (see POST Save the Profile) by a user with the YUUVS_SYSTEM_INTEGRATOR tole.
  • Obsolete as of version 2021 Autumn: Updating task to version 2021 Winter: To use the API, it is necessary to manually configure its connection to the AUTHENTICATION service. In the file authentication-prod.yaml under authorization.accesses, please add endpoints: /manage/refresh as a new line at the end of the section ### Manage-Endpunkte.