ID プラットフォームから認証ブロッキング関数に渡される UserRecord。
署名:
export interface AuthUserRecord
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| customClaims | レコード<文字列、任意> | ユーザーのカスタム クレーム オブジェクト（利用可能な場合）。通常はユーザーロールを定義するために使用され、認証済みユーザーの ID トークンに伝播されます。 |
| 無効 | ブール値 | ユーザーが無効かどうか: 無効の場合は true、有効の場合は false。 |
| displayName | 文字列 | ユーザーの表示名。 |
| 文字列 | ユーザーのメインのメールアドレス（設定されている場合）。 | |
| 確認済み | ブール値 | ユーザーのメインのメールアドレスが確認済みかどうか。 |
| metadata | AuthUserMetadata | ユーザーに関する追加のメタデータ。 |
| 多要素 | AuthMultiFactorSettings | 現在のユーザーの多要素関連プロパティ（利用可能な場合）。 |
| passwordHash | 文字列 | ユーザーのハッシュ化されたパスワード（base64 エンコード）。 |
| passwordSalt | 文字列 | ユーザーのパスワード ソルト（base64 エンコード）。 |
| phoneNumber | 文字列 | ユーザーのメインの電話番号（設定されている場合）。 |
| 写真の URL | 文字列 | ユーザーの写真 URL。 |
| providerData | AuthUserInfo[] | ユーザーにリンクされているプロバイダ（Google、Facebook など）の配列。 |
| tenantId | 文字列 |null | ユーザーが所属するテナントの ID（利用可能な場合）。 |
| tokensValidAfterTime | 文字列 | ユーザーのトークンが有効になった日付より後の日付（UTC 文字列形式）。 |
| UID | 文字列 | ユーザーの uid。 |
identity.AuthUserRecord.customClaims
ユーザーのカスタム クレーム オブジェクト（利用可能な場合）。通常はユーザーロールを定義するために使用され、認証済みユーザーの ID トークンに伝播されます。
署名:
customClaims?: Record<string, any>;
identity.AuthUserRecord.disabled
ユーザーが無効かどうか: 無効の場合は true、有効の場合は false。
署名:
disabled: boolean;
identity.AuthUserRecord.displayName
ユーザーの表示名。
署名:
displayName?: string;
identity.AuthUserRecord.email
ユーザーのメインのメールアドレス（設定されている場合）。
署名:
email?: string;
identity.AuthUserRecord.emailVerified（ID.AuthUserRecord.emailVerified）
ユーザーのメインのメールアドレスが確認済みかどうか。
署名:
emailVerified: boolean;
identity.AuthUserRecord.metadata
ユーザーに関する追加のメタデータ。
署名:
metadata: AuthUserMetadata;
identity.AuthUserRecord.multiFactor
現在のユーザーの多要素関連プロパティ（利用可能な場合）。
署名:
multiFactor?: AuthMultiFactorSettings;
identity.AuthUserRecord.passwordHash
ユーザーのハッシュ化されたパスワード（base64 エンコード）。
署名:
passwordHash?: string;
identity.AuthUserRecord.passwordSalt
ユーザーのパスワード ソルト（base64 エンコード）。
署名:
passwordSalt?: string;
identity.AuthUserRecord.phoneNumber
ユーザーのメインの電話番号（設定されている場合）。
署名:
phoneNumber?: string;
identity.AuthUserRecord.photoURL
ユーザーの写真 URL。
署名:
photoURL?: string;
identity.AuthUserRecord.providerData:
ユーザーにリンクされているプロバイダ（Google、Facebook など）の配列。
署名:
providerData: AuthUserInfo[];
identity.AuthUserRecord.tenantId
ユーザーが所属するテナントの ID（利用可能な場合）。
署名:
tenantId?: string | null;
identity.AuthUserRecord.tokensValidAfterTime
ユーザーのトークンが有効になった日付より後の日付（UTC 文字列形式）。
署名:
tokensValidAfterTime?: string;
identity.AuthUserRecord.uid
ユーザーの uid。
署名:
uid: string;