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