POST/api/sso/:tenantSlug/saml/acs
Assertion Consumer Service(ACS):透過表單 POST 接收身份提供者已簽署嘅 SAML 回應。
呢個端點只會由身份提供者呼叫;必須喺提供者設定入面登記為 ACS URL(參見`saml/metadata`)。身份提供者會喺表單欄位`SAMLResponse`傳送 base64 編碼嘅已簽署回應。成功嘅話,Zentor App 會用帶有一次性代碼嘅查詢參數`sso_code`重新導向瀏覽器;呢個代碼會透過`POST /api/auth/sso/exchange`換成存取權杖。 如果回應無效,或者缺少相關嘅認證流程,伺服器就會帶住查詢參數`sso_error`(例如`sso_error=SSO_STATE_MISSING`)重新導向去登入頁面。
概覽
調用:POST /api/sso/:tenantSlug/saml/acs。此端點屬於 Zentor App API 的「示範聊天機械人同 SSO」組別。 此端點可公開存取,毋須身份驗證。 此調用並非冪等:每次成功調用均會再次觸發有關操作。 必填參數:tenantSlug (路徑), SAMLResponse (請求主體)。 已記錄的錯誤情況:302 SSO_STATE_MISSING。
身份驗證同安全保障
唔需要身份驗證
冪等: 唔係
參數
tenantSlug(path, string,必填)— 已配置 SSO 嘅帳戶識別碼(slug)SAMLResponse(body, string,必填)— 身份提供者簽署嘅 SAML 回應(XML,base64 編碼),作為表單欄位回應範例
跳轉到 https://zentor-app.de/login?sso_error=SSO_STATE_MISSING 嘅302重新導向(冇有效 SAML 回應嘅例子)
錯誤代碼
302 SSO_STATE_MISSING — 如果 SAML 回應無效,或者缺少相關嘅認證流程,就會重新導向去登入頁面,並附帶`sso_error`。已驗證嘅行為
無效嘅`SAMLResponse`會導致重新導向(302)去登入頁面,並附帶`sso_error`。
示範聊天機械人同 SSO
POST /api/global-chatbot/demo向 zentor-app.de/demo 嘅公開示範聊天機械人傳送訊息並回傳佢嘅回應。示範可以喺瀏覽器唔需要註冊就試用。GET /api/global-chatbot/demo/history載入示範對話之前嘅訊息記錄,方便重新打開示範嗰時都保留落嚟。POST /api/global-chatbot/demo/poll取得示範對話嘅新訊息,例如當 Zentor 嘅職員接管咗對話嗰時。示範頁面會定期呼叫呢個端點。POST /api/global-chatbot/demo/rating儲存示範對話嘅評分(有幫助或者冇幫助),可以加可選評論。POST /api/global-chatbot/demo/track為 Zentor 嘅訪客統計,記錄示範頁面嘅匿名使用事件。POST /api/global-chatbot/demo/voice-transcribe如果示範嘅語音功能已經啟用,就將示範頁面嘅錄音轉換成文字(語音輸入)。POST /api/global-chatbot/demo/voice-speak如果示範嘅語音功能已經啟用,就將文字轉換成語音(示範頁面嘅語音輸出)。GET /api/sso/:tenantSlug/status檢查某個帳戶係否已經配置單一登入(SAML 或者 OIDC)。登入頁面會用呢個結果提供 SSO 登入選項。GET /api/sso/:tenantSlug/oidc/start開始透過 OpenID Connect 嘅登入,並將瀏覽器重新導向去已配置嘅身份提供者。GET /api/sso/:tenantSlug/oidc/callback接收 OIDC 登入之後身份提供者嘅重新導向,並將瀏覽器重新導向返去 Zentor App。GET /api/sso/:tenantSlug/saml/start開始透過 SAML 嘅登入,並將瀏覽器重新導向去已配置嘅身份提供者。GET /api/sso/:tenantSlug/saml/metadata回傳要匯入您身份提供者嘅 Zentor App SAML 元數據(XML)。