Firebase Auth REST API

رمز سفارشی را برای شناسه مبادله کنید و توکن تازه سازی کنید

می‌توانید با ارسال یک درخواست HTTP POST به نقطه پایانی Auth verifyCustomToken ، یک نشانه Auth سفارشی را با یک شناسه مبادله کنید و رمز را به‌روزرسانی کنید.

روش: POST

نوع محتوا: application/json

https://identitytoolkit.googleapis.com/v1/accounts:signInWithCustomToken?key=[API_KEY]

نمونه درخواست

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithCustomToken?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"token":"[CUSTOM_TOKEN]","returnSecureToken":true}'

یک درخواست موفقیت آمیز با یک کد وضعیت HTTP 200 OK نشان داده می شود. پاسخ شامل کد Firebase ID و نشانه رفرش مرتبط با توکن سفارشی است.

نمونه پاسخ

{
  "idToken": "[ID_TOKEN]",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600"
}

کدهای خطای رایج

• INVALID_CUSTOM_TOKEN: قالب توکن سفارشی نادرست است یا نشانه به دلایلی نامعتبر است (مثلا منقضی شده، امضای نامعتبر و غیره)
• CREDENTIAL_MISMATCH: توکن سفارشی مربوط به پروژه Firebase دیگری است.

یک نشانه رفرش را با یک نشانه شناسه مبادله کنید

می توانید با صدور درخواست POST HTTP به نقطه پایانی securetoken.googleapis.com ، یک نشانه شناسه Firebase را تازه کنید.

روش: POST

نوع محتوا: برنامه کاربردی/x-www-form-urlencoded

https://securetoken.googleapis.com/v1/token?key=[API_KEY]

نمونه درخواست

curl 'https://securetoken.googleapis.com/v1/token?key=[API_KEY]' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data 'grant_type=refresh_token&refresh_token=[REFRESH_TOKEN]'

یک درخواست موفقیت آمیز با یک کد وضعیت HTTP 200 OK نشان داده می شود. پاسخ حاوی کد جدید Firebase ID و نشانه رفرش است.

نمونه پاسخ

{
  "expires_in": "3600",
  "token_type": "Bearer",
  "refresh_token": "[REFRESH_TOKEN]",
  "id_token": "[ID_TOKEN]",
  "user_id": "tRcfmLH7o2XrNELi...",
  "project_id": "1234567890"
}

کدهای خطای رایج

• TOKEN_EXPIRED: اعتبار کاربر دیگر معتبر نیست. کاربر باید دوباره وارد سیستم شود.
• USER_DISABLED: حساب کاربری توسط یک سرپرست غیرفعال شده است.
• USER_NOT_FOUND: کاربر مربوط به نشانه رفرش پیدا نشد. به احتمال زیاد کاربر حذف شده است.
• کلید API معتبر نیست. لطفاً یک کلید API معتبر ارسال کنید. (کلید API نامعتبر ارائه شده است)
• INVALID_REFRESH_TOKEN: یک نشانه بازخوانی نامعتبر ارائه شده است.
• بار JSON نامعتبر دریافت شد. نام ناشناخته \"refresh_tokens\": پارامتر پرس و جو را نمی توان پیوند داد. فیلد «refresh_tokens» در پیام درخواست یافت نشد.
• INVALID_GRANT_TYPE: نوع کمک هزینه مشخص شده نامعتبر است.
• MISSING_REFRESH_TOKEN: هیچ کد بازخوانی ارائه نشده است.
• PROJECT_NUMBER_MISMATCH: شماره پروژه نشانه تازه سازی با کلید API ارائه شده مطابقت ندارد.

با ایمیل / رمز عبور ثبت نام کنید

می‌توانید با ارسال یک درخواست HTTP POST به نقطه پایانی Auth signupNewUser یک کاربر ایمیل و رمز عبور جدید ایجاد کنید.

روش: POST

نوع محتوا: application/json

https://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]

نمونه درخواست

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"email":"[user@example.com]","password":"[PASSWORD]","returnSecureToken":true}'

یک درخواست موفقیت آمیز با یک کد وضعیت HTTP 200 OK نشان داده می شود. پاسخ حاوی کد Firebase ID و نشانه تازه‌سازی مرتبط با حساب جدید است.

نمونه پاسخ

{
  "idToken": "[ID_TOKEN]",
  "email": "[user@example.com]",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "localId": "tRcfmLH7..."
}

کدهای خطای رایج

• EMAIL_EXISTS: آدرس ایمیل قبلاً توسط حساب دیگری استفاده می شود.
• OPERATION_NOT_ALLOWED: ورود با رمز عبور برای این پروژه غیرفعال است.
• TOO_MANY_ATTEMPTS_TRY_LATER: ما همه درخواست‌های این دستگاه را به دلیل فعالیت غیرمعمول مسدود کرده‌ایم. بعدا دوباره تلاش کنید.

با ایمیل / رمز عبور وارد شوید

می‌توانید با ارسال یک درخواست HTTP POST به نقطه پایانی Auth verifyPassword ، کاربر را با ایمیل و رمز عبور وارد کنید.

روش: POST

نوع محتوا: application/json

https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key=[API_KEY]

نمونه درخواست

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"email":"[user@example.com]","password":"[PASSWORD]","returnSecureToken":true}'

یک درخواست موفقیت آمیز با یک کد وضعیت HTTP 200 OK نشان داده می شود. پاسخ شامل کد Firebase ID و نشانه رفرش مرتبط با حساب ایمیل/گذرواژه موجود است.

نمونه پاسخ

{
  "localId": "ZY1rJK0eYLg...",
  "email": "[user@example.com]",
  "displayName": "",
  "idToken": "[ID_TOKEN]",
  "registered": true,
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600"
}

کدهای خطای رایج

• EMAIL_NOT_FOUND: هیچ سابقه کاربری مربوط به این شناسه وجود ندارد. ممکن است کاربر حذف شده باشد.
• INVALID_PASSWORD: رمز عبور نامعتبر است یا کاربر رمز عبور ندارد.
• USER_DISABLED: حساب کاربری توسط یک سرپرست غیرفعال شده است.

ورود به صورت ناشناس

با ارسال یک درخواست HTTP POST به نقطه پایانی Auth signupNewUser ، می توانید به صورت ناشناس وارد یک کاربر شوید.

روش: POST

نوع محتوا: application/json

https://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]

نمونه درخواست

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]' \
-H 'Content-Type: application/json' --data-binary '{"returnSecureToken":true}'

یک درخواست موفقیت آمیز با یک کد وضعیت HTTP 200 OK نشان داده می شود. پاسخ شامل کد Firebase ID و نشانه رفرش مرتبط با کاربر ناشناس است.

نمونه پاسخ

{
  "idToken": "[ID_TOKEN]",
  "email": "",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "localId": "Jws4SVjpT..."
}

کدهای خطای رایج

• OPERATION_NOT_ALLOWED: ورود کاربر ناشناس برای این پروژه غیرفعال است.

با اعتبار OAuth وارد شوید

می‌توانید با ارسال یک درخواست HTTP POST به نقطه پایانی Auth verifyAssertion ، به کاربری با اعتبار OAuth وارد شوید.

روش: POST

نوع محتوا: application/json

https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]

نمونه درخواست با کد OAuth ID

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"postBody":"id_token=[GOOGLE_ID_TOKEN]&providerId=[google.com]","requestUri":"[http://localhost]","returnIdpCredential":true,"returnSecureToken":true}'

یک درخواست موفقیت آمیز با یک کد وضعیت HTTP 200 OK نشان داده می شود. پاسخ شامل کد Firebase ID و نشانه تازه سازی مرتبط با کاربر احراز هویت شده است.

نمونه پاسخ با کد OAuth ID

{
  "federatedId": "https://accounts.google.com/1234567890",
  "providerId": "google.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "user@example.com",
  "oauthIdToken": "[GOOGLE_ID_TOKEN]",
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "displayName": "John Doe",
  "idToken": "[ID_TOKEN]",
  "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}"
}

درخواست نمونه با نشانه دسترسی OAuth

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"postBody":"access_token=[FACEBOOK_ACCESS_TOKEN]&providerId=[facebook.com]","requestUri":"[http://localhost]","returnIdpCredential":true,"returnSecureToken":true}'

یک درخواست موفقیت آمیز با یک کد وضعیت HTTP 200 OK نشان داده می شود. پاسخ شامل کد Firebase ID و نشانه تازه سازی مرتبط با کاربر احراز هویت شده است.

نمونه پاسخ با نشانه دسترسی OAuth

{
  "federatedId": "http://facebook.com/1234567890",
  "providerId": "facebook.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "user@example.com",
  "oauthAccessToken": "[FACEBOOK_ACCESS_TOKEN]",
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "displayName": "John Doe",
  "idToken": "[ID_TOKEN]",
  "photoUrl": "https://scontent.xx.fbcdn.net/v/...",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}"
}

درخواست نمونه با اعتبار Twitter OAuth 1.0

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"postBody":"access_token=[TWITTER_ACCESS_TOKEN]&oauth_token_secret=[TWITTER_TOKEN_SECRET]&providerId=[twitter.com]","requestUri":"[http://localhost]","returnIdpCredential":true,"returnSecureToken":true}'

یک درخواست موفقیت آمیز با یک کد وضعیت HTTP 200 OK نشان داده می شود. پاسخ شامل کد Firebase ID و نشانه تازه سازی مرتبط با کاربر احراز هویت شده است.

نمونه پاسخ با اعتبار Twitter OAuth 1.0

{
  "federatedId": "http://twitter.com/1234567890",
  "providerId": "twitter.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "user@example.com",
  "oauthAccessToken": "[OAUTH_ACCESS_TOKEN]",
  "oauthTokenSecret": "[OAUTH_TOKEN_SECRET]",
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "displayName": "John Doe",
  "idToken": "[ID_TOKEN]",
  "photoUrl": "http://abs.twimg.com/sticky/...",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}"
}

کدهای خطای رایج

• OPERATION_NOT_ALLOWED: ارائه دهنده مربوطه برای این پروژه غیرفعال است.
• INVALID_IDP_RESPONSE: اعتبار تأییدیه ارائه شده نادرست است یا منقضی شده است.

ارائه دهندگان را برای ایمیل واکشی کنید

می‌توانید با ارسال یک درخواست HTTP POST به نقطه پایانی Auth createAuthUri ، به همه ارائه‌دهندگان مرتبط با یک ایمیل مشخص نگاه کنید.

روش: POST

نوع محتوا: application/json

https://identitytoolkit.googleapis.com/v1/accounts:createAuthUri?key=[API_KEY]

نمونه درخواست

curl 'https://identitytoolkit.googleapis.com/v1/accounts:createAuthUri?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"identifier":"[user@example.com]","continueUri":"[http://localhost:8080/app]"}'

یک درخواست موفقیت آمیز با یک کد وضعیت HTTP 200 OK نشان داده می شود. پاسخ حاوی لیستی از ارائه دهندگان مرتبط با ایمیل است.

نمونه پاسخ

{
  "allProviders": [
    "password",
    "google.com"
  ],
  "registered": true
}

کدهای خطای رایج

• INVALID_EMAIL: آدرس ایمیل بد قالب بندی شده است.

ایمیل بازنشانی رمز عبور را ارسال کنید

می توانید با ارسال یک درخواست HTTP POST به نقطه پایانی Auth getOobConfirmationCode یک ایمیل بازنشانی رمز عبور ارسال کنید.

روش: POST

نوع محتوا: application/json

https://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]

نمونه درخواست

curl 'https://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"requestType":"PASSWORD_RESET","email":"[user@example.com]"}'

یک درخواست موفقیت آمیز با یک کد وضعیت HTTP 200 OK نشان داده می شود.

نمونه پاسخ

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

کدهای خطای رایج

• EMAIL_NOT_FOUND: هیچ سابقه کاربری مربوط به این شناسه وجود ندارد. ممکن است کاربر حذف شده باشد.

کد بازنشانی رمز عبور را تأیید کنید

می‌توانید کد بازنشانی رمز عبور را با ارسال یک درخواست HTTP POST به نقطه پایانی Auth resetPassword تأیید کنید.

روش: POST

نوع محتوا: application/json

https://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]

نمونه درخواست

curl 'https://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]' \
-H 'Content-Type: application/json' --data-binary '{"oobCode":"[PASSWORD_RESET_CODE]"}'

یک درخواست موفقیت آمیز با یک کد وضعیت HTTP 200 OK نشان داده می شود.

نمونه پاسخ

{
  "email": "[user@example.com]",
  "requestType": "PASSWORD_RESET"
}

کدهای خطای رایج

• OPERATION_NOT_ALLOWED: ورود با رمز عبور برای این پروژه غیرفعال است.
• EXPIRED_OOB_CODE: کد اقدام منقضی شده است.
• INVALID_OOB_CODE: کد اقدام نامعتبر است. اگر کد ناقص باشد، منقضی شده باشد یا قبلاً استفاده شده باشد، ممکن است این اتفاق بیفتد.

بازنشانی رمز عبور را تأیید کنید

می‌توانید با ارسال یک درخواست HTTP POST به نقطه پایانی Auth resetPassword ، تغییر بازنشانی رمز عبور را اعمال کنید.

روش: POST

نوع محتوا: application/json

https://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]

نمونه درخواست

curl 'https://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"oobCode":"[PASSWORD_RESET_CODE]","newPassword":"[NEW_PASSWORD]"}'

یک درخواست موفقیت آمیز با یک کد وضعیت HTTP 200 OK نشان داده می شود.

نمونه پاسخ

{
  "email": "[user@example.com]",
  "requestType": "PASSWORD_RESET"
}

کدهای خطای رایج

• OPERATION_NOT_ALLOWED: ورود با رمز عبور برای این پروژه غیرفعال است.
• EXPIRED_OOB_CODE: کد اقدام منقضی شده است.
• INVALID_OOB_CODE: کد اقدام نامعتبر است. اگر کد ناقص باشد، منقضی شده باشد یا قبلاً استفاده شده باشد، ممکن است این اتفاق بیفتد.
• USER_DISABLED: حساب کاربری توسط یک سرپرست غیرفعال شده است.

تغییر ایمیل

می‌توانید ایمیل کاربر را با ارسال یک درخواست HTTP POST به نقطه پایانی Auth setAccountInfo تغییر دهید.

روش: POST

نوع محتوا: application/json

https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]

نمونه درخواست

curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary \
'{"idToken":"[FIREBASE_ID_TOKEN]","email":"[user@example2.com]","returnSecureToken":true}'

یک درخواست موفقیت آمیز با یک کد وضعیت HTTP 200 OK نشان داده می شود. پاسخ حاوی کد جدید Firebase ID و نشانه تازه سازی مرتبط با کاربر است.

نمونه پاسخ

{
  "localId": "tRcfmLH7o2...",
  "email": "[user@example2.com]",
  "passwordHash": "...",
  "providerUserInfo": [
    {
      "providerId": "password",
      "federatedId": "[user@example2.com]"
    }
  ],
  "idToken": "[NEW_ID_TOKEN]",
  "refreshToken": "[NEW_REFRESH_TOKEN]",
  "expiresIn": "3600"
}

کدهای خطای رایج

• EMAIL_EXISTS: آدرس ایمیل قبلاً توسط حساب دیگری استفاده می شود.
• INVALID_ID_TOKEN: اعتبار کاربر دیگر معتبر نیست. کاربر باید دوباره وارد سیستم شود.

رمز عبور را تغییر دهید

می توانید رمز عبور کاربر را با ارسال یک درخواست HTTP POST به نقطه پایانی Auth setAccountInfo تغییر دهید.

روش: POST

نوع محتوا: application/json

https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]

نمونه درخواست

curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary \
'{"idToken":"[FIREBASE_ID_TOKEN]","password":"[NEW_PASSWORD]","returnSecureToken":true}'

یک درخواست موفقیت آمیز با یک کد وضعیت HTTP 200 OK نشان داده می شود. پاسخ حاوی کد جدید Firebase ID و نشانه تازه سازی مرتبط با کاربر است.

نمونه پاسخ

{
  "localId": "tRcfmLH7o2...",
  "email": "[user@example.com]",
  "passwordHash": "...",
  "providerUserInfo": [
    {
      "providerId": "password",
      "federatedId": "[user@example.com]"
    }
  ],
  "idToken": "[NEW_ID_TOKEN]",
  "refreshToken": "[NEW_REFRESH_TOKEN]",
  "expiresIn": "3600"
}

کدهای خطای رایج

• INVALID_ID_TOKEN: اعتبار کاربر دیگر معتبر نیست. کاربر باید دوباره وارد سیستم شود.
• WEAK_PASSWORD: رمز عبور باید 6 کاراکتر یا بیشتر باشد.

بروزرسانی پروفایل

می‌توانید نمایه کاربر (نمایش نام / URL عکس) را با ارسال یک درخواست HTTP POST به نقطه پایانی Auth setAccountInfo به‌روزرسانی کنید.

روش: POST

نوع محتوا: application/json

https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]

نمونه درخواست

curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary \
'{"idToken":"[ID_TOKEN]","displayName":"[NAME]","photoUrl":"[URL]","returnSecureToken":true}'

یک درخواست موفقیت آمیز با یک کد وضعیت HTTP 200 OK نشان داده می شود.

نمونه پاسخ

{
  "localId": "tRcfmLH...",
  "email": "user@example2.com",
  "displayName": "John Doe",
  "photoUrl": "[http://localhost:8080/img1234567890/photo.png]",
  "passwordHash": "...",
  "providerUserInfo": [
    {
      "providerId": "password",
      "federatedId": "user@example2.com",
      "displayName": "John Doe",
      "photoUrl": "http://localhost:8080/img1234567890/photo.png"
    }
  ],
  "idToken": "[NEW_ID_TOKEN]",
  "refreshToken": "[NEW_REFRESH_TOKEN]",
  "expiresIn": "3600"
}

کدهای خطای رایج

• INVALID_ID_TOKEN: اعتبار کاربر دیگر معتبر نیست. کاربر باید دوباره وارد سیستم شود.

دریافت اطلاعات کاربر

می‌توانید با ارسال یک درخواست HTTP POST به نقطه پایانی Auth getAccountInfo ، داده‌های کاربر را دریافت کنید.

روش: POST

نوع محتوا: application/json

https://identitytoolkit.googleapis.com/v1/accounts:lookup?key=[API_KEY]

نمونه درخواست

curl 'https://identitytoolkit.googleapis.com/v1/accounts:lookup?key=[API_KEY]' \
-H 'Content-Type: application/json' --data-binary '{"idToken":"[FIREBASE_ID_TOKEN]"}'

یک درخواست موفقیت آمیز با یک کد وضعیت HTTP 200 OK نشان داده می شود. پاسخ شامل تمام اطلاعات کاربر مرتبط با حساب خواهد بود.

نمونه پاسخ

{
  "users": [
    {
      "localId": "ZY1rJK0...",
      "email": "user@example.com",
      "emailVerified": false,
      "displayName": "John Doe",
      "providerUserInfo": [
        {
          "providerId": "password",
          "displayName": "John Doe",
          "photoUrl": "http://localhost:8080/img1234567890/photo.png",
          "federatedId": "user@example.com",
          "email": "user@example.com",
          "rawId": "user@example.com",
          "screenName": "user@example.com"
        }
      ],
      "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg",
      "passwordHash": "...",
      "passwordUpdatedAt": 1.484124177E12,
      "validSince": "1484124177",
      "disabled": false,
      "lastLoginAt": "1484628946000",
      "createdAt": "1484124142000",
      "customAuth": false
    }
  ]
}

کدهای خطای رایج

• INVALID_ID_TOKEN: اعتبار کاربر دیگر معتبر نیست. کاربر باید دوباره وارد سیستم شود.
• USER_NOT_FOUND: هیچ سابقه کاربری مربوط به این شناسه وجود ندارد. ممکن است کاربر حذف شده باشد.

پیوند با ایمیل / رمز عبور

می‌توانید با ارسال یک درخواست HTTP POST به نقطه پایانی Auth setAccountInfo ، یک ایمیل/گذرواژه را به کاربر فعلی پیوند دهید.

روش: POST

نوع محتوا: application/json

https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]

نمونه درخواست

curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary \
'{"idToken":"[ID_TOKEN]","email":"[user@example.com]","password":"[PASS]","returnSecureToken":true}'

یک درخواست موفقیت آمیز با یک کد وضعیت HTTP 200 OK نشان داده می شود. پاسخ شامل کد Firebase ID و نشانه تازه سازی مرتبط با کاربر احراز هویت شده است.

نمونه پاسخ

{
  "localId": "huDwUz...",
  "email": "user@example.com",
  "displayName": "John Doe",
  "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg",
  "passwordHash": "...",
  "providerUserInfo": [
    {
      "providerId": "password",
      "federatedId": "user@example.com"
    }
  ],
  "idToken": "[ID_TOKEN]",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "emailVerified": false
}

کدهای خطای رایج

• CREDENTIAL_TOO_OLD_LOGIN_AGAIN: اعتبار کاربر دیگر معتبر نیست. کاربر باید دوباره وارد سیستم شود.
• TOKEN_EXPIRED: اعتبار کاربر دیگر معتبر نیست. کاربر باید دوباره وارد سیستم شود.
• INVALID_ID_TOKEN: اعتبار کاربر دیگر معتبر نیست. کاربر باید دوباره وارد سیستم شود.
• WEAK_PASSWORD: رمز عبور باید 6 کاراکتر یا بیشتر باشد.

پیوند با اعتبار OAuth

می‌توانید اعتبار OAuth را با ارسال یک درخواست HTTP POST به نقطه پایانی Auth verifyAssertion به یک کاربر پیوند دهید.

روش: POST

نوع محتوا: application/json

https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]

نمونه درخواست با کد OAuth ID

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"postBody":"id_token=[GOOGLE_ID_TOKEN]&providerId=[google.com]","requestUri":"[http://localhost]","idToken":"[FIREBASE_ID_TOKEN]","returnIdpCredential":true,"returnSecureToken":true}'

یک درخواست موفقیت آمیز با یک کد وضعیت HTTP 200 OK نشان داده می شود. پاسخ شامل کد Firebase ID و نشانه تازه سازی مرتبط با کاربر احراز هویت شده است.

نمونه پاسخ با کد OAuth ID

{
  "federatedId": "https://accounts.google.com/1234567890",
  "providerId": "google.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "user@example.com",
  "oauthIdToken": "[GOOGLE_ID_TOKEN]",
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "displayName": "John Doe",
  "idToken": "[ID_TOKEN]",
  "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}"
}

درخواست نمونه با نشانه دسترسی OAuth

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"postBody":"access_token=[FACEBOOK_ACCESS_TOKEN]&providerId=[facebook.com]","idToken":"[FIREBASE_ID_TOKEN]","requestUri":"[http://localhost]","returnIdpCredential":true,"returnSecureToken":true}'

یک درخواست موفقیت آمیز با یک کد وضعیت HTTP 200 OK نشان داده می شود. پاسخ شامل کد Firebase ID و نشانه تازه سازی مرتبط با کاربر احراز هویت شده است.

نمونه پاسخ با نشانه دسترسی OAuth

{
  "federatedId": "http://facebook.com/1234567890",
  "providerId": "facebook.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "user@example.com",
  "oauthAccessToken": "[FACEBOOK_ACCESS_TOKEN]",
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "displayName": "John Doe",
  "idToken": "[ID_TOKEN]",
  "photoUrl": "https://scontent.xx.fbcdn.net/v/...",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}"
}

درخواست نمونه با اعتبار Twitter OAuth 1.0

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"postBody":"access_token=[TWITTER_ACCESS_TOKEN]&oauth_token_secret=[TWITTER_TOKEN_SECRET]&providerId=[twitter.com]","requestUri":"[http://localhost]","idToken":"[FIREBASE_ID_TOKEN]","returnIdpCredential":true,"returnSecureToken":true}'

یک درخواست موفقیت آمیز با یک کد وضعیت HTTP 200 OK نشان داده می شود. پاسخ شامل کد Firebase ID و نشانه تازه سازی مرتبط با کاربر احراز هویت شده است.

نمونه پاسخ با اعتبار Twitter OAuth 1.0

{
  "federatedId": "http://twitter.com/1234567890",
  "providerId": "twitter.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "user@example.com",
  "oauthAccessToken": "[OAUTH_ACCESS_TOKEN]",
  "oauthTokenSecret": "[OAUTH_TOKEN_SECRET]",
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "displayName": "John Doe",
  "idToken": "[ID_TOKEN]",
  "photoUrl": "http://abs.twimg.com/sticky/...",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}"
}

کدهای خطای رایج

• OPERATION_NOT_ALLOWED: ارائه دهنده مربوطه برای این پروژه غیرفعال است.
• INVALID_IDP_RESPONSE: اعتبار تأییدیه ارائه شده نادرست است یا منقضی شده است.
• INVALID_ID_TOKEN: اعتبار کاربر دیگر معتبر نیست. کاربر باید دوباره وارد سیستم شود.
• EMAIL_EXISTS: آدرس ایمیل قبلاً توسط حساب دیگری استفاده می شود.
• FEDERATED_USER_ID_ALREADY_LINKED: این اعتبار قبلاً با حساب کاربری دیگری مرتبط است.

ارائه دهنده را لغو پیوند کنید

می‌توانید با ارسال یک درخواست HTTP POST به نقطه پایانی Auth setAccountInfo ، پیوند ارائه‌دهنده را با کاربر فعلی لغو کنید.

روش: POST

نوع محتوا: application/json

https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]

نمونه درخواست

curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"idToken":"[FIREBASE_ID_TOKEN]","deleteProvider":["[facebook.com]"]}'

یک درخواست موفقیت آمیز با یک کد وضعیت HTTP 200 OK نشان داده می شود.

نمونه پاسخ

{
  "localId": "huDwUz...",
  "email": "user@example.com",
  "displayName": "John Doe",
  "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg",
  "passwordHash": "...",
  "providerUserInfo": [
    {
      "providerId": "google.com",
      "federatedId": "1234567890",
      "displayName": "John Doe",
      "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg"
    },
    {
      "providerId": "password",
      "federatedId": "user@example.com"
    }
  ],
  "emailVerified": "true"
}

کدهای خطای رایج

• INVALID_ID_TOKEN: اعتبار کاربر دیگر معتبر نیست. کاربر باید دوباره وارد سیستم شود.

ارسال تایید ایمیل

می‌توانید با ارسال یک درخواست HTTP POST به نقطه پایانی Auth getOobConfirmationCode ، یک تأیید ایمیل برای کاربر فعلی ارسال کنید.

روش: POST

نوع محتوا: application/json

https://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]

نمونه درخواست

curl 'https://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"requestType":"VERIFY_EMAIL","idToken":"[FIREBASE_ID_TOKEN]"}'

یک درخواست موفقیت آمیز با یک کد وضعیت HTTP 200 OK نشان داده می شود.

نمونه پاسخ

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

کدهای خطای رایج

• INVALID_ID_TOKEN: اعتبار کاربر دیگر معتبر نیست. کاربر باید دوباره وارد سیستم شود.
• USER_NOT_FOUND: هیچ سابقه کاربری مربوط به این شناسه وجود ندارد. ممکن است کاربر حذف شده باشد.

تایید تایید ایمیل

می‌توانید کد تأیید ایمیل را با ارسال یک درخواست HTTP POST به نقطه پایانی Auth setAccountInfo تأیید کنید.

روش: POST

نوع محتوا: application/json

https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]

نمونه درخواست

curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \
-H 'Content-Type: application/json' --data-binary '{"oobCode":"[VERIFICATION_CODE]"}'

یک درخواست موفقیت آمیز با یک کد وضعیت HTTP 200 OK نشان داده می شود.

نمونه پاسخ

{
  "localId": "FhyStE...",
  "email": "user@example.com",
  "passwordHash": "...",
  "providerUserInfo": [
    {
      "providerId": "password",
      "federatedId": "user@example.com"
    }
  ]
}

کدهای خطای رایج

• EXPIRED_OOB_CODE: کد اقدام منقضی شده است.
• INVALID_OOB_CODE: کد اقدام نامعتبر است. اگر کد ناقص باشد، منقضی شده باشد یا قبلاً استفاده شده باشد، ممکن است این اتفاق بیفتد.
• USER_DISABLED: حساب کاربری توسط یک سرپرست غیرفعال شده است.
• EMAIL_NOT_FOUND: هیچ سابقه کاربری مربوط به این شناسه وجود ندارد. ممکن است کاربر حذف شده باشد.

حذف حساب کاربری

می‌توانید کاربر فعلی را با ارسال یک درخواست HTTP POST به نقطه پایانی Auth deleteAccount حذف کنید.

روش: POST

نوع محتوا: application/json

https://identitytoolkit.googleapis.com/v1/accounts:delete?key=[API_KEY]

نمونه درخواست

curl 'https://identitytoolkit.googleapis.com/v1/accounts:delete?key=[API_KEY]' \
-H 'Content-Type: application/json' --data-binary '{"idToken":"[FIREBASE_ID_TOKEN]"}'

یک درخواست موفقیت آمیز با یک کد وضعیت HTTP 200 OK نشان داده می شود.

کدهای خطای رایج

• INVALID_ID_TOKEN: اعتبار کاربر دیگر معتبر نیست. کاربر باید دوباره وارد سیستم شود.
• USER_NOT_FOUND: هیچ سابقه کاربری مربوط به این شناسه وجود ندارد. ممکن است کاربر حذف شده باشد.

پاک کردن حساب های کاربری

تمام حساب های موجود در پروژه مشخص شده را بدون توجه به وضعیت حذف کنید.

روش: DELETE

توجه داشته باشید که 9099 پورت پیش فرض برای شبیه ساز Authentication است. خروجی ترمینال را برای پورت واقعی مورد استفاده بررسی کنید.

http://localhost:9099/emulator/v1/projects/{project-id}/accounts

پیکربندی شبیه ساز را دریافت کنید

پیکربندی مخصوص شبیه ساز را برای پروژه مشخص شده دریافت کنید.

روش: GET

توجه داشته باشید که 9099 پورت پیش فرض برای شبیه ساز Authentication است. خروجی ترمینال را برای پورت واقعی مورد استفاده بررسی کنید.

http://localhost:9099/emulator/v1/projects/{project-id}/config

پیکربندی شبیه ساز پچ

پیکربندی خاص شبیه ساز را برای پروژه مشخص شده به روز کنید.

روش: پچ

توجه داشته باشید که 9099 پورت پیش فرض برای شبیه ساز Authentication است. خروجی ترمینال را برای پورت واقعی مورد استفاده بررسی کنید.

نوع محتوا: application/json

http://localhost:9099/emulator/v1/projects/{project-id}/config

کدهای احراز هویت خارج از باند را بازیابی کنید

اگر جریان‌های احراز هویتی که آزمایش می‌کنید معمولاً کدهای خارج از باند تولید می‌کنند (مثلاً کدهای تأیید ایمیل، کدهای بازنشانی رمز عبور)، شبیه‌ساز چنین کدهایی را تا زمانی که استفاده شوند در داخل ذخیره می‌کند.

روش: GET

توجه داشته باشید که 9099 پورت پیش فرض برای شبیه ساز Authentication است. خروجی ترمینال را برای پورت واقعی مورد استفاده بررسی کنید.

http://localhost:9099/emulator/v1/projects/{project-id}/oobCodes

کدهای تأیید پیامک را بازیابی کنید

اگر جریان‌های احراز هویت تلفن/پیامک را آزمایش می‌کنید، شبیه‌ساز چنین کدهای پیامکی را تا زمانی که استفاده شوند، در داخل ذخیره می‌کند.

روش: GET

توجه داشته باشید که 9099 پورت پیش فرض برای شبیه ساز Authentication است. خروجی ترمینال را برای پورت واقعی مورد استفاده بررسی کنید.

http://localhost:9099/emulator/v1/projects/{project-id}/verificationCodes

قالب پاسخ به خطا

هر زمان که خطایی از سرور پشتیبان برای هر یک از APIهای بالا برگردانده شود، پاسخ فرمت زیر را خواهد داشت.

نمونه پاسخ

{
  "error": {
    "errors": [
      {
        "domain": "global",
        "reason": "invalid",
        "message": "CREDENTIAL_TOO_OLD_LOGIN_AGAIN"
      }
    ],
    "code": 400,
    "message": "CREDENTIAL_TOO_OLD_LOGIN_AGAIN"
  }
}

کد خطا از قسمت پیام به دست می آید. همه کدهای خطای بالا به محتوای فیلد پیام اشاره دارند.