Sử dụng API
Bạn có thể truy vấn phần phụ trợ Firebase Auth thông qua API REST. Điều này có thể được sử dụng cho nhiều hoạt động khác nhau như tạo người dùng mới, đăng nhập những người dùng hiện có và chỉnh sửa hoặc xóa những người dùng này.
Xuyên suốt tài liệu này, API_KEY
đề cập đến Khóa API Web, có thể lấy được trên trang cài đặt dự án trong bảng điều khiển dành cho quản trị viên của bạn.
Trao đổi mã thông báo tùy chỉnh lấy ID và mã thông báo làm mới
Bạn có thể trao đổi mã thông báo Auth tùy chỉnh lấy ID và mã thông báo làm mới bằng cách đưa ra yêu cầu HTTP POST
tới điểm cuối Auth verifyCustomToken
.
Phương pháp: ĐĂNG
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:signInWithCustomToken?key=[API_KEY]Tải trọng nội dung yêu cầu
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
mã thông báo | sợi dây | Mã thông báo tùy chỉnh Firebase Auth để tạo cặp ID và làm mới mã thông báo. |
returnSecureToken | boolean | Có trả lại ID và làm mới mã thông báo hay không. Phải luôn luôn đúng. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
idToken | sợi dây | Mã thông báo ID xác thực Firebase được tạo từ mã thông báo tùy chỉnh được cung cấp. |
làm mớiToken | sợi dây | Mã thông báo làm mới Firebase Auth được tạo từ mã thông báo tùy chỉnh được cung cấp. |
hết hạnTrong | sợi dây | Số giây mà mã thông báo ID hết hạn. |
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ã trạng thái HTTP 200 OK
. Phản hồi chứa mã thông báo ID Firebase và mã thông báo làm mới được liên kết với mã thông báo tùy chỉnh.
Phản hồi mẫu
{ "idToken": "[ID_TOKEN]", "refreshToken": "[REFRESH_TOKEN]", "expiresIn": "3600" }
Mã lỗi phổ biến
- INVALID_CUSTOM_TOKEN: Định dạng mã thông báo tùy chỉnh không chính xác hoặc mã thông báo không hợp lệ vì 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 tùy chỉnh tương ứng với một dự án Firebase khác.
Đổi mã thông báo làm mới lấy mã thông báo ID
Bạn có thể làm mới mã thông báo ID Firebase bằng cách cấp yêu cầu POST
HTTP cho securetoken.googleapis.com
điểm cuối.
Phương pháp: ĐĂNG
Loại nội dung: application/x-www-form-urlencoded
Điểm cuốihttps://securetoken.googleapis.com/v1/token?key=[API_KEY]Tải trọng nội dung yêu cầu
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
cấp_loại | sợi dây | Loại cấp phép của mã thông báo làm mới, luôn là "refresh_token". |
làm mới_token | sợi dây | Mã thông báo làm mới Firebase Auth. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
hết hạn_in | sợi dây | Số giây mà mã thông báo ID hết hạn. |
token_type | sợi dây | Loại mã thông báo làm mới, luôn là "Người mang". |
làm mới_token | sợi dây | Mã thông báo làm mới Firebase Auth được cung cấp trong yêu cầu hoặc mã thông báo làm mới mới. |
id_token | sợi dây | Mã thông báo ID xác thực Firebase. |
tên người dùng | sợi dây | Uid tương ứng với mã thông báo ID được cung cấp. |
dự án_id | sợi dây | ID dự án Firebase của bạn. |
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ã trạng thái HTTP 200 OK
. Phản hồi chứa mã thông báo ID Firebase mới và mã thông báo 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" }
Mã lỗi phổ biến
- TOKEN_EXPIRED: Thông tin xác thực 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 hóa.
- USER_NOT_FOUND: Không tìm thấy người dùng tương ứng với mã thông báo làm mới. Có khả năng người dùng đã bị xóa.
- Khóa API không hợp lệ. Vui lòng chuyển khóa API hợp lệ. (đã cung cấp khóa API không hợp lệ)
- INVALID_REFRESH_TOKEN: Mã thông báo làm mới không hợp lệ được cung cấp.
- Đã 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 tham số truy vấn. Không thể tìm thấy trường 'refresh_tokens' trong thông báo yêu cầu.
- INVALID_GRANT_TYPE: Loại cấp phép được chỉ định không hợp lệ.
- MISSING_REFRESH_TOKEN: Không cung cấp mã thông báo làm mới.
- PROJECT_NUMBER_MISMATCH: Số dự án của mã thông báo làm mới không khớp với mã khóa 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 đưa ra yêu cầu HTTP POST
tới điểm cuối Auth signupNewUser
.
Phương pháp: ĐĂNG
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]Tải trọng nội dung yêu cầu
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
sợi dây | Email để người dùng tạo. | |
mật khẩu | sợi dây | Mật khẩu do người dùng tạo. |
returnSecureToken | boolean | Có trả lại ID và làm mới mã thông báo hay không. Phải luôn luôn đúng. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
idToken | sợi dây | Mã thông báo ID xác thực Firebase cho người dùng mới được tạo. |
sợi dây | Email cho người dùng mới được tạo. | |
làm mớiToken | sợi dây | Mã thông báo làm mới Firebase Auth cho người dùng mới được tạo. |
hết hạnTrong | sợi dây | Số giây mà mã thông báo ID hết hạn. |
ID địa phương | sợi dây | Uid của người dùng mới được tạo. |
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ã trạng thái HTTP 200 OK
. Phản hồi chứa mã thông báo ID Firebase và mã thông báo 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..." }
Mã lỗi phổ biến
- EMAIL_EXISTS: Địa chỉ email đã được tài khoản khác sử dụng.
- OPERATION_NOT_ALLOWED: Đăng nhập bằng mật khẩu bị vô hiệu hóa đối với dự án này.
- TOO_MANY_ATTEMPTS_TRY_LATER: Chúng tôi đã chặn tất cả yêu cầu từ thiết bị này do hoạt động bất thường. 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 bằng cách đưa ra yêu cầu HTTP POST
tới điểm cuối Auth verifyPassword
.
Phương pháp: ĐĂNG
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key=[API_KEY]Tải trọng nội dung yêu cầu
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
sợi dây | Email mà người dùng đang đăng nhập. | |
mật khẩu | sợi dây | Mật khẩu cho tài khoản. |
returnSecureToken | boolean | Có trả lại ID và làm mới mã thông báo hay không. Phải luôn luôn đúng. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
idToken | sợi dây | Mã thông báo ID xác thực Firebase cho người dùng được xác thực. |
sợi dây | Email dành cho người dùng đã được xác thực. | |
làm mớiToken | sợi dây | Mã thông báo làm mới Firebase Auth cho người dùng được xác thực. |
hết hạnTrong | sợi dây | Số giây mà mã thông báo ID hết hạn. |
ID địa phương | sợi dây | Uid của người dùng được xác thực. |
đăng ký | boolean | Liệu email có dành cho tài khoản hiện có hay không. |
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ã trạng thái HTTP 200 OK
. Phản hồi chứa mã thông báo ID Firebase và mã thông báo làm mới được liên kết với 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" }
Mã lỗi phổ biến
- EMAIL_NOT_FOUND: Không có hồ sơ người dùng nào tương ứng với mã định danh này. Người dùng có thể đã bị xóa.
- INVALID_PASSWORD: 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 hóa.
Đăng nhập ẩn danh
Bạn có thể đăng nhập ẩn danh cho người dùng bằng cách đưa ra yêu cầu HTTP POST
tới điểm cuối Auth signupNewUser
.
Phương pháp: ĐĂNG
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]Tải trọng nội dung yêu cầu
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
returnSecureToken | boolean | Có trả lại ID và làm mới mã thông báo hay không. Phải luôn luôn đúng. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
idToken | sợi dây | Mã thông báo ID xác thực Firebase cho người dùng mới được tạo. |
sợi dây | Vì người dùng ẩn danh nên phần này sẽ trống. | |
làm mớiToken | sợi dây | Mã thông báo làm mới Firebase Auth cho người dùng mới được tạo. |
hết hạnTrong | sợi dây | Số giây mà mã thông báo ID hết hạn. |
ID địa phương | sợi dây | Uid của người dùng mới được tạo. |
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ã trạng thái HTTP 200 OK
. Phản hồi chứa mã thông báo ID Firebase và mã thông báo 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..." }
Mã lỗi phổ biến
- OPERATION_NOT_ALLOWED: Đăng nhập của người dùng ẩn danh bị vô hiệu hóa đối với dự án này.
Đăng nhập bằng thông tin xác thực OAuth
Bạn có thể đăng nhập người dùng bằng thông tin xác thực OAuth bằng cách đưa ra yêu cầu HTTP POST
tới điểm cuối Auth verifyAssertion
.
Phương pháp: ĐĂNG
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]Tải trọng nội dung yêu cầu
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
yêu cầuUri | sợi dây | URI mà IDP chuyển hướng người dùng quay lại. |
bàiBody | sợi dây | Chứa thông tin xác thực OAuth (mã thông báo ID hoặc mã thông báo truy cập) và ID nhà cung cấp cấp thông tin xác thực. |
returnSecureToken | boolean | Có trả lại ID và làm mới mã thông báo hay không. Phải luôn luôn đúng. |
returnIdpThông tin xác thực | boolean | Có buộc trả lại thông tin xác thực OAuth đối với các lỗi sau hay không: FEDERATED_USER_ID_ALREADY_LINKED và EMAIL_EXISTS. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
Id liên kết | sợi dây | ID duy nhất xác định tài khoản IdP. |
id nhà cung cấp | sợi dây | ID nhà cung cấp được liên kết (ví dụ: "google.com" dành cho nhà cung cấp Google). |
ID địa phương | sợi dây | Uid của người dùng được xác thực. |
email đã kích hoạt | boolean | Email đăng nhập có được xác minh hay không. |
sợi dây | Email của tài khoản. | |
oauthIdToken | sợi dây | Mã thông báo id OIDC nếu có. |
oauthAccessToken | sợi dây | Mã thông báo truy cập OAuth nếu có. |
oauthTokenBí mật | sợi dây | Bí mật mã thông báo OAuth 1.0 nếu có. |
thông tin người dùng thô | sợi dây | Phản hồi JSON được xâu chuỗi chứa tất cả dữ liệu IdP tương ứng với thông tin xác thực OAuth được cung cấp. |
tên đầu tiên | sợi dây | Tên đầu tiên của tài khoản. |
họ | sợi dây | Họ của tài khoản. |
Họ và tên | sợi dây | Tên đầy đủ của tài khoản. |
tên hiển thị | sợi dây | Tên hiển thị cho tài khoản. |
url ảnh | sợi dây | Url ảnh cho tài khoản. |
idToken | sợi dây | Mã thông báo ID xác thực Firebase cho người dùng được xác thực. |
làm mớiToken | sợi dây | Mã thông báo làm mới Firebase Auth cho người dùng được xác thực. |
hết hạnTrong | sợi dây | Số giây mà mã thông báo ID hết hạn. |
cầnXác nhận | boolean | Liệu một tài khoản khác có cùng thông tin xác thực đã tồn tại hay chưa. Người dùng sẽ cần đăng nhập vào tài khoản ban đầu và sau đó liên kết thông tin xác thực hiện tại với tài khoản đó. |
Yêu cầu mẫu với mã thông báo ID 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ã trạng thái HTTP 200 OK
. Phản hồi chứa mã thông báo ID Firebase và mã thông báo làm mới được liên kết với người dùng được xác thực.
Phản hồi mẫu bằng mã thông báo ID 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ã thông báo 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ã trạng thái HTTP 200 OK
. Phản hồi chứa mã thông báo ID Firebase và mã thông báo làm mới được liên kết với người dùng được xác thực.
Phản hồi mẫu với mã thông báo 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 với thông tin xác thực 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}'
Yêu cầu thành công được biểu thị bằng mã trạng thái HTTP 200 OK
. Phản hồi chứa mã thông báo ID Firebase và mã thông báo làm mới được liên kết với người dùng được xác thực.
Phản hồi mẫu với thông tin xác thực 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\", ...}" }
Mã lỗi phổ biến
- OPERATION_NOT_ALLOWED: Nhà cung cấp tương ứng bị vô hiệu hóa đối với dự án này.
- INVALID_IDP_RESPONSE: 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 được liên kết với một email được chỉ định bằng cách đưa ra yêu cầu HTTP POST
tới điểm cuối Auth createAuthUri
.
Phương pháp: ĐĂNG
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:createAuthUri?key=[API_KEY]Tải trọng nội dung yêu cầu
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
định danh | sợi dây | Địa chỉ email của người dùng |
tiếp tụcUri | sợi dây | URI mà IDP chuyển hướng người dùng quay lại. Đối với trường hợp sử dụng này, đây chỉ là URL hiện tại. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
tất cả các nhà cung cấp | Danh sách các chuỗi | Danh sách các nhà cung cấp mà người dùng đã đăng nhập trước đó. |
đăng ký | boolean | Liệu email có dành cho tài khoản hiện tại hay không |
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ã trạng thái HTTP 200 OK
. Phản hồi chứa danh sách các nhà cung cấp được liên kết với email.
Phản hồi mẫu
{ "allProviders": [ "password", "google.com" ], "registered": true }
Mã lỗi phổ biến
- INVALID_EMAIL: Địa chỉ email bị đị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 đưa ra yêu cầu HTTP POST
tới điểm cuối Auth getOobConfirmationCode
.
Phương pháp: ĐĂNG
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]Tiêu đề tùy chọn
Tên tài sản | Sự miêu tả |
---|---|
X-Firebase-Locale | Mã ngôn ngữ tương ứng với ngôn ngữ của người dùng. Việc vượt qua điều này sẽ bản địa hóa email đặt lại mật khẩu được gửi cho người dùng. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
loại yêu cầu | sợi dây | Loại mã OOB cần trả về. Phải là "PASSWORD_RESET" để đặt lại mật khẩu. |
sợi dây | Địa chỉ email của người dùng. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
sợi dây | Địa chỉ email của người dùng. |
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ã trạng thái HTTP 200 OK
.
Phản hồi mẫu
{ "email": "[user@example.com]" }
Mã lỗi phổ biến
- EMAIL_NOT_FOUND: Không có hồ sơ người dùng nào tương ứng với mã định danh 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 đưa ra yêu cầu HTTP POST
tới điểm cuối Auth resetPassword
.
Phương pháp: ĐĂNG
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]Tải trọng nội dung yêu cầu
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
mã oob | sợi dây | Mã hành động email được gửi đến email của người dùng để đặt lại mật khẩu. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
sợi dây | Địa chỉ email của người dùng. | |
loại yêu cầu | sợi dây | Loại mã hành động email. Phải là "PASSWORD_RESET". |
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ã trạng thái HTTP 200 OK
.
Phản hồi mẫu
{ "email": "[user@example.com]", "requestType": "PASSWORD_RESET" }
Mã lỗi phổ biến
- OPERATION_NOT_ALLOWED: Đăng nhập bằng mật khẩu bị vô hiệu hóa đối với dự án này.
- EXPIRED_OOB_CODE: Mã hành động đã hết hạn.
- INVALID_OOB_CODE: Mã hành động 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 đưa ra yêu cầu HTTP POST
tới điểm cuối Auth resetPassword
.
Phương pháp: ĐĂNG
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]Tải trọng nội dung yêu cầu
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
mã oob | sợi dây | Mã hành động email được gửi đến email của người dùng để đặt lại mật khẩu. |
mật khẩu mới | sợi dây | Mật khẩu mới của người dùng. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
sợi dây | Địa chỉ email của người dùng. | |
loại yêu cầu | sợi dây | Loại mã hành động email. Phải là "PASSWORD_RESET". |
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ã trạng thái HTTP 200 OK
.
Phản hồi mẫu
{ "email": "[user@example.com]", "requestType": "PASSWORD_RESET" }
Mã lỗi phổ biến
- OPERATION_NOT_ALLOWED: Đăng nhập bằng mật khẩu bị vô hiệu hóa đối với dự án này.
- EXPIRED_OOB_CODE: Mã hành động đã hết hạn.
- INVALID_OOB_CODE: Mã hành động 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 hóa.
Thay đổi e-mail
Bạn có thể thay đổi email của người dùng bằng cách đưa ra yêu cầu HTTP POST
tới điểm cuối Auth setAccountInfo
.
Phương pháp: ĐĂNG
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]Tiêu đề tùy chọn
Tên tài sản | Sự miêu tả |
---|---|
X-Firebase-Locale | Mã ngôn ngữ tương ứng với ngôn ngữ của người dùng. Việc vượt qua điều này sẽ bản địa hóa việc thu hồi thay đổi email được gửi tới người dùng. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
idToken | sợi dây | Mã thông báo ID xác thực Firebase cho người dùng. |
sợi dây | Email mới của người dùng. | |
returnSecureToken | boolean | Có trả lại ID và làm mới mã thông báo hay không. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
ID địa phương | sợi dây | uid của người dùng hiện tại. |
sợi dây | Địa chỉ email của người dùng. | |
mật khẩu băm | sợi dây | Phiên bản băm của mật khẩu. |
thông tin người dùng của nhà cung cấp | Danh sách các đối tượng JSON | Danh sách tất cả các đối tượng nhà cung cấp được liên kết có chứa "providerId" và "federatedId". |
idToken | sợi dây | Mã thông báo ID xác thực Firebase mới cho người dùng. |
làm mớiToken | sợi dây | Mã thông báo làm mới Firebase Auth. |
hết hạnTrong | sợi dây | Số giây mà mã thông báo ID hết hạn. |
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ã trạng thái HTTP 200 OK
. Phản hồi chứa mã thông báo ID Firebase mới và mã thông báo 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" }
Mã lỗi phổ biến
- EMAIL_EXISTS: Địa chỉ email đã được tài khoản khác sử dụng.
- INVALID_ID_TOKEN:Thông tin xác thực 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 đưa ra yêu cầu HTTP POST
tới điểm cuối Auth setAccountInfo
.
Phương pháp: ĐĂNG
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]Tải trọng nội dung yêu cầu
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
idToken | sợi dây | Mã thông báo ID xác thực Firebase cho người dùng. |
mật khẩu | sợi dây | Mật khẩu mới của người dùng. |
returnSecureToken | boolean | Có trả lại ID và làm mới mã thông báo hay không. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
ID địa phương | sợi dây | uid của người dùng hiện tại. |
sợi dây | Địa chỉ email của người dùng. | |
mật khẩu băm | sợi dây | Phiên bản băm của mật khẩu. |
thông tin người dùng của nhà cung cấp | Danh sách các đối tượng JSON | Danh sách tất cả các đối tượng nhà cung cấp được liên kết có chứa "providerId" và "federatedId". |
idToken | sợi dây | Mã thông báo ID xác thực Firebase mới cho người dùng. |
làm mớiToken | sợi dây | Mã thông báo làm mới Firebase Auth. |
hết hạnTrong | sợi dây | Số giây mà mã thông báo ID hết hạn. |
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ã trạng thái HTTP 200 OK
. Phản hồi chứa mã thông báo ID Firebase mới và mã thông báo 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" }
Mã lỗi phổ biến
- INVALID_ID_TOKEN:Thông tin xác thực 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 đưa ra yêu cầu HTTP POST
tới điểm cuối Auth setAccountInfo
.
Phương pháp: ĐĂNG
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]Tải trọng nội dung yêu cầu
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
idToken | sợi dây | Mã thông báo ID xác thực Firebase cho người dùng. |
tên hiển thị | sợi dây | Tên hiển thị mới của người dùng. |
url ảnh | sợi dây | Url ảnh mới của người dùng. |
xóa thuộc tính | Danh sách các chuỗi | Danh sách thuộc tính cần xóa, "DISPLAY_NAME" hoặc "PHOTO_URL". Điều này sẽ vô hiệu hóa các giá trị này. |
returnSecureToken | boolean | Có trả lại ID và làm mới mã thông báo hay không. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
ID địa phương | sợi dây | uid của người dùng hiện tại. |
sợi dây | Địa chỉ email của người dùng. | |
tên hiển thị | sợi dây | Tên hiển thị mới của người dùng. |
url ảnh | sợi dây | Url ảnh mới của người dùng. |
mật khẩu băm | sợi dây | Phiên bản băm của mật khẩu. |
thông tin người dùng của nhà cung cấp | Danh sách các đối tượng JSON | Danh sách tất cả các đối tượng nhà cung cấp được liên kết có chứa "providerId" và "federatedId". |
idToken | sợi dây | Mã thông báo ID xác thực Firebase mới cho người dùng. |
làm mớiToken | sợi dây | Mã thông báo làm mới Firebase Auth. |
hết hạnTrong | sợi dây | Số giây mà mã thông báo ID hết hạn. |
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ã trạng thái HTTP 200 OK
.
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" }
Mã lỗi phổ biến
- INVALID_ID_TOKEN:Thông tin xác thực 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 đưa ra yêu cầu HTTP POST
tới điểm cuối Auth getAccountInfo
.
Phương pháp: ĐĂNG
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:lookup?key=[API_KEY]Tải trọng nội dung yêu cầu
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
idToken | sợi dây | Mã thông báo ID Firebase của tài khoản. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
người dùng | Danh sách các đối tượng JSON | Tài khoản được liên kết với mã thông báo ID Firebase đã cho. Kiểm tra bên dưới để biết thêm chi tiết. |
users
)Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
ID địa phương | sợi dây | uid của người dùng hiện tại. |
sợi dây | Email của tài khoản. | |
email đã kích hoạt | boolean | Email của tài khoản đã được xác minh hay chưa. |
tên hiển thị | sợi dây | Tên hiển thị cho tài khoản. |
thông tin người dùng của nhà cung cấp | Danh sách các đối tượng JSON | Danh sách tất cả các đối tượng nhà cung cấp được liên kết có chứa "providerId" và "federatedId". |
url ảnh | sợi dây | Url ảnh cho tài khoản. |
mật khẩu băm | sợi dây | Phiên bản băm của mật khẩu. |
mật khẩuĐã cập nhậtTại | gấp đôi | Dấu thời gian tính bằng mili giây cho biết mật khẩu tài khoản được thay đổi lần cuối. |
hợp lệVì | sợi dây | Dấu thời gian tính bằng giây đánh dấu ranh giới mà trước đó mã thông báo ID Firebase được coi là bị thu hồi. |
tàn tật | boolean | Cho dù tài khoản có bị vô hiệu hóa hay không. |
lần cuốiĐăng nhậpTại | sợi dây | Dấu thời gian tính bằng mili giây mà tài khoản đăng nhập lần cuối. |
đã tạoTại | sợi dây | Dấu thời gian tính bằng mili giây mà tài khoản được tạo tại thời điểm đó. |
tùy chỉnhAuth | boolean | Liệu tài khoản có được nhà phát triển xác thực hay không. |
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ã trạng thái HTTP 200 OK
. Phản hồi sẽ chứa tất cả thông tin người dùng được liên kết với 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 } ] }
Mã lỗi phổ biến
- INVALID_ID_TOKEN:Thông tin xác thực 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 tương ứng với mã định danh này. Người dùng có thể đã bị xóa.
Liên kết bằng email/mật khẩu
Bạn có thể liên kết email/mật khẩu với người dùng hiện tại bằng cách đưa ra yêu cầu HTTP POST
tới điểm cuối Auth setAccountInfo
.
Phương pháp: ĐĂNG
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]Tải trọng nội dung yêu cầu
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
idToken | sợi dây | Mã thông báo ID Firebase của tài khoản mà bạn đang cố liên kết thông tin xác thực. |
sợi dây | Email để liên kết với tài khoản. | |
mật khẩu | sợi dây | Mật khẩu mới của tài khoản. |
returnSecureToken | sợi dây | Có trả lại ID và làm mới mã thông báo hay không. Phải luôn luôn đúng. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
ID địa phương | sợi dây | uid của người dùng hiện tại. |
sợi dây | Email của tài khoản. | |
tên hiển thị | sợi dây | Tên hiển thị cho tài khoản. |
url ảnh | sợi dây | Url ảnh cho tài khoản. |
mật khẩu băm | sợi dây | Phiên bản băm của mật khẩu. |
thông tin người dùng của nhà cung cấp | Danh sách các đối tượng JSON | Danh sách tất cả các đối tượng nhà cung cấp được liên kết có chứa "providerId" và "federatedId". |
email đã kích hoạt | boolean | Email của tài khoản đã được xác minh hay chưa. |
idToken | sợi dây | Mã thông báo ID xác thực Firebase mới cho người dùng. |
làm mớiToken | sợi dây | Mã thông báo làm mới Firebase Auth. |
hết hạnTrong | sợi dây | Số giây mà mã thông báo ID hết hạn. |
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ã trạng thái HTTP 200 OK
. Phản hồi chứa mã thông báo ID Firebase và mã thông báo làm mới được liên kết với người dùng được 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 }
Mã lỗi phổ biến
- CREDENTIAL_TOO_OLD_LOGIN_AGAIN: Thông tin xác thực của người dùng không còn hợp lệ. Người dùng phải đăng nhập lại.
- TOKEN_EXPIRED: Thông tin xác thực 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 xác thực 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 với thông tin xác thực OAuth
Bạn có thể liên kết thông tin xác thực OAuth với người dùng bằng cách đưa ra yêu cầu HTTP POST
tới điểm cuối Auth verifyAssertion
.
Phương pháp: ĐĂNG
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]Tải trọng nội dung yêu cầu
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
idToken | sợi dây | Mã thông báo ID Firebase của tài khoản mà bạn đang cố liên kết thông tin xác thực. |
yêu cầuUri | sợi dây | URI mà IDP chuyển hướng người dùng quay lại. |
bàiBody | sợi dây | Chứa thông tin xác thực OAuth (mã thông báo ID hoặc mã thông báo truy cập) và ID nhà cung cấp cấp thông tin xác thực. |
returnSecureToken | boolean | Có trả lại ID và làm mới mã thông báo hay không. Phải luôn luôn đúng. |
returnIdpThông tin xác thực | boolean | Có buộc trả lại thông tin xác thực OAuth đối với các lỗi sau hay không: FEDERATED_USER_ID_ALREADY_LINKED và EMAIL_EXISTS. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
Id liên kết | sợi dây | ID duy nhất xác định tài khoản IdP. |
id nhà cung cấp | sợi dây | ID nhà cung cấp được liên kết (ví dụ: "google.com" dành cho nhà cung cấp Google). |
ID địa phương | sợi dây | Uid của người dùng được xác thực. |
email đã kích hoạt | boolean | Email đăng nhập có được xác minh hay không. |
sợi dây | Email của tài khoản. | |
oauthIdToken | sợi dây | Mã thông báo id OIDC nếu có. |
oauthAccessToken | sợi dây | Mã thông báo truy cập OAuth nếu có. |
oauthTokenBí mật | sợi dây | Bí mật mã thông báo OAuth 1.0 nếu có. |
thông tin người dùng thô | sợi dây | Phản hồi JSON được xâu chuỗi chứa tất cả dữ liệu IdP tương ứng với thông tin xác thực OAuth được cung cấp. |
tên đầu tiên | sợi dây | Tên đầu tiên của tài khoản. |
họ | sợi dây | Họ của tài khoản. |
Họ và tên | sợi dây | Tên đầy đủ của tài khoản. |
tên hiển thị | sợi dây | Tên hiển thị cho tài khoản. |
url ảnh | sợi dây | Url ảnh cho tài khoản. |
idToken | sợi dây | Mã thông báo ID xác thực Firebase cho người dùng được xác thực. |
làm mớiToken | sợi dây | Mã thông báo làm mới Firebase Auth cho người dùng được xác thực. |
hết hạnTrong | sợi dây | Số giây mà mã thông báo ID hết hạn. |
Yêu cầu mẫu với mã thông báo ID 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ã trạng thái HTTP 200 OK
. Phản hồi chứa mã thông báo ID Firebase và mã thông báo làm mới được liên kết với người dùng được xác thực.
Phản hồi mẫu bằng mã thông báo ID 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ã thông báo 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ã trạng thái HTTP 200 OK
. Phản hồi chứa mã thông báo ID Firebase và mã thông báo làm mới được liên kết với người dùng được xác thực.
Phản hồi mẫu với mã thông báo 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 với thông tin xác thực 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}'
Yêu cầu thành công được biểu thị bằng mã trạng thái HTTP 200 OK
. Phản hồi chứa mã thông báo ID Firebase và mã thông báo làm mới được liên kết với người dùng được xác thực.
Phản hồi mẫu với thông tin xác thực 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\", ...}" }
Mã lỗi phổ biến
- OPERATION_NOT_ALLOWED: Nhà cung cấp tương ứng bị vô hiệu hóa đối với dự án này.
- INVALID_IDP_RESPONSE: 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 xác thực 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 tài khoản khác sử dụng.
- FEDERATED_USER_ID_ALREADY_LINKED: Thông tin xác thực này đã được liên kết với tài khoản người dùng khác.
Hủy liên kết nhà cung cấp
Bạn có thể hủy liên kết nhà cung cấp khỏi người dùng hiện tại bằng cách đưa ra yêu cầu HTTP POST
tới điểm cuối Auth setAccountInfo
.
Phương pháp: ĐĂNG
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]Tải trọng nội dung yêu cầu
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
idToken | sợi dây | Mã thông báo ID Firebase của tài khoản. |
xóaNhà cung cấp | Danh sách các chuỗi | Danh sách ID nhà cung cấp cần hủy liên kết, ví dụ: 'google.com', 'password', v.v. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
ID địa phương | sợi dây | uid của người dùng hiện tại. |
sợi dây | Email của tài khoản. | |
tên hiển thị | sợi dây | Tên hiển thị cho tài khoản. |
url ảnh | sợi dây | Url ảnh cho tài khoản. |
mật khẩu băm | sợi dây | Phiên bản băm của mật khẩu. |
thông tin người dùng của nhà cung cấp | Danh sách các đối tượng JSON | Danh sách tất cả các đối tượng nhà cung cấp được liên kết có chứa "providerId" và "federatedId". |
email đã kích hoạt | boolean | Email của tài khoản đã được xác minh hay chưa. |
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ã trạng thái HTTP 200 OK
.
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" }
Mã lỗi phổ biến
- INVALID_ID_TOKEN: Thông tin xác thực 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 đưa ra yêu cầu HTTP POST
tới điểm cuối Auth getOobConfirmationCode
.
Phương pháp: ĐĂNG
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]Tiêu đề tùy chọn
Tên tài sản | Sự miêu tả |
---|---|
X-Firebase-Locale | Mã ngôn ngữ tương ứng với ngôn ngữ của người dùng. Việc vượt qua điều này sẽ bản địa hóa xác minh email được gửi cho người dùng. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
loại yêu cầu | sợi dây | Loại mã xác nhận sẽ gửi. Phải luôn là "VERIFY_EMAIL". |
idToken | sợi dây | Mã thông báo ID Firebase của người dùng để xác minh. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
sợi dây | Email của tài khoản. |
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ã trạng thái HTTP 200 OK
.
Phản hồi mẫu
{ "email": "user@example.com" }
Mã lỗi phổ biến
- INVALID_ID_TOKEN: Thông tin xác thực 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 tương ứng với mã định danh 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 đưa ra yêu cầu HTTP POST
tới điểm cuối Auth setAccountInfo
.
Phương pháp: ĐĂNG
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]Tải trọng nội dung yêu cầu
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
mã oob | sợi dây | Mã hành động được gửi đến email của người dùng để xác minh email. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
sợi dây | Email của tài khoản. | |
tên hiển thị | sợi dây | Tên hiển thị cho tài khoản. |
url ảnh | sợi dây | Url ảnh cho tài khoản. |
mật khẩu băm | sợi dây | Băm mật khẩu. |
thông tin người dùng của nhà cung cấp | Danh sách các đối tượng JSON | Danh sách tất cả các đối tượng nhà cung cấp được liên kết có chứa "providerId" và "federatedId". |
email đã kích hoạt | boolean | Email của tài khoản đã được xác minh hay chưa. |
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ã trạng thái HTTP 200 OK
.
Phản hồi mẫu
{ "localId": "FhyStE...", "email": "user@example.com", "passwordHash": "...", "providerUserInfo": [ { "providerId": "password", "federatedId": "user@example.com" } ] }
Mã lỗi phổ biến
- EXPIRED_OOB_CODE: Mã hành động đã hết hạn.
- INVALID_OOB_CODE: Mã hành động 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 hóa.
- EMAIL_NOT_FOUND: Không có hồ sơ người dùng nào tương ứng với mã định danh này. Người dùng có thể đã bị xóa.
Xóa tài khoản
Bạn có thể xóa người dùng hiện tại bằng cách đưa ra yêu cầu HTTP POST
tới điểm cuối Auth deleteAccount
.
Phương pháp: ĐĂNG
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:delete?key=[API_KEY]Tải trọng nội dung yêu cầu
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
idToken | sợi dây | Mã thông báo ID Firebase của người dùng cần xóa. |
Tên tài sản | Kiểu | Sự miêu tả |
---|
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ã trạng thái HTTP 200 OK
.
Mã lỗi phổ biến
- INVALID_ID_TOKEN:Thông tin xác thực 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 tương ứng với mã định danh này. Người dùng có thể đã bị xóa.
Trình mô phỏng xác thực Firebase
Bộ mô phỏng cục bộ Firebase bao gồm một trình mô phỏng xác thực , có thể được sử dụng để tạo nguyên mẫu cục bộ và thử nghiệm các luồng xác thực. Trình mô phỏng hiển thị các điểm cuối REST sau.
Xóa tài khoản người dùng
Xóa tất cả các tài khoản trong dự án được chỉ định, bất kể trạng thái.
Phương pháp: XÓA
Điểm cuối Lưu ý rằng 9099
là cổng mặc định cho trình mô phỏng Xác thực. Kiểm tra đầu ra của thiết bị đầu cuối để biết 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 được chỉ định.
Phương pháp: NHẬN
Điểm cuối Lưu ý rằng 9099
là cổng mặc định cho trình mô phỏng Xác thực. Kiểm tra đầu ra của thiết bị đầu cuối để biết cổng thực tế đang được sử dụng.
http://localhost:9099/emulator/v1/projects/{project-id}/configTải trọng phản hồi
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
đăng nhập | sự vật | Đối tượng cấu hình signIn chứa một khóa duy nhất, allowDuplicateEmails (boolean). |
Cấu hình trình giả lập bản vá
Cập nhật cấu hình dành riêng cho trình mô phỏng cho dự án đã chỉ định.
phương pháp: VÁ
Điểm cuối Lưu ý rằng 9099
là cổng mặc định cho trình mô phỏng Xác thực. Kiểm tra đầu ra của thiết bị đầu cuối để biết 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}/configTải trọng nội dung yêu cầu
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
đăng nhập | sự vật | Đối tượng cấu hình đăng nhập mong muốn bằng một khóa duy nhất, allowDuplicateEmails (boolean). |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
đăng nhập | sự vật | Đối tượng cấu hình Signin sau yêu cầu với khóa đơn, allowDuplicateEmails (boolean). |
Lấy mã xác thực ngoài băng tần
Nếu các luồng xác thực bạn đang kiểm tra thường sẽ 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 giả lập sẽ lưu trữ các mã đó trong nội bộ cho đến khi chúng được sử dụng.
Phương pháp: Nhận
Điểm cuối Lưu ý rằng 9099
là cổng mặc định cho trình giả lập xác thực. Kiểm tra đầu ra đầu ra cho cổng thực tế đang được sử dụng.
http://localhost:9099/emulator/v1/projects/{project-id}/oobCodes
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
OOBCODES | mảng | Một mảng các đối tượng chứa chi tiết của tất cả các mã xác nhận đang chờ xử lý. Mỗi đối tượng chứa email (chuỗi), oobCode (chuỗi), oobLink (chuỗi) và requestType (chuỗi) |
Lấy mã xác minh SMS
Nếu bạn đang kiểm tra các luồng xác thực điện thoại/SMS, trình giả lập sẽ lưu trữ các mã SMS như vậy trong nội bộ cho đến khi chúng được sử dụng.
Phương pháp: Nhận
Điểm cuối Lưu ý rằng 9099
là cổng mặc định cho trình giả lập xác thực. Kiểm tra đầu ra đầu ra cho cổng thực tế đang được sử dụng.
http://localhost:9099/emulator/v1/projects/{project-id}/verificationCodes
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
Xác minh | mảng | Một mảng các đối tượng chứa chi tiết của tất cả các mã xác minh đang chờ xử lý. Mỗi đối tượng chứa phoneNumber (chuỗi) và sessionCode (chuỗi). |
Phản hồi lỗi
Định dạng phản hồi lỗi
Bất cứ khi nào một lỗi được trả về từ máy chủ phụ trợ cho bất kỳ API nào ở trên, phản hồi sẽ có định dạng sau.
Phản ứng 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ả các mã lỗi trên đề cập đến nội dung trường tin nhắn.
Sử dụng API
Bạn có thể truy vấn phụ trợ Firebase Auth thông qua API REST. Điều này có thể được sử dụng cho các hoạt động khác nhau như tạo người dùng mới, đăng nhập vào các hoạt động hiện có và chỉnh sửa hoặc xóa những người dùng này.
Trong suốt tài liệu này, API_KEY
đề cập đến khóa API Web, có thể thu được trên trang Cài đặt dự án trong bảng điều khiển quản trị viên của bạn.
Trao đổi mã thông báo tùy chỉnh cho ID và làm mới mã thông báo
Bạn có thể trao đổi mã thông báo auth tùy chỉnh cho ID và làm mới mã thông báo bằng cách cấp yêu cầu POST
HTTP cho điểm cuối Auth verifyCustomToken
.
Phương pháp: Bài
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:signInWithCustomToken?key=[API_KEY]Yêu cầu tải trọng cơ thể
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
mã thông báo | sợi dây | Một mã thông báo tùy chỉnh Firebase Auth để tạo ID và làm mới cặp mã thông báo. |
returnSecuretoken | boolean | Có hay không trả lại ID và làm mới mã thông báo. Nên luôn luôn là sự thật. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
Idtoken | sợi dây | Mã thông báo ID Firebase Auth được tạo từ mã thông báo tùy chỉnh được cung cấp. |
Làm mới | sợi dây | Một mã thông báo làm mới firebase auth được tạo từ mã thông báo tùy chỉnh được cung cấp. |
hết hạn | sợi dây | Số giây trong đó mã thông báo ID hết hạn. |
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}'
Một yêu cầu thành công được biểu thị bằng mã trạng thái HTTP 200 OK
. Phản hồi chứa mã thông báo ID Firebase và làm mới mã thông báo liên quan đến mã thông báo tùy chỉnh.
Phản ứng mẫu
{ "idToken": "[ID_TOKEN]", "refreshToken": "[REFRESH_TOKEN]", "expiresIn": "3600" }
Mã lỗi phổ biến
- Không hợp lệ_custom_token: Định dạng mã thông báo tùy chỉnh không chính xác hoặc mã thông báo không hợp lệ vì một số lý do (ví dụ: đã hết hạn, chữ ký không hợp lệ, v.v.)
- Custident_mismatch: Mã thông báo tùy chỉnh tương ứng với một dự án Firebase khác.
Trao đổi mã thông báo làm mới cho mã thông báo ID
Bạn có thể làm mới mã thông báo ID Firebase bằng cách cấp yêu cầu POST
HTTP cho securetoken.googleapis.com
điểm cuối.
Phương pháp: Bài
Loại nội dung: application/x-www-form-urlencoded
Điểm cuốihttps://securetoken.googleapis.com/v1/token?key=[API_KEY]Yêu cầu tải trọng cơ thể
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
Grant_Type | sợi dây | Loại tài trợ của mã thông báo làm mới, luôn luôn "refresh_token". |
Làm mới_token | sợi dây | Một mã thông báo làm mới firebase auth. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
hết hạn_in | sợi dây | Số giây trong đó mã thông báo ID hết hạn. |
token_type | sợi dây | Loại mã thông báo làm mới, luôn luôn là "người mang". |
Làm mới_token | sợi dây | Mã thông báo làm mới Auth Firebase được cung cấp trong yêu cầu hoặc mã thông báo làm mới mới. |
id_token | sợi dây | Một mã thông báo id firebase Auth. |
tên người dùng | sợi dây | UID tương ứng với mã thông báo ID được cung cấp. |
Project_id | sợi dây | ID dự án Firebase của bạn. |
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]'
Một yêu cầu thành công được biểu thị bằng mã trạng thái HTTP 200 OK
. Phản hồi chứa mã thông báo ID Firebase mới và mã thông báo làm mới.
Phản ứng mẫu
{ "expires_in": "3600", "token_type": "Bearer", "refresh_token": "[REFRESH_TOKEN]", "id_token": "[ID_TOKEN]", "user_id": "tRcfmLH7o2XrNELi...", "project_id": "1234567890" }
Mã lỗi phổ biến
- Token_expired: Thông tin xác thực 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_disables: Tài khoản người dùng đã bị quản trị viên vô hiệu hóa.
- User_not_found: Người dùng tương ứng với mã thông báo làm mới không được tìm thấy. Có khả năng người dùng đã bị xóa.
- Khóa API không hợp lệ. Vui lòng chuyển khóa API hợp lệ. (Khóa API không hợp lệ được cung cấp)
- Không hợp lệ_refresh_token: Một mã thông báo làm mới không hợp lệ được cung cấp.
- Tải trọng JSON không hợp lệ nhận được. Tên không xác định \ "Refresh_Tokens \": Không thể liên kết tham số truy vấn. Trường 'refresh_tokens' không thể tìm thấy trong thông báo yêu cầu.
- Không hợp lệ_grant_type: Loại tài trợ được chỉ định là không hợp lệ.
- Thiếu_refresh_token: không có mã thông báo làm mới được cung cấp.
- Project_Number_mismatch: Số dự án của mã thông báo làm mới không khớp với khóa API được cung cấp.
Đăng ký bằng email / mật khẩu
Bạn có thể tạo một người dùng email và mật khẩu mới bằng cách cấp yêu cầu POST
HTTP cho điểm cuối của Auth signupNewUser
.
Phương pháp: Bài
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]Yêu cầu tải trọng cơ thể
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
sợi dây | Email cho người dùng để tạo. | |
mật khẩu | sợi dây | Mật khẩu cho người dùng để tạo. |
returnSecuretoken | boolean | Có hay không trả lại ID và làm mới mã thông báo. Nên luôn luôn là sự thật. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
Idtoken | sợi dây | Mã thông báo id firebase Auth cho người dùng mới được tạo. |
sợi dây | Email cho người dùng mới được tạo. | |
Làm mới | sợi dây | Một mã thông báo làm mới firebase auth cho người dùng mới được tạo. |
hết hạn | sợi dây | Số giây trong đó mã thông báo ID hết hạn. |
ID địa phương | sợi dây | UID của người dùng mới được tạo. |
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}'
Một yêu cầu thành công được biểu thị bằng mã trạng thái HTTP 200 OK
. Phản hồi chứa mã thông báo ID Firebase và làm mới mã thông báo liên quan đến tài khoản mới.
Phản ứng mẫu
{ "idToken": "[ID_TOKEN]", "email": "[user@example.com]", "refreshToken": "[REFRESH_TOKEN]", "expiresIn": "3600", "localId": "tRcfmLH7..." }
Mã lỗi phổ biến
- Email_Exists: Địa chỉ email đã được sử dụng bởi một tài khoản khác.
- Hoạt động_not_allowed: Đăng nhập mật khẩu bị vô hiệu hóa cho dự án này.
- TOUS_MANY_ATTEMPS_TRY_LATER: Chúng tôi đã chặn tất cả các yêu cầu từ thiết bị này do hoạt động bất thường. 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 bằng cách cấp yêu cầu POST
HTTP cho điểm cuối auth verifyPassword
.
Phương pháp: Bài
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key=[API_KEY]Yêu cầu tải trọng cơ thể
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
sợi dây | Email mà người dùng đang đăng nhập. | |
mật khẩu | sợi dây | Mật khẩu cho tài khoản. |
returnSecuretoken | boolean | Có hay không trả lại ID và làm mới mã thông báo. Nên luôn luôn là sự thật. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
Idtoken | sợi dây | Mã thông báo id firebase Auth cho người dùng được xác thực. |
sợi dây | Email cho người dùng được xác thực. | |
Làm mới | sợi dây | Một mã thông báo làm mới Auth Firebase cho người dùng được xác thực. |
hết hạn | sợi dây | Số giây trong đó mã thông báo ID hết hạn. |
ID địa phương | sợi dây | UID của người dùng được xác thực. |
đăng ký | boolean | Cho dù email là cho một tài khoản hiện có. |
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}'
Một yêu cầu thành công được biểu thị bằng mã trạng thái HTTP 200 OK
. Phản hồi chứa mã thông báo ID Firebase và làm mới mã thông báo được liên kết với tài khoản email/mật khẩu hiện có.
Phản ứng mẫu
{ "localId": "ZY1rJK0eYLg...", "email": "[user@example.com]", "displayName": "", "idToken": "[ID_TOKEN]", "registered": true, "refreshToken": "[REFRESH_TOKEN]", "expiresIn": "3600" }
Mã lỗi phổ biến
- Email_Not_Found: Không có bản ghi người dùng tương ứng với định danh này. Người dùng có thể đã bị xóa.
- Không hợp lệ_password: Mật khẩu không hợp lệ hoặc người dùng không có mật khẩu.
- User_disables: Tài khoản người dùng đã bị quản trị viên vô hiệu hóa.
Đăng nhập ẩn danh
Bạn có thể đăng nhập một người dùng một cách ẩn danh bằng cách cấp một yêu cầu POST
HTTP cho điểm cuối của Auth signupNewUser
.
Phương pháp: Bài
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]Yêu cầu tải trọng cơ thể
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
returnSecuretoken | boolean | Có hay không trả lại ID và làm mới mã thông báo. Nên luôn luôn là sự thật. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
Idtoken | sợi dây | Mã thông báo id firebase Auth cho người dùng mới được tạo. |
sợi dây | Vì người dùng ẩn danh, điều này phải trống. | |
Làm mới | sợi dây | Một mã thông báo làm mới firebase auth cho người dùng mới được tạo. |
hết hạn | sợi dây | Số giây trong đó mã thông báo ID hết hạn. |
ID địa phương | sợi dây | UID của người dùng mới được tạo. |
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}'
Một yêu cầu thành công được biểu thị bằng mã trạng thái HTTP 200 OK
. Phản hồi chứa mã thông báo ID Firebase và mã thông báo làm mới được liên kết với người dùng ẩn danh.
Phản ứng mẫu
{ "idToken": "[ID_TOKEN]", "email": "", "refreshToken": "[REFRESH_TOKEN]", "expiresIn": "3600", "localId": "Jws4SVjpT..." }
Mã lỗi phổ biến
- Hoạt động_not_allowed: Đăng nhập người dùng ẩn danh bị vô hiệu hóa cho dự án này.
Đăng nhập bằng chứng chỉ OAuth
Bạn có thể đăng nhập vào người dùng có chứng chỉ OAuth bằng cách cấp yêu cầu POST
HTTP cho điểm cuối verifyAssertion
.
Phương pháp: Bài
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]Yêu cầu tải trọng cơ thể
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
requesturi | sợi dây | URI mà IDP chuyển hướng người dùng trở lại. |
Postbody | sợi dây | Chứa thông tin xác thực OAuth (mã thông báo ID hoặc mã thông báo truy cập) và ID nhà cung cấp có thông tin xác thực. |
returnSecuretoken | boolean | Có hay không trả lại ID và làm mới mã thông báo. Nên luôn luôn là sự thật. |
returnidpcredential | boolean | Có buộc phải trả lại thông tin về OAuth về các lỗi sau: Federated_user_id_already_linked và email_exists. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
FederatedId | sợi dây | ID duy nhất xác định tài khoản IDP. |
cung cấp | sợi dây | ID nhà cung cấp được liên kết (ví dụ: "Google.com" cho nhà cung cấp Google). |
ID địa phương | sợi dây | UID của người dùng được xác thực. |
email đã kích hoạt | boolean | Cho dù email đăng nhập đã được xác minh. |
sợi dây | Email của tài khoản. | |
oauthidtoken | sợi dây | Mã thông báo ID OIDC nếu có. |
OAuthaccessToken | sợi dây | Mã thông báo truy cập OAuth nếu có. |
oauthtokenSecret | sợi dây | Bí mật mã thông báo OAuth 1.0 nếu có. |
Rawuserinfo | sợi dây | Phản hồi JSON được xâu chuỗi chứa tất cả dữ liệu IDP tương ứng với thông tin xác thực OAuth được cung cấp. |
tên đầu tiên | sợi dây | Tên đầu tiên cho tài khoản. |
họ | sợi dây | Tên cuối cùng cho tài khoản. |
Họ và tên | sợi dây | Tên đầy đủ cho tài khoản. |
tên hiển thị | sợi dây | Tên hiển thị cho tài khoản. |
Photourl | sợi dây | URL ảnh cho tài khoản. |
Idtoken | sợi dây | Mã thông báo id firebase Auth cho người dùng được xác thực. |
Làm mới | sợi dây | Một mã thông báo làm mới Auth Firebase cho người dùng được xác thực. |
hết hạn | sợi dây | Số giây trong đó mã thông báo ID hết hạn. |
NeedConf xác nhận | boolean | Cho dù một tài khoản khác có cùng thông tin đăng nhập đã tồn tại. Người dùng sẽ cần phải đăng nhập vào tài khoản gốc và sau đó liên kết thông tin xác thực hiện tại với nó. |
Yêu cầu mẫu với mã thông báo 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}'
Một yêu cầu thành công được biểu thị bằng mã trạng thái HTTP 200 OK
. Phản hồi chứa mã thông báo ID Firebase và mã thông báo làm mới được liên kết với người dùng được xác thực.
Phản hồi mẫu với mã thông báo 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\", ...}" }
Yêu cầu mẫu với mã thông báo 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}'
Một yêu cầu thành công được biểu thị bằng mã trạng thái HTTP 200 OK
. Phản hồi chứa mã thông báo ID Firebase và mã thông báo làm mới được liên kết với người dùng được xác thực.
Phản hồi mẫu với mã thông báo 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 với thông tin đăng nhập 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}'
Một yêu cầu thành công được biểu thị bằng mã trạng thái HTTP 200 OK
. Phản hồi chứa mã thông báo ID Firebase và mã thông báo làm mới được liên kết với người dùng được xác thực.
Phản hồi mẫu với chứng chỉ 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\", ...}" }
Mã lỗi phổ biến
- Hoạt động_not_allowed: Nhà cung cấp tương ứng bị vô hiệu hóa cho dự án này.
- Không hợp lệ_idp_response: Thông tin xác thực được cung cấp bị dị tật hoặc đã hết hạn.
Tìm nạp các nhà cung cấp cho email
Bạn có thể xem tất cả các nhà cung cấp được liên kết với một email được chỉ định bằng cách phát hành yêu cầu POST
HTTP cho điểm cuối createAuthUri
Auth CreateAuthuri.
Phương pháp: Bài
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:createAuthUri?key=[API_KEY]Yêu cầu tải trọng cơ thể
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
định danh | sợi dây | Địa chỉ email của người dùng |
Tiếp tục | sợi dây | URI mà IDP chuyển hướng người dùng trở lại. Đối với trường hợp sử dụng này, đây chỉ là URL hiện tại. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
AllProviders | Danh sách các chuỗi | Danh sách các nhà cung cấp mà người dùng đã đăng nhập trước đây. |
đăng ký | boolean | Liệu email có dành cho một tài khoản hiện có |
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]"}'
Một yêu cầu thành công được biểu thị bằng mã trạng thái HTTP 200 OK
. Phản hồi chứa danh sách các nhà cung cấp liên quan đến email.
Phản ứng mẫu
{ "allProviders": [ "password", "google.com" ], "registered": true }
Mã lỗi phổ biến
- Không hợp lệ_email: Địa chỉ email được định dạng xấu.
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 cấp yêu cầu POST
HTTP đến điểm cuối của getOobConfirmationCode
.
Phương pháp: Bài
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]Các tiêu đề tùy chọn
Tên tài sản | Sự miêu tả |
---|---|
X-Firebase-Locale | Mã ngôn ngữ tương ứng với ngôn ngữ của người dùng. Vượt qua điều này sẽ bản địa hóa email đặt lại mật khẩu được gửi cho người dùng. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
loại yêu cầu | sợi dây | Loại mã OOB để trả lại. Nên là "password_reset" để đặt lại mật khẩu. |
sợi dây | Địa chỉ email của người dùng. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
sợi dây | Địa chỉ email của người dùng. |
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]"}'
Một yêu cầu thành công được biểu thị bằng mã trạng thái HTTP 200 OK
.
Phản ứng mẫu
{ "email": "[user@example.com]" }
Mã lỗi phổ biến
- Email_Not_Found: Không có bản ghi người dùng tương ứng với định danh 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 cấp yêu cầu POST
HTTP cho điểm cuối Auth resetPassword
.
Phương pháp: Bài
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]Tải trọng cơ thể
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
OOBCODE | sợi dây | Mã hành động email được gửi đến email của người dùng để đặt lại mật khẩu. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
sợi dây | Địa chỉ email của người dùng. | |
loại yêu cầu | sợi dây | Loại mã hành động email. Phải là "password_reset". |
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]"}'
Một yêu cầu thành công được biểu thị bằng mã trạng thái HTTP 200 OK
.
Phản ứng mẫu
{ "email": "[user@example.com]", "requestType": "PASSWORD_RESET" }
Mã lỗi phổ biến
- Hoạt động_not_allowed: Đăng nhập mật khẩu bị vô hiệu hóa cho dự án này.
- Đã hết hạn_oob_code: Mã hành động đã hết hạn.
- Không hợp lệ_oob_code: Mã hành động không hợp lệ. Điều này có thể xảy ra nếu mã bị dị 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 thiết lập lại mật khẩu bằng cách cấp yêu cầu POST
HTTP cho điểm cuối Auth resetPassword
.
Phương pháp: Bài
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]Yêu cầu tải trọng cơ thể
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
OOBCODE | sợi dây | Mã hành động email được gửi đến email của người dùng để đặt lại mật khẩu. |
mật khẩu mới | sợi dây | Mật khẩu mới của người dùng. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
sợi dây | Địa chỉ email của người dùng. | |
loại yêu cầu | sợi dây | Loại mã hành động email. Phải là "password_reset". |
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]"}'
Một yêu cầu thành công được biểu thị bằng mã trạng thái HTTP 200 OK
.
Phản ứng mẫu
{ "email": "[user@example.com]", "requestType": "PASSWORD_RESET" }
Mã lỗi phổ biến
- Hoạt động_not_allowed: Đăng nhập mật khẩu bị vô hiệu hóa cho dự án này.
- Đã hết hạn_oob_code: Mã hành động đã hết hạn.
- Không hợp lệ_oob_code: Mã hành động không hợp lệ. Điều này có thể xảy ra nếu mã bị dị dạng, hết hạn hoặc đã được sử dụng.
- User_disables: Tài khoản người dùng đã bị quản trị viên vô hiệu hóa.
Thay đổi e-mail
Bạn có thể thay đổi email của người dùng bằng cách cấp yêu cầu POST
HTTP cho điểm cuối Auth setAccountInfo
.
Phương pháp: Bài
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]tiêu đề tùy chọn
Tên tài sản | Sự miêu tả |
---|---|
X-Firebase-Locale | Mã ngôn ngữ tương ứng với ngôn ngữ của người dùng. Vượt qua điều này sẽ bản địa hóa việc thu hồi thay đổi email được gửi cho người dùng. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
Idtoken | sợi dây | Một mã thông báo id firebase Auth cho người dùng. |
sợi dây | Email mới của người dùng. | |
returnSecuretoken | boolean | Có hay không trả lại ID và làm mới mã thông báo. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
ID địa phương | sợi dây | UID của người dùng hiện tại. |
sợi dây | Địa chỉ email của người dùng. | |
Mật khẩu | sợi dây | Phiên bản băm của mật khẩu. |
ProvideruserInfo | Danh sách các đối tượng JSON | Danh sách tất cả các đối tượng nhà cung cấp được liên kết có chứa "Providerid" và "FederatedID". |
Idtoken | sợi dây | Mã thông báo id id firebase mới cho người dùng. |
Làm mới | sợi dây | Một mã thông báo làm mới firebase auth. |
hết hạn | sợi dây | Số giây trong đó mã thông báo ID hết hạn. |
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}'
Một yêu cầu thành công được biểu thị bằng mã trạng thái HTTP 200 OK
. Phản hồi chứa mã thông báo ID FireBase mới và mã thông báo làm mới được liên kết với người dùng.
Phản ứng 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" }
Mã lỗi phổ biến
- Email_Exists: Địa chỉ email đã được sử dụng bởi một tài khoản khác.
- Không hợp lệ_id_token: Thông tin xác thực 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 cấp yêu cầu POST
HTTP cho điểm cuối auth setAccountInfo
.
Phương pháp: Bài
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]Yêu cầu tải trọng cơ thể
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
Idtoken | sợi dây | Một mã thông báo id firebase Auth cho người dùng. |
mật khẩu | sợi dây | Mật khẩu mới của người dùng. |
returnSecuretoken | boolean | Có hay không trả lại ID và làm mới mã thông báo. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
ID địa phương | sợi dây | UID của người dùng hiện tại. |
sợi dây | Địa chỉ email của người dùng. | |
Mật khẩu | sợi dây | Phiên bản băm của mật khẩu. |
ProvideruserInfo | Danh sách các đối tượng JSON | Danh sách tất cả các đối tượng nhà cung cấp được liên kết có chứa "Providerid" và "FederatedID". |
Idtoken | sợi dây | Mã thông báo id id firebase mới cho người dùng. |
Làm mới | sợi dây | Một mã thông báo làm mới firebase auth. |
hết hạn | sợi dây | Số giây trong đó mã thông báo ID hết hạn. |
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}'
Một yêu cầu thành công được biểu thị bằng mã trạng thái HTTP 200 OK
. Phản hồi chứa mã thông báo ID FireBase mới và mã thông báo làm mới được liên kết với người dùng.
Phản ứng 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" }
Mã lỗi phổ biến
- Không hợp lệ_id_token: Thông tin xác thực của người dùng không còn hợp lệ. Người dùng phải đăng nhập lại.
- Yếu_password: Mật khẩu phải dài 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 yêu cầu POST
HTTP cho điểm cuối Auth setAccountInfo
.
Phương pháp: Bài
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]Yêu cầu tải trọng cơ thể
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
Idtoken | sợi dây | Một mã thông báo id firebase Auth cho người dùng. |
tên hiển thị | sợi dây | Tên hiển thị mới của người dùng. |
Photourl | sợi dây | URL ảnh mới của người dùng. |
Xóa | Danh sách các chuỗi | Danh sách các thuộc tính để xóa, "display_name" hoặc "photo_url". Điều này sẽ vô hiệu hóa các giá trị này. |
returnSecuretoken | boolean | Có hay không trả lại ID và làm mới mã thông báo. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
ID địa phương | sợi dây | UID của người dùng hiện tại. |
sợi dây | Địa chỉ email của người dùng. | |
tên hiển thị | sợi dây | Tên hiển thị mới của người dùng. |
Photourl | sợi dây | URL ảnh mới của người dùng. |
Mật khẩu | sợi dây | Phiên bản băm của mật khẩu. |
ProvideruserInfo | Danh sách các đối tượng JSON | Danh sách tất cả các đối tượng nhà cung cấp được liên kết có chứa "Providerid" và "FederatedID". |
Idtoken | sợi dây | Mã thông báo id id firebase mới cho người dùng. |
Làm mới | sợi dây | Một mã thông báo làm mới firebase auth. |
hết hạn | sợi dây | Số giây trong đó mã thông báo ID hết hạn. |
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}'
Một yêu cầu thành công được biểu thị bằng mã trạng thái HTTP 200 OK
.
Phản ứng 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" }
Mã lỗi phổ biến
- Không hợp lệ_id_token: Thông tin xác thực của người dùng không còn hợp lệ. Người dùng phải đăng nhập lại.
Nhận dữ liệu người dùng
Bạn có thể nhận được dữ liệu của người dùng bằng cách cấp yêu cầu POST
HTTP cho điểm cuối auth getAccountInfo
.
Phương pháp: Bài
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:lookup?key=[API_KEY]Yêu cầu tải trọng cơ thể
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
Idtoken | sợi dây | Mã thông báo ID Firebase của tài khoản. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
người dùng | Danh sách các đối tượng JSON | Tài khoản được liên kết với mã thông báo ID Firebase đã cho. Kiểm tra dưới đây để biết thêm chi tiết. |
users
)Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
ID địa phương | sợi dây | UID của người dùng hiện tại. |
sợi dây | Email của tài khoản. | |
email đã kích hoạt | boolean | Liệu email của tài khoản có được xác minh hay không. |
tên hiển thị | sợi dây | Tên hiển thị cho tài khoản. |
ProvideruserInfo | Danh sách các đối tượng JSON | Danh sách tất cả các đối tượng nhà cung cấp được liên kết có chứa "Providerid" và "FederatedID". |
Photourl | sợi dây | URL ảnh cho tài khoản. |
Mật khẩu | sợi dây | Phiên bản băm của mật khẩu. |
Mật khẩuUpdatedat | gấp đôi | Dấu thời gian, tính bằng mili giây, mật khẩu tài khoản đã được thay đổi lần cuối. |
Xác định | sợi dây | Dấu thời gian, trong vài giây, đánh dấu một ranh giới, trước đó mã thông báo ID Firebase được coi là bị thu hồi. |
tàn tật | boolean | Cho dù tài khoản có bị vô hiệu hóa hay không. |
LastLoginat | sợi dây | Dấu thời gian, tính bằng mili giây, tài khoản đã đăng nhập lần cuối tại. |
tạo ra | sợi dây | Dấu thời gian, tính bằng mili giây, tài khoản được tạo tại. |
CustomAuth | boolean | Cho dù tài khoản được xác thực bởi nhà phát triển. |
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]"}'
Một yêu cầu thành công được biểu thị bằng mã trạng thái HTTP 200 OK
. Phản hồi sẽ chứa tất cả các thông tin người dùng được liên kết với tài khoản.
Phản ứng 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 } ] }
Mã lỗi phổ biến
- Không hợp lệ_id_token: Thông tin xác thực 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ó bản ghi người dùng tương ứng với định danh 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 một email/mật khẩu với người dùng hiện tại bằng cách cấp yêu cầu POST
HTTP cho điểm cuối Auth setAccountInfo
.
Phương pháp: Bài
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]Yêu cầu tải trọng cơ thể
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
Idtoken | sợi dây | Mã thông báo ID Firebase của tài khoản bạn đang cố gắng liên kết thông tin đăng nhập. |
sợi dây | Email để liên kết đến tài khoản. | |
mật khẩu | sợi dây | Mật khẩu mới của tài khoản. |
returnSecuretoken | sợi dây | Có hay không trả lại ID và làm mới mã thông báo. Nên luôn luôn là sự thật. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
ID địa phương | sợi dây | UID của người dùng hiện tại. |
sợi dây | Email của tài khoản. | |
tên hiển thị | sợi dây | Tên hiển thị cho tài khoản. |
Photourl | sợi dây | URL ảnh cho tài khoản. |
Mật khẩu | sợi dây | Phiên bản băm của mật khẩu. |
ProvideruserInfo | Danh sách các đối tượng JSON | Danh sách tất cả các đối tượng nhà cung cấp được liên kết có chứa "Providerid" và "FederatedID". |
email đã kích hoạt | boolean | Liệu email của tài khoản có được xác minh hay không. |
Idtoken | sợi dây | Mã thông báo id id firebase mới cho người dùng. |
Làm mới | sợi dây | Một mã thông báo làm mới firebase auth. |
hết hạn | sợi dây | Số giây trong đó mã thông báo ID hết hạn. |
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}'
Một yêu cầu thành công được biểu thị bằng mã trạng thái HTTP 200 OK
. Phản hồi chứa mã thông báo ID Firebase và mã thông báo làm mới được liên kết với người dùng được xác thực.
Phản ứng 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 }
Mã lỗi phổ biến
- Custident_too_old_login_again: Thông tin xác thực của người dùng không còn hợp lệ. Người dùng phải đăng nhập lại.
- Token_expired: Thông tin xác thực của người dùng không còn hợp lệ. Người dùng phải đăng nhập lại.
- Không hợp lệ_id_token: Thông tin xác thực của người dùng không còn hợp lệ. Người dùng phải đăng nhập lại.
- Yếu_password: Mật khẩu phải dài 6 ký tự trở lên.
Liên kết với chứng chỉ OAuth
Bạn có thể liên kết thông tin xác thực OAuth với người dùng bằng cách cấp yêu cầu POST
HTTP cho điểm cuối verifyAssertion
.
Phương pháp: Bài
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]Yêu cầu tải trọng cơ thể
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
Idtoken | sợi dây | Mã thông báo ID Firebase của tài khoản bạn đang cố gắng liên kết thông tin đăng nhập. |
requesturi | sợi dây | URI mà IDP chuyển hướng người dùng trở lại. |
Postbody | sợi dây | Chứa thông tin xác thực OAuth (mã thông báo ID hoặc mã thông báo truy cập) và ID nhà cung cấp có thông tin xác thực. |
returnSecuretoken | boolean | Có hay không trả lại ID và làm mới mã thông báo. Nên luôn luôn là sự thật. |
returnidpcredential | boolean | Có buộc phải trả lại thông tin về OAuth về các lỗi sau: Federated_user_id_already_linked và email_exists. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
FederatedId | sợi dây | ID duy nhất xác định tài khoản IDP. |
cung cấp | sợi dây | ID nhà cung cấp được liên kết (ví dụ: "Google.com" cho nhà cung cấp Google). |
ID địa phương | sợi dây | UID của người dùng được xác thực. |
email đã kích hoạt | boolean | Cho dù email Sigin đã được xác minh. |
sợi dây | Email của tài khoản. | |
oauthidtoken | sợi dây | Mã thông báo ID OIDC nếu có. |
OAuthaccessToken | sợi dây | Mã thông báo truy cập OAuth nếu có. |
oauthtokenSecret | sợi dây | Bí mật mã thông báo OAuth 1.0 nếu có. |
Rawuserinfo | sợi dây | Phản hồi JSON được xâu chuỗi chứa tất cả dữ liệu IDP tương ứng với thông tin xác thực OAuth được cung cấp. |
tên đầu tiên | sợi dây | Tên đầu tiên cho tài khoản. |
họ | sợi dây | Tên cuối cùng cho tài khoản. |
Họ và tên | sợi dây | Tên đầy đủ cho tài khoản. |
tên hiển thị | sợi dây | Tên hiển thị cho tài khoản. |
Photourl | sợi dây | URL ảnh cho tài khoản. |
Idtoken | sợi dây | Mã thông báo id firebase Auth cho người dùng được xác thực. |
Làm mới | sợi dây | Một mã thông báo làm mới Auth Firebase cho người dùng được xác thực. |
hết hạn | sợi dây | Số giây trong đó mã thông báo ID hết hạn. |
Yêu cầu mẫu với mã thông báo 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}'
Một yêu cầu thành công được biểu thị bằng mã trạng thái HTTP 200 OK
. Phản hồi chứa mã thông báo ID Firebase và mã thông báo làm mới được liên kết với người dùng được xác thực.
Phản hồi mẫu với mã thông báo 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\", ...}" }
Yêu cầu mẫu với mã thông báo 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}'
Một yêu cầu thành công được biểu thị bằng mã trạng thái HTTP 200 OK
. Phản hồi chứa mã thông báo ID Firebase và mã thông báo làm mới được liên kết với người dùng được xác thực.
Phản hồi mẫu với mã thông báo 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 với thông tin đăng nhập 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}'
Một yêu cầu thành công được biểu thị bằng mã trạng thái HTTP 200 OK
. Phản hồi chứa mã thông báo ID Firebase và mã thông báo làm mới được liên kết với người dùng được xác thực.
Phản hồi mẫu với chứng chỉ 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\", ...}" }
Mã lỗi phổ biến
- Hoạt động_not_allowed: Nhà cung cấp tương ứng bị vô hiệu hóa cho dự án này.
- Không hợp lệ_idp_response: Thông tin xác thực được cung cấp bị dị tật hoặc đã hết hạn.
- Không hợp lệ_id_token: Thông tin xác thực 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 sử dụng bởi một tài khoản khác.
- Federated_user_id_already_linked: Thông tin đăng nhập này đã được liên kết với một tài khoản người dùng khác.
Nhà cung cấp hủy liên kết
Bạn có thể hủy liên kết một nhà cung cấp khỏi người dùng hiện tại bằng cách cấp yêu cầu POST
HTTP cho điểm cuối auth setAccountInfo
.
Phương pháp: Bài
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]Yêu cầu tải trọng cơ thể
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
Idtoken | sợi dây | Mã thông báo ID Firebase của tài khoản. |
Deleteprovider | Danh sách các chuỗi | Danh sách ID nhà cung cấp để hủy liên kết, ví dụ: 'Google.com', 'Mật khẩu', v.v. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
ID địa phương | sợi dây | UID của người dùng hiện tại. |
sợi dây | Email của tài khoản. | |
tên hiển thị | sợi dây | Tên hiển thị cho tài khoản. |
Photourl | sợi dây | URL ảnh cho tài khoản. |
Mật khẩu | sợi dây | Phiên bản băm của mật khẩu. |
ProvideruserInfo | Danh sách các đối tượng JSON | Danh sách tất cả các đối tượng nhà cung cấp được liên kết có chứa "Providerid" và "FederatedID". |
email đã kích hoạt | boolean | Liệu email của tài khoản có được xác minh hay không. |
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]"]}'
Một yêu cầu thành công được biểu thị bằng mã trạng thái HTTP 200 OK
.
Phản ứng 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" }
Mã lỗi phổ biến
- Không hợp lệ_id_token: Thông tin xác thực 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 xác minh email
Bạn có thể gửi xác minh email cho người dùng hiện tại bằng cách cấp yêu cầu POST
HTTP cho điểm cuối của auth getOobConfirmationCode
.
Phương pháp: Bài
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]tiêu đề tùy chọn
Tên tài sản | Sự miêu tả |
---|---|
X-Firebase-Locale | Mã ngôn ngữ tương ứng với ngôn ngữ của người dùng. Vượt qua điều này sẽ bản địa hóa xác minh email được gửi cho người dùng. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
loại yêu cầu | sợi dây | Loại mã xác nhận để gửi. Phải luôn luôn là "verify_email". |
Idtoken | sợi dây | Mã thông báo ID Firebase của người dùng để xác minh. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
sợi dây | Email của tài khoản. |
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]"}'
Một yêu cầu thành công được biểu thị bằng mã trạng thái HTTP 200 OK
.
Phản ứng mẫu
{ "email": "user@example.com" }
Mã lỗi phổ biến
- Không hợp lệ_id_token: Thông tin xác thực 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ó bản ghi người dùng tương ứng với định danh 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 cấp yêu cầu POST
HTTP cho điểm cuối Auth setAccountInfo
.
Phương pháp: Bài
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]Yêu cầu tải trọng cơ thể
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
OOBCODE | sợi dây | Mã hành động được gửi đến email của người dùng để xác minh email. |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
sợi dây | Email của tài khoản. | |
tên hiển thị | sợi dây | Tên hiển thị cho tài khoản. |
Photourl | sợi dây | URL ảnh cho tài khoản. |
Mật khẩu | sợi dây | Mật khẩu băm. |
ProvideruserInfo | Danh sách các đối tượng JSON | Danh sách tất cả các đối tượng nhà cung cấp được liên kết có chứa "Providerid" và "FederatedID". |
email đã kích hoạt | boolean | Liệu email của tài khoản có được xác minh hay không. |
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]"}'
Một yêu cầu thành công được biểu thị bằng mã trạng thái HTTP 200 OK
.
Phản ứng mẫu
{ "localId": "FhyStE...", "email": "user@example.com", "passwordHash": "...", "providerUserInfo": [ { "providerId": "password", "federatedId": "user@example.com" } ] }
Mã lỗi phổ biến
- Đã hết hạn_oob_code: Mã hành động đã hết hạn.
- Không hợp lệ_oob_code: Mã hành động không hợp lệ. Điều này có thể xảy ra nếu mã bị dị dạng, hết hạn hoặc đã được sử dụng.
- User_disables: Tài khoản người dùng đã bị quản trị viên vô hiệu hóa.
- Email_Not_Found: Không có bản ghi người dùng tương ứng với định danh này. Người dùng có thể đã bị xóa.
Xóa tài khoản
Bạn có thể xóa một người dùng hiện tại bằng cách phát hành yêu cầu POST
HTTP cho điểm cuối Auth deleteAccount
.
Phương pháp: Bài
Loại nội dung: ứng dụng/json
Điểm cuốihttps://identitytoolkit.googleapis.com/v1/accounts:delete?key=[API_KEY]Yêu cầu tải trọng cơ thể
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
Idtoken | sợi dây | Mã thông báo ID Firebase của người dùng để xóa. |
Tên tài sản | Kiểu | Sự miêu tả |
---|
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]"}'
A successful request is indicated by a 200 OK
HTTP status code.
Common error codes
- INVALID_ID_TOKEN:The user's credential is no longer valid. The user must sign in again.
- USER_NOT_FOUND: There is no user record corresponding to this identifier. The user may have been deleted.
Firebase Authentication Emulator
The Firebase Local Emulator Suite includes an Authentication emulator , which can be used for local prototyping and testing of authentication flows. The emulator exposes the following REST endpoints.
Clear user accounts
Remove all accounts in the specified project, regardless of state.
Method: DELETE
Điểm cuối Note that 9099
is the default port for the Authentication emulator. Check terminal output for the actual port being used.
http://localhost:9099/emulator/v1/projects/{project-id}/accounts
Get emulator configuration
Get emulator-specific configuration for the specified project.
Method: GET
Điểm cuối Note that 9099
is the default port for the Authentication emulator. Check terminal output for the actual port being used.
http://localhost:9099/emulator/v1/projects/{project-id}/configResponse Payload
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
đăng nhập | sự vật | signIn configuration object containing a single key, allowDuplicateEmails (boolean). |
Patch emulator configuration
Update emulator-specific configuration for the specified project.
Method: PATCH
Điểm cuối Note that 9099
is the default port for the Authentication emulator. Check terminal output for the actual port being used.
Loại nội dung: ứng dụng/json
http://localhost:9099/emulator/v1/projects/{project-id}/configRequest Body Payload
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
đăng nhập | sự vật | Desired signIn configuration object with single key, allowDuplicateEmails (boolean). |
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
đăng nhập | sự vật | Post-request signIn configuration object with single key, allowDuplicateEmails (boolean). |
Retrieve out-of-band authentication codes
If the authentication flows you are testing would normally generate out-of-band codes (eg, email verification codes, password reset codes), the emulator stores such codes internally until they are used.
Method: GET
Điểm cuối Note that 9099
is the default port for the Authentication emulator. Check terminal output for the actual port being used.
http://localhost:9099/emulator/v1/projects/{project-id}/oobCodesResponse Payload
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
oobCodes | mảng | An array of objects containing details of all pending confirmation codes. Each object contains email (string), oobCode (string), oobLink (string), and requestType (string) |
Retrieve SMS verification codes
If you are testing phone/SMS authentication flows, the emulator stores such SMS codes internally until they are used.
Method: GET
Điểm cuối Note that 9099
is the default port for the Authentication emulator. Check terminal output for the actual port being used.
http://localhost:9099/emulator/v1/projects/{project-id}/verificationCodesResponse Payload
Tên tài sản | Kiểu | Sự miêu tả |
---|---|---|
verificationCodes | mảng | An array of objects containing details of all pending verification codes. Each object contains phoneNumber (string) and sessionCode (string). |
Error Response
Error response format
Anytime an error is returned from the backend server for any of the APIs above, the response will have the following format.
Sample response
{ "error": { "errors": [ { "domain": "global", "reason": "invalid", "message": "CREDENTIAL_TOO_OLD_LOGIN_AGAIN" } ], "code": 400, "message": "CREDENTIAL_TOO_OLD_LOGIN_AGAIN" } }
The error code is obtained from the message field. All of the above error codes refer to the message field content.