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