Module: auth

Auth entry point for firebase-admin-util
Source:

Methods

(async, inner) assertEmailNotTaken(email) → {Promise.<boolean>}

Assert email is not taken by another user
Parameters:
Name Type Description
email string The email to check against.
Source:
Returns:
True iff assertion passed, throws error otherwise
Type
Promise.<boolean>

(async, inner) createUser(email, password) → {Promise.<object>}

Create a user auth record.
Parameters:
Name Type Description
email string The email for the user.
password string The password for the user.
Source:
Returns:
Same behavior as vanilla firebase admin sdk.
Type
Promise.<object>

(async, inner) deleteUser(uid) → {Promise.<object>}

Delete a user from auth records.
Parameters:
Name Type Description
uid string The uid of an existing user that you want to delete.
Source:
Returns:
Same behavior as vanilla firebase admin sdk.
Type
Promise.<object>

(async, inner) updateUser(uid, info) → {Promise.<object>}

Update a user auth record.
Parameters:
Name Type Description
uid string The uid of an existing user that you want to update.
info object The user info you want to update the user record with (same as vanilla firebase admin sdk).
Source:
Returns:
Same behavior as vanilla firebase admin sdk.
Type
Promise.<object>