TenantAwareAuth class

टेनेंट-अवेयर Auth इंटरफ़ेस का इस्तेमाल, उपयोगकर्ताओं को मैनेज करने, एसएएमएल/OIDC सेवा देने वाली कंपनियों को कॉन्फ़िगर करने, पासवर्ड रीसेट करने के लिए ईमेल लिंक जनरेट करने, ईमेल की पुष्टि करने वगैरह के लिए किया जाता है.

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

हर किरायेदार (टेनेंट) में आइडेंटिटी प्रोवाइडर, सेटिंग, और उपयोगकर्ताओं के सेट होते हैं. TenantAwareAuth का इस्तेमाल करके, किसी खास किरायेदार और उससे जुड़े OIDC/SAML कॉन्फ़िगरेशन के उपयोगकर्ता भी मैनेज किए जा सकते हैं. साथ ही, किरायेदार (टेनेंट) से साइन इन किए हुए उपयोगकर्ताओं के आईडी टोकन की पुष्टि की जा सकती है और किरायेदार से जुड़े उपयोगकर्ताओं के लिए, ईमेल कार्रवाई के लिंक भी जनरेट किए जा सकते हैं.

TenantManager.authForTenant() को कॉल करके, किसी खास tenantId के लिए TenantAwareAuth इंस्टेंस को इंस्टैंशिएट किया जा सकता है.

हस्ताक्षर:

export declare class TenantAwareAuth extends BaseAuth 

एक्सटेंडेड: BaseAuth

प्रॉपर्टी

प्रॉपर्टी	मॉडिफ़ायर	टाइप	ब्यौरा
tenantId		स्ट्रिंग	इस TenantAwareAuth इंस्टेंस से जुड़ा किरायेदार (टेनेंट) का आइडेंटिफ़ायर. यूज़र मैनेजमेंट एपीआई, OIDC/एसएएमएल प्रोवाइडर मैनेजमेंट एपीआई, ईमेल लिंक जनरेट करने वाले एपीआई वगैरह को किए जाने वाले सभी कॉल, सिर्फ़ इस टेनेंट के दायरे में लागू होंगे.

तरीके

तरीका	मॉडिफ़ायर	ब्यौरा
createsessionCookie(idToken, sessionCookieOptions)		तय किए गए विकल्पों के साथ एक नई Firebase सेशन कुकी बनाता है. बनाई गई JWT स्ट्रिंग, कस्टम कुकी नीति के साथ सर्वर-साइड सेशन कुकी के तौर पर सेट की जा सकती है. साथ ही, इसका इस्तेमाल सेशन मैनेजमेंट के लिए किया जा सकता है. सेशन कुकी JWT में, दिए गए आईडी टोकन के पेलोड दावे ही होंगे.कोड सैंपल और ज़्यादा जानकारी वाले दस्तावेज़ के लिए, सेशन कुकी मैनेज करें देखें.
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 गड़बड़ी होती है. अगर बताया नहीं गया है, तो जांच नहीं की जा सकती.कोड के नमूने और ज़्यादा जानकारी वाले दस्तावेज़ देखने के लिए, सेशन कुकी की पुष्टि करें देखें

TenantAwareAuth.tenantId

इस TenantAwareAuth इंस्टेंस से जुड़ा किरायेदार (टेनेंट) का आइडेंटिफ़ायर. यूज़र मैनेजमेंट एपीआई, OIDC/एसएएमएल प्रोवाइडर मैनेजमेंट एपीआई, ईमेल लिंक जनरेट करने वाले एपीआई वगैरह को किए जाने वाले सभी कॉल, सिर्फ़ इस टेनेंट के दायरे में लागू होंगे.

हस्ताक्षर:

readonly tenantId: string;

TenantAwareAuth.createsessionCookie()

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<string>

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

TenantAwareAuth.verifyIdToken()

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

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<DecodeIdToken>

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

TenantAwareAuth.verifysessionCookie()

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

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<DecodeIdToken>

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