POST/api/auth/sso/exchange
SSO உள்நுழைவின் (SAML/OIDC) இறுதிப் படி: திருப்பிவிடுதலிலிருந்து ஒருமுறை பயன்படும் குறியீட்டை அணுகல் டோக்கன் மற்றும் புதுப்பிப்பு டோக்கனுடன் மாற்றுகிறது.
அடையாள வழங்குநரிடம் உள்நுழைந்த பிறகு, Zentor App உலாவியை `sso_code` வினவல் அளவுருவில் ஒருமுறை பயன்படும் குறியீட்டுடன் திருப்பி அனுப்புகிறது. இந்தக் குறியீட்டை `code` புலத்தில் அனுப்பவும். பதிலில் வழக்கமான உள்நுழைவைப் போலவே `token` மற்றும் `refreshToken` அடங்கும். ஒவ்வொரு குறியீடும் ஒரே ஒரு முறை மற்றும் குறுகிய காலத்திற்கு மட்டுமே செல்லுபடியாகும். ஏற்கெனவே பயன்படுத்தப்பட்ட, காலாவதியான அல்லது தவறான குறியீடு 400 `SSO_EXCHANGE_INVALID` ஐ ஏற்படுத்தும்; பயனர் அப்போது SSO உள்நுழைவை மீண்டும் தொடங்குகிறார். எனவே இந்த அழைப்பு idempotent அல்ல.
கண்ணோட்டம்
அழைப்பு: POST /api/auth/sso/exchange. இந்த எண்ட்பாயிண்ட் Zentor App API-யின் “அங்கீகாரம்” குழுவைச் சேர்ந்தது. இது பொதுவில் அணுகக்கூடியது; அங்கீகாரம் (authentication) தேவையில்லை. இந்த அழைப்பு idempotent அல்ல: ஒவ்வொரு வெற்றிகரமான அழைப்பும் செயலை மீண்டும் தூண்டும். கட்டாய அளவுருக்கள்: code (பாடி). ஆவணப்படுத்தப்பட்ட பிழை நிலைகள்: 400 SSO_EXCHANGE_INVALID. கீழே உள்ள மாதிரி பதில், JSON வடிவில் வெற்றிகரமான பதிலின் கட்டமைப்பைக் காட்டுகிறது.
அங்கீகாரம் & பாதுகாப்பு
அங்கீகாரம் தேவையில்லை
Idempotent (மீண்டும் செய்தாலும் அதே விளைவு): இல்லை
அளவுருக்கள்
code(body, string, கட்டாயம்)— SSO திருப்பிவிடுதலிலிருந்து ஒருமுறை பயன்படும் குறியீடுஎடுத்துக்காட்டுக் கோரிக்கை
{"code":"<SSO-Callback-Redirect இலிருந்து பெற்ற ஒருமுறைக் குறியீடு>"}எடுத்துக்காட்டுப் பதில்
{"ok":true,"token":"<JWT>","refreshToken":"<Refresh-Token>"}பிழைக் குறியீடுகள்
400 SSO_EXCHANGE_INVALID — குறியீடு தவறானது, ஏற்கெனவே பயன்படுத்தப்பட்டது அல்லது காலாவதியானது.சரிபார்க்கப்பட்ட நடத்தை
தவறான குறியீடு 400 `SSO_EXCHANGE_INVALID` ஐத் திருப்பும். வெற்றி நிலை உள்ளமைக்கப்பட்ட அடையாள வழங்குநரிடம் முழுமையான உள்நுழைவை முன்வைக்கிறது.
அங்கீகாரம்
POST /api/auth/loginமின்னஞ்சல் முகவரி அல்லது பயனர்பெயர் மற்றும் கடவுச்சொல் மூலம் பயனரை உள்நுழைவு செய்து, ஒரு அணுகல் டோக்கன் (JWT) மற்றும் ஒரு புதுப்பிப்பு டோக்கனை வெளியிடுகிறது.POST /api/auth/refreshசெல்லுபடியான புதுப்பிப்பு டோக்கனை புதிய அணுகல் டோக்கன் மற்றும் புதுப்பிப்பு டோக்கனின் ஜோடியுடன் மாற்றுகிறது.POST /api/auth/forgot-passwordகடவுச்சொல் மீட்டமைப்பைத் தொடங்குகிறது: கொடுக்கப்பட்ட மின்னஞ்சல் முகவரியுடன் கணக்கு இருந்தால், அது மீட்டமைப்பு இணைப்புடன் ஒரு மின்னஞ்சலைப் பெறும்.POST /api/auth/reset-passwordகடவுச்சொல் மீட்டமைப்பு மின்னஞ்சலிலுள்ள மீட்டமைப்பு டோக்கனைப் பயன்படுத்தி புதிய கடவுச்சொல்லை அமைக்கிறது.