Versions Compared

Old Version 9

changes.mady.by.user Technische Redaktion

Saved on

compared with

New Version Current

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 Version2021 Summer
Report Note
AssigneeMartin Bartonitz

Resources & Remarks

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

Modification History

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


Excerpt
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

Code Block
languageyml
[
  {"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

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


...