BaseAuth class

Interfaz superior común para las APIs de Auth y TenantAwareAuth

Firma:

export declare abstract class BaseAuth

Métodos

Método Teclas modificadoras Descripción
createCustomToken(uid, developerClaims) Crea un nuevo token personalizado de Firebase (JWT) que se puede enviar de vuelta a un dispositivo cliente para usarlo para acceder con los métodos signInWithCustomToken() de los SDK de cliente. (Las instancias compatibles con usuarios también incorporarán el ID de usuario en el token).Consulta Crea tokens personalizados para ver las muestras de código y la documentación detallada.
createProviderConfig(config). Muestra una promesa que se resuelve con el AuthProviderConfig recién creado cuando se crea la nueva configuración del proveedor.La compatibilidad con proveedores de SAML y OIDC 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.
createSessionCookie(idToken, sessionCookieOptions) Crea una nueva cookie de sesión de Firebase con las opciones especificadas. La cadena de JWT creada se puede establecer como una cookie de sesión del servidor con una política de cookies personalizada y se puede usar para la administración de la sesión. El JWT de la cookie de sesión tendrá las mismas reclamaciones de carga útil que el token de ID proporcionado.Consulta Administrar cookies de sesión para ver muestras de código y documentación detallada.
createUser(propiedades) Crea un usuario nuevo.Consulta Crea un usuario para ver muestras de código y documentación detallada.
deleteProviderConfig(providerId) Borra la configuración del proveedor correspondiente al ID del proveedor que se pasó. Si no existe el ID especificado, se muestra un error auth/configuration-not-found.La compatibilidad con el proveedor de SAML y OIDC 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.
deleteUser(uid) Borra un usuario existente.Consulta Cómo borrar un usuario para ver muestras de código y documentación detallada.
deleteUsers(uids) Borra los usuarios especificados por los UID dados.Borrar un usuario que no existe no generará un error (es decir, este método es idempotente). Los usuarios que no existen se consideran borrados correctamente y, por lo tanto, se cuentan en el valor DeleteUsersResult.successCount.Solo se puede proporcionar un máximo de 1,000 identificadores. Si se proporcionan más de 1,000 identificadores, este método genera un error FirebaseAuthError.Actualmente, la tasa de esta API está limitada en el servidor a 1 QPS. Si superas este límite, es posible que recibas un mensaje de error de cuota excedida. Por lo tanto, si deseas borrar más de 1,000 usuarios, es posible que debas agregar una demora para asegurarte de no superar este límite.
generateEmailVerifyLink(email, actionCodeSettings) Genera el vínculo de acción de correo electrónico fuera de banda para verificar la propiedad del usuario del correo electrónico especificado. El objeto ActionCodeSettings proporcionado como argumento de este método define si el vínculo lo administrará una app para dispositivos móviles o un navegador, junto con información adicional de estado que se pasará en el vínculo directo, etcétera.
generatePasswordResetLink(email, actionCodeSettings) Genera el vínculo de acción de correo electrónico fuera de banda para restablecer la contraseña de un usuario. Se generará el vínculo para el usuario con la dirección de correo electrónico especificada. El objeto opcional ActionCodeSettings define si el vínculo debe controlarse a través de un navegador o una aplicación para dispositivos móviles y la información de estado adicional que se transmitirá en el vínculo directo, etcétera.
generateSignInWithEmailLink(email, actionCodeSettings) Genera el vínculo de acción de correo electrónico fuera de banda para verificar la propiedad del usuario del correo electrónico especificado. El objeto ActionCodeSettings proporcionado como argumento de este método define si el vínculo lo administrará una app para dispositivos móviles o un navegador, junto con información adicional de estado que se pasará en el vínculo directo, etcétera.
generateVerifyAndChangeEmailLink(email, newEmail, actionCodeSettings) Genera un vínculo de acción de correo electrónico fuera de banda para verificar que el usuario es el propietario del correo electrónico especificado. El objeto ActionCodeSettings proporcionado como argumento de este método define si el vínculo lo administrará una app para dispositivos móviles o un navegador, junto con información adicional de estado que se pasará en el vínculo directo, etcétera.
getProviderConfig(providerId) Busca una configuración del proveedor de autenticación con el ID proporcionado. Muestra una promesa que se resuelve con la configuración del proveedor correspondiente al ID de proveedor especificado. Si no existe el ID especificado, se muestra un error auth/configuration-not-found.La compatibilidad con el proveedor de SAML y OIDC 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.
getUser(uid) Obtiene los datos del usuario correspondientes a un uid determinado.Consulta Cómo recuperar los datos del usuario para ver muestras de código y documentación detallada.
getUserByEmail(correo electrónico) Obtiene los datos del usuario correspondientes a un correo electrónico determinado.Consulta Cómo recuperar los datos del usuario para ver muestras de código y documentación detallada.
getUserByPhoneNumber(phoneNumber). Obtiene los datos del usuario correspondientes a un número de teléfono determinado. El número de teléfono debe cumplir con la especificación E.164.Consulta Cómo recuperar los datos del usuario para obtener muestras de código y documentación detallada.
getUserByProviderUid(providerId, uid). Obtiene los datos del usuario correspondiente a un ID de proveedor determinado.Consulta Cómo recuperar los datos del usuario para ver muestras de código y documentación detallada.
getUsers(identificadores) Obtiene los datos del usuario correspondientes a los identificadores especificados.No hay garantías de orden. En particular, no se garantiza que la enésima entrada en la lista de resultados corresponda a la enésima en la lista de parámetros de entrada.Solo se puede proporcionar un máximo de 100 identificadores. Si se proporcionan más de 100 identificadores, este método genera un error FirebaseAuthError.
importUsers(users, opciones) Importa la lista de usuarios proporcionada a Firebase Auth. Se puede importar un máximo de 1,000 usuarios, uno a la vez. Cuando se importan usuarios con contraseñas, se deben especificar UserImportOptions. Esta operación está optimizada para las importaciones masivas y, además, ignorará las comprobaciones de uid, email y otros identificadores únicos que podrían generar duplicados.
listProviderConfigs(options) Muestra la lista de configuraciones del proveedor existentes que coinciden con el filtro proporcionado. Se pueden enumerar hasta 100 parámetros de configuración de proveedores a la vez.La compatibilidad con proveedores de SAML y OIDC 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.
listUsers(maxResults, pageToken) Recupera una lista de usuarios (solo lote) con un tamaño de maxResults a partir del desplazamiento según lo especificado por pageToken. Se usa para recuperar todos los usuarios de un proyecto específico por lotes.Consulta Enumerar todos los usuarios para obtener muestras de código y documentación detallada.
revokeRefreshTokens(uid) Revoca todos los tokens de actualización de un usuario existente.Esta API actualizará el UserRecord.tokensValidAfterTime del usuario al horario UTC actual. Es importante que el servidor al que se llama tenga el reloj configurado de forma correcta y sincronizado.Aunque esto revocará todas las sesiones de un usuario específico y también inhabilitará la creación de los tokens de ID nuevos para las sesiones existentes, los tokens de ID existentes pueden permanecer activos hasta su vencimiento natural (una hora). Para verificar que los tokens de ID estén revocados, usa BaseAuth.verifyIdToken(), en el que checkRevoked se establece como verdadero.
setCustomUserClaims(uid, customUserClaims) Establece reclamos adicionales de desarrollador sobre un usuario existente identificado por el uid proporcionado, que por lo general se usa para definir roles del usuario y niveles de acceso. Estas reclamaciones deben propagarse a todos los dispositivos a los que ya haya accedido el usuario (después del vencimiento del token o cuando se fuerza la actualización del token) y la próxima vez que acceda. Si se usa un nombre de reclamación de OIDC reservado (sub, iat, iss, etc.), se mostrará un error. Se configuran en el JWT del token de ID del usuario autenticado.Consulta Definición de roles de usuario y niveles de acceso para ver muestras de código y documentación detallada.
updateProviderConfig(providerId, updatedConfig) Muestra una promesa que se resuelve con el AuthProviderConfig actualizado correspondiente al ID de proveedor especificado. Si no existe el ID especificado, se muestra un error auth/configuration-not-found.La compatibilidad con el proveedor de SAML y OIDC 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.
updateUser(uid, propiedades) Actualiza un usuario existente.Consulta Actualiza un usuario para ver muestras de código y documentación detallada.
verifyIdToken(idToken, checkRestrictedd) Verifica un token de ID de Firebase (JWT). Si el token es válido, la promesa se cumple con las reclamaciones decodificadas del token; de lo contrario, se rechaza la promesa.Si se establece checkRevoked como verdadero, primero se verifica si el usuario correspondiente está inhabilitado. Si es así, se genera un error auth/user-disabled. Si no es así, verifica si se revocó la sesión correspondiente al token de ID. Si se invalida la sesión del usuario correspondiente, se genera un error auth/id-token-revoked. Si no se especifica, no se aplica la verificación.Consulta Cómo verificar tokens de ID para ver muestras de código y documentación detallada.
verifySessionCookie(sessionCookie, checkResumed) Verifica una cookie de sesión de Firebase. Muestra una promesa con las reclamaciones de cookies. Rechaza la promesa si no se pudo verificar la cookie.Si se configura checkRevoked como verdadera, primero verifica si el usuario correspondiente está inhabilitado. Si es así, se genera un error auth/user-disabled. Si no es así, verifica si se revocó la sesión correspondiente a la cookie de sesión. Si se invalida la sesión del usuario correspondiente, se genera un error auth/session-cookie-revoked. Si no se especifica, no se realiza la verificación.Consulta Verificar cookies de sesión para ver muestras de código y documentación detallada.

BaseAuth.createCustomToken()

Crea un nuevo token personalizado de Firebase (JWT) que se puede enviar de vuelta a un dispositivo cliente para usarlo para acceder con los métodos signInWithCustomToken() de los SDK de cliente. (Las instancias compatibles con usuarios también incorporarán el ID de usuario en el token).

Consulta Crear tokens personalizados para ver muestras de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
uid cadena Es el uid que se usará como asunto del token personalizado.
Reclamaciones del desarrollador objeto Reclamaciones adicionales opcionales para incluir en la carga útil del token personalizado.

Devuelve:

Promesa<string>

Una promesa cumplida con un token personalizado para el uid y la carga útil proporcionados.

BaseAuth.createProviderConfig().

Muestra una promesa que se resuelve con la AuthProviderConfig recién creada cuando se crea la nueva configuración del proveedor.

La compatibilidad con SAML y el proveedor de OIDC 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.

Firma:

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

Parámetros

Parámetro Tipo Descripción
config AuthProviderConfig. La configuración del proveedor que se creará.

Devuelve:

Promesa<AuthProviderConfig>

Una promesa que se resuelve con la configuración del proveedor creada.

BaseAuth.createSessionCookie()

Crea una nueva cookie de sesión de Firebase con las opciones especificadas. La cadena de JWT creada se puede establecer como una cookie de sesión del servidor con una política de cookies personalizada y se puede usar para la administración de la sesión. El JWT de la cookie de sesión tendrá las mismas reclamaciones de carga útil que el token de ID proporcionado.

Consulta Administrar cookies de sesión para ver muestras de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
idToken cadena El token de ID de Firebase que se intercambiará por una cookie de sesión.
Opciones de sesiónCookie SessionCookieOptions. Son las opciones de cookies de sesión que incluyen la duración personalizada de la sesión.

Devuelve:

Promesa<string>

Una promesa que se resuelve con éxito con la cookie de sesión creada.

BaseAuth.createUser()

Crea un usuario nuevo.

Consulta Crea un usuario para ver muestras de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
del bucket CreateRequest. Las propiedades que se deben configurar en el registro de usuario nuevo que se creará.

Devuelve:

Promesa<UserRecord>

Es una promesa entregada con los datos del usuario correspondientes al usuario recién creado.

BaseAuth.deleteProviderConfig()

Borra la configuración del proveedor correspondiente al ID del proveedor que se pasó. Si el ID especificado no existe, se mostrará un error auth/configuration-not-found.

La compatibilidad con SAML y el proveedor de OIDC 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.

Firma:

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

Parámetros

Parámetro Tipo Descripción
providerId cadena El ID del proveedor correspondiente a la configuración del proveedor que se borrará.

Devuelve:

Promesa<void>

Una promesa que se resuelve cuando se completa.

BaseAuth.deleteUser()

Borra un usuario existente.

Consulta Borra un usuario para ver muestras de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
uid cadena El uid correspondiente al usuario que se borrará.

Devuelve:

Promesa<void>

Una promesa vacía que se cumple una vez que se borra el usuario.

BaseAuth.deleteUsers()

Borra los usuarios especificados por los UID dados.

Borrar un usuario que no existe no generará errores (es decir, este método es idempotente). Se considera que los usuarios que no existen se borraron correctamente y, por lo tanto, se cuentan en el valor DeleteUsersResult.successCount.

Solo se puede proporcionar un máximo de 1,000 identificadores. Si se proporcionan más de 1,000 identificadores, este método genera un error FirebaseAuthError.

Actualmente, esta API tiene una tasa limitada en el servidor a 1 QPS. Si superas este límite, es posible que recibas un mensaje de error de cuota excedida. Por lo tanto, si deseas borrar más de 1,000 usuarios, es posible que debas agregar una demora para asegurarte de no superar este límite.

Firma:

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

Parámetros

Parámetro Tipo Descripción
uid string[] El uids correspondiente a los usuarios que se borrarán.

Devuelve:

Promesa<DeleteUsersResult>

Una promesa que resuelve la cantidad total de eliminaciones correctas o fallidas, así como el array de errores que corresponden a las eliminaciones con errores.

Genera el vínculo de acción de correo electrónico fuera de banda para verificar la propiedad del usuario del correo electrónico especificado. El objeto ActionCodeSettings proporcionado como argumento de este método define si el vínculo lo administrará una app para dispositivos móviles o un navegador, junto con información adicional de estado que se pasará en el vínculo directo, etcétera.

Firma:

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

Parámetros

Parámetro Tipo Descripción
email cadena La cuenta de correo electrónico que se verificará.
Configuración de códigodeacción ActionCodeSettings. La configuración del código de acción. Si se especifica, la URL de estado/continuación se establece como parámetro "continueUrl" en el vínculo de verificación por correo electrónico. La página de destino predeterminada para la verificación por correo electrónico la utilizará para mostrar un vínculo que le permitirá volver a la aplicación si está instalada. Si no se especifica actionCodeSettings, no se anexa ninguna URL a la URL de acción. La URL del estado proporcionada debe pertenecer a un dominio que el desarrollador haya incluido en la lista de entidades permitidas de la consola. De lo contrario, se genera un error. Los redireccionamientos de apps para dispositivos móviles solo se aplican si el desarrollador configura y acepta las condiciones del servicio de Firebase Dynamic Links. Solo se respetan el nombre del paquete de Android y el ID del paquete de iOS si se configuran en el mismo proyecto de Firebase Auth.

Devuelve:

Promesa<string>

Una promesa que se resuelve con el vínculo generado.

Ejemplo

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

Genera el vínculo de acción de correo electrónico fuera de banda para restablecer la contraseña de un usuario. Se generará el vínculo para el usuario con la dirección de correo electrónico especificada. El objeto opcional ActionCodeSettings define si el vínculo debe controlarse a través de un navegador o una aplicación para dispositivos móviles y la información de estado adicional que se transmitirá en el vínculo directo, etcétera.

Firma:

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

Parámetros

Parámetro Tipo Descripción
email cadena La dirección de correo electrónico del usuario cuya contraseña se restablecerá.
Configuración de códigodeacción ActionCodeSettings. La configuración del código de acción. Si se especifica, el estado/URL de continuación se establece como el parámetro "continueUrl" en el vínculo para restablecer la contraseña. La página de destino predeterminada para el restablecimiento de la contraseña la usará a fin de mostrar un vínculo para volver a la app si está instalada. Si no se especifica actionCodeSettings, no se anexa ninguna URL a la URL de acción. La URL del estado proporcionada debe pertenecer a un dominio que el desarrollador haya incluido en la lista de entidades permitidas de la consola. De lo contrario, se genera un error. Los redireccionamientos de apps para dispositivos móviles solo se aplican si el desarrollador configura y acepta las condiciones del servicio de Firebase Dynamic Links. Solo se respetan el nombre del paquete de Android y el ID del paquete de iOS si se configuran en el mismo proyecto de Firebase Auth.

Devuelve:

Promesa<string>

Una promesa que se resuelve con el vínculo generado.

Ejemplo

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

Genera el vínculo de acción de correo electrónico fuera de banda para verificar la propiedad del usuario del correo electrónico especificado. El objeto ActionCodeSettings proporcionado como argumento de este método define si el vínculo lo administrará una app para dispositivos móviles o un navegador, junto con información adicional de estado que se pasará en el vínculo directo, etcétera.

Firma:

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

Parámetros

Parámetro Tipo Descripción
email cadena La cuenta de correo electrónico que se verificará.
Configuración de códigodeacción ActionCodeSettings. La configuración del código de acción. Si se especifica, la URL de estado/continuación se establece como parámetro "continueUrl" en el vínculo de verificación por correo electrónico. La página de destino predeterminada para la verificación por correo electrónico la utilizará para mostrar un vínculo que le permitirá volver a la aplicación si está instalada. Si no se especifica actionCodeSettings, no se anexa ninguna URL a la URL de acción. La URL del estado proporcionada debe pertenecer a un dominio que el desarrollador haya incluido en la lista de entidades permitidas de la consola. De lo contrario, se genera un error. Los redireccionamientos de apps para dispositivos móviles solo se aplican si el desarrollador configura y acepta las condiciones del servicio de Firebase Dynamic Links. Solo se respetan el nombre del paquete de Android y el ID del paquete de iOS si se configuran en el mismo proyecto de Firebase Auth.

Devuelve:

Promesa<string>

Una promesa que se resuelve con el vínculo generado.

Ejemplo

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

Genera un vínculo de acción de correo electrónico fuera de banda para verificar que el usuario es el propietario del correo electrónico especificado. El objeto ActionCodeSettings proporcionado como argumento de este método define si el vínculo lo administrará una app para dispositivos móviles o un navegador, junto con información adicional de estado que se pasará en el vínculo directo, etcétera.

Firma:

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

Parámetros

Parámetro Tipo Descripción
email cadena La cuenta de correo electrónico actual.
Correo electrónico nuevo cadena La dirección de correo electrónico a la que se actualizará la cuenta.
Configuración de códigodeacción ActionCodeSettings. La configuración del código de acción. Si se especifica, la URL de estado/continuación se establece como parámetro "continueUrl" en el vínculo de verificación por correo electrónico. La página de destino predeterminada para la verificación por correo electrónico la utilizará para mostrar un vínculo que le permitirá volver a la aplicación si está instalada. Si no se especifica actionCodeSettings, no se anexa ninguna URL a la URL de acción. La URL de estado proporcionada debe pertenecer a un dominio autorizado en la consola. De lo contrario, se arrojará un error. Los redireccionamientos de apps para dispositivos móviles solo se aplican si el desarrollador configura y acepta las condiciones del servicio de Firebase Dynamic Links. Solo se respetan el nombre del paquete de Android y el ID del paquete de iOS si se configuran en el mismo proyecto de Firebase Auth.

Devuelve:

Promesa<string>

Una promesa que se resuelve con el vínculo generado.

BaseAuth.getProviderConfig()

Busca una configuración del proveedor de autenticación con el ID proporcionado. Muestra una promesa que se resuelve con la configuración del proveedor correspondiente al ID de proveedor especificado. Si el ID especificado no existe, se mostrará un error auth/configuration-not-found.

La compatibilidad con SAML y el proveedor de OIDC 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.

Firma:

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

Parámetros

Parámetro Tipo Descripción
providerId cadena El ID del proveedor correspondiente a la configuración del proveedor que se mostrará.

Devuelve:

Promesa<AuthProviderConfig>

Una promesa que se resuelve con la configuración correspondiente al ID proporcionado.

BaseAuth.getUser()

Obtiene los datos del usuario correspondiente a un uid determinado.

Consulta Recupera datos del usuario para ver muestras de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
uid cadena El uid correspondiente al usuario cuyos datos se recuperarán.

Devuelve:

Promesa<UserRecord>

Es una promesa que se cumple con los datos del usuario correspondientes al uid proporcionado.

BaseAuth.getUserByEmail()

Obtiene los datos del usuario correspondiente a un correo electrónico determinado.

Consulta Recupera datos del usuario para ver muestras de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
email cadena El correo electrónico correspondiente al usuario cuyos datos se recuperarán.

Devuelve:

Promesa<UserRecord>

Es una promesa que se cumple con los datos del usuario correspondientes al correo electrónico proporcionado.

BaseAuth.getUserByPhoneNumber()

Obtiene los datos del usuario correspondientes a un número de teléfono determinado. El número de teléfono debe cumplir con la especificación E.164.

Consulta Recupera datos del usuario para ver muestras de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
númerodeteléfono cadena Es el número de teléfono correspondiente al usuario cuyos datos se recuperarán.

Devuelve:

Promesa<UserRecord>

Es una promesa cumplida con los datos del usuario correspondientes al número de teléfono proporcionado.

BaseAuth.getUserByProviderUid().

Obtiene los datos del usuario correspondiente a un ID de proveedor determinado.

Consulta Recupera datos del usuario para ver muestras de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
providerId cadena El ID del proveedor; por ejemplo, "google.com", para el proveedor de Google
uid cadena Es el identificador de usuario del proveedor determinado.

Devuelve:

Promesa<UserRecord>

Es una promesa cumplida con los datos del usuario correspondientes al ID de proveedor determinado.

BaseAuth.getUsers()

Obtiene los datos del usuario correspondientes a los identificadores especificados.

No hay garantías de ordenamiento; en particular, no se garantiza que la enésima entrada de la lista de resultados corresponda a la enésima de la lista de parámetros de entrada.

Solo se puede proporcionar un máximo de 100 identificadores. Si se proporcionan más de 100 identificadores, este método genera un error FirebaseAuthError.

Firma:

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

Parámetros

Parámetro Tipo Descripción
identifiers UserIdentifier[] Los identificadores que se usan para indicar qué registros de usuarios se deben mostrar. No debe tener más de 100 entradas.

Devuelve:

Promesa<GetUsersResult>

Una promesa que se resuelve en los registros de usuario correspondientes.

Excepciones

FirebaseAuthError Si alguno de los identificadores no es válido o si se especifican más de 100.

BaseAuth.importUsers()

Importa la lista de usuarios proporcionada a Firebase Auth. Se puede importar un máximo de 1,000 usuarios, uno a la vez. Cuando se importan usuarios con contraseñas, se deben especificar UserImportOptions. Esta operación está optimizada para las importaciones masivas y, además, ignorará las verificaciones en uid, email y otros identificadores únicos que podrían generar duplicados.

Firma:

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

Parámetros

Parámetro Tipo Descripción
de usuarios UserImportRecord La lista de registros de usuarios para importar a Firebase Auth.
opciones UserImportOptions. Las opciones de importación de usuarios, requeridas cuando los usuarios proporcionados incluyen credenciales de contraseña.

Devuelve:

Promesa<UserImportResult>

Una promesa que se resuelve cuando se completa la operación con el resultado de la importación. Esto incluye la cantidad de importaciones correctas, la cantidad de importaciones con errores y los errores correspondientes.

BaseAuth.listProviderConfigs().

Muestra la lista de configuraciones del proveedor existentes que coinciden con el filtro proporcionado. Como máximo, se pueden enumerar 100 configuraciones del proveedor a la vez.

La compatibilidad con SAML y el proveedor de OIDC 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.

Firma:

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

Parámetros

Parámetro Tipo Descripción
opciones AuthProviderConfigFilter. El filtro de configuración del proveedor que se aplicará.

Devuelve:

Promesa<ListProviderConfigResults>

Una promesa que se resuelve con la lista de parámetros de configuración del proveedor que cumplen con los requisitos del filtro.

BaseAuth.listUsers()

Recupera una lista de usuarios (solo lote) con un tamaño de maxResults a partir del desplazamiento, como especifica pageToken. Se usa para recuperar todos los usuarios de un proyecto específico por lotes.

Consulta Enumerar todos los usuarios para ver muestras de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
maxResults número El tamaño de la página, 1,000 si no está definido. Este es también el límite máximo permitido.
pageToken cadena El token de la página siguiente. Si no se especifica, muestra los usuarios que comienzan sin ningún desplazamiento.

Devuelve:

Promesa<ListUsersResult>

Una promesa que se resuelve con el lote actual de usuarios descargados y el token de la página siguiente.

BaseAuth.revokeRefreshTokens()

Revoca todos los tokens de actualización de un usuario existente.

Esta API actualizará el UserRecord.tokensValidAfterTime del usuario al horario UTC actual. Es importante que el servidor en el que se llama tenga su reloj configurado correctamente y sincronizado.

Si bien esto revocará todas las sesiones de un usuario específico y también inhabilitará la creación de tokens de ID nuevos para las sesiones existentes, los tokens de ID existentes pueden permanecer activos hasta su vencimiento natural (una hora). Para verificar que los tokens de ID estén revocados, usa BaseAuth.verifyIdToken(), en el que checkRevoked se establece como verdadero.

Firma:

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

Parámetros

Parámetro Tipo Descripción
uid cadena El uid correspondiente al usuario cuyos tokens de actualización se revocarán.

Devuelve:

Promesa<void>

Una promesa vacía que se cumple una vez que se revocaron los tokens de actualización del usuario.

BaseAuth.setCustomUserClaims()

Establece reclamos adicionales de desarrollador sobre un usuario existente identificado por el uid proporcionado, que por lo general se usa para definir roles del usuario y niveles de acceso. Estas reclamaciones deben propagarse a todos los dispositivos a los que ya haya accedido el usuario (después del vencimiento del token o cuando se fuerza la actualización del token) y la próxima vez que acceda. Si se usa un nombre de reclamación de OIDC reservado (sub, iat, iss, etc.), se mostrará un error. Se configuran en el JWT del token de ID del usuario autenticado.

Consulta Definición de roles de usuario y niveles de acceso para ver muestras de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
uid cadena El uid del usuario que se editará.
customUserClaims objeto | nulo El desarrollador declara establecer. Si se pasa un valor nulo, se borran las reclamaciones personalizadas existentes. Si se pasa una carga útil de reclamaciones personalizadas de más de 1,000 bytes, se generará un error. Las reclamaciones personalizadas se agregan al token de ID del usuario, que se transmite en cada solicitud autenticada. Para los atributos de usuario que no están relacionados con el acceso, usa la base de datos o algún otro sistema de almacenamiento independiente.

Devuelve:

Promesa<void>

Una promesa que se resuelve cuando la operación se completa de forma correcta.

BaseAuth.updateProviderConfig()

Muestra una promesa que se resuelve con el AuthProviderConfig actualizado correspondiente al ID de proveedor especificado. Si el ID especificado no existe, se mostrará un error auth/configuration-not-found.

La compatibilidad con SAML y el proveedor de OIDC 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.

Firma:

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

Parámetros

Parámetro Tipo Descripción
providerId cadena El ID del proveedor correspondiente a la configuración del proveedor que se actualizará.
updatedConfig UpdateAuthProviderRequest. La configuración actualizada.

Devuelve:

Promesa<AuthProviderConfig>

Una promesa que se resuelve con la configuración actualizada del proveedor.

BaseAuth.updateUser()

Actualiza un usuario existente.

Consulta Actualiza un usuario para ver muestras de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
uid cadena El uid correspondiente al usuario que se actualizará.
del bucket Solicitud de actualización Las propiedades que se actualizarán en el usuario proporcionado.

Devuelve:

Promesa<UserRecord>

Una promesa cumplida con los datos del usuario actualizados.

BaseAuth.verifyIdToken()

Verifica un token de ID de Firebase (JWT). Si el token es válido, la promesa se cumple con las reclamaciones decodificadas del token; de lo contrario, se rechaza la promesa.

Si estableces checkRevoked como verdadera, primero se verifica si el usuario correspondiente está inhabilitado. Si es así, se genera un error auth/user-disabled. Si no es así, verifica si se revocó la sesión correspondiente al token de ID. Si se invalida la sesión del usuario correspondiente, se genera un error auth/id-token-revoked. Si no se especifica, no se aplica la verificación.

Consulta Cómo verificar tokens de ID para ver muestras de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
idToken cadena El token de ID que se verificará.
verificarRevocado boolean Indica si se debe verificar si se revocó el token de ID. Esto requiere una solicitud adicional al backend de Firebase Auth para verificar la hora tokensValidAfterTime del usuario correspondiente. Si no se especifica, no se aplicará esta verificación adicional.

Devuelve:

Promesa<DecodedIdToken>

Una promesa completada con las reclamaciones decodificadas del token si el token de ID es válido; de lo contrario, una promesa rechazada.

BaseAuth.verifySessionCookie()

Verifica una cookie de sesión de Firebase. Muestra una promesa con las reclamaciones de cookies. Rechaza la promesa si no se pudo verificar la cookie.

Si se configura checkRevoked como verdadero, primero verifica si el usuario correspondiente está inhabilitado. Si es así, se genera un error auth/user-disabled. Si no es así, verifica si se revocó la sesión correspondiente a la cookie de sesión. Si se invalida la sesión del usuario correspondiente, se genera un error auth/session-cookie-revoked. Si no se especifica, no se realiza la verificación.

Consulta Cómo verificar las cookies de sesión para ver muestras de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
sesiónCookie cadena La cookie de sesión que se verificará.
verificarRevocado boolean

Devuelve:

Promesa<DecodedIdToken>

Una promesa cumplida con las reclamaciones decodificadas de la cookie de sesión si esta es válida; de lo contrario, es una promesa rechazada.