BaseAuth class

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

हस्ताक्षर:

export declare abstract class BaseAuth

तरीके

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

BaseAuth.createCustomToken()

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<string>

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

BaseAuth.createProviderConfig()

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

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

हस्ताक्षर:

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

पैरामीटर

पैरामीटर टाइप ब्यौरा
कॉन्फ़िगरेशन AuthProviderConfig बनाने के लिए प्रोवाइडर का कॉन्फ़िगरेशन.

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

वादा करें<AuthProviderConfig>

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

BaseAuth.createsessionCookie()

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<string>

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

BaseAuth.createUser()

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

वादा<UserRecord>

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

BaseAuth.deleteProviderConfig()

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<void>

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

BaseAuth.deleteUser()

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<void>

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

BaseAuth.deleteUsers()

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

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

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<DeleteUsersनतीजे>

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

बताए गए ईमेल के लिए उपयोगकर्ता के मालिकाना हक की पुष्टि करने के लिए, बैंड के बाहर वाले ईमेल कार्रवाई का लिंक जनरेट करता है. इस तरीके के तर्क के तौर पर दिया गया 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
    });

किसी उपयोगकर्ता का पासवर्ड रीसेट करने के लिए, बैंड ईमेल से बाहर के कार्रवाई लिंक को जनरेट करता है. यह लिंक, दिए गए ईमेल पते वाले उपयोगकर्ता के लिए जनरेट किया जाता है. वैकल्पिक 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
    });

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

हस्ताक्षर:

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
    });

बताए गए ईमेल के उपयोगकर्ता के मालिकाना हक की पुष्टि करने के लिए, आउट-ऑफ़-बैंड ईमेल कार्रवाई लिंक जनरेट करता है. इस तरीके के तर्क के तौर पर दिया गया 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 गड़बड़ी होती है.

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

हस्ताक्षर:

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

पैरामीटर

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

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

वादा करें<AuthProviderConfig>

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

BaseAuth.getUser()

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

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

हस्ताक्षर:

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

पैरामीटर

पैरामीटर टाइप ब्यौरा
uid स्ट्रिंग उस उपयोगकर्ता से जुड़ा 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>;

पैरामीटर

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

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

वादा<UserRecord>

प्रोवाइडर के आईडी से जुड़े उपयोगकर्ता डेटा के साथ पूरा किया गया प्रॉमिस.

BaseAuth.getUsers()

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

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस <GetUsersनतीजे>

ऐसा प्रॉमिस जिसे उपयोगकर्ता के हिसाब से बनाया जाता है.

अपवाद

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

BaseAuth.ImportUsers()

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<UserImportresults>

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

BaseAuth.listProviderConfigs()

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<ListProviderConfigProducts>

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

BaseAuth.listUsers()

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<ListUsersresults>

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

BaseAuth.RevokerefreshTokens()

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

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<void>

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

BaseAuth.setCustomUserClaims()

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<void>

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

BaseAuth.updateProviderConfig()

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

वादा करें<AuthProviderConfig>

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

BaseAuth.updateUser()

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

वादा<UserRecord>

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

BaseAuth.verifyIdToken()

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

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<DecodeIdToken>

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

BaseAuth.verifysessionCookie()

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

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<DecodeIdToken>

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