firebase-admin.auth package

Firebase Authentication。

関数

関数 説明
getAuth(app) デフォルト アプリまたは特定のアプリの Auth サービスを取得します。デフォルト アプリの Auth サービスにアクセスする場合は、引数なしで getAuth() を呼び出します。特定のアプリに関連付けられた Auth サービスにアクセスするには、getAuth(app) として呼び出すことができます。

クラス

クラス 説明
認証 指定されたアプリにバインドされている認証サービス。Auth インスタンスには複数のテナントを設定できます。
AuthClientErrorCode 認証クライアントのエラーコードとデフォルトのメッセージ。
BaseAuth Auth API と TenantAwareAuth API の両方の共通の親インターフェース。
FirebaseAuthError Firebase Auth のエラーコードの構造。これは PrefixedFirebaseError を拡張します。
MultiFactorInfo ユーザー登録の第 2 要素の一般的なプロパティを表すインターフェース。
MultiFactorSettings 多要素関連のユーザー設定。
PhoneMultiFactorInfo スマートフォン固有のユーザー登録の 2 つ目の要素を表すインターフェース。
ProjectConfig プロジェクト構成を表します。
ProjectConfigManager 現在のプロジェクト構成を管理（取得および更新）します。
テナント テナントの構成を表します。マルチテナンシーのサポートには Google Cloud の Identity Platform（GCIP）が必要です。料金や機能など、GCIP の詳細については、GCIP のドキュメントをご覧ください。Google Cloud Identity Platform プロジェクトでマルチテナンシーを使用するには、Cloud コンソール UI を介してそのプロジェクトでテナントを許可する必要があります。テナント構成では、表示名、テナント ID、メール認証構成などの情報が提供されます。OIDC/SAML プロバイダの構成管理では、テナントで構成された IdP のリストを取得するために、Tenant ではなく TenantAwareAuth インスタンスを使用する必要があります。これらのプロバイダを構成する場合、テナントは親プロジェクトの許可リストのドメインと認証済みリダイレクト URI を継承することに注意してください。テナントのその他の設定も継承されます。これらは Cloud コンソール UI から管理する必要があります。
TenantAwareAuth ユーザーの管理、SAML/OIDC プロバイダの構成、特定のテナントのパスワードの再設定用メールリンクの生成、メール確認などに使用される、テナント対応の Auth インターフェース。マルチテナンシーのサポートには Google Cloud の Identity Platform（GCIP）が必要です。料金や機能など、GCIP の詳細については、GCIP のドキュメントをご覧ください。各テナントには、独自の ID プロバイダ、設定、ユーザーセットが含まれています。TenantAwareAuth を使用すると、特定のテナントのユーザーと対応する OIDC/SAML 構成のユーザーの管理、特定のテナントにログインしたユーザーの ID トークンの検証、テナントに属するユーザーのメール アクション リンクの生成も行うことができます。特定の tenantId の TenantAwareAuth インスタンスをインスタンス化するには、TenantManager.authForTenant() を呼び出します。
TenantManager テナント関連のオペレーションの管理に役立つテナント マネージャーを定義します。これには次のものが含まれます。
  • 基盤となるプロジェクトのテナントを作成、更新、一覧表示、取得、削除する権限。
  • 指定されたテナントのコンテキストで Auth 関連のオペレーション（ユーザー管理、プロバイダ構成管理、トークン検証、メールリンク生成など）を実行するための TenantAwareAuth インスタンスを取得します。
UserInfo Google や Facebook などのサードパーティの ID プロバイダからのユーザーの情報を表します。
UserMetadata ユーザーのメタデータを表します。
UserRecord ユーザーを表します。

インターフェース

インターフェース 説明
ActionCodeSettings これは、必須の続行/状態 URL を定義し、オプションの Android と iOS のバンドル ID を定義するインターフェースです。
AllowByDefault すべてのリージョンをデフォルトで許可し、許可されていないリージョンを禁止リストに追加するポリシーを定義します。
AllowByDefaultWrap AllowByDefault インターフェースの相互排他的な SMS リージョン構成
許可リストのみ 許可リストにリージョンを明示的に追加して、そのリージョンのみを許可するポリシーを定義します。
AllowlistOnlyWrap AllowlistOnly インターフェースの相互に排他的な SMS リージョン構成
AuthProviderConfigFilter プロバイダ構成を一覧表示するために使用されるフィルタ インターフェース。これは、構成済みの ID プロバイダを BaseAuth.listProviderConfigs() で一覧表示する方法を指定するときに使用されます。
BaseAuthProviderConfig 基本認証プロバイダ構成インターフェース。
BaseCreateMultiFactorInfoRequest CreateRequest のユーザー登録の第 2 要素の基本プロパティを表すインターフェース。
BaseUpdateMultiFactorInfoRequest UpdateRequest に対してユーザーが登録した第 2 要素の一般的なプロパティを表すインターフェース。
CreatePhoneMultiFactorInfoRequest CreateRequest の、ユーザーにより登録されたスマートフォン固有の第 2 要素を表すインターフェース。
CreateRequest 作成する新しいユーザー レコードに設定するプロパティを表すインターフェース。
CustomStrengthOptionsConfig パスワード ポリシーに適用される制約
DecodedAuthBlockingToken
DecodedIdToken BaseAuth.verifyIdToken() メソッドから返される、デコードされた Firebase ID トークンを表すインターフェース。Firebase ID トークンは、OpenID Connect 仕様に準拠した JSON ウェブトークン（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 プロバイダ構成を一覧表示するためのレスポンス インターフェース。これは、すべての ID プロバイダをリストする場合にのみ使用できます。BaseAuth.listProviderConfigs() を使用して設定。
ListTenantsResult TenantManager.listTenants() オペレーションから返されるオブジェクトを表すインターフェース。現在のバッチのテナントのリストと、使用可能な場合は次のページトークンが含まれます。
ListUsersResult BaseAuth.listUsers() オペレーションから返されるオブジェクトを表すインターフェース。現在のバッチのユーザーのリストと次のページトークン（使用可能な場合）が含まれます。
MultiFactorConfig 多要素構成を表すインターフェース。これを使用して、多要素認証の有効 / 無効と、サポートされる第 2 要素のチャレンジのリストを定義できます。
MultiFactorCreateSettings 作成オペレーションのための多要素関連ユーザー設定。
MultiFactorProviderConfig 多要素認証プロバイダ構成を表すインターフェース。このインターフェースは SMS 以外の第 2 要素認証プロバイダに使用されます。現在サポートされているのは TOTP のみです。
MultiFactorUpdateSettings 更新オペレーションのための多要素関連ユーザー設定。
OAuthResponseType OAuth 認可フローの OIDC プロバイダのレスポンス オブジェクトを表すインターフェース。次のいずれかの設定が必要です。
  • コードフローの code を true に設定します。
  • ID トークンのフローでは、idToken を true に設定します。
OIDCAuthProviderConfig [OIDC](https://openid.net/specs/openid-connect-core-1_0-final.html) Auth プロバイダ構成インターフェース。OIDC プロバイダは BaseAuth.createProviderConfig() を使用して作成できます。
OIDCUpdateAuthProviderRequest OIDC Auth プロバイダを更新するためのリクエスト インターフェース。これは、BaseAuth.updateProviderConfig() を介して OIDC プロバイダの構成を更新するときに使用されます。
PasswordPolicyConfig プロジェクトまたはテナントのパスワード ポリシー構成
PhoneIdentifier 電話番号でアカウントを検索するために使用します。BaseAuth.getUsers() をご覧ください。
ProviderIdentifier 連携プロバイダでアカウントを検索するために使用されます。BaseAuth.getUsers() をご覧ください。
RecaptchaConfig reCAPTCHA 構成を更新するためのリクエスト インターフェース。reCAPTCHA Enterprise の統合を有効にすると、reCAPTCHA Enterprise の利用規約に同意したことになります。
RecaptchaKey reCAPTCHA キーの構成。
RecaptchaManagedRule reCAPTCHA アクション ルールの構成。
SAMLAuthProviderConfig [SAML](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html) Auth プロバイダ構成インターフェース。SAML プロバイダは BaseAuth.createProviderConfig() を使用して作成できます。
SAMLUpdateAuthProviderRequest SAML 認証プロバイダを更新するためのリクエスト インターフェース。これは、BaseAuth.updateProviderConfig() によって SAML プロバイダの構成を更新するときに使用されます。
SessionCookieOptions（セッション Cookie オプション） 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 要素のタイプを指定します。
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;

パラメータ

パラメータ 型 説明
アプリ アプリ

戻り値:

認証

例 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 要素のタイプを指定します。

署名:

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';

SmsRegionConfig

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;