BaseAuth class

Common parent interface for both Auth and TenantAwareAuth APIs.

Signature:

export declare abstract class BaseAuth 

Methods

BaseAuth.createCustomToken()

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. (Tenant-aware instances will also embed the tenant ID in the token.)

See Create Custom Tokens for code samples and detailed documentation.

Signature:

createCustomToken(uid: string, developerClaims?: object): Promise<string>;

Parameters

Returns:

Promise<string>

A promise fulfilled with a custom token for the provided uid and payload.

BaseAuth.createProviderConfig()

Returns a promise that resolves with the newly created AuthProviderConfig when the new provider configuration is created.

SAML and OIDC provider support requires Google Cloud's Identity Platform (GCIP). To learn more about GCIP, including pricing and features, see the GCIP documentation.

Signature:

createProviderConfig(config: AuthProviderConfig): Promise<AuthProviderConfig>;

Parameters

Returns:

Promise<AuthProviderConfig>

A promise that resolves with the created provider configuration.

BaseAuth.createSessionCookie()

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.

Signature:

createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions): Promise<string>;

Parameters

Returns:

Promise<string>

A promise that resolves on success with the created session cookie.

BaseAuth.createUser()

Creates a new user.

See Create a user for code samples and detailed documentation.

Signature:

createUser(properties: CreateRequest): Promise<UserRecord>;

Parameters

Returns:

Promise<UserRecord>

A promise fulfilled with the user data corresponding to the newly created user.

BaseAuth.deleteProviderConfig()

Deletes the provider configuration corresponding to the provider ID passed. If the specified ID does not exist, an auth/configuration-not-found error is thrown.

SAML and OIDC provider support requires Google Cloud's Identity Platform (GCIP). To learn more about GCIP, including pricing and features, see the GCIP documentation.

Signature:

deleteProviderConfig(providerId: string): Promise<void>;

Parameters

Returns:

Promise<void>

A promise that resolves on completion.

BaseAuth.deleteUser()

Deletes an existing user.

See Delete a user for code samples and detailed documentation.

Signature:

deleteUser(uid: string): Promise<void>;

Parameters

Returns:

Promise<void>

An empty promise fulfilled once the user has been deleted.

BaseAuth.deleteUsers()

Deletes the users specified by the given uids.

Deleting a non-existing user won't generate an error (i.e. this method is idempotent.) Non-existing users are considered to be successfully deleted, and are therefore counted in the DeleteUsersResult.successCount value.

Only a maximum of 1000 identifiers may be supplied. If more than 1000 identifiers are supplied, this method throws a FirebaseAuthError.

This API is currently rate limited at the server to 1 QPS. If you exceed this, you may get a quota exceeded error. Therefore, if you want to delete more than 1000 users, you may need to add a delay to ensure you don't go over this limit.

Signature:

deleteUsers(uids: string[]): Promise<DeleteUsersResult>;

Parameters

Returns:

Promise<DeleteUsersResult>

A Promise that resolves to the total number of successful/failed deletions, as well as the array of errors that corresponds to the failed deletions.

BaseAuth.generateEmailVerificationLink()

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.

Signature:

generateEmailVerificationLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

Parameters

Returns:

Promise<string>

A promise that resolves with the generated link.

Example

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
    });

BaseAuth.generatePasswordResetLink()

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.

Signature:

generatePasswordResetLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

Parameters

Returns:

Promise<string>

A promise that resolves with the generated link.

Example

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
    });

BaseAuth.generateSignInWithEmailLink()

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.

Signature:

generateSignInWithEmailLink(email: string, actionCodeSettings: ActionCodeSettings): Promise<string>;

Parameters

Returns:

Promise<string>

A promise that resolves with the generated link.

Example

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
    });

BaseAuth.generateVerifyAndChangeEmailLink()

Generates an 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.

Signature:

generateVerifyAndChangeEmailLink(email: string, newEmail: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

Parameters

Returns:

Promise<string>

A promise that resolves with the generated link.

BaseAuth.getProviderConfig()

Looks up an Auth provider configuration by the provided ID. Returns a promise that resolves with the provider configuration corresponding to the provider ID specified. If the specified ID does not exist, an auth/configuration-not-found error is thrown.

SAML and OIDC provider support requires Google Cloud's Identity Platform (GCIP). To learn more about GCIP, including pricing and features, see the GCIP documentation.

Signature:

getProviderConfig(providerId: string): Promise<AuthProviderConfig>;

Parameters

Returns:

Promise<AuthProviderConfig>

A promise that resolves with the configuration corresponding to the provided ID.

BaseAuth.getUser()

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

See Retrieve user data for code samples and detailed documentation.

Signature:

getUser(uid: string): Promise<UserRecord>;

Parameters

Returns:

Promise<UserRecord>

A promise fulfilled with the user data corresponding to the provided uid.

BaseAuth.getUserByEmail()

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

See Retrieve user data for code samples and detailed documentation.

Signature:

getUserByEmail(email: string): Promise<UserRecord>;

Parameters

Returns:

Promise<UserRecord>

A promise fulfilled with the user data corresponding to the provided email.

BaseAuth.getUserByPhoneNumber()

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.

Signature:

getUserByPhoneNumber(phoneNumber: string): Promise<UserRecord>;

Parameters

Returns:

Promise<UserRecord>

A promise fulfilled with the user data corresponding to the provided phone number.

BaseAuth.getUserByProviderUid()

Gets the user data for the user corresponding to a given provider id.

See Retrieve user data for code samples and detailed documentation.

Signature:

getUserByProviderUid(providerId: string, uid: string): Promise<UserRecord>;

Parameters

Returns:

Promise<UserRecord>

A promise fulfilled with the user data corresponding to the given provider id.

BaseAuth.getUsers()

Gets the user data corresponding to the specified identifiers.

There are no ordering guarantees; in particular, the nth entry in the result list is not guaranteed to correspond to the nth entry in the input parameters list.

Only a maximum of 100 identifiers may be supplied. If more than 100 identifiers are supplied, this method throws a FirebaseAuthError.

Signature:

getUsers(identifiers: UserIdentifier[]): Promise<GetUsersResult>;

Parameters

Returns:

Promise<GetUsersResult>

A promise that resolves to the corresponding user records.

Exceptions

FirebaseAuthError If any of the identifiers are invalid or if more than 100 identifiers are specified.

BaseAuth.importUsers()

Imports the provided list of users into Firebase Auth. A maximum of 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.

Signature:

importUsers(users: UserImportRecord[], options?: UserImportOptions): Promise<UserImportResult>;

Parameters

Returns:

Promise<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.

BaseAuth.listProviderConfigs()

Returns the list of existing provider configurations matching the filter provided. At most, 100 provider configs can be listed at a time.

SAML and OIDC provider support requires Google Cloud's Identity Platform (GCIP). To learn more about GCIP, including pricing and features, see the GCIP documentation.

Signature:

listProviderConfigs(options: AuthProviderConfigFilter): Promise<ListProviderConfigResults>;

Parameters

Returns:

Promise<ListProviderConfigResults>

A promise that resolves with the list of provider configs meeting the filter requirements.

BaseAuth.listUsers()

Retrieves a list of users (single batch only) with a size of maxResults 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.

Signature:

listUsers(maxResults?: number, pageToken?: string): Promise<ListUsersResult>;

Parameters

Returns:

Promise<ListUsersResult>

A promise that resolves with the current batch of downloaded users and the next page token.

BaseAuth.revokeRefreshTokens()

Revokes all refresh tokens for an existing user.

This API will update the user's UserRecord.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 BaseAuth.verifyIdToken() where checkRevoked is set to true.

Signature:

revokeRefreshTokens(uid: string): Promise<void>;

Parameters

Returns:

Promise<void>

An empty promise fulfilled once the user's refresh tokens have been revoked.

BaseAuth.setCustomUserClaims()

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.

Signature:

setCustomUserClaims(uid: string, customUserClaims: object | null): Promise<void>;

Parameters

Returns:

Promise<void>

A promise that resolves when the operation completes successfully.

BaseAuth.updateProviderConfig()

Returns a promise that resolves with the updated AuthProviderConfig corresponding to the provider ID specified. If the specified ID does not exist, an auth/configuration-not-found error is thrown.

SAML and OIDC provider support requires Google Cloud's Identity Platform (GCIP). To learn more about GCIP, including pricing and features, see the GCIP documentation.

Signature:

updateProviderConfig(providerId: string, updatedConfig: UpdateAuthProviderRequest): Promise<AuthProviderConfig>;

Parameters

Returns:

Promise<AuthProviderConfig>

A promise that resolves with the updated provider configuration.

BaseAuth.updateUser()

Updates an existing user.

See Update a user for code samples and detailed documentation.

Signature:

updateUser(uid: string, properties: UpdateRequest): Promise<UserRecord>;

Parameters

Returns:

Promise<UserRecord>

A promise fulfilled with the updated user data.

BaseAuth.verifyIdToken()

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.

If checkRevoked is set to true, first verifies whether the corresponding user is disabled. If yes, an auth/user-disabled error is thrown. If no, verifies if the session corresponding to the ID token was revoked. If the corresponding user's session was invalidated, an auth/id-token-revoked error is thrown. If not specified the check is not applied.

See Verify ID Tokens for code samples and detailed documentation.

Signature:

verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;

Parameters

Returns:

Promise<DecodedIdToken>

A promise fulfilled with the token's decoded claims if the ID token is valid; otherwise, a rejected promise.

BaseAuth.verifySessionCookie()

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, first verifies whether the corresponding user is disabled: If yes, an auth/user-disabled error is thrown. If no, verifies if the session corresponding to the session cookie was revoked. If the corresponding user's session was invalidated, 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

Signature:

verifySessionCookie(sessionCookie: string, checkRevoked?: boolean): Promise<DecodedIdToken>;

Parameters

Returns:

Promise<DecodedIdToken>

A promise fulfilled with the session cookie's decoded claims if the session cookie is valid; otherwise, a rejected promise.