Fuego

User Import and Export Guide

big-idea

Importing Users

The user import feature allows you to migrate users into Firebase Authentication from external sources while preserving authentication credentials.

Import users

Steps to Import Users

  1. Select Tenant: Choose the target tenant where users will be imported. This step is required if Identity Platform is enabled.

  2. Upload File: Click on the Browse button to select the user data file.

  3. Import Custom Claims (Optional): If the user file does not contain custom claims, specify the default action.

  4. Import with Password: If passwords are included, select the appropriate hashing algorithm.

    Supported hashing algorithms:

    • SCRYPT
    • STANDARD_SCRYPT
    • BCRYPT
    • SHA256
    • SHA512
    • SHA1
    • MD5
    • PBKDF_SHA1
    • PBKDF2_SHA256
    • HMAC_MD5
    • HMAC_SHA1
    • HMAC_SHA256
    • HMAC_SHA512
  5. Set Secret and Salt Separator: If using SCRYPT, Firebase requires these parameters, which can be retrieved from the Identity Platform settings in GCloud.

  6. Set Hashing Parameters: Configure the necessary hashing parameters based on the selected algorithm, such as iterations, memory cost, or other algorithm-specific settings.

  7. Additional Settings (Optional):

    • Import identity providers.
    • Import metadata (e.g., creation date, last login).
    • Specify the ID column name (uid).
  8. Confirm Import: Click Confirm to start the import process.

Advantages of Using Fuego for User Import

  • Allows migration of users from an external authentication system using different password hashing algorithms.
  • Enables migration from another Firebase project.
  • Optimized for fast and efficient bulk import operations, without checking for uid, email, phoneNumber, or other unique identifiers.
  • Supports migration of existing OAuth users (Google, Facebook, etc.).
  • Enables bulk import of users with custom claims.

Usage Considerations

  • Up to 1000 users can be imported in a single API call.
  • The operation does not check for duplicate uid, email, phoneNumber, or other unique identifiers.
  • If a user with an existing uid is imported, the original user data is replaced.
  • If a duplicate email or other field is present, an additional user is created with the same value.
  • Importing Firebase Scrypt hashed passwords requires retrieving internal hash parameters from the Firebase Console.

Exporting Users

The user export feature allows you to extract user data from Firebase Authentication for backup or migration purposes. Export users

Steps to Export Users

  1. Select Tenant: Choose the tenant whose users you want to export.
  2. Choose Export Format:
    • CSV
    • JSON
  3. Include Additional Data:
    • Metadata (creation date, last modification, login data).
    • Custom claims.
    • Hashed passwords.
  4. Set CSV Delimiter: Choose the delimiter character (e.g., comma ,).
  5. Data Formatting:
    • Select the JSON object structure.
    • Define the timestamp format.
  6. Confirm Export: Click Confirm to generate and download the user data file.

By following these steps, you can efficiently import and export user data while maintaining data integrity and security in Firebase Authentication.