firebase-admin 9.100.0-alpha.0 → 10.0.2

package/lib/auth/base-auth.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.100.0-alpha.0 */
+/*! firebase-admin v10.0.2 */
 /*!
  * Copyright 2021 Google Inc.
  *
@@ -21,7 +21,7 @@ import { UserRecord } from './user-record';
 import { UserIdentifier } from './identifier';
 import { UserImportOptions, UserImportRecord, UserImportResult } from './user-import-builder';
 import { ActionCodeSettings } from './action-code-settings-builder';
-/** Represents the result of the {@link auth.Auth.getUsers} API. */
+/** Represents the result of the {@link BaseAuth.getUsers} API. */
 export interface GetUsersResult {
     /**
      * Set of user records, corresponding to the set of users that were
@@ -34,12 +34,12 @@ export interface GetUsersResult {
 }
 /**
  * Interface representing the object returned from a
- * {@link auth.Auth.listUsers `listUsers()`} operation. Contains the list
+ * {@link BaseAuth.listUsers} operation. Contains the list
  * of users for the current batch and the next page token if available.
  */
 export interface ListUsersResult {
     /**
-     * The list of {@link auth.UserRecord `UserRecord`} objects for the
+     * The list of {@link UserRecord} objects for the
      * current downloaded batch.
      */
     users: UserRecord[];
@@ -49,8 +49,7 @@ export interface ListUsersResult {
     pageToken?: string;
 }
 /**
- * Represents the result of the
- * {@link auth.Auth.deleteUsers `deleteUsers()`}
+ * Represents the result of the {@link BaseAuth.deleteUsers}.
  * API.
  */
 export interface DeleteUsersResult {
@@ -67,13 +66,13 @@ export interface DeleteUsersResult {
     /**
      * A list of `FirebaseArrayIndexError` instances describing the errors that
      * were encountered during the deletion. Length of this list is equal to
-     * the return value of [`failureCount`](#failureCount).
+     * the return value of {@link DeleteUsersResult.failureCount}.
      */
     errors: FirebaseArrayIndexError[];
 }
 /**
  * Interface representing the session cookie options needed for the
- * {@link auth.Auth.createSessionCookie `createSessionCookie()`} method.
+ * {@link BaseAuth.createSessionCookie} method.
  */
 export interface SessionCookieOptions {
     /**
@@ -92,14 +91,14 @@ export declare abstract class BaseAuth {
      * methods. (Tenant-aware instances will also embed the tenant ID in the
      * token.)
      *
-     * See [Create Custom Tokens](/docs/auth/admin/create-custom-tokens) for code
-     * samples and detailed documentation.
+     * See {@link https://firebase.google.com/docs/auth/admin/create-custom-tokens | Create Custom Tokens}
+     * for code samples and detailed documentation.
      *
-     * @param uid The `uid` to use as the custom token's subject.
-     * @param developerClaims Optional additional claims to include
+     * @param uid - The `uid` to use as the custom token's subject.
+     * @param developerClaims - Optional additional claims to include
      *   in the custom token's payload.
      *
-     * @return A promise fulfilled with a custom token for the
+     * @returns A promise fulfilled with a custom token for the
      *   provided `uid` and payload.
      */
     createCustomToken(uid: string, developerClaims?: object): Promise<string>;
@@ -107,19 +106,23 @@ export declare abstract class BaseAuth {
      * 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](/docs/auth/admin/verify-id-tokens) for code samples
-     * and detailed documentation.
+     * 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 {@link https://firebase.google.com/docs/auth/admin/verify-id-tokens | Verify ID Tokens}
+     * for code samples and detailed documentation.
      *
-     * @param idToken The ID token to verify.
-     * @param checkRevoked Whether to check if the ID token was revoked.
+     * @param idToken - The ID token to verify.
+     * @param checkRevoked - Whether to check if the ID token was revoked.
      *   This requires an extra request to the Firebase Auth backend to check
      *   the `tokensValidAfterTime` time for the corresponding user.
      *   When not specified, this additional check is not applied.
      *
-     * @return A promise fulfilled with the
+     * @returns A promise fulfilled with the
      *   token's decoded claims if the ID token is valid; otherwise, a rejected
      *   promise.
      */
@@ -127,25 +130,25 @@ export declare abstract class BaseAuth {
     /**
      * Gets the user data for the user corresponding to a given `uid`.
      *
-     * See [Retrieve user data](/docs/auth/admin/manage-users#retrieve_user_data)
+     * See {@link https://firebase.google.com/docs/auth/admin/manage-users#retrieve_user_data | Retrieve user data}
      * for code samples and detailed documentation.
      *
-     * @param uid The `uid` corresponding to the user whose data to fetch.
+     * @param uid - The `uid` corresponding to the user whose data to fetch.
      *
-     * @return A promise fulfilled with the user
+     * @returns A promise fulfilled with the user
      *   data corresponding to the provided `uid`.
      */
     getUser(uid: string): Promise<UserRecord>;
     /**
      * Gets the user data for the user corresponding to a given email.
      *
-     * See [Retrieve user data](/docs/auth/admin/manage-users#retrieve_user_data)
+     * See {@link https://firebase.google.com/docs/auth/admin/manage-users#retrieve_user_data | Retrieve user data}
      * for code samples and detailed documentation.
      *
-     * @param email The email corresponding to the user whose data to
+     * @param email - The email corresponding to the user whose data to
      *   fetch.
      *
-     * @return A promise fulfilled with the user
+     * @returns A promise fulfilled with the user
      *   data corresponding to the provided email.
      */
     getUserByEmail(email: string): Promise<UserRecord>;
@@ -153,16 +156,30 @@ export declare abstract class BaseAuth {
      * 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](/docs/auth/admin/manage-users#retrieve_user_data)
+     * See {@link https://firebase.google.com/docs/auth/admin/manage-users#retrieve_user_data | Retrieve user data}
      * for code samples and detailed documentation.
      *
-     * @param phoneNumber The phone number corresponding to the user whose
+     * @param phoneNumber - The phone number corresponding to the user whose
      *   data to fetch.
      *
-     * @return A promise fulfilled with the user
+     * @returns A promise fulfilled with the user
      *   data corresponding to the provided phone number.
      */
     getUserByPhoneNumber(phoneNumber: string): Promise<UserRecord>;
+    /**
+     * Gets the user data for the user corresponding to a given provider id.
+     *
+     * See {@link https://firebase.google.com/docs/auth/admin/manage-users#retrieve_user_data | Retrieve user data}
+     * for code samples and detailed documentation.
+     *
+     * @param providerId - The provider ID, for example, "google.com" for the
+     *   Google provider.
+     * @param uid - The user identifier for the given provider.
+     *
+     * @returns A promise fulfilled with the user data corresponding to the
+     *   given provider id.
+     */
+    getUserByProviderUid(providerId: string, uid: string): Promise<UserRecord>;
     /**
      * Gets the user data corresponding to the specified identifiers.
      *
@@ -172,9 +189,9 @@ export declare abstract class BaseAuth {
      * Only a maximum of 100 identifiers may be supplied. If more than 100 identifiers are supplied,
      * this method throws a FirebaseAuthError.
      *
-     * @param identifiers The identifiers used to indicate which user records should be returned.
-     *     Must have <= 100 entries.
-     * @return {Promise<GetUsersResult>} A promise that resolves to the corresponding user records.
+     * @param identifiers - The identifiers used to indicate which user records should be returned.
+     *     Must not have more than 100 entries.
+     * @returns A promise that resolves to the corresponding user records.
      * @throws FirebaseAuthError If any of the identifiers are invalid or if more than 100
      *     identifiers are specified.
      */
@@ -184,39 +201,39 @@ export declare abstract class BaseAuth {
      * 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](/docs/auth/admin/manage-users#list_all_users)
+     * See {@link https://firebase.google.com/docs/auth/admin/manage-users#list_all_users | List all users}
      * for code samples and detailed documentation.
      *
-     * @param maxResults The page size, 1000 if undefined. This is also
+     * @param maxResults - The page size, 1000 if undefined. This is also
      *   the maximum allowed limit.
-     * @param pageToken The next page token. If not specified, returns
+     * @param pageToken - The next page token. If not specified, returns
      *   users starting without any offset.
-     * @return A promise that resolves with
+     * @returns A promise that resolves with
      *   the current batch of downloaded users and the next page token.
      */
     listUsers(maxResults?: number, pageToken?: string): Promise<ListUsersResult>;
     /**
      * Creates a new user.
      *
-     * See [Create a user](/docs/auth/admin/manage-users#create_a_user) for code
-     * samples and detailed documentation.
+     * See {@link https://firebase.google.com/docs/auth/admin/manage-users#create_a_user | Create a user}
+     * for code samples and detailed documentation.
      *
-     * @param properties The properties to set on the
+     * @param properties - The properties to set on the
      *   new user record to be created.
      *
-     * @return A promise fulfilled with the user
+     * @returns A promise fulfilled with the user
      *   data corresponding to the newly created user.
      */
     createUser(properties: CreateRequest): Promise<UserRecord>;
     /**
      * Deletes an existing user.
      *
-     * See [Delete a user](/docs/auth/admin/manage-users#delete_a_user) for code
-     * samples and detailed documentation.
+     * See {@link https://firebase.google.com/docs/auth/admin/manage-users#delete_a_user | Delete a user}
+     * for code samples and detailed documentation.
      *
-     * @param uid The `uid` corresponding to the user to delete.
+     * @param uid - The `uid` corresponding to the user to delete.
      *
-     * @return An empty promise fulfilled once the user has been
+     * @returns An empty promise fulfilled once the user has been
      *   deleted.
      */
     deleteUser(uid: string): Promise<void>;
@@ -236,9 +253,9 @@ export declare abstract class BaseAuth {
      * delete more than 1000 users, you may need to add a delay to ensure you
      * don't go over this limit.
      *
-     * @param uids The `uids` corresponding to the users to delete.
+     * @param uids - The `uids` corresponding to the users to delete.
      *
-     * @return A Promise that resolves to the total number of successful/failed
+     * @returns 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.
      */
@@ -246,14 +263,14 @@ export declare abstract class BaseAuth {
     /**
      * Updates an existing user.
      *
-     * See [Update a user](/docs/auth/admin/manage-users#update_a_user) for code
-     * samples and detailed documentation.
+     * See {@link https://firebase.google.com/docs/auth/admin/manage-users#update_a_user | Update a user}
+     * for code samples and detailed documentation.
      *
-     * @param uid The `uid` corresponding to the user to update.
-     * @param properties The properties to update on
+     * @param uid - The `uid` corresponding to the user to update.
+     * @param properties - The properties to update on
      *   the provided user.
      *
-     * @return A promise fulfilled with the
+     * @returns A promise fulfilled with the
      *   updated user data.
      */
     updateUser(uid: string, properties: UpdateRequest): Promise<UserRecord>;
@@ -266,40 +283,38 @@ export declare abstract class BaseAuth {
      * 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](/docs/auth/admin/custom-claims)
+     * See {@link https://firebase.google.com/docs/auth/admin/custom-claims |
+     * Defining user roles and access levels}
      * for code samples and detailed documentation.
      *
-     * @param uid The `uid` of the user to edit.
-     * @param customUserClaims The developer claims to set. If null is
+     * @param uid - The `uid` of the user to edit.
+     * @param customUserClaims - The developer claims to set. If null is
      *   passed, existing custom claims are deleted. Passing a custom claims payload
      *   larger than 1000 bytes will throw an error. Custom claims are added to the
      *   user's ID token which is transmitted on every authenticated request.
      *   For profile non-access related user attributes, use database or other
      *   separate storage systems.
-     * @return A promise that resolves when the operation completes
+     * @returns A promise that resolves when the operation completes
      *   successfully.
      */
     setCustomUserClaims(uid: string, customUserClaims: object | null): Promise<void>;
     /**
      * Revokes all refresh tokens for an existing user.
      *
-     * This API will update the user's
-     * {@link auth.UserRecord.tokensValidAfterTime `tokensValidAfterTime`} to
+     * This API will update the user's {@link 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
-     * {@link auth.Auth.verifyIdToken `verifyIdToken(idToken, true)`}
+     * ID tokens are revoked, use {@link BaseAuth.verifyIdToken}
      * where `checkRevoked` is set to true.
      *
-     * @param uid The `uid` corresponding to the user whose refresh tokens
+     * @param uid - The `uid` corresponding to the user whose refresh tokens
      *   are to be revoked.
      *
-     * @return An empty promise fulfilled once the user's refresh
+     * @returns An empty promise fulfilled once the user's refresh
      *   tokens have been revoked.
      */
     revokeRefreshTokens(uid: string): Promise<void>;
@@ -307,15 +322,15 @@ export declare abstract class BaseAuth {
      * 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,
-     * {@link auth.UserImportOptions `UserImportOptions`} are required to be
+     * {@link 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.
      *
-     * @param users The list of user records to import to Firebase Auth.
-     * @param options The user import options, required when the users provided include
+     * @param users - The list of user records to import to Firebase Auth.
+     * @param options - The user import options, required when the users provided include
      *   password credentials.
-     * @return A promise that resolves when
+     * @returns 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.
@@ -327,36 +342,40 @@ export declare abstract class BaseAuth {
      * 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](/docs/auth/admin/manage-cookies) for code
-     * samples and detailed documentation.
+     * See {@link https://firebase.google.com/docs/auth/admin/manage-cookies | Manage Session Cookies}
+     * for code samples and detailed documentation.
      *
-     * @param idToken The Firebase ID token to exchange for a session
+     * @param idToken - The Firebase ID token to exchange for a session
      *   cookie.
-     * @param sessionCookieOptions The session
+     * @param sessionCookieOptions - The session
      *   cookie options which includes custom session duration.
      *
-     * @return A promise that resolves on success with the
+     * @returns A promise that resolves on success with the
      *   created session cookie.
      */
     createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions): Promise<string>;
     /**
      * 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.
+     * 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](/docs/auth/admin/manage-cookies#verify_session_cookie_and_check_permissions)
+     * See {@link https://firebase.google.com/docs/auth/admin/manage-cookies#verify_session_cookie_and_check_permissions |
+     * Verify Session Cookies}
      * for code samples and detailed documentation
      *
-     * @param sessionCookie The session cookie to verify.
-     * @param checkForRevocation  Whether to check if the session cookie was
+     * @param sessionCookie - The session cookie to verify.
+     * @param checkForRevocation -  Whether to check if the session cookie was
      *   revoked. This requires an extra request to the Firebase Auth backend to
      *   check the `tokensValidAfterTime` time for the corresponding user.
      *   When not specified, this additional check is not performed.
      *
-     * @return A promise fulfilled with the
+     * @returns A promise fulfilled with the
      *   session cookie's decoded claims if the session cookie is valid; otherwise,
      *   a rejected promise.
      */
@@ -364,7 +383,7 @@ export declare abstract class BaseAuth {
     /**
      * 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  {@link auth.ActionCodeSettings `ActionCodeSettings`} object
+     * optional  {@link 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.
      *
@@ -393,9 +412,9 @@ export declare abstract class BaseAuth {
      *     });
      * ```
      *
-     * @param email The email address of the user whose password is to be
+     * @param email - The email address of the user whose password is to be
      *   reset.
-     * @param actionCodeSettings The action
+     * @param actionCodeSettings - The action
      *     code settings. If specified, the state/continue URL is set as the
      *     "continueUrl" parameter in the password reset link. The default password
      *     reset landing page will use this to display a link to go back to the app
@@ -408,13 +427,12 @@ export declare abstract class BaseAuth {
      *     and accepts the Firebase Dynamic Links terms of service.
      *     The Android package name and iOS bundle ID are respected only if they
      *     are configured in the same Firebase Auth project.
-     * @return A promise that resolves with the generated link.
+     * @returns A promise that resolves with the generated link.
      */
     generatePasswordResetLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;
     /**
      * Generates the out of band email action link to verify the user's ownership
-     * of the specified email. The
-     * {@link auth.ActionCodeSettings `ActionCodeSettings`} object provided
+     * of the specified email. The {@link 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.
@@ -444,8 +462,8 @@ export declare abstract class BaseAuth {
      *     });
      * ```
      *
-     * @param email The email account to verify.
-     * @param actionCodeSettings The action
+     * @param email - The email account to verify.
+     * @param actionCodeSettings - The action
      *     code settings. If specified, the state/continue URL is set as the
      *     "continueUrl" parameter in the email verification link. The default email
      *     verification landing page will use this to display a link to go back to
@@ -458,13 +476,12 @@ export declare abstract class BaseAuth {
      *     and accepts the Firebase Dynamic Links terms of service.
      *     The Android package name and iOS bundle ID are respected only if they
      *     are configured in the same Firebase Auth project.
-     * @return A promise that resolves with the generated link.
+     * @returns A promise that resolves with the generated link.
      */
     generateEmailVerificationLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;
     /**
      * Generates the out of band email action link to verify the user's ownership
-     * of the specified email. The
-     * {@link auth.ActionCodeSettings `ActionCodeSettings`} object provided
+     * of the specified email. The {@link 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.
@@ -494,8 +511,8 @@ export declare abstract class BaseAuth {
      *     });
      * ```
      *
-     * @param email The email account to verify.
-     * @param actionCodeSettings The action
+     * @param email - The email account to verify.
+     * @param actionCodeSettings - The action
      *     code settings. If specified, the state/continue URL is set as the
      *     "continueUrl" parameter in the email verification link. The default email
      *     verification landing page will use this to display a link to go back to
@@ -508,7 +525,7 @@ export declare abstract class BaseAuth {
      *     and accepts the Firebase Dynamic Links terms of service.
      *     The Android package name and iOS bundle ID are respected only if they
      *     are configured in the same Firebase Auth project.
-     * @return A promise that resolves with the generated link.
+     * @returns A promise that resolves with the generated link.
      */
     generateSignInWithEmailLink(email: string, actionCodeSettings: ActionCodeSettings): Promise<string>;
     /**
@@ -517,10 +534,10 @@ export declare abstract class BaseAuth {
      *
      * 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](https://cloud.google.com/identity-platform).
+     * see the {@link https://cloud.google.com/identity-platform | GCIP documentation}.
      *
-     * @param options The provider config filter to apply.
-     * @return A promise that resolves with the list of provider configs meeting the
+     * @param options - The provider config filter to apply.
+     * @returns A promise that resolves with the list of provider configs meeting the
      *   filter requirements.
      */
     listProviderConfigs(options: AuthProviderConfigFilter): Promise<ListProviderConfigResults>;
@@ -532,11 +549,11 @@ export declare abstract class BaseAuth {
      *
      * 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](https://cloud.google.com/identity-platform).
+     * see the {@link https://cloud.google.com/identity-platform | GCIP documentation}.
      *
-     * @param providerId The provider ID corresponding to the provider
+     * @param providerId - The provider ID corresponding to the provider
      *     config to return.
-     * @return A promise that resolves
+     * @returns A promise that resolves
      *     with the configuration corresponding to the provided ID.
      */
     getProviderConfig(providerId: string): Promise<AuthProviderConfig>;
@@ -547,11 +564,11 @@ export declare abstract class BaseAuth {
      *
      * 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](https://cloud.google.com/identity-platform).
+     * see the {@link https://cloud.google.com/identity-platform | GCIP documentation}.
      *
-     * @param providerId The provider ID corresponding to the provider
+     * @param providerId - The provider ID corresponding to the provider
      *     config to delete.
-     * @return A promise that resolves on completion.
+     * @returns A promise that resolves on completion.
      */
     deleteProviderConfig(providerId: string): Promise<void>;
     /**
@@ -562,12 +579,12 @@ export declare abstract class BaseAuth {
      *
      * 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](https://cloud.google.com/identity-platform).
+     * see the {@link https://cloud.google.com/identity-platform | GCIP documentation}.
      *
-     * @param providerId The provider ID corresponding to the provider
+     * @param providerId - The provider ID corresponding to the provider
      *     config to update.
-     * @param updatedConfig The updated configuration.
-     * @return A promise that resolves with the updated provider configuration.
+     * @param updatedConfig - The updated configuration.
+     * @returns A promise that resolves with the updated provider configuration.
      */
     updateProviderConfig(providerId: string, updatedConfig: UpdateAuthProviderRequest): Promise<AuthProviderConfig>;
     /**
@@ -576,20 +593,21 @@ export declare abstract class BaseAuth {
      *
      * 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](https://cloud.google.com/identity-platform).
+     * see the {@link https://cloud.google.com/identity-platform | GCIP documentation}.
      *
-     * @param config The provider configuration to create.
-     * @return A promise that resolves with the created provider configuration.
+     * @param config - The provider configuration to create.
+     * @returns A promise that resolves with the created provider configuration.
      */
     createProviderConfig(config: AuthProviderConfig): Promise<AuthProviderConfig>;
     /**
-     * Verifies the decoded Firebase issued JWT is not revoked. Returns a promise that resolves
-     * with the decoded claims on success. Rejects the promise with revocation error if revoked.
+     * Verifies the decoded Firebase issued JWT is not revoked or disabled. Returns a promise that
+     * resolves with the decoded claims on success. Rejects the promise with revocation error if revoked
+     * or user disabled.
      *
-     * @param decodedIdToken The JWT's decoded claims.
-     * @param revocationErrorInfo The revocation error info to throw on revocation
+     * @param decodedIdToken - The JWT's decoded claims.
+     * @param revocationErrorInfo - The revocation error info to throw on revocation
      *     detection.
-     * @return A Promise that will be fulfilled after a successful verification.
+     * @returns A promise that will be fulfilled after a successful verification.
      */
-    private verifyDecodedJWTNotRevoked;
+    private verifyDecodedJWTNotRevokedOrDisabled;
 }