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 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 Code	Meaning
`201 CREATED`	Successful, the tenant with the specified `name` has been created.
`401 UNAUTHORIZED`	The 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

yuuvis® Momentum 2022 Winter LTS

POST /tenant-management/api/system/profile

Analytics

Related content