firebase-admin.auth package

Firebase से पुष्टि करें.

फ़ंक्शन

फ़ंक्शन	ब्यौरा
getAuth(ऐप्लिकेशन)	डिफ़ॉल्ट ऐप्लिकेशन या किसी ऐप्लिकेशन के लिए, पुष्टि करने की सुविधा उपलब्ध कराता है. साथ ही, डिफ़ॉल्ट ऐप्लिकेशन की पुष्टि करने की सेवा को ऐक्सेस करने के लिए, getAuth() को बिना किसी तर्क के कॉल किया जा सकता है. इसके अलावा, किसी खास ऐप्लिकेशन से जुड़ी पुष्टि करने की सेवा को ऐक्सेस करने के लिए, getAuth(app) के तौर पर कॉल किया जा सकता है.

क्लास

क्लास	ब्यौरा
आधिकारिक	दिए गए ऐप्लिकेशन से जुड़ी पुष्टि करने वाली सेवा. पुष्टि के एक इंस्टेंस में एक से ज़्यादा किरायेदार हो सकते हैं.
AuthClientErrorCode	पुष्टि करने वाले क्लाइंट के गड़बड़ी के कोड और उनके डिफ़ॉल्ट मैसेज.
BaseAuth	Auth और TenantAwareAuth एपीआई, दोनों के लिए सामान्य पैरंट इंटरफ़ेस.
FirebaseAuthError	Firebase ऑथ गड़बड़ी कोड स्ट्रक्चर. इससे PrefixedFirebaseError को भी बढ़ा दिया जाता है.
कई तरीकों से जानकारी	उपयोगकर्ता के रजिस्टर किए गए दूसरे फ़ैक्टर की कॉमन प्रॉपर्टी दिखाने वाला इंटरफ़ेस.
मल्टीफ़ैक्टर सेटिंग	मल्टी-फ़ैक्टर से जुड़ी उपयोगकर्ता सेटिंग.
फ़ोन मल्टीफ़ैक्टर की जानकारी	फ़ोन के हिसाब से, उपयोगकर्ता के रजिस्टर किए गए दूसरे चरण की जानकारी देने वाला इंटरफ़ेस.
प्रोजेक्ट कॉन्फ़िगरेशन	यह प्रोजेक्ट कॉन्फ़िगरेशन को दिखाता है.
ProjectConfigManager	मौजूदा प्रोजेक्ट कॉन्फ़िगरेशन को मैनेज करता है और उसे अपडेट करता है.
किराये पर इस्तेमाल करने वाले (टेनेंट)	टेनेंट कॉन्फ़िगरेशन को दिखाता है.मल्टी-टेनेंसी की सुविधा के लिए, Google Cloud के Identity Platform (GCIP) की ज़रूरत होती है. कीमत और सुविधाओं के साथ-साथ GCIP के बारे में ज़्यादा जानने के लिए, GCIP दस्तावेज़ देखें.Google Cloud Identity Platform प्रोजेक्ट पर मल्टी-टेनंसी का इस्तेमाल करने से पहले, किरायेदारों को Cloud Console के यूज़र इंटरफ़ेस (यूआई) के ज़रिए उस प्रोजेक्ट के लिए अनुमति लेनी होगी.टेनेंट कॉन्फ़िगरेशन से डिसप्ले नेम, किरायेदार (टेनेंट) के आइडेंटिफ़ायर और ईमेल की पुष्टि करने वाले कॉन्फ़िगरेशन जैसी जानकारी मिलती है. OIDC/एसएएमएल की सेवा देने वाली कंपनी के कॉन्फ़िगरेशन मैनेजमेंट के लिए, टेनेंट पर कॉन्फ़िगर किए गए आईडीपी की सूची को फिर से पाने के लिए, Tenant के बजाय TenantAwareAuth इंस्टेंस का इस्तेमाल करना चाहिए. इन कंपनियों को कॉन्फ़िगर करते समय, ध्यान रखें कि किरायेदार, अनुमति वाली सूची में शामिल डोमेन और अपने पैरंट प्रोजेक्ट के पुष्टि किए गए रीडायरेक्ट यूआरआई को इनहेरिट करेंगे.टेनेंट की अन्य सभी सेटिंग भी इनहेरिट की जाएंगी. इन्हें Cloud Console के यूज़र इंटरफ़ेस (यूआई) से मैनेज करना होगा.
TenantAwareAuth	टेनेंट-अवेयर Auth इंटरफ़ेस का इस्तेमाल, उपयोगकर्ताओं को मैनेज करने, एसएएमएल/OIDC सेवा देने वाली कंपनियों को कॉन्फ़िगर करने, खास किरायेदारों के लिए पासवर्ड रीसेट करने, ईमेल की पुष्टि करने वगैरह के लिए किया जाता है.कई टेनेसी की सुविधा देने के लिए, Google Cloud के Identity Platform (GCIP) की ज़रूरत होती है. कीमत और सुविधाओं के साथ-साथ GCIP के बारे में ज़्यादा जानने के लिए GCIP दस्तावेज़ देखें.हर किरायेदार के पास आइडेंटिटी प्रोवाइडर, सेटिंग, और उपयोगकर्ताओं के सेट होते हैं. TenantAwareAuth का इस्तेमाल करके, किसी चुनिंदा टेनेंट और उससे जुड़े OIDC/SAML कॉन्फ़िगरेशन के उपयोगकर्ता भी मैनेज किए जा सकते हैं. साथ ही, किसी किरायेदार से साइन इन किए गए उपयोगकर्ताओं के आईडी टोकन की पुष्टि की जा सकती है. साथ ही, उस टेनेंट से जुड़े उपयोगकर्ताओं के लिए, कार्रवाई करने वाले ईमेल लिंक भी जनरेट किए जा सकते हैं. किसी खास tenantId के लिए TenantAwareAuth इंस्टेंस, TenantManager.authForTenant() को कॉल करके इंस्टैंशिएट किए जा सकते हैं.
टेनेंट मैनेजर	किरायेदारों से जुड़े काम मैनेज करने के लिए इस्तेमाल किए जाने वाले टेनेंट मैनेजर के बारे में बताता है. इसमें इस तरह का कॉन्टेंट शामिल है: मौजूदा प्रोजेक्ट के लिए किरायेदारों को बनाने, अपडेट करने, उनकी सूची बनाने, पाने, और उन्हें मिटाने की सुविधा. बताए गए किरायेदार के लिए, पुष्टि से जुड़ी कार्रवाइयां (यूज़र मैनेजमेंट, प्रोवाइडर कॉन्फ़िगरेशन मैनेजमेंट, टोकन की पुष्टि, ईमेल लिंक जनरेट करने वगैरह) के लिए TenantAwareAuth इंस्टेंस पाना.
उपयोगकर्ता की जानकारी	Google या Facebook जैसे तीसरे पक्ष के आइडेंटिटी प्रोवाइडर से मिली उपयोगकर्ता की जानकारी दिखाता है.
उपयोगकर्ता का मेटाडेटा	इससे उपयोगकर्ता का मेटाडेटा पता चलता है.
UserRecord	इससे उपयोगकर्ता का प्रतिनिधित्व किया जाता है.

इंटरफ़ेस

इंटरफ़ेस	ब्यौरा
ActionCodeSettings	यह ऐसा इंटरफ़ेस है जो ज़रूरी जारी/स्टेट यूआरएल के बारे में बताता है. इसमें Android और iOS बंडल के वैकल्पिक आइडेंटिफ़ायर शामिल होते हैं.
AllowByDefault	हर इलाके के लिए डिफ़ॉल्ट रूप से अनुमति देने की नीति के बारे में बताता है. साथ ही, जिन इलाकों के लिए अनुमति नहीं है उनकी सूची को अनुमति नहीं देने वाली सूची में जोड़ देता है.
AllowByDefaultWrap	AllowByDefault इंटरफ़ेस का म्यूचुअल एक्सक्लूज़िव एसएमएस रीजन कॉन्फ़िगरेशन
सिर्फ़ अनुमति वाली सूची	क्षेत्रों को अनुमति देने वाली नीति के बारे में बताता है. इसके लिए, उन्हें अनुमति वाली सूची में साफ़ तौर पर जोड़ना होता है.
AllowlistOnlyWrap	AllowlistOnly इंटरफ़ेस का म्यूचुअली एक्सक्लूसिव मैसेज (एसएमएस) क्षेत्र कॉन्फ़िगरेशन
AuthProviderConfigFilter	लिस्टिंग देने वाले के कॉन्फ़िगरेशन के लिए इस्तेमाल किया जाने वाला फ़िल्टर इंटरफ़ेस. इसका इस्तेमाल तब किया जाता है, जब BaseAuth.listProviderConfigs() के ज़रिए कॉन्फ़िगर किए गए आइडेंटिटी प्रोवाइडर की सूची कैसे बनाई जाए.
BaseAuthProviderConfig	पुष्टि करने वाली सेवा का बेस कॉन्फ़िगरेशन इंटरफ़ेस.
BaseCreateMultiFactorInfoRequest	CreateRequest के लिए, उपयोगकर्ता के रजिस्टर किए गए दूसरे फ़ैक्टर की बुनियादी प्रॉपर्टी दिखाने वाला इंटरफ़ेस.
BaseUpdateMultiFactorInfoRequest	UpdateRequest के लिए, उपयोगकर्ता के रजिस्टर किए गए दूसरे फ़ैक्टर की सामान्य प्रॉपर्टी को दिखाने वाला इंटरफ़ेस.
CreatePhoneMultiFactorInfoRequest	फ़ोन के हिसाब से, CreateRequest के लिए रजिस्टर किए गए दूसरे चरण की जानकारी देने वाला इंटरफ़ेस.
अनुरोध करें	नया उपयोगकर्ता रिकॉर्ड बनाने के लिए, प्रॉपर्टी दिखाने वाला इंटरफ़ेस.
CustomStrengthOptionsConfig	पासवर्ड नीति पर लागू की जाने वाली पाबंदियां
DeकोडAuthBlockToken
डीकोड किया गया आईडी टोकन	डिकोड किया गया Firebase आईडी टोकन दिखाने वाला इंटरफ़ेस, जो BaseAuth.verifyIdToken() तरीके से दिखाया गया है.Firebase आईडी टोकन, Open Connect की शर्तों का पालन करने वाले JSON वेब टोकन (JWTs) हैं. नीचे दी गई खास प्रॉपर्टी के बारे में ज़्यादा जानकारी के लिए, [Openid Connect स्पेसिफ़िकेशन का आईडी टोकन सेक्शन](http://openid.net/specs/openid-connect-core-1_0.html#IDToken) देखें.
Deleteउपयोगकर्ताओं के नतीजे	यह BaseAuth.deleteUsers() का नतीजा दिखाता है. एपीआई.
ईमेल आइडेंटिफ़ायर	इसका इस्तेमाल ईमेल से खाता खोजने के लिए किया जाता है.BaseAuth.getUsers() देखें.
ईमेल-निजता कॉन्फ़िगरेशन	किसी प्रोजेक्ट या किरायेदार के ईमेल की निजता का कॉन्फ़िगरेशन.
EmailSignInProviderConfig	ईमेल साइन इन की सेवा देने वाली कंपनी का कॉन्फ़िगरेशन.
Getउपयोगकर्ताओं के नतीजे	यह BaseAuth.getUsers() एपीआई का नतीजा दिखाता है.
ListProviderConfigresults	लिस्टिंग देने वाली कंपनी के कॉन्फ़िगरेशन के लिए रिस्पॉन्स इंटरफ़ेस. यह सुविधा सिर्फ़ तब उपलब्ध होती है, जब आइडेंटिटी प्रोवाइडर की कॉन्फ़िगरेशन BaseAuth.listProviderConfigs() से शेयर करें.
ListTenants रिज़ल्ट	TenantManager.listTenants() ऑपरेशन से दिखाए गए ऑब्जेक्ट को दिखाने वाला इंटरफ़ेस. इसमें मौजूदा बैच के लिए टेनेंट की सूची और अगले पेज का टोकन (अगर उपलब्ध हो) शामिल होता है.
ListUsersनतीजे	BaseAuth.listUsers() ऑपरेशन से मिले ऑब्जेक्ट को दिखाने वाला इंटरफ़ेस. इसमें मौजूदा बैच के उपयोगकर्ताओं की सूची और अगर उपलब्ध हो, तो अगले पेज का टोकन होता है.
मल्टीफ़ैक्टर कॉन्फ़िगरेशन	बहु-स्तरीय कॉन्फ़िगरेशन दिखाने वाला इंटरफ़ेस. इसका इस्तेमाल यह तय करने के लिए किया जा सकता है कि बहु-स्तरीय पुष्टि (MFA) की सुविधा चालू है या बंद. साथ ही, इसका इस्तेमाल दूसरे तरीकों से जुड़ी उन चुनौतियों की सूची के बारे में बताने के लिए भी किया जा सकता है जो इसके साथ काम करती हैं.
मल्टीफ़ैक्टर बनाने की सेटिंग	बनाने की कार्रवाइयां करने के लिए, कई तरीकों से इस्तेमाल होने वाली उपयोगकर्ता सेटिंग.
MultiFactorProviderConfig	बहु-स्तरीय पुष्टि देने वाले कॉन्फ़िगरेशन को दिखाने वाला इंटरफ़ेस. यह इंटरफ़ेस एसएमएस के अलावा, पुष्टि करने वाले दूसरे कारक के लिए इस्तेमाल किया जाता है. फ़िलहाल, सिर्फ़ TOTP ही काम करता है.
मल्टीफ़ैक्टर अपडेट सेटिंग	अपडेट की कार्रवाइयों के लिए, कई फ़ैक्टर से जुड़ी उपयोगकर्ता सेटिंग.
OAuthResponseType	OAuth की पुष्टि करने के फ़्लो के लिए, OIDC प्रोवाइडर के रिस्पॉन्स ऑब्जेक्ट को दिखाने वाला इंटरफ़ेस. इनमें से एक सेटिंग ज़रूरी है: कोड फ़्लो के लिए, code को true पर सेट करें. आईडी टोकन फ़्लो के लिए, idToken को true पर सेट करें.
OIDCAuthProviderConfig	[OIDC](https://openid.net/specs/openid-connect-core-1_0- Final.html) पुष्टि करने वाले का कॉन्फ़िगरेशन इंटरफ़ेस. BaseAuth.createProviderConfig() के ज़रिए एक OIDC प्रोवाइडर बनाया जा सकता है.
OIDCUpdateAuthProviderRequest	OIDC की पुष्टि करने वाली कंपनी को अपडेट करने के लिए अनुरोध का इंटरफ़ेस. इसका इस्तेमाल तब किया जाता है, जब BaseAuth.updateProviderConfig() के ज़रिए OIDC की सेवा देने वाली कंपनी के कॉन्फ़िगरेशन को अपडेट किया जाता है.
PasswordPolicyConfig	प्रोजेक्ट या किरायेदार के लिए पासवर्ड नीति कॉन्फ़िगरेशन
फ़ोन आइडेंटिफ़ायर	इसका इस्तेमाल, फ़ोन नंबर की मदद से खाता खोजने के लिए किया जाता है.BaseAuth.getUsers() देखें.
Provider आइडेंटिफ़ायर	इसका इस्तेमाल, फ़ेडरेटेड प्रोवाइडर के खाते को खोजने के लिए किया जाता है.BaseAuth.getUsers() देखें.
Re कैप्चाConfig	reCAPTCHA कॉन्फ़िगरेशन को अपडेट करने के लिए, अनुरोध का इंटरफ़ेस. reCAPTCHA Enterprise इंटिग्रेशन को चालू करने का मतलब है कि आप reCAPTCHA Enterprise की सेवा की शर्तों से सहमत हैं.
Re कैप्चाKey	reCAPTCHA कुंजी का कॉन्फ़िगरेशन.
Re कैप्चाManagedRule	reCAPTCHA की कार्रवाई के नियम का कॉन्फ़िगरेशन.
SAMLAuthProviderConfig	[एसएएमएल](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html) ऑथराइज़ेशन प्रोवाइडर का कॉन्फ़िगरेशन इंटरफ़ेस. BaseAuth.createProviderConfig() के ज़रिए एक एसएएमएल कंपनी बनाई जा सकती है.
SAMLUpdateAuthProviderRequest	एसएएमएल पुष्टि देने वाली कंपनी को अपडेट करने के लिए अनुरोध का इंटरफ़ेस. इसका इस्तेमाल BaseAuth.updateProviderConfig() के ज़रिए एसएएमएल कंपनी के कॉन्फ़िगरेशन को अपडेट करते समय किया जाता है.
सेशन कुकी विकल्प	BaseAuth.createsessionCookie() तरीके के लिए ज़रूरी सेशन कुकी विकल्पों को दिखाने वाला इंटरफ़ेस.
TotpMultiFactorProviderConfig	TOTP के दूसरे फ़ैक्टर की पुष्टि के लिए, कॉन्फ़िगरेशन सेटिंग दिखाने वाला इंटरफ़ेस.
UidIdentifier	इसका इस्तेमाल uid से कोई खाता खोजने के लिए किया जाता है.BaseAuth.getUsers() देखें.
UpdatePhoneMultiFactorInfoRequest	फ़ोन के हिसाब से, UpdateRequest के लिए रजिस्टर किए गए दूसरे चरण को दिखाने वाला इंटरफ़ेस.
UpdateProjectConfigRequest	दिए गए प्रोजेक्ट कॉन्फ़िगरेशन के हिसाब से अपडेट की जाने वाली प्रॉपर्टी दिखाने वाला इंटरफ़ेस.
UpdateRequest	दिए गए उपयोगकर्ता के लिए प्रॉपर्टी को अपडेट करने वाला इंटरफ़ेस.
UpdateTenantRequest	दिए गए किरायेदार के हिसाब से प्रॉपर्टी को अपडेट करने वाला इंटरफ़ेस.
UserImportOptions	BaseAuth.ImportUsers() तरीके के लिए ज़रूरी उपयोगकर्ता इंपोर्ट के विकल्पों को दिखाने वाला इंटरफ़ेस. इसका इस्तेमाल पासवर्ड हैशिंग एल्गोरिदम की जानकारी देने के लिए किया जाता है.
UserImportRecord	ऐसा इंटरफ़ेस जो BaseAuth.ImportUsers() तरीके से Firebase पुष्टि करने के लिए उपयोगकर्ता को इंपोर्ट करता है.
UserImportResource	Firebase ऑथराइज़ेशन में उपयोगकर्ताओं के बैच इंपोर्ट करने के लिए, BaseAuth.ImportUsers() तरीके से मिले रिस्पॉन्स को दिखाने वाला इंटरफ़ेस.
UserMetadataRequest	उपयोगकर्ता का डेटा इंपोर्ट करते समय शामिल किया जाने वाला उपयोगकर्ता मेटाडेटा.
UserProvider	यह ऐसे यूज़र आइडेंटिटी प्रोवाइडर को दिखाता है जिसे Firebase उपयोगकर्ता के साथ जोड़ा जा सकता है.
UserProviderRequest	उपयोगकर्ता को इंपोर्ट करते समय शामिल किया जाने वाला उपयोगकर्ता कंपनी का डेटा.

उपनामों का प्रकार

उपनाम टाइप करें	ब्यौरा
AuthFactorType	सेकंड फ़ैक्टर टाइप की पहचान करता है.
AuthProviderConfig	पुष्टि करने वाले का कॉन्फ़िगरेशन टाइप. BaseAuth.createProviderConfig().
CreateMultiFactorInfoRequest	CreateRequest के लिए, उपयोगकर्ता को रजिस्टर किए गए दूसरे फ़ैक्टर की प्रॉपर्टी दिखाने वाला टाइप.
CreateTenantRequest	नए किरायेदार (टेनेंट) के लिए प्रॉपर्टी दिखाने वाला इंटरफ़ेस.
हैशएल्गोरिदम टाइप
MultiFactorConfigState	बहु-स्तरीय कॉन्फ़िगरेशन की स्थिति की पहचान करता है.
पासवर्ड नीति के लागू होने की स्थिति	पासवर्ड की नीति को लागू किए जाने की स्थिति.
Re कैप्चाAction	reCAPTCHA से सुरक्षित किए गए अनुरोधों पर की जाने वाली कार्रवाइयां. - 'ब्लॉक करें': reCAPTCHA से सुरक्षित किया गया अनुरोध ब्लॉक कर दिया जाएगा.
Re कैप्चाKeyClientType	कुंजी का प्लैटफ़ॉर्म टाइप.
ReCapProviderEnforcementState	reCAPTCHA सुरक्षा को लागू करने की स्थिति. - 'बंद': लागू नहीं किया गया. - 'ऑडिट': आकलन तैयार करें, लेकिन नतीजे को लागू न करें. - 'ENFORCE': आकलन तैयार करें और नतीजे को लागू करें.
SmsRegionConfig	मैसेज (एसएमएस) क्षेत्र का कॉन्फ़िगरेशन अपडेट करने के लिए अनुरोध का इंटरफ़ेस. उन इलाकों को कॉन्फ़िगर करता है जहां उपयोगकर्ताओं को पुष्टि करने के लिए एसएमएस भेजने की अनुमति है. यह गंतव्य फ़ोन नंबर के कॉलिंग कोड पर आधारित होता है.
UpdateAuthProviderRequest
UpdateMultiFactorInfoRequest	UpdateRequest के लिए, उपयोगकर्ता को रजिस्टर किए गए दूसरे फ़ैक्टर की प्रॉपर्टी दिखाने का टाइप.
यूज़र आइडेंटिफ़ायर	खोजे जाने वाले उपयोगकर्ता की पहचान करता है.

getAuth(ऐप्लिकेशन)

डिफ़ॉल्ट ऐप्लिकेशन या दिए गए ऐप्लिकेशन के लिए, पुष्टि करने की सेवा उपलब्ध कराता है.

डिफ़ॉल्ट ऐप्लिकेशन की Auth सेवा को ऐक्सेस करने के लिए, getAuth() को बिना किसी तर्क के कॉल किया जा सकता है. इसके अलावा, किसी खास ऐप्लिकेशन से जुड़ी पुष्टि करने के लिए, getAuth(app) के तौर पर भी कॉल किया जा सकता है.

हस्ताक्षर:

export declare function getAuth(app?: App): Auth;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
ऐप्लिकेशन	ऐप्लिकेशन

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

आधिकारिक

उदाहरण 1

// Get the Auth service for the default app
const defaultAuth = getAuth();

उदाहरण 2

// Get the Auth service for a given app
const otherAuth = getAuth(otherApp);

ऑथफ़ैक्टर टाइप

सेकंड फ़ैक्टर टाइप की पहचान करता है.

हस्ताक्षर:

export type AuthFactorType = 'phone';

AuthProviderConfig

पुष्टि करने वाले का कॉन्फ़िगरेशन टाइप. BaseAuth.createProviderConfig().

हस्ताक्षर:

export type AuthProviderConfig = SAMLAuthProviderConfig | OIDCAuthProviderConfig;

मल्टीफ़ैक्टर की जानकारी के लिए अनुरोध

CreateRequest के लिए, उपयोगकर्ता को रजिस्टर किए गए दूसरे फ़ैक्टर की प्रॉपर्टी दिखाने वाला टाइप.

हस्ताक्षर:

export type CreateMultiFactorInfoRequest = CreatePhoneMultiFactorInfoRequest;

CreateTenantRequest

नए किरायेदार (टेनेंट) के लिए प्रॉपर्टी दिखाने वाला इंटरफ़ेस.

हस्ताक्षर:

export type CreateTenantRequest = UpdateTenantRequest;

हैश एल्गोरिदम टाइप

हस्ताक्षर:

export type HashAlgorithmType = 'SCRYPT' | 'STANDARD_SCRYPT' | 'HMAC_SHA512' | 'HMAC_SHA256' | 'HMAC_SHA1' | 'HMAC_MD5' | 'MD5' | 'PBKDF_SHA1' | 'BCRYPT' | 'PBKDF2_SHA256' | 'SHA512' | 'SHA256' | 'SHA1';

मल्टीफ़ैक्टर कॉन्फ़िगरेशनस्टेट

बहु-स्तरीय कॉन्फ़िगरेशन की स्थिति की पहचान करता है.

हस्ताक्षर:

export type MultiFactorConfigState = 'ENABLED' | 'DISABLED';

PasswordPolicyनीति लागू करने की स्थिति

पासवर्ड की नीति को लागू किए जाने की स्थिति.

हस्ताक्षर:

export type PasswordPolicyEnforcementState = 'ENFORCE' | 'OFF';

reCAPTCHAकार्रवाई

reCAPTCHA से सुरक्षित किए गए अनुरोधों पर की जाने वाली कार्रवाइयां. - 'ब्लॉक करें': reCAPTCHA से सुरक्षित किया गया अनुरोध ब्लॉक कर दिया जाएगा.

हस्ताक्षर:

export type RecaptchaAction = 'BLOCK';

reCAPTCHAKeyClientType

कुंजी का प्लैटफ़ॉर्म टाइप.

हस्ताक्षर:

export type RecaptchaKeyClientType = 'WEB' | 'IOS' | 'ANDROID';

reCAPTCHAProviderEnforcementState

reCAPTCHA सुरक्षा को लागू करने की स्थिति. - 'बंद': लागू नहीं किया गया. - 'ऑडिट': आकलन तैयार करें, लेकिन नतीजे को लागू न करें. - 'ENFORCE': आकलन तैयार करें और नतीजे को लागू करें.

हस्ताक्षर:

export type RecaptchaProviderEnforcementState = 'OFF' | 'AUDIT' | 'ENFORCE';

SmsRegionConfig

मैसेज (एसएमएस) के इलाके का कॉन्फ़िगरेशन अपडेट करने के लिए, अनुरोध का इंटरफ़ेस. उन इलाकों को कॉन्फ़िगर करता है जहां उपयोगकर्ताओं को पुष्टि करने के लिए एसएमएस भेजने की अनुमति है. यह गंतव्य फ़ोन नंबर के कॉलिंग कोड पर आधारित होता है.

हस्ताक्षर:

export type SmsRegionConfig = AllowByDefaultWrap | AllowlistOnlyWrap;

UpdateAuthProviderRequest

हस्ताक्षर:

export type UpdateAuthProviderRequest = SAMLUpdateAuthProviderRequest | OIDCUpdateAuthProviderRequest;

अपडेट मल्टीफ़ैक्टर जानकारी अनुरोध

UpdateRequest के लिए, उपयोगकर्ता को रजिस्टर किए गए दूसरे फ़ैक्टर की प्रॉपर्टी दिखाने वाला टाइप.

हस्ताक्षर:

export type UpdateMultiFactorInfoRequest = UpdatePhoneMultiFactorInfoRequest;

यूज़र आइडेंटिफ़ायर

खोजे जाने वाले उपयोगकर्ता की पहचान करता है.

हस्ताक्षर:

export type UserIdentifier = UidIdentifier | EmailIdentifier | PhoneIdentifier | ProviderIdentifier;