उपयोगकर्ताओं को मैनेज करें

फायरबेस एडमिन एसडीके आपके फायरबेस प्रमाणीकरण उपयोगकर्ताओं को उन्नत विशेषाधिकारों के साथ प्रबंधित करने के लिए एक एपीआई प्रदान करता है। व्यवस्थापक उपयोगकर्ता प्रबंधन एपीआई आपको सुरक्षित सर्वर वातावरण से निम्नलिखित कार्यों को प्रोग्रामेटिक रूप से पूरा करने की क्षमता देता है:

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

शुरू करने से पहले

फायरबेस एडमिन एसडीके द्वारा प्रदान किए गए उपयोगकर्ता प्रबंधन एपीआई का उपयोग करने के लिए, आपके पास एक सेवा खाता होना चाहिए। एडमिन एसडीके को आरंभ करने के तरीके के बारे में अधिक जानकारी के लिए सेटअप निर्देशों का पालन करें।

उपयोगकर्ता डेटा पुनर्प्राप्त करें

किसी उपयोगकर्ता को पहचानने का प्राथमिक तरीका उनका uid है, जो उस उपयोगकर्ता के लिए एक विशिष्ट पहचानकर्ता है। एडमिन एसडीके एक ऐसी विधि प्रदान करता है जो उपयोगकर्ताओं की प्रोफ़ाइल जानकारी को उनके uid द्वारा प्राप्त करने की अनुमति देता है:

नोड.जे.एस

getAuth()
  .getUser(uid)
  .then((userRecord) => {
    // See the UserRecord reference doc for the contents of userRecord.
    console.log(`Successfully fetched user data: ${userRecord.toJSON()}`);
  })
  .catch((error) => {
    console.log('Error fetching user data:', error);
  });

जावा

UserRecord userRecord = FirebaseAuth.getInstance().getUser(uid);
// See the UserRecord reference doc for the contents of userRecord.
System.out.println("Successfully fetched user data: " + userRecord.getUid());

अजगर

from firebase_admin import auth

user = auth.get_user(uid)
print('Successfully fetched user data: {0}'.format(user.uid))

जाना

// Get an auth client from the firebase.App
client, err := app.Auth(ctx)
if err != nil {
	log.Fatalf("error getting Auth client: %v\n", err)
}

u, err := client.GetUser(ctx, uid)
if err != nil {
	log.Fatalf("error getting user %s: %v\n", uid, err)
}
log.Printf("Successfully fetched user data: %v\n", u)

सी#

UserRecord userRecord = await FirebaseAuth.DefaultInstance.GetUserAsync(uid);
// See the UserRecord reference doc for the contents of userRecord.
Console.WriteLine($"Successfully fetched user data: {userRecord.Uid}");

यह विधि विधि को प्रदान की गई uid के अनुरूप उपयोगकर्ता के लिए एक UserRecord ऑब्जेक्ट लौटाती है।

यदि प्रदान किया गया uid किसी मौजूदा उपयोगकर्ता से संबंधित नहीं है या उपयोगकर्ता को किसी अन्य कारण से प्राप्त नहीं किया जा सकता है, तो उपरोक्त विधि एक त्रुटि उत्पन्न करती है। विवरण और समाधान चरणों सहित त्रुटि कोड की पूरी सूची के लिए, एडमिन ऑथ एपीआई त्रुटियां देखें।

कुछ मामलों में आपके पास उपयोगकर्ता की uid के बजाय उसका ईमेल होगा। फायरबेस एडमिन एसडीके ईमेल के जरिए उपयोगकर्ता की जानकारी देखने का समर्थन करता है:

नोड.जे.एस

getAuth()
  .getUserByEmail(email)
  .then((userRecord) => {
    // See the UserRecord reference doc for the contents of userRecord.
    console.log(`Successfully fetched user data: ${userRecord.toJSON()}`);
  })
  .catch((error) => {
    console.log('Error fetching user data:', error);
  });

जावा

UserRecord userRecord = FirebaseAuth.getInstance().getUserByEmail(email);
// See the UserRecord reference doc for the contents of userRecord.
System.out.println("Successfully fetched user data: " + userRecord.getEmail());

अजगर

from firebase_admin import auth

user = auth.get_user_by_email(email)
print('Successfully fetched user data: {0}'.format(user.uid))

जाना

u, err := client.GetUserByEmail(ctx, email)
if err != nil {
	log.Fatalf("error getting user by email %s: %v\n", email, err)
}
log.Printf("Successfully fetched user data: %v\n", u)

सी#

UserRecord userRecord = await FirebaseAuth.DefaultInstance.GetUserByEmailAsync(email);
// See the UserRecord reference doc for the contents of userRecord.
Console.WriteLine($"Successfully fetched user data: {userRecord.Uid}");

यह विधि उपयोगकर्ता के लिए दिए गए ईमेल के अनुरूप एक UserRecord ऑब्जेक्ट लौटाती है।

यदि प्रदान किया गया ईमेल किसी मौजूदा उपयोगकर्ता से संबंधित नहीं है या उपयोगकर्ता को किसी अन्य कारण से प्राप्त नहीं किया जा सकता है, तो व्यवस्थापक एसडीके एक त्रुटि देता है। विवरण और समाधान चरणों सहित त्रुटि कोड की पूरी सूची के लिए, व्यवस्थापक प्रमाणीकरण एपीआई त्रुटियां देखें।

अन्य मामलों में, आपके पास उपयोगकर्ता के uid के बजाय उसका फ़ोन नंबर होगा। फायरबेस एडमिन एसडीके फोन नंबर के साथ उपयोगकर्ता की जानकारी देखने का समर्थन करता है:

नोड.जे.एस

getAuth()
  .getUserByPhoneNumber(phoneNumber)
  .then((userRecord) => {
    // See the UserRecord reference doc for the contents of userRecord.
    console.log(`Successfully fetched user data:  ${userRecord.toJSON()}`);
  })
  .catch((error) => {
    console.log('Error fetching user data:', error);
  });

जावा

UserRecord userRecord = FirebaseAuth.getInstance().getUserByPhoneNumber(phoneNumber);
// See the UserRecord reference doc for the contents of userRecord.
System.out.println("Successfully fetched user data: " + userRecord.getPhoneNumber());

अजगर

from firebase_admin import auth

user = auth.get_user_by_phone_number(phone)
print('Successfully fetched user data: {0}'.format(user.uid))

जाना

u, err := client.GetUserByPhoneNumber(ctx, phone)
if err != nil {
	log.Fatalf("error getting user by phone %s: %v\n", phone, err)
}
log.Printf("Successfully fetched user data: %v\n", u)

सी#

UserRecord userRecord = await FirebaseAuth.DefaultInstance.GetUserByPhoneNumberAsync(phoneNumber);
// See the UserRecord reference doc for the contents of userRecord.
Console.WriteLine($"Successfully fetched user data: {userRecord.Uid}");

यह विधि उपयोगकर्ता के लिए दिए गए फ़ोन नंबर के अनुरूप एक UserRecord ऑब्जेक्ट लौटाती है।

यदि प्रदान किया गया फ़ोन नंबर किसी मौजूदा उपयोगकर्ता का नहीं है या उपयोगकर्ता को किसी अन्य कारण से प्राप्त नहीं किया जा सकता है, तो व्यवस्थापक SDK एक त्रुटि देता है। विवरण और समाधान चरणों सहित त्रुटि कोड की पूरी सूची के लिए, व्यवस्थापक प्रमाणीकरण एपीआई त्रुटियां देखें।

उपयोगकर्ता डेटा को थोक में पुनर्प्राप्त करें

फायरबेस एडमिन एसडीके आपके द्वारा प्रदान किए गए पहचानकर्ताओं के आधार पर उपयोगकर्ताओं की एक सूची पुनर्प्राप्त करने की भी अनुमति देता है। आप उपयोगकर्ताओं को उनकी उपयोगकर्ता आईडी, ईमेल या फ़ोन नंबर से पहचान सकते हैं। एक कॉल में अधिकतम 100 पहचानकर्ता प्रदान किए जा सकते हैं। पहचानकर्ताओं में विभिन्न प्रकार के मिश्रण हो सकते हैं:

नोड.जे.एस

getAuth()
  .getUsers([
    { uid: 'uid1' },
    { email: 'user2@example.com' },
    { phoneNumber: '+15555550003' },
    { providerId: 'google.com', providerUid: 'google_uid4' },
  ])
  .then((getUsersResult) => {
    console.log('Successfully fetched user data:');
    getUsersResult.users.forEach((userRecord) => {
      console.log(userRecord);
    });

    console.log('Unable to find users corresponding to these identifiers:');
    getUsersResult.notFound.forEach((userIdentifier) => {
      console.log(userIdentifier);
    });
  })
  .catch((error) => {
    console.log('Error fetching user data:', error);
  });

जावा

GetUsersResult result = FirebaseAuth.getInstance().getUsersAsync(Arrays.asList(
    new UidIdentifier("uid1"),
    new EmailIdentifier("user2@example.com"),
    new PhoneIdentifier("+15555550003"),
    new ProviderIdentifier("google.com", "google_uid4"))).get();

System.out.println("Successfully fetched user data:");
for (UserRecord user : result.getUsers()) {
  System.out.println(user.getUid());
}

System.out.println("Unable to find users corresponding to these identifiers:");
for (UserIdentifier uid : result.getNotFound()) {
  System.out.println(uid);
}

अजगर

from firebase_admin import auth

result = auth.get_users([
    auth.UidIdentifier('uid1'),
    auth.EmailIdentifier('user2@example.com'),
    auth.PhoneIdentifier(+15555550003),
    auth.ProviderIdentifier('google.com', 'google_uid4')
])

print('Successfully fetched user data:')
for user in result.users:
    print(user.uid)

print('Unable to find users corresponding to these identifiers:')
for uid in result.not_found:
    print(uid)

जाना

getUsersResult, err := client.GetUsers(ctx, []auth.UserIdentifier{
	auth.UIDIdentifier{UID: "uid1"},
	auth.EmailIdentifier{Email: "user@example.com"},
	auth.PhoneIdentifier{PhoneNumber: "+15555551234"},
	auth.ProviderIdentifier{ProviderID: "google.com", ProviderUID: "google_uid1"},
})
if err != nil {
	log.Fatalf("error retriving multiple users: %v\n", err)
}

log.Printf("Successfully fetched user data:")
for _, u := range getUsersResult.Users {
	log.Printf("%v", u)
}

log.Printf("Unable to find users corresponding to these identifiers:")
for _, id := range getUsersResult.NotFound {
	log.Printf("%v", id)
}

सी#

GetUsersResult result = await FirebaseAuth.DefaultInstance.GetUsersAsync(
    new List<UserIdentifier>
    {
        new UidIdentifier("uid1"),
        new EmailIdentifier("user2@example.com"),
        new PhoneIdentifier("+15555550003"),
        new ProviderIdentifier("google.com", "google_uid4"),
    });

Console.WriteLine("Successfully fetched user data:");
foreach (UserRecord user in result.Users)
{
    Console.WriteLine($"User: {user.Uid}");
}

Console.WriteLine("Unable to find users corresponding to these identifiers:");
foreach (UserIdentifier uid in result.NotFound)
{
    Console.WriteLine($"{uid}");
}

यह विधि इनपुट सूची के समान आकार की एक सूची लौटाती है, प्रत्येक प्रविष्टि में या तो संबंधित UserRecord या एक त्रुटि होती है जो यह दर्शाती है कि उस पहचानकर्ता को क्यों नहीं देखा जा सका। विवरण और समाधान चरणों सहित त्रुटि कोड की पूरी सूची के लिए, व्यवस्थापक प्रमाणीकरण एपीआई त्रुटियां देखें।

एक उपयोगकर्ता बनाएं

एडमिन एसडीके एक विधि प्रदान करता है जो आपको एक नया फायरबेस प्रमाणीकरण उपयोगकर्ता बनाने की अनुमति देता है। यह विधि नए बनाए गए उपयोगकर्ता खाते में शामिल करने के लिए प्रोफ़ाइल जानकारी वाले ऑब्जेक्ट को स्वीकार करती है:

नोड.जे.एस

getAuth()
  .createUser({
    email: 'user@example.com',
    emailVerified: false,
    phoneNumber: '+11234567890',
    password: 'secretPassword',
    displayName: 'John Doe',
    photoURL: 'http://www.example.com/12345678/photo.png',
    disabled: false,
  })
  .then((userRecord) => {
    // See the UserRecord reference doc for the contents of userRecord.
    console.log('Successfully created new user:', userRecord.uid);
  })
  .catch((error) => {
    console.log('Error creating new user:', error);
  });

जावा

CreateRequest request = new CreateRequest()
    .setEmail("user@example.com")
    .setEmailVerified(false)
    .setPassword("secretPassword")
    .setPhoneNumber("+11234567890")
    .setDisplayName("John Doe")
    .setPhotoUrl("http://www.example.com/12345678/photo.png")
    .setDisabled(false);

UserRecord userRecord = FirebaseAuth.getInstance().createUser(request);
System.out.println("Successfully created new user: " + userRecord.getUid());

अजगर

user = auth.create_user(
    email='user@example.com',
    email_verified=False,
    phone_number='+15555550100',
    password='secretPassword',
    display_name='John Doe',
    photo_url='http://www.example.com/12345678/photo.png',
    disabled=False)
print('Sucessfully created new user: {0}'.format(user.uid))

जाना

params := (&auth.UserToCreate{}).
	Email("user@example.com").
	EmailVerified(false).
	PhoneNumber("+15555550100").
	Password("secretPassword").
	DisplayName("John Doe").
	PhotoURL("http://www.example.com/12345678/photo.png").
	Disabled(false)
u, err := client.CreateUser(ctx, params)
if err != nil {
	log.Fatalf("error creating user: %v\n", err)
}
log.Printf("Successfully created user: %v\n", u)

सी#

UserRecordArgs args = new UserRecordArgs()
{
    Email = "user@example.com",
    EmailVerified = false,
    PhoneNumber = "+11234567890",
    Password = "secretPassword",
    DisplayName = "John Doe",
    PhotoUrl = "http://www.example.com/12345678/photo.png",
    Disabled = false,
};
UserRecord userRecord = await FirebaseAuth.DefaultInstance.CreateUserAsync(args);
// See the UserRecord reference doc for the contents of userRecord.
Console.WriteLine($"Successfully created new user: {userRecord.Uid}");

डिफ़ॉल्ट रूप से, फायरबेस प्रमाणीकरण नए उपयोगकर्ता के लिए एक यादृच्छिक uid उत्पन्न करेगा। यदि आप इसके बजाय नए उपयोगकर्ता के लिए अपना स्वयं uid निर्दिष्ट करना चाहते हैं, तो आप इसे उपयोगकर्ता निर्माण विधि में दिए गए तर्क के रूप में शामिल कर सकते हैं:

नोड.जे.एस

getAuth()
  .createUser({
    uid: 'some-uid',
    email: 'user@example.com',
    phoneNumber: '+11234567890',
  })
  .then((userRecord) => {
    // See the UserRecord reference doc for the contents of userRecord.
    console.log('Successfully created new user:', userRecord.uid);
  })
  .catch((error) => {
    console.log('Error creating new user:', error);
  });

जावा

CreateRequest request = new CreateRequest()
    .setUid("some-uid")
    .setEmail("user@example.com")
    .setPhoneNumber("+11234567890");

UserRecord userRecord = FirebaseAuth.getInstance().createUser(request);
System.out.println("Successfully created new user: " + userRecord.getUid());

अजगर

user = auth.create_user(
    uid='some-uid', email='user@example.com', phone_number='+15555550100')
print('Sucessfully created new user: {0}'.format(user.uid))

जाना

params := (&auth.UserToCreate{}).
	UID(uid).
	Email("user@example.com").
	PhoneNumber("+15555550100")
u, err := client.CreateUser(ctx, params)
if err != nil {
	log.Fatalf("error creating user: %v\n", err)
}
log.Printf("Successfully created user: %v\n", u)

सी#

UserRecordArgs args = new UserRecordArgs()
{
    Uid = "some-uid",
    Email = "user@example.com",
    PhoneNumber = "+11234567890",
};
UserRecord userRecord = await FirebaseAuth.DefaultInstance.CreateUserAsync(args);
// See the UserRecord reference doc for the contents of userRecord.
Console.WriteLine($"Successfully created new user: {userRecord.Uid}");

निम्नलिखित गुणों का कोई भी संयोजन प्रदान किया जा सकता है:

तालिका 1. उपयोगकर्ता बनाएँ ऑपरेशन द्वारा समर्थित गुण

संपत्ति प्रकार विवरण
uid डोरी नव निर्मित उपयोगकर्ता को आवंटित करने के लिए uid । कुल मिलाकर 1-128 वर्णों के बीच की एक स्ट्रिंग होनी चाहिए। यदि प्रदान नहीं किया गया है, तो एक यादृच्छिक uid स्वचालित रूप से उत्पन्न हो जाएगी। छोटी uid बेहतर प्रदर्शन प्रदान करती है।
email डोरी उपयोगकर्ता का प्राथमिक ईमेल. एक वैध ई - मेल पता होना चाहिए।
emailVerified बूलियन उपयोगकर्ता का प्राथमिक ईमेल सत्यापित है या नहीं. यदि प्रदान नहीं किया गया है, तो डिफ़ॉल्ट false है।
phoneNumber डोरी उपयोगकर्ता का प्राथमिक फ़ोन नंबर. एक वैध E.164 विनिर्देश अनुरूप फ़ोन नंबर होना चाहिए।
password डोरी उपयोगकर्ता का कच्चा, बिना हैश किया हुआ पासवर्ड. कम से कम छह अक्षर लंबे होने चाहिए.
displayName डोरी उपयोगकर्ताओं का प्रदर्शन नाम.
photoURL डोरी उपयोगकर्ता का फ़ोटो URL.
disabled बूलियन उपयोगकर्ता अक्षम है या नहीं. विकलांगों के लिए true ; सक्षम के लिए false । यदि प्रदान नहीं किया गया है, तो डिफ़ॉल्ट false है।

उपयोगकर्ता निर्माण विधि नए बनाए गए उपयोगकर्ता के लिए एक UserRecord ऑब्जेक्ट लौटाती है।

यदि प्रदान किया गया uid , ईमेल या फ़ोन नंबर पहले से ही किसी मौजूदा उपयोगकर्ता द्वारा उपयोग में है या किसी अन्य कारण से उपयोगकर्ता नहीं बनाया जा सकता है, तो उपरोक्त विधि एक त्रुटि के साथ विफल हो जाती है। विवरण और समाधान चरणों सहित त्रुटि कोड की पूरी सूची के लिए, व्यवस्थापक प्रमाणीकरण एपीआई त्रुटियां देखें।

किसी उपयोगकर्ता को अद्यतन करें

फायरबेस एडमिन एसडीके मौजूदा उपयोगकर्ता के डेटा को संशोधित करने की सुविधा देता है। आपको उस उपयोगकर्ता के लिए अद्यतन करने के लिए गुणों के साथ एक uid निर्दिष्ट करने की आवश्यकता है:

नोड.जे.एस

getAuth()
  .updateUser(uid, {
    email: 'modifiedUser@example.com',
    phoneNumber: '+11234567890',
    emailVerified: true,
    password: 'newPassword',
    displayName: 'Jane Doe',
    photoURL: 'http://www.example.com/12345678/photo.png',
    disabled: true,
  })
  .then((userRecord) => {
    // See the UserRecord reference doc for the contents of userRecord.
    console.log('Successfully updated user', userRecord.toJSON());
  })
  .catch((error) => {
    console.log('Error updating user:', error);
  });

जावा

UpdateRequest request = new UpdateRequest(uid)
    .setEmail("user@example.com")
    .setPhoneNumber("+11234567890")
    .setEmailVerified(true)
    .setPassword("newPassword")
    .setDisplayName("Jane Doe")
    .setPhotoUrl("http://www.example.com/12345678/photo.png")
    .setDisabled(true);

UserRecord userRecord = FirebaseAuth.getInstance().updateUser(request);
System.out.println("Successfully updated user: " + userRecord.getUid());

अजगर

user = auth.update_user(
    uid,
    email='user@example.com',
    phone_number='+15555550100',
    email_verified=True,
    password='newPassword',
    display_name='John Doe',
    photo_url='http://www.example.com/12345678/photo.png',
    disabled=True)
print('Sucessfully updated user: {0}'.format(user.uid))

जाना

params := (&auth.UserToUpdate{}).
	Email("user@example.com").
	EmailVerified(true).
	PhoneNumber("+15555550100").
	Password("newPassword").
	DisplayName("John Doe").
	PhotoURL("http://www.example.com/12345678/photo.png").
	Disabled(true)
u, err := client.UpdateUser(ctx, uid, params)
if err != nil {
	log.Fatalf("error updating user: %v\n", err)
}
log.Printf("Successfully updated user: %v\n", u)

सी#

UserRecordArgs args = new UserRecordArgs()
{
    Uid = uid,
    Email = "modifiedUser@example.com",
    PhoneNumber = "+11234567890",
    EmailVerified = true,
    Password = "newPassword",
    DisplayName = "Jane Doe",
    PhotoUrl = "http://www.example.com/12345678/photo.png",
    Disabled = true,
};
UserRecord userRecord = await FirebaseAuth.DefaultInstance.UpdateUserAsync(args);
// See the UserRecord reference doc for the contents of userRecord.
Console.WriteLine($"Successfully updated user: {userRecord.Uid}");

निम्नलिखित गुणों का कोई भी संयोजन प्रदान किया जा सकता है:

तालिका 2. अद्यतन उपयोगकर्ता ऑपरेशन द्वारा समर्थित गुण

संपत्ति प्रकार विवरण
email डोरी उपयोगकर्ता का नया प्राथमिक ईमेल. एक वैध ई - मेल पता होना चाहिए।
emailVerified बूलियन उपयोगकर्ता का प्राथमिक ईमेल सत्यापित है या नहीं. यदि प्रदान नहीं किया गया है, तो डिफ़ॉल्ट false है।
phoneNumber डोरी उपयोगकर्ता का नया प्राथमिक फ़ोन नंबर. एक वैध E.164 विनिर्देश अनुरूप फ़ोन नंबर होना चाहिए। उपयोगकर्ता के मौजूदा फ़ोन नंबर को साफ़ करने के लिए null पर सेट करें।
password डोरी उपयोगकर्ता का नया कच्चा, बिना हैश किया हुआ पासवर्ड। कम से कम छह अक्षर लंबे होने चाहिए.
displayName स्ट्रिंग | null उपयोगकर्ताओं का नया प्रदर्शन नाम. उपयोगकर्ता के मौजूदा प्रदर्शन नाम को साफ़ करने के लिए null पर सेट करें।
photoURL स्ट्रिंग | null उपयोगकर्ताओं का नया फ़ोटो URL. उपयोगकर्ता के मौजूदा फ़ोटो URL को साफ़ करने के लिए null पर सेट करें। यदि null नहीं है, तो एक वैध यूआरएल होना चाहिए।
disabled बूलियन उपयोगकर्ता अक्षम है या नहीं. विकलांगों के लिए true ; सक्षम के लिए false

अद्यतन सफलतापूर्वक पूरा होने पर अद्यतन उपयोगकर्ता विधि एक अद्यतन UserRecord ऑब्जेक्ट लौटाती है।

यदि प्रदान किया गया uid किसी मौजूदा उपयोगकर्ता से मेल नहीं खाता है, प्रदान किया गया ईमेल या फोन नंबर पहले से ही मौजूदा उपयोगकर्ता द्वारा उपयोग में है, या उपयोगकर्ता को किसी अन्य कारण से अपडेट नहीं किया जा सकता है, तो उपरोक्त विधि एक त्रुटि के साथ विफल हो जाती है। विवरण और समाधान चरणों सहित त्रुटि कोड की पूरी सूची के लिए, व्यवस्थापक प्रमाणीकरण एपीआई त्रुटियां देखें।

किसी उपयोगकर्ता को हटाएँ

फायरबेस एडमिन एसडीके मौजूदा उपयोगकर्ताओं को उनके uid द्वारा हटाने की अनुमति देता है:

नोड.जे.एस

getAuth()
  .deleteUser(uid)
  .then(() => {
    console.log('Successfully deleted user');
  })
  .catch((error) => {
    console.log('Error deleting user:', error);
  });

जावा

FirebaseAuth.getInstance().deleteUser(uid);
System.out.println("Successfully deleted user.");

अजगर

auth.delete_user(uid)
print('Successfully deleted user')

जाना

err := client.DeleteUser(ctx, uid)
if err != nil {
	log.Fatalf("error deleting user: %v\n", err)
}
log.Printf("Successfully deleted user: %s\n", uid)

सी#

await FirebaseAuth.DefaultInstance.DeleteUserAsync(uid);
Console.WriteLine("Successfully deleted user.");

जब विलोपन सफलतापूर्वक पूरा हो जाता है तो डिलीट उपयोगकर्ता विधि एक खाली परिणाम लौटाती है।

यदि प्रदान किया गया uid किसी मौजूदा उपयोगकर्ता से मेल नहीं खाता है या उपयोगकर्ता को किसी अन्य कारण से हटाया नहीं जा सकता है, तो उपयोगकर्ता हटाएं विधि एक त्रुटि उत्पन्न करती है। विवरण और समाधान चरणों सहित त्रुटि कोड की पूरी सूची के लिए, व्यवस्थापक प्रमाणीकरण एपीआई त्रुटियां देखें।

एकाधिक उपयोगकर्ताओं को हटाएँ

फायरबेस एडमिन एसडीके एक साथ कई उपयोगकर्ताओं को हटा भी सकता है। हालाँकि, ध्यान दें कि एक साथ कई उपयोगकर्ताओं को हटाने के लिए deleteUsers(uids) जैसी विधियों का उपयोग करने से Firebase के लिए क्लाउड फ़ंक्शंस के लिए onDelete() इवेंट हैंडलर ट्रिगर नहीं होंगे। ऐसा इसलिए है क्योंकि बैच डिलीट प्रत्येक उपयोगकर्ता पर उपयोगकर्ता विलोपन ईवेंट को ट्रिगर नहीं करता है। यदि आप चाहते हैं कि प्रत्येक हटाए गए उपयोगकर्ता के लिए उपयोगकर्ता हटाने की घटनाएं सक्रिय हों तो एक-एक करके उपयोगकर्ताओं को हटाएं।

नोड.जे.एस

getAuth()
  .deleteUsers([uid1, uid2, uid3])
  .then((deleteUsersResult) => {
    console.log(`Successfully deleted ${deleteUsersResult.successCount} users`);
    console.log(`Failed to delete ${deleteUsersResult.failureCount} users`);
    deleteUsersResult.errors.forEach((err) => {
      console.log(err.error.toJSON());
    });
  })
  .catch((error) => {
    console.log('Error deleting users:', error);
  });

जावा

DeleteUsersResult result = FirebaseAuth.getInstance().deleteUsersAsync(
    Arrays.asList("uid1", "uid2", "uid3")).get();

System.out.println("Successfully deleted " + result.getSuccessCount() + " users");
System.out.println("Failed to delete " + result.getFailureCount() + " users");
for (ErrorInfo error : result.getErrors()) {
  System.out.println("error #" + error.getIndex() + ", reason: " + error.getReason());
}

अजगर

from firebase_admin import auth

result = auth.delete_users(["uid1", "uid2", "uid3"])

print('Successfully deleted {0} users'.format(result.success_count))
print('Failed to delete {0} users'.format(result.failure_count))
for err in result.errors:
    print('error #{0}, reason: {1}'.format(result.index, result.reason))

जाना

deleteUsersResult, err := client.DeleteUsers(ctx, []string{"uid1", "uid2", "uid3"})
if err != nil {
	log.Fatalf("error deleting users: %v\n", err)
}

log.Printf("Successfully deleted %d users", deleteUsersResult.SuccessCount)
log.Printf("Failed to delete %d users", deleteUsersResult.FailureCount)
for _, err := range deleteUsersResult.Errors {
	log.Printf("%v", err)
}

सी#

DeleteUsersResult result = await FirebaseAuth.DefaultInstance.DeleteUsersAsync(new List<string>
    {
        "uid1",
        "uid2",
        "uid3",
    });

Console.WriteLine($"Successfully deleted {result.SuccessCount} users.");
Console.WriteLine($"Failed to delete {result.FailureCount} users.");

foreach (ErrorInfo err in result.Errors)
{
    Console.WriteLine($"Error #{err.Index}, reason: {err.Reason}");
}

उपयोगकर्ता हटाएं विधि उन उपयोगकर्ताओं के लिए विफलताओं की एक सूची लौटाती है जिन्हें हटाया नहीं जा सका था। विवरण और समाधान चरणों सहित त्रुटि कोड की पूरी सूची के लिए, व्यवस्थापक प्रमाणीकरण एपीआई त्रुटियां देखें।

सभी उपयोगकर्ताओं की सूची बनाएं

फायरबेस एडमिन एसडीके बैचों में उपयोगकर्ताओं की पूरी सूची पुनर्प्राप्त करने की अनुमति देता है:

नोड.जे.एस

const listAllUsers = (nextPageToken) => {
  // List batch of users, 1000 at a time.
  getAuth()
    .listUsers(1000, nextPageToken)
    .then((listUsersResult) => {
      listUsersResult.users.forEach((userRecord) => {
        console.log('user', userRecord.toJSON());
      });
      if (listUsersResult.pageToken) {
        // List next batch of users.
        listAllUsers(listUsersResult.pageToken);
      }
    })
    .catch((error) => {
      console.log('Error listing users:', error);
    });
};
// Start listing users from the beginning, 1000 at a time.
listAllUsers();

जावा

// Start listing users from the beginning, 1000 at a time.
ListUsersPage page = FirebaseAuth.getInstance().listUsers(null);
while (page != null) {
  for (ExportedUserRecord user : page.getValues()) {
    System.out.println("User: " + user.getUid());
  }
  page = page.getNextPage();
}

// Iterate through all users. This will still retrieve users in batches,
// buffering no more than 1000 users in memory at a time.
page = FirebaseAuth.getInstance().listUsers(null);
for (ExportedUserRecord user : page.iterateAll()) {
  System.out.println("User: " + user.getUid());
}

अजगर

# Start listing users from the beginning, 1000 at a time.
page = auth.list_users()
while page:
    for user in page.users:
        print('User: ' + user.uid)
    # Get next batch of users.
    page = page.get_next_page()

# Iterate through all users. This will still retrieve users in batches,
# buffering no more than 1000 users in memory at a time.
for user in auth.list_users().iterate_all():
    print('User: ' + user.uid)

जाना

// Note, behind the scenes, the Users() iterator will retrive 1000 Users at a time through the API
iter := client.Users(ctx, "")
for {
	user, err := iter.Next()
	if err == iterator.Done {
		break
	}
	if err != nil {
		log.Fatalf("error listing users: %s\n", err)
	}
	log.Printf("read user user: %v\n", user)
}

// Iterating by pages 100 users at a time.
// Note that using both the Next() function on an iterator and the NextPage()
// on a Pager wrapping that same iterator will result in an error.
pager := iterator.NewPager(client.Users(ctx, ""), 100, "")
for {
	var users []*auth.ExportedUserRecord
	nextPageToken, err := pager.NextPage(&users)
	if err != nil {
		log.Fatalf("paging error %v\n", err)
	}
	for _, u := range users {
		log.Printf("read user user: %v\n", u)
	}
	if nextPageToken == "" {
		break
	}
}

सी#

// Start listing users from the beginning, 1000 at a time.
var pagedEnumerable = FirebaseAuth.DefaultInstance.ListUsersAsync(null);
var responses = pagedEnumerable.AsRawResponses().GetAsyncEnumerator();
while (await responses.MoveNextAsync())
{
    ExportedUserRecords response = responses.Current;
    foreach (ExportedUserRecord user in response.Users)
    {
        Console.WriteLine($"User: {user.Uid}");
    }
}

// Iterate through all users. This will still retrieve users in batches,
// buffering no more than 1000 users in memory at a time.
var enumerator = FirebaseAuth.DefaultInstance.ListUsersAsync(null).GetAsyncEnumerator();
while (await enumerator.MoveNextAsync())
{
    ExportedUserRecord user = enumerator.Current;
    Console.WriteLine($"User: {user.Uid}");
}

परिणामों के प्रत्येक बैच में उपयोगकर्ताओं की एक सूची होती है और अगले पृष्ठ का टोकन उपयोगकर्ताओं के अगले बैच को सूचीबद्ध करने के लिए उपयोग किया जाता है। जब सभी उपयोगकर्ता पहले ही सूचीबद्ध हो चुके हों, तो कोई pageToken वापस नहीं किया जाता है।

यदि कोई maxResults फ़ील्ड निर्दिष्ट नहीं है, तो प्रति बैच डिफ़ॉल्ट 1000 उपयोगकर्ताओं का उपयोग किया जाता है। यह एक समय में सूचीबद्ध होने के लिए अनुमत उपयोगकर्ताओं की अधिकतम संख्या भी है। अधिकतम से अधिक कोई भी मान एक तर्क त्रुटि उत्पन्न करेगा। यदि कोई pageToken निर्दिष्ट नहीं है, तो ऑपरेशन uid द्वारा क्रमबद्ध शुरुआत से उपयोगकर्ताओं को सूचीबद्ध करेगा।

विवरण और समाधान चरणों सहित त्रुटि कोड की पूरी सूची के लिए, व्यवस्थापक प्रमाणीकरण एपीआई त्रुटियां देखें।

सूचीबद्ध उपयोगकर्ताओं के पासवर्ड हैश

यदि अनुरोध OAuth एक्सेस टोकन उत्पन्न करने के लिए उपयोग किए जाने वाले उपयोगकर्ता/सेवा खाते के पास firebaseauth.configs.getHashConfig अनुमति है, तो यह API पासवर्ड उपयोगकर्ताओं के लिए फायरबेस ऑथ बैकएंड द्वारा हैश किए गए passwordSalt और passwordHash भी लौटाता है। अन्यथा passwordHash और passwordSalt सेट नहीं किया जाएगा।

पासवर्ड हैश की संवेदनशील प्रकृति के कारण, फायरबेस एडमिन एसडीके सेवा खाते में डिफ़ॉल्ट रूप से firebaseauth.configs.getHashConfig अनुमति नहीं है। आप किसी उपयोगकर्ता/सेवा खाते में सीधे अनुमति नहीं जोड़ सकते हैं, लेकिन आप एक कस्टम IAM भूमिका बनाकर अप्रत्यक्ष रूप से ऐसा कर सकते हैं।

कस्टम IAM भूमिका बनाने के लिए:

  1. Google क्लाउड कंसोल में IAM और व्यवस्थापक पैनल में भूमिकाएँ पृष्ठ पर जाएँ।
  2. पृष्ठ के शीर्ष पर स्थित ड्रॉप-डाउन से अपना प्रोजेक्ट चुनें।
  3. भूमिका बनाएँ पर क्लिक करें
  4. अनुमतियाँ जोड़ें पर क्लिक करें
  5. firebaseauth.configs.getHashConfig अनुमति खोजें और उस चेकबॉक्स का चयन करें।
  6. जोड़ें पर क्लिक करें
  7. नई भूमिका बनाना समाप्त करने के लिए CREATE पर क्लिक करें।

IAM पेज में उपयोगकर्ता/सेवा खाते में बनाई गई कस्टम भूमिका जोड़ें:

  1. IAM और एडमिन पैनल में, IAM चुनें
  2. संपादन के लिए सदस्यों की सूची से सेवा या उपयोगकर्ता खाता चुनें।
  3. अन्य भूमिका जोड़ें पर क्लिक करें.
  4. पहले बनाई गई नई कस्टम भूमिका खोजें।
  5. सहेजें पर क्लिक करें.