इस दस्तावेज़ में, प्रोग्राम के हिसाब से मल्टी-फ़ैक्टर ऑथेंटिकेशन का इस्तेमाल करने वाले उपयोगकर्ताओं को मैनेज करने के लिए, Firebase Admin SDK का इस्तेमाल करने का तरीका बताया गया है. मल्टी-फ़ैक्टर ऑथेंटिकेशन का इस्तेमाल करने वाले उपयोगकर्ताओं को मैनेज करते समय, आपके पास सिंगल-फ़ैक्टर ऑथेंटिकेशन का इस्तेमाल करने वाले उपयोगकर्ताओं की तुलना में, उपयोगकर्ता प्रॉपर्टी की ज़्यादा रेंज का ऐक्सेस होता है.
शुरू करने से पहले
Node.js Admin SDK इंस्टॉल करें. फ़िलहाल, अन्य Admin SDK भाषाओं में यह सुविधा उपलब्ध नहीं है.
उपयोगकर्ता हासिल करना
UserRecord
ऑब्जेक्ट से, उपयोगकर्ता के मल्टी-फ़ैक्टर ऑथेंटिकेशन से जुड़ा डेटा वापस पाया जा सकता है. जैसे, रजिस्टर किए गए दूसरे फ़ैक्टर की सूची. उपयोगकर्ता का रिकॉर्ड पाने के लिए, getUser()
या getUserByEmail()
को कॉल करें.
यहां दिए गए उदाहरण में, मल्टी-फ़ैक्टर ऑथेंटिकेशन के लिए रजिस्टर किए गए उपयोगकर्ता को दिखाया गया है:
// console.log(userRecord.toJSON());
{
uid: 'some-uid',
displayName: 'John Doe',
email: 'johndoe@gmail.com',
photoURL: 'http://www.example.com/12345678/photo.png',
emailVerified: true,
phoneNumber: '+11234567890',
// Set this user as admin.
customClaims: {admin: true},
// User with Google provider.
providerData: [{
uid: 'google-uid',
email: 'johndoe@gmail.com',
displayName: 'John Doe',
photoURL: 'http://www.example.com/12345678/photo.png',
providerId: 'google.com'
}],
multiFactor: {
enrolledFactors: [
// 2FA with SMS as 2nd factor.
{
uid: '53HG4HG45HG8G04GJ40J4G3J',
phoneNumber: '+16505551234',
displayName: 'Work phone',
enrollmentTime: 'Fri, 22 Sep 2017 01:49:58 GMT',
factorId: 'phone',
},
],
},
};
उपयोगकर्ताओं की सूची बनाना
नीचे दिए गए कोड में, सभी उपयोगकर्ताओं की सूची बनाने और यह देखने का तरीका बताया गया है कि उन्होंने दूसरा फ़ैक्टर रजिस्टर किया है या नहीं:
admin.auth().listUsers(1000, nextPageToken)
.then((listUsersResult) => {
listUsersResult.users.forEach((userRecord) => {
// Multi-factor enrolled users second factors can be retrieved via:
if (userRecord.multiFactor) {
userRecord.multiFactor.enrolledFactors.forEach((enrolledFactor) => {
console.log(userRecord.uid, enrolledFactor.toJSON());
});
}
});
})
.catch((error) => {
console.log('Error listing users:', error);
});
उपयोगकर्ताओं को बैच में दिखाया जाता है. इन्हें उनके uid
के हिसाब से क्रम में लगाया जाता है. नतीजों के हर बैच में, उपयोगकर्ताओं की सूची होती है. साथ ही, इसमें अगला पेज टोकन होता है, जिसका इस्तेमाल अगले बैच को फ़ेच करने के लिए किया जाता है.
जब सभी उपयोगकर्ताओं को सूची में शामिल कर लिया जाता है, तो कोई pageToken
नहीं मिलता.
maxResult
फ़ील्ड, बैच के ज़्यादा से ज़्यादा साइज़ के बारे में बताता है. डिफ़ॉल्ट और ज़्यादा से ज़्यादा वैल्यू 1,000 है.
उपयोगकर्ता बनाना
नया उपयोगकर्ता बनाने के लिए, createUser()
को कॉल करें. दूसरे चरण की पुष्टि करने वाले नए उपयोगकर्ताओं के लिए, यह ज़रूरी है कि उनके पास पुष्टि किया गया ईमेल पता हो (emailVerified
को true
पर सेट किया गया हो). साथ ही, साइन इन करने के लिए, पहले चरण की पुष्टि करने वाले टूल का इस्तेमाल किया गया हो. हर उपयोगकर्ता के लिए, पुष्टि करने के पांच सेकंडरी फ़ैक्टर इस्तेमाल किए जा सकते हैं.
इस उदाहरण में, दो सेकंडरी फ़ैक्टर के साथ नया उपयोगकर्ता बनाने का तरीका दिखाया गया है:
admin.auth().createUser({
uid: '123456789',
email: 'user@example.com',
emailVerified: true,
password: 'password',
multiFactor: {
enrolledFactors: [
// When creating users with phone second factors, the uid and
// enrollmentTime should not be specified. These will be provisioned by
// the Auth server.
// Primary second factor.
{
phoneNumber: '+16505550001',
displayName: 'Corp phone',
factorId: 'phone',
},
// Backup second factor.
{
phoneNumber: '+16505550002',
displayName: 'Personal phone',
factorId: 'phone'
},
],
},
})
.then((userRecord) => {
console.log(userRecord.multiFactor.enrolledFactors);
})
.catch((error) => {
console.log(error);
});
किसी उपयोगकर्ता की जानकारी अपडेट करना
किसी मौजूदा उपयोगकर्ता की जानकारी अपडेट करने के लिए, updateUser()
को कॉल करें:
admin.auth().updateUser(uid: '123456789', {
multiFactor: {
enrolledFactors: [
{
// uid will be auto-generated.
phoneNumber: '+16505550003',
displayName: 'Spouse\'s phone',
factorId: 'phone',
},
{
// uid can also be specified. This is useful if a new second factor is added and an
// existing enrolled second factor is kept unmodified.
uid: 'existing-enrolled-mfa-uid',
phoneNumber: '+16505550004',
displayName: 'Personal phone',
factorId: 'phone',
},
{
phoneNumber: '+16505550005',
displayName: 'Backup phone',
factorId: 'phone',
// Enrollment time can also be explicitly specified.
enrollmentTime: new Date().toUTCString(),
},
],
},
})
.then((userRecord) => {
console.log(userRecord.multiFactor.enrolledFactors);
})
.catch((error) => {
console.log(error);
});
पुष्टि करने का नया सेकंडरी तरीका जोड़ना
enrolledFactors
की सूची के साथ updateUser()
को कॉल करने पर, उपयोगकर्ता के मौजूदा सेकंडरी फ़ैक्टर मिट जाएंगे. मौजूदा सेकंडरी फ़ैक्टर को बनाए रखते हुए, नया सेकंडरी फ़ैक्टर जोड़ने के लिए, पहले उपयोगकर्ता को ढूंढें. इसके बाद, सूची में नया फ़ैक्टर जोड़ें:
function enrollSecondFactor(userId, secondFactorPhoneNumber, secondFactorDisplayName) {
return admin.auth().getUser(userId)
.then((userRecord) => {
const updatedList = (userRecord.multiFactor &&
userRecord.multiFactor.toJSON().enrolledFactors) || [];
updatedList.push({
phoneNumber: secondFactorPhoneNumber,
displayName: secondFactorDisplayName,
factorId: 'phone',
});
return admin.auth().updateUser(userRecord.uid, {
multiFactor: {
enrolledFactors: updatedList,
},
});
})
.catch((error) => {
console.log(error);
});
}
पुष्टि करने का दूसरा तरीका हटाना
किसी उपयोगकर्ता को कई चरणों में पुष्टि करने की सुविधा से पूरी तरह से हटाने के लिए, enrolledFactors
को null
या खाली कलेक्शन के तौर पर सेट करें:
admin.auth().updateUser(uid: '123456789', {
multiFactor: {
enrolledFactors: null,
},
})
.then((userRecord) => {
console.log(userRecord.multiFactor);
})
.catch((error) => {
console.log(error);
});