MultiFactorUser interface

एक इंटरफ़ेस जो उपयोगकर्ता से संबंधित बहु-कारक संबंधित गुणों और संचालन को परिभाषित करता है .

हस्ताक्षर:

export interface MultiFactorUser 

गुण

तरीकों

MultiFactorUser.नामांकितFactors

उपयोगकर्ता के नामांकित दूसरे कारकों की एक सूची लौटाता है।

हस्ताक्षर:

readonly enrolledFactors: MultiFactorInfo[];

मल्टीफैक्टरयूजर.एनरोल()

उपयोगकर्ता के लिए MultiFactorAssertion द्वारा पहचाने गए दूसरे कारक को नामांकित करता है।

रिज़ॉल्यूशन पर, JWT पेलोड में परिवर्तन को प्रतिबिंबित करने के लिए उपयोगकर्ता टोकन अपडेट किए जाते हैं। अंतिम उपयोगकर्ता के लिए दूसरे कारक की पहचान करने के लिए उपयोग किए जाने वाले अतिरिक्त प्रदर्शन नाम पैरामीटर को स्वीकार करता है। इस ऑपरेशन के सफल होने के लिए हाल ही में पुनः प्रमाणीकरण की आवश्यकता है। सफल नामांकन पर, मौजूदा फायरबेस सत्र (रीफ्रेश टोकन) रद्द कर दिए जाते हैं। जब कोई नया कारक नामांकित होता है, तो उपयोगकर्ता के ईमेल पर एक ईमेल अधिसूचना भेजी जाती है।

हस्ताक्षर:

enroll(assertion: MultiFactorAssertion, displayName?: string | null): Promise<void>;

पैरामीटर

रिटर्न:

वादा<शून्य>

उदाहरण

const multiFactorUser = multiFactor(auth.currentUser);
const multiFactorSession = await multiFactorUser.getSession();

// Send verification code.
const phoneAuthProvider = new PhoneAuthProvider(auth);
const phoneInfoOptions = {
  phoneNumber: phoneNumber,
  session: multiFactorSession
};
const verificationId = await phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, appVerifier);

// Obtain verification code from user.
const phoneAuthCredential = PhoneAuthProvider.credential(verificationId, verificationCode);
const multiFactorAssertion = PhoneMultiFactorGenerator.assertion(phoneAuthCredential);
await multiFactorUser.enroll(multiFactorAssertion);
// Second factor enrolled.

MultiFactorUser.getSession()

दूसरे कारक नामांकन ऑपरेशन के लिए सत्र पहचानकर्ता लौटाता है। इसका उपयोग दूसरे कारक को नामांकित करने का प्रयास करने वाले उपयोगकर्ता की पहचान करने के लिए किया जाता है।

हस्ताक्षर:

getSession(): Promise<MultiFactorSession>;

रिटर्न:

वादा< मल्टीफ़ैक्टरसेशन >

वह वादा जो मल्टीफ़ैक्टर सेशन के साथ हल होता है .

उदाहरण

const multiFactorUser = multiFactor(auth.currentUser);
const multiFactorSession = await multiFactorUser.getSession();

// Send verification code.
const phoneAuthProvider = new PhoneAuthProvider(auth);
const phoneInfoOptions = {
  phoneNumber: phoneNumber,
  session: multiFactorSession
};
const verificationId = await phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, appVerifier);

// Obtain verification code from user.
const phoneAuthCredential = PhoneAuthProvider.credential(verificationId, verificationCode);
const multiFactorAssertion = PhoneMultiFactorGenerator.assertion(phoneAuthCredential);
await multiFactorUser.enroll(multiFactorAssertion);

MultiFactorUser.unenroll()

निर्दिष्ट दूसरे कारक का नामांकन रद्द करता है।

हटाए जाने वाले कारक को निर्दिष्ट करने के लिए, एक मल्टीफैक्टरइन्फो ऑब्जेक्ट पास करें ( मल्टीफैक्टरयूजर.एनरोलडफैक्टर्स से प्राप्त) ) या कारक की यूआईडी स्ट्रिंग। खाता अनियंत्रित होने पर सत्र रद्द नहीं किया जाता है। उपयोगकर्ता को परिवर्तन की सूचना देने के लिए एक ईमेल अधिसूचना भेजे जाने की संभावना है। इस ऑपरेशन के सफल होने के लिए हाल ही में पुनः प्रमाणीकरण की आवश्यकता है। जब कोई मौजूदा कारक नामांकित नहीं होता है, तो उपयोगकर्ता के ईमेल पर एक ईमेल अधिसूचना भेजी जाती है।

हस्ताक्षर:

unenroll(option: MultiFactorInfo | string): Promise<void>;

पैरामीटर

रिटर्न:

वादा<शून्य>

• एक Promise जो नामांकन रद्द करने की कार्रवाई पूरी होने पर हल हो जाता है।

उदाहरण

const multiFactorUser = multiFactor(auth.currentUser);
// Present user the option to choose which factor to unenroll.
await multiFactorUser.unenroll(multiFactorUser.enrolledFactors[i])