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۔ یہ اینڈپوائنٹ Zentor App کی API کے گروپ “توثیق” سے تعلق رکھتا ہے۔ یہ عوامی طور پر قابلِ رسائی ہے اور اس کے لیے کسی تصدیق (authentication) کی ضرورت نہیں۔ یہ کال idempotent ہے: ایک جیسی معلومات کے ساتھ بار بار کال کرنے پر ایک ہی نتیجہ ملتا ہے۔ لازمی پیرامیٹرز: email (باڈی)۔ دستاویزی ایرر کیسز: 400 VALIDATION_ERROR۔ نیچے دیا گیا نمونہ جواب JSON فارمیٹ میں کامیاب جواب کی ساخت دکھاتا ہے۔

تصدیقِ شناخت اور تحفظ

تصدیقِ شناخت ضروری نہیں

Idempotent (دہرانے پر یکساں اثر): جی ہاں

پیرامیٹرز

email(body, string، ضروری)— اکاؤنٹ کا ای میل ایڈریس

مثالی Request

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

مثالی Response

{"ok":true}

خرابی کے کوڈز

400 VALIDATION_ERROR — `email` فیلڈ غائب یا خالی ہے۔

تصدیق شدہ طرزِ عمل

جواب 200 `{"ok":true}` ہے، چاہے اکاؤنٹ موجود ہو یا نہ ہو؛ غائب ای میل فیلڈ 400 `VALIDATION_ERROR` واپس کرتی ہے۔

توثیق

متعلقہ مضامین

← توثیق