POST/api/auth/sso/exchange

SSO 登入(SAML/OIDC)嘅最後一步:將重新導向嗰個一次性代碼換成存取權杖同刷新權杖。

喺身份提供者完成登入之後,Zentor App 會將瀏覽器重新導向返嚟,並喺查詢參數`sso_code`附帶一次性代碼。請將呢個代碼透過`code`欄位傳送。回應會包含`token`同`refreshToken`,同一般登入一樣。 每個代碼都只喺短時間內有效一次。已經被使用、已過期或者無效嘅代碼會回傳400 `SSO_EXCHANGE_INVALID`;到時候使用者就需要重新開始SSO登入。所以,呢個呼叫唔係冪等嘅。

概覽

調用:POST /api/auth/sso/exchange。此端點屬於 Zentor App API 的「身份驗證」組別。 此端點可公開存取,毋須身份驗證。 此調用並非冪等:每次成功調用均會再次觸發有關操作。 必填參數:code (請求主體)。 已記錄的錯誤情況:400 SSO_EXCHANGE_INVALID。 下方的範例回應展示 JSON 格式成功回應的結構。

身份驗證同安全保障

唔需要身份驗證

冪等: 唔係

參數

code(body, string,必填)— SSO 重新導向傳嚟嘅一次性代碼

請求範例

{"code":"<來自 SSO 回呼重新導向嘅一次性代碼>"}

回應範例

{"ok":true,"token":"<JWT>","refreshToken":"<Refresh-Token>"}

錯誤代碼

400 SSO_EXCHANGE_INVALID — 代碼無效、已經被使用或者已過期。

已驗證嘅行為

無效代碼會回傳 400 `SSO_EXCHANGE_INVALID`。成功情況需要喺已設定嘅身份提供者完成完整登入。

身份驗證

相關文章

← 身份驗證