BaseAuth class

Interfaz principal común para las API Auth y TenantAwareAuth .

Firma:

export declare abstract class BaseAuth 

Métodos

Método Modificadores Descripción
createCustomToken(uid, desarrolladorClaims) Crea un nuevo token personalizado de Firebase (JWT) que se puede enviar de vuelta a un dispositivo cliente para usarlo para iniciar sesión con los métodos signInWithCustomToken() de los SDK del cliente. (Las instancias conscientes de inquilinos también incrustarán el ID de inquilino en el token). Consulte Crear tokens personalizados para ver ejemplos de código y documentación detallada.
createProviderConfig(config) Devuelve una promesa que se resuelve con el AuthProviderConfig recién creado cuando se crea la nueva configuración del proveedor. La compatibilidad con los proveedores de SAML y OIDC requiere la plataforma de identidad de Google Cloud (GCIP). Para obtener más información sobre GCIP, incluidos los precios y las funciones, consulte la documentación de GCIP .
createSessionCookie(idToken, sessionCookieOptions) Crea una nueva cookie de sesión de Firebase con las opciones especificadas. La cadena JWT creada se puede configurar como una cookie de sesión del lado del servidor con una política de cookies personalizada y se puede usar para la administración de sesiones. La cookie de sesión JWT tendrá las mismas reclamaciones de carga útil que el token de ID proporcionado. Consulte Administrar cookies de sesión para ver ejemplos de código y documentación detallada.
crearUsuario(propiedades) Crea un nuevo usuario. Consulte Crear un usuario para ver ejemplos de código y documentación detallada.
deleteProviderConfig(proveedorId) Elimina la configuración del proveedor correspondiente al ID de proveedor pasado. Si el ID especificado no existe, se genera un error auth/configuration-not-found . La compatibilidad con los proveedores de SAML y OIDC requiere la plataforma de identidad de Google Cloud (GCIP). Para obtener más información sobre GCIP, incluidos los precios y las funciones, consulte la documentación de GCIP .
eliminarUsuario(uid) Elimina un usuario existente. Consulte Eliminar un usuario para ver ejemplos de código y documentación detallada.
eliminarUsuarios(uids) Elimina los usuarios especificados por los uid dados. Eliminar un usuario que no existe no generará un error (es decir, este método es idempotente). Se considera que los usuarios que no existen se eliminaron correctamente y, por lo tanto, se cuentan en el valor DeleteUsersResult.successCount . Solo se pueden proporcionar un máximo de 1000 identificadores. Si se proporcionan más de 1000 identificadores, este método arroja un FirebaseAuthError. Actualmente, esta API tiene una tasa limitada en el servidor de 1 QPS. Si excede esto, puede obtener un error de cuota excedida. Por lo tanto, si desea eliminar más de 1000 usuarios, es posible que deba agregar un retraso para asegurarse de no superar este límite.
generar enlace de verificación de correo electrónico (correo electrónico, configuración de código de acción) Genera el enlace 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 para este método define si el enlace debe ser manejado por una aplicación móvil o un navegador junto con información de estado adicional que se pasará en el enlace profundo, etc.
generar ContraseñaResetLink (correo electrónico, configuración de código de acción) Genera el enlace de acción de correo electrónico fuera de banda para restablecer la contraseña de un usuario. El enlace se genera para el usuario con la dirección de correo electrónico especificada. El objeto ActionCodeSettings opcional define si el enlace debe ser manejado por una aplicación móvil o un navegador y la información de estado adicional que se transmitirá en el enlace profundo, etc.
generar inicio de sesión con enlace de correo electrónico (correo electrónico, configuración de código de acción) Genera el enlace 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 para este método define si el enlace debe ser manejado por una aplicación móvil o un navegador junto con información de estado adicional que se pasará en el enlace profundo, etc.
generar Verificar y cambiar el enlace de correo electrónico (correo electrónico, nuevo correo electrónico, configuración de código de acción) Genera un enlace 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 para este método define si el enlace debe ser manejado por una aplicación móvil o un navegador junto con información de estado adicional que se pasará en el enlace profundo, etc.
getProviderConfig(proveedorId) Busca una configuración de proveedor de autenticación por el ID proporcionado. Devuelve una promesa que resuelve con la configuración del proveedor correspondiente al ID de proveedor especificado. Si el ID especificado no existe, se genera un error auth/configuration-not-found . La compatibilidad con los proveedores de SAML y OIDC requiere la plataforma de identidad de Google Cloud (GCIP). Para obtener más información sobre GCIP, incluidos los precios y las funciones, consulte la documentación de GCIP .
obtenerUsuario(uid) Obtiene los datos de usuario para el usuario correspondiente a un uid determinado. Consulte Recuperar datos de usuario para obtener ejemplos de código y documentación detallada.
getUserByEmail (correo electrónico) Obtiene los datos de usuario para el usuario correspondiente a un correo electrónico dado. Consulte Recuperar datos de usuario para obtener ejemplos de código y documentación detallada.
getUserByPhoneNumber(phoneNumber) Obtiene los datos de usuario para el usuario correspondiente a un número de teléfono dado. El número de teléfono debe cumplir con la especificación E.164. Consulte Recuperar datos de usuario para obtener ejemplos de código y documentación detallada.
getUserByProviderUid(proveedorId, uid) Obtiene los datos de usuario para el usuario correspondiente a una identificación de proveedor dada. Consulte Recuperar datos de usuario para obtener ejemplos de código y documentación detallada.
getUsers(identificadores) Obtiene los datos de usuario correspondientes a los identificadores especificados. No hay garantías de pedido; en particular, no se garantiza que la n-ésima entrada en la lista de resultados corresponda a la n-ésima entrada en la lista de parámetros de entrada. Solo se pueden proporcionar un máximo de 100 identificadores. Si se proporcionan más de 100 identificadores, este método genera un FirebaseAuthError.
importUsers(usuarios, opciones) Importa la lista de usuarios proporcionada a Firebase Auth. Se permite importar un máximo de 1000 usuarios de uno en uno. Al importar usuarios con contraseñas, es necesario especificar UserImportOptions . Esta operación está optimizada para importaciones masivas e ignorará las comprobaciones de uid , email y otros identificadores únicos que podrían dar lugar a duplicaciones.
listProviderConfigs(opciones) Devuelve la lista de configuraciones de proveedores existentes que coinciden con el filtro proporcionado. Como máximo, se pueden enumerar 100 configuraciones de proveedores a la vez. La compatibilidad con los proveedores de SAML y OIDC requiere la plataforma de identidad de Google Cloud (GCIP). Para obtener más información sobre GCIP, incluidos los precios y las funciones, consulte la documentación de GCIP .
lista de usuarios (resultados máximos, token de página) Recupera una lista de usuarios (solo un lote) con un tamaño de maxResults a partir del desplazamiento especificado por pageToken . Esto se utiliza para recuperar todos los usuarios de un proyecto específico en lotes. Consulte Enumerar a todos los usuarios para ver ejemplos de código y documentación detallada.
revocarRefreshTokens(uid) Revoca todos los tokens de actualización para un usuario existente. Esta API actualizará el UserRecord.tokensValidAfterTime del usuario al 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 para un usuario específico y deshabilitará la acuñación de nuevos tokens de ID 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, use BaseAuth.verifyIdToken() donde checkRevoked se establece en verdadero.
setCustomUserClaims(uid, customUserClaims) Establece reclamos de desarrollador adicionales en un usuario existente identificado por el uid proporcionado, que generalmente se usa para definir roles de usuario y niveles de acceso. Estos reclamos deben propagarse a todos los dispositivos en los que el usuario ya haya iniciado sesión (después del vencimiento del token o cuando se fuerza la actualización del token) y la próxima vez que el usuario inicie sesión. Si se usa un nombre de reclamo de OIDC reservado (sub, iat, iss, etc. ), se arroja un error. Se establecen en el token de ID del usuario autenticado JWT. Consulte Definición de roles de usuario y niveles de acceso para ejemplos de código y documentación detallada.
updateProviderConfig (Id de proveedor, configuración actualizada) Devuelve una promesa que se resuelve con el AuthProviderConfig actualizado correspondiente al ID de proveedor especificado. Si el ID especificado no existe, se genera un error auth/configuration-not-found . La compatibilidad con los proveedores de SAML y OIDC requiere la plataforma de identidad de Google Cloud (GCIP). Para obtener más información sobre GCIP, incluidos los precios y las funciones, consulte la documentación de GCIP .
updateUser(uid, propiedades) Actualiza un usuario existente. Consulte Actualizar un usuario para ver ejemplos de código y documentación detallada.
verificarIdToken(idToken, verificarRevocado) Verifica un token de ID de Firebase (JWT). Si el token es válido, la promesa se cumple con los reclamos decodificados del token; de lo contrario, la promesa es rechazada. Si checkRevoked se establece en verdadero, primero verifica si el usuario correspondiente está deshabilitado. En caso afirmativo, se arroja un error auth/user-disabled . Si no, verifica si la sesión correspondiente al token de ID fue revocada. Si se invalidó la sesión del usuario correspondiente, se genera un error auth/id-token-revoked . Si no se especifica, no se aplica la comprobación. Consulte Verificar tokens de identificación para ver ejemplos de códigos y documentación detallada.
verificarSessionCookie(sessionCookie, checkRevoked) Verifica una cookie de sesión de Firebase. Devuelve una Promesa con los reclamos de cookies. Rechaza la promesa si no se pudo verificar la cookie. Si checkRevoked se establece en verdadero, primero verifica si el usuario correspondiente está deshabilitado: en caso afirmativo, se genera un error auth/user-disabled . Si no, verifica si la sesión correspondiente a la cookie de sesión fue revocada. Si se invalidó la sesión del usuario correspondiente, se genera un error de auth/session-cookie-revoked . Si no se especifica, no se realiza la comprobación. Consulte Verificar cookies de sesión para ver ejemplos 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 iniciar sesión con los métodos signInWithCustomToken() de los SDK del cliente. (Las instancias conscientes de inquilinos también incrustarán el ID de inquilino en el token).

Consulte Crear tokens personalizados para ver ejemplos de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Escribe Descripción
fluido cuerda El uid que se usará como asunto del token personalizado.
desarrolladorClaims objeto Reclamaciones adicionales opcionales para incluir en la carga útil del token personalizado.

Devoluciones:

Promesa <cadena>

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

BaseAuth.createProviderConfig()

Devuelve una promesa que se resuelve con el AuthProviderConfig recién creado cuando se crea la nueva configuración del proveedor.

La compatibilidad con los proveedores de SAML y OIDC requiere la plataforma de identidad de Google Cloud (GCIP). Para obtener más información sobre GCIP, incluidos los precios y las funciones, consulte la documentación de GCIP .

Firma:

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

Parámetros

Parámetro Escribe Descripción
configuración AuthProviderConfig La configuración del proveedor que se va a crear.

Devoluciones:

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 JWT creada se puede configurar como una cookie de sesión del lado del servidor con una política de cookies personalizada y se puede usar para la administración de sesiones. La cookie de sesión JWT tendrá las mismas reclamaciones de carga útil que el token de ID proporcionado.

Consulte Administrar cookies de sesión para ver ejemplos de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Escribe Descripción
idtoken cuerda El token de ID de Firebase para intercambiar por una cookie de sesión.
sessionCookieOptions SessionCookieOptions Las opciones de cookies de la sesión, que incluyen la duración de la sesión personalizada.

Devoluciones:

Promesa <cadena>

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

BaseAuth.createUser()

Crea un nuevo usuario.

Consulte Crear un usuario para ver ejemplos de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Escribe Descripción
propiedades Crear solicitud Las propiedades que se establecerán en el nuevo registro de usuario que se creará.

Devoluciones:

Promesa < Registro de usuario >

Promesa cumplida con los datos de usuario correspondientes al usuario de nueva creación.

BaseAuth.deleteProviderConfig()

Elimina la configuración del proveedor correspondiente al ID de proveedor pasado. Si el ID especificado no existe, se genera un error auth/configuration-not-found .

La compatibilidad con los proveedores de SAML y OIDC requiere la plataforma de identidad de Google Cloud (GCIP). Para obtener más información sobre GCIP, incluidos los precios y las funciones, consulte la documentación de GCIP .

Firma:

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

Parámetros

Parámetro Escribe Descripción
ID de proveedor cuerda El ID del proveedor correspondiente a la configuración del proveedor para eliminar.

Devoluciones:

Promesa <vacío>

Una promesa que se resuelve al completarse.

BaseAuth.deleteUser()

Elimina un usuario existente.

Consulte Eliminar un usuario para ver ejemplos de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Escribe Descripción
fluido cuerda El uid correspondiente al usuario a eliminar.

Devoluciones:

Promesa <vacío>

Una promesa vacía cumplida una vez que el usuario ha sido eliminado.

BaseAuth.deleteUsers()

Elimina los usuarios especificados por los uid proporcionados.

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

Solo se pueden proporcionar un máximo de 1000 identificadores. Si se proporcionan más de 1000 identificadores, este método arroja un FirebaseAuthError.

Actualmente, esta API tiene una tasa limitada en el servidor de 1 QPS. Si excede esto, puede obtener un error de cuota excedida. Por lo tanto, si desea eliminar más de 1000 usuarios, es posible que deba agregar un retraso para asegurarse de no superar este límite.

Firma:

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

Parámetros

Parámetro Escribe Descripción
fluidos cuerda[] Los uids correspondientes a los usuarios a eliminar.

Devoluciones:

Promise< DeleteUsersResult >

Una Promesa que se resuelve en el número total de eliminaciones correctas/fallidas, así como en la matriz de errores que corresponde a las eliminaciones fallidas.

Genera el enlace 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 para este método define si el enlace debe ser manejado por una aplicación móvil o un navegador junto con información de estado adicional que se pasará en el enlace profundo, etc.

Firma:

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

Parámetros

Parámetro Escribe Descripción
Email cuerda La cuenta de correo electrónico a verificar.
configuración de código de acción Configuración de código de acción La configuración del código de acción. Si se especifica, la URL de estado/continuación se establece como el parámetro "continueUrl" en el enlace de verificación de correo electrónico. La página de inicio de verificación de correo electrónico predeterminada usará esto para mostrar un enlace para volver a la aplicación si está instalada. Si no se especifica actionCodeSettings, no se agrega ninguna URL a la URL de acción. La URL de estado proporcionada debe pertenecer a un dominio que el desarrollador haya incluido en la lista blanca en la consola. De lo contrario, se arroja un error. Los redireccionamientos de aplicaciones móviles solo se aplican si el desarrollador configura y acepta los términos de servicio de Firebase Dynamic Links. El nombre del paquete de Android y el ID del paquete de iOS se respetan solo si están configurados en el mismo proyecto de Firebase Auth.

Devoluciones:

Promesa <cadena>

Una promesa que se resuelve con el enlace 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 enlace de acción de correo electrónico fuera de banda para restablecer la contraseña de un usuario. El enlace se genera para el usuario con la dirección de correo electrónico especificada. El objeto ActionCodeSettings opcional define si el enlace debe ser manejado por una aplicación móvil o un navegador y la información de estado adicional que se transmitirá en el enlace profundo, etc.

Firma:

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

Parámetros

Parámetro Escribe Descripción
Email cuerda La dirección de correo electrónico del usuario cuya contraseña se va a restablecer.
configuración de código de acción Configuración de código de acción La configuración del código de acción. Si se especifica, la URL de estado/continuación se establece como el parámetro "continueUrl" en el enlace de restablecimiento de contraseña. La página de inicio de restablecimiento de contraseña predeterminada usará esto para mostrar un enlace para volver a la aplicación si está instalada. Si no se especifica actionCodeSettings, no se agrega ninguna URL a la URL de acción. La URL de estado proporcionada debe pertenecer a un dominio que el desarrollador haya incluido en la lista blanca en la consola. De lo contrario, se arroja un error. Los redireccionamientos de aplicaciones móviles solo se aplican si el desarrollador configura y acepta los términos de servicio de Firebase Dynamic Links. El nombre del paquete de Android y el ID del paquete de iOS se respetan solo si están configurados en el mismo proyecto de Firebase Auth.

Devoluciones:

Promesa <cadena>

Una promesa que se resuelve con el enlace 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 enlace 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 para este método define si el enlace debe ser manejado por una aplicación móvil o un navegador junto con información de estado adicional que se pasará en el enlace profundo, etc.

Firma:

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

Parámetros

Parámetro Escribe Descripción
Email cuerda La cuenta de correo electrónico a verificar.
configuración de código de acción Configuración de código de acción La configuración del código de acción. Si se especifica, la URL de estado/continuación se establece como el parámetro "continueUrl" en el enlace de verificación de correo electrónico. La página de inicio de verificación de correo electrónico predeterminada usará esto para mostrar un enlace para volver a la aplicación si está instalada. Si no se especifica actionCodeSettings, no se agrega ninguna URL a la URL de acción. La URL de estado proporcionada debe pertenecer a un dominio que el desarrollador haya incluido en la lista blanca en la consola. De lo contrario, se arroja un error. Los redireccionamientos de aplicaciones móviles solo se aplican si el desarrollador configura y acepta los términos de servicio de Firebase Dynamic Links. El nombre del paquete de Android y el ID del paquete de iOS se respetan solo si están configurados en el mismo proyecto de Firebase Auth.

Devoluciones:

Promesa <cadena>

Una promesa que se resuelve con el enlace 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 enlace 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 para este método define si el enlace debe ser manejado por una aplicación móvil o un navegador junto con información de estado adicional que se pasará en el enlace profundo, etc.

Firma:

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

Parámetros

Parámetro Escribe Descripción
Email cuerda La cuenta de correo electrónico actual.
Nuevo correo electrónico cuerda La dirección de correo electrónico a la que se está actualizando la cuenta.
configuración de código de acción Configuración de código de acción La configuración del código de acción. Si se especifica, la URL de estado/continuación se establece como el parámetro "continueUrl" en el enlace de verificación de correo electrónico. La página de inicio de verificación de correo electrónico predeterminada usará esto para mostrar un enlace para volver a la aplicación si está instalada. Si no se especifica actionCodeSettings, no se agrega ninguna URL a la URL de acción. La URL de estado proporcionada debe pertenecer a un dominio autorizado en la consola o se generará un error. Los redireccionamientos de aplicaciones móviles solo se aplican si el desarrollador configura y acepta los términos de servicio de Firebase Dynamic Links. El nombre del paquete de Android y el ID del paquete de iOS se respetan solo si están configurados en el mismo proyecto de Firebase Auth.

Devoluciones:

Promesa <cadena>

Una promesa que se resuelve con el enlace generado.

BaseAuth.getProviderConfig()

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

La compatibilidad con los proveedores de SAML y OIDC requiere la plataforma de identidad de Google Cloud (GCIP). Para obtener más información sobre GCIP, incluidos los precios y las funciones, consulte la documentación de GCIP .

Firma:

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

Parámetros

Parámetro Escribe Descripción
ID de proveedor cuerda El ID del proveedor correspondiente a la configuración del proveedor para devolver.

Devoluciones:

Promesa< AuthProviderConfig >

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

BaseAuth.getUser()

Obtiene los datos de usuario para el usuario correspondiente a un uid dado .

Consulte Recuperar datos de usuario para obtener ejemplos de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Escribe Descripción
fluido cuerda El uid correspondiente al usuario cuyos datos se van a recuperar.

Devoluciones:

Promesa < Registro de usuario >

Una promesa cumplida con los datos de usuario correspondientes al uid proporcionado .

BaseAuth.getUserByEmail()

Obtiene los datos de usuario para el usuario correspondiente a un correo electrónico determinado.

Consulte Recuperar datos de usuario para obtener ejemplos de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Escribe Descripción
Email cuerda El correo electrónico correspondiente al usuario cuyos datos se buscan.

Devoluciones:

Promesa < Registro de usuario >

Una promesa cumplida con los datos del usuario correspondientes al correo electrónico facilitado.

BaseAuth.getUserByPhoneNumber()

Obtiene los datos de usuario para el usuario correspondiente a un número de teléfono dado. El número de teléfono debe cumplir con la especificación E.164.

Consulte Recuperar datos de usuario para obtener ejemplos de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Escribe Descripción
número de teléfono cuerda El número de teléfono correspondiente al usuario cuyos datos se van a buscar.

Devoluciones:

Promesa < Registro de usuario >

Una promesa cumplida con los datos del usuario correspondientes al número de teléfono facilitado.

BaseAuth.getUserByProviderUid()

Obtiene los datos de usuario para el usuario correspondiente a una identificación de proveedor dada.

Consulte Recuperar datos de usuario para obtener ejemplos de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Escribe Descripción
ID de proveedor cuerda El ID del proveedor, por ejemplo, "google.com" para el proveedor de Google.
fluido cuerda El identificador de usuario para el proveedor dado.

Devoluciones:

Promesa < Registro de usuario >

Una promesa cumplida con los datos de usuario correspondientes a la identificación del proveedor dado.

BaseAuth.getUsers()

Obtiene los datos de usuario correspondientes a los identificadores especificados.

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

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

Firma:

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

Parámetros

Parámetro Escribe Descripción
identificadores Identificador de usuario [] Los identificadores utilizados para indicar qué registros de usuario deben devolverse. No debe tener más de 100 entradas.

Devoluciones:

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 identificadores.

BaseAuth.importUsers()

Importa la lista de usuarios proporcionada a Firebase Auth. Se permite importar un máximo de 1000 usuarios de uno en uno. Al importar usuarios con contraseñas, es necesario especificar UserImportOptions . Esta operación está optimizada para importaciones masivas e ignorará las comprobaciones de uid , email y otra singularidad del identificador que podría dar lugar a duplicaciones.

Firma:

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

Parámetros

Parámetro Escribe Descripción
usuarios Registro de importación de usuario [] La lista de registros de usuario para importar a Firebase Auth.
opciones Opciones de importación de usuario Las opciones de importación de usuarios, necesarias cuando los usuarios proporcionados incluyen credenciales de contraseña.

Devoluciones:

Promesa < Resultado de importación de usuario >

Una promesa que se resuelve cuando la operación finaliza con el resultado de la importación. Esto incluye el número de importaciones exitosas, el número de importaciones fallidas y sus errores correspondientes.

BaseAuth.listProviderConfigs()

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

La compatibilidad con los proveedores de SAML y OIDC requiere la plataforma de identidad de Google Cloud (GCIP). Para obtener más información sobre GCIP, incluidos los precios y las funciones, consulte la documentación de GCIP .

Firma:

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

Parámetros

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

Devoluciones:

Promise< ListProviderConfigResults >

Una promesa que se resuelve con la lista de configuraciones de proveedores que cumplen con los requisitos del filtro.

BaseAuth.listUsers()

Recupera una lista de usuarios (solo un lote) con un tamaño de maxResults a partir del desplazamiento especificado por pageToken . Esto se utiliza para recuperar todos los usuarios de un proyecto específico en lotes.

Consulte Enumerar a todos los usuarios para ver ejemplos de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Escribe Descripción
maxResultados número El tamaño de página, 1000 si no está definido. Este es también el límite máximo permitido.
token de página cuerda El token de la página siguiente. Si no se especifica, devuelve usuarios que comienzan sin ningún desplazamiento.

Devoluciones:

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 para un usuario existente.

Esta API actualizará el UserRecord.tokensValidAfterTime del usuario al 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 para un usuario específico y deshabilitará la acuñación de nuevos tokens de ID 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, use BaseAuth.verifyIdToken() donde checkRevoked se establece en verdadero.

Firma:

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

Parámetros

Parámetro Escribe Descripción
fluido cuerda El uid correspondiente al usuario cuyos tokens de actualización se van a revocar.

Devoluciones:

Promesa <vacío>

Una promesa vacía cumplida una vez que se han revocado los tokens de actualización del usuario.

BaseAuth.setCustomUserClaims()

Establece reclamos de desarrollador adicionales en un usuario existente identificado por el uid proporcionado , que normalmente se utiliza para definir roles de usuario y niveles de acceso. Estos reclamos deben propagarse a todos los dispositivos en los que el usuario ya haya iniciado sesión (después del vencimiento del token o cuando se fuerza la actualización del token) y la próxima vez que el usuario inicie sesión. Si se usa un nombre de reclamo de OIDC reservado (sub, iat, iss, etc. ), se arroja un error. Se establecen en el token de ID del usuario autenticado JWT.

Consulte Definición de roles de usuario y niveles de acceso para ejemplos de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Escribe Descripción
fluido cuerda El uid del usuario a editar.
reclamos de usuario personalizados objeto | nulo El desarrollador afirma establecer. Si se pasa nulo, se eliminan las reclamaciones personalizadas existentes. Pasar una carga útil de reclamos personalizados de más de 1000 bytes arrojará un error. Los reclamos personalizados se agregan al token de identificación del usuario que se transmite en cada solicitud autenticada. Para los atributos de usuario no relacionados con el acceso al perfil, use la base de datos u otros sistemas de almacenamiento separados.

Devoluciones:

Promesa <vacío>

Una promesa que se resuelve cuando la operación se completa con éxito.

BaseAuth.updateProviderConfig()

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

La compatibilidad con los proveedores de SAML y OIDC requiere la plataforma de identidad de Google Cloud (GCIP). Para obtener más información sobre GCIP, incluidos los precios y las funciones, consulte la documentación de GCIP .

Firma:

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

Parámetros

Parámetro Escribe Descripción
ID de proveedor cuerda El ID del proveedor correspondiente a la configuración del proveedor para actualizar.
configuración actualizada UpdateAuthProviderRequest La configuración actualizada.

Devoluciones:

Promesa< AuthProviderConfig >

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

BaseAuth.updateUser()

Actualiza un usuario existente.

Consulte Actualizar un usuario para ver ejemplos de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Escribe Descripción
fluido cuerda El uid correspondiente al usuario a actualizar.
propiedades Solicitud de actualización Las propiedades para actualizar en el usuario proporcionado.

Devoluciones:

Promesa < Registro de usuario >

Una promesa cumplida con los datos de usuario actualizados.

BaseAuth.verifyIdToken()

Verifica un token de ID de Firebase (JWT). Si el token es válido, la promesa se cumple con los reclamos decodificados del token; de lo contrario, la promesa es rechazada.

Si checkRevoked se establece en verdadero, primero verifica si el usuario correspondiente está deshabilitado. En caso afirmativo, se arroja un error auth/user-disabled . Si no, verifica si la sesión correspondiente al token de ID fue revocada. Si se invalidó la sesión del usuario correspondiente, se genera un error auth/id-token-revoked . Si no se especifica, no se aplica la comprobación.

Consulte Verificar tokens de identificación para ver ejemplos de códigos y documentación detallada.

Firma:

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

Parámetros

Parámetro Escribe Descripción
idtoken cuerda El token de ID para verificar.
verificarRevocado booleano Si verificar si el token de ID fue revocado. Esto requiere una solicitud adicional al backend de Firebase Auth para verificar el tiempo de tokensValidAfterTime para el usuario correspondiente. Cuando no se especifica, esta verificación adicional no se aplica.

Devoluciones:

Promesa< DecodedIdToken >

Una promesa cumplida 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. Devuelve una Promesa con los reclamos de cookies. Rechaza la promesa si no se pudo verificar la cookie.

Si checkRevoked se establece en verdadero, primero verifica si el usuario correspondiente está deshabilitado: en caso afirmativo, se genera un error auth/user-disabled . Si no, verifica si la sesión correspondiente a la cookie de sesión fue revocada. Si se invalidó la sesión del usuario correspondiente, se genera un error de auth/session-cookie-revoked . Si no se especifica, no se realiza la comprobación.

Consulte Verificar cookies de sesión para ver ejemplos de código y documentación detallada.

Firma:

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

Parámetros

Parámetro Escribe Descripción
cookie de sesión cuerda La cookie de sesión para verificar.
verificarRevocado booleano

Devoluciones:

Promesa< DecodedIdToken >

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