PATCH /tenant-management/api/system/tenants/{tenant}

As of Version product version 2021 Summer | component version 1.1

Request Method POST

Response Format HTTP 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 Code	Meaning
`201 UPDATED`	Successful, the tenant with the `name` has been updated.
`401 UNAUTHORIZED`	The 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
}