Firebase is back at Google I/O on May 14! Register now.

इस पेज का अनुवाद Cloud Translation API से किया गया है.

BaseAuth class

Auth और TenantAwareAuth, दोनों एपीआई के लिए सामान्य पैरंट इंटरफ़ेस.

हस्ताक्षर:

export declare abstract class BaseAuth

तरीके

तरीका	मॉडिफ़ायर	ब्यौरा
createCustomToken(uid, developerclaims)		नया Firebase कस्टम टोकन (JWT) बनाता है. इसे क्लाइंट डिवाइस पर वापस भेजा जा सकता है, ताकि क्लाइंट SDK टूल के `signInWithCustomToken()` तरीकों से साइन इन किया जा सके. (टेनेंट-अवेयर इंस्टेंस, टेनेंट आईडी को टोकन में भी एम्बेड कर देंगे.)कोड सैंपल और ज़्यादा जानकारी वाले दस्तावेज़ के लिए, कस्टम टोकन बनाएं देखें.
createProviderConfig(config)		सेवा देने वाली नई कंपनी का कॉन्फ़िगरेशन बनाने के बाद, नए बनाए गए `AuthProviderConfig` के साथ ऐसा प्रॉमिस मिलता है जो सेवा देने वाली नई कंपनी का कॉन्फ़िगरेशन बनाता है.SAML और OIDC प्रोवाइडर सहायता के लिए, Google Cloud के Identity Platform (GCIP) की ज़रूरत होती है. कीमत और सुविधाओं के साथ-साथ जीसीआईपी के बारे में ज़्यादा जानने के लिए, जीसीआईपी के दस्तावेज़ देखें.
createSessionCookie(idToken, sessionCookieOptions)		दिए गए विकल्पों के साथ नई Firebase सेशन कुकी बनाता है. बनाई गई JWT स्ट्रिंग, पसंद के मुताबिक बनाई गई कुकी नीति की मदद से सर्वर-साइड सेशन कुकी के तौर पर सेट की जा सकती है. साथ ही, इसका इस्तेमाल सेशन मैनेजमेंट के लिए किया जा सकता है. सेशन कुकी JWT में पेलोड के वे दावे होंगे जो दिए गए आईडी टोकन की तरह होंगे.कोड सैंपल और ज़्यादा जानकारी वाले दस्तावेज़ के लिए, सेशन कुकी मैनेज करें पर जाएं.
createUser(प्रॉपर्टी)		नया उपयोगकर्ता बनाता है.कोड सैंपल और ज़्यादा जानकारी वाले दस्तावेज़ के लिए, उपयोगकर्ता बनाना देखें.
deleteProviderConfig(providerId)		पास किए गए प्रोवाइडर आईडी के हिसाब से, प्रोवाइडर का कॉन्फ़िगरेशन मिटाता है. अगर बताया गया आईडी मौजूद नहीं है, तो `auth/configuration-not-found` गड़बड़ी होती है.SAML और OIDC प्रोवाइडर से सहायता पाने के लिए, Google Cloud Identity Platform (GCIP) की ज़रूरत होती है. कीमत और सुविधाओं के साथ-साथ जीसीआईपी के बारे में ज़्यादा जानने के लिए, जीसीआईपी के दस्तावेज़ देखें.
deleteUser(uid)		किसी मौजूदा उपयोगकर्ता को हटाता है.कोड नमूनों और विस्तृत दस्तावेज़ों के लिए उपयोगकर्ता को हटाएं देखें.
deleteUsers(uids)		दिए गए uids से तय किए गए उपयोगकर्ताओं को मिटा देता है.किसी गैर-मौजूद उपयोगकर्ता को मिटाने से कोई गड़बड़ी जनरेट नहीं होगी (यानी यह तरीका मुआवज़ा है.) जो उपयोगकर्ता मौजूद नहीं हैं उनके लिए यह माना जाता है कि उन्हें मिटा दिया गया है. इसलिए, उन्हें `DeleteUsersResult.successCount` वैल्यू में गिना जाता है.ज़्यादा से ज़्यादा 1,000 आइडेंटिफ़ायर ही दिए जा सकते हैं. अगर 1,000 से ज़्यादा आइडेंटिफ़ायर दिए गए हैं, तो यह तरीका FirebaseAuthError दिखाता है.फ़िलहाल, सर्वर पर इस एपीआई की दर एक क्यूपीएस तक सीमित है. अगर आपने यह सीमा पार कर ली है, तो आपको कोटा से ज़्यादा हुई गड़बड़ी दिख सकती है. इसलिए, अगर आपको 1,000 से ज़्यादा उपयोगकर्ताओं को हटाना है, तो आपको कुछ समय बाद उसे मिटाना पड़ सकता है, ताकि आप इस सीमा को पार न करें.
GenerateEmail VerificationLink(email, actionCodeSettings)		दिए गए ईमेल पर उपयोगकर्ता के मालिकाना हक की पुष्टि करने के लिए, बैंड ईमेल की कार्रवाई से जुड़ा लिंक जनरेट करता है. इस तरीके के तर्क के तौर पर दिए गए ActionCodeSettings ऑब्जेक्ट से तय होता है कि लिंक को मोबाइल ऐप्लिकेशन या ब्राउज़र से मैनेज किया जाएगा या नहीं. साथ ही, डीप लिंक में पास की जाने वाली स्थिति की अतिरिक्त जानकारी भी दी जाएगी.
GeneratePasswordResetLink(email, actionCodeSettings)		किसी उपयोगकर्ता का पासवर्ड रीसेट करने के लिए बैंड ईमेल कार्रवाई लिंक से आउट जनरेट करता है. यह लिंक, बताए गए ईमेल पते वाले उपयोगकर्ता के लिए जनरेट किया जाता है. वैकल्पिक ActionCodeSettings ऑब्जेक्ट से तय होता है कि लिंक को मोबाइल ऐप्लिकेशन या ब्राउज़र से मैनेज किया जाए या नहीं. डीप लिंक में पास की जाने वाली स्थिति की अतिरिक्त जानकारी वगैरह.
GenerateSignInWithEmailLink(email, actionCodeSettings)		दिए गए ईमेल पर उपयोगकर्ता के मालिकाना हक की पुष्टि करने के लिए, बैंड ईमेल की कार्रवाई से जुड़ा लिंक जनरेट करता है. इस तरीके के तर्क के तौर पर दिए गए ActionCodeSettings ऑब्जेक्ट से तय होता है कि लिंक को मोबाइल ऐप्लिकेशन या ब्राउज़र से मैनेज किया जाएगा या नहीं. साथ ही, डीप लिंक में पास की जाने वाली स्थिति की अतिरिक्त जानकारी भी दी जाएगी.
GenerateVerifyAndChangeEmailLink(email, newEmail, ActionCodeSettings)		यह आउट-ऑफ़-बैंड ईमेल ऐक्शन लिंक जनरेट करता है, ताकि दिए गए ईमेल पर उपयोगकर्ता के मालिकाना हक की पुष्टि की जा सके. इस तरीके के तर्क के तौर पर दिए गए ActionCodeSettings ऑब्जेक्ट से तय होता है कि लिंक को मोबाइल ऐप्लिकेशन या ब्राउज़र से मैनेज किया जाएगा या नहीं. साथ ही, डीप लिंक में पास की जाने वाली स्थिति की अतिरिक्त जानकारी भी दी जाएगी.
getProviderConfig(providerId)		दिए गए आईडी से, पुष्टि करने वाली सेवा का कॉन्फ़िगरेशन ढूंढता है. यह प्रॉमिस देता है जो बताए गए प्रोवाइडर आईडी के हिसाब से प्रोवाइडर के कॉन्फ़िगरेशन के साथ रिज़ॉल्व होता है. अगर बताया गया आईडी मौजूद नहीं है, तो `auth/configuration-not-found` गड़बड़ी होती है.SAML और OIDC प्रोवाइडर से सहायता पाने के लिए, Google Cloud Identity Platform (GCIP) की ज़रूरत होती है. कीमत और सुविधाओं के साथ-साथ जीसीआईपी के बारे में ज़्यादा जानने के लिए, जीसीआईपी के दस्तावेज़ देखें.
getUser(uid)		दिए गए `uid` से जुड़े उपयोगकर्ता के लिए उपयोगकर्ता डेटा देता है.कोड सैंपल और ज़्यादा जानकारी के साथ दस्तावेज़ के लिए उपयोगकर्ता का डेटा वापस पाएं देखें.
getUserByEmail(ईमेल)		दिए गए ईमेल से जुड़े उपयोगकर्ता के लिए उपयोगकर्ता डेटा देता है.कोड सैंपल और ज़्यादा जानकारी के लिए, उपयोगकर्ता का डेटा वापस पाएं देखें.
getUserByPhoneNumber(phoneNumber)		इसमें, दिए गए फ़ोन नंबर से जुड़े उपयोगकर्ता का डेटा मिलता है. फ़ोन नंबर E.164 के स्पेसिफ़िकेशन के मुताबिक होना चाहिए.कोड सैंपल और ज़्यादा जानकारी वाले दस्तावेज़ के लिए, उपयोगकर्ता का डेटा वापस पाएं देखें.
getUserByProviderUid(providerId, uid)		किसी प्रोवाइडर आईडी से जुड़े उपयोगकर्ता के लिए, उपयोगकर्ता का डेटा हासिल करता है.कोड सैंपल और ज़्यादा जानकारी वाले दस्तावेज़ों के लिए, उपयोगकर्ता का डेटा वापस पाएं देखें.
getUsers(आइडेंटिफ़ायर)		इससे, तय किए गए आइडेंटिफ़ायर से जुड़ा उपयोगकर्ता डेटा मिलता है.इस बात की कोई गारंटी नहीं है कि ऑर्डर की कोई गारंटी नहीं है. खास तौर पर, इस बात की कोई गारंटी नहीं है कि नतीजों की सूची की nवीं एंट्री, इनपुट पैरामीटर की सूची में मौजूद nवीं एंट्री से मेल खाएगी.ज़्यादा से ज़्यादा 100 आइडेंटिफ़ायर दिए जा सकते हैं. अगर 100 से ज़्यादा आइडेंटिफ़ायर दिए गए हैं, तो यह तरीका FirebaseAuthError दिखाता है.
इंपोर्ट उपयोगकर्ता(उपयोगकर्ता, विकल्प)		यह नीति, उपयोगकर्ताओं की दी गई सूची को Firebase पुष्टि में इंपोर्ट करती है. एक बार में एक उपयोगकर्ता को ज़्यादा से ज़्यादा 1,000 उपयोगकर्ताओं को इंपोर्ट किया जा सकता है. पासवर्ड वाले उपयोगकर्ताओं को इंपोर्ट करते समय, UserImportOptions के बारे में बताना ज़रूरी है. यह कार्रवाई, बल्क इंपोर्ट के लिए ऑप्टिमाइज़ की गई है. साथ ही, यह `uid`, `email`, और आइडेंटिफ़ायर की दूसरी खासियत की जांच को अनदेखा कर देगी. इससे डुप्लीकेट डेटा बन सकता है.
listProviderConfigs(options)		दिए गए फ़िल्टर से मेल खाने वाले, प्रोवाइडर के मौजूदा कॉन्फ़िगरेशन की सूची दिखाता है. एक बार में, सेवा देने वाली कंपनी के 100 कॉन्फ़िगरेशन शामिल किए जा सकते हैं.SAML और OIDC प्रोवाइडर के लिए सहायता पाने के लिए, Google Cloud Identity Platform (GCIP) की ज़रूरत होती है. कीमत और सुविधाओं के साथ-साथ जीसीआईपी के बारे में ज़्यादा जानने के लिए, जीसीआईपी के दस्तावेज़ देखें.
listUsers(maxresults, pageToken)		`pageToken` के बताए गए ऑफ़सेट से शुरू होने वाले `maxResults` साइज़ वाले उपयोगकर्ताओं की सूची (सिर्फ़ एक बैच) लाता है. इसका इस्तेमाल किसी खास प्रोजेक्ट के सभी उपयोगकर्ताओं को बैच में पाने के लिए किया जाता है.कोड सैंपल और ज़्यादा जानकारी के साथ दस्तावेज़ के लिए सभी उपयोगकर्ताओं की सूची बनाएं देखें.
Revoke FreshTokens(uid)		यह किसी मौजूदा उपयोगकर्ता के सभी रीफ़्रेश टोकन को रद्द करता है.यह एपीआई, उपयोगकर्ता के UserRecord.tokensValidAfterTime को मौजूदा यूटीसी में अपडेट कर देगा. यह ज़रूरी है कि जिस सर्वर पर इसे कॉल किया गया है उसकी घड़ी सही तरीके से सेट हो और सिंक की हुई हो.हालांकि, ऐसा करने से किसी खास उपयोगकर्ता के सभी सेशन रद्द हो जाएंगे और मौजूदा सेशन के लिए कोई भी नया आईडी टोकन इकट्ठा नहीं होने दिया जाएगा. हालांकि, मौजूदा आईडी टोकन अपनी समयसीमा खत्म होने (एक घंटे) तक चालू रह सकते हैं. यह पुष्टि करने के लिए कि आईडी टोकन रद्द कर दिए गए हैं, BaseAuth.verifyIdToken() का इस्तेमाल करें, जहां `checkRevoked` को 'सही है' पर सेट किया गया है.
setCustomUserClaims(uid, customUserClaims)		यह नीति, दिए गए `uid` के ज़रिए पहचाने गए मौजूदा उपयोगकर्ता पर, डेवलपर के लिए अन्य दावे सेट करती है. आम तौर पर, इसका इस्तेमाल उपयोगकर्ता की भूमिकाएं और ऐक्सेस के लेवल तय करने के लिए किया जाता है. ये दावे उन सभी डिवाइसों पर लागू होने चाहिए जिनमें उपयोगकर्ता ने पहले से साइन इन किया हुआ है. यह तब लागू होता है, जब टोकन की समयसीमा खत्म होने या टोकन रीफ़्रेश करने की सुविधा लागू होने के बाद, उपयोगकर्ता अगली बार साइन इन करता है. अगर OIDC के रिज़र्व किए गए किसी दावे का नाम (sub, iat, iss वगैरह) इस्तेमाल किया जाता है, तो गड़बड़ी का मैसेज दिखता है. इन्हें पुष्टि किए गए उपयोगकर्ता के आईडी टोकन JWT पर सेट किया जाता है.इन्हें कोड सैंपल और ज़्यादा जानकारी वाले दस्तावेज़ों के लिए, उपयोगकर्ता की भूमिकाएं और ऐक्सेस लेवल तय करना देखें.
updateProviderConfig(providerId, updatedConfig)		सेवा देने वाले के तय किए गए आईडी के हिसाब से अपडेट किए गए `AuthProviderConfig` के साथ रिज़ॉल्व करने वाला प्रॉमिस देता है. अगर बताया गया आईडी मौजूद नहीं है, तो `auth/configuration-not-found` गड़बड़ी होती है.SAML और OIDC प्रोवाइडर से सहायता पाने के लिए, Google Cloud Identity Platform (GCIP) की ज़रूरत होती है. कीमत और सुविधाओं के साथ-साथ जीसीआईपी के बारे में ज़्यादा जानने के लिए, जीसीआईपी के दस्तावेज़ देखें.
updateUser(uid, प्रॉपर्टी)		किसी मौजूदा उपयोगकर्ता को अपडेट करता है.कोड सैंपल और ज़्यादा जानकारी वाले दस्तावेज़ के लिए, उपयोगकर्ता को अपडेट करें.
verifyIdToken(idToken, check भूलेंd)		Firebase आईडी टोकन (JWT) की पुष्टि करता है. अगर टोकन मान्य है, तो प्रॉमिस, टोकन के डिकोड किए गए दावों के साथ पूरा किया जाता है. ऐसा न करने पर, प्रॉमिस अस्वीकार कर दिया जाता है.अगर `checkRevoked` को 'सही है' पर सेट किया जाता है, तो सबसे पहले यह पुष्टि करता है कि इससे जुड़े उपयोगकर्ता को बंद किया गया है या नहीं. अगर हां, तो `auth/user-disabled` गड़बड़ी होती है. अगर नहीं, तो यह पुष्टि करता है कि आईडी टोकन से जुड़े सेशन को रद्द किया गया था या नहीं. अगर इससे जुड़े उपयोगकर्ता का सेशन अमान्य हो जाता है, तो `auth/id-token-revoked` गड़बड़ी होती है. अगर जानकारी नहीं दी जाती है, तो जांच लागू नहीं होती.कोड सैंपल और ज़्यादा जानकारी के लिए, आईडी टोकन की पुष्टि करें लेख पढ़ें.
verifySessionCookie(sessionCookie, चेक रद्द किया गया)		Firebase सेशन कुकी की पुष्टि करता है. कुकी के दावों के साथ प्रॉमिस दिखाता है. कुकी की पुष्टि न हो पाने पर, प्रॉमिस को अस्वीकार करता है.अगर `checkRevoked` को 'सही है' पर सेट किया गया है, तो सबसे पहले यह पुष्टि करता है कि इससे जुड़े उपयोगकर्ता को बंद किया गया है या नहीं: अगर हां, तो `auth/user-disabled` गड़बड़ी होती है. अगर नहीं, तो यह पुष्टि करता है कि सेशन कुकी से जुड़े सेशन को रद्द किया गया था या नहीं. अगर इससे जुड़े उपयोगकर्ता का सेशन अमान्य हो जाता है, तो `auth/session-cookie-revoked` गड़बड़ी होती है. अगर बताया नहीं गया है, तो जांच नहीं की जाती है.कोड सैंपल और ज़्यादा जानकारी के साथ दस्तावेज़ के लिए सेशन कुकी की पुष्टि करें देखें

BaseAuth.createCustomToken()

नया Firebase कस्टम टोकन (JWT) बनाता है. इसे क्लाइंट डिवाइस पर वापस भेजा जा सकता है, ताकि क्लाइंट SDK टूल के signInWithCustomToken() तरीकों से साइन इन किया जा सके. (टेनेंट-अवेयर इंस्टेंस भी टोकन में टेनेंट आईडी को जोड़ देंगे.)

कोड सैंपल और ज़्यादा जानकारी के लिए, कस्टम टोकन बनाएं लेख पढ़ें.

हस्ताक्षर:

createCustomToken(uid: string, developerClaims?: object): Promise<string>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
यूआईडी	स्ट्रिंग	कस्टम टोकन के सब्जेक्ट के तौर पर इस्तेमाल करने के लिए `uid`.
डेवलपर के दावे	ऑब्जेक्ट	कस्टम टोकन के पेलोड में शामिल करने के लिए, अन्य दावे करना ज़रूरी नहीं है.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<string>

दिए गए uid और पेलोड के लिए कस्टम टोकन के साथ पूरा किया गया प्रॉमिस.

BaseAuth.createProviderConfig()

सेवा देने वाली नई कंपनी का कॉन्फ़िगरेशन बनाते समय, ऐसा प्रॉमिस दिया जाता है जो नए बनाए गए AuthProviderConfig से रिज़ॉल्व होता है.

एसएएमएल और OIDC की सेवा देने वाली कंपनी से मिलने वाली सहायता के लिए, Google Cloud Identity Platform (GCIP) की ज़रूरत होती है. कीमत और सुविधाओं के साथ-साथ जीसीआईपी के बारे में ज़्यादा जानने के लिए, जीसीआईपी के दस्तावेज़ देखें.

हस्ताक्षर:

createProviderConfig(config: AuthProviderConfig): Promise<AuthProviderConfig>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
कॉन्फ़िगरेशन	AuthProviderConfig	सेवा देने वाली कंपनी का कॉन्फ़िगरेशन, जिसे बनाना है.

लौटाए जाने वाले प्रॉडक्ट:

Promise<AuthProviderConfig>

ऐसा प्रॉमिस जो प्रोवाइडर के बनाए गए कॉन्फ़िगरेशन के साथ रिज़ॉल्व हो जाता है.

BaseAuth.createSessionCookie()

दिए गए विकल्पों के साथ नई Firebase सेशन कुकी बनाता है. बनाई गई JWT स्ट्रिंग, पसंद के मुताबिक बनाई गई कुकी नीति की मदद से सर्वर-साइड सेशन कुकी के तौर पर सेट की जा सकती है. साथ ही, इसका इस्तेमाल सेशन मैनेजमेंट के लिए किया जा सकता है. सेशन कुकी JWT में वही पेलोड दावे होंगे जो दिए गए आईडी टोकन के लिए होंगे.

कोड सैंपल और ज़्यादा जानकारी के लिए, सेशन कुकी मैनेज करें देखें.

हस्ताक्षर:

createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions): Promise<string>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
idToken	स्ट्रिंग	सेशन कुकी के बदले Firebase आईडी टोकन.
sessionCookieOptions	sessionCookieOptions	सेशन कुकी के विकल्प, जिनमें कस्टम सेशन की अवधि शामिल होती है.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<string>

ऐसा प्रॉमिस जो बनाई गई सेशन कुकी की मदद से सफल होता है.

BaseAuth.createUser()

नया उपयोगकर्ता बनाता है.

कोड सैंपल और ज़्यादा जानकारी वाले दस्तावेज़ के लिए, उपयोगकर्ता बनाना लेख पढ़ें.

हस्ताक्षर:

createUser(properties: CreateRequest): Promise<UserRecord>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
प्रॉपर्टी	अनुरोध करें	नए उपयोगकर्ता के बनाए जाने वाले रिकॉर्ड के हिसाब से सेट की जाने वाली प्रॉपर्टी.

लौटाए जाने वाले प्रॉडक्ट:

वादा करें<UserRecord>

नए उपयोगकर्ता के डेटा के साथ पूरा किया गया प्रॉमिस.

BaseAuth.deleteProviderConfig()

पास किए गए प्रोवाइडर आईडी के हिसाब से, प्रोवाइडर का कॉन्फ़िगरेशन मिटाता है. अगर बताया गया आईडी मौजूद नहीं है, तो auth/configuration-not-found गड़बड़ी होती है.

हस्ताक्षर:

deleteProviderConfig(providerId: string): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
कंपनी आईडी	स्ट्रिंग	सेवा देने वाली कंपनी के कॉन्फ़िगरेशन से जुड़ा प्रोवाइडर आईडी, जिसे मिटाना है.

लौटाए जाने वाले प्रॉडक्ट:

वादा<void>

ऐसा प्रॉमिस जो पूरा होने पर रिज़ॉल्व हो जाता है.

BaseAuth.deleteUser()

किसी मौजूदा उपयोगकर्ता को हटाता है.

कोड के सैंपल और ज़्यादा जानकारी वाले दस्तावेज़ के लिए, उपयोगकर्ता को मिटाएं लेख पढ़ें.

हस्ताक्षर:

deleteUser(uid: string): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
यूआईडी	स्ट्रिंग	उपयोगकर्ता से जुड़ा `uid`, जिसे मिटाना है.

लौटाए जाने वाले प्रॉडक्ट:

वादा<void>

उपयोगकर्ता के मिटाए जाने के बाद, खाली प्रॉमिस पूरा हुआ.

BaseAuth.deleteUsers()

दिए गए uids से बताए गए उपयोगकर्ताओं को मिटाता है.

किसी ऐसे उपयोगकर्ता को मिटाने से कोई गड़बड़ी नहीं होगी जो मौजूद नहीं है. उदाहरण के लिए, यह तरीका बेअसर है. जो उपयोगकर्ता मौजूद नहीं हैं उनके लिए यह माना जाता है कि उन्हें मिटा दिया गया है. इसलिए, उन्हें DeleteUsersResult.successCount वैल्यू में गिना जाता है.

ज़्यादा से ज़्यादा 1,000 आइडेंटिफ़ायर ही दिए जा सकते हैं. अगर 1,000 से ज़्यादा आइडेंटिफ़ायर दिए गए हैं, तो यह तरीका FirebaseAuthError दिखाता है.

फ़िलहाल, सर्वर पर इस एपीआई की दर एक क्यूपीएस तक सीमित है. अगर आपने यह सीमा पार कर ली है, तो आपको कोटा से ज़्यादा हुई गड़बड़ी दिख सकती है. इसलिए, अगर आपको 1,000 से ज़्यादा उपयोगकर्ताओं को हटाना है, तो आपको कुछ समय बाद उसे मिटाना पड़ सकता है, ताकि आप इस सीमा को पार न करें.

हस्ताक्षर:

deleteUsers(uids: string[]): Promise<DeleteUsersResult>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
यूआईडी	स्ट्रिंग[]	उपयोगकर्ताओं से जुड़ा `uids`, जिसे मिटाना है.

लौटाए जाने वाले प्रॉडक्ट:

Promise<DeleteUsersresults>

ऐसा प्रॉमिस जो सफल/पूरी तरह नहीं मिटाए गए डेटा की कुल संख्या का समाधान करता है. साथ ही, मिटाए नहीं जा सके डेटा से जुड़ी गड़बड़ियों की कैटगरी भी बताता है.

BaseAuth.generateEmailverificationLink()

दिए गए ईमेल पर उपयोगकर्ता के मालिकाना हक की पुष्टि करने के लिए, बैंड ईमेल की कार्रवाई से जुड़ा लिंक जनरेट करता है. इस तरीके के तर्क के तौर पर दिए गए ActionCodeSettings ऑब्जेक्ट से तय होता है कि लिंक को मोबाइल ऐप्लिकेशन या ब्राउज़र से मैनेज किया जाएगा या नहीं. साथ ही, डीप लिंक में पास की जाने वाली स्थिति की अतिरिक्त जानकारी भी दी जाएगी.

हस्ताक्षर:

generateEmailVerificationLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
ईमेल	स्ट्रिंग	पुष्टि करने के लिए ईमेल खाता.
ActionCodeSettings	ActionCodeSettings	कार्रवाई कोड की सेटिंग. अगर बताया गया है, तो ईमेल की पुष्टि करने के लिंक में राज्य/जारी रखने वाले यूआरएल को "ContinueUrl" पैरामीटर के तौर पर सेट किया जाता है. ईमेल पते की पुष्टि करने वाला डिफ़ॉल्ट लैंडिंग पेज, इसका इस्तेमाल एक लिंक दिखाने के लिए करेगा, ताकि ऐप्लिकेशन के इंस्टॉल होने पर उस पर वापस जाया जा सके. अगर ActionCodeSettings की जानकारी नहीं है, तो कार्रवाई यूआरएल में कोई यूआरएल नहीं जोड़ा जाता है. दिया गया राज्य यूआरएल उस डोमेन से जुड़ा होना चाहिए जिसे डेवलपर ने कंसोल में अनुमति दी है. ऐसा न करने पर, कोई गड़बड़ी होती है. मोबाइल ऐप्लिकेशन रीडायरेक्ट सिर्फ़ तब लागू होते हैं, जब डेवलपर Firebase डाइनैमिक लिंक की सेवा की शर्तों को कॉन्फ़िगर करके उन्हें स्वीकार करता है. Android पैकेज के नाम और iOS बंडल आईडी का इस्तेमाल सिर्फ़ तब किया जाता है, जब उन्हें एक ही Firebase से पुष्टि वाले प्रोजेक्ट में कॉन्फ़िगर किया गया हो.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<string>

ऐसा प्रॉमिस जो जनरेट किए गए लिंक से पूरा होता है.

उदाहरण

var actionCodeSettings = {
  url: 'https://www.example.com/cart?email=user@example.com&cartId=123',
  iOS: {
    bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true,
  dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
    .generateEmailVerificationLink('user@example.com', actionCodeSettings)
    .then(function(link) {
      // The link was successfully generated.
    })
    .catch(function(error) {
      // Some error occurred, you can inspect the code: error.code
    });

BaseAuth.generatePasswordResetLink()

किसी उपयोगकर्ता का पासवर्ड रीसेट करने के लिए बैंड ईमेल कार्रवाई लिंक से आउट जनरेट करता है. यह लिंक, बताए गए ईमेल पते वाले उपयोगकर्ता के लिए जनरेट किया जाता है. वैकल्पिक ActionCodeSettings ऑब्जेक्ट से तय होता है कि लिंक को मोबाइल ऐप्लिकेशन या ब्राउज़र से मैनेज किया जाए या नहीं. डीप लिंक में पास की जाने वाली स्थिति की अतिरिक्त जानकारी वगैरह.

हस्ताक्षर:

generatePasswordResetLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
ईमेल	स्ट्रिंग	उस उपयोगकर्ता का ईमेल पता जिसका पासवर्ड रीसेट करना है.
ActionCodeSettings	ActionCodeSettings	कार्रवाई कोड की सेटिंग. अगर बताया गया है, तो पासवर्ड रीसेट लिंक में राज्य/जारी रखें यूआरएल को "ContinueUrl" पैरामीटर के तौर पर सेट किया जाता है. डिफ़ॉल्ट पासवर्ड फिर से सेट करने वाला लैंडिंग पेज इसका इस्तेमाल एक लिंक दिखाने के लिए करेगा, ताकि ऐप्लिकेशन इंस्टॉल होने पर उस पर वापस जा सके. अगर ActionCodeSettings की जानकारी नहीं है, तो कार्रवाई यूआरएल में कोई यूआरएल नहीं जोड़ा जाता है. दिया गया राज्य यूआरएल उस डोमेन से जुड़ा होना चाहिए जिसे डेवलपर ने कंसोल में अनुमति दी है. ऐसा न करने पर, कोई गड़बड़ी होती है. मोबाइल ऐप्लिकेशन रीडायरेक्ट सिर्फ़ तब लागू होते हैं, जब डेवलपर Firebase डाइनैमिक लिंक की सेवा की शर्तों को कॉन्फ़िगर करके उन्हें स्वीकार करता है. Android पैकेज के नाम और iOS बंडल आईडी का इस्तेमाल सिर्फ़ तब किया जाता है, जब उन्हें एक ही Firebase से पुष्टि वाले प्रोजेक्ट में कॉन्फ़िगर किया गया हो.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<string>

ऐसा प्रॉमिस जो जनरेट किए गए लिंक से पूरा होता है.

उदाहरण

var actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
    bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true,
  dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
    .generatePasswordResetLink('user@example.com', actionCodeSettings)
    .then(function(link) {
      // The link was successfully generated.
    })
    .catch(function(error) {
      // Some error occurred, you can inspect the code: error.code
    });

BaseAuth.generateSignInWithEmailLink()

हस्ताक्षर:

generateSignInWithEmailLink(email: string, actionCodeSettings: ActionCodeSettings): Promise<string>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
ईमेल	स्ट्रिंग	पुष्टि करने के लिए ईमेल खाता.
ActionCodeSettings	ActionCodeSettings	कार्रवाई कोड की सेटिंग. अगर बताया गया है, तो ईमेल की पुष्टि करने के लिंक में राज्य/जारी रखने वाले यूआरएल को "ContinueUrl" पैरामीटर के तौर पर सेट किया जाता है. ईमेल पते की पुष्टि करने वाला डिफ़ॉल्ट लैंडिंग पेज, इसका इस्तेमाल एक लिंक दिखाने के लिए करेगा, ताकि ऐप्लिकेशन के इंस्टॉल होने पर उस पर वापस जाया जा सके. अगर ActionCodeSettings की जानकारी नहीं है, तो कार्रवाई यूआरएल में कोई यूआरएल नहीं जोड़ा जाता है. दिया गया राज्य यूआरएल उस डोमेन से जुड़ा होना चाहिए जिसे डेवलपर ने कंसोल में अनुमति दी है. ऐसा न करने पर, कोई गड़बड़ी होती है. मोबाइल ऐप्लिकेशन रीडायरेक्ट सिर्फ़ तब लागू होते हैं, जब डेवलपर Firebase डाइनैमिक लिंक की सेवा की शर्तों को कॉन्फ़िगर करके उन्हें स्वीकार करता है. Android पैकेज के नाम और iOS बंडल आईडी का इस्तेमाल सिर्फ़ तब किया जाता है, जब उन्हें एक ही Firebase से पुष्टि वाले प्रोजेक्ट में कॉन्फ़िगर किया गया हो.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<string>

ऐसा प्रॉमिस जो जनरेट किए गए लिंक से पूरा होता है.

उदाहरण

var actionCodeSettings = {
  url: 'https://www.example.com/cart?email=user@example.com&cartId=123',
  iOS: {
    bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true,
  dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
    .generateEmailVerificationLink('user@example.com', actionCodeSettings)
    .then(function(link) {
      // The link was successfully generated.
    })
    .catch(function(error) {
      // Some error occurred, you can inspect the code: error.code
    });

BaseAuth.GenerateVerifyAndChangeEmailLink()

यह आउट-ऑफ़-बैंड ईमेल ऐक्शन लिंक जनरेट करता है, ताकि दिए गए ईमेल पर उपयोगकर्ता के मालिकाना हक की पुष्टि की जा सके. इस तरीके के तर्क के तौर पर दिए गए ActionCodeSettings ऑब्जेक्ट से तय होता है कि लिंक को मोबाइल ऐप्लिकेशन या ब्राउज़र से मैनेज किया जाएगा या नहीं. साथ ही, डीप लिंक में पास की जाने वाली स्थिति की अतिरिक्त जानकारी भी दी जाएगी.

हस्ताक्षर:

generateVerifyAndChangeEmailLink(email: string, newEmail: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
ईमेल	स्ट्रिंग	मौजूदा ईमेल खाता.
नया ईमेल	स्ट्रिंग	वह ईमेल पता जिस पर खाता अपडेट किया जा रहा है.
ActionCodeSettings	ActionCodeSettings	कार्रवाई कोड की सेटिंग. अगर बताया गया है, तो ईमेल की पुष्टि करने के लिंक में राज्य/जारी रखने वाले यूआरएल को "ContinueUrl" पैरामीटर के तौर पर सेट किया जाता है. ईमेल पते की पुष्टि करने वाला डिफ़ॉल्ट लैंडिंग पेज, इसका इस्तेमाल एक लिंक दिखाने के लिए करेगा, ताकि ऐप्लिकेशन के इंस्टॉल होने पर उस पर वापस जाया जा सके. अगर ActionCodeSettings की जानकारी नहीं है, तो कार्रवाई यूआरएल में कोई यूआरएल नहीं जोड़ा जाता है. दिया गया राज्य यूआरएल किसी ऐसे डोमेन से जुड़ा होना चाहिए जिसे कंसोल में अनुमति दी गई हो, नहीं तो एक गड़बड़ी दिखेगी. मोबाइल ऐप्लिकेशन रीडायरेक्ट सिर्फ़ तब लागू होते हैं, जब डेवलपर Firebase डाइनैमिक लिंक की सेवा की शर्तों को कॉन्फ़िगर करके उन्हें स्वीकार करता है. Android पैकेज के नाम और iOS बंडल आईडी का इस्तेमाल सिर्फ़ तब किया जाता है, जब उन्हें एक ही Firebase से पुष्टि वाले प्रोजेक्ट में कॉन्फ़िगर किया गया हो.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<string>

ऐसा प्रॉमिस जो जनरेट किए गए लिंक से पूरा होता है.

BaseAuth.getProviderConfig()

दिए गए आईडी से, पुष्टि करने वाली सेवा का कॉन्फ़िगरेशन ढूंढता है. यह प्रॉमिस देता है जो बताए गए प्रोवाइडर आईडी के हिसाब से प्रोवाइडर के कॉन्फ़िगरेशन के साथ रिज़ॉल्व होता है. अगर बताया गया आईडी मौजूद नहीं है, तो auth/configuration-not-found गड़बड़ी होती है.

हस्ताक्षर:

getProviderConfig(providerId: string): Promise<AuthProviderConfig>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
कंपनी आईडी	स्ट्रिंग	लौटाने के लिए, सेवा देने वाली कंपनी के कॉन्फ़िगरेशन से जुड़ा प्रोवाइडर आईडी.

लौटाए जाने वाले प्रॉडक्ट:

Promise<AuthProviderConfig>

ऐसा प्रॉमिस जो दिए गए आईडी के कॉन्फ़िगरेशन से रिज़ॉल्व होता है.

BaseAuth.getUser()

दिए गए uid से जुड़े उपयोगकर्ता के लिए उपयोगकर्ता डेटा देता है.

कोड सैंपल और ज़्यादा जानकारी वाले दस्तावेज़ के लिए, उपयोगकर्ता का डेटा वापस पाना देखें.

हस्ताक्षर:

getUser(uid: string): Promise<UserRecord>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
यूआईडी	स्ट्रिंग	उस उपयोगकर्ता से जुड़ा `uid` जिसका डेटा फ़ेच करना है.

लौटाए जाने वाले प्रॉडक्ट:

वादा करें<UserRecord>

दिए गए uid के हिसाब से उपयोगकर्ता के डेटा के साथ पूरा किया गया प्रॉमिस.

BaseAuth.getUserByEmail()

इसमें, दिए गए ईमेल से जुड़े उपयोगकर्ता का डेटा मिलता है.

हस्ताक्षर:

getUserByEmail(email: string): Promise<UserRecord>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
ईमेल	स्ट्रिंग	उस उपयोगकर्ता से जुड़ा ईमेल जिसका डेटा फ़ेच करना है.

लौटाए जाने वाले प्रॉडक्ट:

वादा करें<UserRecord>

दिए गए ईमेल में उपयोगकर्ता के डेटा के साथ पूरा किया गया प्रॉमिस.

BaseAuth.getUserByPhoneNumber()

इसमें, दिए गए फ़ोन नंबर से जुड़े उपयोगकर्ता का डेटा मिलता है. फ़ोन नंबर, E.164 के निर्देशों के मुताबिक होना चाहिए.

हस्ताक्षर:

getUserByPhoneNumber(phoneNumber: string): Promise<UserRecord>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
फ़ोन नंबर	स्ट्रिंग	उस उपयोगकर्ता से जुड़ा फ़ोन नंबर जिसका डेटा फ़ेच करना है.

लौटाए जाने वाले प्रॉडक्ट:

वादा करें<UserRecord>

दिए गए फ़ोन नंबर के हिसाब से, उपयोगकर्ता के डेटा के साथ पूरा किया गया प्रॉमिस.

BaseAuth.getUserByProviderUid()

सेवा देने वाली किसी खास कंपनी के आईडी से जुड़े उपयोगकर्ता के डेटा को ऐक्सेस करता है.

हस्ताक्षर:

getUserByProviderUid(providerId: string, uid: string): Promise<UserRecord>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
कंपनी आईडी	स्ट्रिंग	सेवा देने वाली कंपनी का आईडी, जैसे कि Google की सेवा देने वाली कंपनी के लिए "google.com".
यूआईडी	स्ट्रिंग	किसी कंपनी के लिए उपयोगकर्ता आइडेंटिफ़ायर.

लौटाए जाने वाले प्रॉडक्ट:

वादा करें<UserRecord>

सेवा देने वाले के आईडी के हिसाब से, उपयोगकर्ता के डेटा के साथ पूरा किया गया प्रॉमिस.

BaseAuth.getUsers()

तय किए गए आइडेंटिफ़ायर से जुड़े उपयोगकर्ता का डेटा लेता है.

ऑर्डर करने की कोई गारंटी नहीं है. खास तौर पर, इस बात की कोई गारंटी नहीं है कि नतीजों की सूची में nवीं एंट्री, इनपुट पैरामीटर की सूची में मौजूद nवीं एंट्री से मेल खाएगी.

ज़्यादा से ज़्यादा 100 आइडेंटिफ़ायर ही दिए जा सकते हैं. अगर 100 से ज़्यादा आइडेंटिफ़ायर दिए गए हैं, तो यह तरीका FirebaseAuthError दिखाता है.

हस्ताक्षर:

getUsers(identifiers: UserIdentifier[]): Promise<GetUsersResult>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
आइडेंटिफ़ायर	UserIdentifier[]	आइडेंटिफ़ायर, जिनसे यह पता चलता है कि उपयोगकर्ता के कौनसे रिकॉर्ड दिखाए जाने चाहिए. 100 से ज़्यादा एंट्री नहीं होनी चाहिए.

लौटाए जाने वाले प्रॉडक्ट:

Promise<GetUsersresults>

एक प्रॉमिस जो उपयोगकर्ता के रिकॉर्ड से जुड़ा हो.

अपवाद

FirebaseAuthError अगर कोई आइडेंटिफ़ायर अमान्य है या 100 से ज़्यादा आइडेंटिफ़ायर दिए गए हैं.

BaseAuth.ImportUsers()

यह नीति, उपयोगकर्ताओं की दी गई सूची को Firebase पुष्टि में इंपोर्ट करती है. एक बार में एक उपयोगकर्ता को ज़्यादा से ज़्यादा 1,000 उपयोगकर्ताओं को इंपोर्ट किया जा सकता है. पासवर्ड वाले उपयोगकर्ताओं को इंपोर्ट करते समय, UserImportOptions के बारे में बताना ज़रूरी है. यह कार्रवाई, बल्क इंपोर्ट के लिए ऑप्टिमाइज़ की गई है. साथ ही, यह uid, email, और आइडेंटिफ़ायर की दूसरी खासियत की जांच को अनदेखा कर देगी. इससे डुप्लीकेट डेटा बन सकता है.

हस्ताक्षर:

importUsers(users: UserImportRecord[], options?: UserImportOptions): Promise<UserImportResult>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
users	UserImportRecord[]	Firebase Auth में इंपोर्ट करने के लिए उपयोगकर्ता के रिकॉर्ड की सूची.
विकल्प	UserImportOptions	उपयोगकर्ता को इंपोर्ट करने के विकल्प तब ज़रूरी होते हैं, जब उपयोगकर्ता ने पासवर्ड के क्रेडेंशियल शामिल किए हों.

लौटाए जाने वाले प्रॉडक्ट:

वादा करें<UserImportresults>

यह प्रॉमिस, इंपोर्ट के नतीजे के साथ कार्रवाई पूरी होने पर रिज़ॉल्व हो जाता है. इसमें, पूरे हो चुके इंपोर्ट की संख्या, पूरे न हो पाने वाले इंपोर्ट की संख्या, और उनसे जुड़ी गड़बड़ियां शामिल होती हैं.

BaseAuth.listProviderConfigs()

दिए गए फ़िल्टर से मेल खाने वाले, प्रोवाइडर के मौजूदा कॉन्फ़िगरेशन की सूची दिखाता है. एक बार में, सेवा देने वाली कंपनियों के ज़्यादा से ज़्यादा 100 कॉन्फ़िगरेशन शामिल किए जा सकते हैं.

हस्ताक्षर:

listProviderConfigs(options: AuthProviderConfigFilter): Promise<ListProviderConfigResults>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
विकल्प	AuthProviderConfigFilter	लागू करने के लिए, सेवा देने वाली कंपनी का कॉन्फ़िगरेशन फ़िल्टर.

लौटाए जाने वाले प्रॉडक्ट:

Promise<ListProviderConfigresults>

यह ऐसा प्रॉमिस जो फ़िल्टर की ज़रूरी शर्तों को पूरा करने वाले, प्रोवाइडर के कॉन्फ़िगरेशन की सूची के साथ पूरा होता है.

BaseAuth.listUsers()

pageToken में बताए गए ऑफ़सेट से शुरू होने वाले maxResults साइज़ वाले उपयोगकर्ताओं की सूची (सिर्फ़ एक बैच) लाता है. इसका इस्तेमाल, किसी खास प्रोजेक्ट के सभी उपयोगकर्ताओं को बैच में पाने के लिए किया जाता है.

कोड के सैंपल और ज़्यादा जानकारी के लिए, सभी उपयोगकर्ताओं की सूची बनाएं देखें.

हस्ताक्षर:

listUsers(maxResults?: number, pageToken?: string): Promise<ListUsersResult>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
ज़्यादा से ज़्यादा नतीजे	नंबर	पेज का साइज़, अगर इसकी जानकारी नहीं है, तो 1000. यह मैक्सिमम लिमिट भी इस्तेमाल की जा सकती है.
पेजटोकन	स्ट्रिंग	अगले पेज का टोकन. अगर इसके लिए तय नहीं किया गया है, तो उपयोगकर्ताओं को बिना ऑफ़सेट के शुरू करने वाले नतीजे दिखाता है.

लौटाए जाने वाले प्रॉडक्ट:

Promise<ListUsersresults>

ऐसा प्रॉमिस जो डाउनलोड किए गए उपयोगकर्ताओं के मौजूदा बैच और अगले पेज के टोकन के साथ रिज़ॉल्व होता है.

BaseAuth.revokerefreshTokens() आधार

किसी मौजूदा उपयोगकर्ता के सभी रीफ़्रेश टोकन रद्द करता है.

यह एपीआई, उपयोगकर्ता के UserRecord.tokensValidAfterTime को मौजूदा यूटीसी में अपडेट कर देगा. यह ज़रूरी है कि जिस सर्वर पर इसे कॉल किया जाता है उसकी घड़ी सही तरीके से सेट हो और सिंक की गई हो.

ऐसा करने पर, किसी खास उपयोगकर्ता के सभी सेशन को रद्द कर दिया जाएगा. साथ ही, मौजूदा सेशन के लिए कोई भी नया आईडी टोकन, नए सिरे से बंद हो जाएगा. हालांकि, मौजूदा आईडी टोकन, समयसीमा खत्म होने (एक घंटे) तक चालू रह सकते हैं. यह पुष्टि करने के लिए कि आईडी टोकन रद्द कर दिए गए हैं, BaseAuth.verifyIdToken() का इस्तेमाल करें, जहां checkRevoked को 'सही है' पर सेट किया गया है.

हस्ताक्षर:

revokeRefreshTokens(uid: string): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
यूआईडी	स्ट्रिंग	उस उपयोगकर्ता से जुड़ा `uid` जिसके रीफ़्रेश टोकन को निरस्त करना है.

लौटाए जाने वाले प्रॉडक्ट:

वादा<void>

उपयोगकर्ता के रीफ़्रेश टोकन रद्द करने के बाद, एक खाली प्रॉमिस पूरा किया गया.

BaseAuth.setCustomUserClaims()

यह नीति, दिए गए uid से पहचाने गए मौजूदा उपयोगकर्ता पर, डेवलपर के लिए अन्य दावे सेट करती है. आम तौर पर, इसका इस्तेमाल उपयोगकर्ता की भूमिकाएं और ऐक्सेस के लेवल तय करने के लिए किया जाता है. ये दावे उन सभी डिवाइसों पर लागू होने चाहिए जिनमें उपयोगकर्ता ने पहले से साइन इन किया हुआ है. यह तब लागू होता है, जब टोकन की समयसीमा खत्म होने या टोकन रीफ़्रेश करने की सुविधा लागू होने के बाद, उपयोगकर्ता अगली बार साइन इन करता है. अगर OIDC के रिज़र्व किए गए किसी दावे का नाम (sub, iat, iss वगैरह) इस्तेमाल किया जाता है, तो गड़बड़ी का मैसेज दिखता है. इन्हें, पुष्टि किए गए उपयोगकर्ता के आईडी टोकन JWT पर सेट किया जाता है.

कोड सैंपल और ज़्यादा जानकारी के लिए, उपयोगकर्ता की भूमिकाएं और ऐक्सेस लेवल तय करना देखें.

हस्ताक्षर:

setCustomUserClaims(uid: string, customUserClaims: object | null): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
यूआईडी	स्ट्रिंग	बदलाव करने के लिए उपयोगकर्ता का `uid`.
कस्टम उपयोगकर्ता दावे	ऑब्जेक्ट \| शून्य	डेवलपर सेट करने का दावा करता है. शून्य पास होने पर, मौजूदा कस्टम दावे मिटा दिए जाते हैं. 1000 बाइट से बड़े कस्टम क्लेम पेलोड पास करने पर गड़बड़ी होगी. कस्टम दावे उपयोगकर्ता के आईडी टोकन में जोड़े जाते हैं. यह टोकन, पुष्टि किए गए हर अनुरोध पर भेजा जाता है. प्रोफ़ाइल का ऐक्सेस न होने से जुड़े उपयोगकर्ता एट्रिब्यूट के लिए, डेटाबेस या दूसरे अलग स्टोरेज सिस्टम का इस्तेमाल करें.

लौटाए जाने वाले प्रॉडक्ट:

वादा<void>

यह प्रॉमिस, कार्रवाई पूरी होने पर रिज़ॉल्व हो जाता है.

BaseAuth.updateProviderConfig()

सेवा देने वाले के तय किए गए आईडी के हिसाब से अपडेट किए गए AuthProviderConfig के साथ रिज़ॉल्व करने वाला प्रॉमिस देता है. अगर बताया गया आईडी मौजूद नहीं है, तो auth/configuration-not-found गड़बड़ी होती है.

हस्ताक्षर:

updateProviderConfig(providerId: string, updatedConfig: UpdateAuthProviderRequest): Promise<AuthProviderConfig>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
कंपनी आईडी	स्ट्रिंग	सेवा देने वाली कंपनी के कॉन्फ़िगरेशन से जुड़ा प्रोवाइडर आईडी, जिसे अपडेट करना है.
अपडेट किया गया कॉन्फ़िगरेशन	UpdateAuthProviderRequest	अपडेट किया गया कॉन्फ़िगरेशन.

लौटाए जाने वाले प्रॉडक्ट:

Promise<AuthProviderConfig>

ऐसा प्रॉमिस जो प्रोवाइडर के अपडेट किए गए कॉन्फ़िगरेशन के साथ रिज़ॉल्व हो जाता है.

BaseAuth.updateUser()

किसी मौजूदा उपयोगकर्ता को अपडेट करता है.

कोड सैंपल और ज़्यादा जानकारी वाले दस्तावेज़ के लिए, उपयोगकर्ता को अपडेट करें देखें.

हस्ताक्षर:

updateUser(uid: string, properties: UpdateRequest): Promise<UserRecord>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
यूआईडी	स्ट्रिंग	उपयोगकर्ता से जुड़ा `uid`, जिसे अपडेट करना है.
प्रॉपर्टी	UpdateRequest	दिए गए उपयोगकर्ता के लिए अपडेट की जाने वाली प्रॉपर्टी.

लौटाए जाने वाले प्रॉडक्ट:

वादा करें<UserRecord>

उपयोगकर्ता के अपडेट किए गए डेटा के साथ पूरा किया गया प्रॉमिस.

BaseAuth.verifyIdToken()

Firebase आईडी टोकन (JWT) की पुष्टि करता है. अगर टोकन मान्य है, तो प्रॉमिस, टोकन के डिकोड किए गए दावों के साथ पूरा किया जाता है. ऐसा न होने पर, प्रॉमिस अस्वीकार कर दिया जाता है.

अगर checkRevoked को 'सही है' पर सेट किया जाता है, तो सबसे पहले यह पुष्टि करता है कि इससे जुड़े उपयोगकर्ता को बंद किया गया है या नहीं. अगर हां, तो auth/user-disabled गड़बड़ी होती है. अगर नहीं, तो यह पुष्टि करता है कि आईडी टोकन से जुड़े सेशन को रद्द किया गया था या नहीं. अगर इससे जुड़े उपयोगकर्ता का सेशन अमान्य हो जाता है, तो auth/id-token-revoked गड़बड़ी होती है. अगर इसके बारे में नहीं बताया गया है, तो जांच लागू नहीं होती.

कोड के सैंपल और ज़्यादा जानकारी के लिए, आईडी टोकन की पुष्टि करें लेख पढ़ें.

हस्ताक्षर:

verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
idToken	स्ट्रिंग	पुष्टि करने के लिए आईडी टोकन.
सही का निशान हटाया गया	बूलियन	यह देखना है कि आईडी टोकन रद्द किया गया है या नहीं. इसके लिए, Firebase पुष्टि बैकएंड को एक और अनुरोध करने की ज़रूरत होती है, ताकि यह देखा जा सके कि संबंधित उपयोगकर्ता के लिए `tokensValidAfterTime` बार जांच की जा रही है. अगर इसके लिए कोई निर्देश नहीं दिया गया है, तो यह अतिरिक्त जांच लागू नहीं होती.

लौटाए जाने वाले प्रॉडक्ट:

वादा करें<DecodeIdToken>

आईडी टोकन मान्य होने पर टोकन के डिकोड किए गए दावों के साथ पूरा किया गया प्रॉमिस; नहीं तो, अस्वीकार किया गया प्रॉमिस.

BaseAuth.verifySessionCookie()

Firebase सेशन कुकी की पुष्टि करता है. कुकी के दावों के साथ प्रॉमिस दिखाता है. अगर कुकी की पुष्टि नहीं हो सकी है, तो प्रॉमिस को अस्वीकार कर देता है.

अगर checkRevoked को 'सही है' पर सेट किया जाता है, तो सबसे पहले यह पुष्टि करता है कि इससे जुड़े उपयोगकर्ता को बंद किया गया है या नहीं: अगर हां, तो auth/user-disabled गड़बड़ी दिखती है. अगर नहीं, तो यह पुष्टि करता है कि सेशन कुकी से जुड़े सेशन को रद्द किया गया था या नहीं. अगर इससे जुड़े उपयोगकर्ता का सेशन अमान्य हो जाता है, तो auth/session-cookie-revoked गड़बड़ी होती है. अगर इसके बारे में नहीं बताया गया है, तो जांच नहीं की जाती.

कोड सैंपल और ज़्यादा जानकारी वाले दस्तावेज़ों के लिए, सेशन कुकी की पुष्टि करें देखें

हस्ताक्षर:

verifySessionCookie(sessionCookie: string, checkRevoked?: boolean): Promise<DecodedIdToken>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
सेशनकुकी	स्ट्रिंग	पुष्टि करने के लिए सेशन कुकी.
सही का निशान हटाया गया	बूलियन

लौटाए जाने वाले प्रॉडक्ट:

वादा करें<DecodeIdToken>

सेशन कुकी के मान्य होने पर, सेशन कुकी के डिकोड किए गए दावों के साथ पूरा किया गया प्रॉमिस; नहीं तो, अस्वीकार किया गया प्रॉमिस.