firebase-admin.auth package

Autenticación de base de fuego.

Funciones

Clases

Interfaces

Tipo de alias

obtenerAuth()

Obtiene el servicio de autenticación para la aplicación predeterminada o una aplicación determinada.

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

Firma:

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

Parámetros

Devoluciones:

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';

Configuración del proveedor de autenticación

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

Firma:

export type AuthProviderConfig = SAMLAuthProviderConfig | OIDCAuthProviderConfig;

Crear solicitud de información multifactor

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

Firma:

export type CreateMultiFactorInfoRequest = CreatePhoneMultiFactorInfoRequest;

Crear solicitud de inquilino

Interfaz que representa las propiedades que se establecerán en un nuevo inquilino.

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 multifactor

Identifica un estado de configuración multifactor.

Firma:

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

ContraseñaPolicyEnforcementState

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

Firma:

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

RecaptchaAcción

Las acciones a tomar para solicitudes protegidas por reCAPTCHA. - 'BLOQUEAR': La solicitud protegida por reCAPTCHA se bloqueará.

Firma:

export type RecaptchaAction = 'BLOCK';

RecaptchaKeyClientType

El tipo de plataforma de la clave.

Firma:

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

RecaptchaProviderEnforcementState

Estado de aplicación de la protección reCAPTCHA. - 'OFF': No aplicado. - 'Auditoría': crea una evaluación pero no aplica el resultado. - 'ENFORCE': Crear evaluación y hacer cumplir el resultado.

Firma:

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

Configuración de región de SMS

La 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. Esto se basa en el código de llamada del número de teléfono de destino.

Firma:

export type SmsRegionConfig = AllowByDefaultWrap | AllowlistOnlyWrap;

Solicitud de actualización de proveedor de autenticación

Firma:

export type UpdateAuthProviderRequest = SAMLUpdateAuthProviderRequest | OIDCUpdateAuthProviderRequest;

Solicitud de información de UpdateMultiFactor

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 un usuario que se va a buscar.

Firma:

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