POST/api/auth/sso/exchange
Laaste stap van 'n SSO-aanmelding (SAML/OIDC): ruil die eenmalige kode uit die herleiding vir 'n toegangstoken en 'n refresh-token.
Na aanmelding by die identiteitsverskaffer herlei Zentor App die blaaier terug met 'n eenmalige kode in die navraagparameter `sso_code`. Stuur hierdie kode in die veld `code`. Die antwoord bevat `token` en `refreshToken` soos by 'n gewone aanmelding. Elke kode is net een keer en net vir 'n kort tyd geldig. 'n Reeds gebruikte, verlopde of ongeldige kode lei tot 400 `SSO_EXCHANGE_INVALID`; die gebruiker begin die SSO-aanmelding dan weer. Die oproep is dus nie idempotent nie.
Oorsig
Oproep: POST /api/auth/sso/exchange. Hierdie eindpunt behoort tot die groep “Verifikasie” van die Zentor App-API. Dit is publiek toeganklik en vereis geen verifikasie nie. Die oproep is nie idempotent nie: elke suksesvolle oproep aktiveer die aksie opnuut. Verpligte parameters: code (body). Gedokumenteerde foutgevalle: 400 SSO_EXCHANGE_INVALID. Die voorbeeldrespons hieronder toon die struktuur van ’n suksesvolle respons in JSON-formaat.
Verifikasie en sekuriteit
Geen verifikasie vereis nie
Idempotent: Nee
Parameters
code(body, string, vereis)— Eenmalige kode uit die SSO-herleidingVoorbeeldversoek
{"code":"<eenmalige kode uit die SSO callback Redirect>"}Voorbeeldrespons
{"ok":true,"token":"<JWT>","refreshToken":"<Refresh-Token>"}Foutkodes
400 SSO_EXCHANGE_INVALID — Die kode is ongeldig, reeds gebruik of verlope.Gekontroleerde gedrag
'n Ongeldige kode lewer 400 `SSO_EXCHANGE_INVALID`. Die suksesgeval vereis 'n volledige aanmelding by die opgestelde identiteitsverskaffer.
Verifikasie
POST /api/auth/loginMeld 'n gebruiker aan met e-posadres of gebruikersnaam en wagwoord en gee 'n toegangstoken (JWT) asook 'n refresh-token uit.POST /api/auth/refreshRuil 'n geldige refresh-token vir 'n nuwe paar toegangstoken en refresh-token.POST /api/auth/forgot-passwordBegin die terugstel van 'n wagwoord: as 'n rekening met die opgegewe e-posadres bestaan, ontvang dit 'n e-pos met 'n skakel om terug te stel.POST /api/auth/reset-passwordStel 'n nuwe wagwoord in met die reset-token uit die terugstel-e-pos.