auth:import and auth:export

The auth:import and auth:export commands import user accounts into Firebase projects, and export user accounts to JSON and CSV files.

auth:import

firebase auth:import account_file   \
    --hash-algo=hash_algorithm      \
    --hash-key=key                  \
    --salt-separator=salt_separator \
    --rounds=rounds                 \
    --mem-cost=mem_cost
Parameters
account_file The CSV or JSON file that contains the user accounts to import. See File format.
hash-algo The algorithm used to hash passwords in the user account file. Required to import accounts with password fields. One of the following values: BCRYPT, SCRYPT, HMAC_SHA512, HMAC_SHA256, HMAC_SHA1, HMAC_MD5, MD5, SHA256, SHA1, PBKDF_SHA1, PBKDF2_SHA256.
hash-key Key used to hash passwords. Required for the SCRYPT, HMAC_SHA512, HMAC_SHA256, HMAC_SHA1, and HMAC_MD5 algorithms. This argument must be formatted as a base64-encoded string.
salt-separator Salt separator which will be appended to salt when verifying password. Optional for all algorithms. This argument must be formatted as a base64-encoded string.
rounds The number of rounds used to hash passwords. Required for the SCRYPT, MD5, SHA256, SHA1, PBKDF_SHA1 and PBKDF2_SHA256 algorithms.
mem-cost The memory cost of the hashing algorithm. Required for the SCRYPT algorithm.

auth:export

firebase auth:export account_file --format=file_format
Parameters
account_file The CSV or JSON file to export to. See File format.
format Optional: the file format to export: either csv or json. If the file name specified in the account_file parameter ends with .csv or .json, that format is used and this parameter is ignored.

File format

The user account file can be formatted as CSV or JSON.

CSV

A CSV user account file has the following format:

Column number Field description Field type Comments
1 UID String Required. This ID should be unique among all accounts in your Firebase projects. If you import an account with a UID that already exists, the account will be overwritten.
2 Email String Optional
3 Email Verified Boolean Optional
4 Password Hash String Optional. A base64 encoded string.
5 Password Salt String Optional. A base64 encoded string.
6 Name String Optional
7 Photo URL String Optional
8 Google ID String Optional
9 Google Email String Optional
10 Google Display Name String Optional
11 Google Photo URL String Optional
12 Facebook ID String Optional
13 Facebook Email String Optional
14 Facebook Display Name String Optional
15 Facebook Photo URL String Optional
16 Twitter ID String Optional
17 Twitter Email String Optional
18 Twitter Display Name String Optional
19 Twitter Photo URL String Optional
20 GitHub ID String Optional
21 GitHub Email String Optional
22 GitHub Display Name String Optional
23 GitHub Photo URL String Optional
24 User Creation Time Long Optional. Epoch Unix Timestamp in milliseconds.
25 Last Sign-In Time Long Optional. Epoch Unix Timestamp in milliseconds.

If you leave an optional value unspecified, ensure that you still include an empty field for the value. An empty field can be any number of space characters.

For example, the following line represents a user account:

111, test@test.org, false, Jlf7onfLbzqPNFP/1pqhx6fQF/w=, c2FsdC0x, Test User, http://photo.com/123, , , , , 123, test@test.org, Test FB User, http://photo.com/456, , , , , , , , , 1486324027000, 1486324027000

JSON

A JSON user account file has the following format:

{
  "users": [
    {
      "localId": uid,
      "email": email-address
      "emailVerified": email-verified,
      "passwordHash": base64-encoded-password-hash,
      "salt": base64-encoded-password-salt,
      "displayName": name,
      "photoUrl": photo-url,
      "createdAt": created-at-in-millis,
      "lastSignedInAt": last-signedin-at-in-millis,
      "providerUserInfo": [
        {
          "providerId": provider-id,
          "rawId": provider-uid,
          "email":  provider-email,
          "displayName": provider-name,
          "photoUrl": provider-photo-url
        },
        ...
      ]
    },
    ...
  ]
}

The providerId field must be one of the following values: google.com, facebook.com, github.com, twitter.com.

Send feedback about...

Need help? Visit our support page.