ユーザー アカウント。
署名:
export interface User extends UserInfo
拡張: UserInfo
プロパティ
| プロパティ | タイプ | 説明 |
|---|---|---|
| emailVerified | boolean | sendEmailVerification() と applyActionCode() でメールアドレスが確認されたかどうか。 |
| isAnonymous | boolean | ユーザーが ProviderId.ANONYMOUS プロバイダを使用して認証されるかどうか。 |
| metadata | UserMetadata | ユーザーの作成時間とログイン時間に関する追加のメタデータ。 |
| providerData | UserInfo[] | displayName やプロフィール情報など、プロバイダごとの追加情報。 |
| refreshToken | string | ユーザーの再認証に使用される更新トークン。これを直接使用するのではなく、User.getIdToken() を使用して ID トークンを更新することをおすすめします。 |
| tenantId | 文字列 | null | ユーザーのテナント ID。 |
Methods
| メソッド | 説明 |
|---|---|
| delete() | ユーザーを削除してログアウトします。 |
| getIdToken(forceRefresh) | Firebase サービスでユーザーを識別するために使用される JSON Web Token（JWT）を返します。 |
| getIdTokenResult(forceRefresh) | Firebase サービスでユーザーを識別するために使用される、シリアル化解除された JSON Web Token（JWT）を返します。 |
| reload() | ログイン中のユーザーを更新します。 |
| toJSON() | このオブジェクトのシリアル化可能な JSON 表現を返します。 |
User.emailVerified
sendEmailVerification() と applyActionCode() でメールアドレスが確認されたかどうか。
署名:
readonly emailVerified: boolean;
User.isAnonymous
ユーザーが ProviderId.ANONYMOUS プロバイダを使用して認証されるかどうか。
署名:
readonly isAnonymous: boolean;
User.metadata
ユーザーの作成時間とログイン時間に関する追加のメタデータ。
署名:
readonly metadata: UserMetadata;
User.providerData
displayName やプロフィール情報など、プロバイダごとの追加情報。
署名:
readonly providerData: UserInfo[];
User.refreshToken
ユーザーの再認証に使用される更新トークン。これを直接使用するのではなく、User.getIdToken() を使用して ID トークンを更新することをおすすめします。
署名:
readonly refreshToken: string;
User.tenantId
ユーザーのテナント ID。
これは読み取り専用のプロパティで、ユーザーのログインに使用するテナント ID を示します。ユーザーが親プロジェクトからログインしている場合は null です。
署名:
readonly tenantId: string | null;
例
// Set the tenant ID on Auth instance.
auth.tenantId = 'TENANT_PROJECT_ID';
// All future sign-in request now include tenant ID.
const result = await signInWithEmailAndPassword(auth, email, password);
// result.user.tenantId should be 'TENANT_PROJECT_ID'.
User.delete()
ユーザーを削除してログアウトします。
このメソッドは、FirebaseServerApp で作成された Auth インスタンスによってログインされたどの User でもサポートされません。
署名:
delete(): Promise<void>;
戻り値:
Promise<void>
User.getIdToken()
Firebase サービスでユーザーを識別するために使用される JSON Web Token（JWT）を返します。
現在のトークンが期限切れになっていない場合、または次の 5 分以内に期限切れにならない場合は、トークンを返します。それ以外の場合は、トークンが更新され、新しいトークンが返されます。
署名:
getIdToken(forceRefresh?: boolean): Promise<string>;
パラメータ
| パラメータ | タイプ | 説明 |
|---|---|---|
| forceRefresh | boolean | トークンの有効期限に関係なく強制更新します。 |
戻り値:
Promise<文字列>
User.getIdTokenResult()
Firebase サービスでユーザーを識別するために使用される、シリアル化解除された JSON Web Token（JWT）を返します。
現在のトークンが期限切れになっていない場合、または次の 5 分以内に期限切れにならない場合は、トークンを返します。それ以外の場合は、トークンが更新され、新しいトークンが返されます。
署名:
getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>;
パラメータ
| パラメータ | タイプ | 説明 |
|---|---|---|
| forceRefresh | boolean | トークンの有効期限に関係なく強制更新します。 |
戻り値:
Promise<IdTokenResult>
User.reload()
ログイン中のユーザーを更新します。
署名:
reload(): Promise<void>;
戻り値:
Promise<void>
User.toJSON()
このオブジェクトのシリアル化可能な JSON 表現を返します。
署名:
toJSON(): object;
戻り値:
オブジェクト
このオブジェクトのシリアル化可能な JSON 表現。