Getting Started

설치 단계와 이 플러그인의 전체 마크다운 가이드를 포함한 설정 명령어를 복사하세요.

        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.

설치

Capgo 스킬을 AI 도구에 추가하려면 다음 명령어를 사용하세요:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

다음과 같은 명령어를 사용하세요:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-firebase-authentication` plugin in my project.

만약 Manual Setup을 선호한다면, 플러그인을 설치하기 위해 다음 명령어를 실행하고 아래의 플랫폼별 지침을 따르세요.

bun add @capgo/capacitor-firebase-authentication
bunx cap sync

Import

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

API 개요

`applyActionCode`

Applies a verification code sent to the user by email.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.applyActionCode({} as ApplyActionCodeOptions);

`confirmPasswordReset`

비밀번호를 재설정합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.confirmPasswordReset({} as ConfirmPasswordResetOptions);

`confirmVerificationCode`

휴대폰 인증 코드를 확인합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.confirmVerificationCode({} as ConfirmVerificationCodeOptions);

`createUserWithEmailAndPassword`

이메일과 비밀번호를 사용하여 새로운 사용자 계정을 생성합니다. 새로운 계정이 생성되면 사용자는 자동으로 로그인됩니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.createUserWithEmailAndPassword({} as CreateUserWithEmailAndPasswordOptions);

`deleteUser`

__CAPGO_KEEP_1__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.deleteUser();

`fetchSignInMethodsForEmail`

__CAPGO_KEEP_3__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.fetchSignInMethodsForEmail({} as FetchSignInMethodsForEmailOptions);

`getCurrentUser`

__CAPGO_KEEP_4__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.getCurrentUser();

`getPendingAuthResult`

__CAPGO_KEEP_5__ SignInResult __CAPGO_KEEP_6__

Only available for Android.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.getPendingAuthResult();

`getIdToken`

현재 로그인한 사용자의 Firebase Auth ID 토큰을 가져옵니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.getIdToken();

`getIdTokenResult`

JSON Web Token (JWT)으로 사용자를 식별하기 위해 사용되는 사용자 토큰을 반환합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.getIdTokenResult();

`getRedirectResult`

redirect-based sign-in flow에서 사용자에게 반환되는 SignInResult 로그인에 실패한 경우 오류로 실패합니다. redirect operation이 호출되지 않은 경우 빈 값을 반환합니다.

__CAPGO_KEEP_0__ SignInResult __CAPGO_KEEP_0__

__CAPGO_KEEP_1__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.getRedirectResult();

`getTenantId`

__CAPGO_KEEP_4__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.getTenantId();

`isSignInWithEmailLink`

__CAPGO_KEEP_7__ signInWithEmailLink.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.isSignInWithEmailLink({} as IsSignInWithEmailLinkOptions);

`linkWithApple`

__CAPGO_KEEP_10__

__CAPGO_KEEP_11__ skipNativeAuth __CAPGO_KEEP_0__는 영향을 미치지 않습니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithApple();

`linkWithEmailAndPassword`

이메일 인증 제공자와 사용자 계정을 연결합니다.

native layer에서 로그인해야 합니다. __CAPGO_KEEP_0__는 영향을 미치지 않습니다. skipNativeAuth __CAPGO_KEEP_1__을 클립보드에 복사

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithEmailAndPassword({} as LinkWithEmailAndPasswordOptions);

`linkWithEmailLink`

native layer에서 로그인해야 합니다. __CAPGO_KEEP_0__는 영향을 미치지 않습니다.

__CAPGO_KEEP_1__을 클립보드에 복사 skipNativeAuth __CAPGO_KEEP_0__는 영향을 미치지 않습니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithEmailLink({} as LinkWithEmailLinkOptions);

`linkWithFacebook`

Facebook 인증 제공자와 사용자 계정을 연결합니다.

native layer에서 로그인되어야 합니다. skipNativeAuth 설정 옵션은 이곳에서 효과가 없습니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithFacebook();

`linkWithGameCenter`

Game Center 인증을 통한 계정 연결

Game Center 인증 제공자와 사용자 계정을 연결합니다. skipNativeAuth native layer에서 로그인되어야 합니다.

설정 옵션은 이곳에서 효과가 없습니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithGameCenter();

`linkWithGithub`

GitHub 인증 제공자와 사용자 계정을 연결합니다.

native layer에서 로그인한 사용자여야 합니다. skipNativeAuth 이 설정 옵션은 여기에 영향을 미치지 않습니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithGithub();

`linkWithGoogle`

native layer에서 로그인한 사용자여야 합니다.

이 설정 옵션은 여기에 영향을 미치지 않습니다. skipNativeAuth 클립보드에 복사

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithGoogle();

`linkWithMicrosoft`

이 설정 옵션은 여기에 영향을 미치지 않습니다.

클립보드에 복사 skipNativeAuth configuration option이 여기서 효과가 없습니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithMicrosoft();

`linkWithOpenIdConnect`

OpenID Connect 제공자와 사용자 계정을 연결합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithOpenIdConnect({} as LinkWithOpenIdConnectOptions);

`linkWithPhoneNumber`

전화번호 인증 제공자와 사용자 계정을 연결합니다.

native layer에서 로그인한 사용자만 가능합니다. The skipNativeAuth configuration option이 여기서 효과가 없습니다.

native layer에서 로그인한 사용자만 가능합니다. The phoneVerificationCompleted listener to be notified when the verification is completed. Use the phoneVerificationFailed listener를 사용하여 인증이 완료되었을 때 알림을 받으세요. listener를 사용하여 인증이 실패되었을 때 알림을 받으세요. listener를 사용하여 인증이 실패되었을 때 알림을 받으세요. phoneCodeSent __CAPGO_KEEP_0__을 받기 위한 리스너.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithPhoneNumber({} as LinkWithPhoneNumberOptions);

`linkWithPlayGames`

Play Games 인증 제공자와 사용자 계정을 연결합니다.

native layer에서 로그인한 상태여야 합니다. skipNativeAuth 이 설정 옵션은 여기에 영향을 미치지 않습니다.

Android에서만 사용 가능합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithPlayGames();

`linkWithTwitter`

Twitter 인증 제공자와 사용자 계정을 연결합니다.

native layer에서 로그인한 상태여야 합니다. skipNativeAuth 이 설정 옵션은 여기에 영향을 미치지 않습니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithTwitter();

`linkWithYahoo`

__CAPGO_KEEP_2__

__CAPGO_KEEP_3__ __CAPGO_KEEP_4__ __CAPGO_KEEP_5__ skipNativeAuth __CAPGO_KEEP_0__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithYahoo();

`reload`

__CAPGO_KEEP_7__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.reload();

`revokeAccessToken`

__CAPGO_KEEP_10__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.revokeAccessToken({} as RevokeAccessTokenOptions);

`sendEmailVerification`

현재 로그인한 사용자에게 인증 이메일을 보냅니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.sendEmailVerification();

`sendPasswordResetEmail`

비밀번호를 재설정하는 이메일을 보냅니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.sendPasswordResetEmail({} as SendPasswordResetEmailOptions);

`sendSignInLinkToEmail`

사용자에게 이메일 주소와 이메일 링크를 보내고, 이메일을 받은 사용자가 이메일 링크를 사용하여 로그인할 수 있도록 합니다.

로그인에 이메일 링크를 사용하려면 이메일 주소와 이메일 링크를 호출하세요. signInWithEmailLink with

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.sendSignInLinkToEmail({} as SendSignInLinkToEmailOptions);

`setLanguageCode`

code 언어를 사용자에게 설정합니다. 인증 작업을 위해.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.setLanguageCode({} as SetLanguageCodeOptions);

`setPersistence`

현재 저장된 인증 세션의 유형을 설정합니다.

웹에서만 사용 가능합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.setPersistence({} as SetPersistenceOptions);

`setTenantId`

테넌트 ID를 설정합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.setTenantId({} as SetTenantIdOptions);

`signInAnonymously`

무작위로 로그인합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInAnonymously();

`signInWithApple`

Section titled “signInWithApple”

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithApple();

`signInWithCustomToken`

Section titled “signInWithCustomToken”

이 메소드는 Android 및 iOS에서 사용할 수 없습니다. 이 경우 Firebase JS __CAPGO_KEEP_0__의 직접적인 인터페이스를 사용해야 합니다. skipNativeAuth Copy to clipboard signInWithCustomToken interface of the Firebase JS SDK directly.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithCustomToken({} as SignInWithCustomTokenOptions);

`signInWithEmailAndPassword`

Copy to clipboard

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithEmailAndPassword({} as SignInWithEmailAndPasswordOptions);

`signInWithEmailLink`

이메일과 로그인 이메일 링크를 사용하여 로그인합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithEmailLink({} as SignInWithEmailLinkOptions);

`signInWithFacebook`

Facebook 로그인 흐름을 시작합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithFacebook();

`signInWithGameCenter`

Game Center 로그인 흐름을 시작합니다.

iOS에서만 사용 가능합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithGameCenter();

`signInWithGithub`

GitHub 로그인 흐름을 시작합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithGithub();

`signInWithGoogle`

__CAPGO_KEEP_2__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithGoogle();

`signInWithMicrosoft`

__CAPGO_KEEP_2__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithMicrosoft();

`signInWithOpenIdConnect`

__CAPGO_KEEP_2__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithOpenIdConnect({} as SignInWithOpenIdConnectOptions);

`signInWithPhoneNumber`

__CAPGO_KEEP_2__

Use the phoneVerificationCompleted listener to be notified when the verification is completed. Use the phoneVerificationFailed listener to be notified when the verification is failed. Use the phoneCodeSent listener to get the verification id.

Only available for Android and iOS.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithPhoneNumber({} as SignInWithPhoneNumberOptions);

`signInWithPlayGames`

Starts the Play Games sign-in flow.

Only available for Android.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithPlayGames();

`signInWithTwitter`

Starts the Twitter sign-in flow.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithTwitter();

`signInWithYahoo`

__CAPGO_KEEP_2__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithYahoo();

`signOut`

__CAPGO_KEEP_3__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signOut();

`unlink`

__CAPGO_KEEP_4__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.unlink({} as UnlinkOptions);

`updateEmail`

__CAPGO_KEEP_5__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.updateEmail({} as UpdateEmailOptions);

`updatePassword`

현재 로그인한 사용자의 비밀번호를 업데이트합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.updatePassword({} as UpdatePasswordOptions);

`updateProfile`

사용자의 프로필 데이터를 업데이트합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.updateProfile({} as UpdateProfileOptions);

`useAppLanguage`

Sets the user-facing language code to be the default app language.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.useAppLanguage();

`useEmulator`

앱을 인증 에뮬레이터와 통신하도록 구성합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.useEmulator({} as UseEmulatorOptions);

`verifyBeforeUpdateEmail`

__CAPGO_KEEP_2__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.verifyBeforeUpdateEmail({} as VerifyBeforeUpdateEmailOptions);

`checkAppTrackingTransparencyPermission`

__CAPGO_KEEP_3__

__CAPGO_KEEP_4__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.checkAppTrackingTransparencyPermission();

`requestAppTrackingTransparencyPermission`

__CAPGO_KEEP_6__

__CAPGO_KEEP_7__ __CAPGO_KEEP_8__ Apple의 문서.

iOS에서만 사용 가능합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.requestAppTrackingTransparencyPermission();

타입 참조

`ApplyActionCodeOptions`

export interface ApplyActionCodeOptions {
  /**
   * A verification code sent to the user.
   *
   * @since 0.2.2
   */
  oobCode: string;
}

`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`

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`

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`

export interface CreateUserWithEmailAndPasswordOptions {
  /**
   * @since 0.2.2
   */
  email: string;
  /**
   * @since 0.2.2
   */
  password: string;
}

`FetchSignInMethodsForEmailOptions`

export interface FetchSignInMethodsForEmailOptions {
  /**
   * The user's email address.
   *
   * @since 6.0.0
   */
  email: string;
}

`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`

export interface GetCurrentUserResult {
  /**
   * The currently signed-in user, or null if there isn't any.
   *
   * @since 0.1.0
   */
  user: User | null;
}

`GetIdTokenOptions`

export interface GetIdTokenOptions {
  /**
   * Force refresh regardless of token expiration.
   *
   * @since 0.1.0
   */
  forceRefresh: boolean;
}

`GetIdTokenResult`

export interface GetIdTokenResult {
  /**
   * The Firebase Auth ID token JWT string.
   *
   * @since 0.1.0
   */
  token: string;
}

`GetIdTokenResultOptions`

export interface GetIdTokenResultOptions {
  /**
   * Force refresh regardless of token expiration.
   *
   * @since 7.4.0
   */
  forceRefresh: boolean;
}

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

실질적인 원천

이 페이지는 플러그인의 src/definitions.ts API이 업스트림에서 변경될 때 다시 싱크를 실행하세요.

Getting Started에서 계속하기

__CAPGO_KEEP_0__이 업스트림에서 변경될 때 다시 싱크를 실행하세요. 만약 __CAPGO_KEEP_0__이 업스트림에서 변경될 때 다시 싱크를 실행하세요.가 필요하다면 __CAPGO_KEEP_0__이 업스트림에서 변경될 때 다시 싱크를 실행하세요.를 다시 싱크하세요. 시작하기 인증 및 계정 흐름을 계획하고 연결하려면 @capgo/capacitor-social-login @capgo/capacitor-social-login의 implementation detail에 대해 @capgo/capacitor-passkey @capgo/capacitor-passkey의 implementation detail에 대해 @capgo/capacitor-native-biometric @capgo/capacitor-native-biometric의 implementation detail에 대해 두 단계 인증 두 단계 인증의 implementation detail에 대해, 그리고 SSO (기업) SSO (기업)의 implementation detail에 대해.