API ของ REST สำหรับการตรวจสอบสิทธิ์ของ Firebase

การใช้ API

คุณค้นหาแบ็กเอนด์การตรวจสอบสิทธิ์ Firebase ผ่านทาง REST API ได้ ซึ่งสามารถใช้สำหรับการดำเนินการต่างๆ เช่น เป็นการสร้างผู้ใช้ใหม่ การลงชื่อเข้าใช้ผู้ใช้ที่มีอยู่ และแก้ไขหรือลบผู้ใช้เหล่านี้

API_KEY ทั้งหมดหมายถึงคีย์ API ของเว็บ ซึ่งสามารถดูได้ที่ การตั้งค่าโปรเจ็กต์ ในคอนโซลผู้ดูแลระบบของคุณ

แลกเปลี่ยนโทเค็นที่กำหนดเองสำหรับรหัสและโทเค็นการรีเฟรช

คุณสามารถแลกเปลี่ยนโทเค็นการตรวจสอบสิทธิ์ที่กำหนดเองสำหรับรหัสและโทเค็นการรีเฟรชได้ด้วยการออก HTTP คำขอ POST ไปยังปลายทางการตรวจสอบสิทธิ์ verifyCustomToken

เมธอด: POST

ประเภทเนื้อหา: application/json

ปลายทาง 
https://identitytoolkit.googleapis.com/v1/accounts:signInWithCustomToken?key=[API_KEY]
เพย์โหลดเนื้อความของคำขอ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
โทเค็น สตริง โทเค็นที่กำหนดเองของการตรวจสอบสิทธิ์ Firebase ที่จะใช้สร้างคู่รหัสและรีเฟรชโทเค็น
ReturnSecureToken boolean จะแสดงผลรหัสและโทเค็นการรีเฟรชหรือไม่ ควรเป็นจริงเสมอ
เพย์โหลดการตอบกลับ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
โทเค็นรหัส สตริง โทเค็นรหัสการตรวจสอบสิทธิ์ Firebase ที่สร้างขึ้นจากโทเค็นที่กำหนดเองที่ระบุ
RefreshToken สตริง โทเค็นการรีเฟรช Firebase Auth ที่สร้างขึ้นจากโทเค็นที่กำหนดเองที่ระบุ
หมดอายุภายใน สตริง จำนวนวินาทีที่โทเค็นรหัสหมดอายุ

ตัวอย่างคำขอ 

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

คำขอที่สำเร็จจะระบุด้วย 200 OK HTTP รหัสสถานะ การตอบกลับจะมีโทเค็นรหัส Firebase และโทเค็นการรีเฟรชที่เชื่อมโยงอยู่ ด้วยโทเค็นที่กำหนดเอง

ตัวอย่างคำตอบ 

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

รหัสข้อผิดพลาดที่พบบ่อย

  • INVALID_CUSTOM_TOKEN: รูปแบบโทเค็นที่กำหนดเองไม่ถูกต้อง หรือโทเค็นไม่ถูกต้องสำหรับ เหตุผลบางอย่าง (เช่น หมดอายุ ลายเซ็นไม่ถูกต้อง ฯลฯ)
  • CREDENTIAL_MISMATCH: โทเค็นที่กำหนดเองสอดคล้องกับโปรเจ็กต์ Firebase อื่น

แลกเปลี่ยนโทเค็นการรีเฟรชกับโทเค็นรหัส

คุณสามารถรีเฟรชโทเค็นรหัส Firebase ได้โดยออก HTTP คำขอ POST ไปยังปลายทาง securetoken.googleapis.com

เมธอด: POST

ประเภทเนื้อหา:application/x-www-form-urlencrypted

ปลายทาง 
https://securetoken.googleapis.com/v1/token?key=[API_KEY]
เพย์โหลดเนื้อความของคำขอ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
grant_type สตริง ประเภทการให้สิทธิ์ของโทเค็นการรีเฟรชจะเป็น "refresh_token" เสมอ
โทเค็นการรีเฟรช สตริง โทเค็นการรีเฟรช Firebase Auth
เพย์โหลดการตอบกลับ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
expires_in สตริง จำนวนวินาทีที่โทเค็นรหัสหมดอายุ
token_type สตริง ประเภทของโทเค็นการรีเฟรชเป็น "Bearer" เสมอ
โทเค็นการรีเฟรช สตริง โทเค็นการรีเฟรช Firebase Auth ที่ระบุไว้ในคำขอหรือโทเค็นการรีเฟรชใหม่
โทเค็นรหัส สตริง โทเค็นรหัสการตรวจสอบสิทธิ์ Firebase
user_id สตริง uid ที่เกี่ยวข้องกับโทเค็นรหัสที่ระบุ
รหัสโปรเจ็กต์ สตริง รหัสโปรเจ็กต์ 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]'

คำขอที่สำเร็จจะระบุด้วย 200 OK HTTP รหัสสถานะ การตอบกลับจะมีโทเค็นรหัส Firebase ใหม่และโทเค็นการรีเฟรช

ตัวอย่างคำตอบ 

{
  "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 ไปยังปลายทางการตรวจสอบสิทธิ์ signupNewUser

เมธอด: POST

ประเภทเนื้อหา: application/json

ปลายทาง 
https://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]
เพย์โหลดเนื้อความของคำขอ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
อีเมล สตริง อีเมลสำหรับให้ผู้ใช้สร้าง
รหัสผ่าน สตริง รหัสผ่านที่ผู้ใช้จะสร้าง
ReturnSecureToken boolean จะแสดงผลรหัสและโทเค็นการรีเฟรชหรือไม่ ควรเป็นจริงเสมอ
เพย์โหลดการตอบกลับ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
โทเค็นรหัส สตริง โทเค็นรหัสการตรวจสอบสิทธิ์ Firebase สำหรับผู้ใช้ที่สร้างใหม่
อีเมล สตริง อีเมลสำหรับผู้ใช้ที่สร้างใหม่
RefreshToken สตริง โทเค็นการรีเฟรช Firebase Auth สำหรับผู้ใช้ที่สร้างใหม่
หมดอายุภายใน สตริง จำนวนวินาทีที่โทเค็นรหัสหมดอายุ
รหัสท้องถิ่น สตริง 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}'

คำขอที่สำเร็จจะระบุด้วย 200 OK HTTP รหัสสถานะ การตอบกลับจะมีโทเค็นรหัส Firebase และโทเค็นการรีเฟรชที่เชื่อมโยงอยู่ ด้วยบัญชีใหม่ดังกล่าว

ตัวอย่างคำตอบ 

{
  "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 ไปยังปลายทางการตรวจสอบสิทธิ์ verifyPassword

เมธอด: POST

ประเภทเนื้อหา: application/json

ปลายทาง 
https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key=[API_KEY]
เพย์โหลดเนื้อความของคำขอ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
อีเมล สตริง อีเมลที่ผู้ใช้ใช้ลงชื่อเข้าใช้
รหัสผ่าน สตริง รหัสผ่านของบัญชี
ReturnSecureToken boolean จะแสดงผลรหัสและโทเค็นการรีเฟรชหรือไม่ ควรเป็นจริงเสมอ
เพย์โหลดการตอบกลับ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
โทเค็นรหัส สตริง โทเค็นรหัสการตรวจสอบสิทธิ์ Firebase สำหรับผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว
อีเมล สตริง อีเมลสำหรับผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว
RefreshToken สตริง โทเค็นการรีเฟรช Firebase Auth สำหรับผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว
หมดอายุภายใน สตริง จำนวนวินาทีที่โทเค็นรหัสหมดอายุ
รหัสท้องถิ่น สตริง UID ของผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว
ลงทะเบียนแล้ว boolean อีเมลนี้ใช้สำหรับบัญชีที่มีอยู่หรือไม่

ตัวอย่างคำขอ 

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

คำขอที่สำเร็จจะระบุด้วย 200 OK HTTP รหัสสถานะ การตอบกลับจะมีโทเค็นรหัส Firebase และโทเค็นการรีเฟรชที่เชื่อมโยงอยู่ ด้วยบัญชีอีเมล/รหัสผ่านที่มีอยู่

ตัวอย่างคำตอบ 

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

รหัสข้อผิดพลาดที่พบบ่อย

  • EMAIL_NOT_FOUND: ไม่มีบันทึกผู้ใช้ที่เกี่ยวข้องกับตัวระบุนี้ ผู้ใช้สามารถ ลบ แล้ว
  • ค่าธรรมเนียมไม่ถูกต้อง: รหัสผ่านไม่ถูกต้องหรือผู้ใช้ไม่มีรหัสผ่าน
  • USER_DISABLED: บัญชีผู้ใช้ถูกปิดใช้งานโดยผู้ดูแลระบบ

ลงชื่อเข้าใช้โดยไม่ระบุชื่อ

คุณสามารถลงชื่อเข้าใช้โดยไม่ระบุชื่อผู้ใช้ได้โดยออก HTTP คำขอ POST ไปยังปลายทางการตรวจสอบสิทธิ์ signupNewUser

เมธอด: POST

ประเภทเนื้อหา: application/json

ปลายทาง 
https://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]
เพย์โหลดเนื้อความของคำขอ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
ReturnSecureToken boolean จะแสดงผลรหัสและโทเค็นการรีเฟรชหรือไม่ ควรเป็นจริงเสมอ
เพย์โหลดการตอบกลับ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
โทเค็นรหัส สตริง โทเค็นรหัสการตรวจสอบสิทธิ์ Firebase สำหรับผู้ใช้ที่สร้างใหม่
อีเมล สตริง ค่านี้ควรว่างเปล่าเนื่องจากผู้ใช้ไม่ระบุชื่อ
RefreshToken สตริง โทเค็นการรีเฟรช Firebase Auth สำหรับผู้ใช้ที่สร้างใหม่
หมดอายุภายใน สตริง จำนวนวินาทีที่โทเค็นรหัสหมดอายุ
รหัสท้องถิ่น สตริง UID ของผู้ใช้ที่สร้างใหม่

ตัวอย่างคำขอ 

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

คำขอที่สำเร็จจะระบุด้วย 200 OK HTTP รหัสสถานะ การตอบกลับจะมีโทเค็นรหัส Firebase และโทเค็นการรีเฟรชที่เชื่อมโยงอยู่ กับผู้ใช้ที่ไม่ระบุชื่อ

ตัวอย่างคำตอบ 

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

รหัสข้อผิดพลาดที่พบบ่อย

  • OPERATION_NOT_ALLOWED: โปรเจ็กต์นี้ปิดใช้การลงชื่อเข้าใช้ที่ไม่ระบุชื่อของผู้ใช้

ลงชื่อเข้าใช้ด้วยข้อมูลเข้าสู่ระบบ OAuth

คุณลงชื่อเข้าใช้ผู้ใช้ด้วยข้อมูลเข้าสู่ระบบ OAuth ได้โดยออก HTTP คำขอ POST ไปยังปลายทางการตรวจสอบสิทธิ์ verifyAssertion

เมธอด: POST

ประเภทเนื้อหา: application/json

ปลายทาง 
https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]
เพย์โหลดเนื้อความของคำขอ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
คำขอ Uri สตริง URI ที่ IdP จะเปลี่ยนเส้นทางผู้ใช้กลับไป
เนื้อความ สตริง มีข้อมูลเข้าสู่ระบบ OAuth (โทเค็นรหัสหรือโทเค็นเพื่อการเข้าถึง) และรหัสผู้ให้บริการที่มีปัญหา การรับรอง
ReturnSecureToken boolean จะแสดงผลรหัสและโทเค็นการรีเฟรชหรือไม่ ควรเป็นจริงเสมอ
ReturnIdpCredential boolean กำหนดว่าจะบังคับส่งกลับข้อมูลเข้าสู่ระบบ OAuth เมื่อมีข้อผิดพลาดต่อไปนี้หรือไม่ FEDERATED_USER_ID_ALREADY_LINKED และ EMAIL_EXISTS
เพย์โหลดการตอบกลับ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
รหัสแบบรวมศูนย์ สตริง รหัสที่ไม่ซ้ำกันจะระบุบัญชี IdP
รหัสผู้ให้บริการ สตริง รหัสผู้ให้บริการที่ลิงก์ไว้ (เช่น "google.com" สำหรับผู้ให้บริการ Google)
รหัสท้องถิ่น สตริง UID ของผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว
ยืนยันด้วยอีเมลแล้ว boolean อีเมลสำหรับลงชื่อเข้าใช้ได้รับการยืนยันแล้วหรือไม่
อีเมล สตริง อีเมลของบัญชี
oauthIdToken สตริง โทเค็นรหัส OIDC หากมี
oauthAccessToken สตริง โทเค็นเพื่อการเข้าถึง OAuth ถ้ามี
oauthTokenSecret สตริง ข้อมูลลับของโทเค็น OAuth 1.0 ถ้ามี
ข้อมูลดิบผู้ใช้ สตริง การตอบกลับ JSON ในรูปแบบสตริงที่มีข้อมูล IdP ทั้งหมดที่สอดคล้องกับ ข้อมูลเข้าสู่ระบบ OAuth
ชื่อ สตริง ชื่อจริงของบัญชี
นามสกุล สตริง นามสกุลของบัญชี
ชื่อและนามสกุล สตริง ชื่อและนามสกุลของบัญชี
displayName สตริง ชื่อที่แสดงของบัญชี
URL รูปภาพ สตริง URL รูปภาพสำหรับบัญชี
โทเค็นรหัส สตริง โทเค็นรหัสการตรวจสอบสิทธิ์ Firebase สำหรับผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว
RefreshToken สตริง โทเค็นการรีเฟรช Firebase Auth สำหรับผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว
หมดอายุภายใน สตริง จำนวนวินาทีที่โทเค็นรหัสหมดอายุ
ต้องการการยืนยัน boolean มีบัญชีอื่นที่ใช้ข้อมูลเข้าสู่ระบบเดียวกันอยู่แล้วหรือไม่ ผู้ใช้ต้อง เพื่อลงชื่อเข้าใช้บัญชีเดิมแล้วลิงก์ข้อมูลเข้าสู่ระบบปัจจุบันกับบัญชีนั้น

ตัวอย่างคำขอที่มีโทเค็นรหัส 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}'

คำขอที่สำเร็จจะระบุด้วย 200 OK HTTP รหัสสถานะ การตอบกลับจะมีโทเค็นรหัส Firebase และโทเค็นการรีเฟรชที่เชื่อมโยงอยู่ กับผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว

ตัวอย่างการตอบกลับที่มีโทเค็นรหัส 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\", ...}"
}

ตัวอย่างคำขอที่มีโทเค็นเพื่อการเข้าถึง 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}'

คำขอที่สำเร็จจะระบุด้วย 200 OK HTTP รหัสสถานะ การตอบกลับจะมีโทเค็นรหัส Firebase และโทเค็นการรีเฟรชที่เชื่อมโยงอยู่ กับผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว

ตัวอย่างการตอบกลับด้วยโทเค็นเพื่อการเข้าถึง 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\", ...}"
}

คำขอตัวอย่างที่มีข้อมูลเข้าสู่ระบบ OAuth 1.0 ของ Twitter 

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

คำขอที่สำเร็จจะระบุด้วย 200 OK HTTP รหัสสถานะ การตอบกลับจะมีโทเค็นรหัส Firebase และโทเค็นการรีเฟรชที่เชื่อมโยงอยู่ กับผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว

คำตอบตัวอย่างที่มีข้อมูลเข้าสู่ระบบ OAuth 1.0 ของ Twitter 

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

รหัสข้อผิดพลาดที่พบบ่อย

  • OPERATION_NOT_ALLOWED: ผู้ให้บริการที่เกี่ยวข้องปิดใช้อยู่สำหรับโปรเจ็กต์นี้
  • INVALID_IDP_RESPONSE: ข้อมูลเข้าสู่ระบบการตรวจสอบสิทธิ์ที่ระบุมีรูปแบบไม่ถูกต้องหรือหมดอายุแล้ว

ดึงข้อมูลผู้ให้บริการสำหรับอีเมล

คุณดูผู้ให้บริการทั้งหมดที่เชื่อมโยงกับอีเมลที่ระบุได้โดยออก HTTP คำขอ POST ไปยังปลายทางการตรวจสอบสิทธิ์ createAuthUri

เมธอด: POST

ประเภทเนื้อหา: application/json

ปลายทาง 
https://identitytoolkit.googleapis.com/v1/accounts:createAuthUri?key=[API_KEY]
เพย์โหลดเนื้อความของคำขอ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
ตัวระบุ สตริง อีเมลของผู้ใช้
ContinueUri สตริง URI ที่ IdP จะเปลี่ยนเส้นทางผู้ใช้กลับไป สำหรับกรณีการใช้งานนี้ URL ปัจจุบัน
เพย์โหลดการตอบกลับ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
allProviders รายการสตริง รายชื่อผู้ให้บริการที่ผู้ใช้เคยลงชื่อเข้าใช้ก่อนหน้านี้
ลงทะเบียนแล้ว boolean อีเมลนี้ใช้สำหรับบัญชีที่มีอยู่หรือไม่

ตัวอย่างคำขอ 

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

คำขอที่สำเร็จจะระบุด้วย 200 OK HTTP รหัสสถานะ อีเมลตอบกลับจะมีรายชื่อผู้ให้บริการที่เชื่อมโยงกับอีเมลนั้น

ตัวอย่างคำตอบ 

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

รหัสข้อผิดพลาดที่พบบ่อย

  • INVALID_EMAIL: ที่อยู่อีเมลอยู่ในรูปแบบที่ไม่ถูกต้อง

ส่งอีเมลรีเซ็ตรหัสผ่าน

คุณสามารถส่งอีเมลรีเซ็ตรหัสผ่านโดยออก HTTP คำขอ POST ไปยังปลายทางการตรวจสอบสิทธิ์ getOobConfirmationCode

เมธอด: POST

ประเภทเนื้อหา: application/json

ปลายทาง 
https://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]
ส่วนหัวที่ไม่บังคับ
ชื่อพร็อพเพอร์ตี้ คำอธิบาย
ภาษา X-Firebase รหัสภาษาที่สอดคล้องกับภาษาของผู้ใช้ การส่งผ่านนี้จะเป็นการแปล ส่งอีเมลรีเซ็ตรหัสผ่านไปยังผู้ใช้แล้ว
เพย์โหลดเนื้อความของคำขอ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
requestType สตริง ประเภทของรหัส 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 ไปยังปลายทางการตรวจสอบสิทธิ์ resetPassword

เมธอด: POST

ประเภทเนื้อหา: application/json

ปลายทาง 
https://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]
เพย์โหลดเนื้อความของคำขอ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
รหัส oob สตริง รหัสการดำเนินการกับอีเมลที่ส่งไปยังอีเมลของผู้ใช้เพื่อรีเซ็ตรหัสผ่าน
เพย์โหลดการตอบกลับ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
อีเมล สตริง อีเมลของผู้ใช้
requestType สตริง ประเภทของรหัสการดำเนินการกับอีเมล ควรเป็น "PASSWORD_RESET"

ตัวอย่างคำขอ 

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

คำขอที่สำเร็จจะระบุด้วย 200 OK HTTP รหัสสถานะ

ตัวอย่างคำตอบ 

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

รหัสข้อผิดพลาดที่พบบ่อย

  • OPERATION_NOT_ALLOWED: การลงชื่อเข้าใช้ด้วยรหัสผ่านสำหรับโปรเจ็กต์นี้ถูกปิดใช้
  • EXPIRED_OOB_CODE: รหัสการกระทำหมดอายุแล้ว
  • INVALID_OOB_CODE: รหัสการดำเนินการไม่ถูกต้อง กรณีนี้อาจเกิดขึ้นหากโค้ดผิดรูปแบบ หมดอายุ หรือถูกใช้ไปแล้ว

ยืนยันการรีเซ็ตรหัสผ่าน

คุณสามารถใช้การเปลี่ยนการรีเซ็ตรหัสผ่านได้โดยการออก HTTP คำขอ POST ไปยังปลายทางการตรวจสอบสิทธิ์ resetPassword

เมธอด: POST

ประเภทเนื้อหา: application/json

ปลายทาง 
https://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]
เพย์โหลดเนื้อความของคำขอ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
รหัส oob สตริง รหัสการดำเนินการกับอีเมลที่ส่งไปยังอีเมลของผู้ใช้เพื่อรีเซ็ตรหัสผ่าน
รหัสผ่านใหม่ สตริง รหัสผ่านใหม่ของผู้ใช้
เพย์โหลดการตอบกลับ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
อีเมล สตริง อีเมลของผู้ใช้
requestType สตริง ประเภทของรหัสการดำเนินการกับอีเมล ควรเป็น "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]"}'

คำขอที่สำเร็จจะระบุด้วย 200 OK HTTP รหัสสถานะ

ตัวอย่างคำตอบ 

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

รหัสข้อผิดพลาดที่พบบ่อย

  • OPERATION_NOT_ALLOWED: การลงชื่อเข้าใช้ด้วยรหัสผ่านสำหรับโปรเจ็กต์นี้ถูกปิดใช้
  • EXPIRED_OOB_CODE: รหัสการกระทำหมดอายุแล้ว
  • INVALID_OOB_CODE: รหัสการดำเนินการไม่ถูกต้อง กรณีนี้อาจเกิดขึ้นหากโค้ดผิดรูปแบบ หมดอายุ หรือถูกใช้ไปแล้ว
  • USER_DISABLED: บัญชีผู้ใช้ถูกปิดใช้งานโดยผู้ดูแลระบบ

เปลี่ยนอีเมล

คุณสามารถเปลี่ยนอีเมลของผู้ใช้ได้ด้วยการออก HTTP คำขอ POST ไปยังปลายทางการตรวจสอบสิทธิ์ setAccountInfo

เมธอด: POST

ประเภทเนื้อหา: application/json

ปลายทาง 
https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]
ส่วนหัวที่ไม่บังคับ
ชื่อพร็อพเพอร์ตี้ คำอธิบาย
ภาษา X-Firebase รหัสภาษาที่สอดคล้องกับภาษาของผู้ใช้ การส่งผ่านนี้จะเป็นการแปล ส่งการเพิกถอนการเปลี่ยนแปลงอีเมลถึงผู้ใช้แล้ว
เพย์โหลดเนื้อความของคำขอ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
โทเค็นรหัส สตริง โทเค็นรหัสการตรวจสอบสิทธิ์ Firebase สำหรับผู้ใช้
อีเมล สตริง อีเมลใหม่ของผู้ใช้
ReturnSecureToken boolean จะแสดงผลรหัสและโทเค็นการรีเฟรชหรือไม่
เพย์โหลดการตอบกลับ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
รหัสท้องถิ่น สตริง UID ของผู้ใช้ปัจจุบัน
อีเมล สตริง อีเมลของผู้ใช้
แฮชรหัสผ่าน สตริง เวอร์ชันแฮชของรหัสผ่าน
ข้อมูลผู้ใช้ของผู้ให้บริการ รายการออบเจ็กต์ JSON รายการออบเจ็กต์ผู้ให้บริการที่ลิงก์ทั้งหมดซึ่งมี "providerId" และ "federatedId"
โทเค็นรหัส สตริง โทเค็นรหัสการตรวจสอบสิทธิ์ Firebase ใหม่สำหรับผู้ใช้
RefreshToken สตริง โทเค็นการรีเฟรช Firebase Auth
หมดอายุภายใน สตริง จำนวนวินาทีที่โทเค็นรหัสหมดอายุ

ตัวอย่างคำขอ 

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 ใหม่และโทเค็นการรีเฟรชที่เชื่อมโยงอยู่ กับผู้ใช้

ตัวอย่างคำตอบ 

{
  "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 ไปยังปลายทางการตรวจสอบสิทธิ์ setAccountInfo

เมธอด: POST

ประเภทเนื้อหา: application/json

ปลายทาง 
https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]
เพย์โหลดเนื้อความของคำขอ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
โทเค็นรหัส สตริง โทเค็นรหัสการตรวจสอบสิทธิ์ Firebase สำหรับผู้ใช้
รหัสผ่าน สตริง รหัสผ่านใหม่ของผู้ใช้
ReturnSecureToken boolean จะแสดงผลรหัสและโทเค็นการรีเฟรชหรือไม่
เพย์โหลดการตอบกลับ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
รหัสท้องถิ่น สตริง UID ของผู้ใช้ปัจจุบัน
อีเมล สตริง อีเมลของผู้ใช้
แฮชรหัสผ่าน สตริง เวอร์ชันแฮชของรหัสผ่าน
ข้อมูลผู้ใช้ของผู้ให้บริการ รายการออบเจ็กต์ JSON รายการออบเจ็กต์ผู้ให้บริการที่ลิงก์ทั้งหมดซึ่งมี "providerId" และ "federatedId"
โทเค็นรหัส สตริง โทเค็นรหัสการตรวจสอบสิทธิ์ Firebase ใหม่สำหรับผู้ใช้
RefreshToken สตริง โทเค็นการรีเฟรช Firebase Auth
หมดอายุภายใน สตริง จำนวนวินาทีที่โทเค็นรหัสหมดอายุ

ตัวอย่างคำขอ 

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

คำขอที่สำเร็จจะระบุด้วย 200 OK HTTP รหัสสถานะ การตอบกลับจะมีโทเค็นรหัส Firebase ใหม่และโทเค็นการรีเฟรชที่เชื่อมโยงอยู่ กับผู้ใช้

ตัวอย่างคำตอบ 

{
  "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 ไปยังปลายทางการตรวจสอบสิทธิ์ setAccountInfo

เมธอด: POST

ประเภทเนื้อหา: application/json

ปลายทาง 
https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]
เพย์โหลดเนื้อความของคำขอ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
โทเค็นรหัส สตริง โทเค็นรหัสการตรวจสอบสิทธิ์ Firebase สำหรับผู้ใช้
displayName สตริง ชื่อที่แสดงใหม่ของผู้ใช้
URL รูปภาพ สตริง URL รูปภาพใหม่ของผู้ใช้
ลบแอตทริบิวต์ รายการสตริง รายการแอตทริบิวต์ที่จะลบ "DISPLAY_NAME" หรือ "PHOTO_URL" การดำเนินการนี้จะทำให้ตัวเลือกเหล่านี้เป็นโมฆะ
ReturnSecureToken boolean จะแสดงผลรหัสและโทเค็นการรีเฟรชหรือไม่
เพย์โหลดการตอบกลับ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
รหัสท้องถิ่น สตริง UID ของผู้ใช้ปัจจุบัน
อีเมล สตริง อีเมลของผู้ใช้
displayName สตริง ชื่อที่แสดงใหม่ของผู้ใช้
URL รูปภาพ สตริง URL รูปภาพใหม่ของผู้ใช้
แฮชรหัสผ่าน สตริง เวอร์ชันแฮชของรหัสผ่าน
ข้อมูลผู้ใช้ของผู้ให้บริการ รายการออบเจ็กต์ JSON รายการออบเจ็กต์ผู้ให้บริการที่ลิงก์ทั้งหมดซึ่งมี "providerId" และ "federatedId"
โทเค็นรหัส สตริง โทเค็นรหัสการตรวจสอบสิทธิ์ Firebase ใหม่สำหรับผู้ใช้
RefreshToken สตริง โทเค็นการรีเฟรช Firebase Auth
หมดอายุภายใน สตริง จำนวนวินาทีที่โทเค็นรหัสหมดอายุ

ตัวอย่างคำขอ 

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

คำขอที่สำเร็จจะระบุด้วย 200 OK HTTP รหัสสถานะ

ตัวอย่างคำตอบ 

{
  "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 ไปยังปลายทางการตรวจสอบสิทธิ์ getAccountInfo

เมธอด: POST

ประเภทเนื้อหา: application/json

ปลายทาง 
https://identitytoolkit.googleapis.com/v1/accounts:lookup?key=[API_KEY]
เพย์โหลดเนื้อความของคำขอ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
โทเค็นรหัส สตริง โทเค็นรหัส Firebase ของบัญชี
เพย์โหลดการตอบกลับ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
ผู้ใช้ รายการออบเจ็กต์ JSON บัญชีที่เชื่อมโยงกับโทเค็นรหัส Firebase ที่ระบุ ดูข้อมูลเพิ่มเติมได้ที่ด้านล่าง รายละเอียด
เพย์โหลดการตอบกลับ (เนื้อหาอาร์เรย์ users)
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
รหัสท้องถิ่น สตริง UID ของผู้ใช้ปัจจุบัน
อีเมล สตริง อีเมลของบัญชี
ยืนยันด้วยอีเมลแล้ว boolean อีเมลของบัญชีนี้ได้รับการยืนยันแล้วหรือไม่
displayName สตริง ชื่อที่แสดงของบัญชี
ข้อมูลผู้ใช้ของผู้ให้บริการ รายการออบเจ็กต์ JSON รายการออบเจ็กต์ผู้ให้บริการที่ลิงก์ทั้งหมดซึ่งมี "providerId" และ "federatedId"
URL รูปภาพ สตริง URL รูปภาพสำหรับบัญชี
แฮชรหัสผ่าน สตริง เวอร์ชันแฮชของรหัสผ่าน
อัปเดตรหัสผ่านเมื่อ double การประทับเวลาในหน่วยมิลลิวินาทีที่มีการเปลี่ยนรหัสผ่านบัญชีครั้งล่าสุด
ถูกต้องตั้งแต่ สตริง การประทับเวลาในหน่วยวินาทีซึ่งจะทำเครื่องหมายขอบเขตก่อนโทเค็นรหัส Firebase ถูกเพิกถอน
ปิดใช้อยู่ boolean บัญชีถูกปิดใช้งานหรือไม่
เข้าสู่ระบบครั้งล่าสุดที่ สตริง การประทับเวลามีหน่วยเป็นมิลลิวินาทีที่บัญชีเข้าสู่ระบบครั้งล่าสุด
สร้างเมื่อ สตริง การประทับเวลาในหน่วยมิลลิวินาทีที่สร้างบัญชี
การตรวจสอบสิทธิ์ที่กำหนดเอง boolean นักพัฒนาแอปตรวจสอบสิทธิ์บัญชีแล้วหรือไม่

ตัวอย่างคำขอ 

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 ไปยังปลายทางการตรวจสอบสิทธิ์ setAccountInfo

เมธอด: POST

ประเภทเนื้อหา: application/json

ปลายทาง 
https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]
เพย์โหลดเนื้อความของคำขอ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
โทเค็นรหัส สตริง โทเค็นรหัส Firebase ของบัญชีที่คุณพยายามลิงก์ข้อมูลเข้าสู่ระบบ
อีเมล สตริง อีเมลที่จะลิงก์กับบัญชี
รหัสผ่าน สตริง รหัสผ่านใหม่ของบัญชี
ReturnSecureToken สตริง จะแสดงผลรหัสและโทเค็นการรีเฟรชหรือไม่ ควรเป็นจริงเสมอ
เพย์โหลดการตอบกลับ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
รหัสท้องถิ่น สตริง UID ของผู้ใช้ปัจจุบัน
อีเมล สตริง อีเมลของบัญชี
displayName สตริง ชื่อที่แสดงของบัญชี
URL รูปภาพ สตริง URL รูปภาพสำหรับบัญชี
แฮชรหัสผ่าน สตริง เวอร์ชันแฮชของรหัสผ่าน
ข้อมูลผู้ใช้ของผู้ให้บริการ รายการออบเจ็กต์ JSON รายการออบเจ็กต์ผู้ให้บริการที่ลิงก์ทั้งหมดซึ่งมี "providerId" และ "federatedId"
ยืนยันด้วยอีเมลแล้ว boolean อีเมลของบัญชีนี้ได้รับการยืนยันแล้วหรือไม่
โทเค็นรหัส สตริง โทเค็นรหัสการตรวจสอบสิทธิ์ Firebase ใหม่สำหรับผู้ใช้
RefreshToken สตริง โทเค็นการรีเฟรช Firebase Auth
หมดอายุภายใน สตริง จำนวนวินาทีที่โทเค็นรหัสหมดอายุ

ตัวอย่างคำขอ 

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

คำขอที่สำเร็จจะระบุด้วย 200 OK HTTP รหัสสถานะ การตอบกลับจะมีโทเค็นรหัส Firebase และโทเค็นการรีเฟรชที่เชื่อมโยงกับ ผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว

ตัวอย่างคำตอบ 

{
  "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 กับผู้ใช้ได้โดยการออก HTTP คำขอ POST ไปยังปลายทางการตรวจสอบสิทธิ์ verifyAssertion

เมธอด: POST

ประเภทเนื้อหา: application/json

ปลายทาง 
https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]
เพย์โหลดเนื้อความของคำขอ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
โทเค็นรหัส สตริง โทเค็นรหัส Firebase ของบัญชีที่คุณพยายามลิงก์ข้อมูลเข้าสู่ระบบ
คำขอ Uri สตริง URI ที่ IdP จะเปลี่ยนเส้นทางผู้ใช้กลับไป
เนื้อความ สตริง มีข้อมูลเข้าสู่ระบบ OAuth (โทเค็นรหัสหรือโทเค็นเพื่อการเข้าถึง) และรหัสผู้ให้บริการที่มีปัญหา การรับรอง
ReturnSecureToken boolean จะแสดงผลรหัสและโทเค็นการรีเฟรชหรือไม่ ควรเป็นจริงเสมอ
ReturnIdpCredential boolean กำหนดว่าจะบังคับส่งกลับข้อมูลเข้าสู่ระบบ OAuth เมื่อมีข้อผิดพลาดต่อไปนี้หรือไม่ FEDERATED_USER_ID_ALREADY_LINKED และ EMAIL_EXISTS
เพย์โหลดการตอบกลับ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
รหัสแบบรวมศูนย์ สตริง รหัสที่ไม่ซ้ำกันจะระบุบัญชี IdP
รหัสผู้ให้บริการ สตริง รหัสผู้ให้บริการที่ลิงก์ไว้ (เช่น "google.com" สำหรับผู้ให้บริการ Google)
รหัสท้องถิ่น สตริง UID ของผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว
ยืนยันด้วยอีเมลแล้ว boolean อีเมลสำหรับลงชื่อเข้าใช้ได้รับการยืนยันแล้วหรือไม่
อีเมล สตริง อีเมลของบัญชี
oauthIdToken สตริง โทเค็นรหัส OIDC หากมี
oauthAccessToken สตริง โทเค็นเพื่อการเข้าถึง OAuth ถ้ามี
oauthTokenSecret สตริง ข้อมูลลับของโทเค็น OAuth 1.0 ถ้ามี
ข้อมูลดิบผู้ใช้ สตริง การตอบกลับ JSON ในรูปแบบสตริงที่มีข้อมูล IdP ทั้งหมดที่สอดคล้องกับ ข้อมูลเข้าสู่ระบบ OAuth
ชื่อ สตริง ชื่อจริงของบัญชี
นามสกุล สตริง นามสกุลของบัญชี
ชื่อและนามสกุล สตริง ชื่อและนามสกุลของบัญชี
displayName สตริง ชื่อที่แสดงของบัญชี
URL รูปภาพ สตริง URL รูปภาพสำหรับบัญชี
โทเค็นรหัส สตริง โทเค็นรหัสการตรวจสอบสิทธิ์ Firebase สำหรับผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว
RefreshToken สตริง โทเค็นการรีเฟรช Firebase Auth สำหรับผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว
หมดอายุภายใน สตริง จำนวนวินาทีที่โทเค็นรหัสหมดอายุ

ตัวอย่างคำขอที่มีโทเค็นรหัส 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}'

คำขอที่สำเร็จจะระบุด้วย 200 OK HTTP รหัสสถานะ การตอบกลับจะมีโทเค็นรหัส Firebase และโทเค็นการรีเฟรชที่เชื่อมโยงอยู่ กับผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว

ตัวอย่างการตอบกลับที่มีโทเค็นรหัส 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\", ...}"
}

ตัวอย่างคำขอที่มีโทเค็นเพื่อการเข้าถึง 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}'

คำขอที่สำเร็จจะระบุด้วย 200 OK HTTP รหัสสถานะ การตอบกลับจะมีโทเค็นรหัส Firebase และโทเค็นการรีเฟรชที่เชื่อมโยงอยู่ กับผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว

ตัวอย่างการตอบกลับด้วยโทเค็นเพื่อการเข้าถึง 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\", ...}"
}

คำขอตัวอย่างที่มีข้อมูลเข้าสู่ระบบ OAuth 1.0 ของ Twitter 

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

คำขอที่สำเร็จจะระบุด้วย 200 OK HTTP รหัสสถานะ การตอบกลับจะมีโทเค็นรหัส Firebase และโทเค็นการรีเฟรชที่เชื่อมโยงอยู่ กับผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว

คำตอบตัวอย่างที่มีข้อมูลเข้าสู่ระบบ OAuth 1.0 ของ Twitter 

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

รหัสข้อผิดพลาดที่พบบ่อย

  • OPERATION_NOT_ALLOWED: ผู้ให้บริการที่เกี่ยวข้องปิดใช้อยู่สำหรับโปรเจ็กต์นี้
  • INVALID_IDP_RESPONSE: ข้อมูลเข้าสู่ระบบการตรวจสอบสิทธิ์ที่ระบุมีรูปแบบไม่ถูกต้องหรือหมดอายุแล้ว
  • INVALID_ID_TOKEN:ข้อมูลเข้าสู่ระบบของผู้ใช้ไม่สามารถใช้ได้อีกต่อไป ผู้ใช้ต้องลงชื่อเข้าใช้อีกครั้ง
  • EMAIL_EXISTS: ที่อยู่อีเมลนี้มีการใช้งานโดยบัญชีอื่นแล้ว
  • FEDERATED_USER_ID_ALREADY_LINKED: ข้อมูลรับรองนี้ได้เชื่อมโยงกับ บัญชีผู้ใช้

คุณยกเลิกการลิงก์ผู้ให้บริการกับผู้ใช้ปัจจุบันได้โดยออก HTTP คำขอ POST ไปยังปลายทางการตรวจสอบสิทธิ์ setAccountInfo

เมธอด: POST

ประเภทเนื้อหา: application/json

ปลายทาง 
https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]
เพย์โหลดเนื้อความของคำขอ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
โทเค็นรหัส สตริง โทเค็นรหัส Firebase ของบัญชี
DeleteProvider รายการสตริง รายการรหัสผู้ให้บริการที่จะยกเลิกการลิงก์ เช่น "google.com" "รหัสผ่าน" ฯลฯ
เพย์โหลดการตอบกลับ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
รหัสท้องถิ่น สตริง UID ของผู้ใช้ปัจจุบัน
อีเมล สตริง อีเมลของบัญชี
displayName สตริง ชื่อที่แสดงของบัญชี
URL รูปภาพ สตริง URL รูปภาพสำหรับบัญชี
แฮชรหัสผ่าน สตริง เวอร์ชันแฮชของรหัสผ่าน
ข้อมูลผู้ใช้ของผู้ให้บริการ รายการออบเจ็กต์ JSON รายการออบเจ็กต์ผู้ให้บริการที่ลิงก์ทั้งหมดซึ่งมี "providerId" และ "federatedId"
ยืนยันด้วยอีเมลแล้ว boolean อีเมลของบัญชีนี้ได้รับการยืนยันแล้วหรือไม่

ตัวอย่างคำขอ 

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

คำขอที่สำเร็จจะระบุด้วย 200 OK HTTP รหัสสถานะ

ตัวอย่างคำตอบ 

{
  "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 ไปยังปลายทางการตรวจสอบสิทธิ์ getOobConfirmationCode

เมธอด: POST

ประเภทเนื้อหา: application/json

ปลายทาง 
https://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]
ส่วนหัวที่ไม่บังคับ
ชื่อพร็อพเพอร์ตี้ คำอธิบาย
ภาษา X-Firebase รหัสภาษาที่สอดคล้องกับภาษาของผู้ใช้ การส่งผ่านนี้จะเป็นการแปล อีเมลยืนยันที่ส่งให้ผู้ใช้
เพย์โหลดเนื้อความของคำขอ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
requestType สตริง ประเภทของรหัสยืนยันที่จะส่ง ควรเป็น "VERIFY_EMAIL" เสมอ
โทเค็นรหัส สตริง โทเค็นรหัส Firebase ของผู้ใช้ที่ต้องยืนยัน
เพย์โหลดการตอบกลับ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
อีเมล สตริง อีเมลของบัญชี

ตัวอย่างคำขอ 

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

คำขอที่สำเร็จจะระบุด้วย 200 OK HTTP รหัสสถานะ

ตัวอย่างคำตอบ 

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

รหัสข้อผิดพลาดที่พบบ่อย

  • INVALID_ID_TOKEN: ข้อมูลเข้าสู่ระบบของผู้ใช้ไม่สามารถใช้ได้อีกต่อไป ผู้ใช้ต้องลงชื่อเข้าใช้อีกครั้ง
  • USER_NOT_FOUND: ไม่มีบันทึกผู้ใช้ที่เกี่ยวข้องกับตัวระบุนี้ ผู้ใช้สามารถ ลบ แล้ว

ยืนยันการยืนยันอีเมล

คุณสามารถยืนยันรหัสยืนยันอีเมลได้โดยออก HTTP คำขอ POST ไปยังปลายทางการตรวจสอบสิทธิ์ setAccountInfo

เมธอด: POST

ประเภทเนื้อหา: application/json

ปลายทาง 
https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]
เพย์โหลดเนื้อความของคำขอ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
รหัส oob สตริง รหัสการดำเนินการที่ส่งไปยังอีเมลของผู้ใช้เพื่อยืนยันอีเมล
เพย์โหลดการตอบกลับ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
อีเมล สตริง อีเมลของบัญชี
displayName สตริง ชื่อที่แสดงของบัญชี
URL รูปภาพ สตริง URL รูปภาพสำหรับบัญชี
แฮชรหัสผ่าน สตริง แฮชรหัสผ่าน
ข้อมูลผู้ใช้ของผู้ให้บริการ รายการออบเจ็กต์ JSON รายการออบเจ็กต์ผู้ให้บริการที่ลิงก์ทั้งหมดซึ่งมี "providerId" และ "federatedId"
ยืนยันด้วยอีเมลแล้ว boolean อีเมลของบัญชีนี้ได้รับการยืนยันแล้วหรือไม่

ตัวอย่างคำขอ 

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

คำขอที่สำเร็จจะระบุด้วย 200 OK HTTP รหัสสถานะ

ตัวอย่างคำตอบ 

{
  "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 ไปยังปลายทางการตรวจสอบสิทธิ์ deleteAccount

เมธอด: POST

ประเภทเนื้อหา: application/json

ปลายทาง 
https://identitytoolkit.googleapis.com/v1/accounts:delete?key=[API_KEY]
เพย์โหลดเนื้อความของคำขอ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
โทเค็นรหัส สตริง โทเค็นรหัส Firebase ของผู้ใช้ที่จะลบ
เพย์โหลดการตอบกลับ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย

ตัวอย่างคำขอ 

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

คำขอที่สำเร็จจะระบุด้วย 200 OK HTTP รหัสสถานะ

รหัสข้อผิดพลาดที่พบบ่อย

  • INVALID_ID_TOKEN:ข้อมูลเข้าสู่ระบบของผู้ใช้ไม่สามารถใช้ได้อีกต่อไป ผู้ใช้ต้องลงชื่อเข้าใช้อีกครั้ง
  • USER_NOT_FOUND: ไม่มีบันทึกผู้ใช้ที่เกี่ยวข้องกับตัวระบุนี้ ผู้ใช้สามารถ ลบ แล้ว

โปรแกรมจำลองการตรวจสอบสิทธิ์ Firebase

Firebase Local Emulator Suite มีโปรแกรมจำลองการตรวจสอบสิทธิ์ซึ่งใช้สำหรับ การสร้างต้นแบบเฉพาะเครื่องและการทดสอบขั้นตอนการตรวจสอบสิทธิ์ โปรแกรมจำลองจะแสดง REST ต่อไปนี้ ปลายทาง

ล้างบัญชีผู้ใช้

นำบัญชีทั้งหมดในโปรเจ็กต์ที่ระบุออก โดยไม่คำนึงถึงสถานะ

วิธีการ: DELETE

ปลายทาง

โปรดทราบว่า 9099 คือพอร์ตเริ่มต้นสำหรับโปรแกรมจำลองการตรวจสอบสิทธิ์ ตรวจสอบเทอร์มินัล สำหรับพอร์ตที่ใช้งานจริง 

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

รับการกำหนดค่าโปรแกรมจำลอง

รับการกำหนดค่าเฉพาะโปรแกรมจำลองสำหรับโปรเจ็กต์ที่ระบุ

วิธีการ: GET

ปลายทาง

โปรดทราบว่า 9099 คือพอร์ตเริ่มต้นสำหรับโปรแกรมจำลองการตรวจสอบสิทธิ์ ตรวจสอบเทอร์มินัล สำหรับพอร์ตที่ใช้งานจริง 

http://localhost:9099/emulator/v1/projects/{project-id}/config
เพย์โหลดการตอบกลับ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
ลงชื่อเข้าใช้ ออบเจ็กต์ ออบเจ็กต์การกำหนดค่า signIn ที่มีคีย์เดียวคือ allowDuplicateEmails (บูลีน)

การกำหนดค่าโปรแกรมจำลองแพตช์

อัปเดตการกำหนดค่าเฉพาะโปรแกรมจำลองสำหรับโปรเจ็กต์ที่ระบุ

วิธีการ: แพตช์

ปลายทาง

โปรดทราบว่า 9099 คือพอร์ตเริ่มต้นสำหรับโปรแกรมจำลองการตรวจสอบสิทธิ์ ตรวจสอบเทอร์มินัล สำหรับพอร์ตที่ใช้งานจริง

ประเภทเนื้อหา: application/json 

http://localhost:9099/emulator/v1/projects/{project-id}/config
เพย์โหลดเนื้อความของคำขอ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
ลงชื่อเข้าใช้ ออบเจ็กต์ ออบเจ็กต์การกำหนดค่า SignIn ที่ต้องการด้วยคีย์เดียว, allowDuplicateEmails (บูลีน)
เพย์โหลดการตอบกลับ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
ลงชื่อเข้าใช้ ออบเจ็กต์ ออบเจ็กต์การกำหนดค่า SignIn หลังคำขอที่มีคีย์เดียวคือ allowDuplicateEmails (บูลีน)

ดึงข้อมูลรหัสการตรวจสอบสิทธิ์นอกย่าน

หากขั้นตอนการตรวจสอบสิทธิ์ที่คุณกำลังทดสอบตามปกติจะสร้างรหัสนอกย่านความถี่ (เช่น รหัสยืนยันอีเมล รหัสรีเซ็ตรหัสผ่าน) โปรแกรมจำลองจะจัดเก็บรหัสนี้ไว้ภายในจนกว่า ที่ Google ใช้

วิธีการ: GET

ปลายทาง

โปรดทราบว่า 9099 คือพอร์ตเริ่มต้นสำหรับโปรแกรมจำลองการตรวจสอบสิทธิ์ ตรวจสอบเทอร์มินัล สำหรับพอร์ตที่ใช้งานจริง 

http://localhost:9099/emulator/v1/projects/{project-id}/oobCodes
เพย์โหลดการตอบกลับ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
รหัส oob อาร์เรย์ อาร์เรย์ของออบเจ็กต์ที่มีรายละเอียดรหัสยืนยันที่รอดำเนินการทั้งหมด ออบเจ็กต์แต่ละรายการประกอบด้วย email (สตริง), oobCode (สตริง) oobLink (สตริง) และ requestType (สตริง)

เรียกรหัสยืนยันทาง SMS

หากคุณกำลังทดสอบขั้นตอนการตรวจสอบสิทธิ์ทางโทรศัพท์/SMS โปรแกรมจำลองจะจัดเก็บรหัส SMS ดังกล่าวไว้ภายใน จนกว่าจะใช้งาน

วิธีการ: GET

ปลายทาง

โปรดทราบว่า 9099 คือพอร์ตเริ่มต้นสำหรับโปรแกรมจำลองการตรวจสอบสิทธิ์ ตรวจสอบเทอร์มินัล สำหรับพอร์ตที่ใช้งานจริง 

http://localhost:9099/emulator/v1/projects/{project-id}/verificationCodes
เพย์โหลดการตอบกลับ
ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
รหัสยืนยัน อาร์เรย์ อาร์เรย์ของออบเจ็กต์ที่มีรายละเอียดรหัสยืนยันที่รอดำเนินการทั้งหมด ออบเจ็กต์แต่ละรายการประกอบด้วย phoneNumber (สตริง) และ sessionCode (สตริง)

การตอบกลับข้อผิดพลาด

รูปแบบการตอบกลับข้อผิดพลาด

เมื่อใดก็ตามที่ข้อผิดพลาดถูกส่งกลับมาจากเซิร์ฟเวอร์แบ็กเอนด์สำหรับ API ใดๆ ด้านบน การตอบสนอง จะมีรูปแบบดังต่อไปนี้

ตัวอย่างคำตอบ 

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

รหัสข้อผิดพลาดมาจากช่องข้อความ รหัสข้อผิดพลาดข้างต้นทั้งหมดอ้างอิงถึง เนื้อหาช่องข้อความ