Versions Compared

Old Version 45

changes.mady.by.user Technische Redaktion

Saved on

compared with

New Version 46

changes.mady.by.user Technische Redaktion

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Page Properties
hiddentrue
idrDOC

Product Version
Report Note
AssigneeMartin

Resources & Remarks

  • Version 2.4 - options" ...  "synchronousContentAnalysis": true (OKTO-4309)

Modification History

NameDateProduct VersionAction
Antje08 FEB 20212.4New page properties macro.
Antje12 FEB 20212020 WinterrDOC
Agnieszka15 FEB 20212020 WinterrLANG



As of Versionproduct version 2020 Winter | component version 1.0
Request MethodPOST
Response FormatHTTP status code
Description


Excerpt

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 one 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: allowed to create objects)
  • YUUVIS_MANAGE_SETTINGS (briefly: save result list column and filter configurations as standard)
  • YUUVIS_TENANT_ADMIN (briefly: update schema, rolse set, maintain manage users, ... for the tenant)
  • YUUVIS_SYSTEM_INTEGRATOR (briefly: update global schemata and role sets for the system, create tenants) 

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

Meaning of the response HTTP status codes:

HTTP Status CodeMeaning
201 CREATEDSuccessful, the tenant with the specified name has been created.
401 UNAUTHORIZEDThe call was unauthorized.


Request Example


Panel
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

...