Everything within this section is only visible while editing. Use Page Properties ID "STUB", "REFACTURE", "PROGRESS", "rDEV", "rDOC", "rLANG" and "DONE".

Everything contained within the table is displayed in the (INTERNAL) Reports page.

Product Version2021 Summer
Report Note
AssigneeMartin Bartonitz

Resources & Remarks

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

Modification History

Add a new line to this table and fill it whenever you edit the page.

NameDateProduct VersionAction
Martin20 MAR 20212021 Summercreated
Martin26 JUL 20212021 Autumnextensions for enabled and email settings










As of Versionproduct version 2021 Summer | component version 1.1
Request MethodPOST
Response FormatHTTP status code
Required Permission

Available if listed in authorization.accesses in authentication-prod.yml and the specified access condition is matched. In the default configuration, access is granted via the YUUVIS_SYSTEM_INTEGRATOR role.

>> AUTHENTICATION Service
Description


Update a new tenant with the values for the corresponding parameters specified in JSON format.


The PATCH request body is expected to be in JSONPath format.

The following properties can be updated:
  • Keycloak realm Display Name (request property is displayNameHTML)
  • HTML Display Name (request property is description)
  • As of version 2021 Autumn: Activation/Deactivation of the tenant (request property enabled)
  • As of version 2021 Autumn: Any property of the e-mail settings (request property emailSettings/<property>)

Meaning of the response status codes:


HTTP Status CodeMeaning
201 UPDATEDSuccessful, the tenant with the name has been updated.
401 UNAUTHORIZEDThe call was unauthorized.



Request Example

PATCH /tenant-management/api/system/tenants/myTenant HTTP/1.1

[
  {"op":"replace",
    "path": "/displayNameHTML",
    "value" : "This is a HTML formatted display name"
  },
  {"op":"replace",
    "path": "/description",
    "value" : "My Tenant"
  },
  {
  "op": "replace",
    "path": "/emailSettings/port",
    "value": 200
  },
  {"op":"replace",
    "path": "/enabled",
    "value" : false
  }
]


Response Example

201 UPDATED

{
  "adminEmail": "mrexample@examplemail.net",
  "adminPassword": "changeme",
  "description": "My Tenant",
  "displayNameHTML": "This is a HTML formatted display name",
  "name": "My Name",
  "enabled": true
}