UpdateRequest interface

指定されたユーザーについて更新するプロパティを表すインターフェース。

署名:

export interface UpdateRequest

プロパティ

プロパティ 型 説明
無効 ブール値 ユーザーが無効かどうか: 無効の場合は true、有効の場合は false。
displayName 文字列 |null ユーザーの表示名。
email 文字列 ユーザーのプライマリ メールアドレス。
確認済み ブール値 ユーザーのメインのメールアドレスが確認済みかどうか。
多要素 MultiFactorUpdateSettings ユーザーが更新された多要素関連プロパティ。
パスワード 文字列 ユーザーのハッシュ化されていないパスワード。
phoneNumber 文字列 |null ユーザーのメインの電話番号。
写真の URL 文字列 |null ユーザーの写真 URL。
プロバイダのリンクを解除 string[] このユーザーと指定したプロバイダのリンクを解除します。
providerToLink UserProvider このユーザーを、指定されたプロバイダにリンクします。プロバイダを既存のユーザー アカウントにリンクしても、そのアカウントの更新トークンは無効になりません。つまり、新しくリンクされたプロバイダを使用してログインしていなくても、既存のアカウントでは、引き続きリソースにアクセスできます。この新しいプロバイダでユーザーに認証を求める場合は、（a）更新トークンを取り消して（https://firebase.google.com/docs/auth/admin/manage-sessions#revoke_refresh_tokens を参照）、（b）このアカウントに他の認証方法がないことを確認する必要があります。

UpdateRequest.disabled

ユーザーが無効かどうか: 無効の場合は true、有効の場合は false。

署名:

disabled?: boolean;

UpdateRequest.displayName

ユーザーの表示名。

署名:

displayName?: string | null;

UpdateRequest.email

ユーザーのプライマリ メールアドレス。

署名:

email?: string;

UpdateRequest.emailVerified が認証されました

ユーザーのメインのメールアドレスが確認済みかどうか。

署名:

emailVerified?: boolean;

UpdateRequest.multiFactor に対する引数

ユーザーが更新された多要素関連プロパティ。

署名:

multiFactor?: MultiFactorUpdateSettings;

UpdateRequest.password

ユーザーのハッシュ化されていないパスワード。

署名:

password?: string;

UpdateRequest.phoneNumber

ユーザーのメインの電話番号。

署名:

phoneNumber?: string | null;

UpdateRequest.photoURL

ユーザーの写真 URL。

署名:

photoURL?: string | null;

このユーザーと指定したプロバイダのリンクを解除します。

署名:

providersToUnlink?: string[];

このユーザーを、指定されたプロバイダにリンクします。

プロバイダを既存のユーザー アカウントにリンクしても、そのアカウントの更新トークンは無効になりません。つまり、新しくリンクされたプロバイダを使用してログインしていなくても、既存のアカウントでは、引き続きリソースにアクセスできます。この新しいプロバイダでユーザーに認証を強制するには、（a）更新トークンを取り消して（https://firebase.google.com/docs/auth/admin/manage-sessions#revoke_refresh_tokens を参照）、（b）このアカウントに他の認証方法がないことを確認する必要があります。

署名:

providerToLink?: UserProvider;