किरायेदार-जागरूक Auth इंटरफ़ेस का उपयोग उपयोगकर्ताओं को प्रबंधित करने, एसएएमएल/ओआईडीसी प्रदाताओं को कॉन्फ़िगर करने, विशिष्ट किरायेदारों के लिए पासवर्ड रीसेट, ईमेल सत्यापन आदि के लिए ईमेल लिंक तैयार करने के लिए किया जाता है।
बहु-किरायेदारी समर्थन के लिए Google क्लाउड के पहचान प्लेटफ़ॉर्म (GCIP) की आवश्यकता होती है। मूल्य निर्धारण और सुविधाओं सहित जीसीआईपी के बारे में अधिक जानने के लिए, जीसीआईपी दस्तावेज़ देखें .
प्रत्येक किरायेदार के पास अपने स्वयं के पहचान प्रदाता, सेटिंग्स और उपयोगकर्ताओं के सेट होते हैं। TenantAwareAuth का उपयोग करना , एक विशिष्ट किरायेदार और संबंधित ओआईडीसी/एसएएमएल कॉन्फ़िगरेशन के लिए उपयोगकर्ताओं को भी प्रबंधित किया जा सकता है, एक विशिष्ट किरायेदार में साइन इन किए गए उपयोगकर्ताओं के लिए आईडी टोकन सत्यापित किए जा सकते हैं, और किरायेदार से संबंधित उपयोगकर्ताओं के लिए ईमेल कार्रवाई लिंक भी उत्पन्न किए जा सकते हैं।
किसी विशिष्ट tenantId के लिए TenantAwareAuth उदाहरणों को TenantManager.authForTenant() पर कॉल करके तुरंत चालू किया जा सकता है। .
हस्ताक्षर:
export declare class TenantAwareAuth extends BaseAuth
विस्तार: बेसऑथ
गुण
| संपत्ति | संशोधक | प्रकार | विवरण |
|---|---|---|---|
| किरायेदारआईडी | डोरी | इस TenantAwareAuth उदाहरण के अनुरूप किरायेदार पहचानकर्ता। उपयोगकर्ता प्रबंधन एपीआई, ओआईडीसी/एसएएमएल प्रदाता प्रबंधन एपीआई, ईमेल लिंक जनरेशन एपीआई आदि के लिए सभी कॉल केवल इस किरायेदार के दायरे में लागू की जाएंगी। |
तरीकों
| तरीका | संशोधक | विवरण |
|---|---|---|
| createSessionCookie(idToken, sessionCookieOptions) | निर्दिष्ट विकल्पों के साथ एक नई फायरबेस सत्र कुकी बनाता है। बनाई गई JWT स्ट्रिंग को कस्टम कुकी नीति के साथ सर्वर-साइड सत्र कुकी के रूप में सेट किया जा सकता है, और सत्र प्रबंधन के लिए उपयोग किया जा सकता है। सत्र कुकी JWT में प्रदत्त आईडी टोकन के समान ही पेलोड दावे होंगे। कोड नमूनों और विस्तृत दस्तावेज़ीकरण के लिए सत्र कुकीज़ प्रबंधित करें देखें। | |
| VerifyIdToken(idToken, checkRevoked) | फ़ायरबेस आईडी टोकन (JWT) सत्यापित करता है। यदि टोकन वैध है, तो टोकन के डिकोड किए गए दावों के साथ वादा पूरा हो जाता है; अन्यथा, वादा खारिज कर दिया जाता है. यदि checkRevoked सत्य पर सेट किया गया है, तो पहले सत्यापित करें कि संबंधित उपयोगकर्ता अक्षम है या नहीं। यदि हां, तो एक auth/user-disabled त्रुटि उत्पन्न होती है। यदि नहीं, तो सत्यापित करें कि क्या आईडी टोकन से संबंधित सत्र रद्द कर दिया गया था। यदि संबंधित उपयोगकर्ता का सत्र अमान्य कर दिया गया था, तो एक auth/id-token-revoked त्रुटि उत्पन्न हो जाती है। यदि निर्दिष्ट नहीं है तो चेक लागू नहीं किया जाता है। कोड नमूनों और विस्तृत दस्तावेज़ीकरण के लिए आईडी टोकन सत्यापित करें देखें। | |
| VerifySessionCookie(sessionCookie, checkRevoked) | फ़ायरबेस सत्र कुकी को सत्यापित करता है। कुकी दावों के साथ एक वादा लौटाता है। यदि कुकी सत्यापित नहीं की जा सकी तो वादे को अस्वीकार कर देता है। यदि checkRevoked सत्य पर सेट किया गया है, तो पहले सत्यापित करें कि संबंधित उपयोगकर्ता अक्षम है या नहीं: यदि हाँ, तो एक auth/user-disabled त्रुटि उत्पन्न होती है। यदि नहीं, तो सत्यापित करें कि क्या सत्र कुकी से संबंधित सत्र निरस्त कर दिया गया था। यदि संबंधित उपयोगकर्ता का सत्र अमान्य कर दिया गया था, तो एक auth/session-cookie-revoked त्रुटि उत्पन्न हो जाती है। यदि निर्दिष्ट नहीं है तो जाँच नहीं की जाती है। कोड नमूनों और विस्तृत दस्तावेज़ीकरण के लिए सत्र कुकीज़ सत्यापित करें देखें |
TenantAwareAuth.tenantId
इस TenantAwareAuth उदाहरण के अनुरूप किरायेदार पहचानकर्ता। उपयोगकर्ता प्रबंधन एपीआई, ओआईडीसी/एसएएमएल प्रदाता प्रबंधन एपीआई, ईमेल लिंक जनरेशन एपीआई आदि के लिए सभी कॉल केवल इस किरायेदार के दायरे में लागू की जाएंगी।
हस्ताक्षर:
readonly tenantId: string;
TenantAwareAuth.createSessionCookie()
निर्दिष्ट विकल्पों के साथ एक नई फायरबेस सत्र कुकी बनाता है। बनाई गई JWT स्ट्रिंग को कस्टम कुकी नीति के साथ सर्वर-साइड सत्र कुकी के रूप में सेट किया जा सकता है, और सत्र प्रबंधन के लिए उपयोग किया जा सकता है। सत्र कुकी JWT में प्रदत्त आईडी टोकन के समान ही पेलोड दावे होंगे।
कोड नमूनों और विस्तृत दस्तावेज़ीकरण के लिए सत्र कुकीज़ प्रबंधित करें देखें।
हस्ताक्षर:
createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions): Promise<string>;
पैरामीटर
| पैरामीटर | प्रकार | विवरण |
|---|---|---|
| आईडीटोकन | डोरी | सत्र कुकी के बदले में फायरबेस आईडी टोकन। |
| सत्रकुकीविकल्प | सत्रकुकीविकल्प | सत्र कुकी विकल्प जिसमें कस्टम सत्र अवधि शामिल है। |
रिटर्न:
वादा<स्ट्रिंग>
एक वादा जो निर्मित सत्र कुकी के साथ सफलता पर हल होता है।
TenantAwareAuth.verifyIdToken()
फ़ायरबेस आईडी टोकन (JWT) सत्यापित करता है। यदि टोकन वैध है, तो टोकन के डिकोड किए गए दावों के साथ वादा पूरा हो जाता है; अन्यथा, वादा खारिज कर दिया जाता है.
यदि checkRevoked सत्य पर सेट किया गया है, तो पहले सत्यापित करें कि संबंधित उपयोगकर्ता अक्षम है या नहीं। यदि हां, तो एक auth/user-disabled त्रुटि उत्पन्न होती है। यदि नहीं, तो सत्यापित करें कि क्या आईडी टोकन से संबंधित सत्र रद्द कर दिया गया था। यदि संबंधित उपयोगकर्ता का सत्र अमान्य कर दिया गया था, तो एक auth/id-token-revoked त्रुटि उत्पन्न हो जाती है। यदि निर्दिष्ट नहीं है तो चेक लागू नहीं किया जाता है।
कोड नमूनों और विस्तृत दस्तावेज़ीकरण के लिए आईडी टोकन सत्यापित करें देखें।
हस्ताक्षर:
verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
पैरामीटर
| पैरामीटर | प्रकार | विवरण |
|---|---|---|
| आईडीटोकन | डोरी | सत्यापित करने के लिए आईडी टोकन. |
| जाँचनिरस्त कर दिया गया | बूलियन | क्या यह जांचना है कि आईडी टोकन रद्द कर दिया गया है या नहीं। इसके लिए संबंधित उपयोगकर्ता के लिए tokensValidAfterTime समय की जांच करने के लिए फायरबेस ऑथ बैकएंड के लिए एक अतिरिक्त अनुरोध की आवश्यकता होती है। जब निर्दिष्ट नहीं किया जाता है, तो यह अतिरिक्त जांच लागू नहीं की जाती है। |
रिटर्न:
वादा< डिकोडेडआईडटोकन >
यदि आईडी टोकन वैध है तो टोकन के डिकोड किए गए दावों के साथ पूरा किया गया वादा; अन्यथा, एक अस्वीकृत वादा।
TenantAwareAuth.verifySessionCookie()
फ़ायरबेस सत्र कुकी को सत्यापित करता है। कुकी दावों के साथ एक वादा लौटाता है। यदि कुकी सत्यापित नहीं की जा सकी तो वादे को अस्वीकार कर देता है।
यदि checkRevoked सत्य पर सेट किया गया है, तो पहले सत्यापित करें कि संबंधित उपयोगकर्ता अक्षम है या नहीं: यदि हाँ, तो एक auth/user-disabled त्रुटि उत्पन्न होती है। यदि नहीं, तो सत्यापित करें कि क्या सत्र कुकी से संबंधित सत्र निरस्त कर दिया गया था। यदि संबंधित उपयोगकर्ता का सत्र अमान्य कर दिया गया था, तो एक auth/session-cookie-revoked त्रुटि उत्पन्न हो जाती है। यदि निर्दिष्ट नहीं है तो जाँच नहीं की जाती है।
कोड नमूनों और विस्तृत दस्तावेज़ीकरण के लिए सत्र कुकीज़ सत्यापित करें देखें
हस्ताक्षर:
verifySessionCookie(sessionCookie: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
पैरामीटर
| पैरामीटर | प्रकार | विवरण |
|---|---|---|
| सेशनकुकी | डोरी | सत्यापित करने के लिए सत्र कुकी. |
| जाँचनिरस्त कर दिया गया | बूलियन |
रिटर्न:
वादा< डिकोडेडआईडटोकन >
यदि सत्र कुकी वैध है तो सत्र कुकी के डिकोड किए गए दावों के साथ पूरा किया गया वादा; अन्यथा, एक अस्वीकृत वादा।