app

non-null admin.app.App

The app associated with the current Auth service instance.

var app = auth.app;

createCustomToken

createCustomToken(uid, developerClaims) returns Promise containing string

Creates a new Firebase custom token (JWT) that can be sent back to a client device to use to sign in with the client SDKs' signInWithCustomToken() methods.

See Create Custom Tokens for code samples and detailed documentation.

Returns

non-null Promise containing string A promise fulfilled with a custom token for the provided uid and payload.

createSessionCookie

createSessionCookie(idToken, sessionCookieOptions) returns Promise containing string

Creates a new Firebase session cookie with the specified options. The created JWT string can be set as a server-side session cookie with a custom cookie policy, and be used for session management. The session cookie JWT will have the same payload claims as the provided ID token.

See Manage Session Cookies for code samples and detailed documentation.

Returns

non-null Promise containing string A promise that resolves on success with the created session cookie.

createUser

createUser(properties) returns Promise containing non-null admin.auth.UserRecord

Creates a new user.

See Create a user for code samples and detailed documentation.

Returns

non-null Promise containing non-null admin.auth.UserRecord A promise fulfilled with the user data corresponding to the newly created user.

deleteUser

deleteUser(uid) returns Promise containing void

Deletes an existing user.

See Delete a user for code samples and detailed documentation.

Returns

non-null Promise containing void An empty promise fulfilled once the user has been deleted.

generateEmailVerificationLink

generateEmailVerificationLink(email, actionCodeSettings) returns Promise containing string

Generates the out of band email action link to verify the user's ownership of the specified email. The ActionCodeSettings object provided as an argument to this method defines whether the link is to be handled by a mobile app or browser along with additional state information to be passed in the deep link, etc.

Returns

non-null Promise containing string 

var actionCodeSettings = {
  url: 'https://www.example.com/cart?email=user@example.com&cartId=123',
  iOS: {
    bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true,
  dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
    .generateEmailVerificationLink('user@example.com', actionCodeSettings)
    .then(function(link) {
      // The link was successfully generated.
    })
    .catch(function(error) {
      // Some error occurred, you can inspect the code: error.code
    });

generatePasswordResetLink

generatePasswordResetLink(email, actionCodeSettings) returns Promise containing string

Generates the out of band email action link to reset a user's password. The link is generated for the user with the specified email address. The optional ActionCodeSettings object defines whether the link is to be handled by a mobile app or browser and the additional state information to be passed in the deep link, etc.

Returns

non-null Promise containing string 

var actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
    bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true,
  dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
    .generatePasswordResetLink('user@example.com', actionCodeSettings)
    .then(function(link) {
      // The link was successfully generated.
    })
    .catch(function(error) {
      // Some error occurred, you can inspect the code: error.code
    });

generateSignInWithEmailLink

generateSignInWithEmailLink(email, actionCodeSettings) returns Promise containing string

Generates the out of band email action link to sign in or sign up the owner of the specified email. The ActionCodeSettings object provided as an argument to this method defines whether the link is to be handled by a mobile app or browser along with additional state information to be passed in the deep link, etc.

Returns

non-null Promise containing string 

var actionCodeSettings = {
  // The URL to redirect to for sign-in completion. This is also the deep
  // link for mobile redirects. The domain (www.example.com) for this URL
  // must be whitelisted in the Firebase Console.
  url: 'https://www.example.com/finishSignUp?cartId=1234',
  iOS: {
    bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  // This must be true.
  handleCodeInApp: true,
  dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
    .generateSignInWithEmailLink('user@example.com', actionCodeSettings)
    .then(function(link) {
      // The link was successfully generated.
    })
    .catch(function(error) {
      // Some error occurred, you can inspect the code: error.code
    });

getUser

getUser(uid) returns Promise containing non-null admin.auth.UserRecord

Gets the user data for the user corresponding to a given uid.

See Retrieve user data for code samples and detailed documentation.

Returns

non-null Promise containing non-null admin.auth.UserRecord A promise fulfilled with the user data corresponding to the provided uid.

getUserByEmail

getUserByEmail(email) returns Promise containing non-null admin.auth.UserRecord

Gets the user data for the user corresponding to a given email.

See Retrieve user data for code samples and detailed documentation.

Returns

non-null Promise containing non-null admin.auth.UserRecord A promise fulfilled with the user data corresponding to the provided email.

getUserByPhoneNumber

getUserByPhoneNumber(phoneNumber) returns Promise containing non-null admin.auth.UserRecord

Gets the user data for the user corresponding to a given phone number. The phone number has to conform to the E.164 specification.

See Retrieve user data for code samples and detailed documentation.

Returns

non-null Promise containing non-null admin.auth.UserRecord A promise fulfilled with the user data corresponding to the provided phone number.

importUsers

importUsers(userImportRecords, userImportOptions) returns Promise containing non-null admin.auth.UserImportResult

Imports the provided list of users into Firebase Auth. At most 1000 users are allowed to be imported one at a time. When importing users with passwords, UserImportOptions are required to be specified. This operation is optimized for bulk imports and will ignore checks on uid, email and other identifier uniqueness which could result in duplications.

Returns

non-null Promise containing non-null admin.auth.UserImportResult A promise that resolves when the operation completes with the result of the import. This includes the number of successful imports, the number of failed imports and their corresponding errors.

listUsers

listUsers(maxResults, pageToken) returns Promise containing non-null admin.auth.ListUsersResult

Retrieves a list of users (single batch only) with a size of maxResults and starting from the offset as specified by pageToken. This is used to retrieve all the users of a specified project in batches.

See List all users for code samples and detailed documentation.

Returns

non-null Promise containing non-null admin.auth.ListUsersResult A promise that resolves with the current batch of downloaded users and the next page token.

revokeRefreshTokens

revokeRefreshTokens(uid) returns Promise containing void

Revokes all refresh tokens for an existing user.

This API will update the user's tokensValidAfterTime to the current UTC. It is important that the server on which this is called has its clock set correctly and synchronized.

While this will revoke all sessions for a specified user and disable any new ID tokens for existing sessions from getting minted, existing ID tokens may remain active until their natural expiration (one hour). To verify that ID tokens are revoked, use verifyIdToken(idToken, true) where checkRevoked is set to true.

Returns

non-null Promise containing void An empty promise fulfilled once the user's refresh tokens have been revoked.

setCustomUserClaims

setCustomUserClaims(uid, customUserClaims) returns Promise containing void

Sets additional developer claims on an existing user identified by the provided uid, typically used to define user roles and levels of access. These claims should propagate to all devices where the user is already signed in (after token expiration or when token refresh is forced) and the next time the user signs in. If a reserved OIDC claim name is used (sub, iat, iss, etc), an error is thrown. They are set on the authenticated user's ID token JWT.

See Defining user roles and access levels for code samples and detailed documentation.

Returns

non-null Promise containing void A promise that resolves when the operation completes successfully.

updateUser

updateUser(uid, properties) returns Promise containing non-null admin.auth.UserRecord

Updates an existing user.

See Update a user for code samples and detailed documentation.

Returns

non-null Promise containing non-null admin.auth.UserRecord A promise fulfilled with the updated user data.

verifyIdToken

verifyIdToken(idToken, checkRevoked) returns Promise containing non-null admin.auth.DecodedIdToken

Verifies a Firebase ID token (JWT). If the token is valid, the promise is fulfilled with the token's decoded claims; otherwise, the promise is rejected. An optional flag can be passed to additionally check whether the ID token was revoked.

See Verify ID Tokens for code samples and detailed documentation.

Returns

non-null Promise containing non-null admin.auth.DecodedIdToken A promise fulfilled with the token's decoded claims if the ID token is valid; otherwise, a rejected promise.

verifySessionCookie

verifySessionCookie(sessionCookie, checkRevoked) returns Promise containing non-null admin.auth.DecodedIdToken

Verifies a Firebase session cookie. Returns a Promise with the cookie claims. Rejects the promise if the cookie could not be verified. If checkRevoked is set to true, verifies if the session corresponding to the session cookie was revoked. If the corresponding user's session was revoked, an auth/session-cookie-revoked error is thrown. If not specified the check is not performed.

See Verify Session Cookies for code samples and detailed documentation

Returns

non-null Promise containing non-null admin.auth.DecodedIdToken A promise fulfilled with the session cookie's decoded claims if the session cookie is valid; otherwise, a rejected promise.