API REST xác thực Firebase

Trao đổi mã thông báo tuỳ chỉnh để lấy giá trị nhận dạng và mã làm mới

Bạn có thể trao đổi mã thông báo xác thực tuỳ chỉnh lấy mã nhận dạng và mã làm mới bằng cách tạo một giao thức HTTP Yêu cầu POST đến điểm cuối xác thực verifyCustomToken.

Phương thức: POST

Loại nội dung: ứng dụng/json

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

Yêu cầu mẫu

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

Yêu cầu thành công được biểu thị bằng một HTTP 200 OK mã trạng thái. Phản hồi chứa mã thông báo mã nhận dạng Firebase và mã làm mới được liên kết với mã thông báo tuỳ chỉnh.

Phản hồi mẫu

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

Các mã lỗi thường gặp

• INVALID_CUSTOM_TOKEN: Định dạng mã thông báo tuỳ chỉnh không chính xác hoặc mã thông báo không hợp lệ cho một số lý do (ví dụ: hết hạn, chữ ký không hợp lệ, v.v.)
• CREDENTIAL_MISMATCH: Mã thông báo tuỳ chỉnh tương ứng với một dự án Firebase khác.

Trao đổi mã làm mới lấy mã thông báo nhận dạng

Bạn có thể làm mới mã thông báo mã nhận dạng Firebase bằng cách tạo một HTTP Yêu cầu POST đến điểm cuối securetoken.googleapis.com.

Phương thức: POST

Loại nội dung: application/x-www-form-url encrypted

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

Yêu cầu mẫu

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]'

Yêu cầu thành công được biểu thị bằng một HTTP 200 OK mã trạng thái. Phản hồi chứa mã nhận dạng Firebase mới và mã làm mới.

Phản hồi mẫu

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

Các mã lỗi thường gặp

• TOKEN_EXPIRED: Thông tin đăng nhập của người dùng không còn hợp lệ. Người dùng phải đăng nhập lại.
• USER_DISABLED: Tài khoản người dùng đã bị quản trị viên vô hiệu hoá.
• USER_NOT_FOUND: Không tìm thấy người dùng tương ứng với mã làm mới. Có thể người dùng này đã bị xoá.
• Khoá API không hợp lệ. Vui lòng chuyển một khoá API hợp lệ. (đã cung cấp khoá API không hợp lệ)
• INVALID_refRESH_TOKEN: Đã cung cấp mã thông báo làm mới không hợp lệ.
• Đã nhận được tải trọng JSON không hợp lệ. Tên không xác định \"refresh_tokens\": Không thể liên kết truy vấn . Trường 'refresh_tokens' Không thể tìm thấy trong thông báo yêu cầu.
• INVALID_INVALID_TYPE: Loại cấp quyền được chỉ định không hợp lệ.
• MISSING_RefRESH_TOKEN: Không có mã làm mới nào được cung cấp.
• PROJECT_NUMBER_MISMATCH: Số dự án của mã làm mới không khớp với số dự án của khoá API được cung cấp.

Đăng ký bằng email / mật khẩu

Bạn có thể tạo người dùng email và mật khẩu mới bằng cách phát một HTTP Yêu cầu POST đến điểm cuối xác thực signupNewUser.

Phương thức: POST

Loại nội dung: ứng dụng/json

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

Yêu cầu mẫu

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}'

Yêu cầu thành công được biểu thị bằng một HTTP 200 OK mã trạng thái. Phản hồi chứa mã thông báo mã nhận dạng Firebase và mã làm mới được liên kết với tài khoản mới.

Phản hồi mẫu

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

Các mã lỗi thường gặp

• EMAIL_EXISTS: Địa chỉ email đã được một tài khoản khác sử dụng.
• ACTIVITY_NOT_ALLOWED: Tính năng đăng nhập bằng mật khẩu bị tắt cho dự án này.
• TOO_MANY_SSL_TRY_LATER: Chúng tôi đã chặn tất cả yêu cầu từ thiết bị này do nhận xét bất thường của bạn. Hãy thử lại sau.

Đăng nhập bằng email / mật khẩu

Bạn có thể đăng nhập người dùng bằng email và mật khẩu khi phát hành một HTTP Yêu cầu POST đến điểm cuối xác thực verifyPassword.

Phương thức: POST

Loại nội dung: ứng dụng/json

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

Yêu cầu mẫu

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}'

Yêu cầu thành công được biểu thị bằng một HTTP 200 OK mã trạng thái. Phản hồi chứa mã thông báo mã nhận dạng Firebase và mã làm mới được liên kết bằng tài khoản email/mật khẩu hiện có.

Phản hồi mẫu

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

Các mã lỗi thường gặp

• EMAIL_NOT_FOUND: Không có hồ sơ người dùng nào tương ứng với giá trị nhận dạng này. Người dùng có thể đã bị xóa.
• INVALID_passwords: Mật khẩu không hợp lệ hoặc người dùng không có mật khẩu.
• USER_DISABLED: Tài khoản người dùng đã bị quản trị viên vô hiệu hoá.

Đăng nhập ẩn danh

Bạn có thể đăng nhập người dùng ẩn danh bằng cách tạo một HTTP Yêu cầu POST đến điểm cuối xác thực signupNewUser.

Phương thức: POST

Loại nội dung: ứng dụng/json

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

Yêu cầu mẫu

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

Yêu cầu thành công được biểu thị bằng một HTTP 200 OK mã trạng thái. Phản hồi chứa mã thông báo mã nhận dạng Firebase và mã làm mới được liên kết với người dùng ẩn danh đó.

Phản hồi mẫu

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

Các mã lỗi thường gặp

• ACTIVITY_NOT_ALLOWED: Tính năng đăng nhập của người dùng ẩn danh bị tắt cho dự án này.

Đăng nhập bằng thông tin đăng nhập OAuth

Bạn có thể đăng nhập người dùng bằng thông tin đăng nhập OAuth khi tạo một HTTP Yêu cầu POST đến điểm cuối xác thực verifyAssertion.

Phương thức: POST

Loại nội dung: ứng dụng/json

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

Yêu cầu mẫu có mã thông báo mã OAuth

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}'

Yêu cầu thành công được biểu thị bằng một HTTP 200 OK mã trạng thái. Phản hồi chứa mã thông báo mã nhận dạng Firebase và mã làm mới được liên kết với người dùng đã xác thực.

Phản hồi mẫu có mã thông báo mã OAuth

{
  "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\", ...}"
}

Yêu cầu mẫu có mã truy cập 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}'

Yêu cầu thành công được biểu thị bằng một HTTP 200 OK mã trạng thái. Phản hồi chứa mã thông báo mã nhận dạng Firebase và mã làm mới được liên kết với người dùng đã xác thực.

Phản hồi mẫu có mã truy cập 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\", ...}"
}

Yêu cầu mẫu bằng thông tin đăng nhập OAuth 1.0 của Twitter

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}'

Yêu cầu thành công được biểu thị bằng một HTTP 200 OK mã trạng thái. Phản hồi chứa mã thông báo mã nhận dạng Firebase và mã làm mới được liên kết với người dùng đã xác thực.

Phản hồi mẫu có thông tin đăng nhập OAuth 1.0 của Twitter

{
  "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\", ...}"
}

Các mã lỗi thường gặp

• ACTIVITY_NOT_ALLOWED: Nhà cung cấp tương ứng đã bị tắt cho dự án này.
• INVALID_IDP_reply: Thông tin xác thực được cung cấp không đúng định dạng hoặc đã hết hạn.

Tìm nạp nhà cung cấp email

Bạn có thể xem tất cả các nhà cung cấp liên kết với một email đã chỉ định bằng cách phát một HTTP Yêu cầu POST đến điểm cuối xác thực createAuthUri.

Phương thức: POST

Loại nội dung: ứng dụng/json

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

Yêu cầu mẫu

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]"}'

Yêu cầu thành công được biểu thị bằng một HTTP 200 OK mã trạng thái. Phản hồi có chứa danh sách các nhà cung cấp liên kết với email đó.

Phản hồi mẫu

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

Các mã lỗi thường gặp

• INVALID_EMAIL: Địa chỉ email có định dạng sai.

Gửi email đặt lại mật khẩu

Bạn có thể gửi email đặt lại mật khẩu bằng cách phát một HTTP Yêu cầu POST đến điểm cuối xác thực getOobConfirmationCode.

Phương thức: POST

Loại nội dung: ứng dụng/json

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

Yêu cầu mẫu

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]"}'

Yêu cầu thành công được biểu thị bằng một HTTP 200 OK mã trạng thái.

Phản hồi mẫu

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

Các mã lỗi thường gặp

• EMAIL_NOT_FOUND: Không có hồ sơ người dùng nào tương ứng với giá trị nhận dạng này. Người dùng có thể đã bị xóa.

Xác minh mã đặt lại mật khẩu

Bạn có thể xác minh mã đặt lại mật khẩu bằng cách phát hành một HTTP Yêu cầu POST đến điểm cuối xác thực resetPassword.

Phương thức: POST

Loại nội dung: ứng dụng/json

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

Yêu cầu mẫu

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

Yêu cầu thành công được biểu thị bằng một HTTP 200 OK mã trạng thái.

Phản hồi mẫu

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

Các mã lỗi thường gặp

• ACTIVITY_NOT_ALLOWED: Tính năng đăng nhập bằng mật khẩu bị tắt cho dự án này.
• EXPIRED_OOB_CODE: Mã tác vụ đã hết hạn.
• INVALID_OOB_CODE: Mã tác vụ không hợp lệ. Điều này có thể xảy ra nếu mã không đúng định dạng, đã hết hạn hoặc đã được sử dụng.

Xác nhận đặt lại mật khẩu

Bạn có thể áp dụng thay đổi đặt lại mật khẩu bằng cách phát hành một HTTP Yêu cầu POST đến điểm cuối xác thực resetPassword.

Phương thức: POST

Loại nội dung: ứng dụng/json

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

Yêu cầu mẫu

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]"}'

Yêu cầu thành công được biểu thị bằng một HTTP 200 OK mã trạng thái.

Phản hồi mẫu

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

Các mã lỗi thường gặp

• ACTIVITY_NOT_ALLOWED: Tính năng đăng nhập bằng mật khẩu bị tắt cho dự án này.
• EXPIRED_OOB_CODE: Mã tác vụ đã hết hạn.
• INVALID_OOB_CODE: Mã tác vụ không hợp lệ. Điều này có thể xảy ra nếu mã không đúng định dạng, đã hết hạn hoặc đã được sử dụng.
• USER_DISABLED: Tài khoản người dùng đã bị quản trị viên vô hiệu hoá.

Đổi email

Bạn có thể thay đổi email của người dùng bằng cách phát hành một HTTP Yêu cầu POST đến điểm cuối xác thực setAccountInfo.

Phương thức: POST

Loại nội dung: ứng dụng/json

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

Yêu cầu mẫu

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}'

Yêu cầu thành công được biểu thị bằng một HTTP 200 OK mã trạng thái. Phản hồi chứa mã thông báo mã nhận dạng Firebase mới và mã làm mới được liên kết với người dùng.

Phản hồi mẫu

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

Các mã lỗi thường gặp

• EMAIL_EXISTS: Địa chỉ email đã được một tài khoản khác sử dụng.
• INVALID_ID_TOKEN:Thông tin đăng nhập của người dùng không còn hợp lệ. Người dùng phải đăng nhập lại.

Đổi mật khẩu

Bạn có thể thay đổi mật khẩu của người dùng bằng cách phát hành một HTTP Yêu cầu POST đến điểm cuối xác thực setAccountInfo.

Phương thức: POST

Loại nội dung: ứng dụng/json

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

Yêu cầu mẫu

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}'

Yêu cầu thành công được biểu thị bằng một HTTP 200 OK mã trạng thái. Phản hồi chứa mã thông báo mã nhận dạng Firebase mới và mã làm mới được liên kết với người dùng.

Phản hồi mẫu

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

Các mã lỗi thường gặp

• INVALID_ID_TOKEN:Thông tin đăng nhập của người dùng không còn hợp lệ. Người dùng phải đăng nhập lại.
• WEAK_Password: Mật khẩu phải dài từ 6 ký tự trở lên.

Cập nhật hồ sơ

Bạn có thể cập nhật hồ sơ của người dùng (tên hiển thị / URL ảnh) bằng cách cấp HTTP Yêu cầu POST đến điểm cuối xác thực setAccountInfo.

Phương thức: POST

Loại nội dung: ứng dụng/json

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

Yêu cầu mẫu

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}'

Yêu cầu thành công được biểu thị bằng một HTTP 200 OK mã trạng thái.

Phản hồi mẫu

{
  "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"
}

Các mã lỗi thường gặp

• INVALID_ID_TOKEN:Thông tin đăng nhập của người dùng không còn hợp lệ. Người dùng phải đăng nhập lại.

Lấy dữ liệu người dùng

Bạn có thể lấy dữ liệu của người dùng bằng cách phát hành một HTTP Yêu cầu POST đến điểm cuối xác thực getAccountInfo.

Phương thức: POST

Loại nội dung: ứng dụng/json

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

Yêu cầu mẫu

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

Yêu cầu thành công được biểu thị bằng một HTTP 200 OK mã trạng thái. Phản hồi sẽ chứa tất cả thông tin người dùng liên quan đến tài khoản.

Phản hồi mẫu

{
  "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
    }
  ]
}

Các mã lỗi thường gặp

• INVALID_ID_TOKEN:Thông tin đăng nhập của người dùng không còn hợp lệ. Người dùng phải đăng nhập lại.
• USER_NOT_FOUND: Không có hồ sơ người dùng nào tương ứng với giá trị nhận dạng này. Người dùng có thể đã bị xóa.

Liên kết với email/mật khẩu

Bạn có thể liên kết email/mật khẩu đến người dùng hiện tại bằng cách phát một HTTP Yêu cầu POST đến điểm cuối xác thực setAccountInfo.

Phương thức: POST

Loại nội dung: ứng dụng/json

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

Yêu cầu mẫu

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}'

Yêu cầu thành công được biểu thị bằng một HTTP 200 OK mã trạng thái. Phản hồi chứa mã thông báo nhận dạng Firebase và mã làm mới được liên kết với người dùng đã xác thực.

Phản hồi mẫu

{
  "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
}

Các mã lỗi thường gặp

• CREDENTIAL_TOO_OLD_LOGIN_ Music: Thông tin đăng nhập của người dùng không còn hợp lệ. Người dùng phải hãy đăng nhập lại.
• TOKEN_EXPIRED: Thông tin đăng nhập của người dùng không còn hợp lệ. Người dùng phải đăng nhập lại.
• INVALID_ID_TOKEN:Thông tin đăng nhập của người dùng không còn hợp lệ. Người dùng phải đăng nhập lại.
• WEAK_Password: Mật khẩu phải dài từ 6 ký tự trở lên.

Liên kết bằng thông tin đăng nhập OAuth

Bạn có thể liên kết thông tin đăng nhập OAuth với người dùng bằng cách gửi một HTTP Yêu cầu POST đến điểm cuối xác thực verifyAssertion.

Phương thức: POST

Loại nội dung: ứng dụng/json

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

Yêu cầu mẫu có mã thông báo mã OAuth

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}'

Yêu cầu thành công được biểu thị bằng một HTTP 200 OK mã trạng thái. Phản hồi chứa mã thông báo mã nhận dạng Firebase và mã làm mới được liên kết với người dùng đã xác thực.

Phản hồi mẫu có mã thông báo mã OAuth

{
  "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\", ...}"
}

Yêu cầu mẫu có mã truy cập 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}'

Yêu cầu thành công được biểu thị bằng một HTTP 200 OK mã trạng thái. Phản hồi chứa mã thông báo mã nhận dạng Firebase và mã làm mới được liên kết với người dùng đã xác thực.

Phản hồi mẫu có mã truy cập 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\", ...}"
}

Yêu cầu mẫu bằng thông tin đăng nhập OAuth 1.0 của Twitter

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}'

Yêu cầu thành công được biểu thị bằng một HTTP 200 OK mã trạng thái. Phản hồi chứa mã thông báo mã nhận dạng Firebase và mã làm mới được liên kết với người dùng đã xác thực.

Phản hồi mẫu có thông tin đăng nhập OAuth 1.0 của Twitter

{
  "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\", ...}"
}

Các mã lỗi thường gặp

• ACTIVITY_NOT_ALLOWED: Nhà cung cấp tương ứng đã bị tắt cho dự án này.
• INVALID_IDP_reply: Thông tin xác thực được cung cấp không đúng định dạng hoặc đã hết hạn.
• INVALID_ID_TOKEN:Thông tin đăng nhập của người dùng không còn hợp lệ. Người dùng phải đăng nhập lại.
• EMAIL_EXISTS: Địa chỉ email đã được một tài khoản khác sử dụng.
• FEDERATED_USER_ID_ALREADY_LINKED: Thông tin đăng nhập này đã được liên kết với một tên miền khác tài khoản người dùng.

Huỷ liên kết nhà cung cấp

Bạn có thể huỷ liên kết nhà cung cấp khỏi người dùng hiện tại bằng cách gửi HTTP Yêu cầu POST đến điểm cuối xác thực setAccountInfo.

Phương thức: POST

Loại nội dung: ứng dụng/json

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

Yêu cầu mẫu

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]"]}'

Yêu cầu thành công được biểu thị bằng một HTTP 200 OK mã trạng thái.

Phản hồi mẫu

{
  "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"
}

Các mã lỗi thường gặp

• INVALID_ID_TOKEN: Thông tin đăng nhập của người dùng không còn hợp lệ. Người dùng phải đăng nhập lại.

Gửi email xác minh

Bạn có thể gửi xác minh email cho người dùng hiện tại bằng cách phát một HTTP Yêu cầu POST đến điểm cuối xác thực getOobConfirmationCode.

Phương thức: POST

Loại nội dung: ứng dụng/json

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

Yêu cầu mẫu

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]"}'

Yêu cầu thành công được biểu thị bằng một HTTP 200 OK mã trạng thái.

Phản hồi mẫu

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

Các mã lỗi thường gặp

• INVALID_ID_TOKEN: Thông tin đăng nhập của người dùng không còn hợp lệ. Người dùng phải đăng nhập lại.
• USER_NOT_FOUND: Không có hồ sơ người dùng nào tương ứng với giá trị nhận dạng này. Người dùng có thể đã bị xóa.

Xác nhận xác minh email

Bạn có thể xác nhận mã xác minh email bằng cách phát một HTTP Yêu cầu POST đến điểm cuối xác thực setAccountInfo.

Phương thức: POST

Loại nội dung: ứng dụng/json

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

Yêu cầu mẫu

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

Yêu cầu thành công được biểu thị bằng một HTTP 200 OK mã trạng thái.

Phản hồi mẫu

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

Các mã lỗi thường gặp

• EXPIRED_OOB_CODE: Mã tác vụ đã hết hạn.
• INVALID_OOB_CODE: Mã tác vụ không hợp lệ. Điều này có thể xảy ra nếu mã không đúng định dạng, đã hết hạn hoặc đã được sử dụng.
• USER_DISABLED: Tài khoản người dùng đã bị quản trị viên vô hiệu hoá.
• EMAIL_NOT_FOUND: Không có hồ sơ người dùng nào tương ứng với giá trị nhận dạng này. Người dùng có thể đã bị xóa.

Xoá tài khoản

Bạn có thể xoá người dùng hiện tại bằng cách cấp một HTTP Yêu cầu POST đến điểm cuối xác thực deleteAccount.

Phương thức: POST

Loại nội dung: ứng dụng/json

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

Yêu cầu mẫu

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

Yêu cầu thành công được biểu thị bằng một HTTP 200 OK mã trạng thái.

Các mã lỗi thường gặp

• INVALID_ID_TOKEN:Thông tin đăng nhập của người dùng không còn hợp lệ. Người dùng phải đăng nhập lại.
• USER_NOT_FOUND: Không có hồ sơ người dùng nào tương ứng với giá trị nhận dạng này. Người dùng có thể đã bị xóa.

Xoá tài khoản người dùng

Hãy xoá tất cả tài khoản trong dự án đã chỉ định, bất kể trạng thái.

Phương thức: DELETE

Lưu ý rằng 9099 là cổng mặc định cho Trình mô phỏng xác thực. Kiểm tra thiết bị đầu cuối cho cổng thực tế đang được sử dụng.

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

Nhận cấu hình trình mô phỏng

Nhận cấu hình dành riêng cho trình mô phỏng cho dự án đã chỉ định.

Phương thức: GET

Lưu ý rằng 9099 là cổng mặc định cho Trình mô phỏng xác thực. Kiểm tra thiết bị đầu cuối cho cổng thực tế đang được sử dụng.

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

Cấu hình trình mô phỏng bản vá

Cập nhật cấu hình dành riêng cho trình mô phỏng cho dự án được chỉ định.

Phương thức: PATCH

Lưu ý rằng 9099 là cổng mặc định cho Trình mô phỏng xác thực. Kiểm tra thiết bị đầu cuối cho cổng thực tế đang được sử dụng.

Loại nội dung: ứng dụng/json

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

Truy xuất mã xác thực ngoài băng tần

Nếu quy trình xác thực mà bạn đang thử nghiệm thường tạo mã ngoài băng tần (ví dụ: mã xác minh email, mã đặt lại mật khẩu), trình mô phỏng lưu trữ các mã đó nội bộ cho đến chúng sẽ được sử dụng.

Phương thức: GET

Lưu ý rằng 9099 là cổng mặc định cho Trình mô phỏng xác thực. Kiểm tra thiết bị đầu cuối cho cổng thực tế đang được sử dụng.

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

Truy xuất mã xác minh qua SMS

Nếu bạn đang kiểm thử quy trình xác thực qua điện thoại/SMS, trình mô phỏng sẽ lưu trữ các mã SMS đó trong nội bộ cho đến khi chúng được sử dụng.

Phương thức: GET

Lưu ý rằng 9099 là cổng mặc định cho Trình mô phỏng xác thực. Kiểm tra thiết bị đầu cuối cho cổng thực tế đang được sử dụng.

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

Định dạng phản hồi lỗi

Bất cứ khi nào một lỗi được máy chủ phụ trợ trả về cho bất kỳ API nào ở trên, phản hồi sẽ có định dạng như sau.

Phản hồi mẫu

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

Mã lỗi được lấy từ trường tin nhắn. Tất cả mã lỗi trên đề cập đến việc nội dung của trường tin nhắn.