Interfaz principal común para las API Auth y TenantAwareAuth .
Firma:
export declare abstract class BaseAuth
Métodos
| Método | Modificadores | Descripción |
|---|---|---|
| crearCustomToken(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 que reconocen a los inquilinos también incorporarán el ID del inquilino en el token). Consulte Crear tokens personalizados para ver ejemplos de código y documentación detallada. | |
| crearProviderConfig(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 proveedores de SAML y OIDC requiere la plataforma de identidad de Google Cloud (GCIP). Para obtener más información sobre GCIP, incluidos precios y funciones, consulte la documentación de GCIP. . | |
| crearSessionCookie(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 usarse para la gestión de sesiones. La cookie de sesión JWT tendrá las mismas reclamaciones de carga útil que el token de identificación 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. | |
| eliminarProviderConfig(providerId) | Elimina la configuración del proveedor correspondiente al ID del proveedor pasado. Si el ID especificado no existe, se genera un error auth/configuration-not-found . La compatibilidad con proveedores de SAML y OIDC requiere la plataforma de identidad de Google Cloud (GCIP). Para obtener más información sobre GCIP, incluidos precios y funciones, consulte la documentación de GCIP. . | |
| eliminar usuario (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 uids dados. Eliminar un usuario no existente no generará un error (es decir, este método es idempotente). Se considera que los usuarios no existentes se eliminaron correctamente y, por lo tanto, se cuentan en el valor DeleteUsersResult.successCount . Sólo se podrá suministrar un máximo de 1000 identificadores. Si se proporcionan más de 1000 identificadores, este método genera un FirebaseAuthError. Actualmente, esta API tiene una tarifa limitada en el servidor a 1 QPS. Si excede esto, es posible que obtenga 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. | |
| generarEmailVerificationLink(correo electrónico, actionCodeSettings) | 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. | |
| generarPasswordResetLink(correo electrónico, actionCodeSettings) | 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 opcional ActionCodeSettings define si el enlace será manejado por una aplicación móvil o un navegador y la información de estado adicional que se pasará en el enlace profundo, etc. | |
| generarSignInWithEmailLink(correo electrónico, actionCodeSettings) | 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. | |
| generarVerifyAndChangeEmailLink(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(ID de proveedor) | Busca una configuración de proveedor de autenticación según el ID proporcionado. Devuelve una promesa que se resuelve con la configuración del proveedor correspondiente al ID del proveedor especificado. Si el ID especificado no existe, se genera un error auth/configuration-not-found . La compatibilidad con proveedores de SAML y OIDC requiere la plataforma de identidad de Google Cloud (GCIP). Para obtener más información sobre GCIP, incluidos precios y funciones, consulte la documentación de GCIP. . | |
| obtenerUsuario(uid) | Obtiene los datos del usuario correspondiente a un uid determinado. Consulte Recuperar datos de usuario para ver ejemplos de código y documentación detallada. | |
| getUserByEmail(correo electrónico) | Obtiene los datos del usuario correspondiente a un correo electrónico determinado. Consulte Recuperar datos de usuario para ver ejemplos de código y documentación detallada. | |
| getUserByPhoneNumber(número de teléfono) | Obtiene los datos del usuario correspondiente a un número de teléfono determinado. El número de teléfono debe cumplir con la especificación E.164. Consulte Recuperar datos de usuario para ver ejemplos de código y documentación detallada. | |
| getUserByProviderUid(ID de proveedor, uid) | Obtiene los datos del usuario correspondiente a una identificación de proveedor determinada. Consulte Recuperar datos de usuario para ver ejemplos de código y documentación detallada. | |
| getUsuarios(identificadores) | Obtiene los datos del usuario correspondientes a los identificadores especificados. No hay garantías de pedido; en particular, no se garantiza que la enésima entrada de la lista de resultados corresponda con la enésima entrada de la lista de parámetros de entrada. Sólo se podrá suministrar 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 uno a la vez. 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 provocar duplicaciones. | |
| listaProviderConfigs(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 proveedores de SAML y OIDC requiere la plataforma de identidad de Google Cloud (GCIP). Para obtener más información sobre GCIP, incluidos precios y funciones, consulte la documentación de GCIP. . | |
| listaUsuarios(maxResults, pageToken) | Recupera una lista de usuarios (solo un solo 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 Listar todos los usuarios para ver ejemplos de código y documentación detallada. | |
| revocarRefreshTokens(uid) | Revoca todos los tokens de actualización de un usuario existente. Esta API actualizará UserRecord.tokensValidAfterTime del usuario al UTC actual. Es importante que el servidor al que se llama tenga su reloj configurado correctamente y sincronizado. Si bien esto revocará todas las sesiones de un usuario específico y deshabilitará la acuñación de nuevos tokens de identificación para sesiones existentes, los tokens de identificación existentes pueden permanecer activos hasta su vencimiento natural (una hora). Para verificar que los tokens de identificación estén revocados, use BaseAuth.verifyIdToken() donde checkRevoked está establecido en verdadero. | |
| setCustomUserClaims(uid, customUserClaims) | Establece reclamos de desarrollador adicionales sobre 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 donde el usuario ya inició sesión (después de la expiración del token o cuando se fuerza la actualización del token) y la próxima vez que el usuario inicie sesión. Si se utiliza un nombre de reclamo OIDC reservado (sub, iat, iss, etc.) ), se genera un error. Se configuran en el token de ID del usuario autenticado JWT. Consulte Definición de roles de usuario y niveles de acceso para obtener 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 del proveedor especificado. Si el ID especificado no existe, se genera un error auth/configuration-not-found . La compatibilidad con proveedores de SAML y OIDC requiere la plataforma de identidad de Google Cloud (GCIP). Para obtener más información sobre GCIP, incluidos precios y funciones, consulte la documentación de GCIP. . | |
| actualizarUsuario(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 las afirmaciones decodificadas del token; de lo contrario, la promesa se rechaza. Si checkRevoked se establece en verdadero, primero verifica si el usuario correspondiente está deshabilitado. En caso afirmativo, se genera un error auth/user-disabled . En caso negativo, verifica si la sesión correspondiente al token de ID fue revocada. Si la sesión del usuario correspondiente fue invalidada, se genera un error auth/id-token-revoked . Si no se especifica el cheque no se aplica. Consulte Verificar tokens de identificación para obtener ejemplos de código y documentación detallada. | |
| verificarSessionCookie(sessionCookie, checkRevoked) | Verifica una cookie de sesión de Firebase. Devuelve una Promesa con las afirmaciones 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 . En caso negativo, verifica si la sesión correspondiente a la cookie de sesión fue revocada. Si la sesión del usuario correspondiente fue invalidada, se genera un error auth/session-cookie-revoked . Si no se especifica, la verificación no se realiza. Consulte Verificar cookies de sesión para obtener 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 que reconocen a los inquilinos también incorporarán el ID del 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 | Tipo | Descripción |
|---|---|---|
| fluido | cadena | El uid que se utilizará como asunto del token personalizado. |
| Reclamaciones del desarrollador | 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 proveedores de SAML y OIDC requiere la plataforma de identidad de Google Cloud (GCIP). Para obtener más información sobre GCIP, incluidos precios y funciones, consulte la documentación de GCIP. .
Firma:
createProviderConfig(config: AuthProviderConfig): Promise<AuthProviderConfig>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| configuración | Configuración del proveedor de autenticación | 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 usarse para la gestión de sesiones. La cookie de sesión JWT tendrá las mismas reclamaciones de carga útil que el token de identificación 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 | Tipo | Descripción |
|---|---|---|
| token de identificación | cadena | El token de ID de Firebase que se intercambiará por una cookie de sesión. |
| opciones de cookies de sesión | Opciones de cookies de sesión | Las opciones de cookies de sesión que incluyen la duración de la sesión personalizada. |
Devoluciones:
Promesa<cadena>
Una promesa que se resuelve correctamente 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 | Tipo | 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 >
Una promesa cumplida con los datos de usuario correspondientes al usuario recién creado.
BaseAuth.deleteProviderConfig()
Elimina la configuración del proveedor correspondiente al ID del proveedor pasado. Si el ID especificado no existe, se genera un error auth/configuration-not-found .
La compatibilidad con proveedores de SAML y OIDC requiere la plataforma de identidad de Google Cloud (GCIP). Para obtener más información sobre GCIP, incluidos precios y funciones, consulte la documentación de GCIP. .
Firma:
deleteProviderConfig(providerId: string): Promise<void>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| ID de proveedor | cadena | El ID del proveedor correspondiente a la configuración del proveedor que se va a eliminar. |
Devoluciones:
Promesa<nulo>
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 | Tipo | Descripción |
|---|---|---|
| fluido | cadena | El uid correspondiente al usuario a eliminar. |
Devoluciones:
Promesa<nulo>
Una promesa vacía que se cumple una vez que el usuario ha sido eliminado.
BaseAuth.deleteUsers()
Elimina los usuarios especificados por los uids dados.
Eliminar un usuario no existente no generará un error (es decir, este método es idempotente). Se considera que los usuarios no existentes se eliminaron correctamente y, por lo tanto, se cuentan en el valor DeleteUsersResult.successCount .
Sólo se podrá suministrar un máximo de 1000 identificadores. Si se proporcionan más de 1000 identificadores, este método genera un FirebaseAuthError.
Actualmente, esta API tiene una tarifa limitada en el servidor a 1 QPS. Si excede esto, es posible que obtenga 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 | Tipo | Descripción |
|---|---|---|
| fluidos | cadena[] | Los uids correspondientes a los usuarios a eliminar. |
Devoluciones:
Promesa< EliminarUsuariosResultado >
Una Promesa que resuelve el número total de eliminaciones exitosas/fallidas, así como el conjunto de errores que corresponden a las eliminaciones fallidas.
BaseAuth.generateEmailVerificationLink()
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 | Tipo | Descripción |
|---|---|---|
| correo electrónico | cadena | La cuenta de correo electrónico a verificar. |
| configuración de código de acción | Configuración del 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 del correo electrónico. La página de inicio de verificación de correo electrónico predeterminada utilizará esto para mostrar un enlace para regresar 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 incluido en la lista blanca del desarrollador en la consola. De lo contrario se produce 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
});
BaseAuth.generarContraseñaResetLink()
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 opcional ActionCodeSettings define si el enlace será manejado por una aplicación móvil o un navegador y la información de estado adicional que se pasará en el enlace profundo, etc.
Firma:
generatePasswordResetLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| correo electrónico | cadena | 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 del 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 utilizará esto para mostrar un enlace para regresar 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 incluido en la lista blanca del desarrollador en la consola. De lo contrario se produce 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
});
BaseAuth.generateSignInWithEmailLink()
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 | Tipo | Descripción |
|---|---|---|
| correo electrónico | cadena | La cuenta de correo electrónico a verificar. |
| configuración de código de acción | Configuración del 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 del correo electrónico. La página de inicio de verificación de correo electrónico predeterminada utilizará esto para mostrar un enlace para regresar 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 incluido en la lista blanca del desarrollador en la consola. De lo contrario se produce 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
});
BaseAuth.generateVerifyAndChangeEmailLink()
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 | Tipo | Descripción |
|---|---|---|
| correo electrónico | cadena | La cuenta de correo electrónico actual. |
| Nuevo Email | cadena | La dirección de correo electrónico a la que se actualiza la cuenta. |
| configuración de código de acción | Configuración del 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 del correo electrónico. La página de inicio de verificación de correo electrónico predeterminada utilizará esto para mostrar un enlace para regresar 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 según el ID proporcionado. Devuelve una promesa que se resuelve con la configuración del proveedor correspondiente al ID del proveedor especificado. Si el ID especificado no existe, se genera un error auth/configuration-not-found .
La compatibilidad con proveedores de SAML y OIDC requiere la plataforma de identidad de Google Cloud (GCIP). Para obtener más información sobre GCIP, incluidos precios y funciones, consulte la documentación de GCIP. .
Firma:
getProviderConfig(providerId: string): Promise<AuthProviderConfig>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| ID de proveedor | cadena | El ID del proveedor correspondiente a la configuración del proveedor que se devolverá. |
Devoluciones:
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. .
Consulte Recuperar datos de usuario para ver ejemplos de código y documentación detallada.
Firma:
getUser(uid: string): Promise<UserRecord>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| fluido | cadena | El uid correspondiente al usuario cuyos datos se van a recuperar. |
Devoluciones:
Promesa< Registro de usuario >
Una promesa cumplida con los datos del usuario correspondientes al uid proporcionado. .
BaseAuth.getUserByEmail()
Obtiene los datos del usuario correspondiente a un correo electrónico determinado.
Consulte Recuperar datos de usuario para ver ejemplos de código y documentación detallada.
Firma:
getUserByEmail(email: string): Promise<UserRecord>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| correo electrónico | cadena | El correo electrónico correspondiente al usuario cuyos datos desea recuperar. |
Devoluciones:
Promesa< Registro de usuario >
Una promesa cumplida con los datos del usuario correspondientes al correo electrónico proporcionado.
BaseAuth.getUserByPhoneNumber()
Obtiene los datos del usuario correspondiente a un número de teléfono determinado. El número de teléfono debe cumplir con la especificación E.164.
Consulte Recuperar datos de usuario para ver ejemplos de código y documentación detallada.
Firma:
getUserByPhoneNumber(phoneNumber: string): Promise<UserRecord>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| número de teléfono | cadena | El número de teléfono correspondiente al usuario cuyos datos se van a recuperar. |
Devoluciones:
Promesa< Registro de usuario >
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 una identificación de proveedor determinada.
Consulte Recuperar datos de usuario para ver ejemplos de código y documentación detallada.
Firma:
getUserByProviderUid(providerId: string, uid: string): Promise<UserRecord>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| ID de proveedor | cadena | El ID del proveedor, por ejemplo, "google.com" para el proveedor de Google. |
| fluido | cadena | El identificador de usuario para el proveedor determinado. |
Devoluciones:
Promesa< Registro de usuario >
Una promesa cumplida con los datos del usuario correspondientes al id del proveedor dado.
BaseAuth.getUsers()
Obtiene los datos del usuario correspondientes a los identificadores especificados.
No hay garantías de pedido; en particular, no se garantiza que la enésima entrada de la lista de resultados corresponda con la enésima entrada de la lista de parámetros de entrada.
Sólo se podrá suministrar 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 | Tipo | 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< ObtenerResultadoUsuarios >
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 uno a la vez. 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.
Firma:
importUsers(users: UserImportRecord[], options?: UserImportOptions): Promise<UserImportResult>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| usuarios | Registro de importación de usuario [] | La lista de registros de usuarios 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< ResultadoImportaciónUsuario >
Una promesa que se resuelve cuando la operación se completa con el resultado de la importación. Esto incluye la cantidad de importaciones exitosas, la cantidad 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 proveedores de SAML y OIDC requiere la plataforma de identidad de Google Cloud (GCIP). Para obtener más información sobre GCIP, incluidos precios y funciones, consulte 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á. |
Devoluciones:
Promesa < 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 solo 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 Listar 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 | Tipo | Descripción |
|---|---|---|
| resultados máximos | número | El tamaño de la página, 1000 si no está definido. Este es también el límite máximo permitido. |
| token de página | cadena | El token de la página siguiente. Si no se especifica, devuelve usuarios que comienzan sin ningún desplazamiento. |
Devoluciones:
Promesa< ListaUsuariosResultado >
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á UserRecord.tokensValidAfterTime del usuario al UTC actual. Es importante que el servidor al que se llama tenga su reloj configurado correctamente y sincronizado.
Si bien esto revocará todas las sesiones de un usuario específico y deshabilitará la acuñación de nuevos tokens de identificación para sesiones existentes, los tokens de identificación existentes pueden permanecer activos hasta su vencimiento natural (una hora). Para verificar que los tokens de identificación estén revocados, use BaseAuth.verifyIdToken() donde checkRevoked está establecido en verdadero.
Firma:
revokeRefreshTokens(uid: string): Promise<void>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| fluido | cadena | El uid correspondiente al usuario cuyos tokens de actualización se van a revocar. |
Devoluciones:
Promesa<nulo>
Una promesa vacía que se cumple una vez que se revocan los tokens de actualización del usuario.
BaseAuth.setCustomUserClaims()
Establece reclamos de desarrollador adicionales sobre un usuario existente identificado por el uid proporcionado , normalmente utilizado para definir roles de usuario y niveles de acceso. Estos reclamos deben propagarse a todos los dispositivos donde el usuario ya inició sesión (después de la expiración del token o cuando se fuerza la actualización del token) y la próxima vez que el usuario inicie sesión. Si se utiliza un nombre de reclamo OIDC reservado (sub, iat, iss, etc.) ), se genera un error. Se configuran en el token de ID del usuario autenticado JWT.
Consulte Definición de roles de usuario y niveles de acceso para obtener ejemplos de código y documentación detallada.
Firma:
setCustomUserClaims(uid: string, customUserClaims: object | null): Promise<void>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| fluido | cadena | El uid del usuario a editar. |
| reclamaciones de usuario personalizadas | objeto | nulo | El desarrollador afirma establecer. Si se pasa null, se eliminan las reclamaciones personalizadas existentes. Pasar una carga útil de reclamaciones personalizada de más de 1000 bytes generará un error. Los reclamos personalizados se agregan al token de identificación del usuario que se transmite en cada solicitud autenticada. Para atributos de usuario no relacionados con el acceso al perfil, utilice una base de datos u otros sistemas de almacenamiento separados. |
Devoluciones:
Promesa<nulo>
Una promesa que se resuelve cuando la operación se completa correctamente.
BaseAuth.updateProviderConfig()
Devuelve una promesa que se resuelve con el AuthProviderConfig actualizado correspondiente al ID del proveedor especificado. Si el ID especificado no existe, se genera un error auth/configuration-not-found .
La compatibilidad con proveedores de SAML y OIDC requiere la plataforma de identidad de Google Cloud (GCIP). Para obtener más información sobre GCIP, incluidos precios y funciones, consulte la documentación de GCIP. .
Firma:
updateProviderConfig(providerId: string, updatedConfig: UpdateAuthProviderRequest): Promise<AuthProviderConfig>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| ID de proveedor | cadena | El ID del proveedor correspondiente a la configuración del proveedor que se va a actualizar. |
| configuración actualizada | Solicitud de actualización de proveedor de autenticación | La configuración actualizada. |
Devoluciones:
Promesa< AuthProviderConfig >
Una promesa que se resuelve con la configuración del proveedor actualizada.
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 | Tipo | Descripción |
|---|---|---|
| fluido | cadena | El uid correspondiente al usuario a actualizar. |
| propiedades | Solicitud de actualización | Las propiedades que se actualizarán 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 las afirmaciones decodificadas del token; de lo contrario, la promesa se rechaza.
Si checkRevoked se establece en verdadero, primero verifica si el usuario correspondiente está deshabilitado. En caso afirmativo, se genera un error auth/user-disabled . En caso negativo, verifica si la sesión correspondiente al token de ID fue revocada. Si la sesión del usuario correspondiente fue invalidada, se genera un error auth/id-token-revoked . Si no se especifica el cheque no se aplica.
Consulte Verificar tokens de identificación para obtener ejemplos de código y documentación detallada.
Firma:
verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| token de identificación | cadena | El token de identificación que se va a verificar. |
| comprobarRevocado | booleano | Si se debe verificar si el token de identificación 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 afirmaciones decodificadas del token si el token de identificación es válido; de lo contrario, una promesa rechazada.
BaseAuth.verifySessionCookie()
Verifica una cookie de sesión de Firebase. Devuelve una Promesa con las afirmaciones 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 . En caso negativo, verifica si la sesión correspondiente a la cookie de sesión fue revocada. Si la sesión del usuario correspondiente fue invalidada, se genera un error auth/session-cookie-revoked . Si no se especifica, la verificación no se realiza.
Consulte Verificar cookies de sesión para obtener ejemplos de código y documentación detallada.
Firma:
verifySessionCookie(sessionCookie: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| cookie de sesión | cadena | La cookie de sesión para verificar. |
| comprobarRevocado | booleano |
Devoluciones:
Promesa< DecodedIdToken >
Una promesa cumplida con las afirmaciones decodificadas de la cookie de sesión si la cookie de sesión es válida; de lo contrario, una promesa rechazada.