การใช้งาน API
คุณสามารถค้นหาแบ็กเอนด์ Firebase Auth ผ่าน REST API ซึ่งสามารถใช้สำหรับการดำเนินการต่างๆ เช่น การสร้างผู้ใช้ใหม่ การลงชื่อเข้าใช้งานที่มีอยู่ และการแก้ไขหรือการลบผู้ใช้เหล่านี้
ตลอดทั้งเอกสารนี้ API_KEY
อ้างถึงคีย์ Web API ซึ่งสามารถรับได้ที่หน้า การตั้งค่าโปรเจ็กต์ ในคอนโซลผู้ดูแลระบบของคุณ
แลกเปลี่ยนโทเค็นที่กำหนดเองเป็น ID และโทเค็นการรีเฟรช
คุณสามารถแลกเปลี่ยนโทเค็น Auth แบบกำหนดเองเป็น ID และรีเฟรชโทเค็นได้โดยการออกคำขอ HTTP POST
ไปยังจุดสิ้นสุด Auth verifyCustomToken
วิธีการ: โพสต์
ประเภทเนื้อหา: application/json
จุดสิ้นสุดhttps://identitytoolkit.googleapis.com/v1/accounts:signInWithCustomToken?key=[API_KEY]ขอน้ำหนักบรรทุกเนื้อหา
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
โทเค็น | เชือก | โทเค็นที่กำหนดเองของ Firebase Auth เพื่อใช้สร้างคู่โทเค็น ID และรีเฟรช |
returnSecureToken | บูลีน | ไม่ว่าจะส่งคืน ID และโทเค็นการรีเฟรชหรือไม่ ควรจะเป็นจริงเสมอ |
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
idToken | เชือก | โทเค็น Firebase Auth ID ที่สร้างจากโทเค็นที่กำหนดเองที่ให้มา |
รีเฟรชโทเค็น | เชือก | โทเค็นการรีเฟรช Firebase Auth ที่สร้างจากโทเค็นที่กำหนดเองที่ให้มา |
หมดอายุใน | เชือก | จำนวนวินาทีที่โทเค็น ID หมดอายุ |
คำขอตัวอย่าง
curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithCustomToken?key=[API_KEY]' \ -H 'Content-Type: application/json' \ --data-binary '{"token":"[CUSTOM_TOKEN]","returnSecureToken":true}'
คำขอที่สำเร็จจะแสดงด้วยรหัสสถานะ HTTP 200 OK
การตอบกลับประกอบด้วยโทเค็น Firebase ID และโทเค็นการรีเฟรชที่เชื่อมโยงกับโทเค็นที่กำหนดเอง
ตัวอย่างการตอบกลับ
{ "idToken": "[ID_TOKEN]", "refreshToken": "[REFRESH_TOKEN]", "expiresIn": "3600" }
รหัสข้อผิดพลาดทั่วไป
- INVALID_CUSTOM_TOKEN: รูปแบบโทเค็นที่กำหนดเองไม่ถูกต้องหรือโทเค็นไม่ถูกต้องด้วยเหตุผลบางประการ (เช่น หมดอายุ ลายเซ็นไม่ถูกต้อง ฯลฯ)
- CREDENTIAL_MISMATCH: โทเค็นที่กำหนดเองสอดคล้องกับโปรเจ็กต์ Firebase อื่น
แลกเปลี่ยนโทเค็นการรีเฟรชเป็นโทเค็น ID
คุณสามารถรีเฟรชโทเค็น Firebase ID ได้โดยออกคำขอ HTTP POST
ไปยังตำแหน่ง securetoken.googleapis.com
วิธีการ: โพสต์
ประเภทเนื้อหา: application/x-www-form-urlencoded
จุดสิ้นสุดhttps://securetoken.googleapis.com/v1/token?key=[API_KEY]คำขอน้ำหนักบรรทุก
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
grant_type | เชือก | ประเภทการให้สิทธิ์ของโทเค็นการรีเฟรชจะเป็น "refresh_token" เสมอ |
รีเฟรช_โทเค็น | เชือก | โทเค็นการรีเฟรช Firebase Auth |
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
หมดอายุใน | เชือก | จำนวนวินาทีที่โทเค็น ID หมดอายุ |
token_type | เชือก | ประเภทของโทเค็นการรีเฟรชจะเป็น "ผู้ถือ" เสมอ |
รีเฟรช_โทเค็น | เชือก | โทเค็นการรีเฟรช Firebase Auth ที่ให้ไว้ในคำขอหรือโทเค็นการรีเฟรชใหม่ |
id_token | เชือก | โทเค็น Firebase Auth ID |
ผู้ใช้_id | เชือก | uid ที่สอดคล้องกับโทเค็น ID ที่ให้มา |
โครงการ_id | เชือก | รหัสโปรเจ็กต์ Firebase ของคุณ |
คำขอตัวอย่าง
curl 'https://securetoken.googleapis.com/v1/token?key=[API_KEY]' \ -H 'Content-Type: application/x-www-form-urlencoded' \ --data 'grant_type=refresh_token&refresh_token=[REFRESH_TOKEN]'
คำขอที่สำเร็จจะแสดงด้วยรหัสสถานะ HTTP 200 OK
การตอบกลับประกอบด้วยโทเค็น Firebase ID ใหม่และโทเค็นการรีเฟรช
ตัวอย่างการตอบกลับ
{ "expires_in": "3600", "token_type": "Bearer", "refresh_token": "[REFRESH_TOKEN]", "id_token": "[ID_TOKEN]", "user_id": "tRcfmLH7o2XrNELi...", "project_id": "1234567890" }
รหัสข้อผิดพลาดทั่วไป
- TOKEN_EXPIRED: ข้อมูลรับรองของผู้ใช้ใช้ไม่ได้อีกต่อไป ผู้ใช้จะต้องลงชื่อเข้าใช้อีกครั้ง
- USER_DISABLED: บัญชีผู้ใช้ถูกปิดใช้งานโดยผู้ดูแลระบบ
- USER_NOT_FOUND: ไม่พบผู้ใช้ที่สอดคล้องกับโทเค็นการรีเฟรช เป็นไปได้ว่าผู้ใช้ถูกลบไปแล้ว
- คีย์ API ไม่ถูกต้อง กรุณาส่งคีย์ API ที่ถูกต้อง (ระบุคีย์ API ไม่ถูกต้อง)
- INVALID_REFRESH_TOKEN: มีการระบุโทเค็นการรีเฟรชที่ไม่ถูกต้อง
- ได้รับเพย์โหลด JSON ที่ไม่ถูกต้อง ชื่อที่ไม่รู้จัก \"refresh_tokens\": ไม่สามารถผูกพารามิเตอร์การสืบค้นได้ ไม่พบฟิลด์ 'refresh_tokens' ในข้อความคำขอ
- INVALID_GRANT_TYPE: ประเภทสิทธิ์ที่ระบุไม่ถูกต้อง
- MISSING_REFRESH_TOKEN: ไม่มีโทเค็นการรีเฟรชให้มา
- PROJECT_NUMBER_MISMATCH: หมายเลขโครงการของโทเค็นการรีเฟรชไม่ตรงกับหมายเลขของคีย์ API ที่ให้ไว้
ลงทะเบียนด้วยอีเมล / รหัสผ่าน
คุณสามารถสร้างผู้ใช้อีเมลและรหัสผ่านใหม่ได้โดยออกคำขอ HTTP POST
ไปยังจุดสิ้นสุด Auth signupNewUser
วิธีการ: โพสต์
ประเภทเนื้อหา: application/json
จุดสิ้นสุดhttps://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]ขอน้ำหนักบรรทุกเนื้อหา
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
อีเมล | เชือก | อีเมลที่ผู้ใช้จะสร้าง |
รหัสผ่าน | เชือก | รหัสผ่านที่ผู้ใช้จะสร้าง |
returnSecureToken | บูลีน | ไม่ว่าจะส่งคืน ID และโทเค็นการรีเฟรชหรือไม่ ควรจะเป็นจริงเสมอ |
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
idToken | เชือก | โทเค็น Firebase Auth ID สำหรับผู้ใช้ที่สร้างขึ้นใหม่ |
อีเมล | เชือก | อีเมลสำหรับผู้ใช้ที่สร้างขึ้นใหม่ |
รีเฟรชโทเค็น | เชือก | โทเค็นการรีเฟรช Firebase Auth สำหรับผู้ใช้ที่สร้างขึ้นใหม่ |
หมดอายุใน | เชือก | จำนวนวินาทีที่โทเค็น ID หมดอายุ |
รหัสท้องถิ่น | เชือก | uid ของผู้ใช้ที่สร้างขึ้นใหม่ |
คำขอตัวอย่าง
curl 'https://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]' \ -H 'Content-Type: application/json' \ --data-binary '{"email":"[user@example.com]","password":"[PASSWORD]","returnSecureToken":true}'
คำขอที่สำเร็จจะแสดงด้วยรหัสสถานะ HTTP 200 OK
การตอบสนองประกอบด้วยโทเค็น Firebase ID และโทเค็นการรีเฟรชที่เชื่อมโยงกับบัญชีใหม่
ตัวอย่างการตอบกลับ
{ "idToken": "[ID_TOKEN]", "email": "[user@example.com]", "refreshToken": "[REFRESH_TOKEN]", "expiresIn": "3600", "localId": "tRcfmLH7..." }
รหัสข้อผิดพลาดทั่วไป
- EMAIL_EXISTS: ที่อยู่อีเมลนี้มีการใช้งานแล้วโดยบัญชีอื่น
- OPERATION_NOT_ALLOWED: การลงชื่อเข้าใช้รหัสผ่านถูกปิดใช้งานสำหรับโปรเจ็กต์นี้
- TOO_MANY_ATTEMPTS_TRY_LATER: เราได้บล็อกคำขอทั้งหมดจากอุปกรณ์นี้เนื่องจากมีกิจกรรมที่ผิดปกติ ลองอีกครั้งในภายหลัง
เข้าสู่ระบบด้วยอีเมล / รหัสผ่าน
คุณสามารถลงชื่อเข้าใช้ผู้ใช้ด้วยอีเมลและรหัสผ่านได้โดยส่งคำขอ HTTP POST
ไปยังจุดสิ้นสุด Auth verifyPassword
วิธีการ: โพสต์
ประเภทเนื้อหา: application/json
จุดสิ้นสุดhttps://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key=[API_KEY]คำขอน้ำหนักบรรทุก
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
อีเมล | เชือก | อีเมลที่ผู้ใช้ลงชื่อเข้าใช้ |
รหัสผ่าน | เชือก | รหัสผ่านสำหรับบัญชี |
returnSecureToken | บูลีน | ไม่ว่าจะส่งคืน ID และโทเค็นการรีเฟรชหรือไม่ ควรจะเป็นจริงเสมอ |
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
idToken | เชือก | โทเค็น Firebase Auth ID สำหรับผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์ |
อีเมล | เชือก | อีเมลสำหรับผู้ใช้ที่ได้รับการรับรองความถูกต้อง |
รีเฟรชโทเค็น | เชือก | โทเค็นการรีเฟรช Firebase Auth สำหรับผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์ |
หมดอายุใน | เชือก | จำนวนวินาทีที่โทเค็น ID หมดอายุ |
รหัสท้องถิ่น | เชือก | uid ของผู้ใช้ที่ได้รับการรับรองความถูกต้อง |
ลงทะเบียนแล้ว | บูลีน | ไม่ว่าจะเป็นอีเมลสำหรับบัญชีที่มีอยู่ |
คำขอตัวอย่าง
curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key=[API_KEY]' \ -H 'Content-Type: application/json' \ --data-binary '{"email":"[user@example.com]","password":"[PASSWORD]","returnSecureToken":true}'
คำขอที่สำเร็จจะแสดงด้วยรหัสสถานะ HTTP 200 OK
การตอบกลับประกอบด้วยโทเค็น Firebase ID และโทเค็นการรีเฟรชที่เชื่อมโยงกับบัญชีอีเมล/รหัสผ่านที่มีอยู่
ตัวอย่างการตอบกลับ
{ "localId": "ZY1rJK0eYLg...", "email": "[user@example.com]", "displayName": "", "idToken": "[ID_TOKEN]", "registered": true, "refreshToken": "[REFRESH_TOKEN]", "expiresIn": "3600" }
รหัสข้อผิดพลาดทั่วไป
- EMAIL_NOT_FOUND: ไม่มีบันทึกผู้ใช้ที่สอดคล้องกับตัวระบุนี้ ผู้ใช้อาจถูกลบไปแล้ว
- INVALID_PASSWORD: รหัสผ่านไม่ถูกต้องหรือผู้ใช้ไม่มีรหัสผ่าน
- USER_DISABLED: บัญชีผู้ใช้ถูกปิดใช้งานโดยผู้ดูแลระบบ
ลงชื่อเข้าใช้โดยไม่ระบุชื่อ
คุณสามารถลงชื่อเข้าใช้ผู้ใช้โดยไม่ระบุชื่อได้โดยส่งคำขอ HTTP POST
ไปยังจุดสิ้นสุด Auth signupNewUser
วิธีการ: โพสต์
ประเภทเนื้อหา: application/json
จุดสิ้นสุดhttps://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]ขอน้ำหนักบรรทุกเนื้อหา
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
returnSecureToken | บูลีน | ไม่ว่าจะส่งคืน ID และโทเค็นการรีเฟรชหรือไม่ ควรจะเป็นจริงเสมอ |
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
idToken | เชือก | โทเค็น Firebase Auth ID สำหรับผู้ใช้ที่สร้างขึ้นใหม่ |
อีเมล | เชือก | เนื่องจากผู้ใช้ไม่ระบุชื่อ ข้อมูลนี้จึงควรว่างเปล่า |
รีเฟรชโทเค็น | เชือก | โทเค็นการรีเฟรช Firebase Auth สำหรับผู้ใช้ที่สร้างขึ้นใหม่ |
หมดอายุใน | เชือก | จำนวนวินาทีที่โทเค็น ID หมดอายุ |
รหัสท้องถิ่น | เชือก | uid ของผู้ใช้ที่สร้างขึ้นใหม่ |
คำขอตัวอย่าง
curl 'https://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]' \ -H 'Content-Type: application/json' --data-binary '{"returnSecureToken":true}'
คำขอที่สำเร็จจะแสดงด้วยรหัสสถานะ HTTP 200 OK
การตอบกลับประกอบด้วยโทเค็น Firebase ID และโทเค็นการรีเฟรชที่เชื่อมโยงกับผู้ใช้ที่ไม่ระบุชื่อ
ตัวอย่างการตอบกลับ
{ "idToken": "[ID_TOKEN]", "email": "", "refreshToken": "[REFRESH_TOKEN]", "expiresIn": "3600", "localId": "Jws4SVjpT..." }
รหัสข้อผิดพลาดทั่วไป
- OPERATION_NOT_ALLOWED: การลงชื่อเข้าใช้ของผู้ใช้ที่ไม่ระบุชื่อถูกปิดใช้งานสำหรับโปรเจ็กต์นี้
ลงชื่อเข้าใช้ด้วยข้อมูลรับรอง OAuth
คุณสามารถลงชื่อเข้าใช้ผู้ใช้ด้วยข้อมูลรับรอง OAuth ได้โดยส่งคำขอ HTTP POST
ไปยังจุดสิ้นสุด Auth verifyAssertion
วิธีการ: โพสต์
ประเภทเนื้อหา: application/json
จุดสิ้นสุดhttps://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]คำขอน้ำหนักบรรทุก
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
ขอUri | เชือก | URI ที่ IDP เปลี่ยนเส้นทางผู้ใช้กลับมา |
โพสต์ร่างกาย | เชือก | ประกอบด้วยข้อมูลรับรอง OAuth (โทเค็น ID หรือโทเค็นการเข้าถึง) และ ID ผู้ให้บริการที่ออกข้อมูลรับรอง |
returnSecureToken | บูลีน | ไม่ว่าจะส่งคืน ID และโทเค็นการรีเฟรชหรือไม่ ควรจะเป็นจริงเสมอ |
returnIdpCredential | บูลีน | ว่าจะบังคับให้ส่งคืนข้อมูลรับรอง OAuth จากข้อผิดพลาดต่อไปนี้: FEDERATED_USER_ID_ALREADY_LINKED และ EMAIL_EXISTS หรือไม่ |
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
รหัสสหพันธ์ | เชือก | รหัสที่ไม่ซ้ำกันจะระบุบัญชี IdP |
รหัสผู้ให้บริการ | เชือก | รหัสผู้ให้บริการที่เชื่อมโยง (เช่น "google.com" สำหรับผู้ให้บริการ Google) |
รหัสท้องถิ่น | เชือก | uid ของผู้ใช้ที่ได้รับการรับรองความถูกต้อง |
อีเมลยืนยันแล้ว | บูลีน | อีเมลสำหรับลงชื่อเข้าใช้ได้รับการยืนยันแล้วหรือไม่ |
อีเมล | เชือก | อีเมลของบัญชี |
oauthIdToken | เชือก | โทเค็นรหัส OIDC หากมี |
oauthAccessToken | เชือก | โทเค็นการเข้าถึง OAuth หากมี |
oauthTokenSecret | เชือก | ข้อมูลลับโทเค็น OAuth 1.0 หากมี |
ข้อมูลผู้ใช้ดิบ | เชือก | การตอบสนอง JSON แบบเข้มงวดที่มีข้อมูล IdP ทั้งหมดที่สอดคล้องกับข้อมูลรับรอง OAuth ที่ระบุ |
ชื่อจริง | เชือก | ชื่อแรกของบัญชี |
นามสกุล | เชือก | นามสกุลของบัญชี |
ชื่อเต็ม | เชือก | ชื่อเต็มของบัญชี |
ชื่อที่แสดง | เชือก | ชื่อที่แสดงสำหรับบัญชี |
URL รูปภาพ | เชือก | URL รูปภาพสำหรับบัญชี |
idToken | เชือก | โทเค็น Firebase Auth ID สำหรับผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์ |
รีเฟรชโทเค็น | เชือก | โทเค็นการรีเฟรช Firebase Auth สำหรับผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์ |
หมดอายุใน | เชือก | จำนวนวินาทีที่โทเค็น ID หมดอายุ |
ต้องการการยืนยัน | บูลีน | มีบัญชีอื่นที่ใช้ข้อมูลรับรองเดียวกันอยู่แล้วหรือไม่ ผู้ใช้จะต้องลงชื่อเข้าใช้บัญชีเดิม จากนั้นจึงเชื่อมโยงข้อมูลรับรองปัจจุบันเข้ากับบัญชีดังกล่าว |
คำขอตัวอย่างด้วยโทเค็น OAuth ID
curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \ -H 'Content-Type: application/json' \ --data-binary '{"postBody":"id_token=[GOOGLE_ID_TOKEN]&providerId=[google.com]","requestUri":"[http://localhost]","returnIdpCredential":true,"returnSecureToken":true}'
คำขอที่สำเร็จจะแสดงด้วยรหัสสถานะ HTTP 200 OK
การตอบสนองประกอบด้วยโทเค็น Firebase ID และโทเค็นการรีเฟรชที่เชื่อมโยงกับผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์
ตัวอย่างการตอบสนองด้วยโทเค็น OAuth ID
{ "federatedId": "https://accounts.google.com/1234567890", "providerId": "google.com", "localId": "5xwsPCWYo...", "emailVerified": true, "email": "user@example.com", "oauthIdToken": "[GOOGLE_ID_TOKEN]", "firstName": "John", "lastName": "Doe", "fullName": "John Doe", "displayName": "John Doe", "idToken": "[ID_TOKEN]", "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg", "refreshToken": "[REFRESH_TOKEN]", "expiresIn": "3600", "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}" }
คำขอตัวอย่างพร้อมโทเค็นการเข้าถึง OAuth
curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \ -H 'Content-Type: application/json' \ --data-binary '{"postBody":"access_token=[FACEBOOK_ACCESS_TOKEN]&providerId=[facebook.com]","requestUri":"[http://localhost]","returnIdpCredential":true,"returnSecureToken":true}'
คำขอที่สำเร็จจะแสดงด้วยรหัสสถานะ HTTP 200 OK
การตอบสนองประกอบด้วยโทเค็น Firebase ID และโทเค็นการรีเฟรชที่เชื่อมโยงกับผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์
ตัวอย่างการตอบสนองด้วยโทเค็นการเข้าถึง OAuth
{ "federatedId": "http://facebook.com/1234567890", "providerId": "facebook.com", "localId": "5xwsPCWYo...", "emailVerified": true, "email": "user@example.com", "oauthAccessToken": "[FACEBOOK_ACCESS_TOKEN]", "firstName": "John", "lastName": "Doe", "fullName": "John Doe", "displayName": "John Doe", "idToken": "[ID_TOKEN]", "photoUrl": "https://scontent.xx.fbcdn.net/v/...", "refreshToken": "[REFRESH_TOKEN]", "expiresIn": "3600", "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}" }
คำขอตัวอย่างพร้อมข้อมูลรับรอง Twitter OAuth 1.0
curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \ -H 'Content-Type: application/json' \ --data-binary '{"postBody":"access_token=[TWITTER_ACCESS_TOKEN]&oauth_token_secret=[TWITTER_TOKEN_SECRET]&providerId=[twitter.com]","requestUri":"[http://localhost]","returnIdpCredential":true,"returnSecureToken":true}'
คำขอที่สำเร็จจะแสดงด้วยรหัสสถานะ HTTP 200 OK
การตอบสนองประกอบด้วยโทเค็น Firebase ID และโทเค็นการรีเฟรชที่เชื่อมโยงกับผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์
ตัวอย่างการตอบกลับด้วยข้อมูลรับรอง Twitter OAuth 1.0
{ "federatedId": "http://twitter.com/1234567890", "providerId": "twitter.com", "localId": "5xwsPCWYo...", "emailVerified": true, "email": "user@example.com", "oauthAccessToken": "[OAUTH_ACCESS_TOKEN]", "oauthTokenSecret": "[OAUTH_TOKEN_SECRET]", "firstName": "John", "lastName": "Doe", "fullName": "John Doe", "displayName": "John Doe", "idToken": "[ID_TOKEN]", "photoUrl": "http://abs.twimg.com/sticky/...", "refreshToken": "[REFRESH_TOKEN]", "expiresIn": "3600", "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}" }
รหัสข้อผิดพลาดทั่วไป
- OPERATION_NOT_ALLOWED: ผู้ให้บริการที่เกี่ยวข้องถูกปิดใช้งานสำหรับโครงการนี้
- INVALID_IDP_RESPONSE: ข้อมูลรับรองการตรวจสอบที่ให้มามีรูปแบบไม่ถูกต้องหรือหมดอายุแล้ว
ดึงข้อมูลผู้ให้บริการสำหรับอีเมล
คุณสามารถดูผู้ให้บริการทั้งหมดที่เกี่ยวข้องกับอีเมลที่ระบุได้โดยส่งคำขอ HTTP POST
ไปยังจุดสิ้นสุด Auth createAuthUri
วิธีการ: โพสต์
ประเภทเนื้อหา: application/json
จุดสิ้นสุดhttps://identitytoolkit.googleapis.com/v1/accounts:createAuthUri?key=[API_KEY]คำขอน้ำหนักบรรทุก
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
ตัวระบุ | เชือก | ที่อยู่อีเมลของผู้ใช้ |
ดำเนินการต่อUri | เชือก | URI ที่ IDP เปลี่ยนเส้นทางผู้ใช้กลับมา สำหรับกรณีการใช้งานนี้ นี่เป็นเพียง URL ปัจจุบัน |
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
ผู้ให้บริการทั้งหมด | รายการสตริง | รายชื่อผู้ให้บริการที่ผู้ใช้ลงชื่อเข้าใช้ก่อนหน้านี้ |
ลงทะเบียนแล้ว | บูลีน | ไม่ว่าจะเป็นอีเมลสำหรับบัญชีที่มีอยู่ |
คำขอตัวอย่าง
curl 'https://identitytoolkit.googleapis.com/v1/accounts:createAuthUri?key=[API_KEY]' \ -H 'Content-Type: application/json' \ --data-binary '{"identifier":"[user@example.com]","continueUri":"[http://localhost:8080/app]"}'
คำขอที่สำเร็จจะแสดงด้วยรหัสสถานะ HTTP 200 OK
การตอบกลับประกอบด้วยรายชื่อผู้ให้บริการที่เกี่ยวข้องกับอีเมล
ตัวอย่างการตอบกลับ
{ "allProviders": [ "password", "google.com" ], "registered": true }
รหัสข้อผิดพลาดทั่วไป
- INVALID_EMAIL: ที่อยู่อีเมลมีรูปแบบที่ไม่เหมาะสม
ส่งอีเมลรีเซ็ตรหัสผ่าน
คุณสามารถส่งอีเมลรีเซ็ตรหัสผ่านได้โดยส่งคำขอ HTTP POST
ไปยังจุดสิ้นสุด Auth getOobConfirmationCode
วิธีการ: โพสต์
ประเภทเนื้อหา: application/json
จุดสิ้นสุดhttps://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]ส่วนหัวเสริม
ชื่อคุณสมบัติ | คำอธิบาย |
---|---|
X-Firebase-สถานที่ | รหัสภาษาที่สอดคล้องกับสถานที่ของผู้ใช้ การผ่านขั้นตอนนี้จะแปลอีเมลรีเซ็ตรหัสผ่านที่ส่งถึงผู้ใช้เป็นภาษาท้องถิ่น |
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
ประเภทคำขอ | เชือก | ประเภทของรหัส OOB ที่จะส่งคืน ควรเป็น "PASSWORD_RESET" สำหรับการรีเซ็ตรหัสผ่าน |
อีเมล | เชือก | ที่อยู่อีเมลของผู้ใช้ |
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
อีเมล | เชือก | ที่อยู่อีเมลของผู้ใช้ |
คำขอตัวอย่าง
curl 'https://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]' \ -H 'Content-Type: application/json' \ --data-binary '{"requestType":"PASSWORD_RESET","email":"[user@example.com]"}'
คำขอที่สำเร็จจะแสดงด้วยรหัสสถานะ HTTP 200 OK
ตัวอย่างการตอบกลับ
{ "email": "[user@example.com]" }
รหัสข้อผิดพลาดทั่วไป
- EMAIL_NOT_FOUND: ไม่มีบันทึกผู้ใช้ที่สอดคล้องกับตัวระบุนี้ ผู้ใช้อาจถูกลบไปแล้ว
ตรวจสอบรหัสรีเซ็ตรหัสผ่าน
คุณสามารถตรวจสอบรหัสรีเซ็ตรหัสผ่านได้โดยออกคำขอ HTTP POST
ไปยังจุดสิ้นสุด Auth resetPassword
วิธีการ: โพสต์
ประเภทเนื้อหา: application/json
จุดสิ้นสุดhttps://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]คำขอน้ำหนักบรรทุก
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
oobCode | เชือก | รหัสการดำเนินการอีเมลที่ส่งไปยังอีเมลของผู้ใช้เพื่อรีเซ็ตรหัสผ่าน |
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
อีเมล | เชือก | ที่อยู่อีเมลของผู้ใช้ |
ประเภทคำขอ | เชือก | ประเภทของรหัสการดำเนินการอีเมล ควรเป็น "PASSWORD_RESET" |
คำขอตัวอย่าง
curl 'https://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]' \ -H 'Content-Type: application/json' --data-binary '{"oobCode":"[PASSWORD_RESET_CODE]"}'
คำขอที่สำเร็จจะแสดงด้วยรหัสสถานะ HTTP 200 OK
ตัวอย่างการตอบกลับ
{ "email": "[user@example.com]", "requestType": "PASSWORD_RESET" }
รหัสข้อผิดพลาดทั่วไป
- OPERATION_NOT_ALLOWED: การลงชื่อเข้าใช้รหัสผ่านถูกปิดใช้งานสำหรับโปรเจ็กต์นี้
- EXPIRED_OOB_CODE: รหัสการดำเนินการหมดอายุแล้ว
- INVALID_OOB_CODE: รหัสการดำเนินการไม่ถูกต้อง กรณีนี้อาจเกิดขึ้นได้หากรหัสมีรูปแบบไม่ถูกต้อง หมดอายุ หรือมีการใช้งานแล้ว
ยืนยันการรีเซ็ตรหัสผ่าน
คุณสามารถใช้การเปลี่ยนแปลงการรีเซ็ตรหัสผ่านได้โดยการออกคำขอ HTTP POST
ไปยังจุดสิ้นสุด Auth resetPassword
วิธีการ: โพสต์
ประเภทเนื้อหา: application/json
จุดสิ้นสุดhttps://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]คำขอน้ำหนักบรรทุก
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
oobCode | เชือก | รหัสการดำเนินการอีเมลที่ส่งไปยังอีเมลของผู้ใช้เพื่อรีเซ็ตรหัสผ่าน |
รหัสผ่านใหม่ | เชือก | รหัสผ่านใหม่ของผู้ใช้ |
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
อีเมล | เชือก | ที่อยู่อีเมลของผู้ใช้ |
ประเภทคำขอ | เชือก | ประเภทของรหัสการดำเนินการอีเมล ควรเป็น "PASSWORD_RESET" |
คำขอตัวอย่าง
curl 'https://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]' \ -H 'Content-Type: application/json' \ --data-binary '{"oobCode":"[PASSWORD_RESET_CODE]","newPassword":"[NEW_PASSWORD]"}'
คำขอที่สำเร็จจะแสดงด้วยรหัสสถานะ HTTP 200 OK
ตัวอย่างการตอบกลับ
{ "email": "[user@example.com]", "requestType": "PASSWORD_RESET" }
รหัสข้อผิดพลาดทั่วไป
- OPERATION_NOT_ALLOWED: การลงชื่อเข้าใช้รหัสผ่านถูกปิดใช้งานสำหรับโปรเจ็กต์นี้
- EXPIRED_OOB_CODE: รหัสการดำเนินการหมดอายุแล้ว
- INVALID_OOB_CODE: รหัสการดำเนินการไม่ถูกต้อง กรณีนี้อาจเกิดขึ้นได้หากรหัสมีรูปแบบไม่ถูกต้อง หมดอายุ หรือมีการใช้งานแล้ว
- USER_DISABLED: บัญชีผู้ใช้ถูกปิดใช้งานโดยผู้ดูแลระบบ
เปลี่ยนอีเมล
คุณสามารถเปลี่ยนอีเมลของผู้ใช้ได้โดยส่งคำขอ HTTP POST
ไปยังจุดสิ้นสุด Auth setAccountInfo
วิธีการ: โพสต์
ประเภทเนื้อหา: application/json
จุดสิ้นสุดhttps://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]ส่วนหัวเสริม
ชื่อคุณสมบัติ | คำอธิบาย |
---|---|
X-Firebase-สถานที่ | รหัสภาษาที่สอดคล้องกับสถานที่ของผู้ใช้ การส่งผ่านนี้จะแปลการเพิกถอนการเปลี่ยนแปลงอีเมลที่ส่งถึงผู้ใช้เป็นภาษาท้องถิ่น |
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
idToken | เชือก | โทเค็น Firebase Auth ID สำหรับผู้ใช้ |
อีเมล | เชือก | อีเมลใหม่ของผู้ใช้ |
returnSecureToken | บูลีน | ไม่ว่าจะส่งคืน ID และโทเค็นการรีเฟรชหรือไม่ |
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
รหัสท้องถิ่น | เชือก | uid ของผู้ใช้ปัจจุบัน |
อีเมล | เชือก | ที่อยู่อีเมลของผู้ใช้ |
รหัสผ่านHash | เชือก | รหัสผ่านเวอร์ชันแฮช |
ผู้ให้บริการ UserInfo | รายการออบเจ็กต์ JSON | รายการออบเจ็กต์ผู้ให้บริการที่เชื่อมโยงทั้งหมดซึ่งมี "providerId" และ "federatedId" |
idToken | เชือก | โทเค็น Firebase Auth ID ใหม่สำหรับผู้ใช้ |
รีเฟรชโทเค็น | เชือก | โทเค็นการรีเฟรช Firebase Auth |
หมดอายุใน | เชือก | จำนวนวินาทีที่โทเค็น ID หมดอายุ |
คำขอตัวอย่าง
curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \ -H 'Content-Type: application/json' \ --data-binary \ '{"idToken":"[FIREBASE_ID_TOKEN]","email":"[user@example2.com]","returnSecureToken":true}'
คำขอที่สำเร็จจะแสดงด้วยรหัสสถานะ HTTP 200 OK
การตอบสนองประกอบด้วยโทเค็น Firebase ID ใหม่และโทเค็นการรีเฟรชที่เชื่อมโยงกับผู้ใช้
ตัวอย่างการตอบกลับ
{ "localId": "tRcfmLH7o2...", "email": "[user@example2.com]", "passwordHash": "...", "providerUserInfo": [ { "providerId": "password", "federatedId": "[user@example2.com]" } ], "idToken": "[NEW_ID_TOKEN]", "refreshToken": "[NEW_REFRESH_TOKEN]", "expiresIn": "3600" }
รหัสข้อผิดพลาดทั่วไป
- EMAIL_EXISTS: ที่อยู่อีเมลนี้มีการใช้งานแล้วโดยบัญชีอื่น
- INVALID_ID_TOKEN:ข้อมูลประจำตัวของผู้ใช้ไม่ถูกต้องอีกต่อไป ผู้ใช้จะต้องลงชื่อเข้าใช้อีกครั้ง
เปลี่ยนรหัสผ่าน
คุณสามารถเปลี่ยนรหัสผ่านของผู้ใช้ได้โดยส่งคำขอ HTTP POST
ไปยังจุดสิ้นสุด Auth setAccountInfo
วิธีการ: โพสต์
ประเภทเนื้อหา: application/json
จุดสิ้นสุดhttps://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]คำขอน้ำหนักบรรทุก
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
idToken | เชือก | โทเค็น Firebase Auth ID สำหรับผู้ใช้ |
รหัสผ่าน | เชือก | รหัสผ่านใหม่ของผู้ใช้ |
returnSecureToken | บูลีน | ไม่ว่าจะส่งคืน ID และโทเค็นการรีเฟรชหรือไม่ |
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
รหัสท้องถิ่น | เชือก | uid ของผู้ใช้ปัจจุบัน |
อีเมล | เชือก | ที่อยู่อีเมลของผู้ใช้ |
รหัสผ่านHash | เชือก | รหัสผ่านเวอร์ชันแฮช |
ผู้ให้บริการ UserInfo | รายการออบเจ็กต์ JSON | รายการออบเจ็กต์ผู้ให้บริการที่เชื่อมโยงทั้งหมดซึ่งมี "providerId" และ "federatedId" |
idToken | เชือก | โทเค็น Firebase Auth ID ใหม่สำหรับผู้ใช้ |
รีเฟรชโทเค็น | เชือก | โทเค็นการรีเฟรช Firebase Auth |
หมดอายุใน | เชือก | จำนวนวินาทีที่โทเค็น ID หมดอายุ |
คำขอตัวอย่าง
curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \ -H 'Content-Type: application/json' \ --data-binary \ '{"idToken":"[FIREBASE_ID_TOKEN]","password":"[NEW_PASSWORD]","returnSecureToken":true}'
คำขอที่สำเร็จจะแสดงด้วยรหัสสถานะ HTTP 200 OK
การตอบสนองประกอบด้วยโทเค็น Firebase ID ใหม่และโทเค็นการรีเฟรชที่เชื่อมโยงกับผู้ใช้
ตัวอย่างการตอบกลับ
{ "localId": "tRcfmLH7o2...", "email": "[user@example.com]", "passwordHash": "...", "providerUserInfo": [ { "providerId": "password", "federatedId": "[user@example.com]" } ], "idToken": "[NEW_ID_TOKEN]", "refreshToken": "[NEW_REFRESH_TOKEN]", "expiresIn": "3600" }
รหัสข้อผิดพลาดทั่วไป
- INVALID_ID_TOKEN:ข้อมูลประจำตัวของผู้ใช้ไม่ถูกต้องอีกต่อไป ผู้ใช้จะต้องลงชื่อเข้าใช้อีกครั้ง
- WEAK_PASSWORD: รหัสผ่านต้องมีความยาว 6 ตัวอักษรขึ้นไป
อัพเดตโปรไฟล์
คุณสามารถอัปเดตโปรไฟล์ของผู้ใช้ (ชื่อที่แสดง / URL รูปภาพ) ได้โดยการออกคำขอ HTTP POST
ไปยังจุดสิ้นสุด Auth setAccountInfo
วิธีการ: โพสต์
ประเภทเนื้อหา: application/json
จุดสิ้นสุดhttps://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]คำขอน้ำหนักบรรทุก
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
idToken | เชือก | โทเค็น Firebase Auth ID สำหรับผู้ใช้ |
ชื่อที่แสดง | เชือก | ชื่อที่แสดงใหม่ของผู้ใช้ |
URL รูปภาพ | เชือก | URL รูปภาพใหม่ของผู้ใช้ |
ลบแอตทริบิวต์ | รายการสตริง | รายการแอตทริบิวต์ที่จะลบ "DISPLAY_NAME" หรือ "PHOTO_URL" สิ่งนี้จะทำให้ค่าเหล่านี้เป็นโมฆะ |
returnSecureToken | บูลีน | ไม่ว่าจะส่งคืน ID และโทเค็นการรีเฟรชหรือไม่ |
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
รหัสท้องถิ่น | เชือก | uid ของผู้ใช้ปัจจุบัน |
อีเมล | เชือก | ที่อยู่อีเมลของผู้ใช้ |
ชื่อที่แสดง | เชือก | ชื่อที่แสดงใหม่ของผู้ใช้ |
URL รูปภาพ | เชือก | URL รูปภาพใหม่ของผู้ใช้ |
รหัสผ่านHash | เชือก | รหัสผ่านเวอร์ชันแฮช |
ผู้ให้บริการ UserInfo | รายการออบเจ็กต์ JSON | รายการออบเจ็กต์ผู้ให้บริการที่เชื่อมโยงทั้งหมดซึ่งมี "providerId" และ "federatedId" |
idToken | เชือก | โทเค็น Firebase Auth ID ใหม่สำหรับผู้ใช้ |
รีเฟรชโทเค็น | เชือก | โทเค็นการรีเฟรช Firebase Auth |
หมดอายุใน | เชือก | จำนวนวินาทีที่โทเค็น ID หมดอายุ |
คำขอตัวอย่าง
curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \ -H 'Content-Type: application/json' \ --data-binary \ '{"idToken":"[ID_TOKEN]","displayName":"[NAME]","photoUrl":"[URL]","returnSecureToken":true}'
คำขอที่สำเร็จจะแสดงด้วยรหัสสถานะ HTTP 200 OK
ตัวอย่างการตอบกลับ
{ "localId": "tRcfmLH...", "email": "user@example2.com", "displayName": "John Doe", "photoUrl": "[http://localhost:8080/img1234567890/photo.png]", "passwordHash": "...", "providerUserInfo": [ { "providerId": "password", "federatedId": "user@example2.com", "displayName": "John Doe", "photoUrl": "http://localhost:8080/img1234567890/photo.png" } ], "idToken": "[NEW_ID_TOKEN]", "refreshToken": "[NEW_REFRESH_TOKEN]", "expiresIn": "3600" }
รหัสข้อผิดพลาดทั่วไป
- INVALID_ID_TOKEN:ข้อมูลประจำตัวของผู้ใช้ไม่ถูกต้องอีกต่อไป ผู้ใช้จะต้องลงชื่อเข้าใช้อีกครั้ง
รับข้อมูลผู้ใช้
คุณสามารถรับข้อมูลของผู้ใช้ได้โดยส่งคำขอ HTTP POST
ไปยังจุดสิ้นสุด Auth getAccountInfo
วิธีการ: โพสต์
ประเภทเนื้อหา: application/json
จุดสิ้นสุดhttps://identitytoolkit.googleapis.com/v1/accounts:lookup?key=[API_KEY]คำขอน้ำหนักบรรทุก
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
idToken | เชือก | โทเค็นรหัส Firebase ของบัญชี |
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
ผู้ใช้ | รายการออบเจ็กต์ JSON | บัญชีที่เชื่อมโยงกับโทเค็น Firebase ID ที่กำหนด ตรวจสอบด้านล่างสำหรับรายละเอียดเพิ่มเติม |
users
)ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
รหัสท้องถิ่น | เชือก | uid ของผู้ใช้ปัจจุบัน |
อีเมล | เชือก | อีเมลของบัญชี |
อีเมลยืนยันแล้ว | บูลีน | อีเมลของบัญชีได้รับการยืนยันแล้วหรือไม่ |
ชื่อที่แสดง | เชือก | ชื่อที่แสดงสำหรับบัญชี |
ผู้ให้บริการ UserInfo | รายการออบเจ็กต์ JSON | รายการออบเจ็กต์ผู้ให้บริการที่เชื่อมโยงทั้งหมดซึ่งมี "providerId" และ "federatedId" |
URL รูปภาพ | เชือก | URL รูปภาพสำหรับบัญชี |
รหัสผ่านHash | เชือก | รหัสผ่านเวอร์ชันแฮช |
รหัสผ่านอัปเดตแล้ว | สองเท่า | การประทับเวลาเป็นมิลลิวินาทีที่รหัสผ่านบัญชีถูกเปลี่ยนแปลงครั้งล่าสุด |
ถูกต้องตั้งแต่ | เชือก | การประทับเวลาเป็นวินาทีซึ่งทำเครื่องหมายขอบเขต ก่อนที่จะถือว่าโทเค็น Firebase ID ถูกเพิกถอน |
พิการ | บูลีน | ไม่ว่าบัญชีจะถูกปิดการใช้งานหรือไม่ |
เข้าสู่ระบบครั้งล่าสุด | เชือก | การประทับเวลาเป็นมิลลิวินาทีที่บัญชีเข้าสู่ระบบครั้งล่าสุด |
สร้างขึ้นที่ | เชือก | การประทับเวลาเป็นมิลลิวินาทีที่ใช้สร้างบัญชี |
การตรวจสอบสิทธิ์แบบกำหนดเอง | บูลีน | ไม่ว่าบัญชีจะได้รับการรับรองความถูกต้องโดยนักพัฒนาหรือไม่ |
คำขอตัวอย่าง
curl 'https://identitytoolkit.googleapis.com/v1/accounts:lookup?key=[API_KEY]' \ -H 'Content-Type: application/json' --data-binary '{"idToken":"[FIREBASE_ID_TOKEN]"}'
คำขอที่สำเร็จจะแสดงด้วยรหัสสถานะ HTTP 200 OK
การตอบกลับจะมีข้อมูลผู้ใช้ทั้งหมดที่เกี่ยวข้องกับบัญชี
ตัวอย่างการตอบกลับ
{ "users": [ { "localId": "ZY1rJK0...", "email": "user@example.com", "emailVerified": false, "displayName": "John Doe", "providerUserInfo": [ { "providerId": "password", "displayName": "John Doe", "photoUrl": "http://localhost:8080/img1234567890/photo.png", "federatedId": "user@example.com", "email": "user@example.com", "rawId": "user@example.com", "screenName": "user@example.com" } ], "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg", "passwordHash": "...", "passwordUpdatedAt": 1.484124177E12, "validSince": "1484124177", "disabled": false, "lastLoginAt": "1484628946000", "createdAt": "1484124142000", "customAuth": false } ] }
รหัสข้อผิดพลาดทั่วไป
- INVALID_ID_TOKEN:ข้อมูลประจำตัวของผู้ใช้ไม่ถูกต้องอีกต่อไป ผู้ใช้จะต้องลงชื่อเข้าใช้อีกครั้ง
- USER_NOT_FOUND: ไม่มีบันทึกผู้ใช้ที่สอดคล้องกับตัวระบุนี้ ผู้ใช้อาจถูกลบไปแล้ว
เชื่อมโยงกับอีเมล/รหัสผ่าน
คุณสามารถเชื่อมโยงอีเมล/รหัสผ่านกับผู้ใช้ปัจจุบันได้โดยการออกคำขอ HTTP POST
ไปยังจุดสิ้นสุด Auth setAccountInfo
วิธีการ: โพสต์
ประเภทเนื้อหา: application/json
จุดสิ้นสุดhttps://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]คำขอน้ำหนักบรรทุก
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
idToken | เชือก | โทเค็นรหัส Firebase ของบัญชีที่คุณพยายามเชื่อมโยงข้อมูลรับรองด้วย |
อีเมล | เชือก | อีเมลที่จะเชื่อมโยงกับบัญชี |
รหัสผ่าน | เชือก | รหัสผ่านใหม่ของบัญชี |
returnSecureToken | เชือก | ไม่ว่าจะส่งคืน ID และโทเค็นการรีเฟรชหรือไม่ ควรจะเป็นจริงเสมอ |
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
รหัสท้องถิ่น | เชือก | uid ของผู้ใช้ปัจจุบัน |
อีเมล | เชือก | อีเมลของบัญชี |
ชื่อที่แสดง | เชือก | ชื่อที่แสดงสำหรับบัญชี |
URL รูปภาพ | เชือก | URL รูปภาพสำหรับบัญชี |
รหัสผ่านHash | เชือก | รหัสผ่านเวอร์ชันแฮช |
ผู้ให้บริการ UserInfo | รายการออบเจ็กต์ JSON | รายการออบเจ็กต์ผู้ให้บริการที่เชื่อมโยงทั้งหมดซึ่งมี "providerId" และ "federatedId" |
อีเมลยืนยันแล้ว | บูลีน | อีเมลของบัญชีได้รับการยืนยันแล้วหรือไม่ |
idToken | เชือก | โทเค็น Firebase Auth ID ใหม่สำหรับผู้ใช้ |
รีเฟรชโทเค็น | เชือก | โทเค็นการรีเฟรช Firebase Auth |
หมดอายุใน | เชือก | จำนวนวินาทีที่โทเค็น ID หมดอายุ |
คำขอตัวอย่าง
curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \ -H 'Content-Type: application/json' \ --data-binary \ '{"idToken":"[ID_TOKEN]","email":"[user@example.com]","password":"[PASS]","returnSecureToken":true}'
คำขอที่สำเร็จจะแสดงด้วยรหัสสถานะ HTTP 200 OK
การตอบสนองประกอบด้วยโทเค็น Firebase ID และโทเค็นการรีเฟรชที่เชื่อมโยงกับผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์
ตัวอย่างการตอบกลับ
{ "localId": "huDwUz...", "email": "user@example.com", "displayName": "John Doe", "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg", "passwordHash": "...", "providerUserInfo": [ { "providerId": "password", "federatedId": "user@example.com" } ], "idToken": "[ID_TOKEN]", "refreshToken": "[REFRESH_TOKEN]", "expiresIn": "3600", "emailVerified": false }
รหัสข้อผิดพลาดทั่วไป
- CREDENTIAL_TOO_OLD_LOGIN_AGAIN: ข้อมูลประจำตัวของผู้ใช้ไม่ถูกต้องอีกต่อไป ผู้ใช้จะต้องลงชื่อเข้าใช้อีกครั้ง
- TOKEN_EXPIRED: ข้อมูลรับรองของผู้ใช้ใช้ไม่ได้อีกต่อไป ผู้ใช้จะต้องลงชื่อเข้าใช้อีกครั้ง
- INVALID_ID_TOKEN:ข้อมูลประจำตัวของผู้ใช้ไม่ถูกต้องอีกต่อไป ผู้ใช้จะต้องลงชื่อเข้าใช้อีกครั้ง
- WEAK_PASSWORD: รหัสผ่านต้องมีความยาว 6 ตัวอักษรขึ้นไป
เชื่อมโยงกับข้อมูลรับรอง OAuth
คุณสามารถเชื่อมโยงข้อมูลรับรอง OAuth กับผู้ใช้ได้โดยออกคำขอ HTTP POST
ไปยังจุดสิ้นสุด Auth verifyAssertion
วิธีการ: โพสต์
ประเภทเนื้อหา: application/json
จุดสิ้นสุดhttps://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]คำขอน้ำหนักบรรทุก
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
idToken | เชือก | โทเค็น Firebase ID ของบัญชีที่คุณพยายามเชื่อมโยงข้อมูลรับรองด้วย |
ขอUri | เชือก | URI ที่ IDP เปลี่ยนเส้นทางผู้ใช้กลับมา |
โพสต์ร่างกาย | เชือก | ประกอบด้วยข้อมูลรับรอง OAuth (โทเค็น ID หรือโทเค็นการเข้าถึง) และ ID ผู้ให้บริการที่ออกข้อมูลประจำตัว |
returnSecureToken | บูลีน | ไม่ว่าจะส่งคืน ID และโทเค็นการรีเฟรชหรือไม่ ควรจะเป็นจริงเสมอ |
returnIdpCredential | บูลีน | ว่าจะบังคับให้ส่งคืนข้อมูลรับรอง OAuth จากข้อผิดพลาดต่อไปนี้: FEDERATED_USER_ID_ALREADY_LINKED และ EMAIL_EXISTS หรือไม่ |
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
รหัสสหพันธ์ | เชือก | รหัสที่ไม่ซ้ำกันจะระบุบัญชี IdP |
รหัสผู้ให้บริการ | เชือก | รหัสผู้ให้บริการที่เชื่อมโยง (เช่น "google.com" สำหรับผู้ให้บริการ Google) |
รหัสท้องถิ่น | เชือก | uid ของผู้ใช้ที่ได้รับการรับรองความถูกต้อง |
อีเมลยืนยันแล้ว | บูลีน | อีเมลสำหรับลงชื่อเข้าใช้ได้รับการยืนยันแล้วหรือไม่ |
อีเมล | เชือก | อีเมลของบัญชี |
oauthIdToken | เชือก | โทเค็นรหัส OIDC หากมี |
oauthAccessToken | เชือก | โทเค็นการเข้าถึง OAuth หากมี |
oauthTokenSecret | เชือก | ข้อมูลลับโทเค็น OAuth 1.0 หากมี |
ข้อมูลผู้ใช้ดิบ | เชือก | การตอบสนอง JSON แบบเข้มงวดที่มีข้อมูล IdP ทั้งหมดที่สอดคล้องกับข้อมูลรับรอง OAuth ที่ระบุ |
ชื่อจริง | เชือก | ชื่อแรกของบัญชี |
นามสกุล | เชือก | นามสกุลของบัญชี |
ชื่อเต็ม | เชือก | ชื่อเต็มของบัญชี |
ชื่อที่แสดง | เชือก | ชื่อที่แสดงสำหรับบัญชี |
URL รูปภาพ | เชือก | URL รูปภาพสำหรับบัญชี |
idToken | เชือก | โทเค็น Firebase Auth ID สำหรับผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์ |
รีเฟรชโทเค็น | เชือก | โทเค็นการรีเฟรช Firebase Auth สำหรับผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์ |
หมดอายุใน | เชือก | จำนวนวินาทีที่โทเค็น ID หมดอายุ |
คำขอตัวอย่างด้วยโทเค็น OAuth ID
curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \ -H 'Content-Type: application/json' \ --data-binary '{"postBody":"id_token=[GOOGLE_ID_TOKEN]&providerId=[google.com]","requestUri":"[http://localhost]","idToken":"[FIREBASE_ID_TOKEN]","returnIdpCredential":true,"returnSecureToken":true}'
คำขอที่สำเร็จจะแสดงด้วยรหัสสถานะ HTTP 200 OK
การตอบสนองประกอบด้วยโทเค็น Firebase ID และโทเค็นการรีเฟรชที่เชื่อมโยงกับผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์
ตัวอย่างการตอบสนองด้วยโทเค็น OAuth ID
{ "federatedId": "https://accounts.google.com/1234567890", "providerId": "google.com", "localId": "5xwsPCWYo...", "emailVerified": true, "email": "user@example.com", "oauthIdToken": "[GOOGLE_ID_TOKEN]", "firstName": "John", "lastName": "Doe", "fullName": "John Doe", "displayName": "John Doe", "idToken": "[ID_TOKEN]", "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg", "refreshToken": "[REFRESH_TOKEN]", "expiresIn": "3600", "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}" }
คำขอตัวอย่างพร้อมโทเค็นการเข้าถึง OAuth
curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \ -H 'Content-Type: application/json' \ --data-binary '{"postBody":"access_token=[FACEBOOK_ACCESS_TOKEN]&providerId=[facebook.com]","idToken":"[FIREBASE_ID_TOKEN]","requestUri":"[http://localhost]","returnIdpCredential":true,"returnSecureToken":true}'
คำขอที่สำเร็จจะแสดงด้วยรหัสสถานะ HTTP 200 OK
การตอบสนองประกอบด้วยโทเค็น Firebase ID และโทเค็นการรีเฟรชที่เชื่อมโยงกับผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์
ตัวอย่างการตอบสนองด้วยโทเค็นการเข้าถึง OAuth
{ "federatedId": "http://facebook.com/1234567890", "providerId": "facebook.com", "localId": "5xwsPCWYo...", "emailVerified": true, "email": "user@example.com", "oauthAccessToken": "[FACEBOOK_ACCESS_TOKEN]", "firstName": "John", "lastName": "Doe", "fullName": "John Doe", "displayName": "John Doe", "idToken": "[ID_TOKEN]", "photoUrl": "https://scontent.xx.fbcdn.net/v/...", "refreshToken": "[REFRESH_TOKEN]", "expiresIn": "3600", "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}" }
คำขอตัวอย่างพร้อมข้อมูลรับรอง Twitter OAuth 1.0
curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \ -H 'Content-Type: application/json' \ --data-binary '{"postBody":"access_token=[TWITTER_ACCESS_TOKEN]&oauth_token_secret=[TWITTER_TOKEN_SECRET]&providerId=[twitter.com]","requestUri":"[http://localhost]","idToken":"[FIREBASE_ID_TOKEN]","returnIdpCredential":true,"returnSecureToken":true}'
คำขอที่สำเร็จจะแสดงด้วยรหัสสถานะ HTTP 200 OK
การตอบสนองประกอบด้วยโทเค็น Firebase ID และโทเค็นการรีเฟรชที่เชื่อมโยงกับผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์
ตัวอย่างการตอบกลับด้วยข้อมูลรับรอง Twitter OAuth 1.0
{ "federatedId": "http://twitter.com/1234567890", "providerId": "twitter.com", "localId": "5xwsPCWYo...", "emailVerified": true, "email": "user@example.com", "oauthAccessToken": "[OAUTH_ACCESS_TOKEN]", "oauthTokenSecret": "[OAUTH_TOKEN_SECRET]", "firstName": "John", "lastName": "Doe", "fullName": "John Doe", "displayName": "John Doe", "idToken": "[ID_TOKEN]", "photoUrl": "http://abs.twimg.com/sticky/...", "refreshToken": "[REFRESH_TOKEN]", "expiresIn": "3600", "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}" }
รหัสข้อผิดพลาดทั่วไป
- OPERATION_NOT_ALLOWED: ผู้ให้บริการที่เกี่ยวข้องถูกปิดใช้งานสำหรับโครงการนี้
- INVALID_IDP_RESPONSE: ข้อมูลรับรองการตรวจสอบที่ให้มามีรูปแบบไม่ถูกต้องหรือหมดอายุแล้ว
- INVALID_ID_TOKEN:ข้อมูลประจำตัวของผู้ใช้ไม่ถูกต้องอีกต่อไป ผู้ใช้จะต้องลงชื่อเข้าใช้อีกครั้ง
- EMAIL_EXISTS: ที่อยู่อีเมลนี้มีการใช้งานแล้วโดยบัญชีอื่น
- FEDERATED_USER_ID_ALREADY_LINKED: ข้อมูลรับรองนี้เชื่อมโยงกับบัญชีผู้ใช้อื่นแล้ว
ยกเลิกการลิงก์ผู้ให้บริการ
คุณสามารถยกเลิกการเชื่อมโยงผู้ให้บริการจากผู้ใช้ปัจจุบันได้โดยออกคำขอ HTTP POST
ไปยังจุดสิ้นสุด Auth setAccountInfo
วิธีการ: โพสต์
ประเภทเนื้อหา: application/json
จุดสิ้นสุดhttps://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]ขอน้ำหนักบรรทุกเนื้อหา
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
idToken | เชือก | โทเค็นรหัส Firebase ของบัญชี |
ลบผู้ให้บริการ | รายการสตริง | รายการรหัสผู้ให้บริการที่จะยกเลิกการเชื่อมโยง เช่น 'google.com', 'รหัสผ่าน' ฯลฯ |
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
รหัสท้องถิ่น | เชือก | uid ของผู้ใช้ปัจจุบัน |
อีเมล | เชือก | อีเมลของบัญชี |
ชื่อที่แสดง | เชือก | ชื่อที่แสดงสำหรับบัญชี |
URL รูปภาพ | เชือก | URL รูปภาพสำหรับบัญชี |
รหัสผ่านHash | เชือก | รหัสผ่านเวอร์ชันแฮช |
ผู้ให้บริการ UserInfo | รายการออบเจ็กต์ JSON | รายการออบเจ็กต์ผู้ให้บริการที่เชื่อมโยงทั้งหมดซึ่งมี "providerId" และ "federatedId" |
อีเมลยืนยันแล้ว | บูลีน | อีเมลของบัญชีได้รับการยืนยันแล้วหรือไม่ |
คำขอตัวอย่าง
curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \ -H 'Content-Type: application/json' \ --data-binary '{"idToken":"[FIREBASE_ID_TOKEN]","deleteProvider":["[facebook.com]"]}'
คำขอที่สำเร็จจะแสดงด้วยรหัสสถานะ HTTP 200 OK
ตัวอย่างการตอบกลับ
{ "localId": "huDwUz...", "email": "user@example.com", "displayName": "John Doe", "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg", "passwordHash": "...", "providerUserInfo": [ { "providerId": "google.com", "federatedId": "1234567890", "displayName": "John Doe", "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg" }, { "providerId": "password", "federatedId": "user@example.com" } ], "emailVerified": "true" }
รหัสข้อผิดพลาดทั่วไป
- INVALID_ID_TOKEN: ข้อมูลประจำตัวของผู้ใช้ไม่ถูกต้องอีกต่อไป ผู้ใช้จะต้องลงชื่อเข้าใช้อีกครั้ง
ส่งอีเมล์ยืนยัน
คุณสามารถส่งการยืนยันอีเมลสำหรับผู้ใช้ปัจจุบันได้โดยออกคำขอ HTTP POST
ไปยังจุดสิ้นสุด Auth getOobConfirmationCode
วิธีการ: โพสต์
ประเภทเนื้อหา: application/json
จุดสิ้นสุดhttps://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]ส่วนหัวเสริม
ชื่อคุณสมบัติ | คำอธิบาย |
---|---|
X-Firebase-สถานที่ | รหัสภาษาที่สอดคล้องกับสถานที่ของผู้ใช้ การผ่านขั้นตอนนี้จะแปลการยืนยันอีเมลที่ส่งถึงผู้ใช้เป็นภาษาท้องถิ่น |
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
ประเภทคำขอ | เชือก | ประเภทของรหัสยืนยันที่จะส่ง ควรเป็น "VERIFY_EMAIL" เสมอ |
idToken | เชือก | โทเค็น Firebase ID ของผู้ใช้ที่จะตรวจสอบ |
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
อีเมล | เชือก | อีเมลของบัญชี |
คำขอตัวอย่าง
curl 'https://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]' \ -H 'Content-Type: application/json' \ --data-binary '{"requestType":"VERIFY_EMAIL","idToken":"[FIREBASE_ID_TOKEN]"}'
คำขอที่สำเร็จจะแสดงด้วยรหัสสถานะ HTTP 200 OK
ตัวอย่างการตอบกลับ
{ "email": "user@example.com" }
รหัสข้อผิดพลาดทั่วไป
- INVALID_ID_TOKEN: ข้อมูลประจำตัวของผู้ใช้ไม่ถูกต้องอีกต่อไป ผู้ใช้จะต้องลงชื่อเข้าใช้อีกครั้ง
- USER_NOT_FOUND: ไม่มีบันทึกผู้ใช้ที่สอดคล้องกับตัวระบุนี้ ผู้ใช้อาจถูกลบไปแล้ว
ยืนยันการยืนยันอีเมล
คุณสามารถยืนยันรหัสยืนยันอีเมลได้โดยออกคำขอ HTTP POST
ไปยังจุดสิ้นสุด Auth setAccountInfo
วิธีการ: โพสต์
ประเภทเนื้อหา: application/json
จุดสิ้นสุดhttps://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]คำขอน้ำหนักบรรทุก
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
oobCode | เชือก | รหัสการดำเนินการที่ส่งไปยังอีเมลของผู้ใช้เพื่อยืนยันอีเมล |
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
อีเมล | เชือก | อีเมลของบัญชี |
ชื่อที่แสดง | เชือก | ชื่อที่แสดงสำหรับบัญชี |
URL รูปภาพ | เชือก | URL รูปภาพสำหรับบัญชี |
รหัสผ่านHash | เชือก | แฮรหัสผ่าน |
ผู้ให้บริการ UserInfo | รายการออบเจ็กต์ JSON | รายการออบเจ็กต์ผู้ให้บริการที่เชื่อมโยงทั้งหมดซึ่งมี "providerId" และ "federatedId" |
อีเมลยืนยันแล้ว | บูลีน | อีเมลของบัญชีได้รับการยืนยันแล้วหรือไม่ |
คำขอตัวอย่าง
curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \ -H 'Content-Type: application/json' --data-binary '{"oobCode":"[VERIFICATION_CODE]"}'
คำขอที่สำเร็จจะแสดงด้วยรหัสสถานะ HTTP 200 OK
ตัวอย่างการตอบกลับ
{ "localId": "FhyStE...", "email": "user@example.com", "passwordHash": "...", "providerUserInfo": [ { "providerId": "password", "federatedId": "user@example.com" } ] }
รหัสข้อผิดพลาดทั่วไป
- EXPIRED_OOB_CODE: รหัสการดำเนินการหมดอายุแล้ว
- INVALID_OOB_CODE: รหัสการดำเนินการไม่ถูกต้อง กรณีนี้อาจเกิดขึ้นได้หากรหัสมีรูปแบบไม่ถูกต้อง หมดอายุ หรือมีการใช้งานแล้ว
- USER_DISABLED: บัญชีผู้ใช้ถูกปิดใช้งานโดยผู้ดูแลระบบ
- EMAIL_NOT_FOUND: ไม่มีบันทึกผู้ใช้ที่สอดคล้องกับตัวระบุนี้ ผู้ใช้อาจถูกลบไปแล้ว
ลบบัญชี
คุณสามารถลบผู้ใช้ปัจจุบันได้โดยออกคำขอ HTTP POST
ไปยังจุดสิ้นสุด Auth deleteAccount
วิธีการ: โพสต์
ประเภทเนื้อหา: application/json
จุดสิ้นสุดhttps://identitytoolkit.googleapis.com/v1/accounts:delete?key=[API_KEY]คำขอน้ำหนักบรรทุก
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
idToken | เชือก | โทเค็นรหัส Firebase ของผู้ใช้ที่จะลบ |
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|
คำขอตัวอย่าง
curl 'https://identitytoolkit.googleapis.com/v1/accounts:delete?key=[API_KEY]' \ -H 'Content-Type: application/json' --data-binary '{"idToken":"[FIREBASE_ID_TOKEN]"}'
คำขอที่สำเร็จจะแสดงด้วยรหัสสถานะ HTTP 200 OK
รหัสข้อผิดพลาดทั่วไป
- INVALID_ID_TOKEN:ข้อมูลประจำตัวของผู้ใช้ไม่ถูกต้องอีกต่อไป ผู้ใช้จะต้องลงชื่อเข้าใช้อีกครั้ง
- USER_NOT_FOUND: ไม่มีบันทึกผู้ใช้ที่สอดคล้องกับตัวระบุนี้ ผู้ใช้อาจถูกลบไปแล้ว
โปรแกรมจำลองการรับรองความถูกต้องของ Firebase
Firebase Local Emulator Suite มี โปรแกรมจำลองการตรวจสอบสิทธิ์ ซึ่งสามารถใช้สำหรับการสร้างต้นแบบในเครื่องและการทดสอบขั้นตอนการตรวจสอบสิทธิ์ โปรแกรมจำลองเปิดเผยจุดสิ้นสุด REST ต่อไปนี้
ล้างบัญชีผู้ใช้
ลบบัญชีทั้งหมดในโครงการที่ระบุ โดยไม่คำนึงถึงสถานะ
วิธีการ: ลบ
จุดสิ้นสุด โปรดทราบว่า 9099
เป็นพอร์ตเริ่มต้นสำหรับโปรแกรมจำลองการรับรองความถูกต้อง ตรวจสอบเอาต์พุตเทอร์มินัลสำหรับพอร์ตจริงที่ใช้งานอยู่
http://localhost:9099/emulator/v1/projects/{project-id}/accounts
รับการกำหนดค่าโปรแกรมจำลอง
รับการกำหนดค่าเฉพาะโปรแกรมจำลองสำหรับโปรเจ็กต์ที่ระบุ
วิธีการ: GET
จุดสิ้นสุด โปรดทราบว่า 9099
เป็นพอร์ตเริ่มต้นสำหรับโปรแกรมจำลองการรับรองความถูกต้อง ตรวจสอบเอาต์พุตเทอร์มินัลสำหรับพอร์ตจริงที่ใช้งานอยู่
http://localhost:9099/emulator/v1/projects/{project-id}/configเพย์โหลดการตอบสนอง
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
เข้าสู่ระบบ | วัตถุ | อ็อบเจ็กต์การกำหนดค่า signIn ที่มีคีย์เดียวคือ allowDuplicateEmails (บูลีน) |
การกำหนดค่าโปรแกรมจำลองแพทช์
อัปเดตการกำหนดค่าเฉพาะโปรแกรมจำลองสำหรับโปรเจ็กต์ที่ระบุ
วิธีการ: PATCH
จุดสิ้นสุด โปรดทราบว่า 9099
เป็นพอร์ตเริ่มต้นสำหรับโปรแกรมจำลองการรับรองความถูกต้อง ตรวจสอบเอาต์พุตเทอร์มินัลสำหรับพอร์ตจริงที่ใช้งานอยู่
ประเภทเนื้อหา: application/json
http://localhost:9099/emulator/v1/projects/{project-id}/configขอน้ำหนักบรรทุกของร่างกาย
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
เข้าสู่ระบบ | วัตถุ | ออบเจ็กต์การกำหนดค่า signIn ที่ต้องการด้วยคีย์เดียว allowDuplicateEmails (บูลีน) |
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
เข้าสู่ระบบ | วัตถุ | วัตถุการกำหนดค่าการลงชื่อเข้าใช้ Post-REQUEST พร้อมคีย์เดี่ยว allowDuplicateEmails (บูลีน) |
ดึงรหัสการรับรองความถูกต้องนอกวงดนตรี
หากการตรวจสอบความถูกต้องคุณกำลังทดสอบโดยปกติจะสร้างรหัสนอกแบนด์ (เช่นรหัสการตรวจสอบอีเมลรหัสรีเซ็ตรหัสผ่าน) ตัวจำลองจะเก็บรหัสดังกล่าวภายในจนกว่าจะมีการใช้งาน
วิธี: รับ
จุดสิ้นสุด โปรดทราบว่า 9099
เป็นพอร์ตเริ่มต้นสำหรับตัวจำลองการรับรองความถูกต้อง ตรวจสอบเอาต์พุตเทอร์มินัลสำหรับพอร์ตจริงที่ใช้
http://localhost:9099/emulator/v1/projects/{project-id}/oobCodespayload คำตอบ
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
oobcodes | อาร์เรย์ | อาร์เรย์ของวัตถุที่มีรายละเอียดของรหัสการยืนยันที่ค้างอยู่ทั้งหมด แต่ละวัตถุมี email (สตริง), oobCode (สตริง), oobLink (สตริง) และ requestType (สตริง) |
ดึงรหัสการตรวจสอบ SMS
หากคุณกำลังทดสอบกระแสการรับรองความถูกต้องของโทรศัพท์/SMS Emulator จะจัดเก็บรหัส SMS ดังกล่าวภายในจนกว่าจะมีการใช้งาน
วิธี: รับ
จุดสิ้นสุด โปรดทราบว่า 9099
เป็นพอร์ตเริ่มต้นสำหรับตัวจำลองการรับรองความถูกต้อง ตรวจสอบเอาต์พุตเทอร์มินัลสำหรับพอร์ตจริงที่ใช้
http://localhost:9099/emulator/v1/projects/{project-id}/verificationCodespayload คำตอบ
ชื่อคุณสมบัติ | พิมพ์ | คำอธิบาย |
---|---|---|
รหัสตรวจสอบ | อาร์เรย์ | อาร์เรย์ของวัตถุที่มีรายละเอียดของรหัสการตรวจสอบที่ค้างอยู่ทั้งหมด แต่ละวัตถุมี phoneNumber (สตริง) และ sessionCode (สตริง) |
การตอบกลับข้อผิดพลาด
รูปแบบการตอบกลับข้อผิดพลาด
เมื่อใดก็ตามที่ข้อผิดพลาดจะถูกส่งคืนจากเซิร์ฟเวอร์แบ็กเอนด์สำหรับ API ใด ๆ ด้านบนการตอบกลับจะมีรูปแบบต่อไปนี้
การตอบสนองตัวอย่าง
{ "error": { "errors": [ { "domain": "global", "reason": "invalid", "message": "CREDENTIAL_TOO_OLD_LOGIN_AGAIN" } ], "code": 400, "message": "CREDENTIAL_TOO_OLD_LOGIN_AGAIN" } }
รหัสข้อผิดพลาดได้จากฟิลด์ข้อความ รหัสข้อผิดพลาดทั้งหมดข้างต้นอ้างถึงเนื้อหาฟิลด์ข้อความ