فراموشی/تغییر رمز عبور - REST

هدف از این مستند این است که بتوانید رمز عبور یک کاربر را تغییر داده و یا در صورتی که کاربر شما رمز عبور خود را فراموش کرده است، امکانی امن برای او فراهم کنید تا رمز خود را بازنشانی کند.

نکته: در صورتی که با مفهوم REST و سرویس‌های سمت سرور و یا با دستور curl آشنایی ندارید، به آشنایی با REST مراجعه کنید.

پیش‌نیازها

1. در صورتی که با سرویس کاربران آشنایی ندارید، به معرفی سرویس کاربران مراجعه کنید.

تغییر کلمه عبور(change-password)

با استفاده از این سرویس می‌توانید کلمه عبور کاربران را تغییر دهید.

توجه: در header این درخواست نیاز به X-Backtory-Authentication-Id وجود دارد که با مراجعه به پنل بکتوری، در قسمت کلیدها قابل مشاهده می‌باشد. همچنین کلمه عبور قبلی و جدید نیز باید در درخواست وجود داشته باشد.

curl -X POST \
    --header "Authorization: Bearer <USER-ACCESS-TOKEN>" \
    --header "X-Backtory-Authentication-Id: <ID>" \
    --header "Content-Type: application/json" \
    -d '{
        "lastPassword": "LAST-PASSWORD",
        "newPassword": "NEW-PASSWORD"
    }' https://api.backtory.com/auth/change-password

انواع پاسخ‌هایی که از این سرویس ممکن است دریافت کنید به صورت جدول زیر است:

فراموشی کلمه عبور (forgot-password)

با استفاده از این سرویس می‌توانید امکان بازیابی رمز عبور کاربران را هنگامی که رمزعبور خود را فراموش کرده‌اند، فراهم کنید. ابتدا لازم است درخواست را مبنی بر فراموشی کلمه عبور ارسال نمایید. پس از این درخواست و در صورت تایید این درخواست توسط کاربر (به وسیله پست الکترونیکی و با کلیک بر روی لینک یک‌بار مصرف داخل ایمیل)، کلمه عبور جدید برای وی ارسال خواهد شد.

curl -X POST \
    --header "X-Backtory-Authentication-Id: <ID>" \
    'https://api.backtory.com/auth/forgot-password?username=USERNAME'

انواع پاسخ‌هایی که از این سرویس ممکن است دریافت کنید به صورت جدول زیر است:

گام بعدی

• قابلیت‌های مدیر