POST /tenant-management/api/system/profile

As of Version product version 2020 Winter | component version 1.0

Request Method POST

Response Format HTTP status code

Description

Updates the specific 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 profile.

The following yuuvis® roles are set per default for each tenant:

YUUVIS_DEFAULT (briefly: full access to every object via default role set)
YUUVIS_CREATE_OBJECT (briefly: create objects)
YUUVIS_MANAGE_SETTINGS (briefly: save result list column and filter configurations as standard)
YUUVIS_TENANT_ADMIN (briefly: update schema, rolse set, manage users, ... for the tenant)
YUUVIS_SYSTEM_INTEGRATOR (briefly: update global schemata and role sets for the system, create tenants)

An admin user is created for each tenant that is used for the initial tenant administration. This user has all the above roles except YUUVIS_TENANT_ADMINISTRATOR.

Settings for Keycloak can be adjusted and additional roles can be created by passing the desired values for the corresponding parameters:

general section (These set parameters are displayed in the Keycloak GUI, realm setting Themes.)
As of RC3 (tag '1.2.0-rc1):
- displayNameHTML parameter
  Define the branding on the login page. If not specified, the Keycloak realm HTML Display name will be set by default to "<div class="yuv-brand-logo">${DISPLAY_TENANT_NAME}</div>".
- supportedLocalesparameter
  Set the languages for the language selection in the login dialog. The default locales are en for English and de for German. Find more available locales in the Keycloak documentation.
- defaultLocale parameter
  Set the locale to specify the language used in the e-mail invitation. The default locale is en.
roles section:
- Define additional roles (in addition to the pre-definied role set), each of them with a role title and a description.
user section:
- Create standard users and assign roles to them. You may want to create technical users who manage the schema, for example.
  As of RC3 (tag '1.2.0-rc1): If you want to invite the created users via e-mail, set "withInvitation": "true". The default value is false.
  Note: if "true", the e-mail section and its parameters must be set to match the SMTP e-mail service installed.
email section:
Set up all e-mail keys to be able to send invitations to newly created users using your configured e-mail service.
The mandatory keys are host, username and password.

Meaning of the response HTTP status codes:

HTTP Status Code	Meaning
`201 CREATED`	Successful, the tenant with the specified `name` has been created.
`401 UNAUTHORIZED`	The call was unauthorized.

Request Example

POST /api-tm/system/profile HTTP/1.1

{
     "general": {
          "displayNameHTML": "<div class=\"yuv-brand-logo\">${DISPLAY_TENANT_NAME}</div>",
          "customMicroservice": "myCustomMicroservice",
          "supportedLocales": ["en","de","es"],
          "defaultLocale": "es"
,      },

     "email": {
        "host": "myemailservice.com",
        "port": 25,
        "fromDisplayName": "myHostName",
        "from": "myemailaddress",
        "enableSSL": true,
        "enableStartTLS": true,
        "enableAuthentication": true,
        "username": "emailserviceuser",
        "password": "thisisaverystrongpassword"
      },

     "roles": [ 
         {
             "role": "Role 1",
             "description": "Description of Role 1"
         }, ...    ],

    "user": {
       "users": [
          { 
             "username": "ira1", 
             "email": "grasshoff@optimal-systems.de",
             "firstName": "Irina",
             "lastName": "Graßhoff",
             "roles": ["YUUVIS_DEFAULT"],
             "password": "thisisasecureinitialpasswordtheuserisrequestedtochangeafterfirstlogin",
             "enabled": true
          },
          ...
    ],

        "withInvitation": true
    }
}

Response Example

201 CREATED

no response body