Firebase is back at Google I/O on May 14! Register now.

Se usó la API de Cloud Translation para traducir esta página.

firebase-admin.auth package

Firebase Authentication.

Funciones

Función	Descripción
getAuth(app)	Obtiene el servicio Auth para la app predeterminada o una app determinada.Se puede llamar a `getAuth()` sin argumentos para acceder al servicio Auth de la app predeterminada o como `getAuth(app)` para acceder al servicio Auth asociado con una app específica.

Clases

Clase	Descripción
Autenticación	El servicio de Auth está vinculado a la app proporcionada. Una instancia de Auth puede tener múltiples usuarios.
BaseAuth	Interfaz superior común para las APIs de `Auth` y `TenantAwareAuth`
Información de varios factores	Interfaz que representa las propiedades comunes de un segundo factor inscrito por el usuario.
Configuración de varios factores	La configuración del usuario relacionada con varios factores.
PhoneMultiFactorInfo	Interfaz que representa un segundo factor específico de un teléfono que inscribió un usuario.
ProjectConfig	Representa la configuración de un proyecto.
ProjectConfigManager.	Administra (obtiene y actualiza) la configuración actual del proyecto.
Usuario	Representa la configuración de un usuario.La compatibilidad con la función multiusuario requiere Identity Platform (GCIP) de Google Cloud. Para obtener más información sobre GCIP, incluidos los precios y las funciones, consulta la documentación de GCIP.Antes de poder usar la función multiusuario en un proyecto de Google Cloud Identity Platform, se debe permitir a los usuarios en ese proyecto a través de la IU de la consola de Cloud.Una configuración de usuario proporciona información como el nombre visible, el identificador del usuario y la configuración de la autenticación por correo electrónico. Para la administración de la configuración del proveedor de OIDC/SAML, se deben usar instancias de `TenantAwareAuth` en lugar de `Tenant` para recuperar la lista de IdP configurados en un usuario. Cuando configures estos proveedores, ten en cuenta que los usuarios heredarán los dominios incluidos en la lista de entidades permitidas y los URI de redireccionamiento autenticados de sus proyectos superiores.También se heredarán todas las demás opciones de configuración de un usuario. Estos deberán administrarse desde la IU de la consola de Cloud.
TenantAwareAuth	Es una interfaz `Auth` adaptada al usuario que se usa para administrar usuarios, configurar proveedores de SAML/OIDC, generar vínculos de correo electrónico para restablecer contraseñas, verificar por correo electrónico, etc. de usuarios específicos.La compatibilidad con los usuarios múltiples requiere Identity Platform (GCIP) de Google Cloud. Para obtener más información sobre GCIP, incluidos los precios y las funciones, consulta la documentación de GCIP.Cada usuario contiene sus propios proveedores de identidad, configuración y conjuntos de usuarios. Con `TenantAwareAuth`, también se pueden administrar los usuarios de un usuario específico y las configuraciones de OIDC/SAML correspondientes, se pueden verificar los tokens de ID de los usuarios que accedieron a un usuario específico y también se pueden generar vínculos de acciones de correo electrónico para los usuarios que pertenecen al usuario.Se puede crear una instancia de `TenantAwareAuth` para una `tenantId` específica llamando a TenantManager.authForTenant().
TenantManager;	Define el administrador de usuarios que se usa para ayudar a administrar las operaciones relacionadas con las instancias. Esto incluye: La capacidad de crear, actualizar, enumerar, obtener y borrar usuarios para el proyecto subyacente Obtener una instancia de `TenantAwareAuth` para ejecutar operaciones relacionadas con Auth (administración de usuarios, administración de la configuración del proveedor, verificación de tokens, generación de vínculos de correo electrónico, etc.) en el contexto de un usuario especificado
Información del usuario	Representa la información de un usuario de un proveedor de identidad externo, como Google o Facebook.
Metadatos del usuario	Representa los metadatos de un usuario.
Registro de usuario	Representa a un usuario.

Interfaces

Interfaz	Descripción
ActionCodeSettings.	Esta es la interfaz que define la URL de estado o continuación obligatoria con identificadores de paquete opcionales de iOS y Android.
PermitirPorPredeterminado	Define una política que permite cada región de forma predeterminada y agrega regiones no permitidas a una lista de elementos no permitidos.
AllowByDefaultWrap	Configuración de región de SMS mutuamente excluyente de la interfaz AllowByDefault
AllowlistOnly	Define una política que permite solo regiones agregándolas explícitamente a una lista de entidades permitidas.
AllowlistOnlyWrap	Configuración de región de SMS mutuamente exclusiva de la interfaz AllowlistOnly
AuthProviderConfigFilter.	La interfaz de filtro que se usa para enumerar las configuraciones del proveedor. Se usa cuando se especifica cómo enumerar los proveedores de identidad configurados a través de BaseAuth.listProviderConfigs().
BaseAuthProviderConfig.	La interfaz de configuración del proveedor de autenticación base.
BaseCreateMultiFactorInfoRequest	Interfaz que representa las propiedades base de un segundo factor inscrito por el usuario para una `CreateRequest`.
BaseUpdateMultiFactorInfoRequest	Interfaz que representa las propiedades comunes de un segundo factor inscrito por el usuario para una `UpdateRequest`.
CreatePhoneMultiFactorInfoRequest.	Interfaz que representa un segundo factor específico de teléfono inscrito por el usuario para una `CreateRequest`
CreateRequest.	Interfaz que representa las propiedades que se configurarán en un nuevo registro de usuario que se creará.
Configuración de la calidad personalizada	Restricciones que se aplicarán en la política de contraseñas
DecodedAuthBlockingToken
DecodedIdToken	Interfaz que representa un token de ID de Firebase decodificado, que se muestra con el método BaseAuth.verifyIdToken().Los tokens de ID de Firebase son tokens web JSON (JWT) que cumplen con las especificaciones de OpenID Connect. Consulta la [sección de token de ID de las especificaciones de OpenID Connect](http://openid.net/specs/openid-connect-core-1_0.html#IDToken) para obtener más información sobre las propiedades específicas a continuación.
DeleteUsersResult	Representa el resultado de la API de BaseAuth.deleteUsers().
EmailIdentifier	Se usa para buscar una cuenta por correo electrónico.Consulta BaseAuth.getUsers().
EmailPrivacyConfig.	La configuración de privacidad del correo electrónico de un proyecto o usuario.
EmailSignInProviderConfig.	La configuración del proveedor de acceso por correo electrónico.
GetUsersResult	Representa el resultado de la API de BaseAuth.getUsers().
ListProviderConfigResults.	La interfaz de respuesta para enumerar los parámetros de configuración del proveedor. Esta opción solo está disponible cuando se enumeran todas las configuraciones de los proveedores de identidad a través de BaseAuth.listProviderConfigs().
ListTenantsResult	Interfaz que representa el objeto que se muestra desde una operación TenantManager.listTenants(). Contiene la lista de usuarios para el lote actual y el token de la página siguiente, si está disponible.
ListUsersResult.	Interfaz que representa el objeto que se muestra después de una operación BaseAuth.listUsers(). Contiene la lista de usuarios para el lote actual y el token de la página siguiente, si está disponible.
MultiFactorConfig	Interfaz que representa una configuración de varios factores. Se puede usar para definir si la autenticación multifactor está habilitada o inhabilitada y la lista de desafíos de segundos factores que se admiten.
MultiFactorCreateSettings	La configuración del usuario relacionada con varios factores para operaciones de creación.
MultiFactorProviderConfig.	Interfaz que representa una configuración del proveedor de autenticación multifactor. Esta interfaz se usa para proveedores de autenticación de dos factores distintos de SMS. Actualmente, solo se admite TOTP.
MultiFactorUpdateSettings	La configuración del usuario relacionada con varios factores para operaciones de actualización.
OAuthResponseType	La interfaz que representa el objeto de respuesta del proveedor de OIDC para el flujo de autorización de OAuth. Se requiere uno de los siguientes parámetros de configuración: Establece `code` en `true` para el flujo de código. Establece `idToken` en `true` para el flujo del token de ID.
OIDCAuthProviderConfig.	La interfaz de configuración del proveedor de autenticación [OIDC](https://openid.net/specs/openid-connect-core-1_0-final.html) Se puede crear un proveedor de OIDC a través de BaseAuth.createProviderConfig().
OIDCUpdateAuthProviderRequest.	La interfaz de solicitud para actualizar un proveedor de autenticación de OIDC. Se usa cuando se actualiza la configuración de un proveedor de OIDC a través de BaseAuth.updateProviderConfig().
PasswordPolicyConfig	Una configuración de política de contraseñas para un proyecto o usuario
PhoneIdentifier	Se usa para buscar una cuenta por número de teléfono.Consulta BaseAuth.getUsers().
ProviderIdentifier	Se usa para buscar una cuenta por proveedor federado.Consulta BaseAuth.getUsers().
RecaptchaConfig	La interfaz de solicitud para actualizar una configuración de reCAPTCHA. Cuando habilitas la integración de reCAPTCHA Enterprise, aceptas las Condiciones del Servicio de reCAPTCHA Enterprise.
RecaptchaKey	La configuración de la clave de reCAPTCHA.
RecaptchaManagedRule	La configuración de una regla de acción de reCAPTCHA.
SAMLAuthProviderConfig.	La interfaz de configuración del proveedor de autenticación [SAML](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html) Se puede crear un proveedor de SAML con BaseAuth.createProviderConfig().
SAMLUpdateAuthProviderRequest.	La interfaz de solicitud para actualizar un proveedor de autenticación de SAML. Se usa cuando se actualiza la configuración de un proveedor de SAML a través de BaseAuth.updateProviderConfig().
SessionCookieOptions.	Interfaz que representa las opciones de cookies de sesión necesarias para el método BaseAuth.createSessionCookie().
TotpMultiFactorProviderConfig.	Interfaz que representa los parámetros de configuración de la autenticación de segundo factor de TOTP.
UidIdentifier	Se usa para buscar una cuenta según el uid.Consulta BaseAuth.getUsers().
UpdatePhoneMultiFactorInfoRequest.	Interfaz que representa un segundo factor específico de teléfono inscrito por el usuario para una `UpdateRequest`
UpdateProjectConfigRequest.	Interfaz que representa las propiedades que se actualizarán en la configuración del proyecto proporcionada.
Solicitud de actualización	Interfaz que representa las propiedades que se actualizarán en el usuario proporcionado.
UpdateTenantRequest.	Interfaz que representa las propiedades que se actualizarán en el usuario proporcionado.
UserImportOptions.	Interfaz que representa las opciones de importación del usuario necesarias para el método BaseAuth.importUsers(). Esto se usa para proporcionar información del algoritmo de hash de contraseñas.
UserImportRecord.	Interfaz que representa a un usuario para importar a Firebase Auth a través del método BaseAuth.importUsers().
UserImportResult.	Interfaz que representa la respuesta del método BaseAuth.importUsers() para la importación de usuarios por lotes a Firebase Auth.
UserMetadataRequest.	Metadatos de usuario que se incluirán cuando se importe un usuario.
UserProvider.	Representa un proveedor de identidad de usuario que se puede asociar con un usuario de Firebase.
UserProviderRequest.	Datos del proveedor de usuarios que se incluirán cuando se importe un usuario.

Escribe alias

Alias de tipo	Descripción
AuthFactorType	Identifica un segundo tipo de factor.
AuthProviderConfig.	El tipo de configuración del proveedor de autenticación. BaseAuth.createProviderConfig().
CreateMultiFactorInfoRequest.	Es un tipo que representa las propiedades de un segundo factor inscrito por el usuario para una `CreateRequest`.
CreateTenantRequest.	Interfaz que representa las propiedades que se configurarán en un usuario nuevo.
HashAlgorithmType
MultiFactorConfigState	Identifica un estado de configuración de varios factores.
PasswordPolicyEnforcementState.	El estado de aplicación de una política de contraseñas.
RecaptchaAction	Las acciones que se deben tomar para las solicitudes protegidas por reCAPTCHA. - "BLOQUEAR": Se bloqueará la solicitud protegida por reCAPTCHA.
RecaptchaKeyClientType	Es el tipo de plataforma de la clave.
RecaptchaProviderEnforcementState.	Estado de aplicación de la protección de reCAPTCHA. - "DESACTIVADO": No aplicado. - “AUDIT”: Crea una evaluación, pero no aplica el resultado de manera forzosa. - “ENFORCE”: Crea una evaluación y aplica el resultado.
SmsRegionConfig.	Interfaz de solicitud para actualizar una configuración de región de SMS. Configura las regiones donde los usuarios pueden enviar SMS de verificación. Se basa en el código de llamada del número de teléfono de destino.
UpdateAuthProviderRequest.
UpdateMultiFactorInfoRequest.	Es un tipo que representa las propiedades de un segundo factor inscrito por el usuario para una `UpdateRequest`.
UserIdentifier	Identifica a un usuario para que lo busquen.

getAuth(app)

Obtiene el servicio Auth para la app predeterminada o una app determinada.

Se puede llamar a getAuth() sin argumentos para acceder al servicio Auth de la app predeterminada o como getAuth(app) para acceder al servicio Auth asociado con una app específica.

Firma:

export declare function getAuth(app?: App): Auth;

Parámetros

Parámetro	Tipo	Descripción
app	App

Devuelve:

Autenticación

Ejemplo 1

// Get the Auth service for the default app
const defaultAuth = getAuth();

Ejemplo 2

// Get the Auth service for a given app
const otherAuth = getAuth(otherApp);

Tipo de factor de autenticación

Identifica un segundo tipo de factor.

Firma:

export type AuthFactorType = 'phone';

AuthProviderConfig

El tipo de configuración del proveedor de autenticación. BaseAuth.createProviderConfig().

Firma:

export type AuthProviderConfig = SAMLAuthProviderConfig | OIDCAuthProviderConfig;

CreateMultiFactorInfoRequest

Tipo que representa las propiedades de un segundo factor inscrito por el usuario para un CreateRequest.

Firma:

export type CreateMultiFactorInfoRequest = CreatePhoneMultiFactorInfoRequest;

CreateTenantRequest

Interfaz que representa las propiedades que se configurarán en un usuario nuevo.

Firma:

export type CreateTenantRequest = UpdateTenantRequest;

TipoHashAlgorithmType

Firma:

export type HashAlgorithmType = 'SCRYPT' | 'STANDARD_SCRYPT' | 'HMAC_SHA512' | 'HMAC_SHA256' | 'HMAC_SHA1' | 'HMAC_MD5' | 'MD5' | 'PBKDF_SHA1' | 'BCRYPT' | 'PBKDF2_SHA256' | 'SHA512' | 'SHA256' | 'SHA1';

Estado de configuración de varios factores

Identifica un estado de configuración de varios factores.

Firma:

export type MultiFactorConfigState = 'ENABLED' | 'DISABLED';

Estado de aplicacióndela políticadecontraseña

El estado de aplicación de una política de contraseñas.

Firma:

export type PasswordPolicyEnforcementState = 'ENFORCE' | 'OFF';

RecaptchaAction

Las acciones que se deben tomar para las solicitudes protegidas por reCAPTCHA. - "BLOQUEAR": Se bloqueará la solicitud protegida por reCAPTCHA.

Firma:

export type RecaptchaAction = 'BLOCK';

RecaptchaKeyClientType

Es el tipo de plataforma de la clave.

Firma:

export type RecaptchaKeyClientType = 'WEB' | 'IOS' | 'ANDROID';

RecaptchaProviderEnforcementState.

Estado de aplicación de la protección de reCAPTCHA. - "DESACTIVADO": No aplicado. - “AUDIT”: Crea una evaluación, pero no aplica el resultado de manera forzosa. - “ENFORCE”: Crea una evaluación y aplica el resultado.

Firma:

export type RecaptchaProviderEnforcementState = 'OFF' | 'AUDIT' | 'ENFORCE';

Configuración de la región sms

Interfaz de solicitud para actualizar una configuración de región de SMS. Configura las regiones donde los usuarios pueden enviar SMS de verificación. Se basa en el código de llamada del número de teléfono de destino.

Firma:

export type SmsRegionConfig = AllowByDefaultWrap | AllowlistOnlyWrap;

UpdateAuthProviderRequest

Firma:

export type UpdateAuthProviderRequest = SAMLUpdateAuthProviderRequest | OIDCUpdateAuthProviderRequest;

UpdateMultiFactorInfoRequest

Tipo que representa las propiedades de un segundo factor inscrito por el usuario para una UpdateRequest.

Firma:

export type UpdateMultiFactorInfoRequest = UpdatePhoneMultiFactorInfoRequest;

Identificador de usuario

Identifica a un usuario para que lo busquen.

Firma:

export type UserIdentifier = UidIdentifier | EmailIdentifier | PhoneIdentifier | ProviderIdentifier;