Zum Hauptinhalt springen

Tenant

Ein Tenant in diesem System repräsentiert eine Organisation (z. B. Acme Inc.), die Benutzer, Touren und Konfigurationen besitzt. Öffentliche v2-Endpoints verwenden snake_case-Schlüssel und sind in der OpenAPI-Spezifikation dokumentiert; die wichtigsten Punkte finden Sie unten.

Endpoints​

  • GET /api/v2/tenant — gibt die aktuell authentifizierte Tenant-Ressource zurück.
  • PUT /api/v2/tenant — vollständiger Austausch der Tenant-Ressource (name, language, timezone).
  • PATCH /api/v2/tenant — JSON Merge Patch (RFC 7386). Felder weglassen, um sie unverändert zu lassen.

Alle Tenant-Endpoints erfordern Authentifizierung und den Grant g:updateTenant.

Payloads​

Get (GET /api/v2/tenant)​

{
  "name": "TenantA",
  "language": "de-AT",
  "timezone": "Europe/Vienna"
}

Replace (PUT /api/v2/tenant)​

{
  "name": "Acme Inc.",
  "language": "en-US",
  "timezone": "Europe/Vienna"
}

Patch (PATCH /api/v2/tenant)​

Content-Type: application/merge-patch+json (application/json wird als Alias akzeptiert)

{
  "name": "Acme Europe",
  "language": "de-DE"
}

Leerer Patch (behält die aktuellen Werte bei):

{}

Hinweise:

  • name muss ein nicht-leerer String mit maximal 255 Zeichen sein.
  • language muss ein nicht-leerer String mit maximal 10 Zeichen sein.
  • timezone muss ein nicht-leerer String mit maximal 50 Zeichen und ein gültiger IANA-Zeitzonenbezeichner sein (zum Beispiel Europe/Vienna).
  • name: null wird mit 422 Validation failed abgelehnt.
  • language: null und timezone: null werden mit 422 Validation failed abgelehnt.
  • language und timezone sind gespeicherte Tenant-Einstellungen. Sie überschreiben nicht direkt die UI-Sprache des Browsers.

Zeitzonen-Katalog (nur Frontend)​

Für hauseigene Frontend-Clients werden Zeitzonen-Optionen bereitgestellt durch:

  • GET /frontend/v2/frontend-configuration/timezones — gibt die verfügbaren IANA-Zeitzonenbezeichner zurück.

Sprach-Katalog (nur Frontend)​

Für hauseigene Frontend-Clients werden Sprach-Optionen bereitgestellt durch:

  • GET /frontend/v2/frontend-configuration/languages — gibt die derzeit unterstützten Tenant-Sprachbezeichner zurück.

Beide Frontend-Katalog-Endpoints sind für die interne Frontend-Nutzung gedacht und nicht Teil des öffentlichen v2-API-Vertrags.