फायरबेस ऑथेंटिकेशन एपीआई

एपीआई उपयोग

आप REST API के माध्यम से फायरबेस ऑथ बैकएंड को क्वेरी कर सकते हैं। इसका उपयोग विभिन्न कार्यों के लिए किया जा सकता है जैसे नए उपयोगकर्ता बनाना, मौजूदा उपयोगकर्ताओं में साइन इन करना और इन उपयोगकर्ताओं को संपादित करना या हटाना।

इस संपूर्ण दस्तावेज़ में, API_KEY वेब एपीआई कुंजी को संदर्भित करता है, जिसे आपके व्यवस्थापक कंसोल में प्रोजेक्ट सेटिंग पृष्ठ पर प्राप्त किया जा सकता है।

एक आईडी के लिए कस्टम टोकन एक्सचेंज करें और टोकन रीफ्रेश करें

आप एक आईडी के लिए एक कस्टम ऑथ टोकन का आदान-प्रदान कर सकते हैं और ऑथ verifyCustomToken एंडपॉइंट पर HTTP POST अनुरोध जारी करके टोकन को रीफ्रेश कर सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

समापन बिंदु
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}'

एक सफल अनुरोध को 200 OK HTTP स्थिति कोड द्वारा दर्शाया जाता है। प्रतिक्रिया में कस्टम टोकन से जुड़े फायरबेस आईडी टोकन और रीफ्रेश टोकन शामिल हैं।

नमूना प्रतिक्रिया

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

सामान्य त्रुटि कोड

  • INVALID_CUSTOM_TOKEN: कस्टम टोकन प्रारूप गलत है या किसी कारण से टोकन अमान्य है (उदाहरण के लिए समाप्त हो गया, अमान्य हस्ताक्षर आदि)
  • CREDENTIAL_MISMATCH: कस्टम टोकन एक अलग फायरबेस प्रोजेक्ट से मेल खाता है।

एक आईडी टोकन के लिए एक ताज़ा टोकन का आदान-प्रदान करें

आप securetoken.googleapis.com एंडपॉइंट पर HTTP POST अनुरोध जारी करके फायरबेस आईडी टोकन को रीफ्रेश कर सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/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]'

एक सफल अनुरोध को 200 OK HTTP स्थिति कोड द्वारा दर्शाया जाता है। प्रतिक्रिया में नया फायरबेस आईडी टोकन और रीफ्रेश टोकन शामिल है।

नमूना प्रतिक्रिया

{
  "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: ताज़ा टोकन से संबंधित उपयोगकर्ता नहीं मिला। संभावना है कि उपयोगकर्ता को हटा दिया गया था.
  • एपीआई कुंजी मान्य नहीं है. कृपया एक वैध एपीआई कुंजी पास करें। (अमान्य एपीआई कुंजी प्रदान की गई)
  • INVALID_REFRESH_TOKEN: एक अमान्य ताज़ा टोकन प्रदान किया गया है।
  • अमान्य JSON पेलोड प्राप्त हुआ. अज्ञात नाम \"refresh_tokens\": क्वेरी पैरामीटर को बाइंड नहीं किया जा सकता। फ़ील्ड 'रिफ्रेश_टोकन' अनुरोध संदेश में नहीं पाया जा सका।
  • INVALID_GRANT_TYPE: निर्दिष्ट अनुदान प्रकार अमान्य है।
  • MISSING_REFRESH_TOKEN: कोई ताज़ा टोकन प्रदान नहीं किया गया।
  • PROJECT_NUMBER_MISMATCH: रिफ्रेश टोकन का प्रोजेक्ट नंबर प्रदान की गई एपीआई कुंजी से मेल नहीं खाता है।

ईमेल/पासवर्ड से साइन अप करें

आप ऑथ signupNewUser एंडपॉइंट पर HTTP POST अनुरोध जारी करके एक नया ईमेल और पासवर्ड उपयोगकर्ता बना सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

समापन बिंदु
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}'

एक सफल अनुरोध को 200 OK HTTP स्थिति कोड द्वारा दर्शाया जाता है। प्रतिक्रिया में नए खाते से जुड़े फायरबेस आईडी टोकन और रीफ्रेश टोकन शामिल हैं।

नमूना प्रतिक्रिया

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

सामान्य त्रुटि कोड

  • EMAIL_EXISTS: ईमेल पता पहले से ही किसी अन्य खाते द्वारा उपयोग में है।
  • OPERATION_NOT_ALOWED: इस प्रोजेक्ट के लिए पासवर्ड साइन-इन अक्षम है।
  • TOO_MANY_ATTEMPTS_TRY_LATER: हमने असामान्य गतिविधि के कारण इस डिवाइस से सभी अनुरोधों को अवरुद्ध कर दिया है। बाद में पुन: प्रयास।

ईमेल/पासवर्ड से साइन इन करें

आप ऑथ verifyPassword एंडपॉइंट पर HTTP POST अनुरोध जारी करके किसी उपयोगकर्ता को ईमेल और पासवर्ड से साइन इन कर सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

समापन बिंदु
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}'

एक सफल अनुरोध को 200 OK HTTP स्थिति कोड द्वारा दर्शाया जाता है। प्रतिक्रिया में मौजूदा ईमेल/पासवर्ड खाते से जुड़े फायरबेस आईडी टोकन और रीफ्रेश टोकन शामिल हैं।

नमूना प्रतिक्रिया

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

सामान्य त्रुटि कोड

  • EMAIL_NOT_FOUND: इस पहचानकर्ता के अनुरूप कोई उपयोगकर्ता रिकॉर्ड नहीं है। हो सकता है कि उपयोगकर्ता हटा दिया गया हो.
  • INVALID_PASSWORD: पासवर्ड अमान्य है या उपयोगकर्ता के पास पासवर्ड नहीं है।
  • USER_DISABLED: उपयोगकर्ता खाता किसी व्यवस्थापक द्वारा अक्षम कर दिया गया है।

गुमनाम रूप से आना

आप ऑथ signupNewUser एंडपॉइंट पर HTTP POST अनुरोध जारी करके किसी उपयोगकर्ता को गुमनाम रूप से साइन इन कर सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

समापन बिंदु
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}'

एक सफल अनुरोध को 200 OK HTTP स्थिति कोड द्वारा दर्शाया जाता है। प्रतिक्रिया में अज्ञात उपयोगकर्ता से जुड़े फायरबेस आईडी टोकन और रीफ्रेश टोकन शामिल हैं।

नमूना प्रतिक्रिया

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

सामान्य त्रुटि कोड

  • OPERATION_NOT_ALLOWED: इस प्रोजेक्ट के लिए अज्ञात उपयोगकर्ता साइन-इन अक्षम है।

OAuth क्रेडेंशियल के साथ साइन इन करें

आप Auth verifyAssertion एंडपॉइंट पर HTTP POST अनुरोध जारी करके OAuth क्रेडेंशियल वाले उपयोगकर्ता में साइन इन कर सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

समापन बिंदु
https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]
बॉडी पेलोड का अनुरोध करें
संपत्ति का नाम प्रकार विवरण
requestUri डोरी वह यूआरआई जिस पर आईडीपी उपयोगकर्ता को वापस रीडायरेक्ट करता है।
पोस्टबॉडी डोरी इसमें OAuth क्रेडेंशियल (एक आईडी टोकन या एक्सेस टोकन) और प्रदाता आईडी शामिल है जो क्रेडेंशियल जारी करता है।
रिटर्नसिक्योरटोकन बूलियन आईडी वापस करनी है या नहीं और टोकन रीफ्रेश करना है या नहीं। हमेशा सच होना चाहिए.
रिटर्नआईडीपीक्रेडेंशियल बूलियन क्या निम्नलिखित त्रुटियों पर OAuth क्रेडेंशियल की वापसी को बाध्य किया जाए: FEDERATED_USER_ID_ALREADY_LINKED और EMAIL_EXISTS।
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
फ़ेडरेटेडआईडी डोरी विशिष्ट आईडी आईडीपी खाते की पहचान करती है।
प्रदाताआईडी डोरी लिंक किया गया प्रदाता आईडी (उदाहरण के लिए Google प्रदाता के लिए "google.com")।
स्थानीयआईडी डोरी प्रमाणित उपयोगकर्ता की यूआईडी.
ईमेल सत्यापित हुआ बूलियन क्या साइन-इन ईमेल सत्यापित है.
ईमेल डोरी खाते का ईमेल.
oauthIdToken डोरी यदि उपलब्ध हो तो ओआईडीसी आईडी टोकन।
oauthAccessToken डोरी यदि उपलब्ध हो तो OAuth एक्सेस टोकन।
oauthTokenSecret डोरी यदि उपलब्ध हो तो OAuth 1.0 टोकन रहस्य।
rawUserInfo डोरी कड़े JSON प्रतिक्रिया में दिए गए OAuth क्रेडेंशियल के अनुरूप सभी IdP डेटा शामिल है।
पहला नाम डोरी खाते के लिए पहला नाम.
उपनाम डोरी खाते का अंतिम नाम.
पूरा नाम डोरी खाते का पूरा नाम.
प्रदर्शित होने वाला नाम डोरी खाते के लिए प्रदर्शन नाम.
फोटोयूआरएल डोरी खाते के लिए फोटो यूआरएल.
आईडीटोकन डोरी प्रमाणित उपयोगकर्ता के लिए एक फायरबेस प्रामाणिक आईडी टोकन।
ताज़ाटोकन डोरी प्रमाणित उपयोगकर्ता के लिए एक फायरबेस ऑथ रिफ्रेश टोकन।
में समाप्त होना डोरी सेकंड की संख्या जिसमें आईडी टोकन समाप्त हो जाता है।
पुष्टि की आवश्यकता है बूलियन क्या समान क्रेडेंशियल वाला कोई अन्य खाता पहले से मौजूद है। उपयोगकर्ता को मूल खाते में साइन इन करना होगा और फिर वर्तमान क्रेडेंशियल को उससे लिंक करना होगा।

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 स्थिति कोड द्वारा दर्शाया जाता है। प्रतिक्रिया में प्रमाणित उपयोगकर्ता से जुड़े फायरबेस आईडी टोकन और रीफ्रेश टोकन शामिल हैं।

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 स्थिति कोड द्वारा दर्शाया जाता है। प्रतिक्रिया में प्रमाणित उपयोगकर्ता से जुड़े फायरबेस आईडी टोकन और रीफ्रेश टोकन शामिल हैं।

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 क्रेडेंशियल के साथ नमूना अनुरोध

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 स्थिति कोड द्वारा दर्शाया जाता है। प्रतिक्रिया में प्रमाणित उपयोगकर्ता से जुड़े फायरबेस आईडी टोकन और रीफ्रेश टोकन शामिल हैं।

ट्विटर 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_ALOWED: इस प्रोजेक्ट के लिए संबंधित प्रदाता अक्षम है।
  • INVALID_IDP_RESPONSE: आपूर्ति किया गया प्रामाणिक क्रेडेंशियल ख़राब है या समाप्त हो चुका है।

ईमेल के लिए प्रदाता प्राप्त करें

आप Auth createAuthUri एंडपॉइंट पर HTTP POST अनुरोध जारी करके किसी निर्दिष्ट ईमेल से जुड़े सभी प्रदाताओं को देख सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

समापन बिंदु
https://identitytoolkit.googleapis.com/v1/accounts:createAuthUri?key=[API_KEY]
बॉडी पेलोड का अनुरोध करें
संपत्ति का नाम प्रकार विवरण
पहचानकर्ता डोरी उपयोगकर्ता का ईमेल पता
जारी रखेंउरी डोरी वह यूआरआई जिस पर आईडीपी उपयोगकर्ता को वापस रीडायरेक्ट करता है। इस उपयोग के मामले के लिए, यह केवल वर्तमान 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]"}'

एक सफल अनुरोध को 200 OK HTTP स्थिति कोड द्वारा दर्शाया जाता है। प्रतिक्रिया में ईमेल से जुड़े प्रदाताओं की सूची शामिल है।

नमूना प्रतिक्रिया

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

सामान्य त्रुटि कोड

  • INVALID_EMAIL: ईमेल पता बुरी तरह से स्वरूपित है।

पासवर्ड रीसेट ईमेल भेजें

आप Auth getOobConfirmationCode एंडपॉइंट पर HTTP POST अनुरोध जारी करके पासवर्ड रीसेट ईमेल भेज सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

समापन बिंदु
https://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]
वैकल्पिक शीर्षलेख
संपत्ति का नाम विवरण
एक्स-फ़ायरबेस-लोकेल उपयोगकर्ता के स्थान के अनुरूप भाषा कोड. इसे पास करने से उपयोगकर्ता को भेजा गया पासवर्ड रीसेट ईमेल स्थानीयकृत हो जाएगा।
बॉडी पेलोड का अनुरोध करें
संपत्ति का नाम प्रकार विवरण
अनुरोध का प्रकार डोरी वापस करने के लिए 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]"}'

एक सफल अनुरोध को 200 OK HTTP स्थिति कोड द्वारा दर्शाया जाता है।

नमूना प्रतिक्रिया

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

सामान्य त्रुटि कोड

  • EMAIL_NOT_FOUND: इस पहचानकर्ता के अनुरूप कोई उपयोगकर्ता रिकॉर्ड नहीं है। हो सकता है कि उपयोगकर्ता हटा दिया गया हो.

पासवर्ड रीसेट कोड सत्यापित करें

आप ऑथ resetPassword एंडपॉइंट पर HTTP POST अनुरोध जारी करके पासवर्ड रीसेट कोड को सत्यापित कर सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

समापन बिंदु
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]"}'

एक सफल अनुरोध को 200 OK HTTP स्थिति कोड द्वारा दर्शाया जाता है।

नमूना प्रतिक्रिया

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

सामान्य त्रुटि कोड

  • OPERATION_NOT_ALOWED: इस प्रोजेक्ट के लिए पासवर्ड साइन-इन अक्षम है।
  • EXPIRED_OOB_CODE: क्रिया कोड समाप्त हो गया है।
  • INVALID_OOB_CODE: क्रिया कोड अमान्य है। ऐसा तब हो सकता है जब कोड ख़राब हो, समाप्त हो चुका हो, या पहले ही उपयोग किया जा चुका हो।

पासवर्ड रीसेट की पुष्टि करें

आप ऑथ resetPassword एंडपॉइंट पर HTTP POST अनुरोध जारी करके पासवर्ड रीसेट परिवर्तन लागू कर सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

समापन बिंदु
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]"}'

एक सफल अनुरोध को 200 OK HTTP स्थिति कोड द्वारा दर्शाया जाता है।

नमूना प्रतिक्रिया

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

सामान्य त्रुटि कोड

  • OPERATION_NOT_ALOWED: इस प्रोजेक्ट के लिए पासवर्ड साइन-इन अक्षम है।
  • EXPIRED_OOB_CODE: क्रिया कोड समाप्त हो गया है।
  • INVALID_OOB_CODE: क्रिया कोड अमान्य है। ऐसा तब हो सकता है जब कोड ख़राब हो, समाप्त हो चुका हो, या पहले ही उपयोग किया जा चुका हो।
  • USER_DISABLED: उपयोगकर्ता खाता किसी व्यवस्थापक द्वारा अक्षम कर दिया गया है।

बदले ई - मेल

आप Auth setAccountInfo एंडपॉइंट पर HTTP POST अनुरोध जारी करके उपयोगकर्ता का ईमेल बदल सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

समापन बिंदु
https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]
वैकल्पिक शीर्षलेख
संपत्ति का नाम विवरण
एक्स-फ़ायरबेस-लोकेल उपयोगकर्ता के स्थान के अनुरूप भाषा कोड. इसे पारित करने से उपयोगकर्ता को भेजा गया ईमेल परिवर्तन निरस्तीकरण स्थानीयकृत हो जाएगा।
बॉडी पेलोड का अनुरोध करें
संपत्ति का नाम प्रकार विवरण
आईडीटोकन डोरी उपयोगकर्ता के लिए एक फ़ायरबेस प्रामाणिक आईडी टोकन।
ईमेल डोरी उपयोगकर्ता का नया ईमेल.
रिटर्नसिक्योरटोकन बूलियन आईडी वापस करनी है या नहीं और टोकन रीफ्रेश करना है या नहीं।
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
स्थानीयआईडी डोरी वर्तमान उपयोगकर्ता का यूआईडी.
ईमेल डोरी उपयोगकर्ता का ईमेल पता.
पासवर्डहैश डोरी पासवर्ड का हैश संस्करण.
प्रदाता उपयोगकर्ता जानकारी JSON ऑब्जेक्ट की सूची सभी लिंक किए गए प्रदाता ऑब्जेक्ट की सूची जिसमें "प्रदाता आईडी" और "फ़ेडरेटेड आईडी" शामिल हैं।
आईडीटोकन डोरी उपयोगकर्ता के लिए नया फायरबेस प्रामाणिक आईडी टोकन।
ताज़ाटोकन डोरी एक फायरबेस ऑथ रिफ्रेश टोकन।
में समाप्त होना डोरी सेकंड की संख्या जिसमें आईडी टोकन समाप्त हो जाता है।

नमूना अनुरोध

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

एक सफल अनुरोध को 200 OK HTTP स्थिति कोड द्वारा दर्शाया जाता है। प्रतिक्रिया में उपयोगकर्ता से जुड़ा नया फायरबेस आईडी टोकन और रीफ्रेश टोकन शामिल है।

नमूना प्रतिक्रिया

{
  "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: उपयोगकर्ता का क्रेडेंशियल अब मान्य नहीं है। उपयोगकर्ता को दोबारा साइन इन करना होगा.

पासवर्ड बदलें

आप Auth setAccountInfo एंडपॉइंट पर HTTP POST अनुरोध जारी करके उपयोगकर्ता का पासवर्ड बदल सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

समापन बिंदु
https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]
बॉडी पेलोड का अनुरोध करें
संपत्ति का नाम प्रकार विवरण
आईडीटोकन डोरी उपयोगकर्ता के लिए एक फ़ायरबेस प्रामाणिक आईडी टोकन।
पासवर्ड डोरी उपयोगकर्ता का नया पासवर्ड.
रिटर्नसिक्योरटोकन बूलियन आईडी वापस करनी है या नहीं और टोकन रीफ्रेश करना है या नहीं।
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
स्थानीयआईडी डोरी वर्तमान उपयोगकर्ता का यूआईडी.
ईमेल डोरी उपयोगकर्ता का ईमेल पता.
पासवर्डहैश डोरी पासवर्ड का हैश संस्करण.
प्रदाता उपयोगकर्ता जानकारी JSON ऑब्जेक्ट की सूची सभी लिंक किए गए प्रदाता ऑब्जेक्ट की सूची जिसमें "प्रदाता आईडी" और "फ़ेडरेटेड आईडी" शामिल हैं।
आईडीटोकन डोरी उपयोगकर्ता के लिए नया फायरबेस प्रामाणिक आईडी टोकन।
ताज़ाटोकन डोरी एक फायरबेस ऑथ रिफ्रेश टोकन।
में समाप्त होना डोरी सेकंड की संख्या जिसमें आईडी टोकन समाप्त हो जाता है।

नमूना अनुरोध

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 स्थिति कोड द्वारा दर्शाया जाता है। प्रतिक्रिया में उपयोगकर्ता से जुड़ा नया फायरबेस आईडी टोकन और रीफ्रेश टोकन शामिल है।

नमूना प्रतिक्रिया

{
  "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 अक्षर लंबा या अधिक होना चाहिए।

प्रोफ़ाइल अपडेट करें

आप Auth setAccountInfo एंडपॉइंट पर HTTP POST अनुरोध जारी करके उपयोगकर्ता की प्रोफ़ाइल (प्रदर्शन नाम / फोटो URL) को अपडेट कर सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

समापन बिंदु
https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]
बॉडी पेलोड का अनुरोध करें
संपत्ति का नाम प्रकार विवरण
आईडीटोकन डोरी उपयोगकर्ता के लिए एक फ़ायरबेस प्रामाणिक आईडी टोकन।
प्रदर्शित होने वाला नाम डोरी उपयोगकर्ता का नया प्रदर्शन नाम.
फोटोयूआरएल डोरी उपयोगकर्ता का नया फोटो यूआरएल.
हटाएँविशेषताएँ तारों की सूची हटाने के लिए विशेषताओं की सूची, "DISPLAY_NAME" या "PHOTO_URL"। इससे ये मान ख़त्म हो जायेंगे.
रिटर्नसिक्योरटोकन बूलियन आईडी वापस करनी है या नहीं और टोकन रीफ्रेश करना है या नहीं।
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
स्थानीयआईडी डोरी वर्तमान उपयोगकर्ता का यूआईडी.
ईमेल डोरी उपयोगकर्ता का ईमेल पता.
प्रदर्शित होने वाला नाम डोरी उपयोगकर्ता का नया प्रदर्शन नाम.
फोटोयूआरएल डोरी उपयोगकर्ता का नया फोटो यूआरएल.
पासवर्डहैश डोरी पासवर्ड का हैश संस्करण.
प्रदाता उपयोगकर्ता जानकारी JSON ऑब्जेक्ट की सूची सभी लिंक किए गए प्रदाता ऑब्जेक्ट की सूची जिसमें "प्रदाता आईडी" और "फ़ेडरेटेड आईडी" शामिल हैं।
आईडीटोकन डोरी उपयोगकर्ता के लिए नया फायरबेस प्रामाणिक आईडी टोकन।
ताज़ाटोकन डोरी एक फायरबेस ऑथ रिफ्रेश टोकन।
में समाप्त होना डोरी सेकंड की संख्या जिसमें आईडी टोकन समाप्त हो जाता है।

नमूना अनुरोध

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: उपयोगकर्ता का क्रेडेंशियल अब मान्य नहीं है। उपयोगकर्ता को दोबारा साइन इन करना होगा.

उपयोगकर्ता डेटा प्राप्त करें

आप Auth getAccountInfo एंडपॉइंट पर HTTP POST अनुरोध जारी करके उपयोगकर्ता का डेटा प्राप्त कर सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

समापन बिंदु
https://identitytoolkit.googleapis.com/v1/accounts:lookup?key=[API_KEY]
बॉडी पेलोड का अनुरोध करें
संपत्ति का नाम प्रकार विवरण
आईडीटोकन डोरी खाते का फायरबेस आईडी टोकन।
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
उपयोगकर्ताओं JSON ऑब्जेक्ट की सूची दिए गए फायरबेस आईडी टोकन से जुड़ा खाता। अधिक विवरण के लिए नीचे देखें.
प्रतिक्रिया पेलोड ( users सरणी सामग्री)
संपत्ति का नाम प्रकार विवरण
स्थानीयआईडी डोरी वर्तमान उपयोगकर्ता का यूआईडी.
ईमेल डोरी खाते का ईमेल.
ईमेल सत्यापित हुआ बूलियन खाते का ईमेल सत्यापित किया गया है या नहीं.
प्रदर्शित होने वाला नाम डोरी खाते के लिए प्रदर्शन नाम.
प्रदाता उपयोगकर्ता जानकारी JSON ऑब्जेक्ट की सूची सभी लिंक किए गए प्रदाता ऑब्जेक्ट की सूची जिसमें "प्रदाता आईडी" और "फ़ेडरेटेड आईडी" शामिल हैं।
फोटोयूआरएल डोरी खाते के लिए फोटो यूआरएल.
पासवर्डहैश डोरी पासवर्ड का हैश संस्करण.
पासवर्डअपडेटेडएट दोहरा टाइमस्टैम्प, मिलीसेकंड में, कि खाता पासवर्ड आखिरी बार बदला गया था।
वैधचूंकि डोरी टाइमस्टैम्प, सेकंड में, जो एक सीमा को चिह्नित करता है, जिसके पहले फायरबेस आईडी टोकन को निरस्त माना जाता है।
अक्षम बूलियन खाता अक्षम है या नहीं.
अंतिमलॉगइनएट डोरी टाइमस्टैम्प, मिलीसेकंड में, जिस पर खाता अंतिम बार लॉग इन हुआ था।
पर बनाया गया डोरी टाइमस्टैम्प, मिलीसेकंड में, जिस पर खाता बनाया गया था।
कस्टमऑथ बूलियन क्या खाता डेवलपर द्वारा प्रमाणित है।

नमूना अनुरोध

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

एक सफल अनुरोध को 200 OK HTTP स्थिति कोड द्वारा दर्शाया जाता है। प्रतिक्रिया में खाते से जुड़ी सभी उपयोगकर्ता जानकारी शामिल होगी।

नमूना प्रतिक्रिया

{
  "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: इस पहचानकर्ता के अनुरूप कोई उपयोगकर्ता रिकॉर्ड नहीं है। हो सकता है कि उपयोगकर्ता हटा दिया गया हो.

आप Auth setAccountInfo एंडपॉइंट पर HTTP POST अनुरोध जारी करके किसी ईमेल/पासवर्ड को मौजूदा उपयोगकर्ता से लिंक कर सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

समापन बिंदु
https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]
बॉडी पेलोड का अनुरोध करें
संपत्ति का नाम प्रकार विवरण
आईडीटोकन डोरी जिस खाते से आप क्रेडेंशियल लिंक करने का प्रयास कर रहे हैं उसका फायरबेस आईडी टोकन।
ईमेल डोरी खाते से लिंक करने के लिए ईमेल.
पासवर्ड डोरी खाते का नया पासवर्ड.
रिटर्नसिक्योरटोकन डोरी आईडी वापस करनी है या नहीं और टोकन रीफ्रेश करना है या नहीं। हमेशा सच होना चाहिए.
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
स्थानीयआईडी डोरी वर्तमान उपयोगकर्ता का यूआईडी.
ईमेल डोरी खाते का ईमेल.
प्रदर्शित होने वाला नाम डोरी खाते के लिए प्रदर्शन नाम.
फोटोयूआरएल डोरी खाते के लिए फोटो यूआरएल.
पासवर्डहैश डोरी पासवर्ड का हैश संस्करण.
प्रदाता उपयोगकर्ता जानकारी JSON ऑब्जेक्ट की सूची सभी लिंक किए गए प्रदाता ऑब्जेक्ट की सूची जिसमें "प्रदाता आईडी" और "फ़ेडरेटेड आईडी" शामिल हैं।
ईमेल सत्यापित हुआ बूलियन खाते का ईमेल सत्यापित किया गया है या नहीं.
आईडीटोकन डोरी उपयोगकर्ता के लिए नया फायरबेस प्रामाणिक आईडी टोकन।
ताज़ाटोकन डोरी एक फायरबेस ऑथ रिफ्रेश टोकन।
में समाप्त होना डोरी सेकंड की संख्या जिसमें आईडी टोकन समाप्त हो जाता है।

नमूना अनुरोध

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 स्थिति कोड द्वारा दर्शाया जाता है। प्रतिक्रिया में प्रमाणित उपयोगकर्ता से जुड़े फायरबेस आईडी टोकन और रीफ्रेश टोकन शामिल हैं।

नमूना प्रतिक्रिया

{
  "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 अक्षर लंबा या अधिक होना चाहिए।

आप Auth verifyAssertion समापन बिंदु पर HTTP POST अनुरोध जारी करके OAuth क्रेडेंशियल को किसी उपयोगकर्ता से लिंक कर सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

समापन बिंदु
https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]
बॉडी पेलोड का अनुरोध करें
संपत्ति का नाम प्रकार विवरण
आईडीटोकन डोरी जिस खाते से आप क्रेडेंशियल लिंक करने का प्रयास कर रहे हैं उसका फायरबेस आईडी टोकन।
requestUri डोरी वह यूआरआई जिस पर आईडीपी उपयोगकर्ता को वापस रीडायरेक्ट करता है।
पोस्टबॉडी डोरी इसमें OAuth क्रेडेंशियल (एक आईडी टोकन या एक्सेस टोकन) और प्रदाता आईडी शामिल है जो क्रेडेंशियल जारी करता है।
रिटर्नसिक्योरटोकन बूलियन आईडी वापस करनी है या नहीं और टोकन रीफ्रेश करना है या नहीं। हमेशा सच होना चाहिए.
रिटर्नआईडीपीक्रेडेंशियल बूलियन क्या निम्नलिखित त्रुटियों पर OAuth क्रेडेंशियल की वापसी को बाध्य किया जाए: FEDERATED_USER_ID_ALREADY_LINKED और EMAIL_EXISTS।
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
फ़ेडरेटेडआईडी डोरी विशिष्ट आईडी आईडीपी खाते की पहचान करती है।
प्रदाताआईडी डोरी लिंक किया गया प्रदाता आईडी (उदाहरण के लिए Google प्रदाता के लिए "google.com")।
स्थानीयआईडी डोरी प्रमाणित उपयोगकर्ता की यूआईडी.
ईमेल सत्यापित हुआ बूलियन क्या साइनइन ईमेल सत्यापित है.
ईमेल डोरी खाते का ईमेल.
oauthIdToken डोरी यदि उपलब्ध हो तो ओआईडीसी आईडी टोकन।
oauthAccessToken डोरी यदि उपलब्ध हो तो OAuth एक्सेस टोकन।
oauthTokenSecret डोरी यदि उपलब्ध हो तो OAuth 1.0 टोकन रहस्य।
rawUserInfo डोरी कड़े JSON प्रतिक्रिया में दिए गए OAuth क्रेडेंशियल के अनुरूप सभी IdP डेटा शामिल है।
पहला नाम डोरी खाते के लिए पहला नाम.
उपनाम डोरी खाते का अंतिम नाम.
पूरा नाम डोरी खाते का पूरा नाम.
प्रदर्शित होने वाला नाम डोरी खाते के लिए प्रदर्शन नाम.
फोटोयूआरएल डोरी खाते के लिए फोटो यूआरएल.
आईडीटोकन डोरी प्रमाणित उपयोगकर्ता के लिए एक फायरबेस प्रामाणिक आईडी टोकन।
ताज़ाटोकन डोरी प्रमाणित उपयोगकर्ता के लिए एक फायरबेस ऑथ रिफ्रेश टोकन।
में समाप्त होना डोरी सेकंड की संख्या जिसमें आईडी टोकन समाप्त हो जाता है।

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 स्थिति कोड द्वारा दर्शाया जाता है। प्रतिक्रिया में प्रमाणित उपयोगकर्ता से जुड़े फायरबेस आईडी टोकन और रीफ्रेश टोकन शामिल हैं।

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 स्थिति कोड द्वारा दर्शाया जाता है। प्रतिक्रिया में प्रमाणित उपयोगकर्ता से जुड़े फायरबेस आईडी टोकन और रीफ्रेश टोकन शामिल हैं।

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 क्रेडेंशियल के साथ नमूना अनुरोध

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 स्थिति कोड द्वारा दर्शाया जाता है। प्रतिक्रिया में प्रमाणित उपयोगकर्ता से जुड़े फायरबेस आईडी टोकन और रीफ्रेश टोकन शामिल हैं।

ट्विटर 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: यह क्रेडेंशियल पहले से ही एक अलग उपयोगकर्ता खाते से संबद्ध है।

आप Auth setAccountInfo एंडपॉइंट पर HTTP POST अनुरोध जारी करके किसी प्रदाता को वर्तमान उपयोगकर्ता से अनलिंक कर सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

समापन बिंदु
https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]
बॉडी पेलोड का अनुरोध करें
संपत्ति का नाम प्रकार विवरण
आईडीटोकन डोरी खाते का फायरबेस आईडी टोकन।
प्रदाता हटाएं तारों की सूची अनलिंक करने के लिए प्रदाता आईडी की सूची, उदाहरण के लिए: 'google.com', 'पासवर्ड', आदि।
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
स्थानीयआईडी डोरी वर्तमान उपयोगकर्ता का यूआईडी.
ईमेल डोरी खाते का ईमेल.
प्रदर्शित होने वाला नाम डोरी खाते के लिए प्रदर्शन नाम.
फोटोयूआरएल डोरी खाते के लिए फोटो यूआरएल.
पासवर्डहैश डोरी पासवर्ड का हैश संस्करण.
प्रदाता उपयोगकर्ता जानकारी JSON ऑब्जेक्ट की सूची सभी लिंक किए गए प्रदाता ऑब्जेक्ट की सूची जिसमें "प्रदाता आईडी" और "फ़ेडरेटेड आईडी" शामिल हैं।
ईमेल सत्यापित हुआ बूलियन खाते का ईमेल सत्यापित किया गया है या नहीं.

नमूना अनुरोध

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: उपयोगकर्ता का क्रेडेंशियल अब मान्य नहीं है। उपयोगकर्ता को दोबारा साइन इन करना होगा.

ईमेल सत्यापन भेजें

आप Auth getOobConfirmationCode एंडपॉइंट पर HTTP POST अनुरोध जारी करके वर्तमान उपयोगकर्ता के लिए एक ईमेल सत्यापन भेज सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

समापन बिंदु
https://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]
वैकल्पिक शीर्षलेख
संपत्ति का नाम विवरण
एक्स-फ़ायरबेस-लोकेल उपयोगकर्ता के स्थान के अनुरूप भाषा कोड. इसे पास करने से उपयोगकर्ता को भेजा गया ईमेल सत्यापन स्थानीयकृत हो जाएगा।
बॉडी पेलोड का अनुरोध करें
संपत्ति का नाम प्रकार विवरण
अनुरोध का प्रकार डोरी भेजने के लिए पुष्टिकरण कोड का प्रकार. हमेशा "VERIFY_EMAIL" होना चाहिए।
आईडीटोकन डोरी सत्यापित करने के लिए उपयोगकर्ता का फायरबेस आईडी टोकन।
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
ईमेल डोरी खाते का ईमेल.

नमूना अनुरोध

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: इस पहचानकर्ता के अनुरूप कोई उपयोगकर्ता रिकॉर्ड नहीं है। हो सकता है कि उपयोगकर्ता हटा दिया गया हो.

ईमेल सत्यापन की पुष्टि करें

आप Auth setAccountInfo एंडपॉइंट पर HTTP POST अनुरोध जारी करके ईमेल सत्यापन कोड की पुष्टि कर सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

समापन बिंदु
https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]
बॉडी पेलोड का अनुरोध करें
संपत्ति का नाम प्रकार विवरण
oobCode डोरी ईमेल सत्यापन के लिए उपयोगकर्ता के ईमेल पर कार्रवाई कोड भेजा गया।
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
ईमेल डोरी खाते का ईमेल.
प्रदर्शित होने वाला नाम डोरी खाते के लिए प्रदर्शन नाम.
फोटोयूआरएल डोरी खाते के लिए फोटो यूआरएल.
पासवर्डहैश डोरी पासवर्ड हैश.
प्रदाता उपयोगकर्ता जानकारी JSON ऑब्जेक्ट की सूची सभी लिंक किए गए प्रदाता ऑब्जेक्ट की सूची जिसमें "प्रदाता आईडी" और "फ़ेडरेटेड आईडी" शामिल हैं।
ईमेल सत्यापित हुआ बूलियन खाते का ईमेल सत्यापित किया गया है या नहीं.

नमूना अनुरोध

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: इस पहचानकर्ता के अनुरूप कोई उपयोगकर्ता रिकॉर्ड नहीं है। हो सकता है कि उपयोगकर्ता हटा दिया गया हो.

खाता हटा दो

आप Auth deleteAccount एंडपॉइंट पर HTTP POST अनुरोध जारी करके किसी मौजूदा उपयोगकर्ता को हटा सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

समापन बिंदु
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]"}'

एक सफल अनुरोध को 200 OK HTTP स्थिति कोड द्वारा दर्शाया जाता है।

सामान्य त्रुटि कोड

  • INVALID_ID_TOKEN: उपयोगकर्ता का क्रेडेंशियल अब मान्य नहीं है। उपयोगकर्ता को दोबारा साइन इन करना होगा.
  • USER_NOT_FOUND: इस पहचानकर्ता के अनुरूप कोई उपयोगकर्ता रिकॉर्ड नहीं है। हो सकता है कि उपयोगकर्ता हटा दिया गया हो.

फायरबेस प्रमाणीकरण एम्यूलेटर

फायरबेस लोकल एमुलेटर सूट में एक प्रमाणीकरण एमुलेटर शामिल है, जिसका उपयोग स्थानीय प्रोटोटाइप और प्रमाणीकरण प्रवाह के परीक्षण के लिए किया जा सकता है। एमुलेटर निम्नलिखित REST समापन बिंदुओं को उजागर करता है।

उपयोगकर्ता खाते साफ़ करें

राज्य की परवाह किए बिना, निर्दिष्ट प्रोजेक्ट में सभी खाते हटा दें।

विधि: हटाएँ

endpoint

ध्यान दें कि 9099 प्रमाणीकरण एमुलेटर के लिए डिफ़ॉल्ट पोर्ट है। उपयोग किए जा रहे वास्तविक पोर्ट के लिए टर्मिनल आउटपुट की जाँच करें।

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

एम्यूलेटर कॉन्फ़िगरेशन प्राप्त करें

निर्दिष्ट प्रोजेक्ट के लिए एमुलेटर-विशिष्ट कॉन्फ़िगरेशन प्राप्त करें।

विधि: प्राप्त करें

endpoint

ध्यान दें कि 9099 प्रमाणीकरण एमुलेटर के लिए डिफ़ॉल्ट पोर्ट है। उपयोग किए जा रहे वास्तविक पोर्ट के लिए टर्मिनल आउटपुट की जाँच करें।

http://localhost:9099/emulator/v1/projects/{project-id}/config
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
दाखिल करना वस्तु साइनइन कॉन्फ़िगरेशन ऑब्जेक्ट जिसमें एक कुंजी है, डुप्लिकेटईमेल्स (बूलियन) allowDuplicateEmails

पैच एम्यूलेटर कॉन्फ़िगरेशन

निर्दिष्ट प्रोजेक्ट के लिए एमुलेटर-विशिष्ट कॉन्फ़िगरेशन अपडेट करें।

विधि: पैच

endpoint

ध्यान दें कि 9099 प्रमाणीकरण एमुलेटर के लिए डिफ़ॉल्ट पोर्ट है। उपयोग किए जा रहे वास्तविक पोर्ट के लिए टर्मिनल आउटपुट की जाँच करें।

सामग्री-प्रकार: एप्लिकेशन/जेसन

http://localhost:9099/emulator/v1/projects/{project-id}/config
बॉडी पेलोड का अनुरोध करें
संपत्ति का नाम प्रकार विवरण
दाखिल करना वस्तु एकल कुंजी के साथ वांछित साइनइन कॉन्फ़िगरेशन ऑब्जेक्ट, डुप्लिकेटईमेल्स (बूलियन) allowDuplicateEmails
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
दाखिल करना वस्तु एकल कुंजी के साथ पोस्ट-अनुरोध साइनइन कॉन्फ़िगरेशन ऑब्जेक्ट, allowDuplicateEmails (बूलियन) की अनुमति दें।

आउट-ऑफ़-बैंड प्रमाणीकरण कोड पुनर्प्राप्त करें

यदि आप जिस प्रमाणीकरण प्रवाह का परीक्षण कर रहे हैं वह आम तौर पर आउट-ऑफ-बैंड कोड (उदाहरण के लिए, ईमेल सत्यापन कोड, पासवर्ड रीसेट कोड) उत्पन्न करेगा, तो एमुलेटर ऐसे कोड को आंतरिक रूप से तब तक संग्रहीत करता है जब तक उनका उपयोग नहीं किया जाता है।

विधि: प्राप्त करें

endpoint

ध्यान दें कि 9099 प्रमाणीकरण एमुलेटर के लिए डिफ़ॉल्ट पोर्ट है। उपयोग किए जा रहे वास्तविक पोर्ट के लिए टर्मिनल आउटपुट की जाँच करें।

http://localhost:9099/emulator/v1/projects/{project-id}/oobCodes
रिस्पांस पेलोड
संपत्ति का नाम प्रकार विवरण
oobCodes सरणी वस्तुओं की एक सारणी जिसमें सभी लंबित पुष्टिकरण कोडों का विवरण शामिल है। प्रत्येक ऑब्जेक्ट में email (स्ट्रिंग), oobCode (स्ट्रिंग), oobLink (स्ट्रिंग), और requestType (स्ट्रिंग) शामिल हैं।

एसएमएस सत्यापन कोड पुनः प्राप्त करें

यदि आप फोन/एसएमएस प्रमाणीकरण प्रवाह का परीक्षण कर रहे हैं, तो एमुलेटर ऐसे एसएमएस कोड को आंतरिक रूप से तब तक संग्रहीत करता है जब तक उनका उपयोग नहीं किया जाता है।

विधि: प्राप्त करें

endpoint

ध्यान दें कि 9099 प्रमाणीकरण एमुलेटर के लिए डिफ़ॉल्ट पोर्ट है। उपयोग किए जा रहे वास्तविक पोर्ट के लिए टर्मिनल आउटपुट की जाँच करें।

http://localhost:9099/emulator/v1/projects/{project-id}/verificationCodes
रिस्पांस पेलोड
संपत्ति का नाम प्रकार विवरण
सत्यापन कोड सरणी वस्तुओं की एक सारणी जिसमें सभी लंबित सत्यापन कोडों का विवरण शामिल है। प्रत्येक ऑब्जेक्ट में phoneNumber (स्ट्रिंग) और sessionCode (स्ट्रिंग) होता है।

त्रुटि प्रतिक्रिया

त्रुटि प्रतिक्रिया प्रारूप

जब भी उपरोक्त किसी भी एपीआई के लिए बैकएंड सर्वर से कोई त्रुटि आती है, तो प्रतिक्रिया में निम्नलिखित प्रारूप होगा।

नमूना प्रतिक्रिया

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

त्रुटि कोड संदेश फ़ील्ड से प्राप्त किया जाता है। उपरोक्त सभी त्रुटि कोड संदेश फ़ील्ड सामग्री को संदर्भित करते हैं।

,

एपीआई उपयोग

आप REST API के माध्यम से फायरबेस ऑथ बैकएंड को क्वेरी कर सकते हैं। इसका उपयोग विभिन्न कार्यों के लिए किया जा सकता है जैसे नए उपयोगकर्ता बनाना, मौजूदा उपयोगकर्ताओं में साइन इन करना और इन उपयोगकर्ताओं को संपादित करना या हटाना।

इस संपूर्ण दस्तावेज़ में, API_KEY वेब एपीआई कुंजी को संदर्भित करता है, जिसे आपके व्यवस्थापक कंसोल में प्रोजेक्ट सेटिंग पृष्ठ पर प्राप्त किया जा सकता है।

एक आईडी के लिए कस्टम टोकन एक्सचेंज करें और टोकन रीफ्रेश करें

आप एक आईडी के लिए एक कस्टम ऑथ टोकन का आदान-प्रदान कर सकते हैं और ऑथ verifyCustomToken एंडपॉइंट पर HTTP POST अनुरोध जारी करके टोकन को रीफ्रेश कर सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

समापन बिंदु
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}'

एक सफल अनुरोध को 200 OK HTTP स्थिति कोड द्वारा दर्शाया जाता है। प्रतिक्रिया में फायरबेस आईडी टोकन और कस्टम टोकन के साथ जुड़े टोकन को रिफ्रेश होता है।

नमूना प्रतिक्रिया

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

सामान्य त्रुटि कोड

  • Invalid_custom_token: कस्टम टोकन प्रारूप गलत है या टोकन किसी कारण से अमान्य है (जैसे समाप्त हो गया, अमान्य हस्ताक्षर आदि)
  • क्रेडेंशियल_मिस्मच: कस्टम टोकन एक अलग फायरबेस परियोजना से मेल खाता है।

एक आईडी टोकन के लिए एक ताज़ा टोकन का आदान -प्रदान करें

आप securetoken.googleapis.com एंडपॉइंट पर HTTP POST अनुरोध जारी करके एक फायरबेस आईडी टोकन को ताज़ा कर सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/x-www-form-urlencoded

एंडपॉइंट
https://securetoken.googleapis.com/v1/token?key=[API_KEY]
अनुरोध बॉडी पेलोड
संपत्ति का नाम प्रकार विवरण
अनुदान_प्रकार डोरी रिफ्रेश टोकन के अनुदान प्रकार, हमेशा "REFRESH_TOKEN"।
ताज़ा_टोकन डोरी एक फायरबेस ऑथ रिफ्रेश टोकन।
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
में समाप्त होना डोरी सेकंड की संख्या जिसमें आईडी टोकन समाप्त हो जाता है।
टोकन_प्रकार डोरी रिफ्रेश टोकन का प्रकार, हमेशा "बियरर"।
ताज़ा_टोकन डोरी फायरबेस ऑथ रिफ्रेश टोकन अनुरोध में प्रदान किया गया या एक नया रिफ्रेश टोकन।
आईडी_टोकन डोरी एक फायरबेस ऑथ आईडी टोकन।
उपयोगकर्ता पहचान डोरी प्रदान की गई आईडी टोकन के अनुरूप यूआईडी।
प्रोजेक्ट_आईडी डोरी आपका फायरबेस प्रोजेक्ट आईडी।

नमूना अनुरोध

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 स्थिति कोड द्वारा इंगित किया गया है। प्रतिक्रिया में नई फायरबेस आईडी टोकन और रिफ्रेश टोकन शामिल हैं।

नमूना प्रतिक्रिया

{
  "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: रिफ्रेश टोकन के अनुरूप उपयोगकर्ता नहीं मिला। यह संभावना है कि उपयोगकर्ता को हटा दिया गया था।
  • एपीआई कुंजी मान्य नहीं है। कृपया एक वैध एपीआई कुंजी पास करें। (अमान्य एपीआई कुंजी प्रदान की गई)
  • Invalid_refresh_token: एक अमान्य रिफ्रेश टोकन प्रदान किया जाता है।
  • अमान्य JSON पेलोड प्राप्त हुआ। अज्ञात नाम \ "REFRESH_TOKENS \": क्वेरी पैरामीटर को बांध नहीं सकता। फ़ील्ड 'REFRESH_TOKENS' अनुरोध संदेश में नहीं पाया जा सकता है।
  • Invalid_grant_type: निर्दिष्ट अनुदान प्रकार अमान्य है।
  • लापता_रेफ्रेश_टोकन: कोई रिफ्रेश टोकन प्रदान नहीं किया गया।
  • Project_number_mismatch: रिफ्रेश टोकन की प्रोजेक्ट नंबर एपीआई कुंजी से मेल नहीं खाती है।

ईमेल / पासवर्ड के साथ साइन अप करें

आप Auth signupNewUser समापन बिंदु के लिए HTTP POST अनुरोध जारी करके एक नया ईमेल और पासवर्ड उपयोगकर्ता बना सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

एंडपॉइंट
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}'

एक सफल अनुरोध 200 OK HTTP स्थिति कोड द्वारा इंगित किया गया है। प्रतिक्रिया में फायरबेस आईडी टोकन और नए खाते से जुड़े टोकन को रिफ्रेश करें।

नमूना प्रतिक्रिया

{
  "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 एंडपॉइंट पर जारी कर सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

एंडपॉइंट
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}'

एक सफल अनुरोध 200 OK HTTP स्थिति कोड द्वारा इंगित किया गया है। प्रतिक्रिया में फायरबेस आईडी टोकन और मौजूदा ईमेल/पासवर्ड खाते से जुड़े टोकन को रिफ्रेश करें।

नमूना प्रतिक्रिया

{
  "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 समापन बिंदु पर हस्ताक्षर कर सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

एंडपॉइंट
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}'

एक सफल अनुरोध 200 OK HTTP स्थिति कोड द्वारा इंगित किया गया है। प्रतिक्रिया में फायरबेस आईडी टोकन और रिफ्रेश टोकन शामिल हैं जो अनाम उपयोगकर्ता से जुड़े हैं।

नमूना प्रतिक्रिया

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

सामान्य त्रुटि कोड

  • Operation_not_allowed: अनाम उपयोगकर्ता साइन-इन इस परियोजना के लिए अक्षम है।

Oauth क्रेडेंशियल के साथ साइन इन करें

आप एक OAuth क्रेडेंशियल के साथ एक उपयोगकर्ता में साइन इन कर सकते हैं, जो कि HTTP POST अनुरोध को verifyAssertion ENDPOINT के लिए जारी कर सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

एंडपॉइंट
https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]
अनुरोध बॉडी पेलोड
संपत्ति का नाम प्रकार विवरण
requestUri डोरी URI जिस पर IDP उपयोगकर्ता को वापस पुनर्निर्देशित करता है।
पोस्टबॉडी डोरी ओएथ क्रेडेंशियल (एक आईडी टोकन या एक्सेस टोकन) और प्रदाता आईडी शामिल है जो क्रेडेंशियल जारी करता है।
रिटर्नसुरेटोकन बूलियन एक आईडी वापस करने और टोकन को ताज़ा करने के लिए या नहीं। हमेशा सच होना चाहिए।
वापसी बूलियन क्या निम्नलिखित त्रुटियों पर OAUTH क्रेडेंशियल की वापसी को मजबूर करना है: Federated_user_id_arready_linked और ईमेल_एक्सिस्ट।
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
फेडरेटेडिड डोरी अद्वितीय आईडी IDP खाते की पहचान करता है।
प्रदाताआईडी डोरी लिंक्ड प्रदाता आईडी (जैसे Google प्रदाता के लिए "Google.com")।
लोकलिड डोरी प्रमाणित उपयोगकर्ता का यूआईडी।
ईमेल सत्यापित हुआ बूलियन क्या साइन-इन ईमेल सत्यापित है।
ईमेल डोरी खाते का ईमेल।
oauthidtoken डोरी यदि उपलब्ध हो तो OIDC ID टोकन।
oauthaccesstoken डोरी यदि उपलब्ध हो तो Oauth एक्सेस टोकन।
ओआथटोकेंसेक्रेट डोरी यदि उपलब्ध हो तो Oauth 1.0 टोकन रहस्य।
rawuserinfo डोरी प्रदान किए गए OAuth क्रेडेंशियल के अनुरूप सभी IDP डेटा वाले स्ट्रिंग JSON प्रतिक्रिया।
पहला नाम डोरी खाते के लिए पहला नाम।
उपनाम डोरी खाते के लिए अंतिम नाम।
पूरा नाम डोरी खाते के लिए पूरा नाम।
प्रदर्शित होने वाला नाम डोरी खाते के लिए प्रदर्शन नाम।
फोटोरल डोरी खाते के लिए फोटो URL।
आईडीटोकन डोरी प्रमाणित उपयोगकर्ता के लिए एक फायरबेस ऑथ आईडी टोकन।
ताज़ाटोकन डोरी प्रमाणित उपयोगकर्ता के लिए एक फायरबेस ऑथ रिफ्रेश टोकन।
में समाप्त होना डोरी सेकंड की संख्या जिसमें आईडी टोकन समाप्त हो जाता है।
आवश्यकता है बूलियन क्या एक ही क्रेडेंशियल के साथ एक और खाता पहले से मौजूद है। उपयोगकर्ता को मूल खाते में साइन इन करना होगा और फिर वर्तमान क्रेडेंशियल को लिंक करना होगा।

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

एक सफल अनुरोध 200 OK HTTP स्थिति कोड द्वारा इंगित किया गया है। प्रतिक्रिया में फायरबेस आईडी टोकन और रीफ्रेश टोकन शामिल हैं जो प्रमाणित उपयोगकर्ता के साथ जुड़े हैं।

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

एक सफल अनुरोध 200 OK HTTP स्थिति कोड द्वारा इंगित किया गया है। प्रतिक्रिया में फायरबेस आईडी टोकन और रीफ्रेश टोकन शामिल हैं जो प्रमाणित उपयोगकर्ता के साथ जुड़े हैं।

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 क्रेडेंशियल के साथ नमूना अनुरोध

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 स्थिति कोड द्वारा इंगित किया गया है। प्रतिक्रिया में फायरबेस आईडी टोकन और रीफ्रेश टोकन शामिल हैं जो प्रमाणित उपयोगकर्ता के साथ जुड़े हैं।

ट्विटर 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: आपूर्ति की गई साख को विकृत किया गया है या समाप्त हो गया है।

ईमेल के लिए प्रदाताओं को प्राप्त करें

आप एक निर्दिष्ट ईमेल से जुड़े सभी प्रदाताओं को createAuthUri एंडपॉइंट के लिए HTTP POST अनुरोध जारी करके देख सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

एंडपॉइंट
https://identitytoolkit.googleapis.com/v1/accounts:createAuthUri?key=[API_KEY]
अनुरोध बॉडी पेलोड
संपत्ति का नाम प्रकार विवरण
पहचानकर्ता डोरी उपयोगकर्ता का ईमेल पता
Suctonuri डोरी URI जिस पर IDP उपयोगकर्ता को वापस पुनर्निर्देशित करता है। इस उपयोग के मामले के लिए, यह सिर्फ वर्तमान URL है।
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
allproviders तारों की सूची उन प्रदाताओं की सूची जो उपयोगकर्ता ने पहले हस्ताक्षर किए हैं।
दर्ज कराई बूलियन क्या ईमेल किसी मौजूदा खाते के लिए है

नमूना अनुरोध

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: ईमेल पता बुरी तरह से स्वरूपित है।

पासवर्ड रीसेट ईमेल भेजें

आप Auth getOobConfirmationCode EndPoint को HTTP POST अनुरोध जारी करके एक पासवर्ड रीसेट ईमेल भेज सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

एंडपॉइंट
https://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]
वैकल्पिक हेडर
संपत्ति का नाम विवरण
एक्स-फायरबेस-लोकेल उपयोगकर्ता के स्थान के अनुरूप भाषा कोड। इसे पास करने से उपयोगकर्ता को भेजे गए पासवर्ड रीसेट ईमेल को स्थानीय बनाया जाएगा।
बॉडी पेलोड का अनुरोध करें
संपत्ति का नाम प्रकार विवरण
अनुरोध का प्रकार डोरी वापसी करने के लिए OOB कोड का प्रकार। पासवर्ड रीसेट के लिए "पासवर्ड_सेट" होना चाहिए।
ईमेल डोरी उपयोगकर्ता का ईमेल पता.
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
ईमेल डोरी उपयोगकर्ता का ईमेल पता.

नमूना अनुरोध

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

एक सफल अनुरोध 200 OK HTTP स्थिति कोड द्वारा इंगित किया गया है।

नमूना प्रतिक्रिया

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

सामान्य त्रुटि कोड

  • EMAIL_NOT_FOUND: इस पहचानकर्ता के अनुरूप कोई उपयोगकर्ता रिकॉर्ड नहीं है। हो सकता है कि उपयोगकर्ता हटा दिया गया हो.

पासवर्ड रीसेट कोड सत्यापित करें

आप Auth resetPassword EndPoint के लिए HTTP POST अनुरोध जारी करके एक पासवर्ड रीसेट कोड सत्यापित कर सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

एंडपॉइंट
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]"}'

एक सफल अनुरोध 200 OK HTTP स्थिति कोड द्वारा इंगित किया गया है।

नमूना प्रतिक्रिया

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

सामान्य त्रुटि कोड

  • Operation_not_allowed: पासवर्ड साइन-इन इस प्रोजेक्ट के लिए अक्षम है।
  • Expired_oob_code: एक्शन कोड समाप्त हो गया है।
  • Invalid_OOB_CODE: एक्शन कोड अमान्य है। यह तब हो सकता है जब कोड विकृत हो गया, समाप्त हो गया, या पहले से ही उपयोग किया गया हो।

पासवर्ड रीसेट की पुष्टि करें

आप Auth resetPassword समापन बिंदु के लिए HTTP POST अनुरोध जारी करके एक पासवर्ड रीसेट परिवर्तन लागू कर सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

एंडपॉइंट
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]"}'

एक सफल अनुरोध 200 OK HTTP स्थिति कोड द्वारा इंगित किया गया है।

नमूना प्रतिक्रिया

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

सामान्य त्रुटि कोड

  • Operation_not_allowed: पासवर्ड साइन-इन इस प्रोजेक्ट के लिए अक्षम है।
  • Expired_oob_code: एक्शन कोड समाप्त हो गया है।
  • Invalid_OOB_CODE: एक्शन कोड अमान्य है। यह तब हो सकता है जब कोड विकृत हो गया, समाप्त हो गया, या पहले से ही उपयोग किया गया हो।
  • User_disabled: उपयोगकर्ता खाता एक व्यवस्थापक द्वारा अक्षम कर दिया गया है।

बदले ई - मेल

आप Auth setAccountInfo एंडपॉइंट के लिए HTTP POST अनुरोध जारी करके उपयोगकर्ता के ईमेल को बदल सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

एंडपॉइंट
https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]
वैकल्पिक हेडर
संपत्ति का नाम विवरण
एक्स-फायरबेस-लोकेल उपयोगकर्ता के स्थान के अनुरूप भाषा कोड। इसे पास करने से उपयोगकर्ता को भेजे गए ईमेल परिवर्तन निरसन को स्थानीय बनाया जाएगा।
बॉडी पेलोड का अनुरोध करें
संपत्ति का नाम प्रकार विवरण
आईडीटोकन डोरी उपयोगकर्ता के लिए एक फायरबेस ऑथ आईडी टोकन।
ईमेल डोरी उपयोगकर्ता का नया ईमेल।
रिटर्नसुरेटोकन बूलियन एक आईडी वापस करने और टोकन को ताज़ा करने के लिए या नहीं।
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
लोकलिड डोरी वर्तमान उपयोगकर्ता का यूआईडी।
ईमेल डोरी उपयोगकर्ता का ईमेल पता.
पासवर्डहैश डोरी पासवर्ड का हैश संस्करण।
प्रदाता उपयोगकर्ता जानकारी JSON ऑब्जेक्ट्स की सूची सभी लिंक किए गए प्रदाता वस्तुओं की सूची जिसमें "प्रदाता" और "फेडरेटेड" शामिल हैं।
आईडीटोकन डोरी उपयोगकर्ता के लिए नया फायरबेस ऑथ आईडी टोकन।
ताज़ाटोकन डोरी एक फायरबेस ऑथ रिफ्रेश टोकन।
में समाप्त होना डोरी सेकंड की संख्या जिसमें आईडी टोकन समाप्त हो जाता है।

नमूना अनुरोध

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

एक सफल अनुरोध 200 OK HTTP स्थिति कोड द्वारा इंगित किया गया है। प्रतिक्रिया में नई फायरबेस आईडी टोकन और उपयोगकर्ता के साथ जुड़े टोकन को रिफ्रेश करें।

नमूना प्रतिक्रिया

{
  "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: उपयोगकर्ता की क्रेडेंशियल अब मान्य नहीं है। उपयोगकर्ता को फिर से साइन इन करना होगा।

पासवर्ड बदलें

आप Auth setAccountInfo एंडपॉइंट के लिए HTTP POST अनुरोध जारी करके उपयोगकर्ता का पासवर्ड बदल सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

एंडपॉइंट
https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]
अनुरोध बॉडी पेलोड
संपत्ति का नाम प्रकार विवरण
आईडीटोकन डोरी उपयोगकर्ता के लिए एक फायरबेस ऑथ आईडी टोकन।
पासवर्ड डोरी उपयोगकर्ता का नया पासवर्ड।
रिटर्नसुरेटोकन बूलियन एक आईडी वापस करने और टोकन को ताज़ा करने के लिए या नहीं।
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
लोकलिड डोरी वर्तमान उपयोगकर्ता का यूआईडी।
ईमेल डोरी उपयोगकर्ता का ईमेल पता.
पासवर्डहैश डोरी पासवर्ड का हैश संस्करण।
प्रदाता उपयोगकर्ता जानकारी JSON ऑब्जेक्ट्स की सूची सभी लिंक किए गए प्रदाता वस्तुओं की सूची जिसमें "प्रदाता" और "फेडरेटेड" शामिल हैं।
आईडीटोकन डोरी उपयोगकर्ता के लिए नया फायरबेस ऑथ आईडी टोकन।
ताज़ाटोकन डोरी एक फायरबेस ऑथ रिफ्रेश टोकन।
में समाप्त होना डोरी सेकंड की संख्या जिसमें आईडी टोकन समाप्त हो जाता है।

नमूना अनुरोध

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 स्थिति कोड द्वारा इंगित किया गया है। प्रतिक्रिया में नई फायरबेस आईडी टोकन और उपयोगकर्ता के साथ जुड़े टोकन को रिफ्रेश करें।

नमूना प्रतिक्रिया

{
  "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 वर्ण लंबा या अधिक होना चाहिए।

प्रोफ़ाइल अपडेट करें

आप Auth setAccountInfo एंडपॉइंट के लिए HTTP POST अनुरोध जारी करके उपयोगकर्ता की प्रोफ़ाइल (प्रदर्शन नाम / फोटो URL) को अपडेट कर सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

एंडपॉइंट
https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]
अनुरोध बॉडी पेलोड
संपत्ति का नाम प्रकार विवरण
आईडीटोकन डोरी उपयोगकर्ता के लिए एक फायरबेस ऑथ आईडी टोकन।
प्रदर्शित होने वाला नाम डोरी उपयोगकर्ता का नया प्रदर्शन नाम।
फोटोरल डोरी उपयोगकर्ता का नया फोटो URL।
हटाएँविशेषताएँ तारों की सूची हटाने के लिए विशेषताओं की सूची, "display_name" या "photo_url"। यह इन मूल्यों को शून्य कर देगा।
रिटर्नसुरेटोकन बूलियन एक आईडी वापस करने और टोकन को ताज़ा करने के लिए या नहीं।
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
लोकलिड डोरी वर्तमान उपयोगकर्ता का यूआईडी।
ईमेल डोरी उपयोगकर्ता का ईमेल पता.
प्रदर्शित होने वाला नाम डोरी उपयोगकर्ता का नया प्रदर्शन नाम।
फोटोरल डोरी उपयोगकर्ता का नया फोटो URL।
पासवर्डहैश डोरी पासवर्ड का हैश संस्करण।
प्रदाता उपयोगकर्ता जानकारी JSON ऑब्जेक्ट्स की सूची सभी लिंक किए गए प्रदाता वस्तुओं की सूची जिसमें "प्रदाता" और "फेडरेटेड" शामिल हैं।
आईडीटोकन डोरी उपयोगकर्ता के लिए नया फायरबेस ऑथ आईडी टोकन।
ताज़ाटोकन डोरी एक फायरबेस ऑथ रिफ्रेश टोकन।
में समाप्त होना डोरी सेकंड की संख्या जिसमें आईडी टोकन समाप्त हो जाता है।

नमूना अनुरोध

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: उपयोगकर्ता की क्रेडेंशियल अब मान्य नहीं है। उपयोगकर्ता को फिर से साइन इन करना होगा।

उपयोगकर्ता डेटा प्राप्त करें

आप Auth getAccountInfo एंडपॉइंट के लिए HTTP POST अनुरोध जारी करके उपयोगकर्ता का डेटा प्राप्त कर सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

एंडपॉइंट
https://identitytoolkit.googleapis.com/v1/accounts:lookup?key=[API_KEY]
अनुरोध बॉडी पेलोड
संपत्ति का नाम प्रकार विवरण
आईडीटोकन डोरी खाते का फायरबेस आईडी टोकन।
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
उपयोगकर्ताओं JSON ऑब्जेक्ट्स की सूची दिए गए फायरबेस आईडी टोकन से जुड़ा खाता। अधिक विवरण के लिए नीचे देखें.
प्रतिक्रिया पेलोड ( users सरणी सामग्री)
संपत्ति का नाम प्रकार विवरण
लोकलिड डोरी वर्तमान उपयोगकर्ता का यूआईडी।
ईमेल डोरी खाते का ईमेल।
ईमेल सत्यापित हुआ बूलियन खाते के ईमेल को सत्यापित किया गया है या नहीं।
प्रदर्शित होने वाला नाम डोरी खाते के लिए प्रदर्शन नाम।
प्रदाता उपयोगकर्ता जानकारी JSON ऑब्जेक्ट्स की सूची सभी लिंक किए गए प्रदाता वस्तुओं की सूची जिसमें "प्रदाता" और "फेडरेटेड" शामिल हैं।
फोटोरल डोरी खाते के लिए फोटो URL।
पासवर्डहैश डोरी पासवर्ड का हैश संस्करण।
passwordupdatedat दोहरा टाइमस्टैम्प, मिलीसेकंड में, कि खाता पासवर्ड को अंतिम बार बदल दिया गया था।
मान्य डोरी टाइमस्टैम्प, सेकंड में, जो एक सीमा को चिह्नित करता है, जिसके पहले फायरबेस आईडी टोकन को निरस्त माना जाता है।
अक्षम बूलियन खाता अक्षम है या नहीं।
लास्टलोगिनाट डोरी टाइमस्टैम्प, मिलीसेकंड में, कि खाता अंतिम बार में लॉग इन किया गया था।
पर बनाया गया डोरी टाइमस्टैम्प, मिलीसेकंड में, कि खाता बनाया गया था।
CustomAuth बूलियन क्या खाता डेवलपर द्वारा प्रमाणित किया गया है या नहीं।

नमूना अनुरोध

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

एक सफल अनुरोध 200 OK HTTP स्थिति कोड द्वारा इंगित किया गया है। प्रतिक्रिया में खाते से जुड़ी सभी उपयोगकर्ता जानकारी शामिल होगी।

नमूना प्रतिक्रिया

{
  "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 एंडपॉइंट को लिंक कर सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

एंडपॉइंट
https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]
अनुरोध बॉडी पेलोड
संपत्ति का नाम प्रकार विवरण
आईडीटोकन डोरी उस खाते का फायरबेस आईडी टोकन जिसे आप क्रेडेंशियल को लिंक करने की कोशिश कर रहे हैं।
ईमेल डोरी खाते से लिंक करने के लिए ईमेल।
पासवर्ड डोरी खाते का नया पासवर्ड।
रिटर्नसुरेटोकन डोरी एक आईडी वापस करने और टोकन को ताज़ा करने के लिए या नहीं। हमेशा सच होना चाहिए।
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
लोकलिड डोरी वर्तमान उपयोगकर्ता का यूआईडी।
ईमेल डोरी खाते का ईमेल।
प्रदर्शित होने वाला नाम डोरी खाते के लिए प्रदर्शन नाम।
फोटोरल डोरी खाते के लिए फोटो URL।
पासवर्डहैश डोरी पासवर्ड का हैश संस्करण।
प्रदाता उपयोगकर्ता जानकारी JSON ऑब्जेक्ट्स की सूची सभी लिंक किए गए प्रदाता वस्तुओं की सूची जिसमें "प्रदाता" और "फेडरेटेड" शामिल हैं।
ईमेल सत्यापित हुआ बूलियन खाते के ईमेल को सत्यापित किया गया है या नहीं।
आईडीटोकन डोरी उपयोगकर्ता के लिए नया फायरबेस ऑथ आईडी टोकन।
ताज़ाटोकन डोरी एक फायरबेस ऑथ रिफ्रेश टोकन।
में समाप्त होना डोरी सेकंड की संख्या जिसमें आईडी टोकन समाप्त हो जाता है।

नमूना अनुरोध

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 स्थिति कोड द्वारा इंगित किया गया है। प्रतिक्रिया में फायरबेस आईडी टोकन और रीफ्रेश टोकन शामिल हैं जो प्रमाणित उपयोगकर्ता के साथ जुड़े हैं।

नमूना प्रतिक्रिया

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

सामान्य त्रुटि कोड

  • क्रेडेंशियल_टू_ोल्ड_लोगिन_गैन: उपयोगकर्ता की क्रेडेंशियल अब मान्य नहीं है। उपयोगकर्ता को फिर से साइन इन करना होगा।
  • TOKEN_EXPIRED: उपयोगकर्ता की क्रेडेंशियल अब मान्य नहीं है। उपयोगकर्ता को फिर से साइन इन करना होगा।
  • Invalid_id_token: उपयोगकर्ता की क्रेडेंशियल अब मान्य नहीं है। उपयोगकर्ता को फिर से साइन इन करना होगा।
  • Weak_password: पासवर्ड 6 वर्ण लंबा या अधिक होना चाहिए।

आप एक OAuth क्रेडेंशियल को उपयोगकर्ता को HTTP POST अनुरोध जारी करके ऑटिट verifyAssertion एंडपॉइंट के लिए एक उपयोगकर्ता से लिंक कर सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

एंडपॉइंट
https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]
अनुरोध बॉडी पेलोड
संपत्ति का नाम प्रकार विवरण
आईडीटोकन डोरी उस खाते का फायरबेस आईडी टोकन जिसे आप क्रेडेंशियल को लिंक करने की कोशिश कर रहे हैं।
requestUri डोरी URI जिस पर IDP उपयोगकर्ता को वापस पुनर्निर्देशित करता है।
पोस्टबॉडी डोरी ओएथ क्रेडेंशियल (एक आईडी टोकन या एक्सेस टोकन) और प्रदाता आईडी शामिल है जो क्रेडेंशियल जारी करता है।
रिटर्नसुरेटोकन बूलियन एक आईडी वापस करने और टोकन को ताज़ा करने के लिए या नहीं। हमेशा सच होना चाहिए।
वापसी बूलियन क्या निम्नलिखित त्रुटियों पर OAUTH क्रेडेंशियल की वापसी को मजबूर करना है: Federated_user_id_arready_linked और ईमेल_एक्सिस्ट।
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
फेडरेटेडिड डोरी अद्वितीय आईडी IDP खाते की पहचान करता है।
प्रदाताआईडी डोरी लिंक्ड प्रदाता आईडी (जैसे Google प्रदाता के लिए "Google.com")।
लोकलिड डोरी प्रमाणित उपयोगकर्ता का यूआईडी।
ईमेल सत्यापित हुआ बूलियन क्या साइनिन ईमेल सत्यापित है।
ईमेल डोरी खाते का ईमेल।
oauthidtoken डोरी यदि उपलब्ध हो तो OIDC ID टोकन।
oauthaccesstoken डोरी यदि उपलब्ध हो तो Oauth एक्सेस टोकन।
ओआथटोकेंसेक्रेट डोरी यदि उपलब्ध हो तो Oauth 1.0 टोकन रहस्य।
rawuserinfo डोरी प्रदान किए गए OAuth क्रेडेंशियल के अनुरूप सभी IDP डेटा वाले स्ट्रिंग JSON प्रतिक्रिया।
पहला नाम डोरी खाते के लिए पहला नाम।
उपनाम डोरी खाते के लिए अंतिम नाम।
पूरा नाम डोरी खाते के लिए पूरा नाम।
प्रदर्शित होने वाला नाम डोरी खाते के लिए प्रदर्शन नाम।
फोटोरल डोरी खाते के लिए फोटो URL।
आईडीटोकन डोरी प्रमाणित उपयोगकर्ता के लिए एक फायरबेस ऑथ आईडी टोकन।
ताज़ाटोकन डोरी प्रमाणित उपयोगकर्ता के लिए एक फायरबेस ऑथ रिफ्रेश टोकन।
में समाप्त होना डोरी सेकंड की संख्या जिसमें आईडी टोकन समाप्त हो जाता है।

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

एक सफल अनुरोध 200 OK HTTP स्थिति कोड द्वारा इंगित किया गया है। प्रतिक्रिया में फायरबेस आईडी टोकन और रीफ्रेश टोकन शामिल हैं जो प्रमाणित उपयोगकर्ता के साथ जुड़े हैं।

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

एक सफल अनुरोध 200 OK HTTP स्थिति कोड द्वारा इंगित किया गया है। प्रतिक्रिया में फायरबेस आईडी टोकन और रीफ्रेश टोकन शामिल हैं जो प्रमाणित उपयोगकर्ता के साथ जुड़े हैं।

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 क्रेडेंशियल के साथ नमूना अनुरोध

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 स्थिति कोड द्वारा इंगित किया गया है। प्रतिक्रिया में फायरबेस आईडी टोकन और रीफ्रेश टोकन शामिल हैं जो प्रमाणित उपयोगकर्ता के साथ जुड़े हैं।

ट्विटर 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_ARERDY_LINKED: यह क्रेडेंशियल पहले से ही एक अलग उपयोगकर्ता खाते से जुड़ा हुआ है।

आप एक वर्तमान उपयोगकर्ता से एक प्रदाता को Auth setAccountInfo एंडपॉइंट के लिए HTTP POST अनुरोध जारी करके एक प्रदाता को अनलिंक कर सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

एंडपॉइंट
https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]
अनुरोध बॉडी पेलोड
संपत्ति का नाम प्रकार विवरण
आईडीटोकन डोरी खाते का फायरबेस आईडी टोकन।
डिलीटप्रोवाइडर तारों की सूची प्रदाता आईडी की सूची अनलिंक करने के लिए, जैसे: 'Google.com', 'पासवर्ड', आदि।
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
लोकलिड डोरी वर्तमान उपयोगकर्ता का यूआईडी।
ईमेल डोरी खाते का ईमेल।
प्रदर्शित होने वाला नाम डोरी खाते के लिए प्रदर्शन नाम।
फोटोरल डोरी खाते के लिए फोटो URL।
पासवर्डहैश डोरी पासवर्ड का हैश संस्करण।
प्रदाता उपयोगकर्ता जानकारी JSON ऑब्जेक्ट्स की सूची सभी लिंक किए गए प्रदाता वस्तुओं की सूची जिसमें "प्रदाता" और "फेडरेटेड" शामिल हैं।
ईमेल सत्यापित हुआ बूलियन खाते के ईमेल को सत्यापित किया गया है या नहीं।

नमूना अनुरोध

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 समापन बिंदु पर है।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

एंडपॉइंट
https://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]
वैकल्पिक हेडर
संपत्ति का नाम विवरण
एक्स-फायरबेस-लोकेल उपयोगकर्ता के स्थान के अनुरूप भाषा कोड। इसे पास करने से उपयोगकर्ता को भेजे गए ईमेल सत्यापन को स्थानीय बनाया जाएगा।
बॉडी पेलोड का अनुरोध करें
संपत्ति का नाम प्रकार विवरण
अनुरोध का प्रकार डोरी भेजने के लिए पुष्टिकरण कोड का प्रकार। हमेशा "Verify_email" होना चाहिए।
आईडीटोकन डोरी सत्यापित करने के लिए उपयोगकर्ता के फायरबेस आईडी टोकन।
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
ईमेल डोरी खाते का ईमेल।

नमूना अनुरोध

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: इस पहचानकर्ता के अनुरूप कोई उपयोगकर्ता रिकॉर्ड नहीं है। हो सकता है कि उपयोगकर्ता हटा दिया गया हो.

ईमेल सत्यापन की पुष्टि करें

आप Auth setAccountInfo एंडपॉइंट के लिए HTTP POST अनुरोध जारी करके एक ईमेल सत्यापन कोड की पुष्टि कर सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

एंडपॉइंट
https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]
अनुरोध बॉडी पेलोड
संपत्ति का नाम प्रकार विवरण
ओबकोड डोरी ईमेल सत्यापन के लिए उपयोगकर्ता के ईमेल को भेजा गया एक्शन कोड।
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
ईमेल डोरी खाते का ईमेल।
प्रदर्शित होने वाला नाम डोरी खाते के लिए प्रदर्शन नाम।
फोटोरल डोरी खाते के लिए फोटो URL।
पासवर्डहैश डोरी पासवर्ड हैश.
प्रदाता उपयोगकर्ता जानकारी JSON ऑब्जेक्ट्स की सूची सभी लिंक किए गए प्रदाता वस्तुओं की सूची जिसमें "प्रदाता" और "फेडरेटेड" शामिल हैं।
ईमेल सत्यापित हुआ बूलियन खाते के ईमेल को सत्यापित किया गया है या नहीं।

नमूना अनुरोध

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: इस पहचानकर्ता के अनुरूप कोई उपयोगकर्ता रिकॉर्ड नहीं है। हो सकता है कि उपयोगकर्ता हटा दिया गया हो.

खाता हटा दो

आप एक वर्तमान उपयोगकर्ता को Auth deleteAccount समापन बिंदु के लिए HTTP POST अनुरोध जारी करके हटा सकते हैं।

विधि: पोस्ट

सामग्री-प्रकार: एप्लिकेशन/जेसन

एंडपॉइंट
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]"}'

एक सफल अनुरोध 200 OK HTTP स्थिति कोड द्वारा इंगित किया गया है।

सामान्य त्रुटि कोड

  • Invalid_id_token: उपयोगकर्ता की क्रेडेंशियल अब मान्य नहीं है। उपयोगकर्ता को फिर से साइन इन करना होगा।
  • User_not_found: इस पहचानकर्ता के अनुरूप कोई उपयोगकर्ता रिकॉर्ड नहीं है। हो सकता है कि उपयोगकर्ता हटा दिया गया हो.

फायरबेस प्रमाणीकरण एमुलेटर

फायरबेस स्थानीय एमुलेटर सूट में एक प्रमाणीकरण एमुलेटर शामिल है, जिसका उपयोग स्थानीय प्रोटोटाइपिंग और प्रमाणीकरण प्रवाह के परीक्षण के लिए किया जा सकता है। एमुलेटर निम्नलिखित REST एंडपॉइंट्स को उजागर करता है।

उपयोगकर्ता खातों को साफ़ करें

राज्य की परवाह किए बिना निर्दिष्ट परियोजना में सभी खातों को हटा दें।

विधि: हटाएँ

endpoint

ध्यान दें कि 9099 प्रमाणीकरण एमुलेटर के लिए डिफ़ॉल्ट पोर्ट है। उपयोग किए जा रहे वास्तविक पोर्ट के लिए टर्मिनल आउटपुट की जाँच करें।

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

एमुलेटर कॉन्फ़िगरेशन प्राप्त करें

निर्दिष्ट परियोजना के लिए एमुलेटर-विशिष्ट कॉन्फ़िगरेशन प्राप्त करें।

विधि: प्राप्त करें

endpoint

ध्यान दें कि 9099 प्रमाणीकरण एमुलेटर के लिए डिफ़ॉल्ट पोर्ट है। उपयोग किए जा रहे वास्तविक पोर्ट के लिए टर्मिनल आउटपुट की जाँच करें।

http://localhost:9099/emulator/v1/projects/{project-id}/config
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
दाखिल करना वस्तु साइनिन कॉन्फ़िगरेशन ऑब्जेक्ट जिसमें एक एकल कुंजी है, allowDuplicateEmails (बूलियन)।

पैच एमुलेटर विन्यास

निर्दिष्ट परियोजना के लिए एमुलेटर-विशिष्ट कॉन्फ़िगरेशन को अपडेट करें।

विधि: पैच

endpoint

ध्यान दें कि 9099 प्रमाणीकरण एमुलेटर के लिए डिफ़ॉल्ट पोर्ट है। उपयोग किए जा रहे वास्तविक पोर्ट के लिए टर्मिनल आउटपुट की जाँच करें।

सामग्री-प्रकार: एप्लिकेशन/जेसन

http://localhost:9099/emulator/v1/projects/{project-id}/config
अनुरोध बॉडी पेलोड
संपत्ति का नाम प्रकार विवरण
दाखिल करना वस्तु एकल कुंजी के साथ वांछित हस्ताक्षर कॉन्फ़िगरेशन ऑब्जेक्ट, allowDuplicateEmails (बूलियन)।
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
दाखिल करना वस्तु सिंगल कुंजी के साथ पोस्ट-रिक्वेस्ट साइनिन कॉन्फ़िगरेशन ऑब्जेक्ट, allowDuplicateEmails (बूलियन)।

आउट-ऑफ-बैंड प्रमाणीकरण कोड प्राप्त करें

यदि आप जिस प्रमाणीकरण प्रवाह का परीक्षण कर रहे हैं, वह सामान्य रूप से आउट-ऑफ-बैंड कोड (जैसे, ईमेल सत्यापन कोड, पासवर्ड रीसेट कोड) उत्पन्न करेगा, तो एमुलेटर इस तरह के कोड को आंतरिक रूप से संग्रहीत करता है जब तक कि वे उपयोग नहीं किए जाते हैं।

विधि: प्राप्त करें

endpoint

ध्यान दें कि 9099 प्रमाणीकरण एमुलेटर के लिए डिफ़ॉल्ट पोर्ट है। उपयोग किए जा रहे वास्तविक पोर्ट के लिए टर्मिनल आउटपुट की जाँच करें।

http://localhost:9099/emulator/v1/projects/{project-id}/oobCodes
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
ओबकोड्स सरणी सभी लंबित पुष्टिकरण कोड का विवरण युक्त वस्तुओं की एक सरणी। प्रत्येक ऑब्जेक्ट में email (स्ट्रिंग), oobCode (स्ट्रिंग), oobLink (स्ट्रिंग), और requestType (स्ट्रिंग) शामिल हैं

एसएमएस सत्यापन कोड प्राप्त करें

यदि आप फोन/एसएमएस प्रमाणीकरण प्रवाह का परीक्षण कर रहे हैं, तो एमुलेटर ऐसे एसएमएस कोड को आंतरिक रूप से संग्रहीत करता है जब तक कि उनका उपयोग नहीं किया जाता है।

विधि: प्राप्त करें

endpoint

ध्यान दें कि 9099 प्रमाणीकरण एमुलेटर के लिए डिफ़ॉल्ट पोर्ट है। उपयोग किए जा रहे वास्तविक पोर्ट के लिए टर्मिनल आउटपुट की जाँच करें।

http://localhost:9099/emulator/v1/projects/{project-id}/verificationCodes
प्रतिक्रिया पेलोड
संपत्ति का नाम प्रकार विवरण
सत्यापन कोड सरणी सभी लंबित सत्यापन कोड का विवरण युक्त वस्तुओं की एक सरणी। प्रत्येक ऑब्जेक्ट में phoneNumber (स्ट्रिंग) और sessionCode (स्ट्रिंग) होता है।

त्रुटि प्रतिक्रिया

त्रुटि प्रतिक्रिया प्रारूप

किसी भी समय API के ऊपर से किसी भी API के लिए बैकएंड सर्वर से कोई त्रुटि वापस कर दी जाती है, प्रतिक्रिया में निम्नलिखित प्रारूप होगा।

नमूना प्रतिक्रिया

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

त्रुटि कोड संदेश फ़ील्ड से प्राप्त होता है। उपरोक्त सभी त्रुटि कोड संदेश फ़ील्ड सामग्री को संदर्भित करते हैं।