GET/api/sso/:tenantSlug/saml/metadata

Liefert die SAML-Metadaten von Zentor App (XML) zum Import in Ihren Identity-Provider.

Die Metadaten enthalten unter anderem die Entity-ID und die ACS-URL, die Ihr Identity-Provider für die Einrichtung benötigt. Die Antwort ist ein XML-Dokument, kein JSON. Ist SAML für das Konto nicht eingerichtet, antwortet der Server mit 404 `SSO_NOT_CONFIGURED`.

Überblick

Aufruf: GET /api/sso/:tenantSlug/saml/metadata. Der Endpunkt gehört zur Gruppe „Demo-Chatbot und SSO“ der API von Zentor App. Er ist öffentlich erreichbar und benötigt keine Authentifizierung. Der Aufruf ist idempotent: Wiederholte Aufrufe mit denselben Angaben liefern dasselbe Ergebnis. Pflichtparameter: tenantSlug (Pfad). Dokumentierte Fehlerfälle: 404 -.

Auth & Absicherung

Keine Authentifizierung erforderlich

Idempotent: Ja

Parameter

tenantSlug(path, string, erforderlich)— Kennung (Slug) des Kontos, für das SSO eingerichtet ist

Beispiel-Response

(SAML-Metadaten als XML-Dokument, wenn SAML für das Konto eingerichtet ist – kein JSON)

Fehlercodes

404 - — SAML ist für dieses Konto nicht eingerichtet.

Geprüftes Verhalten

Für ein Konto ohne SAML liefert der Abruf 404.

Demo-Chatbot und SSO

POST /api/global-chatbot/demoSendet eine Nachricht an den öffentlichen Demo-Chatbot auf zentor-app.de/demo und liefert dessen Antwort. Die Demo lässt sich ohne Registrierung im Browser ausprobieren.GET /api/global-chatbot/demo/historyLädt den bisherigen Nachrichtenverlauf einer Demo-Konversation, damit er beim erneuten Öffnen der Demo erhalten bleibt.POST /api/global-chatbot/demo/pollRuft neue Nachrichten einer Demo-Konversation ab, etwa wenn ein Mitarbeiter von Zentor das Gespräch übernommen hat. Die Demo-Seite ruft den Endpunkt in Abständen auf.POST /api/global-chatbot/demo/ratingSpeichert die Bewertung einer Demo-Konversation (hilfreich oder nicht hilfreich) mit optionalem Kommentar.POST /api/global-chatbot/demo/trackErfasst anonyme Nutzungsereignisse der Demo-Seite für die Besucherstatistik von Zentor.POST /api/global-chatbot/demo/voice-transcribeWandelt eine Sprachaufnahme auf der Demo-Seite in Text um (Spracheingabe), sofern die Sprachfunktion der Demo aktiviert ist.POST /api/global-chatbot/demo/voice-speakWandelt Text in gesprochene Sprache um (Sprachausgabe auf der Demo-Seite), sofern die Sprachfunktion der Demo aktiviert ist.GET /api/sso/:tenantSlug/statusPrüft, ob für ein Konto Single Sign-On (SAML oder OIDC) eingerichtet ist. Die Anmeldeseite nutzt das Ergebnis, um die SSO-Anmeldung anzubieten.GET /api/sso/:tenantSlug/oidc/startStartet die Anmeldung per OpenID Connect und leitet den Browser zum eingerichteten Identity-Provider weiter.GET /api/sso/:tenantSlug/oidc/callbackNimmt die Weiterleitung des Identity-Providers nach der OIDC-Anmeldung entgegen und leitet den Browser zurück zu Zentor App.GET /api/sso/:tenantSlug/saml/startStartet die Anmeldung per SAML und leitet den Browser zum eingerichteten Identity-Provider weiter.POST /api/sso/:tenantSlug/saml/acsAssertion Consumer Service (ACS): nimmt die signierte SAML-Antwort des Identity-Providers per Formular-POST entgegen.

Verwandte Artikel

← Demo-Chatbot und SSO