POST/api/auth/sso/exchange

ขั้นตอนสุดท้ายของการเข้าสู่ระบบด้วย SSO (SAML/OIDC): แลกโค้ดใช้ครั้งเดียวจากการเปลี่ยนเส้นทางเป็น Access Token และ Refresh Token

หลังจากเข้าสู่ระบบที่ Identity Provider แล้ว Zentor App จะเปลี่ยนเส้นทางเบราว์เซอร์กลับมาพร้อมโค้ดใช้ครั้งเดียวในพารามิเตอร์คำค้นหา `sso_code` ส่งโค้ดนี้ในช่อง `code` การตอบกลับจะมี `token` และ `refreshToken` เหมือนกับการเข้าสู่ระบบทั่วไป โค้ดแต่ละตัวใช้ได้เพียงครั้งเดียวและมีอายุใช้งานสั้น โค้ดที่ถูกใช้ไปแล้ว หมดอายุ หรือไม่ถูกต้องจะได้รับ 400 `SSO_EXCHANGE_INVALID` ในกรณีนั้นผู้ใช้จะต้องเริ่มการเข้าสู่ระบบด้วย SSO ใหม่ ดังนั้นการเรียกนี้จึงไม่ใช่ idempotent

ภาพรวม

การเรียกใช้: POST /api/auth/sso/exchange เอนด์พอยต์นี้อยู่ในกลุ่ม “การยืนยันตัวตน” ของ API ของ Zentor App เอนด์พอยต์นี้เข้าถึงได้แบบสาธารณะและไม่ต้องยืนยันตัวตน การเรียกใช้นี้ไม่เป็นแบบ idempotent: การเรียกที่สำเร็จแต่ละครั้งจะทริกเกอร์การดำเนินการใหม่อีกครั้ง พารามิเตอร์ที่จำเป็น: code (body) กรณีข้อผิดพลาดที่จัดทำเอกสารไว้: 400 SSO_EXCHANGE_INVALID ตัวอย่างการตอบกลับด้านล่างแสดงโครงสร้างของการตอบกลับที่สำเร็จในรูปแบบ JSON

การยืนยันตัวตนและความปลอดภัย

ไม่ต้องยืนยันตัวตน

Idempotent (เรียกซ้ำได้ผลเหมือนเดิม): ไม่

พารามิเตอร์

code(body, string, จำเป็น)— โค้ดใช้ครั้งเดียวจากการเปลี่ยนเส้นทาง SSO

ตัวอย่างคำขอ

{"code":"<รหัสใช้ครั้งเดียวจากการเปลี่ยนเส้นทาง SSO-Callback>"}

ตัวอย่างการตอบกลับ

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

รหัสข้อผิดพลาด

400 SSO_EXCHANGE_INVALID — โค้ดไม่ถูกต้อง ถูกใช้ไปแล้ว หรือหมดอายุ

พฤติกรรมที่ตรวจสอบแล้ว

โค้ดที่ไม่ถูกต้องจะได้รับ 400 `SSO_EXCHANGE_INVALID` กรณีสำเร็จต้องมีการเข้าสู่ระบบที่สมบูรณ์กับ Identity Provider ที่ตั้งค่าไว้

การยืนยันตัวตน

POST /api/auth/loginยืนยันตัวตนผู้ใช้ด้วยอีเมลหรือชื่อผู้ใช้และรหัสผ่าน และออก Access Token (JWT) พร้อม Refresh TokenPOST /api/auth/refreshแลก Refresh Token ที่ถูกต้องเป็นคู่ Access Token และ Refresh Token ใหม่POST /api/auth/forgot-passwordเริ่มการรีเซ็ตรหัสผ่าน: หากมีบัญชีที่ใช้อีเมลที่ระบุอยู่ บัญชีนั้นจะได้รับอีเมลพร้อมลิงก์สำหรับรีเซ็ตPOST /api/auth/reset-passwordตั้งรหัสผ่านใหม่ด้วย Reset Token จากอีเมลรีเซ็ตรหัสผ่าน

บทความที่เกี่ยวข้อง

← การยืนยันตัวตน