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.

インストール

AI アシストセットアップを使用してプラグインをインストールできます。AI ツールに Capgo スキルを追加するには、以下のコマンドを実行してください。

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 { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

APIの概要

`applyActionCode`

ユーザーにメールで送信された確認用codeを適用します。

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`

ユーザーを削除し、サインアウトします。

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

await FirebaseAuthentication.deleteUser();

`fetchSignInMethodsForEmail`

クリップボードにコピー

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

await FirebaseAuthentication.fetchSignInMethodsForEmail({} as FetchSignInMethodsForEmailOptions);

`getCurrentUser`

Webサインインフローを開始した場合にOSがアプリをバックグラウンドでクリーンアップした場合に返される

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

await FirebaseAuthentication.getCurrentUser();

`getPendingAuthResult`

if your app launched a web sign-in flow and the OS cleans up the app while in the background. SignInResult if your app launched a web sign-in flow and the OS cleans up the app while in the background.

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`

ユーザーをFirebaseサービスに識別するために使用されるJSON Webトークン(JWT)を返します。

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

await FirebaseAuthentication.getIdTokenResult();

`getRedirectResult`

リダイレクトベースのサインインフローから SignInResult サインインが失敗した場合、エラーで失敗します。リダイレクトオペレーションが呼び出されていなかった場合、空のオブジェクトを返します。

クリップボードにコピー SignInResult __CAPGO_KEEP_0__はユーザーが存在しない場合です。

Only available for Web.

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

await FirebaseAuthentication.getRedirectResult();

`getTenantId`

テナントIDを取得します。

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

await FirebaseAuthentication.getTenantId();

`isSignInWithEmailLink`

メールアドレスでサインインするリンクが来る場合にチェックします。 signInWithEmailLink.

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

await FirebaseAuthentication.isSignInWithEmailLink({} as IsSignInWithEmailLinkOptions);

`linkWithApple`

Apple認証プロバイダとユーザーアカウントをリンクします。

ユーザーはネイティブレイヤーでログインしている必要があります。 skipNativeAuth 設定オプションはここでは効果を発揮しません。

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

await FirebaseAuthentication.linkWithApple();

`linkWithEmailAndPassword`

ユーザーアカウントをEmail認証プロバイダーとリンクします。

ユーザーはネイティブ層でログインしている必要があります。設定オプションはここでは効果を発揮しません。 skipNativeAuth クリップボードにコピー

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

await FirebaseAuthentication.linkWithEmailAndPassword({} as LinkWithEmailAndPasswordOptions);

`linkWithEmailLink`

ユーザーはネイティブ層でログインしている必要があります。設定オプションはここでは効果を発揮しません。

クリップボードにコピー skipNativeAuth 設定オプションはここでは効果を発揮しません。

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

await FirebaseAuthentication.linkWithEmailLink({} as LinkWithEmailLinkOptions);

`linkWithFacebook`

Facebook認証プロバイダーとユーザーアカウントをリンクします。

nativeレイヤーでログインしている必要があります。 skipNativeAuth この設定オプションはここでは効果がありません。

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

await FirebaseAuthentication.linkWithFacebook();

`linkWithGameCenter`

ゲームセンター認証プロバイダーとユーザーアカウントをリンクします。

nativeレイヤーでログインしている必要があります。 skipNativeAuth この設定オプションはここでは効果がありません。

iOSのみ

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

await FirebaseAuthentication.linkWithGameCenter();

`linkWithGithub`

GitHubの認証プロバイダーとユーザーアカウントをリンクします。

nativeレイヤーでログインしている必要があります。設定オプションはここでは効果がありません。 skipNativeAuth クリップボードにコピー

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

await FirebaseAuthentication.linkWithGithub();

`linkWithGoogle`

nativeレイヤーでログインしている必要があります。設定オプションはここでは効果がありません。

クリップボードにコピー skipNativeAuth 「linkWithMicrosoft」セクション

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

await FirebaseAuthentication.linkWithGoogle();

`linkWithMicrosoft`

クリップボードにコピー

「linkWith__CAPGO_KEEP_0__」セクション skipNativeAuth 設定オプションはここでは効果を発揮しません。

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`

Phone Number 認証プロバイダーとユーザーアカウントをリンクします。

ユーザーはネイティブ層でログインしている必要があります。 skipNativeAuth 設定オプションはここでは効果を発揮しません。

を使用して、検証が完了したときに通知を受け取ることができます。 phoneVerificationCompleted を使用して、検証が失敗したときに通知を受け取ることができます。 phoneVerificationFailed を使用して、検証が失敗したときに通知を受け取ることができます。 phoneCodeSent リスナーを取得するための検証IDを取得します。

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

await FirebaseAuthentication.linkWithPhoneNumber({} as LinkWithPhoneNumberOptions);

`linkWithPlayGames`

Play Gamesの認証プロバイダとユーザーアカウントをリンクします。

ユーザーはネイティブレイヤーでログインしている必要があります。 skipNativeAuth この設定オプションはここでは効果がありません。

Androidのみ

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

await FirebaseAuthentication.linkWithPlayGames();

`linkWithTwitter`

Twitterの認証プロバイダとユーザーアカウントをリンクします。

ユーザーはネイティブレイヤーでログインしている必要があります。 skipNativeAuth この設定オプションはここでは効果がありません。

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

await FirebaseAuthentication.linkWithTwitter();

`linkWithYahoo`

Yahoo 認証プロバイダとユーザーアカウントをリンクします。

ユーザーはネイティブ層でログインしている必要があります。この設定オプションはここでは効果がありません。 skipNativeAuth クリップボードにコピー

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

await FirebaseAuthentication.linkWithYahoo();

`reload`

クリップボードにコピー

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

await FirebaseAuthentication.reload();

`revokeAccessToken`

クリップボードにコピー

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 メールに送信されたメールアドレスとメールリンクを指定してください。

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`

現在の認証セッションの保存方法を設定します。

Webのみで利用可能です。

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`

Appleサインインフローを開始します。

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

await FirebaseAuthentication.signInWithApple();

`signInWithCustomToken`

カスタムトークンサインインフローを開始します。

このメソッドは、AndroidおよびiOSで同時に使用できません。この場合、Firebase JS __CAPGO_KEEP_0__の直接インターフェイスを使用する必要があります。 skipNativeAuth クリップボードにコピー signInWithCustomToken interface of the Firebase JS SDK directly.

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

await FirebaseAuthentication.signInWithCustomToken({} as SignInWithCustomTokenOptions);

`signInWithEmailAndPassword`

メールアドレスとパスワードを使用したサインインフローを開始します。

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`

Googleサインインフローを開始します。

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

await FirebaseAuthentication.signInWithGoogle();

`signInWithMicrosoft`

Microsoftサインインフローを開始します。

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

await FirebaseAuthentication.signInWithMicrosoft();

`signInWithOpenIdConnect`

OpenID Connectサインインフローを開始します。

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

await FirebaseAuthentication.signInWithOpenIdConnect({} as SignInWithOpenIdConnectOptions);

`signInWithPhoneNumber`

電話番号を使用したサインインフローを開始します。

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`

コピー

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

await FirebaseAuthentication.signInWithYahoo();

`signOut`

コピー

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

await FirebaseAuthentication.signOut();

`unlink`

現在のユーザーアカウントのメールアドレスを更新します。

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

await FirebaseAuthentication.unlink({} as UnlinkOptions);

`updateEmail`

サインアウトフローを開始します。

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`

現在ログイン中のユーザーのメールアドレスを更新する前に、新しいメールアドレスを検証します。

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

await FirebaseAuthentication.verifyBeforeUpdateEmail({} as VerifyBeforeUpdateEmailOptions);

`checkAppTrackingTransparencyPermission`

現在のアプリのトラッキング透明性の状態を確認します。

iOSのみで利用可能です。

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

await FirebaseAuthentication.checkAppTrackingTransparencyPermission();

`requestAppTrackingTransparencyPermission`

アプリのトラッキング透明性の許可を求めるシステムダイアログを開きます。

注意: ユーザーは、デバイスの設定でトラッキングの要求を無効にしている可能性があります。 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.tsAPIがアップストリームで変更された場合に再度同期を実行してください。

「Getting Started」から続けて

CloudflareやCapacitor、GitHub、Capgo、code、API、SDK、CLI、npm、bunを使用している場合 スタート 認証とアカウントフローの計画に役立つものとして @capgo/capacitor-social-login @capgo/capacitor-social-loginの実装詳細について @capgo/capacitor-passkey @capgo/capacitor-passkeyの実装詳細について @capgo/capacitor-native-biometric @capgo/capacitor-native-biometricの実装詳細について 2要素認証 2要素認証の実装詳細について、そして SSO (Enterprise) SSO (Enterprise)の実装詳細について。