Manage users in yuuvis® Momentum and in Keycloak via the Tenant Management API.

Introduction

The Tenant Management API provides endpoints for user management via Keycloak. In order to scale the identity management, the KEYCLOAK-PROXY service can be used for the connection of multiple Keycloak instances. The endpoints of the Tenant Management API are called by the MANAGEMENT-CONSOLE, MANAGEMENT-CONSOLE-CLIENT and ARCHITECT services.

This article describes the handling and representation formats of data for individual user accounts as retrieved and expected by the Tenant Management Endpoints.

User Account Properties

The following properties for user accounts can be managed via the Tenant Management API.

Property	Type	in Creation Requests	in Update Requests	in Response Bodies	Description
id	string	ignored	required	included	The ID of the user for identification in the identity management system and in yuuvis® Momentum.
email	string	required if invitation via email is desired	optional	included if available	The e-mail address of the user.
firstName	string	optional	optional	included if available	The first name of the user.
lastName	string	optional	optional	included if available	The last name of the user.
roles	list of string role names	optional	partly removed if not specified	included if available	A list of roles defined in the identity management system that are assigned to the user.
groups	list of string group names	optional	removed if not specified	included if available	A list of groups defined in the identity management system in which the assigned user is a member.
username	string	required	optional	included	The username of the user.
enabled	boolean	optional, default: true	optional	included	Specifies whether the user is allowed to log in (true) or not (false).
createdTimestamp		ignored	ignored	included

Summary