Versions Compared

Old Version 4

changes.mady.by.user Team Kolibri

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.
  • Version 2.4 - options" ...  "synchronousContentAnalysis": true (OKTO-4309)

...


...

hiddentrue

...

Ressources

Remarks

History


Page Properties
hiddentrue
idrDOC

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
Martin26 JUK 20212021 Autumnthere are some more parameters that are put out

Martin: Mit Version 2021 Autumn werden ein Paar mehr Parameter ausgegben, dito für den admin-Punkt:

{
  "name": "kolibri",
  "description": "Kolibri Team-CI System",
  "displayNameHTML": "<div class=\"yuv-brand-logo\">Kolibri</div>",
  "enabled": true,
  "emailSettings": {
    "host": "email-domain.amazonaws.com",
    "from": "dms@mydomain.com",
    "username": "BKIAX6KZPD3NQFHB3ZRM",
    "password": "**********",
    "port": 20,
    "enableAuthentication": true,
    "enableSSL": false,
    "enableStartTLS": false
  }
}


Pierre: Folgendes müsste ergänzt werden

  • Wenn Query-Parameter withSystems=true, dann enhält der Tenant im Response zusätzliches Objekt systems mit folgenden Eigenschaften
    • ips: Wenn true, dann ist Tenant im IPS vorhanden
    • yuuvis: Wenn true, dann ist Tenant in yuuvis vorhanden

Response kann dann zusätzliches Objekt enthalten. Bsp

{
	"name": "myMandant",
	...
	"systems" : {
		"ips": true,
		"yuuvis": false
	}
}


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


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

Required: user with role YUUVIS_SYSTEM_INTEGRATOR
 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-tm/system/tenants/myMandant1 HTTP/1.1

Result Response Examplepanel


Code Block
{
  

  "name": "myMandant1",
  "description":
:
 "Description of myMandant1",
  "displayNameHTML": "<div class=\"yuv-brand-logo\">Sanity</div>"
,
, "name"::"myMandant1"
},
{
Response
Meaning of the response status codes:

200 OK

The data of the tenant with the name has been read

401 UNAUTHORIZED

The call was unauthorized
,
  "enabled": true,
  "emailSettings": {
    "host": "string",
    "from": "strung",
    "username": "string",
    "port": 20,
    "enableAuthentication": true,
    "enableSSL": false,
    "enableStartTLS": false
  }
}

{