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

Owned by Team Kolibri (Unlicensed)
Last updated: Feb 13, 2023 by Technische Redaktion
2 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_SYSTEM_INTEGRATOR role.

>> AUTHENTICATION Service
Description

Retrieves the top-level representation of the Keycloak realm specified by tenant. It will not include nested information like User and Client representations. Reads the tenant data of the specified tenant. 


Meaning of the response status codes:

HTTP Status CodeMeaning
200 OKSuccessful, the data of the specified tenant has been read.
401 UNAUTHORIZEDThe call was unauthorized.
404 NOT FOUNDThe specified tenant was not found.
Request Example

GET /tenant-management/api/system/tenants/myMandant1 HTTP/1.1

Response Example
{
  "name": "myMandant1",
  "description": "Description of myMandant1",
  "displayNameHTML": "<div class=\"yuv-brand-logo\">Sanity</div>",
  "enabled": true,
  "emailSettings": {
    "host": "string",
    "from": "strung",
    "username": "string",
    "port": 20,
    "enableAuthentication": true,
    "enableSSL": false,
    "enableStartTLS": false
  }
}

{