Versions Compared

Old Version 11

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
idDONErDOC

Product Version
Report Note
AssigneeMartin

Resources & Remarks

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

Modification History

NameDateProduct VersionAction
Antje08 FEB 20212.4New page properties macro.
Antje12 FEB 20212020 WinterrDOC
Agnieszka15 FEB 20212020 WinterrLANG



Get GET /api-tm
As of Versionproduct version 2.4 2020 Winter | component version 1.0
Request MethodGET
Response FormatJSON
DescriptionRequired 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


Excerpt
Retrieves the tenant data as given in the
identity service Keycloak, requested by a tenant administrator (user with role YUUVIS_TENANT_ADMIN)
Request Example
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


Result Response Example


Panelcode
{
  

  "name": "myTenant",
  "description":
:
 "myTenant description
";
, "name"::"myTenant"
}
{
Responses
Meaning of the response status codes:

200 OK

The tenant data has been read

401 UNAUTHORIZED

The call was unauthorized
",
  "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
  }
}