Primeros pasos
Copia un prompt de configuración con los pasos de instalación y la guía completa en markdown para este plugin.
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-firebase-authentication`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/firebase-authentication/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
Instalar
Sección titulada “Instalación”Puedes usar nuestro setup asistido por IA para instalar el plugin. Añade las skills de Capgo a tu herramienta de IA con el siguiente comando:
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-pluginsLuego usa el siguiente prompt:
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-firebase-authentication` plugin in my project.Si prefieres la configuración manual, instala el plugin ejecutando estos comandos y sigue las instrucciones de cada plataforma:
bun add @capgo/capacitor-firebase-authenticationnpx cap syncImportar
Sección titulada “Importar”import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';Inicio rápido
Sección titulada “Inicio rápido”import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.applyActionCode({ oobCode: 'oob-code' });Ejemplo: confirmPasswordReset
Sección titulada “Example: confirmPasswordReset”import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.confirmPasswordReset({ oobCode: 'oob-code', newPassword: 'new-password',});Ejemplo: confirmVerificationCode
Sección titulada “Example: confirmVerificationCode”import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.confirmVerificationCode({ verificationId: 'phoneCodeSent', verificationCode: 'phoneCodeSent',});// The result holds sensitive values: use it without logging it.Errores comunes
Sección titulada “Errores comunes”- Listeners: elimina los handles cuando se desmonten las pantallas.
- Sync nativo: ejecuta
npx cap synctras actualizar los plugins. - Fuente de verdad: confianza
src/definitions.tsen el repo de GitHub.
Resumen de API
Sección titulada “Resumen de API”applyActionCode
Sección titulada “applyActionCode”Aplica un code de verificación enviado al usuario por email.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.applyActionCode({ oobCode: 'oob-code' });confirmPasswordReset
Sección titulada “confirmPasswordReset”Completa el proceso de restablecimiento de contraseña.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.confirmPasswordReset({ oobCode: 'oob-code', newPassword: 'new-password',});confirmVerificationCode
Sección titulada “confirmVerificationCode”Finaliza el proceso de verificación del número de teléfono.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.confirmVerificationCode({ verificationId: 'phoneCodeSent', verificationCode: 'phoneCodeSent',});// The result holds sensitive values: use it without logging it.createUserWithEmailAndPassword
Sección titulada “createUserWithEmailAndPassword”Crea una nueva cuenta de usuario con email y contraseña. Si la cuenta se crea correctamente, el usuario inicia sesión automáticamente.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.createUserWithEmailAndPassword({ email: 'user@example.com', password: 'password',});// The result holds sensitive values: use it without logging it.deleteUser
Sección titulada “deleteUser”Elimina al usuario y cierra su sesión.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.deleteUser();fetchSignInMethodsForEmail
Sección titulada “fetchSignInMethodsForEmail”Obtiene los métodos de inicio de sesión de una dirección de email.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.fetchSignInMethodsForEmail({ email: 'user@example.com' });console.log(result);getCurrentUser
Sección titulada “getCurrentUser”Obtiene el usuario que ha iniciado sesión actualmente.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.getCurrentUser();// The result holds sensitive values: use it without logging it.getPendingAuthResult
Sección titulada “getPendingAuthResult”Devuelve el SignInResult si tu app inició un flujo de inicio de sesión web y el SO cierra la app mientras está en segundo plano.
Solo disponible para Android.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.getPendingAuthResult();// The result holds sensitive values: use it without logging it.getIdToken
Sección titulada “getIdToken”Obtiene el ID Token de Firebase Auth para el usuario autenticado actualmente.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.getIdToken();// The result holds sensitive values: use it without logging it.getIdTokenResult
Sección titulada “getIdTokenResult”Devuelve un JSON Web Token (JWT) deserializado para identificar al usuario ante un servicio de Firebase.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.getIdTokenResult();// The result holds sensitive values: use it without logging it.getRedirectResult
Sección titulada “getRedirectResult”Devuelve el SignInResult del flujo de inicio de sesión mediante redirección.
Si el inicio de sesión falla, devuelve un error.
Si no se llamó a una operación de redirección, devuelve un SignInResult con un usuario nulo.
Solo disponible para Web.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.getRedirectResult();// The result holds sensitive values: use it without logging it.getTenantId
Sección titulada “getTenantId”Obtiene el tenant id.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.getTenantId();console.log(result);isSignInWithEmailLink
Sección titulada “isSignInWithEmailLink”Comprueba si el enlace entrante es un sign-in con email apto para signInWithEmailLink.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.isSignInWithEmailLink({ emailLink: 'https://example.com' });// The result holds sensitive values: use it without logging it.linkWithApple
Sección titulada “linkWithApple”Vincula la cuenta de usuario con el proveedor de autenticación de Apple.
El usuario debe haber iniciado sesión en la capa nativa.
La skipNativeAuth opción de configuración no tiene efecto aquí.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.linkWithApple();// The result holds sensitive values: use it without logging it.linkWithEmailAndPassword
Sección titulada “linkWithEmailAndPassword”Vincula la cuenta de usuario con el proveedor de autenticación por email.
El usuario debe haber iniciado sesión en la capa nativa.
La skipNativeAuth opción de configuración no tiene efecto aquí.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.linkWithEmailAndPassword({ email: 'user@example.com', password: 'password',});// The result holds sensitive values: use it without logging it.linkWithEmailLink
Sección titulada “linkWithEmailLink”Vincula la cuenta de usuario con el proveedor de autenticación por email.
El usuario debe haber iniciado sesión en la capa nativa.
La skipNativeAuth opción de configuración no tiene efecto aquí.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.linkWithEmailLink({ email: 'user@example.com', emailLink: 'https://example.com',});// The result holds sensitive values: use it without logging it.linkWithFacebook
Sección titulada “linkWithFacebook”Vincula la cuenta de usuario con el proveedor de autenticación de Facebook.
El usuario debe haber iniciado sesión en la capa nativa.
La skipNativeAuth opción de configuración no tiene efecto aquí.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.linkWithFacebook();// The result holds sensitive values: use it without logging it.linkWithGameCenter
Sección titulada “linkWithGameCenter”Vincula la cuenta de usuario con el proveedor de Game Center.
El usuario debe haber iniciado sesión en la capa nativa.
La skipNativeAuth opción de configuración no tiene efecto aquí.
Solo disponible para iOS.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.linkWithGameCenter();// The result holds sensitive values: use it without logging it.linkWithGithub
Sección titulada “linkWithGithub”Vincula la cuenta de usuario con el proveedor GitHub.
El usuario debe haber iniciado sesión en la capa nativa.
La skipNativeAuth opción de configuración no tiene efecto aquí.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.linkWithGithub();// The result holds sensitive values: use it without logging it.linkWithGoogle
Sección titulada “linkWithGoogle”Vincula la cuenta de usuario con el proveedor de Google.
El usuario debe haber iniciado sesión en la capa nativa.
La skipNativeAuth opción de configuración no tiene efecto aquí.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.linkWithGoogle();// The result holds sensitive values: use it without logging it.linkWithMicrosoft
Sección titulada “linkWithMicrosoft”Vincula la cuenta de usuario con el proveedor de Microsoft.
El usuario debe haber iniciado sesión en la capa nativa.
La skipNativeAuth opción de configuración no tiene efecto aquí.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.linkWithMicrosoft();// The result holds sensitive values: use it without logging it.linkWithOpenIdConnect
Sección titulada “linkWithOpenIdConnect”Vincula la cuenta de usuario con un proveedor OpenID Connect.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.linkWithOpenIdConnect({ providerId: 'provider-id-123' });// The result holds sensitive values: use it without logging it.linkWithPhoneNumber
Sección titulada “linkWithPhoneNumber”Vincula la cuenta de usuario con el proveedor de número de teléfono.
El usuario debe haber iniciado sesión en la capa nativa.
La skipNativeAuth opción de configuración no tiene efecto aquí.
Usa la phoneVerificationCompleted listener para recibir una notificación cuando se complete la verificación.
Usa el phoneVerificationFailed listener para recibir una notificación cuando la verificación falle.
Usa el phoneCodeSent listener para obtener el id de verificación.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.linkWithPhoneNumber({ phoneNumber: "+16505550101" });linkWithPlayGames
Sección titulada “linkWithPlayGames”Vincula la cuenta de usuario con el proveedor de Play Games.
El usuario debe haber iniciado sesión en la capa nativa.
La skipNativeAuth opción de configuración no tiene efecto aquí.
Solo disponible para Android.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.linkWithPlayGames();// The result holds sensitive values: use it without logging it.linkWithTwitter
Sección titulada “linkWithTwitter”Vincula la cuenta de usuario con el proveedor de Twitter.
El usuario debe haber iniciado sesión en la capa nativa.
La skipNativeAuth opción de configuración no tiene efecto aquí.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.linkWithTwitter();// The result holds sensitive values: use it without logging it.linkWithYahoo
Sección titulada “linkWithYahoo”Vincula la cuenta de usuario con el proveedor de Yahoo.
El usuario debe haber iniciado sesión en la capa nativa.
La skipNativeAuth opción de configuración no tiene efecto aquí.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.linkWithYahoo();// The result holds sensitive values: use it without logging it.Recarga los datos de la cuenta si hay una sesión activa.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.reload();revokeAccessToken
Sección titulada “revokeAccessToken”Revoca el access token indicado. Actualmente solo admite access tokens de Apple OAuth.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.revokeAccessToken({ token: 'token-123' });sendEmailVerification
Sección titulada “sendEmailVerification”Envía un email de verificación al usuario con la sesión iniciada.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.sendEmailVerification();sendPasswordResetEmail
Sección titulada “sendPasswordResetEmail”Envía un email para restablecer la contraseña.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.sendPasswordResetEmail({ email: 'user@example.com' });sendSignInLinkToEmail
Sección titulada “sendSignInLinkToEmail”Envía al usuario un enlace de inicio de sesión al email especificado.
Para completar el inicio de sesión con el enlace de email, llama a signInWithEmailLink con la dirección de email y el enlace de email incluido en el correo enviado al usuario.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.sendSignInLinkToEmail({ email: 'user@example.com', actionCodeSettings: { url: 'https://example.com' },});setLanguageCode
Sección titulada “setLanguageCode”Establece el idioma de code para las operaciones de autenticación.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.setLanguageCode({ languageCode: "en-US" });setPersistence
Sección titulada “setPersistence”Define el tipo de persistencia de la sesión de auth actual.
Solo disponible para Web.
import { FirebaseAuthentication, Persistence } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.setPersistence({ persistence: Persistence.IndexedDbLocal });setTenantId
Sección titulada “setTenantId”Establece el id del tenant.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.setTenantId({ tenantId: 'tenant-id-123' });signInAnonymously
Sección titulada “signInAnonymously”Inicia sesión como usuario anónimo.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.signInAnonymously();// The result holds sensitive values: use it without logging it.signInWithApple
Sección titulada “signInWithApple”Inicia el flujo de inicio de sesión con Apple.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.signInWithApple();// The result holds sensitive values: use it without logging it.signInWithCustomToken
Sección titulada “signInWithCustomToken”Inicia el flujo de inicio de sesión con Custom Token.
Este método no se puede usar junto con skipNativeAuth en Android e iOS.
En este caso, debes usar la signInWithCustomToken interfaz de Firebase JS SDK directamente.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.signInWithCustomToken({ token: 'token-123' });// The result holds sensitive values: use it without logging it.signInWithEmailAndPassword
Sección titulada “signInWithEmailAndPassword”Inicia el flujo de inicio de sesión con email y contraseña.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.signInWithEmailAndPassword({ email: 'user@example.com', password: 'password',});// The result holds sensitive values: use it without logging it.signInWithEmailLink
Sección titulada “signInWithEmailLink”Inicia sesión con un email y un enlace de inicio de sesión.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.signInWithEmailLink({ email: 'user@example.com', emailLink: 'https://example.com',});// The result holds sensitive values: use it without logging it.signInWithFacebook
Sección titulada “signInWithFacebook”Inicia el flujo de inicio de sesión con Facebook.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.signInWithFacebook();// The result holds sensitive values: use it without logging it.signInWithGameCenter
Sección titulada “signInWithGameCenter”Inicia el flujo de inicio de sesión de Game Center.
Solo disponible para iOS.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.signInWithGameCenter();// The result holds sensitive values: use it without logging it.signInWithGithub
Sección titulada “signInWithGithub”Inicia el flujo de inicio de sesión de GitHub.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.signInWithGithub();// The result holds sensitive values: use it without logging it.signInWithGoogle
Sección titulada “signInWithGoogle”Inicia el flujo de inicio de sesión con Google.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.signInWithGoogle();// The result holds sensitive values: use it without logging it.signInWithMicrosoft
Sección titulada “signInWithMicrosoft”Inicia el flujo de inicio de sesión de Microsoft.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.signInWithMicrosoft();// The result holds sensitive values: use it without logging it.signInWithOpenIdConnect
Sección titulada “signInWithOpenIdConnect”Inicia el flujo de inicio de sesión de OpenID Connect.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.signInWithOpenIdConnect({ providerId: 'provider-id-123' });// The result holds sensitive values: use it without logging it.signInWithPhoneNumber
Sección titulada “signInWithPhoneNumber”Inicia el flujo de inicio de sesión con número de teléfono.
Usa la phoneVerificationCompleted listener para recibir una notificación cuando se complete la verificación.
Usa el phoneVerificationFailed listener para recibir una notificación cuando la verificación falle.
Usa el phoneCodeSent listener para obtener el id de verificación.
Solo disponible para Android e iOS.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.signInWithPhoneNumber({ phoneNumber: "+16505550101" });signInWithPlayGames
Sección titulada “signInWithPlayGames”Inicia el flujo de inicio de sesión de Play Games.
Solo disponible para Android.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.signInWithPlayGames();// The result holds sensitive values: use it without logging it.signInWithTwitter
Sección titulada “signInWithTwitter”Inicia el flujo de inicio de sesión con Twitter.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.signInWithTwitter();// The result holds sensitive values: use it without logging it.signInWithYahoo
Sección titulada “signInWithYahoo”Inicia el flujo de inicio de sesión de Yahoo.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.signInWithYahoo();// The result holds sensitive values: use it without logging it.signOut
Sección titulada “signOut”Inicia el flujo de cierre de sesión.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.signOut();Desvincula un proveedor de una cuenta de usuario.
import { FirebaseAuthentication, ProviderId } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.unlink({ providerId: ProviderId.APPLE });// The result holds sensitive values: use it without logging it.updateEmail
Sección titulada “updateEmail”Actualiza el email del usuario con sesión iniciada.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.updateEmail({ newEmail: 'user@example.com' });updatePassword
Sección titulada “updatePassword”Actualiza la contraseña del usuario que ha iniciado sesión.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.updatePassword({ newPassword: 'new-password' });updateProfile
Sección titulada “updateProfile”Actualiza los datos del perfil del usuario.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.updateProfile({ displayName: 'display', photoUrl: 'https://example.com',});useAppLanguage
Sección titulada “useAppLanguage”Establece el idioma code que ve el usuario como idioma predeterminado de la app.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.useAppLanguage();useEmulator
Sección titulada “useEmulator”Configura tu app para conectarse al emulador de Authentication.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.useEmulator({ host: "127.0.0.1" });verifyBeforeUpdateEmail
Sección titulada “verifyBeforeUpdateEmail”Verifica la nueva dirección de correo antes de actualizar el email del usuario que ha iniciado sesión.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.verifyBeforeUpdateEmail({ newEmail: 'user@example.com' });checkAppTrackingTransparencyPermission
Sección titulada “checkAppTrackingTransparencyPermission”Comprueba el estado actual de App Tracking Transparency.
Solo disponible en iOS.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.checkAppTrackingTransparencyPermission();console.log(result);requestAppTrackingTransparencyPermission
Sección titulada “requestAppTrackingTransparencyPermission”Abre el diálogo del sistema para autorizar App Tracking Transparency.
Atención: Es posible que el usuario haya desactivado la solicitud de seguimiento en los ajustes del dispositivo, ver Documentación de Apple.
Solo disponible en iOS.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.requestAppTrackingTransparencyPermission();console.log(result);Referencia de tipos
Sección titulada “Referencia de tipos”ApplyActionCodeOptions
Sección titulada “ApplyActionCodeOptions”export interface ApplyActionCodeOptions { /** * A verification code sent to the user. * * @since 0.2.2 */ oobCode: string;}ConfirmPasswordResetOptions
Sección titulada “ConfirmPasswordResetOptions”export interface ConfirmPasswordResetOptions { /** * A verification code sent to the user. * * @since 0.2.2 */ oobCode: string; /** * The new password. * * @since 0.2.2 */ newPassword: string;}ConfirmVerificationCodeOptions
Sección titulada “ConfirmVerificationCodeOptions”export interface ConfirmVerificationCodeOptions { /** * The verification ID received from the `phoneCodeSent` listener. * * The `verificationCode` option must also be provided. * * @since 5.0.0 */ verificationId: string; /** * The verification code either received from the `phoneCodeSent` listener or entered by the user. * * The `verificationId` option must also be provided. * * @since 5.0.0 */ verificationCode: string;}SignInResult
Sección titulada “SignInResult”export interface SignInResult { /** * The currently signed-in user, or null if there isn't any. * * @since 0.1.0 */ user: User | null; /** * Credentials returned by an auth provider. * * @since 0.1.0 */ credential: AuthCredential | null; /** * Additional user information from a federated identity provider. * * @since 0.5.1 */ additionalUserInfo: AdditionalUserInfo | null;}CreateUserWithEmailAndPasswordOptions
Sección titulada “CreateUserWithEmailAndPasswordOptions”export interface CreateUserWithEmailAndPasswordOptions { /** * @since 0.2.2 */ email: string; /** * @since 0.2.2 */ password: string;}FetchSignInMethodsForEmailOptions
Sección titulada “FetchSignInMethodsForEmailOptions”export interface FetchSignInMethodsForEmailOptions { /** * The user's email address. * * @since 6.0.0 */ email: string;}FetchSignInMethodsForEmailResult
Sección titulada “FetchSignInMethodsForEmailResult”export interface FetchSignInMethodsForEmailResult { /** * The sign-in methods for the specified email address. * * This list is empty when [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) * is enabled, irrespective of the number of authentication methods available for the given email. * * @since 6.0.0 */ signInMethods: string[];}GetCurrentUserResult
Sección titulada “GetCurrentUserResult”export interface GetCurrentUserResult { /** * The currently signed-in user, or null if there isn't any. * * @since 0.1.0 */ user: User | null;}GetIdTokenOptions
Sección titulada “GetIdTokenOptions”export interface GetIdTokenOptions { /** * Force refresh regardless of token expiration. * * @since 0.1.0 */ forceRefresh: boolean;}GetIdTokenResult
Sección titulada “GetIdTokenResult”export interface GetIdTokenResult { /** * The Firebase Auth ID token JWT string. * * @since 0.1.0 */ token: string;}GetIdTokenResultOptions
Sección titulada “GetIdTokenResultOptions”export interface GetIdTokenResultOptions { /** * Force refresh regardless of token expiration. * * @since 7.4.0 */ forceRefresh: boolean;}GetIdTokenResultResult
Sección titulada “GetIdTokenResultResult”export interface GetIdTokenResultResult { /** * The authentication time in milliseconds since the epoch. * * This is the time the user authenticated (signed in) and not the time the token was refreshed. * * @since 7.4.0 */ authTime: number; /** * The ID token expiration time in milliseconds since the epoch. * * @since 7.4.0 */ expirationTime: number; /** * The ID token issuance time in milliseconds since the epoch. * * @since 7.4.0 */ issuedAtTime: number; /** * The sign-in provider through which the ID token was obtained. * * @since 7.4.0 */ signInProvider: string | null; /** * The type of second factor associated with this session, provided the user was multi-factor * authenticated (eg. phone, etc). * * @since 7.4.0 */ signInSecondFactor: string | null; /** * The entire payload claims of the ID token including the standard reserved claims as well as * the custom claims. * * @since 7.4.0 */ claims: Record<string, unknown>;}Fuente de verdad
Sección titulada “Fuente de verdad”Esta página se genera a partir del plugin src/definitions.ts. Vuelve a ejecutar el sync cuando el API público cambie en upstream.
Continúa desde Getting Started
Sección titulada “Continúa desde Primeros pasos”Si estás usando Primeros pasos para planificar los flujos de autenticación y de cuenta, conéctalo con @capgo/capacitor-social-login para los detalles de implementación en @capgo/capacitor-social-login, @capgo/capacitor-passkey para el detalle de implementación en @capgo/capacitor-passkey, @capgo/capacitor-native-biometric para el detalle de implementación en @capgo/capacitor-native-biometric, Autenticación de dos factores para el detalle de implementación en la autenticación de dos factores, y SSO (Enterprise) para el detalle de implementación en SSO (Enterprise).