ユーザーを表します。
署名:
export declare class UserRecord
プロパティ
| プロパティ | 修飾キー | タイプ | 説明 |
|---|---|---|---|
| customClaims | { [キー: 文字列]: 任意;} | ユーザーのカスタム クレーム オブジェクト（利用可能な場合）。通常はユーザーロールを定義するために使用され、認証済みユーザーの ID トークンに伝播されます。これは BaseAuth.setCustomUserClaims() で設定されます。 | |
| 無効 | ブール値 | ユーザーが無効かどうか: 無効の場合は true、有効の場合は false。 |
|
| displayName | 文字列 | ユーザーの表示名。 | |
| 文字列 | ユーザーのメインのメールアドレス（設定されている場合）。 | ||
| 確認済み | ブール値 | ユーザーのメインのメールアドレスが確認済みかどうか。 | |
| metadata | UserMetadata | ユーザーに関する追加のメタデータ。 | |
| 多要素 | MultiFactorSettings | 現在のユーザーの多要素関連プロパティ（利用可能な場合）。 | |
| passwordHash | 文字列 | Firebase Auth のハッシュ化アルゴリズム（SCRYPT）が使用されている場合のみ、ユーザーのハッシュ化されたパスワード（base64 エンコード）。このユーザーをアップロードする際に別のハッシュ アルゴリズムが使用されていた場合（別の Auth システムから移行する際の一般的なこと）、これは空の文字列になります。パスワードが設定されていない場合、これは null です。これは、ユーザーが BaseAuth.listUsers() から取得された場合にのみ使用できます。 | |
| passwordSalt | 文字列 | Firebase Auth ハッシュ アルゴリズム（SCRYPT）が使用されている場合のみ、ユーザーのパスワード ソルト（base64 エンコード）。このユーザーのアップロードに別のハッシュ アルゴリズムが使用されていた場合、通常は別の Auth システムから移行した場合、これは空の文字列になります。パスワードが設定されていない場合、これは null です。これは、ユーザーが BaseAuth.listUsers() から取得された場合にのみ使用できます。 | |
| phoneNumber | 文字列 | ユーザーのメインの電話番号（設定されている場合）。 | |
| 写真の URL | 文字列 | ユーザーの写真 URL。 | |
| providerData | UserInfo[] | ユーザーにリンクされているプロバイダ（Google、Facebook など）の配列。 | |
| tenantId | 文字列 |null | ユーザーが所属するテナントの ID（利用可能な場合）。 | |
| tokensValidAfterTime | 文字列 | ユーザーのトークンが有効になった日付より後の日付（UTC 文字列形式）。これは、アカウントの大幅な変更（パスワードのリセット、パスワード、メールの更新など）時に BaseAuth.revokeRefreshTokens() API または Firebase Auth バックエンドからユーザーの更新トークンが取り消されるたびに更新されます。 | |
| UID | 文字列 | ユーザーの uid。 |
メソッド
| メソッド | 修飾キー | 説明 |
|---|---|---|
| toJSON() | このオブジェクトの JSON シリアル化可能な表現を返します。 |
UserRecord.customClaims
ユーザーのカスタム クレーム オブジェクト（利用可能な場合）。通常はユーザーロールを定義するために使用され、認証済みユーザーの ID トークンに伝播されます。これは BaseAuth.setCustomUserClaims() で設定されます。
署名:
readonly customClaims?: {
[key: string]: any;
};
UserRecord.disabled
ユーザーが無効かどうか: 無効の場合は true、有効の場合は false。
署名:
readonly disabled: boolean;
UserRecord.displayName
ユーザーの表示名。
署名:
readonly displayName?: string;
UserRecord.email
ユーザーのメインのメールアドレス（設定されている場合）。
署名:
readonly email?: string;
UserRecord.emailVerified（UserRecord.emailVerified）
ユーザーのメインのメールアドレスが確認済みかどうか。
署名:
readonly emailVerified: boolean;
UserRecord.metadata
ユーザーに関する追加のメタデータ。
署名:
readonly metadata: UserMetadata;
UserRecord.multiFactor
現在のユーザーの多要素関連プロパティ（利用可能な場合）。
署名:
readonly multiFactor?: MultiFactorSettings;
UserRecord.passwordHash
Firebase Auth のハッシュ化アルゴリズム（SCRYPT）が使用されている場合のみ、ユーザーのハッシュ化されたパスワード（base64 エンコード）。このユーザーをアップロードする際に別のハッシュ アルゴリズムが使用されていた場合（別の Auth システムから移行する際の一般的なこと）、これは空の文字列になります。パスワードが設定されていない場合、これは null です。これは、ユーザーが BaseAuth.listUsers() から取得された場合にのみ使用できます。
署名:
readonly passwordHash?: string;
UserRecord.passwordSalt
Firebase Auth ハッシュ アルゴリズム（SCRYPT）が使用されている場合のみ、ユーザーのパスワード ソルト（base64 エンコード）。このユーザーのアップロードに別のハッシュ アルゴリズムが使用されていた場合、通常は別の Auth システムから移行した場合、これは空の文字列になります。パスワードが設定されていない場合、これは null です。これは、ユーザーが BaseAuth.listUsers() から取得された場合にのみ使用できます。
署名:
readonly passwordSalt?: string;
UserRecord.phoneNumber
ユーザーのメインの電話番号（設定されている場合）。
署名:
readonly phoneNumber?: string;
UserRecord.photoURL
ユーザーの写真 URL。
署名:
readonly photoURL?: string;
UserRecord.providerData:
ユーザーにリンクされているプロバイダ（Google、Facebook など）の配列。
署名:
readonly providerData: UserInfo[];
UserRecord.tenantId
ユーザーが所属するテナントの ID（利用可能な場合）。
署名:
readonly tenantId?: string | null;
UserRecord.tokensValidAfterTime
ユーザーのトークンが有効になった日付より後の日付（UTC 文字列形式）。これは、アカウントの大幅な変更（パスワードのリセット、パスワード、メールの更新など）時に BaseAuth.revokeRefreshTokens() API または Firebase Auth バックエンドからユーザーの更新トークンが取り消されるたびに更新されます。
署名:
readonly tokensValidAfterTime?: string;
UserRecord.uid
ユーザーの uid。
署名:
readonly uid: string;
UserRecord.toJSON()
このオブジェクトの JSON シリアル化可能な表現を返します。
署名:
toJSON(): object;
戻り値:
オブジェクト
このオブジェクトの JSON シリアル化可能な表現。