एपीआई का इस्तेमाल
REST API की मदद से, Firebase पुष्टि वाले बैकएंड से क्वेरी की जा सकती है. इसका इस्तेमाल अलग-अलग कामों में किया जा सकता है, जैसे कि जैसे कि नए उपयोगकर्ता बनाना, मौजूदा उपयोगकर्ताओं को साइन इन करना और इन उपयोगकर्ताओं में बदलाव करना या उन्हें मिटाना.
इस पूरे दस्तावेज़ में, API_KEY
, वेब एपीआई पासकोड से जुड़ा है,
जिसे यहां जाकर देखा जा सकता है:
प्रोजेक्ट की सेटिंग
पेज पर जाएं.
किसी आईडी और रीफ़्रेश टोकन के लिए कस्टम टोकन एक्सचेंज करें
एचटीटीपी जारी करके, कस्टम ऑथराइज़ेशन टोकन को किसी आईडी के बदले और रीफ़्रेश टोकन से बदला जा सकता है
पुष्टि करने के verifyCustomToken
एंडपॉइंट के लिए POST
अनुरोध.
तरीका: POST
कॉन्टेंट का टाइप: ऐप्लिकेशन/JSON
एंडपॉइंटhttps://identitytoolkit.googleapis.com/v1/accounts:signInWithCustomToken?key=[API_KEY]
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
टोकन | स्ट्रिंग | Firebase पुष्टि करने वाला कस्टम टोकन, जिससे आईडी बनाया जाता है और टोकन का जोड़ा रीफ़्रेश किया जाता है. |
वापस करने के लिए सुरक्षित टोकन | बूलियन | आईडी और रीफ़्रेश टोकन दिखाना है या नहीं. हमेशा सही होना चाहिए. |
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
आईडीटोकन | स्ट्रिंग | दिए गए कस्टम टोकन से Firebase का पुष्टि आईडी टोकन जनरेट किया गया. |
रीफ़्रेश टोकन | स्ट्रिंग | उपलब्ध कराए गए कस्टम टोकन से, Firebase की पुष्टि करने वाला रीफ़्रेश टोकन जनरेट किया गया. |
समयसीमा खत्म होने की तारीख | स्ट्रिंग | आईडी टोकन की समयसीमा खत्म होने के सेकंड. |
अनुरोध का सैंपल
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
एचटीटीपी है
स्टेटस कोड डालें. रिस्पॉन्स में Firebase आईडी टोकन और रीफ़्रेश टोकन शामिल होता है
का इस्तेमाल करें.
जवाब का सैंपल
{ "idToken": "[ID_TOKEN]", "refreshToken": "[REFRESH_TOKEN]", "expiresIn": "3600" }
सामान्य गड़बड़ियों के कोड
- INVALID_CUSTOM_TOKEN: कस्टम टोकन फ़ॉर्मैट गलत है या टोकन इनके लिए अमान्य है कोई वजह हो सकती है (जैसे, समयसीमा खत्म हो गई हो, हस्ताक्षर गलत हो वगैरह)
- CREDENTIAL_MISMATCH: कस्टम टोकन, किसी दूसरे Firebase प्रोजेक्ट से जुड़ा होता है.
किसी आईडी टोकन के लिए रीफ़्रेश टोकन का एक्सचेंज करना
एचटीटीपी जारी करके, Firebase आईडी टोकन को रीफ़्रेश किया जा सकता है
securetoken.googleapis.com
एंडपॉइंट को POST
अनुरोध भेजा गया.
तरीका: POST
कॉन्टेंट का टाइप: application/x-www-form-urlencoded
एंडपॉइंटhttps://securetoken.googleapis.com/v1/token?key=[API_KEY]
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
grant_type | स्ट्रिंग | रीफ़्रेश टोकन का ग्रांट टाइप, हमेशा "refresh_token". |
रीफ़्रेश_टोकन | स्ट्रिंग | Firebase पुष्टि वाला रीफ़्रेश टोकन. |
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
expires_in | स्ट्रिंग | आईडी टोकन की समयसीमा खत्म होने के सेकंड. |
token_type | स्ट्रिंग | रीफ़्रेश टोकन का टाइप, हमेशा "Bearer" होता है. |
रीफ़्रेश_टोकन | स्ट्रिंग | अनुरोध में दिया गया Firebase पुष्टि टोकन या नया रीफ़्रेश टोकन. |
id_token | स्ट्रिंग | Firebase पुष्टि आईडी टोकन. |
user_id | स्ट्रिंग | दिए गए आईडी टोकन से जुड़ा uid. |
Project_id | स्ट्रिंग | आपका Firebase प्रोजेक्ट आईडी. |
अनुरोध का सैंपल
curl 'https://securetoken.googleapis.com/v1/token?key=[API_KEY]' \ -H 'Content-Type: application/x-www-form-urlencoded' \ --data 'grant_type=refresh_token&refresh_token=[REFRESH_TOKEN]'
अनुरोध स्वीकार किए जाने का मतलब 200 OK
एचटीटीपी है
स्टेटस कोड डालें. रिस्पॉन्स में नया Firebase आईडी टोकन और रीफ़्रेश टोकन शामिल होता है.
जवाब का सैंपल
{ "expires_in": "3600", "token_type": "Bearer", "refresh_token": "[REFRESH_TOKEN]", "id_token": "[ID_TOKEN]", "user_id": "tRcfmLH7o2XrNELi...", "project_id": "1234567890" }
सामान्य गड़बड़ियों के कोड
- TOKEN_EXPIRED: उपयोगकर्ता का क्रेडेंशियल अब मान्य नहीं है. उपयोगकर्ता को फिर से साइन इन करना होगा.
- USER_ROWSD: उपयोगकर्ता खाता किसी व्यवस्थापक द्वारा अक्षम कर दिया गया है.
- USER_NOT_FOUND: रीफ़्रेश टोकन से जुड़ा उपयोगकर्ता नहीं मिला. ऐसा लगता है कि उपयोगकर्ता को मिटा दिया गया है.
- एपीआई पासकोड मान्य नहीं है. कृपया मान्य एपीआई पासकोड पास करें. (अमान्य एपीआई पासकोड दिया गया)
- INVALID_REFRESH_TOKEN: एक अमान्य रीफ़्रेश टोकन दिया जाता है.
- JSON पेलोड अमान्य है. अज्ञात नाम \"refresh_tokens\": क्वेरी को बाइंड नहीं किया जा सकता पैरामीटर. 'refresh_tokens' फ़ील्ड अनुरोध संदेश में नहीं मिला.
- INVALID_GRANT_TYPE: बताया गया अनुदान प्रकार अमान्य है.
- MISSING_REFRESH_TOKEN: कोई रीफ़्रेश टोकन नहीं दिया गया.
- PROJECT_NUMBER_MISMATCH: रीफ़्रेश टोकन का प्रोजेक्ट नंबर, उपलब्ध कराई गई एपीआई कुंजी के प्रोजेक्ट नंबर से मेल नहीं खाता.
ईमेल / पासवर्ड से साइन अप करें
एचटीटीपी जारी करके, नया ईमेल और पासवर्ड उपयोगकर्ता बनाया जा सकता है
पुष्टि करने के signupNewUser
एंडपॉइंट के लिए POST
अनुरोध.
तरीका: POST
कॉन्टेंट का टाइप: ऐप्लिकेशन/JSON
एंडपॉइंटhttps://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
ईमेल | स्ट्रिंग | बनाने के लिए उपयोगकर्ता का ईमेल. |
पासवर्ड | स्ट्रिंग | उपयोगकर्ता के लिए, बनाने के लिए पासवर्ड. |
वापस करने के लिए सुरक्षित टोकन | बूलियन | आईडी और रीफ़्रेश टोकन दिखाना है या नहीं. हमेशा सही होना चाहिए. |
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
आईडीटोकन | स्ट्रिंग | नए उपयोगकर्ता के लिए, Firebase का पुष्टि आईडी टोकन. |
ईमेल | स्ट्रिंग | नए उपयोगकर्ता के लिए ईमेल. |
रीफ़्रेश टोकन | स्ट्रिंग | नए उपयोगकर्ता के लिए, Firebase की पुष्टि करने वाला रीफ़्रेश टोकन. |
समयसीमा खत्म होने की तारीख | स्ट्रिंग | आईडी टोकन की समयसीमा खत्म होने के सेकंड. |
स्थानीय आईडी | स्ट्रिंग | नए उपयोगकर्ता का uid. |
अनुरोध का सैंपल
curl 'https://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]' \ -H 'Content-Type: application/json' \ --data-binary '{"email":"[user@example.com]","password":"[PASSWORD]","returnSecureToken":true}'
अनुरोध स्वीकार किए जाने का मतलब 200 OK
एचटीटीपी है
स्टेटस कोड डालें. रिस्पॉन्स में Firebase आईडी टोकन और रीफ़्रेश टोकन शामिल होता है
पर जाकर संपर्क फ़ॉर्म भरें और उसमें दूसरे खाते की जानकारी शामिल करें.
जवाब का सैंपल
{ "idToken": "[ID_TOKEN]", "email": "[user@example.com]", "refreshToken": "[REFRESH_TOKEN]", "expiresIn": "3600", "localId": "tRcfmLH7..." }
सामान्य गड़बड़ियों के कोड
- EMAIL_EXISTS: ईमेल पता पहले से किसी अन्य खाते के उपयोग में है.
- OPERATION_NOT_ALLOWED: इस प्रोजेक्ट के लिए पासवर्ड से साइन-इन करने की सुविधा बंद है.
- TOO_MANY_WITHS_TRY_LATER: हमने इस डिवाइस से किए गए सभी अनुरोधों को ब्लॉक कर दिया है. गतिविधि. कुछ देर बाद कोशिश करें.
ईमेल / पासवर्ड से साइन इन करें
एचटीटीपी जारी करके, ईमेल और पासवर्ड का इस्तेमाल करके उपयोगकर्ता को साइन इन किया जा सकता है
पुष्टि करने के verifyPassword
एंडपॉइंट के लिए POST
अनुरोध.
तरीका: POST
कॉन्टेंट का टाइप: ऐप्लिकेशन/JSON
एंडपॉइंटhttps://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key=[API_KEY]
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
ईमेल | स्ट्रिंग | वह ईमेल पता जिससे उपयोगकर्ता साइन इन कर रहा है. |
पासवर्ड | स्ट्रिंग | खाते का पासवर्ड. |
वापस करने के लिए सुरक्षित टोकन | बूलियन | आईडी और रीफ़्रेश टोकन दिखाना है या नहीं. हमेशा सही होना चाहिए. |
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
आईडीटोकन | स्ट्रिंग | पुष्टि किए गए उपयोगकर्ता के लिए Firebase पुष्टि आईडी टोकन. |
ईमेल | स्ट्रिंग | पुष्टि किए गए उपयोगकर्ता का ईमेल पता. |
रीफ़्रेश टोकन | स्ट्रिंग | पुष्टि किए गए उपयोगकर्ता के लिए Firebase पुष्टि रीफ़्रेश टोकन. |
समयसीमा खत्म होने की तारीख | स्ट्रिंग | आईडी टोकन की समयसीमा खत्म होने के सेकंड. |
स्थानीय आईडी | स्ट्रिंग | पुष्टि किए गए उपयोगकर्ता का uid. |
रजिस्टर किया गया | बूलियन | ईमेल मौजूदा खाते के लिए है या नहीं. |
अनुरोध का सैंपल
curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key=[API_KEY]' \ -H 'Content-Type: application/json' \ --data-binary '{"email":"[user@example.com]","password":"[PASSWORD]","returnSecureToken":true}'
अनुरोध स्वीकार किए जाने का मतलब 200 OK
एचटीटीपी है
स्टेटस कोड डालें. रिस्पॉन्स में Firebase आईडी टोकन और रीफ़्रेश टोकन शामिल होता है
साइन इन करें.
जवाब का सैंपल
{ "localId": "ZY1rJK0eYLg...", "email": "[user@example.com]", "displayName": "", "idToken": "[ID_TOKEN]", "registered": true, "refreshToken": "[REFRESH_TOKEN]", "expiresIn": "3600" }
सामान्य गड़बड़ियों के कोड
- EMAIL_NOT_FOUND: इस आइडेंटिफ़ायर से जुड़ा कोई उपयोगकर्ता रिकॉर्ड नहीं है. उपयोगकर्ता हो सकता है हटा दिए गए हैं.
- अमान्य_पासवर्ड: पासवर्ड अमान्य है या उपयोगकर्ता के पास कोई पासवर्ड नहीं है.
- USER_disableD: उपयोगकर्ता खाता व्यवस्थापक द्वारा अक्षम कर दिया गया है.
पहचान छिपाकर साइन इन करें
एचटीटीपी जारी करके, किसी उपयोगकर्ता को पहचान छिपाकर साइन इन किया जा सकता है
पुष्टि करने के signupNewUser
एंडपॉइंट के लिए POST
अनुरोध.
तरीका: POST
कॉन्टेंट का टाइप: ऐप्लिकेशन/JSON
एंडपॉइंटhttps://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
वापस करने के लिए सुरक्षित टोकन | बूलियन | आईडी और रीफ़्रेश टोकन दिखाना है या नहीं. हमेशा सही होना चाहिए. |
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
आईडीटोकन | स्ट्रिंग | नए उपयोगकर्ता के लिए, Firebase का पुष्टि आईडी टोकन. |
ईमेल | स्ट्रिंग | उपयोगकर्ता की पहचान छिपी हुई है, इसलिए यह फ़ील्ड खाली होना चाहिए. |
रीफ़्रेश टोकन | स्ट्रिंग | नए उपयोगकर्ता के लिए, Firebase की पुष्टि करने वाला रीफ़्रेश टोकन. |
समयसीमा खत्म होने की तारीख | स्ट्रिंग | आईडी टोकन की समयसीमा खत्म होने के सेकंड. |
स्थानीय आईडी | स्ट्रिंग | नए उपयोगकर्ता का uid. |
अनुरोध का सैंपल
curl 'https://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]' \ -H 'Content-Type: application/json' --data-binary '{"returnSecureToken":true}'
अनुरोध स्वीकार किए जाने का मतलब 200 OK
एचटीटीपी है
स्टेटस कोड डालें. रिस्पॉन्स में Firebase आईडी टोकन और रीफ़्रेश टोकन शामिल होता है
के साथ बातचीत करते हैं.
जवाब का सैंपल
{ "idToken": "[ID_TOKEN]", "email": "", "refreshToken": "[REFRESH_TOKEN]", "expiresIn": "3600", "localId": "Jws4SVjpT..." }
सामान्य गड़बड़ियों के कोड
- OPERATION_NOT_ALLOWED: इस प्रोजेक्ट के लिए, उपयोगकर्ता की पहचान ज़ाहिर किए बिना साइन इन करने की सुविधा बंद है.
OAuth क्रेडेंशियल से साइन इन करें
एचटीटीपी जारी करके, OAuth क्रेडेंशियल की मदद से किसी उपयोगकर्ता को साइन इन किया जा सकता है
पुष्टि करने के verifyAssertion
एंडपॉइंट के लिए POST
अनुरोध.
तरीका: POST
कॉन्टेंट का टाइप: ऐप्लिकेशन/JSON
एंडपॉइंटhttps://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
अनुरोधUri | स्ट्रिंग | वह यूआरआई जिस पर आईडीपी, उपयोगकर्ता को वापस रीडायरेक्ट करता है. |
पोस्ट का मुख्य भाग | स्ट्रिंग | इसमें OAuth क्रेडेंशियल (आईडी टोकन या ऐक्सेस टोकन) और सेवा देने वाली कंपनी का आईडी शामिल होता है, जो समस्या करता है क्रेडेंशियल. |
वापस करने के लिए सुरक्षित टोकन | बूलियन | आईडी और रीफ़्रेश टोकन दिखाना है या नहीं. हमेशा सही होना चाहिए. |
रिटर्न आईडीपीक्रेडेंशियल | बूलियन | क्या नीचे दी गई गड़बड़ियों पर OAuth क्रेडेंशियल वापस लागू करना है: FEDETED_USER_ID_ALREADY_LINKED और EMAIL_EXISTS. |
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
फ़ेडरेटेड आईडी | स्ट्रिंग | यूनीक आईडी से, आईडीपी (IdP) खाते की पहचान की जाती है. |
providerId | स्ट्रिंग | लिंक की गई कंपनी का आईडी (जैसे, Google प्रोवाइडर के लिए "google.com"). |
स्थानीय आईडी | स्ट्रिंग | पुष्टि किए गए उपयोगकर्ता का uid. |
ईमेल से पुष्टि की गई | बूलियन | साइन-इन करने के लिए दिए गए ईमेल पते की पुष्टि की गई है. |
ईमेल | स्ट्रिंग | खाते का ईमेल पता. |
oauthIdToken | स्ट्रिंग | OIDC आईडी टोकन उपलब्ध होने पर. |
oauthAccessToken | स्ट्रिंग | OAuth ऐक्सेस टोकन (अगर उपलब्ध हो). |
oauthTokenSecret | स्ट्रिंग | उपलब्ध होने पर, OAuth 1.0 टोकन सीक्रेट. |
रॉ उपयोगकर्ता जानकारी | स्ट्रिंग | JSON का, स्ट्रिंग वाला जवाब, जिसमें दिए गए सभी आईडीपी (IdP) का डेटा होता है OAuth क्रेडेंशियल. |
नाम | स्ट्रिंग | खाते का नाम. |
उपनाम | स्ट्रिंग | खाते का सरनेम. |
पूरा नाम | स्ट्रिंग | खाते का पूरा नाम. |
displayName | स्ट्रिंग | खाते का डिसप्ले नेम. |
फ़ोटोUrl | स्ट्रिंग | खाते के लिए फ़ोटो का यूआरएल. |
आईडीटोकन | स्ट्रिंग | पुष्टि किए गए उपयोगकर्ता के लिए Firebase पुष्टि आईडी टोकन. |
रीफ़्रेश टोकन | स्ट्रिंग | पुष्टि किए गए उपयोगकर्ता के लिए Firebase पुष्टि रीफ़्रेश टोकन. |
समयसीमा खत्म होने की तारीख | स्ट्रिंग | आईडी टोकन की समयसीमा खत्म होने के सेकंड. |
पुष्टि की ज़रूरत है | बूलियन | क्या इसी क्रेडेंशियल वाला कोई दूसरा खाता पहले से मौजूद है. उपयोगकर्ता को इनकी ज़रूरत होगी का इस्तेमाल करें. इसके बाद, मौजूदा क्रेडेंशियल को उससे लिंक करें. |
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
एचटीटीपी है
स्टेटस कोड डालें. रिस्पॉन्स में Firebase आईडी टोकन और रीफ़्रेश टोकन शामिल होता है
पुष्टि करनी होगी.
OAuth आईडी टोकन की मदद से जवाब का सैंपल
{ "federatedId": "https://accounts.google.com/1234567890", "providerId": "google.com", "localId": "5xwsPCWYo...", "emailVerified": true, "email": "user@example.com", "oauthIdToken": "[GOOGLE_ID_TOKEN]", "firstName": "John", "lastName": "Doe", "fullName": "John Doe", "displayName": "John Doe", "idToken": "[ID_TOKEN]", "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg", "refreshToken": "[REFRESH_TOKEN]", "expiresIn": "3600", "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}" }
OAuth ऐक्सेस टोकन वाले अनुरोध का सैंपल
curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \ -H 'Content-Type: application/json' \ --data-binary '{"postBody":"access_token=[FACEBOOK_ACCESS_TOKEN]&providerId=[facebook.com]","requestUri":"[http://localhost]","returnIdpCredential":true,"returnSecureToken":true}'
अनुरोध स्वीकार किए जाने का मतलब 200 OK
एचटीटीपी है
स्टेटस कोड डालें. रिस्पॉन्स में Firebase आईडी टोकन और रीफ़्रेश टोकन शामिल होता है
पुष्टि करनी होगी.
OAuth ऐक्सेस टोकन के साथ रिस्पॉन्स का सैंपल
{ "federatedId": "http://facebook.com/1234567890", "providerId": "facebook.com", "localId": "5xwsPCWYo...", "emailVerified": true, "email": "user@example.com", "oauthAccessToken": "[FACEBOOK_ACCESS_TOKEN]", "firstName": "John", "lastName": "Doe", "fullName": "John Doe", "displayName": "John Doe", "idToken": "[ID_TOKEN]", "photoUrl": "https://scontent.xx.fbcdn.net/v/...", "refreshToken": "[REFRESH_TOKEN]", "expiresIn": "3600", "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}" }
Twitter OAuth 1.0 क्रेडेंशियल के साथ अनुरोध का सैंपल
curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \ -H 'Content-Type: application/json' \ --data-binary '{"postBody":"access_token=[TWITTER_ACCESS_TOKEN]&oauth_token_secret=[TWITTER_TOKEN_SECRET]&providerId=[twitter.com]","requestUri":"[http://localhost]","returnIdpCredential":true,"returnSecureToken":true}'
अनुरोध स्वीकार किए जाने का मतलब 200 OK
एचटीटीपी है
स्टेटस कोड डालें. रिस्पॉन्स में Firebase आईडी टोकन और रीफ़्रेश टोकन शामिल होता है
पुष्टि करनी होगी.
Twitter OAuth 1.0 क्रेडेंशियल के साथ रिस्पॉन्स का सैंपल
{ "federatedId": "http://twitter.com/1234567890", "providerId": "twitter.com", "localId": "5xwsPCWYo...", "emailVerified": true, "email": "user@example.com", "oauthAccessToken": "[OAUTH_ACCESS_TOKEN]", "oauthTokenSecret": "[OAUTH_TOKEN_SECRET]", "firstName": "John", "lastName": "Doe", "fullName": "John Doe", "displayName": "John Doe", "idToken": "[ID_TOKEN]", "photoUrl": "http://abs.twimg.com/sticky/...", "refreshToken": "[REFRESH_TOKEN]", "expiresIn": "3600", "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}" }
सामान्य गड़बड़ियों के कोड
- OPERATION_NOT_ALLOWED: संबंधित कंपनी को इस प्रोजेक्ट के लिए बंद कर दिया गया है.
- INVALID_IDP_REPLY: दिया गया पुष्टि करने का क्रेडेंशियल गलत है या उसकी समयसीमा खत्म हो चुकी है.
ईमेल के लिए फ़ेच प्रोवाइडर
एक एचटीटीपी जारी करके, किसी खास ईमेल से जुड़ी सेवा देने वाली सभी कंपनियां देखी जा सकती हैं
पुष्टि करने के createAuthUri
एंडपॉइंट के लिए POST
अनुरोध.
तरीका: POST
कॉन्टेंट का टाइप: ऐप्लिकेशन/JSON
एंडपॉइंटhttps://identitytoolkit.googleapis.com/v1/accounts:createAuthUri?key=[API_KEY]
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
पहचानकर्ता | स्ट्रिंग | उपयोगकर्ता का ईमेल पता |
यूरी जारी रखें | स्ट्रिंग | वह यूआरआई जिस पर आईडीपी, उपयोगकर्ता को वापस रीडायरेक्ट करता है. उपयोग के इस उदाहरण में, यह सिर्फ़ कर सकते हैं. |
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
सभी सेवा देने वाली कंपनियां | स्ट्रिंग की सूची | उन कंपनियों की सूची जिनके साथ लोगों ने पहले साइन इन किया था. |
रजिस्टर किया गया | बूलियन | ईमेल किसी मौजूदा खाते का है या नहीं |
अनुरोध का सैंपल
curl 'https://identitytoolkit.googleapis.com/v1/accounts:createAuthUri?key=[API_KEY]' \ -H 'Content-Type: application/json' \ --data-binary '{"identifier":"[user@example.com]","continueUri":"[http://localhost:8080/app]"}'
अनुरोध स्वीकार किए जाने का मतलब 200 OK
एचटीटीपी है
स्टेटस कोड डालें. जवाब में, ईमेल से जुड़ी सेवा देने वाली कंपनियों की सूची शामिल होती है.
जवाब का सैंपल
{ "allProviders": [ "password", "google.com" ], "registered": true }
सामान्य गड़बड़ियों के कोड
- INVALID_EMAIL: ईमेल पता गलत तरीके से प्रारूपित किया गया है.
पासवर्ड रीसेट करने का ईमेल भेजें
एचटीटीपी जारी करके, पासवर्ड फिर से सेट करने का ईमेल भेजा जा सकता है
पुष्टि करने के getOobConfirmationCode
एंडपॉइंट के लिए POST
अनुरोध.
तरीका: POST
कॉन्टेंट का टाइप: ऐप्लिकेशन/JSON
एंडपॉइंटhttps://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]
प्रॉपर्टी का नाम | ब्यौरा |
---|---|
X-Firebase-लोकेल | उपयोगकर्ता की स्थान-भाषा के मुताबिक भाषा का कोड. इसे पास करने से पासवर्ड फिर सेट करने का ईमेल उपयोगकर्ता को भेजा गया. |
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
requestType | स्ट्रिंग | किस तरह का OOB कोड दिखाना है. "Password_RESET" होना चाहिए पासवर्ड रीसेट करने के लिए. |
ईमेल | स्ट्रिंग | उपयोगकर्ता का ईमेल पता. |
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
ईमेल | स्ट्रिंग | उपयोगकर्ता का ईमेल पता. |
अनुरोध का सैंपल
curl 'https://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]' \ -H 'Content-Type: application/json' \ --data-binary '{"requestType":"PASSWORD_RESET","email":"[user@example.com]"}'
अनुरोध स्वीकार किए जाने का मतलब 200 OK
एचटीटीपी है
स्टेटस कोड डालें.
जवाब का सैंपल
{ "email": "[user@example.com]" }
सामान्य गड़बड़ियों के कोड
- EMAIL_NOT_FOUND: इस आइडेंटिफ़ायर से जुड़ा कोई उपयोगकर्ता रिकॉर्ड नहीं है. उपयोगकर्ता हो सकता है हटा दिए गए हैं.
पासवर्ड रीसेट कोड सत्यापित करें
एचटीटीपी जारी करके, पासवर्ड रीसेट कोड की पुष्टि की जा सकती है
पुष्टि करने के resetPassword
एंडपॉइंट के लिए POST
अनुरोध.
तरीका: POST
कॉन्टेंट का टाइप: ऐप्लिकेशन/JSON
एंडपॉइंटhttps://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
oobCode | स्ट्रिंग | पासवर्ड रीसेट करने के लिए, उपयोगकर्ता के ईमेल पर भेजा गया ईमेल कार्रवाई कोड. |
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
ईमेल | स्ट्रिंग | उपयोगकर्ता का ईमेल पता. |
requestType | स्ट्रिंग | ईमेल ऐक्शन कोड का टाइप. "Password_RESET" होना चाहिए. |
अनुरोध का सैंपल
curl 'https://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]' \ -H 'Content-Type: application/json' --data-binary '{"oobCode":"[PASSWORD_RESET_CODE]"}'
अनुरोध स्वीकार किए जाने का मतलब 200 OK
एचटीटीपी है
स्टेटस कोड डालें.
जवाब का सैंपल
{ "email": "[user@example.com]", "requestType": "PASSWORD_RESET" }
सामान्य गड़बड़ियों के कोड
- OPERATION_NOT_ALLOWED: इस प्रोजेक्ट के लिए पासवर्ड से साइन-इन करने की सुविधा बंद है.
- EXPIRED_OOB_CODE: कार्रवाई कोड की समयसीमा खत्म हो गई है.
- INVALID_OOB_CODE: कार्रवाई कोड अमान्य है. ऐसा तब हो सकता है, जब कोड गलत हो, जिनकी समयसीमा खत्म हो गई हो या जिनका इस्तेमाल पहले ही किया जा चुका हो.
पासवर्ड फिर से सेट करने की पुष्टि करें
आप एक एचटीटीपी जारी करके, पासवर्ड रीसेट बदलाव लागू कर सकते हैं
पुष्टि करने के resetPassword
एंडपॉइंट के लिए POST
अनुरोध.
तरीका: POST
कॉन्टेंट का टाइप: ऐप्लिकेशन/JSON
एंडपॉइंटhttps://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
oobCode | स्ट्रिंग | पासवर्ड रीसेट करने के लिए, उपयोगकर्ता के ईमेल पर भेजा गया ईमेल कार्रवाई कोड. |
नया पासवर्ड | स्ट्रिंग | उपयोगकर्ता का नया पासवर्ड. |
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
ईमेल | स्ट्रिंग | उपयोगकर्ता का ईमेल पता. |
requestType | स्ट्रिंग | ईमेल ऐक्शन कोड का टाइप. "Password_RESET" होना चाहिए. |
अनुरोध का सैंपल
curl 'https://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]' \ -H 'Content-Type: application/json' \ --data-binary '{"oobCode":"[PASSWORD_RESET_CODE]","newPassword":"[NEW_PASSWORD]"}'
अनुरोध स्वीकार किए जाने का मतलब 200 OK
एचटीटीपी है
स्टेटस कोड डालें.
जवाब का सैंपल
{ "email": "[user@example.com]", "requestType": "PASSWORD_RESET" }
सामान्य गड़बड़ियों के कोड
- OPERATION_NOT_ALLOWED: इस प्रोजेक्ट के लिए पासवर्ड से साइन-इन करने की सुविधा बंद है.
- EXPIRED_OOB_CODE: कार्रवाई कोड की समयसीमा खत्म हो गई है.
- INVALID_OOB_CODE: कार्रवाई कोड अमान्य है. ऐसा तब हो सकता है, जब कोड गलत हो, जिनकी समयसीमा खत्म हो गई हो या जिनका इस्तेमाल पहले ही किया जा चुका हो.
- USER_disableD: उपयोगकर्ता खाता व्यवस्थापक द्वारा अक्षम कर दिया गया है.
ईमेल बदलें
एचटीटीपी जारी करके, उपयोगकर्ता के ईमेल पते को बदला जा सकता है
पुष्टि करने के setAccountInfo
एंडपॉइंट के लिए POST
अनुरोध.
तरीका: POST
कॉन्टेंट का टाइप: ऐप्लिकेशन/JSON
एंडपॉइंटhttps://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]
प्रॉपर्टी का नाम | ब्यौरा |
---|---|
X-Firebase-लोकेल | उपयोगकर्ता की स्थान-भाषा के मुताबिक भाषा का कोड. इसे पास करने से ईमेल पते में हुए बदलाव को रद्द करने का ईमेल भेजा गया. |
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
आईडीटोकन | स्ट्रिंग | उपयोगकर्ता के लिए, Firebase का पुष्टि आईडी टोकन. |
ईमेल | स्ट्रिंग | उपयोगकर्ता का नया ईमेल. |
वापस करने के लिए सुरक्षित टोकन | बूलियन | आईडी और रीफ़्रेश टोकन दिखाना है या नहीं. |
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
स्थानीय आईडी | स्ट्रिंग | मौजूदा उपयोगकर्ता का uid. |
ईमेल | स्ट्रिंग | उपयोगकर्ता का ईमेल पता. |
पासवर्ड हैश | स्ट्रिंग | पासवर्ड का हैश वर्शन. |
कंपनी के उपयोगकर्ता की जानकारी | JSON ऑब्जेक्ट की सूची | लिंक किए गए, प्रोवाइडर के उन सभी ऑब्जेक्ट की सूची जिनमें "providerId" है और "फ़ेडरेटेड आईडी" है. |
आईडीटोकन | स्ट्रिंग | उपयोगकर्ता के लिए, Firebase का नया ऑथराइज़ेशन आईडी टोकन. |
रीफ़्रेश टोकन | स्ट्रिंग | Firebase पुष्टि वाला रीफ़्रेश टोकन. |
समयसीमा खत्म होने की तारीख | स्ट्रिंग | आईडी टोकन की समयसीमा खत्म होने के सेकंड. |
अनुरोध का सैंपल
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
एचटीटीपी है
स्टेटस कोड डालें. रिस्पॉन्स में नया Firebase आईडी टोकन और रीफ़्रेश टोकन शामिल होता है
उपयोगकर्ता के साथ शेयर करते हैं.
जवाब का सैंपल
{ "localId": "tRcfmLH7o2...", "email": "[user@example2.com]", "passwordHash": "...", "providerUserInfo": [ { "providerId": "password", "federatedId": "[user@example2.com]" } ], "idToken": "[NEW_ID_TOKEN]", "refreshToken": "[NEW_REFRESH_TOKEN]", "expiresIn": "3600" }
सामान्य गड़बड़ियों के कोड
- EMAIL_EXISTS: ईमेल पता पहले से किसी अन्य खाते के उपयोग में है.
- INVALID_ID_TOKEN:उपयोगकर्ता का क्रेडेंशियल अब मान्य नहीं है. उपयोगकर्ता को फिर से साइन इन करना होगा.
पासवर्ड बदलें
एचटीटीपी जारी करके, किसी उपयोगकर्ता का पासवर्ड बदला जा सकता है
पुष्टि करने के setAccountInfo
एंडपॉइंट के लिए POST
अनुरोध.
तरीका: POST
कॉन्टेंट का टाइप: ऐप्लिकेशन/JSON
एंडपॉइंटhttps://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
आईडीटोकन | स्ट्रिंग | उपयोगकर्ता के लिए, Firebase का पुष्टि आईडी टोकन. |
पासवर्ड | स्ट्रिंग | उपयोगकर्ता का नया पासवर्ड. |
वापस करने के लिए सुरक्षित टोकन | बूलियन | आईडी और रीफ़्रेश टोकन दिखाना है या नहीं. |
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
स्थानीय आईडी | स्ट्रिंग | मौजूदा उपयोगकर्ता का uid. |
ईमेल | स्ट्रिंग | उपयोगकर्ता का ईमेल पता. |
पासवर्ड हैश | स्ट्रिंग | पासवर्ड का हैश वर्शन. |
कंपनी के उपयोगकर्ता की जानकारी | JSON ऑब्जेक्ट की सूची | लिंक किए गए, प्रोवाइडर के उन सभी ऑब्जेक्ट की सूची जिनमें "providerId" है और "फ़ेडरेटेड आईडी" है. |
आईडीटोकन | स्ट्रिंग | उपयोगकर्ता के लिए, Firebase का नया ऑथराइज़ेशन आईडी टोकन. |
रीफ़्रेश टोकन | स्ट्रिंग | Firebase पुष्टि वाला रीफ़्रेश टोकन. |
समयसीमा खत्म होने की तारीख | स्ट्रिंग | आईडी टोकन की समयसीमा खत्म होने के सेकंड. |
अनुरोध का सैंपल
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
एचटीटीपी है
स्टेटस कोड डालें. रिस्पॉन्स में नया Firebase आईडी टोकन और रीफ़्रेश टोकन शामिल होता है
उपयोगकर्ता के साथ शेयर करते हैं.
जवाब का सैंपल
{ "localId": "tRcfmLH7o2...", "email": "[user@example.com]", "passwordHash": "...", "providerUserInfo": [ { "providerId": "password", "federatedId": "[user@example.com]" } ], "idToken": "[NEW_ID_TOKEN]", "refreshToken": "[NEW_REFRESH_TOKEN]", "expiresIn": "3600" }
सामान्य गड़बड़ियों के कोड
- INVALID_ID_TOKEN:उपयोगकर्ता का क्रेडेंशियल अब मान्य नहीं है. उपयोगकर्ता को फिर से साइन इन करना होगा.
- WEAK_Password: पासवर्ड, छह या इससे ज़्यादा वर्णों का होना चाहिए.
प्रोफ़ाइल अपडेट करें
एचटीटीपी जारी करके, उपयोगकर्ता की प्रोफ़ाइल (डिसप्ले नेम / फ़ोटो का यूआरएल) अपडेट किया जा सकता है
पुष्टि करने के setAccountInfo
एंडपॉइंट के लिए POST
अनुरोध.
तरीका: POST
कॉन्टेंट का टाइप: ऐप्लिकेशन/JSON
एंडपॉइंटhttps://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
आईडीटोकन | स्ट्रिंग | उपयोगकर्ता के लिए, Firebase का पुष्टि आईडी टोकन. |
displayName | स्ट्रिंग | उपयोगकर्ता का नया डिसप्ले नेम. |
फ़ोटोUrl | स्ट्रिंग | उपयोगकर्ता की नई फ़ोटो का यूआरएल. |
डिलीट एट्रिब्यूट | स्ट्रिंग की सूची | हटाई जाने वाली विशेषताओं की सूची, "DISPLAY_NAME" या "PHOTO_URL" में बदलाव न करें. इससे इन सभी को वैल्यू. |
वापस करने के लिए सुरक्षित टोकन | बूलियन | आईडी और रीफ़्रेश टोकन दिखाना है या नहीं. |
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
स्थानीय आईडी | स्ट्रिंग | मौजूदा उपयोगकर्ता का uid. |
ईमेल | स्ट्रिंग | उपयोगकर्ता का ईमेल पता. |
displayName | स्ट्रिंग | उपयोगकर्ता का नया डिसप्ले नेम. |
फ़ोटोUrl | स्ट्रिंग | उपयोगकर्ता की नई फ़ोटो का यूआरएल. |
पासवर्ड हैश | स्ट्रिंग | पासवर्ड का हैश वर्शन. |
कंपनी के उपयोगकर्ता की जानकारी | JSON ऑब्जेक्ट की सूची | लिंक किए गए, प्रोवाइडर के उन सभी ऑब्जेक्ट की सूची जिनमें "providerId" है और "फ़ेडरेटेड आईडी" है. |
आईडीटोकन | स्ट्रिंग | उपयोगकर्ता के लिए, Firebase का नया ऑथराइज़ेशन आईडी टोकन. |
रीफ़्रेश टोकन | स्ट्रिंग | Firebase पुष्टि वाला रीफ़्रेश टोकन. |
समयसीमा खत्म होने की तारीख | स्ट्रिंग | आईडी टोकन की समयसीमा खत्म होने के सेकंड. |
अनुरोध का सैंपल
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
एचटीटीपी है
स्टेटस कोड डालें.
जवाब का सैंपल
{ "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:उपयोगकर्ता का क्रेडेंशियल अब मान्य नहीं है. उपयोगकर्ता को फिर से साइन इन करना होगा.
उपयोगकर्ता का डेटा पाना
एचटीटीपी जारी करके, उपयोगकर्ता का डेटा हासिल किया जा सकता है
पुष्टि करने के getAccountInfo
एंडपॉइंट के लिए POST
अनुरोध.
तरीका: POST
कॉन्टेंट का टाइप: ऐप्लिकेशन/JSON
एंडपॉइंटhttps://identitytoolkit.googleapis.com/v1/accounts:lookup?key=[API_KEY]
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
आईडीटोकन | स्ट्रिंग | खाते का Firebase आईडी टोकन. |
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
users | JSON ऑब्जेक्ट की सूची | वह खाता जो दिए गए Firebase आईडी टोकन से जुड़ा है. ज़्यादा जानकारी के लिए नीचे देखें विवरण. |
users
कलेक्शन कॉन्टेंट)
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
स्थानीय आईडी | स्ट्रिंग | मौजूदा उपयोगकर्ता का uid. |
ईमेल | स्ट्रिंग | खाते का ईमेल पता. |
ईमेल से पुष्टि की गई | बूलियन | खाते के ईमेल पते की पुष्टि की गई है या नहीं. |
displayName | स्ट्रिंग | खाते का डिसप्ले नेम. |
कंपनी के उपयोगकर्ता की जानकारी | JSON ऑब्जेक्ट की सूची | लिंक किए गए, प्रोवाइडर के उन सभी ऑब्जेक्ट की सूची जिनमें "providerId" है और "फ़ेडरेटेड आईडी" है. |
फ़ोटोUrl | स्ट्रिंग | खाते के लिए फ़ोटो का यूआरएल. |
पासवर्ड हैश | स्ट्रिंग | पासवर्ड का हैश वर्शन. |
इस समय अपडेट किया गया | डबल | खाते का पासवर्ड पिछली बार बदले जाने का टाइमस्टैंप, मिलीसेकंड में. |
इसके बाद से मान्य | स्ट्रिंग | सेकंड में टाइमस्टैंप, जो सीमा को दिखाता है और जिसके पहले Firebase आईडी टोकन होता है निरस्त किया गया माना जाता है. |
अक्षम किया गया | बूलियन | खाता बंद है या नहीं. |
आखिरी में लॉगिन करने का समय | स्ट्रिंग | मिलीसेकंड में टाइमस्टैंप, जब खाते में पिछली बार लॉग इन किया गया था. |
इस समय बनाया गया | स्ट्रिंग | मिलीसेकंड में वह टाइमस्टैंप जब खाता बनाया गया था. |
कस्टम ऑथराइज़ेशन | बूलियन | डेवलपर ने खाते की पुष्टि की है या नहीं. |
अनुरोध का सैंपल
curl 'https://identitytoolkit.googleapis.com/v1/accounts:lookup?key=[API_KEY]' \ -H 'Content-Type: application/json' --data-binary '{"idToken":"[FIREBASE_ID_TOKEN]"}'
अनुरोध स्वीकार किए जाने का मतलब 200 OK
एचटीटीपी है
स्टेटस कोड डालें. इस जवाब में खाते से जुड़ी सभी उपयोगकर्ता जानकारी शामिल होगी.
जवाब का सैंपल
{ "users": [ { "localId": "ZY1rJK0...", "email": "user@example.com", "emailVerified": false, "displayName": "John Doe", "providerUserInfo": [ { "providerId": "password", "displayName": "John Doe", "photoUrl": "http://localhost:8080/img1234567890/photo.png", "federatedId": "user@example.com", "email": "user@example.com", "rawId": "user@example.com", "screenName": "user@example.com" } ], "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg", "passwordHash": "...", "passwordUpdatedAt": 1.484124177E12, "validSince": "1484124177", "disabled": false, "lastLoginAt": "1484628946000", "createdAt": "1484124142000", "customAuth": false } ] }
सामान्य गड़बड़ियों के कोड
- INVALID_ID_TOKEN:उपयोगकर्ता का क्रेडेंशियल अब मान्य नहीं है. उपयोगकर्ता को फिर से साइन इन करना होगा.
- USER_NOT_FOUND: इस आइडेंटिफ़ायर से जुड़ा कोई उपयोगकर्ता रिकॉर्ड नहीं है. उपयोगकर्ता हो सकता है हटा दिए गए हैं.
ईमेल/पासवर्ड से लिंक करें
आपके पास एचटीटीपी जारी करके किसी मौजूदा उपयोगकर्ता को ईमेल/पासवर्ड जोड़ने का विकल्प है
पुष्टि करने के setAccountInfo
एंडपॉइंट के लिए POST
अनुरोध.
तरीका: POST
कॉन्टेंट का टाइप: ऐप्लिकेशन/JSON
एंडपॉइंटhttps://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
आईडीटोकन | स्ट्रिंग | उस खाते का Firebase आईडी टोकन जिससे आपको क्रेडेंशियल को लिंक करने की कोशिश करनी है. |
ईमेल | स्ट्रिंग | खाते से लिंक करने के लिए ईमेल. |
पासवर्ड | स्ट्रिंग | खाते का नया पासवर्ड. |
वापस करने के लिए सुरक्षित टोकन | स्ट्रिंग | आईडी और रीफ़्रेश टोकन दिखाना है या नहीं. हमेशा सही होना चाहिए. |
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
स्थानीय आईडी | स्ट्रिंग | मौजूदा उपयोगकर्ता का uid. |
ईमेल | स्ट्रिंग | खाते का ईमेल पता. |
displayName | स्ट्रिंग | खाते का डिसप्ले नेम. |
फ़ोटोUrl | स्ट्रिंग | खाते के लिए फ़ोटो का यूआरएल. |
पासवर्ड हैश | स्ट्रिंग | पासवर्ड का हैश वर्शन. |
कंपनी के उपयोगकर्ता की जानकारी | JSON ऑब्जेक्ट की सूची | लिंक किए गए, प्रोवाइडर के उन सभी ऑब्जेक्ट की सूची जिनमें "providerId" है और "फ़ेडरेटेड आईडी" है. |
ईमेल से पुष्टि की गई | बूलियन | खाते के ईमेल पते की पुष्टि की गई है या नहीं. |
आईडीटोकन | स्ट्रिंग | उपयोगकर्ता के लिए, Firebase का नया ऑथराइज़ेशन आईडी टोकन. |
रीफ़्रेश टोकन | स्ट्रिंग | Firebase पुष्टि वाला रीफ़्रेश टोकन. |
समयसीमा खत्म होने की तारीख | स्ट्रिंग | आईडी टोकन की समयसीमा खत्म होने के सेकंड. |
अनुरोध का सैंपल
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
एचटीटीपी है
स्टेटस कोड डालें. रिस्पॉन्स में Firebase आईडी टोकन और रीफ़्रेश टोकन शामिल होता है.
पुष्टि हो चुकी है.
जवाब का सैंपल
{ "localId": "huDwUz...", "email": "user@example.com", "displayName": "John Doe", "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg", "passwordHash": "...", "providerUserInfo": [ { "providerId": "password", "federatedId": "user@example.com" } ], "idToken": "[ID_TOKEN]", "refreshToken": "[REFRESH_TOKEN]", "expiresIn": "3600", "emailVerified": false }
सामान्य गड़बड़ियों के कोड
- CREDENTIAL_TOO_OLD_LOGIN_AGAIN: उपयोगकर्ता का क्रेडेंशियल अब मान्य नहीं है. उपयोगकर्ता को ज़रूरी शर्तें पूरी करनी होंगी फिर से साइन इन करें.
- TOKEN_EXPIRED: उपयोगकर्ता का क्रेडेंशियल अब मान्य नहीं है. उपयोगकर्ता को फिर से साइन इन करना होगा.
- INVALID_ID_TOKEN:उपयोगकर्ता का क्रेडेंशियल अब मान्य नहीं है. उपयोगकर्ता को फिर से साइन इन करना होगा.
- WEAK_Password: पासवर्ड, छह या इससे ज़्यादा वर्णों का होना चाहिए.
OAuth क्रेडेंशियल से लिंक करें
एचटीटीपी जारी करके, किसी उपयोगकर्ता से OAuth क्रेडेंशियल जोड़ा जा सकता है
पुष्टि करने के verifyAssertion
एंडपॉइंट के लिए POST
अनुरोध.
तरीका: POST
कॉन्टेंट का टाइप: ऐप्लिकेशन/JSON
एंडपॉइंटhttps://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
आईडीटोकन | स्ट्रिंग | उस खाते का Firebase आईडी टोकन जिससे आपको क्रेडेंशियल को लिंक करने की कोशिश करनी है. |
रिक्वेस्टयूरी | स्ट्रिंग | वह यूआरआई जिस पर आईडीपी, उपयोगकर्ता को वापस रीडायरेक्ट करता है. |
पोस्ट का मुख्य भाग | स्ट्रिंग | इसमें OAuth क्रेडेंशियल (आईडी टोकन या ऐक्सेस टोकन) और सेवा देने वाली कंपनी का आईडी शामिल होता है, जो समस्या करता है क्रेडेंशियल. |
वापस करने के लिए सुरक्षित टोकन | बूलियन | आईडी और रीफ़्रेश टोकन दिखाना है या नहीं. हमेशा सही होना चाहिए. |
रिटर्न आईडीपीक्रेडेंशियल | बूलियन | क्या नीचे दी गई गड़बड़ियों पर OAuth क्रेडेंशियल वापस लागू करना है: FEDETED_USER_ID_ALREADY_LINKED और EMAIL_EXISTS. |
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
फ़ेडरेटेड आईडी | स्ट्रिंग | यूनीक आईडी से, आईडीपी (IdP) खाते की पहचान की जाती है. |
providerId | स्ट्रिंग | लिंक की गई कंपनी का आईडी (जैसे, Google प्रोवाइडर के लिए "google.com"). |
स्थानीय आईडी | स्ट्रिंग | पुष्टि किए गए उपयोगकर्ता का uid. |
ईमेल से पुष्टि की गई | बूलियन | साइन इन ईमेल की पुष्टि की गई है या नहीं. |
ईमेल | स्ट्रिंग | खाते का ईमेल पता. |
oauthIdToken | स्ट्रिंग | OIDC आईडी टोकन उपलब्ध होने पर. |
oauthAccessToken | स्ट्रिंग | OAuth ऐक्सेस टोकन (अगर उपलब्ध हो). |
oauthTokenSecret | स्ट्रिंग | उपलब्ध होने पर, OAuth 1.0 टोकन सीक्रेट. |
रॉ उपयोगकर्ता जानकारी | स्ट्रिंग | JSON का, स्ट्रिंग वाला जवाब, जिसमें दिए गए सभी आईडीपी (IdP) का डेटा होता है OAuth क्रेडेंशियल. |
नाम | स्ट्रिंग | खाते का नाम. |
उपनाम | स्ट्रिंग | खाते का सरनेम. |
पूरा नाम | स्ट्रिंग | खाते का पूरा नाम. |
displayName | स्ट्रिंग | खाते का डिसप्ले नेम. |
फ़ोटोUrl | स्ट्रिंग | खाते के लिए फ़ोटो का यूआरएल. |
आईडीटोकन | स्ट्रिंग | पुष्टि किए गए उपयोगकर्ता के लिए Firebase पुष्टि आईडी टोकन. |
रीफ़्रेश टोकन | स्ट्रिंग | पुष्टि किए गए उपयोगकर्ता के लिए Firebase पुष्टि रीफ़्रेश टोकन. |
समयसीमा खत्म होने की तारीख | स्ट्रिंग | आईडी टोकन की समयसीमा खत्म होने के सेकंड. |
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
एचटीटीपी है
स्टेटस कोड डालें. रिस्पॉन्स में Firebase आईडी टोकन और रीफ़्रेश टोकन शामिल होता है
पुष्टि करनी होगी.
OAuth आईडी टोकन की मदद से जवाब का सैंपल
{ "federatedId": "https://accounts.google.com/1234567890", "providerId": "google.com", "localId": "5xwsPCWYo...", "emailVerified": true, "email": "user@example.com", "oauthIdToken": "[GOOGLE_ID_TOKEN]", "firstName": "John", "lastName": "Doe", "fullName": "John Doe", "displayName": "John Doe", "idToken": "[ID_TOKEN]", "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg", "refreshToken": "[REFRESH_TOKEN]", "expiresIn": "3600", "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}" }
OAuth ऐक्सेस टोकन वाले अनुरोध का सैंपल
curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \ -H 'Content-Type: application/json' \ --data-binary '{"postBody":"access_token=[FACEBOOK_ACCESS_TOKEN]&providerId=[facebook.com]","idToken":"[FIREBASE_ID_TOKEN]","requestUri":"[http://localhost]","returnIdpCredential":true,"returnSecureToken":true}'
अनुरोध स्वीकार किए जाने का मतलब 200 OK
एचटीटीपी है
स्टेटस कोड डालें. रिस्पॉन्स में Firebase आईडी टोकन और रीफ़्रेश टोकन शामिल होता है
पुष्टि करनी होगी.
OAuth ऐक्सेस टोकन के साथ रिस्पॉन्स का सैंपल
{ "federatedId": "http://facebook.com/1234567890", "providerId": "facebook.com", "localId": "5xwsPCWYo...", "emailVerified": true, "email": "user@example.com", "oauthAccessToken": "[FACEBOOK_ACCESS_TOKEN]", "firstName": "John", "lastName": "Doe", "fullName": "John Doe", "displayName": "John Doe", "idToken": "[ID_TOKEN]", "photoUrl": "https://scontent.xx.fbcdn.net/v/...", "refreshToken": "[REFRESH_TOKEN]", "expiresIn": "3600", "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}" }
Twitter OAuth 1.0 क्रेडेंशियल के साथ अनुरोध का सैंपल
curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \ -H 'Content-Type: application/json' \ --data-binary '{"postBody":"access_token=[TWITTER_ACCESS_TOKEN]&oauth_token_secret=[TWITTER_TOKEN_SECRET]&providerId=[twitter.com]","requestUri":"[http://localhost]","idToken":"[FIREBASE_ID_TOKEN]","returnIdpCredential":true,"returnSecureToken":true}'
अनुरोध स्वीकार किए जाने का मतलब 200 OK
एचटीटीपी है
स्टेटस कोड डालें. रिस्पॉन्स में Firebase आईडी टोकन और रीफ़्रेश टोकन शामिल होता है
पुष्टि करनी होगी.
Twitter OAuth 1.0 क्रेडेंशियल के साथ रिस्पॉन्स का सैंपल
{ "federatedId": "http://twitter.com/1234567890", "providerId": "twitter.com", "localId": "5xwsPCWYo...", "emailVerified": true, "email": "user@example.com", "oauthAccessToken": "[OAUTH_ACCESS_TOKEN]", "oauthTokenSecret": "[OAUTH_TOKEN_SECRET]", "firstName": "John", "lastName": "Doe", "fullName": "John Doe", "displayName": "John Doe", "idToken": "[ID_TOKEN]", "photoUrl": "http://abs.twimg.com/sticky/...", "refreshToken": "[REFRESH_TOKEN]", "expiresIn": "3600", "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}" }
सामान्य गड़बड़ियों के कोड
- OPERATION_NOT_ALLOWED: संबंधित कंपनी को इस प्रोजेक्ट के लिए बंद कर दिया गया है.
- INVALID_IDP_REPLY: दिया गया पुष्टि करने का क्रेडेंशियल गलत है या उसकी समयसीमा खत्म हो चुकी है.
- INVALID_ID_TOKEN:उपयोगकर्ता का क्रेडेंशियल अब मान्य नहीं है. उपयोगकर्ता को फिर से साइन इन करना होगा.
- EMAIL_EXISTS: ईमेल पता पहले से किसी अन्य खाते के उपयोग में है.
- FEDETED_USER_ID_ALREADY_LINKED: यह क्रेडेंशियल पहले से ही किसी दूसरे क्रेडेंशियल से जुड़ा है उपयोगकर्ता खाता.
सेवा देने वाली कंपनी को अलग करें
एचटीटीपी जारी करके, सेवा देने वाली कंपनी को मौजूदा उपयोगकर्ता से अनलिंक किया जा सकता है
पुष्टि करने के setAccountInfo
एंडपॉइंट के लिए POST
अनुरोध.
तरीका: POST
कॉन्टेंट का टाइप: ऐप्लिकेशन/JSON
एंडपॉइंटhttps://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
आईडीटोकन | स्ट्रिंग | खाते का Firebase आईडी टोकन. |
DeleteProvider | स्ट्रिंग की सूची | अलग किए जाने वाले आईडी की सूची, जैसे: 'google.com', 'password' वगैरह. |
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
स्थानीय आईडी | स्ट्रिंग | मौजूदा उपयोगकर्ता का uid. |
ईमेल | स्ट्रिंग | खाते का ईमेल पता. |
displayName | स्ट्रिंग | खाते का डिसप्ले नेम. |
फ़ोटोUrl | स्ट्रिंग | खाते के लिए फ़ोटो का यूआरएल. |
पासवर्ड हैश | स्ट्रिंग | पासवर्ड का हैश वर्शन. |
कंपनी के उपयोगकर्ता की जानकारी | JSON ऑब्जेक्ट की सूची | लिंक किए गए, प्रोवाइडर के उन सभी ऑब्जेक्ट की सूची जिनमें "providerId" है और "फ़ेडरेटेड आईडी" है. |
ईमेल से पुष्टि की गई | बूलियन | खाते के ईमेल पते की पुष्टि की गई है या नहीं. |
अनुरोध का सैंपल
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
एचटीटीपी है
स्टेटस कोड डालें.
जवाब का सैंपल
{ "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: उपयोगकर्ता का क्रेडेंशियल अब मान्य नहीं है. उपयोगकर्ता को फिर से साइन इन करना होगा.
पुष्टि करने के लिए ईमेल भेजें
आप एचटीटीपी जारी करके मौजूदा उपयोगकर्ता के लिए ईमेल पते की पुष्टि कर सकते हैं
पुष्टि करने के getOobConfirmationCode
एंडपॉइंट के लिए POST
अनुरोध.
तरीका: POST
कॉन्टेंट का टाइप: ऐप्लिकेशन/JSON
एंडपॉइंटhttps://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]
प्रॉपर्टी का नाम | ब्यौरा |
---|---|
X-Firebase-लोकेल | उपयोगकर्ता की स्थान-भाषा के मुताबिक भाषा का कोड. इसे पास करने से ईमेल पते की पुष्टि उपयोगकर्ता को भेजी गई. |
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
requestType | स्ट्रिंग | भेजे जाने वाले पुष्टि करने वाले कोड का टाइप. इसकी वैल्यू हमेशा "CODE_EMAIL" होनी चाहिए. |
आईडीटोकन | स्ट्रिंग | पुष्टि करने के लिए उपयोगकर्ता का Firebase आईडी टोकन. |
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
ईमेल | स्ट्रिंग | खाते का ईमेल पता. |
अनुरोध का सैंपल
curl 'https://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]' \ -H 'Content-Type: application/json' \ --data-binary '{"requestType":"VERIFY_EMAIL","idToken":"[FIREBASE_ID_TOKEN]"}'
अनुरोध स्वीकार किए जाने का मतलब 200 OK
एचटीटीपी है
स्टेटस कोड डालें.
जवाब का सैंपल
{ "email": "user@example.com" }
सामान्य गड़बड़ियों के कोड
- INVALID_ID_TOKEN: उपयोगकर्ता का क्रेडेंशियल अब मान्य नहीं है. उपयोगकर्ता को फिर से साइन इन करना होगा.
- USER_NOT_FOUND: इस आइडेंटिफ़ायर से जुड़ा कोई उपयोगकर्ता रिकॉर्ड नहीं है. उपयोगकर्ता हो सकता है हटा दिए गए हैं.
ईमेल पते की पुष्टि करें
एक एचटीटीपी जारी करके, ईमेल पते की पुष्टि करने वाले कोड की पुष्टि की जा सकती है
पुष्टि करने के setAccountInfo
एंडपॉइंट के लिए POST
अनुरोध.
तरीका: POST
कॉन्टेंट का टाइप: ऐप्लिकेशन/JSON
एंडपॉइंटhttps://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
oobCode | स्ट्रिंग | कार्रवाई का कोड, ईमेल पते की पुष्टि करने के लिए उपयोगकर्ता के ईमेल पते पर भेजा गया है. |
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
ईमेल | स्ट्रिंग | खाते का ईमेल पता. |
displayName | स्ट्रिंग | खाते का डिसप्ले नेम. |
फ़ोटोUrl | स्ट्रिंग | खाते के लिए फ़ोटो का यूआरएल. |
पासवर्ड हैश | स्ट्रिंग | पासवर्ड हैश. |
कंपनी के उपयोगकर्ता की जानकारी | JSON ऑब्जेक्ट की सूची | लिंक किए गए, प्रोवाइडर के उन सभी ऑब्जेक्ट की सूची जिनमें "providerId" है और "फ़ेडरेटेड आईडी" है. |
ईमेल से पुष्टि की गई | बूलियन | खाते के ईमेल पते की पुष्टि की गई है या नहीं. |
अनुरोध का सैंपल
curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \ -H 'Content-Type: application/json' --data-binary '{"oobCode":"[VERIFICATION_CODE]"}'
अनुरोध स्वीकार किए जाने का मतलब 200 OK
एचटीटीपी है
स्टेटस कोड डालें.
जवाब का सैंपल
{ "localId": "FhyStE...", "email": "user@example.com", "passwordHash": "...", "providerUserInfo": [ { "providerId": "password", "federatedId": "user@example.com" } ] }
सामान्य गड़बड़ियों के कोड
- EXPIRED_OOB_CODE: कार्रवाई कोड की समयसीमा खत्म हो गई है.
- INVALID_OOB_CODE: कार्रवाई कोड अमान्य है. ऐसा तब हो सकता है, जब कोड गलत हो, जिनकी समयसीमा खत्म हो गई हो या जिनका इस्तेमाल पहले ही किया जा चुका हो.
- USER_disableD: उपयोगकर्ता खाता व्यवस्थापक द्वारा अक्षम कर दिया गया है.
- EMAIL_NOT_FOUND: इस आइडेंटिफ़ायर से जुड़ा कोई उपयोगकर्ता रिकॉर्ड नहीं है. उपयोगकर्ता हो सकता है हटा दिए गए हैं.
खाता मिटाएं
एचटीटीपी जारी करके, मौजूदा उपयोगकर्ता को मिटाया जा सकता है
पुष्टि करने के deleteAccount
एंडपॉइंट के लिए POST
अनुरोध.
तरीका: POST
कॉन्टेंट का टाइप: ऐप्लिकेशन/JSON
एंडपॉइंटhttps://identitytoolkit.googleapis.com/v1/accounts:delete?key=[API_KEY]
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
आईडीटोकन | स्ट्रिंग | उपयोगकर्ता का Firebase आईडी टोकन, जिसे मिटाना है. |
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|
अनुरोध का सैंपल
curl 'https://identitytoolkit.googleapis.com/v1/accounts:delete?key=[API_KEY]' \ -H 'Content-Type: application/json' --data-binary '{"idToken":"[FIREBASE_ID_TOKEN]"}'
अनुरोध स्वीकार किए जाने का मतलब 200 OK
एचटीटीपी है
स्टेटस कोड डालें.
सामान्य गड़बड़ियों के कोड
- INVALID_ID_TOKEN:उपयोगकर्ता का क्रेडेंशियल अब मान्य नहीं है. उपयोगकर्ता को फिर से साइन इन करना होगा.
- USER_NOT_FOUND: इस आइडेंटिफ़ायर से जुड़ा कोई उपयोगकर्ता रिकॉर्ड नहीं है. उपयोगकर्ता हो सकता है हटा दिए गए हैं.
Firebase ऑथेंटिकेशन एम्युलेटर
Firebase लोकल एम्युलेटर सुइट में एक पुष्टि करने वाला एम्युलेटर शामिल है. इसका इस्तेमाल इन कामों के लिए किया जा सकता है लोकल प्रोटोटाइपिंग और ऑथेंटिकेशन फ़्लो की टेस्टिंग. एम्युलेटर, इन REST की जानकारी दिखाता है एंडपॉइंट के बारे में भी बताएंगे.
उपयोगकर्ता खाते हटाएं
बताए गए प्रोजेक्ट में सभी खाते हटाएं, भले ही वह स्थिति कुछ भी हो.
तरीका: DELETE
एंडपॉइंट
ध्यान दें कि ऑथेंटिकेशन एम्युलेटर के लिए 9099
डिफ़ॉल्ट पोर्ट है. टर्मिनल की जांच करें
इस्तेमाल किए जा रहे असल पोर्ट का आउटपुट.
http://localhost:9099/emulator/v1/projects/{project-id}/accounts
एम्युलेटर कॉन्फ़िगरेशन पाएं
बताए गए प्रोजेक्ट के लिए एम्युलेटर के हिसाब से कॉन्फ़िगरेशन पाएं.
तरीका: GET
एंडपॉइंट
ध्यान दें कि ऑथेंटिकेशन एम्युलेटर के लिए 9099
डिफ़ॉल्ट पोर्ट है. टर्मिनल की जांच करें
इस्तेमाल किए जा रहे असल पोर्ट का आउटपुट.
http://localhost:9099/emulator/v1/projects/{project-id}/config
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
साइन इन करें | ऑब्जेक्ट | साइन इन कॉन्फ़िगरेशन ऑब्जेक्ट में एक कुंजी, allowDuplicateEmails (बूलियन) है. |
पैच एम्युलेटर कॉन्फ़िगरेशन
बताए गए प्रोजेक्ट के लिए एम्युलेटर के हिसाब से कॉन्फ़िगरेशन अपडेट करें.
तरीका: पैच
एंडपॉइंट
ध्यान दें कि ऑथेंटिकेशन एम्युलेटर के लिए 9099
डिफ़ॉल्ट पोर्ट है. टर्मिनल की जांच करें
इस्तेमाल किए जा रहे असल पोर्ट का आउटपुट.
कॉन्टेंट का टाइप: ऐप्लिकेशन/JSON
http://localhost:9099/emulator/v1/projects/{project-id}/config
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
साइन इन करें | ऑब्जेक्ट | पसंदीदा साइन इन कॉन्फ़िगरेशन ऑब्जेक्ट, जिसमें एक कुंजी, allowDuplicateEmails (बूलियन) है. |
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
साइन इन करें | ऑब्जेक्ट | अनुरोध के बाद साइन इन कॉन्फ़िगरेशन ऑब्जेक्ट, जिसमें एक कुंजी, allowDuplicateEmails (बूलियन) है. |
आउट-ऑफ़-बैंड प्रमाणीकरण कोड वापस पाना
अगर पुष्टि करने के फ़्लो की जांच की जा रही है, तो आम तौर पर वह आउट-ऑफ़-बैंड कोड जनरेट करता है (उदाहरण के लिए, ईमेल पते की पुष्टि करने के कोड, पासवर्ड रीसेट करने के कोड), एम्युलेटर इन कोड को अंदरूनी तौर पर इस समय तक सेव करता है उनका इस्तेमाल होता है.
तरीका: GET
एंडपॉइंट
ध्यान दें कि ऑथेंटिकेशन एम्युलेटर के लिए 9099
डिफ़ॉल्ट पोर्ट है. टर्मिनल की जांच करें
इस्तेमाल किए जा रहे असल पोर्ट का आउटपुट.
http://localhost:9099/emulator/v1/projects/{project-id}/oobCodes
प्रॉपर्टी का नाम | टाइप | ब्यौरा |
---|---|---|
oobCodes | कलेक्शन | ऑब्जेक्ट का कलेक्शन, जिसमें पुष्टि करने के लिए ऐसे सभी कोड की जानकारी है जिन्हें मंज़ूरी मिलना बाकी है.
हर ऑब्जेक्ट में, email (स्ट्रिंग), oobCode (स्ट्रिंग) होता है.
oobLink (स्ट्रिंग) और requestType (स्ट्रिंग) |
मैसेज (एसएमएस) की पुष्टि करने वाले कोड वापस पाएं
अगर फ़ोन/एसएमएस की पुष्टि करने के फ़्लो की जांच की जा रही है, तो एम्युलेटर ऐसे मैसेज (एसएमएस) कोड को अंदरूनी तौर पर सेव करता है जब तक उनका इस्तेमाल नहीं किया जाता.
तरीका: GET
एंडपॉइंट
ध्यान दें कि ऑथेंटिकेशन एम्युलेटर के लिए 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" } }
गड़बड़ी का कोड, मैसेज फ़ील्ड से मिलता है. ऊपर दिए गए सभी गड़बड़ी कोड मैसेज फ़ील्ड में मौजूद कॉन्टेंट को कॉपी करने की सुविधा मिलती है.