POST/api/auth/sso/exchange

Isinyathelo sokugcina sokungena nge-SSO (SAML/OIDC): ishintshanisa ikhodi ekhonjwa kanye ekhishwe yi-callback ngo-JWT weseshini ojwayelekileyo.

Ikhasi elithi „POST /api/auth/sso/exchange — Ireferensi ye-API“ likhuluma ngengxenye yemisebenzi ekhonjwe ku-URL. Okuqukethwe okukhona kwengezelelwa ngokuhamba kwenqubo okwenzakala sibili, izidingo ezifunekayo kanye lemikhawulo eyaziwayo. IZentor kayilalo uhlelo lwama-API key abathuthukisi. Ku-Dashboard kusetshenziswa ama-JWT eseshini asebenza amahora alitshumi lambili kanye lama-refresh token asebenza insuku eziyisikhombisa; i-TOTP le-SSO kakusizo okuphoqelelweyo. Ama-embed token e-widget atshengiswa kanye kuphela embhalweni ocacileyo njalo abotshelwe kuma-origin avunyelweyo. Imibhalo emayelana le-`POST /api/auth/sso/exchange` kumele ifundwe njengencazelo yobuchwepheshe eqondileyo yale endpoint ethile. Okuqakathekileyo yi-method, i-path, ukuqinisekiswa kobuntu, izigaba ezifunekayo, amaphutha angenzakala kanye lombuzo wokuthi ukubiza kutsha kwenza umphumela ofanayo yini. Ngakho-ke lesi sigaba soncedo https://zentor-app.de/hilfe/api-referenz/auth/auth.sso_exchange kasivumelanga ukuba lezitatimende zokukhangisa ezijwayelekileyo, kodwa kuphela izinyathelo zokuhlanganisa ezilandelekayo lezibonelo zezimpendulo ezifakazelweyo. Ukubiza i-`/api/auth/sso/exchange`, isicelo sakhiwa ngokuvumelana le-Registry. Imizila yomphakathi kayidingi i-API key ejwayelekileyo yabathuthukisi, ngoba iZentor kayinikezi uhlelo olunjalo lwama-key. Kodwa imizila ye-widget evikelweyo isebenzisa i-embed token etshengiswe kanye kuphela kanye lokuhlolwa kwe-origin. Isimo se-HTTP lokuqukethwe kwe-JSON kumele kuhlolwe ndawonye; isigaba se-`ok` sisodwa kasithathi indawo yokuphatha amaphutha. Nxa kuhlolwa i-`POST /api/auth/sso/exchange` kumele kusetshenziswe amanani angaveziyo ukuthi ngawobani. Idatha yamakhasimende eqotho, ama-UUID okusebenza, ama-token eseshini lezikhathi eziqondileyo akumelanga kube sezibonelweni zomphakathi. Umkhawulo owaziwayo wenkundla yonke ngu-2.000 wezicelo phakathi kwemizuzu engu-15; umkhawulo owehlukileyo owodwa kawufakazelwanga. Ukubiza kwe-POST okungesikho idempotent akumelanga kuphindwe ngobuphofu ngemva kokuqamuka kwenethiwekhi okungacacanga. Amaphutha ajwayelekileyo okuhlanganisa kulo mzila avela ngenxa yama-parameter afunekayo angekho, izinhlobo zedatha ezingalunganga, amakhodi asebenza kanye kuphela aphelelwe yisikhathi, ama-origin angavunyelwanga kumbe irekhodi elingakasetshenziswa. Uhlelo lokusebenza kumele luphathe izimo lezi ngokwehlukeneyo njalo lubhale umlayezo wephutha obuyiswe yi-endpoint, ngaphandle kokubhala okuqukethwe okuyimfihlo. Isicelo esiphumeleleyo siqinisekisa kuphela lesi sinyathelo sokusebenza, hatshi ngokuzenzakalelayo impumelelo ye-imeyili, yokubhadala kumbe ye-SSO elandelayo. Lokhu kuqakathekile ngqo ku-„POST /api/auth/sso/exchange“. Ukuhlolwa kobuchwepheshe kwaleli khasi kumele kusekelwe ku-Registry ku-`app/frontend/src/content/api-reference/` lemizileni ye-backend ehambelana layo. Amanothi okuhlola bukhoma angatsho kuphela lokho okuhlolwe sibili. Ukuhlola okubi (negative test) kumbe ukufanisa lekhodi kakusibo ubufakazi obupheleleyo bempumelelo. Ngakho-ke ku-POST /api/auth/sso/exchange — Ireferensi ye-API kumele kwehlukaniswe ngokucacileyo phakathi kwesakhiwo esibhaliweyo, ukuhlola okuzenzakalelayo lokuziphatha bukhoma okubonwe ngokuqinisekileyo.

Ukuqinisekisa ubuwena lokuvikeleka

Kakudingeki ukuqinisekisa ubuwena

I-idempotent: Hatshi

Amapharamitha

code(body, string, kuyadingeka)— Ikhodi yokushintshana ekhonjwa kanye evela ku-SSO-redirect

Isibonelo sesicelo (request)

{"code":"<ikhodi yokusetshenziswa kanye evela ku-SSO-Callback-Redirect>"}

Isibonelo sempendulo (response)

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

Amakhodi amaphutha

400 SSO_EXCHANGE_INVALID — Ikhodi yokushintshana ayivumelekile, isivele isetshenzisiwe kumbe iphelelwe yisikhathi.

Ubufakazi bokuhlola okuphilayo

Ikhesi elingaphumelelanga (400) lekhodi eqanjiweyo liqinisekiswe bukhoma; ikhesi eliphumelelayo lingadinga ukudlula okugcweleyo kwe-SAML/OIDC-redirect le-identity provider yangempela, akulingiswanga kule ndawo yokuhlola.

← Ukuqinisekisa