POST/api/auth/forgot-password

เริ่มการรีเซ็ตรหัสผ่าน: หากมีบัญชีที่ใช้อีเมลที่ระบุอยู่ บัญชีนั้นจะได้รับอีเมลพร้อมลิงก์สำหรับรีเซ็ต

ส่งอีเมลของบัญชีในช่อง `email` การตอบกลับ `{"ok":true}` ถูกตั้งใจให้เหมือนกันเสมอ – ไม่ว่าจะมีบัญชีอยู่หรือไม่ – เพื่อไม่ให้สามารถระบุได้ผ่านเอนด์พอยต์นี้ว่าอีเมลใดลงทะเบียนไว้บ้าง รหัสผ่านใหม่จะถูกตั้งค่าในขั้นต่อไปด้วยโทเค็นจากอีเมลผ่าน `POST /api/auth/reset-password` หากช่อง `email` หายไปหรือว่างเปล่า เอนด์พอยต์จะตอบกลับด้วย 400 `VALIDATION_ERROR` เพื่อป้องกันการใช้งานในทางที่ผิด จำนวนคำขอต่อที่อยู่ IP จะถูกจำกัด (429 `RATE_LIMIT_EXCEEDED`)

ภาพรวม

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

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

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

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

พารามิเตอร์

email(body, string, จำเป็น)— อีเมลของบัญชี

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

{"email":"user@example.com"}

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

{"ok":true}

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

400 VALIDATION_ERROR — ช่อง `email` หายไปหรือว่างเปล่า

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

การตอบกลับคือ 200 `{"ok":true}` ไม่ว่าบัญชีจะมีอยู่หรือไม่ก็ตาม ช่องอีเมลที่หายไปจะได้รับ 400 `VALIDATION_ERROR`

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

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

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

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