Auth
API とTenantAwareAuth
API の両方に共通の親インターフェイス。
サイン:
export declare abstract class BaseAuth
メソッド
方法 | 修飾子 | 説明 |
---|---|---|
createCustomToken(uid、developerClaims) | 新しい Firebase カスタム トークン (JWT) を作成します。これをクライアント デバイスに送り返し、クライアント SDK のsignInWithCustomToken() メソッドでサインインするために使用できます。 (テナント対応インスタンスもトークンにテナント ID を埋め込みます。)コードサンプルと詳細なドキュメントについては、 「カスタム トークンの作成」を参照してください。 | |
createProviderConfig(config) | 新しいプロバイダー構成の作成時に、新しく作成されたAuthProviderConfig で解決される Promise を返します。 SAML および OIDC プロバイダーのサポートには、Google Cloud の ID プラットフォーム (GCIP) が必要です。価格や機能など、GCIP の詳細については、 GCIP のドキュメントを参照してください。 。 | |
createSessionCookie(idToken, sessionCookieOptions) | 指定されたオプションを使用して新しい Firebase セッション Cookie を作成します。作成された JWT 文字列は、カスタム Cookie ポリシーを使用してサーバー側のセッション Cookie として設定し、セッション管理に使用できます。セッション Cookie JWT には、提供された ID トークンと同じペイロード クレームが含まれます。コードサンプルと詳細なドキュメントについては、「セッション Cookie の管理」を参照してください。 | |
createUser(プロパティ) | 新しいユーザーを作成します。コードサンプルと詳細なドキュメントについては、「ユーザーの作成」を参照してください。 | |
deleteProviderConfig(プロバイダーID) | 渡されたプロバイダー ID に対応するプロバイダー構成を削除します。指定された ID が存在しない場合は、 auth/configuration-not-found エラーがスローされます。 SAML および OIDC プロバイダーのサポートには、Google Cloud の ID プラットフォーム (GCIP) が必要です。価格や機能など、GCIP の詳細については、 GCIP のドキュメントを参照してください。 。 | |
ユーザーの削除(uid) | 既存のユーザーを削除します。コードサンプルと詳細なドキュメントについては、 「ユーザーの削除」を参照してください。 | |
deleteUsers(uid) | 指定された uid で指定されたユーザーを削除します。存在しないユーザーを削除してもエラーは生成されません (つまり、このメソッドは冪等です)。存在しないユーザーは正常に削除されたとみなされ、そのためDeleteUsersResult.successCount 値にカウントされます。最大 1000 個の識別子のみを指定できます。 1000 を超える識別子が指定された場合、このメソッドは FirebaseAuthError をスローします。現在、この API はサーバーで 1 QPS にレート制限されています。これを超えると、クォータ超過エラーが発生する可能性があります。したがって、1000 人を超えるユーザーを削除する場合は、この制限を超えないよう遅延を追加する必要がある場合があります。 | |
generateEmailVerificationLink(電子メール, actionCodeSettings) | 指定された電子メールのユーザーの所有権を確認するために、帯域外電子メール アクション リンクを生成します。このメソッドの引数として提供されるActionCodeSettingsオブジェクトは、ディープ リンクなどで渡される追加の状態情報とともに、リンクがモバイル アプリまたはブラウザで処理されるかどうかを定義します。 | |
generatePasswordResetLink(電子メール, actionCodeSettings) | ユーザーのパスワードをリセットするための帯域外電子メール アクション リンクを生成します。指定した電子メール アドレスを持つユーザーに対してリンクが生成されます。オプションのActionCodeSettingsオブジェクトは、リンクをモバイル アプリまたはブラウザーで処理するかどうか、およびディープ リンクで渡される追加の状態情報などを定義します。 | |
generateSignInWithEmailLink(電子メール, actionCodeSettings) | 指定された電子メールのユーザーの所有権を確認するために、帯域外電子メール アクション リンクを生成します。このメソッドの引数として提供されるActionCodeSettingsオブジェクトは、ディープ リンクなどで渡される追加の状態情報とともに、リンクがモバイル アプリまたはブラウザで処理されるかどうかを定義します。 | |
generateVerifyAndChangeEmailLink(email, newEmail, actionCodeSettings) | 指定された電子メールのユーザーの所有権を確認するための帯域外電子メール アクション リンクを生成します。このメソッドの引数として提供されるActionCodeSettingsオブジェクトは、ディープ リンクなどで渡される追加の状態情報とともに、リンクがモバイル アプリまたはブラウザで処理されるかどうかを定義します。 | |
getProviderConfig(プロバイダーID) | 指定された ID によって認証プロバイダー構成を検索します。指定されたプロバイダー ID に対応するプロバイダー構成で解決される Promise を返します。指定された ID が存在しない場合は、 auth/configuration-not-found エラーがスローされます。 SAML および OIDC プロバイダーのサポートには、Google Cloud の ID プラットフォーム (GCIP) が必要です。価格や機能など、GCIP の詳細については、 GCIP のドキュメントを参照してください。 。 | |
getUser(uid) | 指定されたuid に対応するユーザーのユーザー データを取得します。コード サンプルと詳細なドキュメントについては、 「ユーザー データの取得」を参照してください。 | |
getUserByEmail(電子メール) | 指定された電子メールに対応するユーザーのユーザー データを取得します。コード サンプルと詳細なドキュメントについては、 「ユーザー データの取得」を参照してください。 | |
getUserByPhoneNumber(電話番号) | 指定された電話番号に対応するユーザーのユーザー データを取得します。電話番号は E.164 仕様に準拠している必要があります。コード サンプルと詳細なドキュメントについては、 「ユーザー データの取得」を参照してください。 | |
getUserByProviderUid(プロバイダーID, uid) | 指定されたプロバイダー ID に対応するユーザーのユーザー データを取得します。コード サンプルと詳細なドキュメントについては、 「ユーザー データの取得」を参照してください。 | |
getUsers(識別子) | 指定された識別子に対応するユーザーデータを取得します。順序の保証はありません。特に、結果リストの n 番目のエントリが入力パラメータ リストの n 番目のエントリに対応するという保証はありません。最大 100 個の識別子のみを指定できます。 100 を超える識別子が指定された場合、このメソッドは FirebaseAuthError をスローします。 | |
importUsers(ユーザー、オプション) | 提供されたユーザーのリストを Firebase Auth にインポートします。一度に最大 1000 ユーザーをインポートできます。パスワードを使用してユーザーをインポートする場合は、 UserImportOptions を指定する必要があります。この操作は一括インポート用に最適化されており、重複が発生する可能性があるuid 、 email 、その他の識別子の一意性のチェックは無視されます。 | |
listProviderConfigs(オプション) | 指定されたフィルターに一致する既存のプロバイダー構成のリストを返します。一度に最大 100 個のプロバイダー構成を一覧表示できます。 SAML および OIDC プロバイダーのサポートには、Google Cloud の ID プラットフォーム (GCIP) が必要です。価格や機能など、GCIP の詳細については、 GCIP のドキュメントを参照してください。 。 | |
listUsers(maxResults, pageToken) | pageToken で指定されたオフセットから始まるmaxResults のサイズのユーザーのリスト (単一バッチのみ) を取得します。これは、指定したプロジェクトのすべてのユーザーをバッチで取得するために使用されます。コードサンプルと詳細なドキュメントについては、「すべてのユーザーのリスト」を参照してください。 | |
revokeRefreshTokens(uid) | 既存のユーザーのすべての更新トークンを取り消します。この API は、ユーザーのUserRecord.tokensValidAfterTime を現在の UTC に更新します。これを呼び出すサーバーのクロックが正しく設定され、同期していることが重要です。これにより、指定されたユーザーのすべてのセッションが取り消され、既存のセッションの新しい ID トークンが作成されなくなりますが、既存の ID トークンは自然な有効期限 (1 時間) までアクティブなままになる場合があります。 ID トークンが取り消されていることを確認するには、 checkRevoked true に設定されているBaseAuth.verifyIdToken()を使用します。 | |
setCustomUserClaims(uid,customUserClaims) | 指定されたuid によって識別される既存のユーザーに追加の開発者クレームを設定します。これは通常、ユーザーの役割とアクセスのレベルを定義するために使用されます。これらのクレームは、ユーザーが既にサインインしているすべてのデバイス (トークンの有効期限が切れた後、またはトークンの更新が強制されたとき) および次回ユーザーがサインインするときに伝播される必要があります。 予約された OIDC クレーム名が使用されている場合 (sub、iat、iss など) )、エラーがスローされます。これらは、認証されたユーザーの ID トークン JWT に設定されます。コード サンプルと詳細なドキュメントについては、「ユーザー ロールとアクセス レベルの定義」を参照してください。 | |
updateProviderConfig(providerId, updatedConfig) | 指定されたプロバイダー ID に対応する更新されたAuthProviderConfig で解決される Promise を返します。指定された ID が存在しない場合は、 auth/configuration-not-found エラーがスローされます。 SAML および OIDC プロバイダーのサポートには、Google Cloud の ID プラットフォーム (GCIP) が必要です。価格や機能など、GCIP の詳細については、 GCIP のドキュメントを参照してください。 。 | |
updateUser(uid, プロパティ) | 既存のユーザーを更新します。コードサンプルと詳細なドキュメントについては、「ユーザーの更新」を参照してください。 | |
verifyIdToken(idToken, checkRevoked) | Firebase ID トークン (JWT) を検証します。トークンが有効な場合、Promise はトークンのデコードされたクレームで履行されます。そうでない場合、約束は拒否されます。 checkRevoked true に設定されている場合、まず対応するユーザーが無効になっているかどうかを確認します。 「はい」の場合、 auth/user-disabled エラーがスローされます。 「いいえ」の場合、ID トークンに対応するセッションが取り消されたかどうかを確認します。対応するユーザーのセッションが無効化された場合、 auth/id-token-revoked エラーがスローされます。指定しない場合、チェックは適用されません。コードサンプルと詳細なドキュメントについては、 「ID トークンの検証」を参照してください。 | |
verifySessionCookie(sessionCookie, checkRevoked) | Firebase セッション Cookie を検証します。 Cookie クレームを含む Promise を返します。 Cookie が検証できなかった場合は、Promise を拒否します。 checkRevoked true に設定されている場合、対応するユーザーが無効になっているかどうかが最初に検証されます。無効になっている場合は、 auth/user-disabled エラーがスローされます。 「いいえ」の場合、セッション Cookie に対応するセッションが取り消されたかどうかを確認します。対応するユーザーのセッションが無効化された場合、 auth/session-cookie-revoked エラーがスローされます。指定しない場合、チェックは実行されません。コードサンプルと詳細なドキュメントについては、 「セッション Cookie の検証」を参照してください。 |
BaseAuth.createCustomToken()
新しい Firebase カスタム トークン (JWT) を作成します。これをクライアント デバイスに送り返し、クライアント SDK のsignInWithCustomToken()
メソッドでサインインするために使用できます。 (テナント対応インスタンスもトークンにテナント ID を埋め込みます。)
コードサンプルと詳細なドキュメントについては、 「カスタム トークンの作成」を参照してください。
サイン:
createCustomToken(uid: string, developerClaims?: object): Promise<string>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
UID | 弦 | カスタム トークンのサブジェクトとして使用するuid 。 |
開発者のクレーム | 物体 | カスタム トークンのペイロードに含めるオプションの追加クレーム。 |
戻り値:
約束<文字列>
提供されたuid
とペイロードのカスタム トークンを使用して履行された Promise。
BaseAuth.createProviderConfig()
新しいプロバイダー構成の作成時に、新しく作成されたAuthProviderConfig
で解決される Promise を返します。
SAML および OIDC プロバイダーのサポートには、Google Cloud の ID プラットフォーム (GCIP) が必要です。価格や機能など、GCIP の詳細については、 GCIP のドキュメントを参照してください。 。
サイン:
createProviderConfig(config: AuthProviderConfig): Promise<AuthProviderConfig>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
構成 | AuthProviderConfig | 作成するプロバイダー構成。 |
戻り値:
Promise< AuthProviderConfig >
作成されたプロバイダー構成で解決される Promise。
BaseAuth.createSessionCookie()
指定されたオプションを使用して新しい Firebase セッション Cookie を作成します。作成された JWT 文字列は、カスタム Cookie ポリシーを使用してサーバー側のセッション Cookie として設定し、セッション管理に使用できます。セッション Cookie JWT には、提供された ID トークンと同じペイロード クレームが含まれます。
コードサンプルと詳細なドキュメントについては、 「セッション Cookie の管理」を参照してください。
サイン:
createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions): Promise<string>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
idトークン | 弦 | セッション Cookie と交換する Firebase ID トークン。 |
セッションCookieオプション | セッションクッキーオプション | カスタム セッション期間を含むセッション Cookie オプション。 |
戻り値:
約束<文字列>
作成されたセッション Cookie の成功時に解決される Promise。
BaseAuth.createUser()
新しいユーザーを作成します。
コードサンプルと詳細なドキュメントについては、「ユーザーの作成」を参照してください。
サイン:
createUser(properties: CreateRequest): Promise<UserRecord>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
プロパティ | リクエストの作成 | 作成される新しいユーザー レコードに設定するプロパティ。 |
戻り値:
Promise< UserRecord >
新しく作成されたユーザーに対応するユーザー データによって履行される約束。
BaseAuth.deleteProviderConfig()
渡されたプロバイダー ID に対応するプロバイダー構成を削除します。指定された ID が存在しない場合は、 auth/configuration-not-found
エラーがスローされます。
SAML および OIDC プロバイダーのサポートには、Google Cloud の ID プラットフォーム (GCIP) が必要です。価格や機能など、GCIP の詳細については、 GCIP のドキュメントを参照してください。 。
サイン:
deleteProviderConfig(providerId: string): Promise<void>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
プロバイダーID | 弦 | 削除するプロバイダー構成に対応するプロバイダー ID。 |
戻り値:
約束<無効>
完了時に解決される Promise。
BaseAuth.deleteUser()
既存のユーザーを削除します。
コードサンプルと詳細なドキュメントについては、 「ユーザーの削除」を参照してください。
サイン:
deleteUser(uid: string): Promise<void>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
UID | 弦 | 削除するユーザーに対応するuid 。 |
戻り値:
約束<無効>
ユーザーが削除されると空の Promise が実行されます。
BaseAuth.deleteUsers()
指定された uid で指定されたユーザーを削除します。
存在しないユーザーを削除してもエラーは生成されません (つまり、このメソッドは冪等です)。存在しないユーザーは正常に削除されたとみなされ、そのためDeleteUsersResult.successCount
値にカウントされます。
最大 1000 個の識別子のみを指定できます。 1000 を超える識別子が指定された場合、このメソッドは FirebaseAuthError をスローします。
現在、この API はサーバーで 1 QPS にレート制限されています。これを超えると、クォータ超過エラーが発生する可能性があります。したがって、1000 人を超えるユーザーを削除する場合は、この制限を超えないよう遅延を追加する必要がある場合があります。
サイン:
deleteUsers(uids: string[]): Promise<DeleteUsersResult>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
UIDS | 弦[] | 削除するユーザーに対応するuids 。 |
戻り値:
Promise< DeleteUsersResult >
成功/失敗した削除の合計数と、失敗した削除に対応するエラーの配列を解決する Promise。
BaseAuth.generateEmailVerificationLink()
指定された電子メールのユーザーの所有権を確認するために、帯域外電子メール アクション リンクを生成します。このメソッドの引数として提供されるActionCodeSettingsオブジェクトは、ディープ リンクなどで渡される追加の状態情報とともに、リンクがモバイル アプリまたはブラウザで処理されるかどうかを定義します。
サイン:
generateEmailVerificationLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
Eメール | 弦 | 確認する電子メール アカウント。 |
アクションコード設定 | アクションコード設定 | アクションコードの設定です。指定した場合、状態/続行 URL は電子メール検証リンクの「ContinueUrl」パラメーターとして設定されます。デフォルトの電子メール検証ランディング ページでは、これを使用して、アプリがインストールされている場合にそのアプリに戻るためのリンクを表示します。 actionCodeSettings が指定されていない場合、URL はアクション URL に追加されません。提供される状態 URL は、コンソールで開発者によってホワイトリストに登録されているドメインに属している必要があります。それ以外の場合は、エラーがスローされます。モバイル アプリのリダイレクトは、開発者が Firebase Dynamic Links の利用規約を構成して同意した場合にのみ適用されます。 Android パッケージ名と iOS バンドル ID は、同じ Firebase Auth プロジェクトで構成されている場合にのみ考慮されます。 |
戻り値:
約束<文字列>
生成されたリンクで解決される Promise。
例
var actionCodeSettings = {
url: 'https://www.example.com/cart?email=user@example.com&cartId=123',
iOS: {
bundleId: 'com.example.ios'
},
android: {
packageName: 'com.example.android',
installApp: true,
minimumVersion: '12'
},
handleCodeInApp: true,
dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
.generateEmailVerificationLink('user@example.com', actionCodeSettings)
.then(function(link) {
// The link was successfully generated.
})
.catch(function(error) {
// Some error occurred, you can inspect the code: error.code
});
BaseAuth.generatePasswordResetLink()
ユーザーのパスワードをリセットするための帯域外電子メール アクション リンクを生成します。指定した電子メール アドレスを持つユーザーに対してリンクが生成されます。オプションのActionCodeSettingsオブジェクトは、リンクをモバイル アプリまたはブラウザーで処理するかどうか、およびディープ リンクで渡される追加の状態情報などを定義します。
サイン:
generatePasswordResetLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
Eメール | 弦 | パスワードをリセットするユーザーの電子メール アドレス。 |
アクションコード設定 | アクションコード設定 | アクションコードの設定です。指定した場合、状態/継続 URL はパスワード リセット リンクの「ContinueUrl」パラメータとして設定されます。デフォルトのパスワード リセット ランディング ページでは、これを使用して、アプリがインストールされている場合にそのアプリに戻るためのリンクを表示します。 actionCodeSettings が指定されていない場合、URL はアクション URL に追加されません。提供される状態 URL は、コンソールで開発者によってホワイトリストに登録されているドメインに属している必要があります。それ以外の場合は、エラーがスローされます。モバイル アプリのリダイレクトは、開発者が Firebase Dynamic Links の利用規約を構成して同意した場合にのみ適用されます。 Android パッケージ名と iOS バンドル ID は、同じ Firebase Auth プロジェクトで構成されている場合にのみ考慮されます。 |
戻り値:
約束<文字列>
生成されたリンクで解決される Promise。
例
var actionCodeSettings = {
url: 'https://www.example.com/?email=user@example.com',
iOS: {
bundleId: 'com.example.ios'
},
android: {
packageName: 'com.example.android',
installApp: true,
minimumVersion: '12'
},
handleCodeInApp: true,
dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
.generatePasswordResetLink('user@example.com', actionCodeSettings)
.then(function(link) {
// The link was successfully generated.
})
.catch(function(error) {
// Some error occurred, you can inspect the code: error.code
});
BaseAuth.generateSignInWithEmailLink()
指定された電子メールのユーザーの所有権を確認するために、帯域外電子メール アクション リンクを生成します。このメソッドの引数として提供されるActionCodeSettingsオブジェクトは、ディープ リンクなどで渡される追加の状態情報とともに、リンクがモバイル アプリまたはブラウザで処理されるかどうかを定義します。
サイン:
generateSignInWithEmailLink(email: string, actionCodeSettings: ActionCodeSettings): Promise<string>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
Eメール | 弦 | 確認する電子メール アカウント。 |
アクションコード設定 | アクションコード設定 | アクションコードの設定です。指定した場合、状態/続行 URL は電子メール検証リンクの「ContinueUrl」パラメーターとして設定されます。デフォルトの電子メール検証ランディング ページでは、これを使用して、アプリがインストールされている場合にそのアプリに戻るためのリンクを表示します。 actionCodeSettings が指定されていない場合、URL はアクション URL に追加されません。提供される状態 URL は、コンソールで開発者によってホワイトリストに登録されているドメインに属している必要があります。それ以外の場合は、エラーがスローされます。モバイル アプリのリダイレクトは、開発者が Firebase Dynamic Links の利用規約を構成して同意した場合にのみ適用されます。 Android パッケージ名と iOS バンドル ID は、同じ Firebase Auth プロジェクトで構成されている場合にのみ考慮されます。 |
戻り値:
約束<文字列>
生成されたリンクで解決される Promise。
例
var actionCodeSettings = {
url: 'https://www.example.com/cart?email=user@example.com&cartId=123',
iOS: {
bundleId: 'com.example.ios'
},
android: {
packageName: 'com.example.android',
installApp: true,
minimumVersion: '12'
},
handleCodeInApp: true,
dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
.generateEmailVerificationLink('user@example.com', actionCodeSettings)
.then(function(link) {
// The link was successfully generated.
})
.catch(function(error) {
// Some error occurred, you can inspect the code: error.code
});
BaseAuth.generateVerifyAndChangeEmailLink()
指定された電子メールのユーザーの所有権を確認するための帯域外電子メール アクション リンクを生成します。このメソッドの引数として提供されるActionCodeSettingsオブジェクトは、ディープ リンクなどで渡される追加の状態情報とともに、リンクがモバイル アプリまたはブラウザで処理されるかどうかを定義します。
サイン:
generateVerifyAndChangeEmailLink(email: string, newEmail: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
Eメール | 弦 | 現在の電子メール アカウント。 |
新しいメール | 弦 | アカウントが更新される電子メール アドレス。 |
アクションコード設定 | アクションコード設定 | アクションコードの設定です。指定した場合、状態/続行 URL は電子メール検証リンクの「ContinueUrl」パラメーターとして設定されます。デフォルトの電子メール検証ランディング ページでは、これを使用して、アプリがインストールされている場合にそのアプリに戻るためのリンクを表示します。 actionCodeSettings が指定されていない場合、URL はアクション URL に追加されません。指定された状態 URL は、コンソールで承認されたドメインに属している必要があります。そうでない場合は、エラーがスローされます。モバイル アプリのリダイレクトは、開発者が Firebase Dynamic Links の利用規約を構成して同意した場合にのみ適用されます。 Android パッケージ名と iOS バンドル ID は、同じ Firebase Auth プロジェクトで構成されている場合にのみ考慮されます。 |
戻り値:
約束<文字列>
生成されたリンクで解決される Promise。
BaseAuth.getProviderConfig()
指定された ID によって認証プロバイダー構成を検索します。指定されたプロバイダー ID に対応するプロバイダー構成で解決される Promise を返します。指定された ID が存在しない場合は、 auth/configuration-not-found
エラーがスローされます。
SAML および OIDC プロバイダーのサポートには、Google Cloud の ID プラットフォーム (GCIP) が必要です。価格や機能など、GCIP の詳細については、 GCIP のドキュメントを参照してください。 。
サイン:
getProviderConfig(providerId: string): Promise<AuthProviderConfig>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
プロバイダーID | 弦 | 返されるプロバイダー構成に対応するプロバイダー ID。 |
戻り値:
Promise< AuthProviderConfig >
指定された ID に対応する構成で解決される Promise。
BaseAuth.getUser()
指定されたuid
に対応するユーザーのユーザー データを取得します。
コード サンプルと詳細なドキュメントについては、 「ユーザー データの取得」を参照してください。
サイン:
getUser(uid: string): Promise<UserRecord>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
UID | 弦 | データを取得するユーザーに対応するuid 。 |
戻り値:
Promise< UserRecord >
提供されたuid
に対応するユーザーデータで履行されたPromise 。
BaseAuth.getUserByEmail()
指定された電子メールに対応するユーザーのユーザー データを取得します。
コード サンプルと詳細なドキュメントについては、 「ユーザー データの取得」を参照してください。
サイン:
getUserByEmail(email: string): Promise<UserRecord>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
Eメール | 弦 | データを取得するユーザーに対応する電子メール。 |
戻り値:
Promise< UserRecord >
提供された電子メールに対応するユーザー データを使用して履行された約束。
BaseAuth.getUserByPhoneNumber()
指定された電話番号に対応するユーザーのユーザー データを取得します。電話番号は E.164 仕様に準拠している必要があります。
コード サンプルと詳細なドキュメントについては、 「ユーザー データの取得」を参照してください。
サイン:
getUserByPhoneNumber(phoneNumber: string): Promise<UserRecord>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
電話番号 | 弦 | データを取得するユーザーに対応する電話番号。 |
戻り値:
Promise< UserRecord >
提供された電話番号に対応するユーザー データを使用して約束が履行されます。
BaseAuth.getUserByProviderUid()
指定されたプロバイダー ID に対応するユーザーのユーザー データを取得します。
コード サンプルと詳細なドキュメントについては、 「ユーザー データの取得」を参照してください。
サイン:
getUserByProviderUid(providerId: string, uid: string): Promise<UserRecord>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
プロバイダーID | 弦 | プロバイダー ID (たとえば、Google プロバイダーの場合は「google.com」)。 |
UID | 弦 | 指定されたプロバイダーのユーザー識別子。 |
戻り値:
Promise< UserRecord >
指定されたプロバイダー ID に対応するユーザー データで履行される約束。
BaseAuth.getUsers()
指定された識別子に対応するユーザーデータを取得します。
順序の保証はありません。特に、結果リストの n 番目のエントリが入力パラメータ リストの n 番目のエントリに対応するという保証はありません。
最大 100 個の識別子のみを指定できます。 100 を超える識別子が指定された場合、このメソッドは FirebaseAuthError をスローします。
サイン:
getUsers(identifiers: UserIdentifier[]): Promise<GetUsersResult>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
識別子 | ユーザー識別子[] | どのユーザー レコードを返す必要があるかを示すために使用される識別子。エントリは 100 を超えてはなりません。 |
戻り値:
Promise< GetUsersResult >
対応するユーザー レコードに解決される Promise。
例外
FirebaseAuthError いずれかの識別子が無効な場合、または 100 を超える識別子が指定された場合。
BaseAuth.importUsers()
提供されたユーザーのリストを Firebase Auth にインポートします。一度に最大 1000 ユーザーをインポートできます。パスワードを使用してユーザーをインポートする場合は、 UserImportOptions を指定する必要があります。この操作は一括インポート用に最適化されており、 uid
のチェックを無視します。 、 email
およびその他の識別子の一意性により、重複が発生する可能性があります。
サイン:
importUsers(users: UserImportRecord[], options?: UserImportOptions): Promise<UserImportResult>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
ユーザー | ユーザーインポートレコード[] | Firebase Auth にインポートするユーザー レコードのリスト。 |
オプション | ユーザーインポートオプション | ユーザー インポート オプション。指定されたユーザーにパスワード資格情報が含まれている場合に必要です。 |
戻り値:
Promise< UserImportResult >
インポートの結果で操作が完了したときに解決される Promise。これには、成功したインポートの数、失敗したインポートの数、およびそれらに対応するエラーが含まれます。
BaseAuth.listProviderConfigs()
指定されたフィルターに一致する既存のプロバイダー構成のリストを返します。一度に最大 100 個のプロバイダー構成を一覧表示できます。
SAML および OIDC プロバイダーのサポートには、Google Cloud の ID プラットフォーム (GCIP) が必要です。価格や機能など、GCIP の詳細については、 GCIP のドキュメントを参照してください。 。
サイン:
listProviderConfigs(options: AuthProviderConfigFilter): Promise<ListProviderConfigResults>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
オプション | AuthProviderConfigFilter | 適用するプロバイダー構成フィルター。 |
戻り値:
Promise< ListProviderConfigResults >
フィルター要件を満たすプロバイダー構成のリストで解決される Promise。
BaseAuth.listUsers()
pageToken
で指定されたオフセットから始まるmaxResults
のサイズでユーザーのリスト (単一バッチのみ) を取得します。 。これは、指定したプロジェクトのすべてのユーザーをバッチで取得するために使用されます。
コードサンプルと詳細なドキュメントについては、「すべてのユーザーのリスト」を参照してください。
サイン:
listUsers(maxResults?: number, pageToken?: string): Promise<ListUsersResult>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
最大結果 | 番号 | ページ サイズ。未定義の場合は 1000。これは最大許容値でもあります。 |
ページトークン | 弦 | 次のページのトークン。指定しない場合は、オフセットなしで開始するユーザーを返します。 |
戻り値:
Promise< ListUsersResult >
ダウンロードされたユーザーの現在のバッチと次のページ トークンで解決される Promise。
BaseAuth.revokeRefreshTokens()
既存のユーザーのすべての更新トークンを取り消します。
この API は、ユーザーのUserRecord.tokensValidAfterTime を現在の UTC に更新します。これを呼び出すサーバーのクロックが正しく設定され、同期していることが重要です。
これにより、指定されたユーザーのすべてのセッションが取り消され、既存のセッションの新しい ID トークンの作成が無効になりますが、既存の ID トークンは自然な有効期限 (1 時間) までアクティブなままになる場合があります。 ID トークンが取り消されていることを確認するには、 checkRevoked
true に設定されているBaseAuth.verifyIdToken()を使用します。
サイン:
revokeRefreshTokens(uid: string): Promise<void>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
UID | 弦 | リフレッシュトークンが取り消されるユーザーに対応するuid 。 |
戻り値:
約束<無効>
ユーザーの更新トークンが取り消されると、空の Promise が実行されます。
BaseAuth.setCustomUserClaims()
提供されたuid
で識別される既存のユーザーに追加の開発者クレームを設定します。 、通常はユーザーの役割とアクセスのレベルを定義するために使用されます。これらのクレームは、ユーザーが既にサインインしているすべてのデバイス (トークンの有効期限が切れた後、またはトークンの更新が強制されたとき) および次回ユーザーがサインインしたときに、すべてのデバイスに伝播される必要があります。 予約された OIDC クレーム名が使用されている場合 (sub、iat、iss など) )、エラーがスローされます。これらは、認証されたユーザーの ID トークン JWT に設定されます。
コード サンプルと詳細なドキュメントについては、「ユーザー ロールとアクセス レベルの定義」を参照してください。
サイン:
setCustomUserClaims(uid: string, customUserClaims: object | null): Promise<void>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
UID | 弦 | 編集するユーザーのuid 。 |
カスタムユーザークレーム | オブジェクト |ヌル | 開発者は設定すると主張しています。 null が渡された場合、既存のカスタム クレームは削除されます。 1000 バイトを超えるカスタム クレーム ペイロードを渡すと、エラーがスローされます。カスタム クレームは、認証されたリクエストごとに送信されるユーザーの ID トークンに追加されます。プロファイル非アクセス関連のユーザー属性の場合は、データベースまたはその他の別個のストレージ システムを使用します。 |
戻り値:
約束<無効>
操作が正常に完了したときに解決される Promise。
BaseAuth.updateProviderConfig()
指定されたプロバイダー ID に対応する更新されたAuthProviderConfig
で解決される Promise を返します。指定された ID が存在しない場合は、 auth/configuration-not-found
エラーがスローされます。
SAML および OIDC プロバイダーのサポートには、Google Cloud の ID プラットフォーム (GCIP) が必要です。価格や機能など、GCIP の詳細については、 GCIP のドキュメントを参照してください。 。
サイン:
updateProviderConfig(providerId: string, updatedConfig: UpdateAuthProviderRequest): Promise<AuthProviderConfig>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
プロバイダーID | 弦 | 更新するプロバイダー構成に対応するプロバイダー ID。 |
更新された構成 | UpdateAuthProviderRequest | 更新された構成。 |
戻り値:
Promise< AuthProviderConfig >
更新されたプロバイダー構成で解決される Promise。
BaseAuth.updateUser()
既存のユーザーを更新します。
コードサンプルと詳細なドキュメントについては、「ユーザーの更新」を参照してください。
サイン:
updateUser(uid: string, properties: UpdateRequest): Promise<UserRecord>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
UID | 弦 | 更新するユーザーに対応するuid 。 |
プロパティ | 更新リクエスト | 指定されたユーザーで更新するプロパティ。 |
戻り値:
Promise< UserRecord >
更新されたユーザー データによって約束が果たされました。
BaseAuth.verifyIdToken()
Firebase ID トークン (JWT) を検証します。トークンが有効な場合、Promise はトークンのデコードされたクレームで履行されます。そうでない場合、約束は拒否されます。
checkRevoked
true に設定されている場合、まず対応するユーザーが無効になっているかどうかを確認します。 「はい」の場合、 auth/user-disabled
エラーがスローされます。 「いいえ」の場合、ID トークンに対応するセッションが取り消されたかどうかを確認します。対応するユーザーのセッションが無効化された場合、 auth/id-token-revoked
エラーがスローされます。指定しない場合、チェックは適用されません。
コードサンプルと詳細なドキュメントについては、 「ID トークンの検証」を参照してください。
サイン:
verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
idトークン | 弦 | 検証する ID トークン。 |
チェック取り消し済み | ブール値 | IDトークンが取り消されたかどうかを確認するかどうか。これには、対応するユーザーのtokensValidAfterTime 時間を確認するために、Firebase Auth バックエンドへの追加のリクエストが必要です。指定しない場合、この追加チェックは適用されません。 |
戻り値:
Promise< DecodedIdToken >
ID トークンが有効な場合、トークンのデコードされたクレームによって履行される Promise。それ以外の場合は、約束が拒否されます。
BaseAuth.verifySessionCookie()
Firebase セッション Cookie を検証します。 Cookie クレームを含む Promise を返します。 Cookie が検証できなかった場合は、Promise を拒否します。
checkRevoked
true に設定されている場合、対応するユーザーが無効になっているかどうかが最初に検証されます。無効になっている場合は、 auth/user-disabled
エラーがスローされます。 「いいえ」の場合、セッション Cookie に対応するセッションが取り消されたかどうかを確認します。対応するユーザーのセッションが無効化された場合、 auth/session-cookie-revoked
エラーがスローされます。指定しない場合、チェックは実行されません。
コードサンプルと詳細なドキュメントについては、 「セッション Cookie の検証」を参照してください。
サイン:
verifySessionCookie(sessionCookie: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
セッションクッキー | 弦 | 検証するセッション Cookie。 |
チェック取り消し済み | ブール値 |
戻り値:
Promise< DecodedIdToken >
セッション Cookie が有効な場合、セッション Cookie のデコードされたクレームによって履行される Promise。それ以外の場合は、約束が拒否されます。