POST /tenant-management/api/system/profile

Owned by Team Kolibri (Unlicensed)
Last updated: Aug 19, 2021 by Technische Redaktion
2 min read
As of Versionproduct version 2020 Winter | component version 1.0
Request MethodPOST
Response FormatHTTP status code
Description

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.All available parameters are described here:
>> Tenant Creation Profile

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
POST /tenant-management/api/system/profile HTTP/1.1

{
     "general": {
          "displayNameHTML": "<div class=\"yuv-brand-logo\">${DISPLAY_TENANT_NAME}</div>",
          "customMicroservice": "https://myCustomMicroserviceURL",
          "customMicroserviceOnDelete": "https://myCustomMicroserviceOnDeleteURL",
          "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": "PaswordWith8Characters1Uppercase1SpecialNoUserName"
      },

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

    "user": {
       "users": [
          { 
            "username": "annebraun", 
            "email": "grasshoffbraun@optimal-systems.de",
            "firstName": "Anne",
            "lastName": "Braun",
            "roles": ["YUUVIS_DEFAULT"],
            "password": "PaswordWith8Characters1Uppercase1SpecialNoUserName",
 			"temporaryPassword": false,
            "enabled": true
     },
     ...
    ],
        "withInvitation": true
    }
}
Response Example

201 CREATED

no response body