TenantAwareAuth class

ভাড়াটে-সচেতন Auth ইন্টারফেস ব্যবহারকারীদের পরিচালনা, SAML/OIDC প্রদানকারীদের কনফিগার করা, নির্দিষ্ট ভাড়াটেদের জন্য পাসওয়ার্ড রিসেট, ইমেল যাচাইকরণ ইত্যাদির জন্য ইমেল লিঙ্ক তৈরি করার জন্য ব্যবহৃত হয়।

মাল্টি-টেনেন্সি সমর্থনের জন্য Google ক্লাউডের আইডেন্টিটি প্ল্যাটফর্ম (GCIP) প্রয়োজন। মূল্য এবং বৈশিষ্ট্য সহ GCIP সম্পর্কে আরও জানতে, GCIP ডকুমেন্টেশন দেখুন .

প্রতিটি ভাড়াটে এর নিজস্ব পরিচয় প্রদানকারী, সেটিংস এবং ব্যবহারকারীদের সেট রয়েছে। TenantAwareAuth ব্যবহার করে , একটি নির্দিষ্ট ভাড়াটে এবং সংশ্লিষ্ট OIDC/SAML কনফিগারেশনের ব্যবহারকারীদেরও পরিচালনা করা যেতে পারে, নির্দিষ্ট ভাড়াটে সাইন ইন করা ব্যবহারকারীদের জন্য আইডি টোকেন যাচাই করা যেতে পারে, এবং ইমেল অ্যাকশন লিঙ্কগুলিও ভাড়াটে ব্যবহারকারীদের জন্য তৈরি করা যেতে পারে।

একটি নির্দিষ্ট tenantId জন্য TenantAwareAuth দৃষ্টান্তগুলি TenantManager.authForTenant() কল করে ইনস্ট্যান্ট করা যেতে পারে .

স্বাক্ষর:

export declare class TenantAwareAuth extends BaseAuth

প্রসারিত: BaseAuth

বৈশিষ্ট্য

সম্পত্তি সংশোধক টাইপ বর্ণনা
ভাড়াটে আইডি স্ট্রিং এই TenantAwareAuth উদাহরণের সাথে সংশ্লিষ্ট ভাড়াটে শনাক্তকারী। ইউজার ম্যানেজমেন্ট API, OIDC/SAML প্রোভাইডার ম্যানেজমেন্ট API, ইমেল লিঙ্ক জেনারেশন API, ইত্যাদির সমস্ত কল শুধুমাত্র এই ভাড়াটিয়ার সুযোগের মধ্যেই প্রয়োগ করা হবে।

পদ্ধতি

পদ্ধতি সংশোধক বর্ণনা
CreateSessionCookie(idToken, sessionCookieOptions) নির্দিষ্ট বিকল্পগুলির সাথে একটি নতুন Firebase সেশন কুকি তৈরি করে৷ তৈরি করা JWT স্ট্রিং একটি কাস্টম কুকি নীতি সহ সার্ভার-সাইড সেশন কুকি হিসাবে সেট করা যেতে পারে এবং সেশন পরিচালনার জন্য ব্যবহার করা যেতে পারে। সেশন কুকি JWT-তে প্রদত্ত আইডি টোকেনের মতো একই পেলোড দাবি থাকবে। কোড নমুনা এবং বিস্তারিত ডকুমেন্টেশনের জন্য সেশন কুকিজ পরিচালনা দেখুন।
verifyIdToken(idToken, চেক প্রত্যাহার) একটি Firebase ID টোকেন (JWT) যাচাই করে। যদি টোকেন বৈধ হয়, প্রতিশ্রুতি টোকেনের ডিকোড করা দাবির সাথে পূর্ণ হয়; অন্যথায়, প্রতিশ্রুতি প্রত্যাখ্যান করা হয়। checkRevoked সত্যে সেট করা থাকলে, সংশ্লিষ্ট ব্যবহারকারী অক্ষম কিনা তা প্রথমে যাচাই করে। যদি হ্যাঁ, একটি auth/user-disabled ত্রুটি নিক্ষেপ করা হয়। যদি না হয়, আইডি টোকেনের সাথে সম্পর্কিত সেশনটি প্রত্যাহার করা হয়েছে কিনা তা যাচাই করে। যদি সংশ্লিষ্ট ব্যবহারকারীর সেশনটি অবৈধ হয়ে থাকে, তাহলে একটি auth/id-token-revoked ত্রুটি নিক্ষেপ করা হয়। উল্লেখ না থাকলে চেক প্রয়োগ করা হয় না। কোড নমুনা এবং বিস্তারিত ডকুমেন্টেশনের জন্য আইডি টোকেন যাচাই করুন দেখুন।
verifySessionCookie(সেশন কুকি, চেক প্রত্যাহার করা হয়েছে) একটি Firebase সেশন কুকি যাচাই করে। কুকি দাবির সাথে একটি প্রতিশ্রুতি প্রদান করে। কুকি যাচাই করা সম্ভব না হলে প্রতিশ্রুতি প্রত্যাখ্যান করে। checkRevoked সত্যে সেট করা থাকলে, সংশ্লিষ্ট ব্যবহারকারী নিষ্ক্রিয় কিনা তা প্রথমে যাচাই করে: যদি হ্যাঁ, একটি auth/user-disabled ত্রুটি নিক্ষেপ করা হয়। যদি না হয়, সেশন কুকির সাথে সম্পর্কিত সেশনটি প্রত্যাহার করা হয়েছে কিনা তা যাচাই করে। সংশ্লিষ্ট ব্যবহারকারীর অধিবেশন অবৈধ হলে, একটি auth/session-cookie-revoked ত্রুটি নিক্ষেপ করা হয়। নির্দিষ্ট না হলে চেক সঞ্চালিত হয় না. কোড নমুনা এবং বিস্তারিত ডকুমেন্টেশনের জন্য সেশন কুকিজ যাচাই দেখুন

TenantAwareAuth.tenantId

এই TenantAwareAuth উদাহরণের সাথে সংশ্লিষ্ট ভাড়াটে শনাক্তকারী। ইউজার ম্যানেজমেন্ট API, OIDC/SAML প্রোভাইডার ম্যানেজমেন্ট API, ইমেল লিঙ্ক জেনারেশন API, ইত্যাদির সমস্ত কল শুধুমাত্র এই ভাড়াটিয়ার সুযোগের মধ্যেই প্রয়োগ করা হবে।

স্বাক্ষর:

readonly tenantId: string;

TenantAwareAuth.createSessionCookie()

নির্দিষ্ট বিকল্পগুলির সাথে একটি নতুন Firebase সেশন কুকি তৈরি করে৷ তৈরি করা JWT স্ট্রিং একটি কাস্টম কুকি নীতি সহ সার্ভার-সাইড সেশন কুকি হিসাবে সেট করা যেতে পারে এবং সেশন পরিচালনার জন্য ব্যবহার করা যেতে পারে। সেশন কুকি JWT-তে প্রদত্ত আইডি টোকেনের মতো একই পেলোড দাবি থাকবে।

কোড নমুনা এবং বিস্তারিত ডকুমেন্টেশনের জন্য সেশন কুকিজ পরিচালনা দেখুন।

স্বাক্ষর:

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

পরামিতি

প্যারামিটার টাইপ বর্ণনা
idToken স্ট্রিং একটি সেশন কুকি বিনিময় করার জন্য Firebase আইডি টোকেন।
সেশন কুকি বিকল্প সেশনকুকি বিকল্প সেশন কুকি বিকল্প যা কাস্টম সেশনের সময়কাল অন্তর্ভুক্ত করে।

রিটার্ন:

প্রতিশ্রুতি<string>

একটি প্রতিশ্রুতি যা তৈরি করা সেশন কুকির সাথে সাফল্যের সমাধান করে।

TenantAwareAuth.verifyIdToken()

একটি Firebase ID টোকেন (JWT) যাচাই করে। যদি টোকেন বৈধ হয়, প্রতিশ্রুতি টোকেনের ডিকোড করা দাবির সাথে পূর্ণ হয়; অন্যথায়, প্রতিশ্রুতি প্রত্যাখ্যান করা হয়।

checkRevoked সত্যে সেট করা থাকলে, সংশ্লিষ্ট ব্যবহারকারী অক্ষম কিনা তা প্রথমে যাচাই করে। যদি হ্যাঁ, একটি auth/user-disabled ত্রুটি নিক্ষেপ করা হয়। যদি না হয়, আইডি টোকেনের সাথে সম্পর্কিত সেশনটি প্রত্যাহার করা হয়েছে কিনা তা যাচাই করে। যদি সংশ্লিষ্ট ব্যবহারকারীর সেশনটি অবৈধ হয়ে থাকে, তাহলে একটি auth/id-token-revoked ত্রুটি নিক্ষেপ করা হয়। উল্লেখ না থাকলে চেক প্রয়োগ করা হয় না।

কোড নমুনা এবং বিস্তারিত ডকুমেন্টেশনের জন্য আইডি টোকেন যাচাই করুন দেখুন।

স্বাক্ষর:

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

পরামিতি

প্যারামিটার টাইপ বর্ণনা
idToken স্ট্রিং আইডি টোকেন যাচাই করতে হবে।
চেক প্রত্যাহার বুলিয়ান আইডি টোকেন প্রত্যাহার করা হয়েছে কিনা তা পরীক্ষা করতে হবে। এর জন্য সংশ্লিষ্ট ব্যবহারকারীর জন্য tokensValidAfterTime সময় পরীক্ষা করার জন্য Firebase Auth ব্যাকএন্ডের কাছে একটি অতিরিক্ত অনুরোধের প্রয়োজন। নির্দিষ্ট করা না থাকলে, এই অতিরিক্ত চেক প্রয়োগ করা হয় না।

রিটার্ন:

প্রতিশ্রুতি< DecodedIdToken >

আইডি টোকেন বৈধ হলে টোকেনের ডিকোড করা দাবির সাথে পূর্ণ একটি প্রতিশ্রুতি; অন্যথায়, একটি প্রত্যাখ্যাত প্রতিশ্রুতি।

TenantAwareAuth.verifySessionCookie()

একটি Firebase সেশন কুকি যাচাই করে। কুকি দাবির সাথে একটি প্রতিশ্রুতি প্রদান করে। কুকি যাচাই করা সম্ভব না হলে প্রতিশ্রুতি প্রত্যাখ্যান করে।

checkRevoked সত্যে সেট করা থাকলে, সংশ্লিষ্ট ব্যবহারকারী নিষ্ক্রিয় কিনা তা প্রথমে যাচাই করে: যদি হ্যাঁ, একটি auth/user-disabled ত্রুটি নিক্ষেপ করা হয়। যদি না হয়, সেশন কুকির সাথে সম্পর্কিত সেশনটি প্রত্যাহার করা হয়েছে কিনা তা যাচাই করে। সংশ্লিষ্ট ব্যবহারকারীর অধিবেশন অবৈধ হলে, একটি auth/session-cookie-revoked ত্রুটি নিক্ষেপ করা হয়। নির্দিষ্ট না হলে চেক সঞ্চালিত হয় না.

কোড নমুনা এবং বিস্তারিত ডকুমেন্টেশনের জন্য সেশন কুকিজ যাচাই দেখুন

স্বাক্ষর:

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

পরামিতি

প্যারামিটার টাইপ বর্ণনা
সেশন কুকি স্ট্রিং যাচাই করার জন্য সেশন কুকি।
চেক প্রত্যাহার বুলিয়ান

রিটার্ন:

প্রতিশ্রুতি< DecodedIdToken >

সেশন কুকি বৈধ হলে সেশন কুকির ডিকোড করা দাবির সাথে পূর্ণ একটি প্রতিশ্রুতি; অন্যথায়, একটি প্রত্যাখ্যাত প্রতিশ্রুতি।