GET /tenant-management/api/admin/tenant

Owned by Team Kolibri (Unlicensed)
Last updated: Feb 13, 2023 by Technische Redaktion
1 min read
As of Versionproduct version 2020 Winter | component version 1.0
Request MethodGET
Response FormatJSON
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_TENANT_ADMIN role.

>> AUTHENTICATION Service
Description

Retrieves the tenant data as given in the Keycloak identity provider for the tenant of the calling user.

Meaning of the response status codes:
HTTP Status CodeMeaning
200 OKSuccessful, the tenant data has been read.
401 UNAUTHORIZEDThe call was unauthorized.
Request Example

GET /tenant-management/api/admin/tenant HTTP/1.1

Response Example
{
  "name": "myTenant",
  "description": "myTenant description",
  "displayNameHTML": "string",
  "adminPassword": "string",
  "adminEmail": "string",
  "enabled": true,
  "emailSettings": {
    "host": "string",
    "from": "string",
    "username": "string",
    "password": "string",
    "fromDisplayName": "string",
    "port": 0,
    "enableAuthentication": true,
    "enableSSL": true,
    "enableStartTLS": true
  },
  "systems": {
    "ips": true,
    "yuuvis": true
  }
}