BaseAuth class

Auth এবং TenantAwareAuth API উভয়ের জন্য সাধারণ অভিভাবক ইন্টারফেস।

স্বাক্ষর:

export declare abstract class BaseAuth 

পদ্ধতি

পদ্ধতি সংশোধক বর্ণনা
CreateCustomToken(uid, বিকাশকারীর দাবি) একটি নতুন Firebase কাস্টম টোকেন (JWT) তৈরি করে যা ক্লায়েন্ট SDK-এর signInWithCustomToken() পদ্ধতিতে সাইন ইন করতে ব্যবহার করার জন্য একটি ক্লায়েন্ট ডিভাইসে ফেরত পাঠানো যেতে পারে। (ভাড়াটে-সচেতন উদাহরণগুলিও টোকেনে ভাড়াটে আইডি এমবেড করবে।) কোড নমুনা এবং বিস্তারিত ডকুমেন্টেশনের জন্য কাস্টম টোকেন তৈরি করুন দেখুন।
CreateProviderConfig(config) একটি প্রতিশ্রুতি প্রদান করে যা নতুন প্রদানকারী কনফিগারেশন তৈরি করা হলে নতুন তৈরি AuthProviderConfig এর সাথে সমাধান করে। SAML এবং OIDC প্রদানকারী সহায়তার জন্য Google Cloud এর আইডেন্টিটি প্ল্যাটফর্ম (GCIP) প্রয়োজন। মূল্য এবং বৈশিষ্ট্য সহ GCIP সম্পর্কে আরও জানতে, GCIP ডকুমেন্টেশন দেখুন .
CreateSessionCookie(idToken, sessionCookieOptions) নির্দিষ্ট বিকল্পগুলির সাথে একটি নতুন Firebase সেশন কুকি তৈরি করে৷ তৈরি করা JWT স্ট্রিং একটি কাস্টম কুকি নীতি সহ সার্ভার-সাইড সেশন কুকি হিসাবে সেট করা যেতে পারে এবং সেশন পরিচালনার জন্য ব্যবহার করা যেতে পারে। সেশন কুকি JWT-তে প্রদত্ত আইডি টোকেনের মতো একই পেলোড দাবি থাকবে। কোড নমুনা এবং বিস্তারিত ডকুমেন্টেশনের জন্য সেশন কুকিজ পরিচালনা দেখুন।
ব্যবহারকারী তৈরি করুন(বৈশিষ্ট্য) একটি নতুন ব্যবহারকারী তৈরি করে। কোড নমুনা এবং বিস্তারিত ডকুমেন্টেশনের জন্য একটি ব্যবহারকারী তৈরি করুন দেখুন।
ডিলিটপ্রোভাইডার কনফিগ(প্রোভাইডারআইডি) পাস করা প্রদানকারী আইডির সাথে সম্পর্কিত প্রদানকারী কনফিগারেশন মুছে দেয়। যদি নির্দিষ্ট আইডিটি বিদ্যমান না থাকে, একটি auth/configuration-not-found ত্রুটি নিক্ষেপ করা হয়। SAML এবং OIDC প্রদানকারী সহায়তার জন্য Google Cloud এর আইডেন্টিটি প্ল্যাটফর্ম (GCIP) প্রয়োজন। মূল্য এবং বৈশিষ্ট্য সহ GCIP সম্পর্কে আরও জানতে, GCIP ডকুমেন্টেশন দেখুন .
ডিলিট ইউজার(uid) একটি বিদ্যমান ব্যবহারকারী মুছে দেয়। কোড নমুনা এবং বিস্তারিত ডকুমেন্টেশনের জন্য একটি ব্যবহারকারী মুছুন দেখুন।
ব্যবহারকারীদের (ইউআইডি) মুছুন প্রদত্ত ইউআইডি দ্বারা নির্দিষ্ট ব্যবহারকারীদের মুছে দেয়। একটি অ-বিদ্যমান ব্যবহারকারী মুছে ফেলা একটি ত্রুটি তৈরি করবে না (অর্থাৎ এই পদ্ধতিটি অদম্য।) অ-বিদ্যমান ব্যবহারকারীদের সফলভাবে মুছে ফেলা হয়েছে বলে মনে করা হয়, এবং তাই DeleteUsersResult.successCount মানতে গণনা করা হয়। শুধুমাত্র সর্বাধিক 1000 শনাক্তকারী সরবরাহ করা যেতে পারে। যদি 1000 টির বেশি শনাক্তকারী সরবরাহ করা হয়, এই পদ্ধতিটি একটি FirebaseAuthError নিক্ষেপ করে। এই API বর্তমানে সার্ভারে 1 QPS-এ সীমাবদ্ধ। আপনি এটি অতিক্রম করলে, আপনি একটি কোটা অতিক্রম করার ত্রুটি পেতে পারেন। অতএব, আপনি যদি 1000 টির বেশি ব্যবহারকারীকে মুছতে চান, তাহলে আপনি এই সীমা অতিক্রম করবেন না তা নিশ্চিত করার জন্য আপনাকে একটি বিলম্ব যোগ করতে হতে পারে।
ইমেইল যাচাইকরণ লিঙ্ক তৈরি করুন (ইমেল, অ্যাকশন কোড সেটিংস) নির্দিষ্ট ইমেলের ব্যবহারকারীর মালিকানা যাচাই করার জন্য আউট অফ ব্যান্ড ইমেল অ্যাকশন লিঙ্ক তৈরি করে। এই পদ্ধতির একটি যুক্তি হিসাবে প্রদত্ত ActionCodeSettings অবজেক্টটি ডিপ লিঙ্কে পাস করার জন্য অতিরিক্ত রাষ্ট্রীয় তথ্য সহ লিঙ্কটি মোবাইল অ্যাপ বা ব্রাউজার দ্বারা পরিচালনা করা হবে কিনা তা নির্ধারণ করে।
পাসওয়ার্ড রিসেটলিঙ্ক তৈরি করুন (ইমেল, অ্যাকশন কোড সেটিংস) ব্যবহারকারীর পাসওয়ার্ড পুনরায় সেট করতে ব্যান্ডের বাইরের ইমেল অ্যাকশন লিঙ্ক তৈরি করে। লিঙ্কটি নির্দিষ্ট ইমেল ঠিকানা সহ ব্যবহারকারীর জন্য তৈরি করা হয়। ঐচ্ছিক ActionCodeSettings অবজেক্ট সংজ্ঞায়িত করে যে লিঙ্কটি একটি মোবাইল অ্যাপ বা ব্রাউজার দ্বারা পরিচালনা করা হবে কিনা এবং অতিরিক্ত রাষ্ট্রীয় তথ্য ডিপ লিঙ্কে পাস করা হবে ইত্যাদি।
সাইনইন উইথ ইমেইল লিঙ্ক তৈরি করুন (ইমেল, অ্যাকশন কোড সেটিংস) নির্দিষ্ট ইমেলের ব্যবহারকারীর মালিকানা যাচাই করার জন্য আউট অফ ব্যান্ড ইমেল অ্যাকশন লিঙ্ক তৈরি করে। এই পদ্ধতির একটি যুক্তি হিসাবে প্রদত্ত ActionCodeSettings অবজেক্টটি ডিপ লিঙ্কে পাস করার জন্য অতিরিক্ত রাষ্ট্রীয় তথ্য সহ লিঙ্কটি মোবাইল অ্যাপ বা ব্রাউজার দ্বারা পরিচালনা করা হবে কিনা তা নির্ধারণ করে।
যাচাই করুন এবং পরিবর্তন করুন ইমেল লিঙ্ক (ইমেল, নতুন ইমেল, অ্যাকশন কোড সেটিংস) নির্দিষ্ট ইমেলের ব্যবহারকারীর মালিকানা যাচাই করতে একটি আউট-অফ-ব্যান্ড ইমেল অ্যাকশন লিঙ্ক তৈরি করে। এই পদ্ধতির একটি যুক্তি হিসাবে প্রদত্ত ActionCodeSettings অবজেক্টটি ডিপ লিঙ্কে পাস করার জন্য অতিরিক্ত রাষ্ট্রীয় তথ্য সহ লিঙ্কটি মোবাইল অ্যাপ বা ব্রাউজার দ্বারা পরিচালনা করা হবে কিনা তা নির্ধারণ করে।
getProviderConfig(providerId) প্রদত্ত আইডি দ্বারা একটি প্রমাণ প্রদানকারী কনফিগারেশন সন্ধান করে৷ একটি প্রতিশ্রুতি প্রদান করে যা নির্দিষ্ট প্রদানকারী আইডির সাথে সংশ্লিষ্ট প্রদানকারী কনফিগারেশনের সাথে সমাধান করে। যদি নির্দিষ্ট আইডিটি বিদ্যমান না থাকে, একটি auth/configuration-not-found ত্রুটি নিক্ষেপ করা হয়। SAML এবং OIDC প্রদানকারী সহায়তার জন্য Google Cloud এর আইডেন্টিটি প্ল্যাটফর্ম (GCIP) প্রয়োজন। মূল্য এবং বৈশিষ্ট্য সহ GCIP সম্পর্কে আরও জানতে, GCIP ডকুমেন্টেশন দেখুন .
getUser(uid) একটি প্রদত্ত uid সাথে সংশ্লিষ্ট ব্যবহারকারীর জন্য ব্যবহারকারীর ডেটা পায়। কোড নমুনা এবং বিস্তারিত ডকুমেন্টেশনের জন্য ব্যবহারকারীর ডেটা পুনরুদ্ধার দেখুন।
getUserByEmail(ইমেল) প্রদত্ত ইমেলের সাথে সংশ্লিষ্ট ব্যবহারকারীর জন্য ব্যবহারকারীর ডেটা পায়। কোড নমুনা এবং বিস্তারিত ডকুমেন্টেশনের জন্য ব্যবহারকারীর ডেটা পুনরুদ্ধার দেখুন।
getUserByPhoneNumber(ফোন নম্বর) একটি প্রদত্ত ফোন নম্বরের সাথে সংশ্লিষ্ট ব্যবহারকারীর জন্য ব্যবহারকারীর ডেটা পায়। ফোন নম্বরটিকে E.164 স্পেসিফিকেশন মেনে চলতে হবে। কোড নমুনা এবং বিস্তারিত ডকুমেন্টেশনের জন্য ব্যবহারকারীর ডেটা পুনরুদ্ধার দেখুন।
getUserByProviderUid(providerId, uid) একটি প্রদত্ত প্রদানকারী আইডির সাথে সংশ্লিষ্ট ব্যবহারকারীর জন্য ব্যবহারকারীর ডেটা পায়। কোড নমুনা এবং বিস্তারিত ডকুমেন্টেশনের জন্য ব্যবহারকারীর ডেটা পুনরুদ্ধার দেখুন।
getUsers(শনাক্তকারী) নির্দিষ্ট শনাক্তকারীর সাথে সংশ্লিষ্ট ব্যবহারকারীর ডেটা পায়। কোন অর্ডার গ্যারান্টি নেই; বিশেষ করে, ফলাফল তালিকার nম এন্ট্রি ইনপুট পরামিতি তালিকার nম এন্ট্রির সাথে সঙ্গতিপূর্ণ হওয়ার নিশ্চয়তা নেই৷ শুধুমাত্র সর্বাধিক 100 শনাক্তকারী সরবরাহ করা যেতে পারে। যদি 100 টির বেশি শনাক্তকারী সরবরাহ করা হয়, এই পদ্ধতিটি একটি FirebaseAuthError নিক্ষেপ করে।
আমদানি ব্যবহারকারী (ব্যবহারকারী, বিকল্প) Firebase Auth-এ ব্যবহারকারীদের প্রদত্ত তালিকা আমদানি করে। সর্বাধিক 1000 ব্যবহারকারীকে একবারে আমদানি করার অনুমতি দেওয়া হয়। পাসওয়ার্ড সহ ব্যবহারকারীদের আমদানি করার সময়, UserImportOptions নির্দিষ্ট করা প্রয়োজন৷ এই ক্রিয়াকলাপটি বাল্ক আমদানির জন্য অপ্টিমাইজ করা হয়েছে এবং uid , email এবং অন্যান্য শনাক্তকারী স্বতন্ত্রতার চেকগুলিকে উপেক্ষা করবে যার ফলে ডুপ্লিকেশন হতে পারে৷
listProviderConfigs(বিকল্প) প্রদত্ত ফিল্টারের সাথে মেলে বিদ্যমান প্রদানকারী কনফিগারেশনের তালিকা প্রদান করে। সর্বাধিক, 100টি প্রদানকারী কনফিগার একবারে তালিকাভুক্ত করা যেতে পারে। SAML এবং OIDC প্রদানকারী সহায়তার জন্য Google Cloud এর আইডেন্টিটি প্ল্যাটফর্ম (GCIP) প্রয়োজন। মূল্য এবং বৈশিষ্ট্য সহ GCIP সম্পর্কে আরও জানতে, GCIP ডকুমেন্টেশন দেখুন .
ব্যবহারকারীদের তালিকা (সর্বোচ্চ ফলাফল, পৃষ্ঠা টোকেন) pageToken দ্বারা নির্দিষ্ট করা অফসেট থেকে শুরু করে maxResults আকার সহ ব্যবহারকারীদের একটি তালিকা (শুধুমাত্র একক ব্যাচ) পুনরুদ্ধার করে। এটি ব্যাচগুলিতে একটি নির্দিষ্ট প্রকল্পের সমস্ত ব্যবহারকারীকে পুনরুদ্ধার করতে ব্যবহৃত হয়। কোড নমুনা এবং বিস্তারিত ডকুমেন্টেশনের জন্য সমস্ত ব্যবহারকারীদের তালিকা দেখুন।
RevokeRefreshTokens(uid) একটি বিদ্যমান ব্যবহারকারীর জন্য সমস্ত রিফ্রেশ টোকেন প্রত্যাহার করে৷ এই API ব্যবহারকারীর UserRecord.tokensValidAfterTime বর্তমান UTC-তে আপডেট করবে। এটি গুরুত্বপূর্ণ যে সার্ভারে এটি বলা হয় তার ঘড়িটি সঠিকভাবে সেট করা এবং সিঙ্ক্রোনাইজ করা হয়েছে৷ যদিও এটি একটি নির্দিষ্ট ব্যবহারকারীর জন্য সমস্ত সেশন প্রত্যাহার করবে এবং বিদ্যমান সেশনগুলির জন্য যেকোন নতুন আইডি টোকেনকে মিন্ট করা থেকে নিষ্ক্রিয় করবে, বিদ্যমান আইডি টোকেনগুলি তাদের স্বাভাবিক মেয়াদ শেষ না হওয়া পর্যন্ত সক্রিয় থাকতে পারে (এক ঘন্টা)। আইডি টোকেনগুলি প্রত্যাহার করা হয়েছে তা যাচাই করতে, BaseAuth.verifyIdToken() ব্যবহার করুন যেখানে checkRevoked সত্য হিসাবে সেট করা আছে৷
setCustomUserClaims(uid, customUserClaims) প্রদত্ত uid দ্বারা চিহ্নিত একটি বিদ্যমান ব্যবহারকারীর উপর অতিরিক্ত বিকাশকারীর দাবি সেট করে, সাধারণত ব্যবহারকারীর ভূমিকা এবং অ্যাক্সেসের স্তরগুলি নির্ধারণ করতে ব্যবহৃত হয়৷ এই দাবিগুলি সমস্ত ডিভাইসে প্রচার করা উচিত যেখানে ব্যবহারকারী ইতিমধ্যে সাইন ইন করেছেন (টোকেনের মেয়াদ শেষ হওয়ার পরে বা যখন টোকেন রিফ্রেশ বাধ্য করা হয়) এবং পরবর্তী সময়ে ব্যবহারকারী সাইন ইন করে। যদি একটি সংরক্ষিত OIDC দাবির নাম ব্যবহার করা হয় (sub, iat, iss, ইত্যাদি) ), একটি ত্রুটি নিক্ষেপ করা হয়। এগুলি প্রমাণীকৃত ব্যবহারকারীর আইডি টোকেন JWT-তে সেট করা আছে। কোড নমুনা এবং বিস্তারিত ডকুমেন্টেশনের জন্য ব্যবহারকারীর ভূমিকা এবং অ্যাক্সেসের স্তর নির্ধারণ করা দেখুন।
UpdateProviderConfig(providerId, updateConfig) একটি প্রতিশ্রুতি প্রদান করে যা নির্দিষ্ট প্রদানকারী আইডির সাথে সম্পর্কিত আপডেট করা AuthProviderConfig এর সাথে সমাধান করে। যদি নির্দিষ্ট আইডিটি বিদ্যমান না থাকে, একটি auth/configuration-not-found ত্রুটি নিক্ষেপ করা হয়। SAML এবং OIDC প্রদানকারী সহায়তার জন্য Google Cloud এর আইডেন্টিটি প্ল্যাটফর্ম (GCIP) প্রয়োজন। মূল্য এবং বৈশিষ্ট্য সহ GCIP সম্পর্কে আরও জানতে, GCIP ডকুমেন্টেশন দেখুন .
UpdateUser(uid, বৈশিষ্ট্য) একটি বিদ্যমান ব্যবহারকারী আপডেট করে। কোড নমুনা এবং বিস্তারিত ডকুমেন্টেশনের জন্য একজন ব্যবহারকারীকে আপডেট করুন দেখুন।
verifyIdToken(idToken, চেক প্রত্যাহার) একটি Firebase ID টোকেন (JWT) যাচাই করে। যদি টোকেন বৈধ হয়, প্রতিশ্রুতি টোকেনের ডিকোড করা দাবির সাথে পূর্ণ হয়; অন্যথায়, প্রতিশ্রুতি প্রত্যাখ্যান করা হয়। checkRevoked সত্যে সেট করা থাকলে, সংশ্লিষ্ট ব্যবহারকারী অক্ষম কিনা তা প্রথমে যাচাই করে। যদি হ্যাঁ, একটি auth/user-disabled ত্রুটি নিক্ষেপ করা হয়। যদি না হয়, আইডি টোকেনের সাথে সম্পর্কিত সেশনটি প্রত্যাহার করা হয়েছে কিনা তা যাচাই করে। যদি সংশ্লিষ্ট ব্যবহারকারীর সেশনটি অবৈধ হয়ে থাকে, তাহলে একটি auth/id-token-revoked ত্রুটি নিক্ষেপ করা হয়। উল্লেখ না থাকলে চেক প্রয়োগ করা হয় না। কোড নমুনা এবং বিস্তারিত ডকুমেন্টেশনের জন্য আইডি টোকেন যাচাই করুন দেখুন।
verifySessionCookie(সেশন কুকি, চেক প্রত্যাহার করা হয়েছে) একটি 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 এর সাথে সমাধান করে।

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

স্বাক্ষর:

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

পরামিতি

প্যারামিটার টাইপ বর্ণনা
কনফিগারেশন AuthProviderConfig প্রদানকারীর কনফিগারেশন তৈরি করতে হবে।

রিটার্ন:

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

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

BaseAuth.createSessionCookie()

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

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

স্বাক্ষর:

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

পরামিতি

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

রিটার্ন:

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

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

BaseAuth.createUser()

একটি নতুন ব্যবহারকারী তৈরি করে।

কোড নমুনা এবং বিস্তারিত ডকুমেন্টেশনের জন্য একটি ব্যবহারকারী তৈরি করুন দেখুন।

স্বাক্ষর:

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

পরামিতি

প্যারামিটার টাইপ বর্ণনা
বৈশিষ্ট্য অনুরোধ তৈরি করুন নতুন ব্যবহারকারীর রেকর্ডে সেট করার বৈশিষ্ট্যগুলি তৈরি করতে হবে৷

রিটার্ন:

প্রতিশ্রুতি< ব্যবহারকারীর রেকর্ড >

সদ্য নির্মিত ব্যবহারকারীর সাথে সংশ্লিষ্ট ব্যবহারকারীর ডেটার সাথে পূর্ণ একটি প্রতিশ্রুতি।

BaseAuth.deleteProviderConfig()

পাস করা প্রদানকারী আইডির সাথে সম্পর্কিত প্রদানকারী কনফিগারেশন মুছে দেয়। যদি নির্দিষ্ট আইডিটি বিদ্যমান না থাকে, একটি auth/configuration-not-found ত্রুটি নিক্ষেপ করা হয়।

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

স্বাক্ষর:

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

পরামিতি

প্যারামিটার টাইপ বর্ণনা
প্রদানকারী আইডি স্ট্রিং মুছে ফেলার জন্য প্রদানকারী কনফিগারেশনের সাথে সংশ্লিষ্ট প্রদানকারী আইডি।

রিটার্ন:

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

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

BaseAuth.deleteUser()

একটি বিদ্যমান ব্যবহারকারী মুছে দেয়।

কোড নমুনা এবং বিস্তারিত ডকুমেন্টেশনের জন্য একটি ব্যবহারকারী মুছুন দেখুন।

স্বাক্ষর:

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

পরামিতি

প্যারামিটার টাইপ বর্ণনা
uid স্ট্রিং ব্যবহারকারীর সাথে সংশ্লিষ্ট uid মুছে ফেলতে হবে।

রিটার্ন:

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

ব্যবহারকারীকে মুছে ফেলার পরে একটি খালি প্রতিশ্রুতি পূরণ হয়।

BaseAuth.deleteUsers()

প্রদত্ত ইউআইডি দ্বারা নির্দিষ্ট ব্যবহারকারীদের মুছে দেয়।

একটি অ-বিদ্যমান ব্যবহারকারী মুছে ফেলা একটি ত্রুটি তৈরি করবে না (অর্থাৎ এই পদ্ধতিটি অদম্য।) অ-বিদ্যমান ব্যবহারকারীদের সফলভাবে মুছে ফেলা হয়েছে বলে মনে করা হয়, এবং তাই DeleteUsersResult.successCount মানতে গণনা করা হয়।

শুধুমাত্র সর্বাধিক 1000 শনাক্তকারী সরবরাহ করা যেতে পারে। যদি 1000 টির বেশি শনাক্তকারী সরবরাহ করা হয়, এই পদ্ধতিটি একটি FirebaseAuthError নিক্ষেপ করে।

এই API বর্তমানে সার্ভারে 1 QPS-এ সীমাবদ্ধ। আপনি এটি অতিক্রম করলে, আপনি একটি কোটা অতিক্রম করার ত্রুটি পেতে পারেন। অতএব, আপনি যদি 1000 টির বেশি ব্যবহারকারীকে মুছতে চান, তাহলে আপনি এই সীমা অতিক্রম করবেন না তা নিশ্চিত করার জন্য আপনাকে একটি বিলম্ব যোগ করতে হতে পারে।

স্বাক্ষর:

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

পরামিতি

প্যারামিটার টাইপ বর্ণনা
ইউআইডি স্ট্রিং[] ব্যবহারকারীদের সাথে সংশ্লিষ্ট uids মুছে ফেলতে হবে।

রিটার্ন:

প্রতিশ্রুতি < ব্যবহারকারীদের ফলাফল মুছুন >

একটি প্রতিশ্রুতি যা সফল/ব্যর্থ মুছে ফেলার মোট সংখ্যার সমাধান করে, সেইসাথে ব্যর্থ মোছার সাথে সামঞ্জস্যপূর্ণ ত্রুটির বিন্যাস।

নির্দিষ্ট ইমেলের ব্যবহারকারীর মালিকানা যাচাই করার জন্য আউট অফ ব্যান্ড ইমেল অ্যাকশন লিঙ্ক তৈরি করে। এই পদ্ধতির একটি যুক্তি হিসাবে প্রদত্ত ActionCodeSettings অবজেক্টটি ডিপ লিঙ্কে পাস করার জন্য অতিরিক্ত রাষ্ট্রীয় তথ্য সহ লিঙ্কটি মোবাইল অ্যাপ বা ব্রাউজার দ্বারা পরিচালনা করা হবে কিনা তা নির্ধারণ করে।

স্বাক্ষর:

generateEmailVerificationLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

পরামিতি

প্যারামিটার টাইপ বর্ণনা
ইমেইল স্ট্রিং ইমেল অ্যাকাউন্ট যাচাই করতে হবে।
অ্যাকশন কোড সেটিংস অ্যাকশন কোড সেটিংস অ্যাকশন কোড সেটিংস। উল্লেখ করা থাকলে, স্টেট/কন্টিনিউ ইউআরএল ইমেল যাচাইকরণ লিঙ্কে "continueUrl" প্যারামিটার হিসেবে সেট করা হয়। ডিফল্ট ইমেল যাচাইকরণ ল্যান্ডিং পৃষ্ঠাটি ইনস্টল করা থাকলে অ্যাপটিতে ফিরে যাওয়ার জন্য একটি লিঙ্ক প্রদর্শন করতে এটি ব্যবহার করবে। যদি actionCodeSettings নির্দিষ্ট করা না থাকে, তাহলে অ্যাকশন URL-এ কোনো URL যুক্ত করা হয় না। প্রদত্ত স্টেট ইউআরএলটি অবশ্যই একটি ডোমেনের অন্তর্গত হতে হবে যা কনসোলে ডেভেলপার দ্বারা সাদাতালিকাভুক্ত। অন্যথায় একটি ত্রুটি নিক্ষেপ করা হয়. মোবাইল অ্যাপ রিডাইরেক্ট শুধুমাত্র তখনই প্রযোজ্য যদি ডেভেলপার Firebase ডায়নামিক লিঙ্কের পরিষেবার শর্তাবলী কনফিগার করে এবং গ্রহণ করে। Android প্যাকেজের নাম এবং iOS বান্ডেল আইডি শুধুমাত্র তখনই সম্মান করা হয় যদি সেগুলি একই Firebase Auth প্রোজেক্টে কনফিগার করা থাকে।

রিটার্ন:

প্রতিশ্রুতি<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>;

পরামিতি

প্যারামিটার টাইপ বর্ণনা
ইমেইল স্ট্রিং যে ব্যবহারকারীর পাসওয়ার্ড রিসেট করতে হবে তার ইমেল ঠিকানা।
অ্যাকশন কোড সেটিংস অ্যাকশন কোড সেটিংস অ্যাকশন কোড সেটিংস। নির্দিষ্ট করা থাকলে, পাসওয়ার্ড রিসেট লিঙ্কে স্টেট/কন্টিনিউ ইউআরএলটিকে "continueUrl" প্যারামিটার হিসেবে সেট করা হয়। ডিফল্ট পাসওয়ার্ড রিসেট ল্যান্ডিং পৃষ্ঠা এটি ইনস্টল করা থাকলে অ্যাপে ফিরে যাওয়ার জন্য একটি লিঙ্ক প্রদর্শন করতে এটি ব্যবহার করবে। যদি actionCodeSettings নির্দিষ্ট করা না থাকে, তাহলে অ্যাকশন URL-এ কোনো URL যুক্ত করা হয় না। প্রদত্ত স্টেট ইউআরএলটি অবশ্যই একটি ডোমেনের অন্তর্গত হতে হবে যা কনসোলে ডেভেলপার দ্বারা সাদাতালিকাভুক্ত। অন্যথায় একটি ত্রুটি নিক্ষেপ করা হয়. মোবাইল অ্যাপ রিডাইরেক্ট শুধুমাত্র তখনই প্রযোজ্য যদি ডেভেলপার Firebase ডায়নামিক লিঙ্কের পরিষেবার শর্তাবলী কনফিগার করে এবং গ্রহণ করে। Android প্যাকেজের নাম এবং iOS বান্ডেল আইডি শুধুমাত্র তখনই সম্মান করা হয় যদি সেগুলি একই Firebase Auth প্রোজেক্টে কনফিগার করা থাকে।

রিটার্ন:

প্রতিশ্রুতি<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>;

পরামিতি

প্যারামিটার টাইপ বর্ণনা
ইমেইল স্ট্রিং ইমেল অ্যাকাউন্ট যাচাই করতে হবে।
অ্যাকশন কোড সেটিংস অ্যাকশন কোড সেটিংস অ্যাকশন কোড সেটিংস। উল্লেখ করা থাকলে, স্টেট/কন্টিনিউ ইউআরএল ইমেল যাচাইকরণ লিঙ্কে "continueUrl" প্যারামিটার হিসেবে সেট করা হয়। ডিফল্ট ইমেল যাচাইকরণ ল্যান্ডিং পৃষ্ঠাটি ইনস্টল করা থাকলে অ্যাপটিতে ফিরে যাওয়ার জন্য একটি লিঙ্ক প্রদর্শন করতে এটি ব্যবহার করবে। যদি actionCodeSettings নির্দিষ্ট করা না থাকে, তাহলে অ্যাকশন URL-এ কোনো URL যুক্ত করা হয় না। প্রদত্ত স্টেট ইউআরএলটি অবশ্যই একটি ডোমেনের অন্তর্গত হতে হবে যা কনসোলে ডেভেলপার দ্বারা সাদাতালিকাভুক্ত। অন্যথায় একটি ত্রুটি নিক্ষেপ করা হয়. মোবাইল অ্যাপ রিডাইরেক্ট শুধুমাত্র তখনই প্রযোজ্য যদি ডেভেলপার Firebase ডায়নামিক লিঙ্কের পরিষেবার শর্তাবলী কনফিগার করে এবং গ্রহণ করে। Android প্যাকেজের নাম এবং iOS বান্ডেল আইডি শুধুমাত্র তখনই সম্মান করা হয় যদি সেগুলি একই Firebase Auth প্রোজেক্টে কনফিগার করা থাকে।

রিটার্ন:

প্রতিশ্রুতি<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>;

পরামিতি

প্যারামিটার টাইপ বর্ণনা
ইমেইল স্ট্রিং বর্তমান ইমেল অ্যাকাউন্ট।
নতুন ইমেইল স্ট্রিং অ্যাকাউন্টটি যে ইমেল ঠিকানায় আপডেট করা হচ্ছে।
অ্যাকশন কোড সেটিংস অ্যাকশন কোড সেটিংস অ্যাকশন কোড সেটিংস। উল্লেখ করা থাকলে, স্টেট/কন্টিনিউ ইউআরএল ইমেল যাচাইকরণ লিঙ্কে "continueUrl" প্যারামিটার হিসেবে সেট করা হয়। ডিফল্ট ইমেল যাচাইকরণ ল্যান্ডিং পৃষ্ঠাটি ইনস্টল করা থাকলে অ্যাপটিতে ফিরে যাওয়ার জন্য একটি লিঙ্ক প্রদর্শন করতে এটি ব্যবহার করবে। যদি actionCodeSettings নির্দিষ্ট করা না থাকে, তাহলে অ্যাকশন URL-এ কোনো URL যুক্ত করা হয় না। প্রদত্ত স্টেট URL অবশ্যই একটি ডোমেনের অন্তর্গত হতে হবে যা কনসোলে অনুমোদিত, নতুবা একটি ত্রুটি নিক্ষেপ করা হবে৷ মোবাইল অ্যাপ রিডাইরেক্ট শুধুমাত্র তখনই প্রযোজ্য যদি ডেভেলপার Firebase ডায়নামিক লিঙ্কের পরিষেবার শর্তাবলী কনফিগার করে এবং গ্রহণ করে। Android প্যাকেজের নাম এবং iOS বান্ডেল আইডি শুধুমাত্র তখনই সম্মান করা হয় যদি সেগুলি একই Firebase Auth প্রোজেক্টে কনফিগার করা থাকে।

রিটার্ন:

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

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

BaseAuth.getProviderConfig()

প্রদত্ত আইডি দ্বারা একটি প্রমাণ প্রদানকারী কনফিগারেশন সন্ধান করে৷ একটি প্রতিশ্রুতি প্রদান করে যা নির্দিষ্ট প্রদানকারী আইডির সাথে সংশ্লিষ্ট প্রদানকারী কনফিগারেশনের সাথে সমাধান করে। যদি নির্দিষ্ট আইডিটি বিদ্যমান না থাকে, একটি auth/configuration-not-found ত্রুটি নিক্ষেপ করা হয়।

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

স্বাক্ষর:

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

পরামিতি

প্যারামিটার টাইপ বর্ণনা
প্রদানকারী আইডি স্ট্রিং প্রদানকারী আইডি প্রদানকারীর কনফিগারেশনের সাথে সম্পর্কিত।

রিটার্ন:

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

একটি প্রতিশ্রুতি যা প্রদত্ত আইডির সাথে সম্পর্কিত কনফিগারেশনের সাথে সমাধান করে।

BaseAuth.getUser()

একটি প্রদত্ত uid সাথে সংশ্লিষ্ট ব্যবহারকারীর জন্য ব্যবহারকারীর ডেটা পায় .

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

স্বাক্ষর:

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

পরামিতি

প্যারামিটার টাইপ বর্ণনা
uid স্ট্রিং যে ব্যবহারকারীর ডেটা আনতে হবে তার সাথে সংশ্লিষ্ট uid

রিটার্ন:

প্রতিশ্রুতি< ব্যবহারকারীর রেকর্ড >

প্রদত্ত uid সাথে সংশ্লিষ্ট ব্যবহারকারীর ডেটার সাথে পূর্ণ একটি প্রতিশ্রুতি .

BaseAuth.getUserByEmail()

প্রদত্ত ইমেলের সাথে সংশ্লিষ্ট ব্যবহারকারীর জন্য ব্যবহারকারীর ডেটা পায়।

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

স্বাক্ষর:

getUserByEmail(email: string): Promise<UserRecord>;

পরামিতি

প্যারামিটার টাইপ বর্ণনা
ইমেইল স্ট্রিং ব্যবহারকারীর সাথে সম্পর্কিত ইমেল যার ডেটা আনতে হবে৷

রিটার্ন:

প্রতিশ্রুতি< ব্যবহারকারীর রেকর্ড >

প্রদত্ত ইমেলের সাথে সংশ্লিষ্ট ব্যবহারকারীর ডেটার সাথে পূর্ণ একটি প্রতিশ্রুতি।

BaseAuth.getUserByPhoneNumber()

একটি প্রদত্ত ফোন নম্বরের সাথে সংশ্লিষ্ট ব্যবহারকারীর জন্য ব্যবহারকারীর ডেটা পায়। ফোন নম্বরটিকে E.164 স্পেসিফিকেশন মেনে চলতে হবে।

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

স্বাক্ষর:

getUserByPhoneNumber(phoneNumber: string): Promise<UserRecord>;

পরামিতি

প্যারামিটার টাইপ বর্ণনা
ফোন নম্বর স্ট্রিং ফোন নম্বর যে ব্যবহারকারীর ডেটা আনতে হবে তার সাথে সংশ্লিষ্ট।

রিটার্ন:

প্রতিশ্রুতি< ব্যবহারকারীর রেকর্ড >

প্রদত্ত ফোন নম্বরের সাথে সংশ্লিষ্ট ব্যবহারকারীর ডেটার সাথে পূর্ণ একটি প্রতিশ্রুতি।

BaseAuth.getUserByProviderUid()

একটি প্রদত্ত প্রদানকারী আইডির সাথে সংশ্লিষ্ট ব্যবহারকারীর জন্য ব্যবহারকারীর ডেটা পায়।

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

স্বাক্ষর:

getUserByProviderUid(providerId: string, uid: string): Promise<UserRecord>;

পরামিতি

প্যারামিটার টাইপ বর্ণনা
প্রদানকারী আইডি স্ট্রিং প্রদানকারী আইডি, উদাহরণস্বরূপ, Google প্রদানকারীর জন্য "google.com"।
uid স্ট্রিং প্রদত্ত প্রদানকারীর জন্য ব্যবহারকারী শনাক্তকারী।

রিটার্ন:

প্রতিশ্রুতি< ব্যবহারকারীর রেকর্ড >

প্রদত্ত প্রদানকারী আইডির সাথে সংশ্লিষ্ট ব্যবহারকারীর ডেটার সাথে একটি প্রতিশ্রুতি পূরণ করা হয়েছে।

BaseAuth.getUsers()

নির্দিষ্ট শনাক্তকারীর সাথে সংশ্লিষ্ট ব্যবহারকারীর ডেটা পায়।

কোন অর্ডার গ্যারান্টি নেই; বিশেষ করে, ফলাফল তালিকার nম এন্ট্রি ইনপুট পরামিতি তালিকার nম এন্ট্রির সাথে সঙ্গতিপূর্ণ হওয়ার নিশ্চয়তা নেই৷

শুধুমাত্র সর্বাধিক 100 শনাক্তকারী সরবরাহ করা যেতে পারে। যদি 100 টির বেশি শনাক্তকারী সরবরাহ করা হয়, এই পদ্ধতিটি একটি FirebaseAuthError নিক্ষেপ করে।

স্বাক্ষর:

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

পরামিতি

প্যারামিটার টাইপ বর্ণনা
শনাক্তকারী ব্যবহারকারী সনাক্তকারী [] কোন ব্যবহারকারীর রেকর্ড ফেরত দেওয়া উচিত তা নির্দেশ করতে ব্যবহৃত শনাক্তকারী। 100 টির বেশি এন্ট্রি থাকা উচিত নয়।

রিটার্ন:

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

একটি প্রতিশ্রুতি যা সংশ্লিষ্ট ব্যবহারকারীর রেকর্ডের সমাধান করে।

ব্যতিক্রম

FirebaseAuthError যদি কোনো শনাক্তকারী অবৈধ হয় বা 100 টির বেশি শনাক্তকারী নির্দিষ্ট করা থাকে।

BaseAuth.importUsers()

Firebase Auth-এ ব্যবহারকারীদের প্রদত্ত তালিকা আমদানি করে। সর্বাধিক 1000 ব্যবহারকারীকে একবারে আমদানি করার অনুমতি দেওয়া হয়। পাসওয়ার্ড সহ ব্যবহারকারীদের আমদানি করার সময়, UserImportOptions নির্দিষ্ট করা প্রয়োজন৷ এই ক্রিয়াকলাপটি বাল্ক আমদানির জন্য অপ্টিমাইজ করা হয়েছে এবং uid এর চেকগুলিকে উপেক্ষা করবে৷ , email এবং অন্যান্য শনাক্তকারী স্বতন্ত্রতা যার ফলে ডুপ্লিকেশন হতে পারে।

স্বাক্ষর:

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

পরামিতি

প্যারামিটার টাইপ বর্ণনা
ব্যবহারকারীদের UserImportRecord [] Firebase Auth-এ আমদানি করার জন্য ব্যবহারকারীর রেকর্ডের তালিকা।
বিকল্প UserImportOptions ব্যবহারকারী আমদানির বিকল্প, যখন ব্যবহারকারীরা পাসওয়ার্ড শংসাপত্র অন্তর্ভুক্ত করে তখন প্রয়োজনীয়।

রিটার্ন:

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

একটি প্রতিশ্রুতি যা আমদানির ফলাফলের সাথে অপারেশন সম্পূর্ণ হলে সমাধান করে। এতে সফল আমদানির সংখ্যা, ব্যর্থ আমদানির সংখ্যা এবং তাদের সংশ্লিষ্ট ত্রুটি অন্তর্ভুক্ত রয়েছে।

BaseAuth.listProviderConfigs()

প্রদত্ত ফিল্টারের সাথে মেলে বিদ্যমান প্রদানকারী কনফিগারেশনের তালিকা প্রদান করে। সর্বাধিক, 100টি প্রদানকারী কনফিগার একবারে তালিকাভুক্ত করা যেতে পারে।

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

স্বাক্ষর:

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

পরামিতি

প্যারামিটার টাইপ বর্ণনা
বিকল্প AuthProviderConfigFilter প্রয়োগ করার জন্য প্রদানকারী কনফিগার ফিল্টার।

রিটার্ন:

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

একটি প্রতিশ্রুতি যা ফিল্টারের প্রয়োজনীয়তা পূরণকারী প্রদানকারী কনফিগারগুলির তালিকার সাথে সমাধান করে।

BaseAuth.listUsers()

pageToken দ্বারা নির্দিষ্ট করা অফসেট থেকে শুরু করে maxResults আকার সহ ব্যবহারকারীদের একটি তালিকা (শুধুমাত্র একক ব্যাচ) পুনরুদ্ধার করে . এটি ব্যাচগুলিতে একটি নির্দিষ্ট প্রকল্পের সমস্ত ব্যবহারকারীকে পুনরুদ্ধার করতে ব্যবহৃত হয়।

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

স্বাক্ষর:

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

পরামিতি

প্যারামিটার টাইপ বর্ণনা
সর্বোচ্চ ফলাফল সংখ্যা পৃষ্ঠার আকার, 1000 যদি অনির্ধারিত থাকে। এটিও সর্বাধিক অনুমোদিত সীমা।
পেজ টোকেন স্ট্রিং পরের পাতা টোকেন. নির্দিষ্ট করা না থাকলে, কোনো অফসেট ছাড়াই শুরু করে ব্যবহারকারীদের ফেরত দেয়।

রিটার্ন:

প্রতিশ্রুতি< তালিকা ব্যবহারকারীর ফলাফল >

একটি প্রতিশ্রুতি যা ডাউনলোড করা ব্যবহারকারীদের বর্তমান ব্যাচ এবং পরবর্তী পৃষ্ঠা টোকেনের সাথে সমাধান করে।

BaseAuth.revokeRefreshTokens()

একটি বিদ্যমান ব্যবহারকারীর জন্য সমস্ত রিফ্রেশ টোকেন প্রত্যাহার করে৷

এই API ব্যবহারকারীর UserRecord.tokensValidAfterTime বর্তমান UTC-তে আপডেট করবে। এটি গুরুত্বপূর্ণ যে সার্ভারে এটি বলা হয় তার ঘড়িটি সঠিকভাবে সেট করা এবং সিঙ্ক্রোনাইজ করা হয়েছে৷

যদিও এটি একটি নির্দিষ্ট ব্যবহারকারীর জন্য সমস্ত সেশন প্রত্যাহার করবে এবং বিদ্যমান সেশনগুলির জন্য যেকোন নতুন আইডি টোকেনকে মিন্ট করা থেকে নিষ্ক্রিয় করবে, বিদ্যমান আইডি টোকেনগুলি তাদের স্বাভাবিক মেয়াদ শেষ না হওয়া পর্যন্ত সক্রিয় থাকতে পারে (এক ঘন্টা)। আইডি টোকেনগুলি প্রত্যাহার করা হয়েছে তা যাচাই করতে, 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 .
কাস্টম ইউজার দাবি বস্তু | খালি ডেভেলপার সেট করার দাবি করে। যদি নাল পাস হয়, বিদ্যমান কাস্টম দাবি মুছে ফেলা হয়। 1000 বাইটের থেকে বড় একটি কাস্টম দাবি পেলোড পাস করলে একটি ত্রুটি হবে৷ কাস্টম দাবিগুলি ব্যবহারকারীর আইডি টোকেনে যোগ করা হয় যা প্রতিটি প্রমাণীকৃত অনুরোধে প্রেরণ করা হয়। প্রোফাইল অ-অ্যাক্সেস সম্পর্কিত ব্যবহারকারীর বৈশিষ্ট্যগুলির জন্য, ডাটাবেস বা অন্যান্য পৃথক স্টোরেজ সিস্টেম ব্যবহার করুন।

রিটার্ন:

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

একটি প্রতিশ্রুতি যা সমাধান করে যখন অপারেশন সফলভাবে সম্পন্ন হয়।

BaseAuth.updateProviderConfig()

একটি প্রতিশ্রুতি প্রদান করে যা নির্দিষ্ট প্রদানকারী আইডির সাথে সম্পর্কিত আপডেট করা AuthProviderConfig এর সাথে সমাধান করে। যদি নির্দিষ্ট আইডিটি বিদ্যমান না থাকে, একটি auth/configuration-not-found ত্রুটি নিক্ষেপ করা হয়।

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

স্বাক্ষর:

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

পরামিতি

প্যারামিটার টাইপ বর্ণনা
প্রদানকারী আইডি স্ট্রিং আপডেট করার জন্য প্রদানকারীর কনফিগারেশনের সাথে সংশ্লিষ্ট প্রদানকারী আইডি।
আপডেট করা কনফিগ UpdateAuthProviderRequest আপডেট করা কনফিগারেশন।

রিটার্ন:

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

একটি প্রতিশ্রুতি যা আপডেট করা প্রদানকারী কনফিগারেশনের সাথে সমাধান করে।

BaseAuth.updateUser()

একটি বিদ্যমান ব্যবহারকারী আপডেট করে।

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

স্বাক্ষর:

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

পরামিতি

প্যারামিটার টাইপ বর্ণনা
uid স্ট্রিং আপডেট করার জন্য ব্যবহারকারীর সাথে সংশ্লিষ্ট uid .
বৈশিষ্ট্য আপডেটের অনুরোধ প্রদত্ত ব্যবহারকারীর উপর আপডেট করার বৈশিষ্ট্য।

রিটার্ন:

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

আপডেট করা ব্যবহারকারীর ডেটার সাথে একটি প্রতিশ্রুতি পূরণ হয়েছে।

BaseAuth.verifyIdToken()

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

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

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

স্বাক্ষর:

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

পরামিতি

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

রিটার্ন:

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

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

BaseAuth.verifySessionCookie()

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

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

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

স্বাক্ষর:

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

পরামিতি

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

রিটার্ন:

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

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