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 de 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 de Auth asociado con una app específica.

Clases

Clase	Descripción
Autenticación	Servicio de autenticación vinculado a la app proporcionada. Una instancia de Auth puede tener varios usuarios.
AuthClientErrorCode.	Códigos de error del cliente de autenticación y sus mensajes predeterminados
BaseAuth	Interfaz superior común para las APIs de `Auth` y `TenantAwareAuth`.
FirebaseAuthError	Estructura del código de error de Firebase Auth. Esto extiende PrefixedFirebaseError.
MultiFactorInfo	Interfaz que representa las propiedades comunes de un segundo factor que inscribe el usuario.
MultiFactorSettings	La configuración del usuario relacionada con varios factores.
PhoneMultiFactorInfo	Interfaz que representa un segundo factor inscrito por el usuario específico del teléfono.
Configuración de proyecto	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 que se puedan usar multiusuarios en un proyecto de Google Cloud Identity Platform, los usuarios deben tener permiso 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 de usuario y la configuración de autenticación de correo electrónico. Para la administración de configuraciones del proveedor de OIDC/SAML, se deben usar las 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 todos los demás parámetros de configuración de un usuario. Se deberán administrar desde la IU de la consola de Cloud.
TenantAwareAuth	Interfaz `Auth` adaptada al usuario que se usa para administrar usuarios, configurar proveedores de SAML/OIDC, generar vínculos de correo electrónico para el restablecimiento de contraseñas, la verificación por correo electrónico, etc., para usuarios específicos.La compatibilidad con multiusuarios requiere Identity Platform de Google Cloud (GCIP). 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, parámetros de configuración y conjuntos de usuarios. Con `TenantAwareAuth`, también se pueden administrar los usuarios de un usuario específico y las configuraciones correspondientes de OIDC/SAML, se pueden verificar tokens de ID de usuarios que accedieron a un usuario específico y también se pueden generar vínculos de acción de correo electrónico para usuarios que pertenecen al usuario.Se pueden crear instancias de `TenantAwareAuth` para un `tenantId` específico llamando a TenantManager.authForTenant().
TenantManager	Define el administrador de usuarios que se usa para ayudar a administrar las operaciones relacionadas con el usuario. Esto incluye: La capacidad de crear, actualizar, enumerar, obtener y borrar usuarios del proyecto subyacente. Obtener una instancia de `TenantAwareAuth` para ejecutar operaciones relacionadas con Auth (administración de usuarios, administración de 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 de usuario	Representa la información del usuario de un proveedor de identidad de terceros, como Google o Facebook.
UserMetadata	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 requerida con identificadores opcionales de paquete de iOS y Android.
AllowByDefault	Define una política para permitir cada región de forma predeterminada y agregar regiones no permitidas a una lista de elementos no permitidos.
AllowByDefaultWrap	Configuración de la región de SMS mutua exclusiva de la interfaz AllowByDefault
Solo lista de entidades permitidas	Define una política de permitir solo regiones agregándolas explícitamente a una lista de entidades permitidas.
AllowlistOnlyWrap	Configuración de región de SMS mutuamente exclusiva para la interfaz AllowlistOnly
AuthProviderConfigFilter	La interfaz de filtro que se usa para mostrar la lista de 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 base del proveedor de autenticación
BaseCreateMultiFactorInfoRequest	Interfaz que representa las propiedades base de un segundo factor que inscribió el usuario para un elemento `CreateRequest`.
BaseUpdateMultiFactorInfoRequest	Interfaz que representa las propiedades comunes de un segundo factor que inscribió el usuario para un elemento `UpdateRequest`.
CreatePhoneMultiFactorInfoRequest	Interfaz que representa un segundo factor inscrito por el usuario específico del teléfono para un `CreateRequest`.
CreateRequest:	Interfaz que representa las propiedades que se deben configurar en un nuevo registro de usuario que se creará.
CustomStrengthOptionsConfig	Restricciones que se deben aplicar en la política de contraseñas
DecodedAuthBlockingToken
DecodedIdToken	Interfaz que representa un token de ID de Firebase decodificado, que se muestra desde 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 acerca de las propiedades específicas a continuación.
DeleteUsersResult.	Representa el resultado de BaseAuth.deleteUsers(). en la API de Cloud.
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 las configuraciones del proveedor. Solo está disponible cuando se listan todos los proveedores de identidad de configuraciones a través de BaseAuth.listProviderConfigs().
ListTenantsResult	Interfaz que representa el objeto que se muestra en una operación TenantManager.listTenants(). Contiene la lista de usuarios del lote actual y el token de la página siguiente si está disponible.
ListUsersResult	Interfaz que representa el objeto que se muestra en 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 de varios factores está habilitada o inhabilitada, y la lista de desafíos de segundo factor compatibles.
MultiFactorCreateSettings	La configuración de usuario relacionada con varios factores para las operaciones de creación.
MultiFactorProviderConfig	Interfaz que representa la configuración de un proveedor de autenticación de varios factores. Esta interfaz se usa para proveedores de autenticación de segundo factor distintos de SMS. Actualmente, solo se admite TOTP.
MultiFactorUpdateSettings	La configuración de usuario relacionada con varios factores para las 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 una de las siguientes opciones 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 de [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
Identificador de teléfono	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. Si 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 (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 a través de 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.
Identificador de UI	Se usa para buscar una cuenta por UID.Consulta BaseAuth.getUsers().
UpdatePhoneMultiFactorInfoRequest	Interfaz que representa un segundo factor inscrito por el usuario específico del teléfono para una `UpdateRequest`.
UpdateProjectConfigRequest	Interfaz que representa las propiedades que se deben actualizar en la configuración del proyecto proporcionada.
UpdateRequest	Es la interfaz que representa las propiedades que se deben actualizar 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 de usuarios necesarias para el método BaseAuth.importUsers(). Se usa para proporcionar la 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 por lotes de usuarios 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 puede asociarse 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	Tipo que representa las propiedades de un segundo factor que inscribió un usuario para un `CreateRequest`.
CreateTenantRequest.	Interfaz que representa las propiedades que se deben configurar 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. - "BLOCK": Se bloqueará la solicitud protegida por reCAPTCHA.
RecaptchaKeyClientType	El tipo de plataforma de la clave.
RecaptchaProviderEnforcementState	Estado de aplicación de la protección reCAPTCHA. - “DESACTIVADO”: no se aplicó. - “AUDITORÍA”: crea la evaluación, pero no aplique el resultado. - “ENFORCE”: Crea la evaluación y aplica el resultado.
SmsRegionConfig.	La interfaz de solicitud para actualizar una configuración de región de SMS. Configura las regiones en las que 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	Tipo que representa las propiedades de un segundo factor que inscribió un usuario para un elemento `UpdateRequest`.
Identificador de usuario	Identifica a un usuario que se debe buscar.

getAuth(aplicación)

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

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

Firma:

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

Parámetros

Parámetro	Tipo	Descripción
app	App

Muestra:

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 que inscribió un usuario para un CreateRequest.

Firma:

export type CreateMultiFactorInfoRequest = CreatePhoneMultiFactorInfoRequest;

CreateTenantRequest

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

Firma:

export type CreateTenantRequest = UpdateTenantRequest;

Tipo de algoritmo hash

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ón de las políticas de contraseñas

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. - "BLOCK": Se bloqueará la solicitud protegida por reCAPTCHA.

Firma:

export type RecaptchaAction = 'BLOCK';

TipoDeClienteClavedeRecaptcha

El tipo de plataforma de la clave.

Firma:

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

RecaptchaProviderEnforcementState

Estado de aplicación de la protección reCAPTCHA. - “DESACTIVADO”: no se aplicó. - “AUDITORÍA”: crea la evaluación, pero no aplique el resultado. - “ENFORCE”: Crea la evaluación y aplica el resultado.

Firma:

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

SmsRegionConfig

La interfaz de solicitud para actualizar una configuración de región de SMS. Configura las regiones en las que 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 que inscribió un usuario para un UpdateRequest.

Firma:

export type UpdateMultiFactorInfoRequest = UpdatePhoneMultiFactorInfoRequest;

Identificador de usuario

Identifica a un usuario que se debe buscar.

Firma:

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