POST/api/auth/forgot-password
Iqalisa ukusetwa kwakhona kwephasiwedi: ukuba i-akhawunti enedilesi ye-imeyile enikeziweyo ikhona, ifumana i-imeyile enekhonkco lokusetwa kwakhona.
Thumela idilesi ye-imeyile ye-akhawunti kwimveliso ethi `email`. Impendulo ethi `{"ok":true}` ihlala ifana ngabom – ukuba i-akhawunti ikhona okanye hayi – ukuze isidibanisi esi singakhafulwa ukuba zeziphi iidilesi ezibhalisiweyo. Iphasiwedi entsha isetwa emva koko nge-token evela kwi-imeyile nge`POST /api/auth/reset-password`. Ukuba imveliso ethi `email` ayikho okanye yimpontshi, isidibanisi siphendula nge-400 `VALIDATION_ERROR`. Ukukhusela ukuxhatshazwa, inani leenxuso kwidilesi ye-IP nganye linokukhawulelwa (429 `RATE_LIMIT_EXCEEDED`).
Ushwankathelo
Ukubiza: POST /api/auth/forgot-password. Le endpoint yeyeqela elithi “Uqinisekiso” le-API ye-Zentor App. Ifikeleleka esidlangalaleni kwaye ayifuni kuqinisekiswa kwesazisi (authentication). Ukubiza yi-idempotent: ukubiza kaninzi ngolwazi olufanayo kubuyisa isiphumo esifanayo. Iipharamitha ezinyanzelekileyo: email (body). Iimeko zeempazamo ezibhaliweyo: 400 VALIDATION_ERROR. Impendulo engumzekelo engezantsi ibonisa ulwakhiwo lwempendulo ephumelelayo ngefomathi ye-JSON.
Ukuqinisekiswa nokhuseleko
Akukho kuqinisekiswa kufunekayo
Idempotent: Yebo
Iiparamitha
email(body, string, kuyafuneka)— Idilesi ye-imeyile ye-akhawuntiUmzekelo we-request
{"email":"user@example.com"}Umzekelo we-response
{"ok":true}Iikhowudi zeempazamo
400 VALIDATION_ERROR — Imveliso ethi `email` ayikho okanye impontshi.Ukuziphatha okujongwe
Impendulo yi-200 `{"ok":true}`, ingakhathalele ukuba i-akhawunti ikhona okanye hayi; imveliso ye-imeyile engekhoyo inika i-400 `VALIDATION_ERROR`.
Uqinisekiso
POST /api/auth/loginIngenisa umsebenzisi ngedilesi ye-imeyile okanye igama lomsebenzisi kunye nephasiwedi kwaye ikhuphe i-token yokufikelela (JWT) kunye ne-refresh token.POST /api/auth/refreshTshintshela i-refresh-token esebenzayo ngesibini esitsha se-token yokufikelela kunye ne-refresh token.POST /api/auth/reset-passwordIsetha iphasiwedi entsha nge-token ye-reset evela kwi-imeyile yokusetwa kwakhona.POST /api/auth/sso/exchangeInyathelo lokugqibela lokungena nge-SSO (SAML/OIDC): itshintshanisa ikhowudi yesihlandlo esinye evela kwisiqondiso kabusha nge-token yokufikelela kunye ne-refresh token.