Firebase Authentication。
関数
関数 | 説明 |
---|---|
getAuth(app) | デフォルト アプリまたは特定のアプリの Auth サービスを取得します。引数なしで getAuth() を呼び出してデフォルト アプリの Auth サービスにアクセスするか、getAuth(app) として呼び出して特定のアプリに関連付けられた Auth サービスにアクセスできます。 |
クラス
クラス | 説明 |
---|---|
認証 | 指定されたアプリにバインドされた Auth サービス。Auth インスタンスには複数のテナントを含めることができます。 |
AuthClientErrorCode | 認証クライアントのエラーコードとそのデフォルト メッセージ。 |
BaseAuth | Auth API と TenantAwareAuth API の両方の共通の親インターフェース。 |
FirebaseAuthError | Firebase Auth のエラーコードの構造。これは PrefixedFirebaseError を拡張します。 |
MultiFactorInfo | ユーザーが登録した第 2 要素の一般的なプロパティを表すインターフェース。 |
MultiFactorSettings | 多要素に関連するユーザー設定。 |
PhoneMultiFactorInfo | ユーザーが登録した第 2 要素となるスマートフォン固有のインターフェース。 |
プロジェクト構成 | プロジェクト構成を表します。 |
ProjectConfigManager | 現在のプロジェクト構成を管理(取得と更新)します。 |
テナント | テナント構成を表します。マルチテナンシーのサポートには、Google Cloud の Identity Platform(GCIP)が必要です。GCIP の料金や機能などの詳細については、GCIP のドキュメントをご覧ください。Google Cloud Identity Platform プロジェクトでマルチテナンシーを使用するには、Cloud コンソールの UI でそのプロジェクトでテナントを許可する必要があります。テナント構成には、表示名、テナント ID、メール認証構成などの情報が含まれます。OIDC/SAML プロバイダの構成管理では、Tenant の代わりに TenantAwareAuth インスタンスを使用して、テナントで構成された IdP のリストを取得する必要があります。これらのプロバイダを構成する場合、テナントは、親プロジェクトの許可リスト登録済みドメインと認証済みリダイレクト URI を継承することに注意してください。テナントのその他の設定もすべて継承されます。これらは Cloud コンソール UI で管理する必要があります。 |
テナント認識認証 | テナント対応の Auth インターフェース。特定のテナントに対するユーザーの管理、SAML/OIDC プロバイダの構成、パスワードの再設定、メール確認などのメールリンクの生成に使用されます。マルチテナンシーのサポートには、Google Cloud の Identity Platform(GCIP)が必要です。料金や機能など、GCIP の詳細については、GCIP のドキュメントをご覧ください。各テナントには、独自の ID プロバイダ、設定、ユーザーセットが含まれています。TenantAwareAuth を使用すると、特定のテナントのユーザーや対応する OIDC/SAML 構成の管理、特定のテナントにログインしたユーザーの ID トークンの検証、テナントに属するユーザーのメール アクション リンクの生成もできます。特定の tenantId の TenantAwareAuth インスタンスをインスタンス化するには、TenantManager.authForTenant() を呼び出します。 |
TenantManager | テナント関連のオペレーションの管理に役立つテナント マネージャーを定義します。これには以下が含まれます。
|
ユーザー情報 | Google や Facebook などのサードパーティ ID プロバイダのユーザー情報を表します。 |
UserMetadata | ユーザーのメタデータを表します。 |
UserRecord | ユーザーを表します。 |
インターフェース
インターフェース | 説明 |
---|---|
ActionCodeSettings | これは、省略可能な Android と iOS のバンドル ID を使用して、必要な続行/状態 URL を定義するインターフェースです。 |
AllowByDefault | デフォルトですべてのリージョンを許可し、禁止リージョンを禁止リストに追加するポリシーを定義します。 |
AllowByDefaultWrap | AllowByDefault インターフェースの相互排他的な SMS リージョン構成 |
許可リストのみ | 明示的にリージョンを許可リストに追加することで、そのリージョンのみを許可するポリシーを定義します。 |
AllowlistOnlyWrap | AllowlistOnly インターフェースの相互に排他的な SMS リージョン設定 |
AuthProviderConfigFilter | プロバイダ構成を一覧表示するために使用されるフィルタ インターフェース。これは、構成済みの ID プロバイダを BaseAuth.listProviderConfigs() で一覧表示する方法を指定するときに使用されます。 |
BaseAuthProviderConfig | 基本認証プロバイダ構成インターフェース。 |
BaseCreateMultiFactorInfoRequest | ユーザーが登録した CreateRequest の第 2 要素の基本プロパティを表すインターフェース。 |
BaseUpdateMultiFactorInfoRequest | UpdateRequest のユーザーが登録した第 2 要素の一般的なプロパティを表すインターフェース。 |
CreatePhoneMultiFactorInfoRequest | CreateRequest のユーザーが登録した第 2 要素を表すスマートフォンを表すインターフェース。 |
CreateRequest | 作成する新しいユーザー レコードに設定するプロパティを表すインターフェース。 |
CustomStrengthOptionsConfig | パスワード ポリシーに適用する制約 |
DecodeAuthBlockingToken | |
DecodeIdToken | デコードされた Firebase ID トークンを表すインターフェース。BaseAuth.verifyIdToken() メソッドから返されます。Firebase ID トークンは、OpenID Connect 仕様準拠の JSON Web Token(JWT)です。以下の特定のプロパティについて詳しくは、[OpenID Connect 仕様の ID トークン セクション](http://openid.net/specs/openid-connect-core-1_0.html#IDToken)をご覧ください。 |
DeleteUsersResult | BaseAuth.deleteUsers() API の結果を表します。 |
EmailIdentifier | メールアドレスでアカウントを検索するために使用します。BaseAuth.getUsers() をご覧ください。 |
EmailPrivacyConfig | プロジェクトまたはテナントのメール プライバシー構成。 |
EmailSignInProviderConfig | メール ログイン プロバイダの構成。 |
GetUsersResult | BaseAuth.getUsers() API の結果を表します。 |
ListProviderConfigResults | プロバイダの構成を一覧表示するレスポンス インターフェース。これは、BaseAuth.listProviderConfigs() を介してすべての ID プロバイダの構成を一覧表示する場合にのみ使用できます。 |
ListTenantsResult | TenantManager.listTenants() オペレーションから返されるオブジェクトを表すインターフェースです。現在のバッチのテナントのリストと、使用可能な場合は次のページトークンが含まれます。 |
ListUsersResult | BaseAuth.listUsers() オペレーションから返されるオブジェクトを表すインターフェース。現在のバッチと次のページトークン(使用可能な場合)のユーザーのリストが含まれます。 |
MultiFactorConfig | 多要素構成を表すインターフェース。これを使用して、多要素認証が有効か無効かと、サポートされている第 2 要素による本人確認のリストを定義できます。 |
MultiFactorCreateSettings | 作成オペレーションの多要素に関連するユーザー設定。 |
MultiFactorProviderConfig | 多要素認証プロバイダの設定を表すインターフェース。このインターフェースは、SMS 以外の 2 段階認証プロセスプロバイダに使用されます。現在、TOTP のみがサポートされています。 |
MultiFactorUpdateSettings | 更新オペレーションのための多要素に関連するユーザー設定。 |
OAuthResponseType | OAuth 認可フローの OIDC プロバイダのレスポンス オブジェクトを表すインターフェース。次のいずれかの設定が必要です。
|
OIDCAuthProviderConfig | [OIDC](https://openid.net/specs/openid-connect-core-1_0-final.html) Auth プロバイダの構成インターフェース。OIDC プロバイダは BaseAuth.createProviderConfig() を使用して作成できます。 |
OIDCUpdateAuthProviderRequest | OIDC 認証プロバイダを更新するためのリクエスト インターフェース。これは、BaseAuth.updateProviderConfig() を介して OIDC プロバイダの構成を更新するときに使用されます。 |
PasswordPolicyConfig | プロジェクトまたはテナントのパスワード ポリシー構成 |
PhoneIdentifier | 電話番号でアカウントを検索するために使用します。BaseAuth.getUsers() をご覧ください。 |
ProviderIdentifier | 連携プロバイダによるアカウント検索に使用されます。BaseAuth.getUsers() をご覧ください。 |
recaptchaConfig | reCAPTCHA 構成を更新するためのリクエスト インターフェース。reCAPTCHA Enterprise の統合を有効にすると、reCAPTCHA Enterprise の利用規約に同意したことになります。 |
reCAPTCHA キー | reCAPTCHA キーの構成。 |
recaptchaManagedRule | reCAPTCHA アクション ルールの構成。 |
SAMLAuthProviderConfig | [SAML](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html) 認証プロバイダ構成インターフェース。SAML プロバイダは、BaseAuth.createProviderConfig() を使用して作成できます。 |
SAMLUpdateAuthProviderRequest | SAML 認証プロバイダを更新するためのリクエスト インターフェース。これは、BaseAuth.updateProviderConfig() を使用して SAML プロバイダの構成を更新するときに使用されます。 |
SessionCookieOptions | BaseAuth.createSessionCookie() メソッドに必要なセッション Cookie オプションを表すインターフェース。 |
TotpMultiFactorProviderConfig | TOTP の 2 段階認証プロセスの構成設定を表すインターフェース。 |
UidIdentifier | uid でアカウントを検索するために使用します。BaseAuth.getUsers() をご覧ください。 |
UpdatePhoneMultiFactorInfoRequest | UpdateRequest のユーザーが登録した電話の第 2 要素を表すインターフェース。 |
UpdateProjectConfigRequest | 指定されたプロジェクト構成で更新するプロパティを表すインターフェースです。 |
UpdateRequest | 指定されたユーザーについて更新するプロパティを表すインターフェース。 |
UpdateTenantRequest | 指定されたテナントで更新するプロパティを表すインターフェース。 |
UserImportOptions | BaseAuth.importUsers() メソッドに必要なユーザー インポート オプションを表すインターフェース。パスワードのハッシュ アルゴリズムの情報を提供するために使われます。 |
UserImportRecord | BaseAuth.importUsers() メソッドを使用して Firebase Auth にインポートするユーザーを表すインターフェース。 |
UserImportResult | ユーザーを Firebase Auth に一括インポートするための BaseAuth.importUsers() メソッドからのレスポンスを表すインターフェース。 |
UserMetadataRequest | ユーザーのインポート時に含めるユーザー メタデータ。 |
UserProvider | Firebase ユーザーに関連付けることができるユーザー ID プロバイダを表します。 |
UserProviderRequest | ユーザーのインポート時に含めるユーザー プロバイダ データ。 |
型エイリアス
タイプ エイリアス | 説明 |
---|---|
AuthFactorType | 第 2 要素のタイプを識別する ID を指定します。 |
AuthProviderConfig | 認証プロバイダの構成タイプ。BaseAuth.createProviderConfig()。 |
CreateMultiFactorInfoRequest | CreateRequest のユーザーが登録した第 2 要素のプロパティを表す型。 |
CreateTenantRequest | 新しいテナントに設定するプロパティを表すインターフェース。 |
HashAlgorithmType | |
MultiFactorConfigState | 多要素構成の状態を識別します。 |
PasswordPolicyEnforcementState | パスワード ポリシーの適用状態。 |
recaptchaAction | reCAPTCHA で保護されたリクエストに対して実行するアクション。- 「BLOCK」: reCAPTCHA で保護されたリクエストはブロックされます。 |
recaptchaKeyClientType | キーのプラットフォーム タイプ。 |
RecaptchaProviderEnforcementState | reCAPTCHA による保護の適用状態。- 「OFF」: 適用されません。- 'AUDIT': 評価を作成しますが、結果を強制適用しません。- 'ENFORCE': 評価を作成して結果を適用します。 |
SmsRegionConfig | SMS リージョン構成を更新するためのリクエスト インターフェース。ユーザーが確認 SMS を送信できる地域を設定します。これは、送信先の電話番号の通話コードに基づいて決まります。 |
UpdateAuthProviderRequest | |
UpdateMultiFactorInfoRequest | UpdateRequest のユーザーが登録した第 2 要素のプロパティを表す型。 |
UserIdentifier | 検索するユーザーを識別します。 |
getAuth(アプリ)
デフォルト アプリまたは特定のアプリの Auth サービスを取得します。
getAuth()
を引数なしで呼び出すと、デフォルト アプリの Auth サービスにアクセスできます。また、getAuth(app)
として呼び出すと、特定のアプリに関連付けられた Auth サービスにアクセスできます。
署名:
export declare function getAuth(app?: App): Auth;
パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
app | アプリ |
戻り値:
例 1
// Get the Auth service for the default app
const defaultAuth = getAuth();
例 2
// Get the Auth service for a given app
const otherAuth = getAuth(otherApp);
AuthFactorType
第 2 要素のタイプを識別する ID を指定します。
署名:
export type AuthFactorType = 'phone';
AuthProviderConfig
認証プロバイダの構成タイプ。BaseAuth.createProviderConfig()。
署名:
export type AuthProviderConfig = SAMLAuthProviderConfig | OIDCAuthProviderConfig;
CreateMultiFactorInfoRequest
CreateRequest
のユーザーが登録した第 2 要素のプロパティを表す型。
署名:
export type CreateMultiFactorInfoRequest = CreatePhoneMultiFactorInfoRequest;
CreateTenantRequest
新しいテナントに設定するプロパティを表すインターフェース。
署名:
export type CreateTenantRequest = UpdateTenantRequest;
HashAlgorithmType
署名:
export type HashAlgorithmType = 'SCRYPT' | 'STANDARD_SCRYPT' | 'HMAC_SHA512' | 'HMAC_SHA256' | 'HMAC_SHA1' | 'HMAC_MD5' | 'MD5' | 'PBKDF_SHA1' | 'BCRYPT' | 'PBKDF2_SHA256' | 'SHA512' | 'SHA256' | 'SHA1';
MultiFactorConfigState
多要素構成の状態を識別します。
署名:
export type MultiFactorConfigState = 'ENABLED' | 'DISABLED';
PasswordPolicyEnforcementState
パスワード ポリシーの適用状態。
署名:
export type PasswordPolicyEnforcementState = 'ENFORCE' | 'OFF';
RecaptchaAction
reCAPTCHA で保護されたリクエストに対して実行するアクション。- 「BLOCK」: reCAPTCHA で保護されたリクエストはブロックされます。
署名:
export type RecaptchaAction = 'BLOCK';
recaptchaKeyClientType
キーのプラットフォーム タイプ。
署名:
export type RecaptchaKeyClientType = 'WEB' | 'IOS' | 'ANDROID';
RecaptchaProviderEnforcementState
reCAPTCHA による保護の適用状態。- 「OFF」: 適用されません。- 'AUDIT': 評価を作成しますが、結果を強制適用しません。- 'ENFORCE': 評価を作成して結果を適用します。
署名:
export type RecaptchaProviderEnforcementState = 'OFF' | 'AUDIT' | 'ENFORCE';
SMS リージョン構成
SMS リージョン構成を更新するためのリクエスト インターフェース。ユーザーが確認 SMS を送信できる地域を設定します。これは、送信先の電話番号の通話コードに基づいて決まります。
署名:
export type SmsRegionConfig = AllowByDefaultWrap | AllowlistOnlyWrap;
UpdateAuthProviderRequest
署名:
export type UpdateAuthProviderRequest = SAMLUpdateAuthProviderRequest | OIDCUpdateAuthProviderRequest;
UpdateMultiFactorInfoRequest
UpdateRequest
のユーザーが登録した第 2 要素のプロパティを表す型。
署名:
export type UpdateMultiFactorInfoRequest = UpdatePhoneMultiFactorInfoRequest;
UserIdentifier
検索するユーザーを識別します。
署名:
export type UserIdentifier = UidIdentifier | EmailIdentifier | PhoneIdentifier | ProviderIdentifier;