API ส่วนที่เหลือของ Firebase Auth

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

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

วิธีการ: โพสต์

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

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

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

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

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

ตัวอย่างการตอบกลับ

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

รหัสข้อผิดพลาดทั่วไป

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

แลกเปลี่ยนโทเค็นการรีเฟรชเป็นโทเค็น ID

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

วิธีการ: โพสต์

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

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

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

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

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

ตัวอย่างการตอบกลับ

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

รหัสข้อผิดพลาดทั่วไป

• TOKEN_EXPIRED: ข้อมูลรับรองของผู้ใช้ใช้ไม่ได้อีกต่อไป ผู้ใช้จะต้องลงชื่อเข้าใช้อีกครั้ง
• USER_DISABLED: บัญชีผู้ใช้ถูกปิดใช้งานโดยผู้ดูแลระบบ
• USER_NOT_FOUND: ไม่พบผู้ใช้ที่สอดคล้องกับโทเค็นการรีเฟรช เป็นไปได้ว่าผู้ใช้ถูกลบไปแล้ว
• คีย์ API ไม่ถูกต้อง กรุณาส่งคีย์ API ที่ถูกต้อง (ระบุคีย์ API ไม่ถูกต้อง)
• INVALID_REFRESH_TOKEN: มีการระบุโทเค็นการรีเฟรชที่ไม่ถูกต้อง
• ได้รับเพย์โหลด JSON ที่ไม่ถูกต้อง ชื่อที่ไม่รู้จัก \"refresh_tokens\": ไม่สามารถผูกพารามิเตอร์การสืบค้นได้ ไม่พบฟิลด์ 'refresh_tokens' ในข้อความคำขอ
• INVALID_GRANT_TYPE: ประเภทสิทธิ์ที่ระบุไม่ถูกต้อง
• MISSING_REFRESH_TOKEN: ไม่มีโทเค็นการรีเฟรชให้มา
• PROJECT_NUMBER_MISMATCH: หมายเลขโครงการของโทเค็นการรีเฟรชไม่ตรงกับหมายเลขของคีย์ API ที่ให้ไว้

ลงทะเบียนด้วยอีเมล / รหัสผ่าน

คุณสามารถสร้างผู้ใช้อีเมลและรหัสผ่านใหม่ได้โดยออกคำขอ HTTP POST ไปยังจุดสิ้นสุด Auth signupNewUser

วิธีการ: โพสต์

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

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

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

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

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

ตัวอย่างการตอบกลับ

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

รหัสข้อผิดพลาดทั่วไป

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

เข้าสู่ระบบด้วยอีเมล / รหัสผ่าน

คุณสามารถลงชื่อเข้าใช้ผู้ใช้ด้วยอีเมลและรหัสผ่านได้โดยส่งคำขอ HTTP POST ไปยังจุดสิ้นสุด Auth verifyPassword

วิธีการ: โพสต์

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

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

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

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

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

ตัวอย่างการตอบกลับ

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

รหัสข้อผิดพลาดทั่วไป

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

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

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

วิธีการ: โพสต์

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

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

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

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

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

ตัวอย่างการตอบกลับ

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

รหัสข้อผิดพลาดทั่วไป

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

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

คุณสามารถลงชื่อเข้าใช้ผู้ใช้ด้วยข้อมูลรับรอง OAuth ได้โดยส่งคำขอ HTTP POST ไปยังจุดสิ้นสุด Auth verifyAssertion

วิธีการ: โพสต์

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

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

คำขอตัวอย่างด้วยโทเค็น OAuth ID

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

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

ตัวอย่างการตอบสนองด้วยโทเค็น OAuth ID

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

คำขอตัวอย่างพร้อมโทเค็นการเข้าถึง OAuth

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

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

ตัวอย่างการตอบสนองด้วยโทเค็นการเข้าถึง OAuth

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

คำขอตัวอย่างพร้อมข้อมูลรับรอง Twitter OAuth 1.0

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

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

ตัวอย่างการตอบกลับด้วยข้อมูลรับรอง Twitter OAuth 1.0

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

รหัสข้อผิดพลาดทั่วไป

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

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

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

วิธีการ: โพสต์

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

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

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

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

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

ตัวอย่างการตอบกลับ

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

รหัสข้อผิดพลาดทั่วไป

• INVALID_EMAIL: ที่อยู่อีเมลมีรูปแบบที่ไม่เหมาะสม

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

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

วิธีการ: โพสต์

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

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

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

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

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

ตัวอย่างการตอบกลับ

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

รหัสข้อผิดพลาดทั่วไป

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

ตรวจสอบรหัสรีเซ็ตรหัสผ่าน

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

วิธีการ: โพสต์

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

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

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

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

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

ตัวอย่างการตอบกลับ

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

รหัสข้อผิดพลาดทั่วไป

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

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

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

วิธีการ: โพสต์

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

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

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

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

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

ตัวอย่างการตอบกลับ

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

รหัสข้อผิดพลาดทั่วไป

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

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

คุณสามารถเปลี่ยนอีเมลของผู้ใช้ได้โดยส่งคำขอ HTTP POST ไปยังจุดสิ้นสุด Auth setAccountInfo

วิธีการ: โพสต์

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

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

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

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

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

ตัวอย่างการตอบกลับ

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

รหัสข้อผิดพลาดทั่วไป

• EMAIL_EXISTS: ที่อยู่อีเมลนี้มีการใช้งานแล้วโดยบัญชีอื่น
• INVALID_ID_TOKEN:ข้อมูลประจำตัวของผู้ใช้ไม่ถูกต้องอีกต่อไป ผู้ใช้จะต้องลงชื่อเข้าใช้อีกครั้ง

เปลี่ยนรหัสผ่าน

คุณสามารถเปลี่ยนรหัสผ่านของผู้ใช้ได้โดยส่งคำขอ HTTP POST ไปยังจุดสิ้นสุด Auth setAccountInfo

วิธีการ: โพสต์

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

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

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

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

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

ตัวอย่างการตอบกลับ

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

รหัสข้อผิดพลาดทั่วไป

• INVALID_ID_TOKEN:ข้อมูลประจำตัวของผู้ใช้ไม่ถูกต้องอีกต่อไป ผู้ใช้จะต้องลงชื่อเข้าใช้อีกครั้ง
• WEAK_PASSWORD: รหัสผ่านต้องมีความยาว 6 ตัวอักษรขึ้นไป

อัพเดตโปรไฟล์

คุณสามารถอัปเดตโปรไฟล์ของผู้ใช้ (ชื่อที่แสดง / URL รูปภาพ) ได้โดยการออกคำขอ HTTP POST ไปยังจุดสิ้นสุด Auth setAccountInfo

วิธีการ: โพสต์

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

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

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

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

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

ตัวอย่างการตอบกลับ

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

รหัสข้อผิดพลาดทั่วไป

• INVALID_ID_TOKEN:ข้อมูลประจำตัวของผู้ใช้ไม่ถูกต้องอีกต่อไป ผู้ใช้จะต้องลงชื่อเข้าใช้อีกครั้ง

รับข้อมูลผู้ใช้

คุณสามารถรับข้อมูลของผู้ใช้ได้โดยส่งคำขอ HTTP POST ไปยังจุดสิ้นสุด Auth getAccountInfo

วิธีการ: โพสต์

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

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

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

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

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

ตัวอย่างการตอบกลับ

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

รหัสข้อผิดพลาดทั่วไป

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

เชื่อมโยงกับอีเมล/รหัสผ่าน

คุณสามารถเชื่อมโยงอีเมล/รหัสผ่านกับผู้ใช้ปัจจุบันได้โดยการออกคำขอ HTTP POST ไปยังจุดสิ้นสุด Auth setAccountInfo

วิธีการ: โพสต์

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

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

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

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

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

ตัวอย่างการตอบกลับ

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

รหัสข้อผิดพลาดทั่วไป

• CREDENTIAL_TOO_OLD_LOGIN_AGAIN: ข้อมูลประจำตัวของผู้ใช้ไม่ถูกต้องอีกต่อไป ผู้ใช้จะต้องลงชื่อเข้าใช้อีกครั้ง
• TOKEN_EXPIRED: ข้อมูลรับรองของผู้ใช้ใช้ไม่ได้อีกต่อไป ผู้ใช้จะต้องลงชื่อเข้าใช้อีกครั้ง
• INVALID_ID_TOKEN:ข้อมูลประจำตัวของผู้ใช้ไม่ถูกต้องอีกต่อไป ผู้ใช้จะต้องลงชื่อเข้าใช้อีกครั้ง
• WEAK_PASSWORD: รหัสผ่านต้องมีความยาว 6 ตัวอักษรขึ้นไป

เชื่อมโยงกับข้อมูลรับรอง OAuth

คุณสามารถเชื่อมโยงข้อมูลรับรอง OAuth กับผู้ใช้ได้โดยออกคำขอ HTTP POST ไปยังจุดสิ้นสุด Auth verifyAssertion

วิธีการ: โพสต์

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

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

คำขอตัวอย่างด้วยโทเค็น OAuth ID

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

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

ตัวอย่างการตอบสนองด้วยโทเค็น OAuth ID

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

คำขอตัวอย่างพร้อมโทเค็นการเข้าถึง OAuth

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

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

ตัวอย่างการตอบสนองด้วยโทเค็นการเข้าถึง OAuth

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

คำขอตัวอย่างพร้อมข้อมูลรับรอง Twitter OAuth 1.0

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

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

ตัวอย่างการตอบกลับด้วยข้อมูลรับรอง Twitter OAuth 1.0

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

รหัสข้อผิดพลาดทั่วไป

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

ยกเลิกการลิงก์ผู้ให้บริการ

คุณสามารถยกเลิกการเชื่อมโยงผู้ให้บริการจากผู้ใช้ปัจจุบันได้โดยออกคำขอ HTTP POST ไปยังจุดสิ้นสุด Auth setAccountInfo

วิธีการ: โพสต์

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

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

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

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

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

ตัวอย่างการตอบกลับ

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

รหัสข้อผิดพลาดทั่วไป

• INVALID_ID_TOKEN: ข้อมูลประจำตัวของผู้ใช้ไม่ถูกต้องอีกต่อไป ผู้ใช้จะต้องลงชื่อเข้าใช้อีกครั้ง

ส่งอีเมล์ยืนยัน

คุณสามารถส่งการยืนยันอีเมลสำหรับผู้ใช้ปัจจุบันได้โดยออกคำขอ HTTP POST ไปยังจุดสิ้นสุด Auth getOobConfirmationCode

วิธีการ: โพสต์

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

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

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

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

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

ตัวอย่างการตอบกลับ

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

รหัสข้อผิดพลาดทั่วไป

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

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

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

วิธีการ: โพสต์

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

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

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

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

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

ตัวอย่างการตอบกลับ

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

รหัสข้อผิดพลาดทั่วไป

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

ลบบัญชี

คุณสามารถลบผู้ใช้ปัจจุบันได้โดยออกคำขอ HTTP POST ไปยังจุดสิ้นสุด Auth deleteAccount

วิธีการ: โพสต์

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

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

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

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

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

รหัสข้อผิดพลาดทั่วไป

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

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

ลบบัญชีทั้งหมดในโครงการที่ระบุ โดยไม่คำนึงถึงสถานะ

วิธีการ: ลบ

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

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

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

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

วิธีการ: GET

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

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

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

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

วิธีการ: PATCH

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

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

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

ดึงรหัสการรับรองความถูกต้องนอกวงดนตรี

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

วิธี: รับ

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

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

ดึงรหัสการตรวจสอบ SMS

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

วิธี: รับ

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

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

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

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

การตอบสนองตัวอย่าง

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

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