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 al dispositivo cliente para usarlo para acceder con los SDK de cliente. signInWithCustomToken(). (Las instancias con reconocimiento de usuarios también incorporarán el ID de usuario en el token).Consulta Cómo crear tokens personalizados para ver muestras de código y documentación detallada. |
|
| createProviderConfig(config) | Muestra una promesa que se resuelve con el AuthProviderConfig recién creado cuando se crea la configuración del proveedor nuevo.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 sesiones. El JWT de la cookie de sesión tendrá las mismas reclamaciones de carga útil que el token de ID proporcionado.Consulta Cómo 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 de proveedor correspondiente al ID de proveedor pasado. 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. |
|
| 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). Se considera que los usuarios que no existen se borraron correctamente, por lo que 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 arroja un error de FirebaseAuthError.Actualmente, esta API tiene una limitación de frecuencia de 1 QPS en el servidor. Si superas este límite, es posible que recibas un 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. |
|
| generateEmailVerificaciónLink(correo electrónico, 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 a este método define si una app para dispositivos móviles o un navegador controlará el vínculo junto con información de estado adicional que se pasará en el vínculo directo, etcétera. | |
| generatePasswordResetLink(correo electrónico, actionCodeSettings) | Genera un vínculo de acción de correo electrónico fuera de banda para restablecer la contraseña de un usuario. El vínculo se genera para el usuario con la dirección de correo electrónico especificada. El objeto opcional ActionCodeSettings define si el vínculo se debe controlar mediante una app para dispositivos móviles o un navegador, así como la información de estado adicional que se debe pasar en el vínculo directo, etcétera. | |
| generateSignInWithEmailLink(correo electrónico, 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 a este método define si una app para dispositivos móviles o un navegador controlará el vínculo junto con información de estado adicional que se pasará en el vínculo directo, etcétera. | |
| generateVerifyAndChangeEmailLink(correo electrónico, newEmail, actionCodeSettings) | Genera un 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 a este método define si una app para dispositivos móviles o un navegador controlará el vínculo junto con información de estado adicional que se pasará en el vínculo directo, etcétera. | |
| getProviderConfig(providerId) | Busca una configuración del proveedor de autenticación según 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. |
|
| getUser(uid) | Obtiene los datos del usuario correspondientes a un objeto uid determinado.Consulta Cómo recuperar los datos del usuario para ver muestras de código y documentación detallada. |
|
| getUserByEmail(correo electrónico) | Permite obtener 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 ver muestras de código y documentación detallada. | |
| getUserByProviderUid(providerId, uid) | Obtiene los datos del usuario correspondientes 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(identifiers) | 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 entrada 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 FirebaseAuthError. | |
| importUsers(usuarios, opciones) | Importa la lista proporcionada de usuarios a Firebase Auth. Se permite importar un máximo de 1,000 usuarios a la vez. Cuando importas usuarios con contraseñas, se debe especificar UserImportOptions. Esta operación está optimizada para las importaciones masivas y, además, ignorará las verificaciones de uid, email y otros identificadores únicos que podrían generar duplicaciones. |
|
| listProviderConfigs(options) | Devuelve la lista de configuraciones de proveedores existentes que coinciden con el filtro proporcionado. Se pueden mostrar 100 parámetros de configuración de proveedores como máximo 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 un lote) con un tamaño de maxResults a partir del desplazamiento especificado por pageToken. Se usa para recuperar todos los usuarios de un proyecto especificado por lotes.Consulta Enumera todos los usuarios para ver 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 a la hora UTC actual. Es importante que el servidor al que se llama tenga el reloj configurado correctamente y sincronizado.Si bien esta acción revocará todas las sesiones de un usuario específico e inhabilitará la emisión de tokens de ID nuevos para sesiones existentes, los tokens de ID existentes pueden permanecer activos hasta su vencimiento natural (una hora). Para verificar que se hayan revocado los tokens de ID, usa BaseAuth.verifyIdToken(), donde checkRevoked está configurado como verdadero. |
|
| setCustomUserClaims(uid, customUserClaims) | Establece reclamaciones adicionales del desarrollador en un usuario existente identificado por el uid proporcionado. Por lo general, se usa para definir roles del usuario y niveles de acceso. Estas reclamaciones deben propagarse a todos los dispositivos en los que el usuario ya accedió (después del vencimiento del token o cuando se fuerza su actualización) y la próxima vez que acceda. Si se usa un nombre de reclamación de OIDC reservado (sub, iat, iss, etc.), se genera un error. Se establecen en el token de ID del usuario autenticado JWT.Consulta Definición de roles del usuario y niveles de acceso para ver ejemplos 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 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. |
|
| 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 configura checkRevoked como true, 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 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 Verificar tokens de ID para ver muestras de código y documentación detallada. |
|
| verifySessionCookie(sessionCookie, checkRestrictedd) | Verifica una cookie de sesión de Firebase. Devuelve una promesa con las reclamaciones de cookies. Rechaza la promesa si no se pudo verificar la cookie.Si se configura checkRevoked como verdadero, primero se verifica si el usuario correspondiente está inhabilitado. De ser así, se mostrará 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 token personalizado de Firebase (JWT) nuevo que se puede enviar de vuelta al dispositivo cliente para usarlo para acceder con los SDK de cliente. signInWithCustomToken(). (Las instancias con reconocimiento de usuarios también incorporarán el ID de usuario en el token).
Consulta Crea 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 | string | El uid que se usará como sujeto del token personalizado. |
| developerClaims | objeto | Reclamaciones adicionales opcionales que se incluirán en la carga útil del token personalizado. |
Muestra:
Promesa<string>
Una promesa que se cumple con un token personalizado para el uid y la carga útil proporcionados.
BaseAuth.createProviderConfig()
Muestra una promesa que se resuelve con el AuthProviderConfig recién creado cuando se crea la configuración del proveedor nuevo.
La compatibilidad con los 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.
Firma:
createProviderConfig(config: AuthProviderConfig): Promise<AuthProviderConfig>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| config | AuthProviderConfig | La configuración del proveedor que se creará. |
Muestra:
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 sesiones. 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 | string | El token de ID de Firebase que se intercambia por una cookie de sesión. |
| SessionCookieOptions | SessionCookieOptions. | Son las opciones de cookies de sesión, que incluyen la duración personalizada de la sesión. |
Muestra:
Promesa<string>
Una promesa que se resuelve en función del é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 configurarán en el nuevo registro de usuario que se creará. |
Muestra:
Promesa<UserRecord>
Una promesa que se cumple con los datos del usuario correspondientes al usuario recién creado.
BaseAuth.deleteProviderConfig()
Borra la configuración de 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 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 | string | El ID de proveedor que corresponde a la configuración del proveedor que se borrará. |
Muestra:
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 | string | El uid que corresponde al usuario que se borrará. |
Muestra:
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á un error (es decir, este método es idempotente). Se considera que los usuarios que no existen se borraron correctamente y, por lo tanto, se registran 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 un límite de frecuencia de 1 QPS en el servidor. Si superas este límite, es posible que recibas un 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 |
|---|---|---|
| UIDs | string[] | El uids correspondiente a los usuarios que se borrarán. |
Muestra:
Promesa<DeleteUsersResult>
Una promesa que resuelve la cantidad total de eliminaciones correctas o fallidas, así como el array de errores que corresponde a las eliminaciones fallidas.
BaseAuth.generateEmail VerificationLink().
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 a este método define si una app para dispositivos móviles o un navegador controlará el vínculo junto con información de estado adicional 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 |
|---|---|---|
| string | La cuenta de correo electrónico que se verificará. | |
| actionCodeSettings | ActionCodeSettings | La configuración del código de acción. Si se especifica, la URL de estado/continuación se establece como "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 usará a fin de mostrar un vínculo para volver a la app si está instalada. Si no se especifica actionCodeSettings, no se agrega ninguna URL a la URL de la acción. La URL de estado proporcionada debe pertenecer a un dominio que el desarrollador incluyó en la lista de entidades permitidas de la consola. De lo contrario, se mostrará 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. |
Muestra:
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
});
BaseAuth.generatePasswordResetLink()
Genera un vínculo de acción de correo electrónico fuera de banda para restablecer la contraseña de un usuario. El vínculo se genera para el usuario con la dirección de correo electrónico especificada. El objeto opcional ActionCodeSettings define si el vínculo se debe controlar mediante una app para dispositivos móviles o un navegador, así como la información de estado adicional que se debe pasar en el vínculo directo, etcétera.
Firma:
generatePasswordResetLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| string | La dirección de correo electrónico del usuario cuya contraseña se restablecerá. | |
| actionCodeSettings | ActionCodeSettings | La configuración del código de acción. Si se especifica, la URL de estado/continuación se establece como "continueUrl" en el vínculo para restablecer la contraseña. La página de destino predeterminada para el restablecimiento de la contraseña la utilizará para mostrar un vínculo que permite regresar a la app si está instalada. Si no se especifica actionCodeSettings, no se agrega ninguna URL a la URL de la acción. La URL de estado proporcionada debe pertenecer a un dominio que el desarrollador incluyó en la lista de entidades permitidas de la consola. De lo contrario, se mostrará 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. |
Muestra:
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
});
BaseAuth.generateSignInWithEmailLink()
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 a este método define si una app para dispositivos móviles o un navegador controlará el vínculo junto con información de estado adicional 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 |
|---|---|---|
| string | La cuenta de correo electrónico que se verificará. | |
| actionCodeSettings | ActionCodeSettings | La configuración del código de acción. Si se especifica, la URL de estado/continuación se establece como "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 usará a fin de mostrar un vínculo para volver a la app si está instalada. Si no se especifica actionCodeSettings, no se agrega ninguna URL a la URL de la acción. La URL de estado proporcionada debe pertenecer a un dominio que el desarrollador incluyó en la lista de entidades permitidas de la consola. De lo contrario, se mostrará 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. |
Muestra:
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
});
BaseAuth.generateVerifyAndChangeEmailLink()
Genera un 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 a este método define si una app para dispositivos móviles o un navegador controlará el vínculo junto con información de estado adicional 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 |
|---|---|---|
| string | La cuenta de correo electrónico actual. | |
| Correo electrónico nuevo | string | La dirección de correo electrónico a la que se actualizará la cuenta. |
| actionCodeSettings | ActionCodeSettings | La configuración del código de acción. Si se especifica, la URL de estado/continuación se establece como "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 usará a fin de mostrar un vínculo para volver a la app si está instalada. Si no se especifica actionCodeSettings, no se agrega ninguna URL a la URL de la acción. La URL de estado proporcionada debe pertenecer a un dominio autorizado en la consola; de lo contrario, se mostrará 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. |
Muestra:
Promesa<string>
Una promesa que se resuelve con el vínculo generado.
BaseAuth.getProviderConfig()
Busca una configuración del proveedor de autenticación según 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 genera un error auth/configuration-not-found.
La compatibilidad con los 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.
Firma:
getProviderConfig(providerId: string): Promise<AuthProviderConfig>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| providerId | string | El ID de proveedor correspondiente a la configuración del proveedor que se mostrará. |
Muestra:
Promesa<AuthProviderConfig>
Una promesa que se resuelve con la configuración correspondiente al ID proporcionado.
BaseAuth.getUser()
Obtiene los datos del usuario correspondientes a un uid determinado.
Consulta Recupera los 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 | string | El uid que corresponde al usuario cuyos datos se recuperarán. |
Muestra:
Promesa<UserRecord>
Una promesa que se cumple con los datos del usuario correspondientes al uid proporcionado.
BaseAuth.getUserByEmail()
Obtiene los datos del usuario correspondientes a un correo electrónico determinado.
Consulta Recupera los 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 |
|---|---|---|
| string | El correo electrónico correspondiente al usuario cuyos datos se recuperarán. |
Muestra:
Promesa<UserRecord>
Una promesa cumplida 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 los 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 | string | El número de teléfono correspondiente al usuario cuyos datos se recuperarán. |
Muestra:
Promesa<UserRecord>
Una promesa que se cumple con los datos del usuario correspondientes al número de teléfono proporcionado.
BaseAuth.getUserByProviderUid()
Obtiene los datos del usuario correspondientes a un ID de proveedor determinado.
Consulta Recupera los 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 | string | El ID del proveedor; por ejemplo, "google.com" para el proveedor de Google. |
| uid | string | Es el identificador de usuario del proveedor determinado. |
Muestra:
Promesa<UserRecord>
Una promesa que se cumple 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 pedido; En particular, no se garantiza que la enésima entrada de la lista de resultados corresponda a la enésima entrada 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 FirebaseAuthError.
Firma:
getUsers(identifiers: UserIdentifier[]): Promise<GetUsersResult>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| identifiers | Identificador de usuario | Los identificadores que se usan para indicar qué registros de usuario se deben mostrar. No debe tener más de 100 entradas. |
Muestra:
Promesa<GetUsersResult>
Una promesa que resuelve 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 proporcionada de usuarios a Firebase Auth. Se permite importar un máximo de 1,000 usuarios a la vez. Cuando importas usuarios con contraseñas, se debe especificar UserImportOptions. Esta operación está optimizada para las importaciones masivas y, además, ignorará las verificaciones de uid, email y otros identificadores únicos que podrían generar duplicaciones.
Firma:
importUsers(users: UserImportRecord[], options?: UserImportOptions): Promise<UserImportResult>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| usuarios | UserImportRecord | Es la lista de registros de usuarios para importar a Firebase Auth. |
| opciones | UserImportOptions | Las opciones de importación de usuarios, obligatorias cuando los usuarios proporcionados incluyen credenciales de contraseña. |
Muestra:
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, de importaciones con errores y de los 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 parámetros de configuración de proveedores a la vez.
La compatibilidad con los 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.
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á. |
Muestra:
Promesa<ListProviderConfigResults>
Una promesa que se resuelve con la lista de parámetros de configuración de proveedores que cumplen con los requisitos de filtro.
BaseAuth.listUsers()
Recupera una lista de usuarios (solo un lote) con un tamaño de maxResults a partir del desplazamiento que especifica pageToken. Se usa para recuperar todos los usuarios de un proyecto especificado por lotes.
Consulta Enumera 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 | Es el tamaño de la página, 1,000 si no está definido. Este también es el límite máximo permitido. |
| pageToken | string | El token de la página siguiente. Si no se especifica, muestra los usuarios que comienzan sin ningún desplazamiento. |
Muestra:
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 a la UTC actual. Es importante que el servidor al que se llama tenga configurado el reloj de forma correcta y sincronizado.
Si bien esta acción revocará todas las sesiones de un usuario específico y también inhabilitará la emisión de tokens de ID nuevos para sesiones existentes, los tokens de ID existentes pueden permanecer activos hasta su vencimiento natural (una hora). Para verificar que se hayan revocado los tokens de ID, usa BaseAuth.verifyIdToken(), donde checkRevoked está configurado como verdadero.
Firma:
revokeRefreshTokens(uid: string): Promise<void>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| uid | string | El uid correspondiente al usuario cuyos tokens de actualización se revocarán. |
Muestra:
Promesa<void>
Una promesa vacía que se cumple una vez que se revocan los tokens de actualización del usuario.
BaseAuth.setCustomUserClaims()
Establece reclamaciones adicionales del desarrollador en un usuario existente identificado por el uid proporcionado. Por lo general, se usa para definir roles del usuario y niveles de acceso. Estas reclamaciones deben propagarse a todos los dispositivos en los que el usuario ya accedió (después del vencimiento del token o cuando se fuerza su actualización) y la próxima vez que acceda. Si se usa un nombre de reclamación de OIDC reservado (sub, iat, iss, etc.), se genera un error. Se establecen en el token JWT del ID del usuario autenticado.
Consulta Define 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 | string | El uid del usuario que se editará. |
| customUserClaims | objeto | nulo | El desarrollador afirma establecer. Si se pasa null, se borran los reclamos personalizados existentes. Si se pasa una carga útil de reclamación personalizada superior a 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 relacionados con el perfil y no relacionados con el acceso, usa la base de datos o algún otro sistema de almacenamiento independiente. |
Muestra:
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 genera un error auth/configuration-not-found.
La compatibilidad con los 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.
Firma:
updateProviderConfig(providerId: string, updatedConfig: UpdateAuthProviderRequest): Promise<AuthProviderConfig>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| providerId | string | El ID de proveedor correspondiente a la configuración del proveedor que se actualizará. |
| Configuración actualizada | UpdateAuthProviderRequest | La configuración actualizada. |
Muestra:
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 | string | El uid que corresponde al usuario que se actualizará. |
| del bucket | UpdateRequest | Las propiedades que se actualizarán en el usuario proporcionado. |
Muestra:
Promesa<UserRecord>
Una promesa que se cumple 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 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 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 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 | string | El token de ID que se debe verificar. |
| checkRevocado | booleano | Establece 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 aplica esta verificación adicional. |
Muestra:
Promesa<DecodedIdToken>
Una promesa que se cumple 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 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. De ser así, se mostrará 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 |
|---|---|---|
| sessionCookie | string | La cookie de sesión que se verificará. |
| checkRevocado | booleano |
Muestra:
Promesa<DecodedIdToken>
Una promesa que se cumple 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.