POST/api/auth/sso/exchange
الخطوة الأخيرة في تسجيل دخول SSO (SAML/OIDC): تستبدل الرمز الأحادي الاستخدام من إعادة التوجيه برمز وصول ورمز تحديث.
بعد تسجيل الدخول لدى مزوّد الهوية، تُعيد Zentor App توجيه المتصفح مع رمز أحادي الاستخدام في معامل الاستعلام `sso_code`. أرسلوا هذا الرمز في الحقل `code`. وتحتوي الاستجابة على `token` و`refreshToken` كما في تسجيل الدخول العادي. كل رمز صالح لمرة واحدة فقط ولفترة قصيرة. ويؤدي رمز مُستخدَم مسبقًا أو منتهي الصلاحية أو غير صالح إلى رمز 400 `SSO_EXCHANGE_INVALID`؛ ويبدأ المستخدم في هذه الحالة تسجيل دخول SSO من جديد. وبالتالي فإن هذا الاستدعاء غير مُكرِّر (not idempotent).
نظرة عامة
الاستدعاء: POST /api/auth/sso/exchange. تنتمي نقطة النهاية هذه إلى مجموعة «المصادقة» في واجهة برمجة تطبيقات Zentor App. يمكن الوصول إليها بشكل عام ولا تتطلب أي مصادقة. الاستدعاء غير متساوي القوة (idempotent): كل استدعاء ناجح يُطلق الإجراء من جديد. المعاملات الإلزامية: code (النص (Body)). حالات الخطأ الموثقة: 400 SSO_EXCHANGE_INVALID. يوضح مثال الاستجابة أدناه بنية الاستجابة الناجحة بتنسيق JSON.
المصادقة والأمان
لا يلزم أي مصادقة
متطابق القوة: لا
المعلمات
code(body, string، إلزامي)— الرمز الأحادي الاستخدام من إعادة توجيه SSOمثال طلب
{"code":"<رمز لمرة واحدة من إعادة توجيه SSO callback>"}مثال استجابة
{"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يضع كلمة مرور جديدة باستخدام رمز إعادة الضبط الوارد في بريد إعادة ضبط كلمة المرور.