BaseAuth.importUsers()メソッドを介して Firebase Auth にインポートするユーザーを表すインターフェース。
サイン:
export interface UserImportRecord
プロパティ
財産 | タイプ | 説明 |
---|---|---|
カスタムクレーム | { [キー: 文字列]: 任意; } | ユーザーのカスタム クレーム オブジェクト (利用可能な場合)。通常はユーザー ロールの定義に使用され、認証されたユーザーの ID トークンに伝播されます。 |
無効 | ブール値 | ユーザーが無効かどうか: 無効の場合はtrue 。有効の場合はfalse 。 |
表示名 | 弦 | ユーザーの表示名。 |
Eメール | 弦 | ユーザーのプライマリ電子メール (設定されている場合)。 |
メール認証済み | ブール値 | ユーザーのプライマリ電子メールが検証されているかどうか。 |
メタデータ | ユーザーメタデータリクエスト | ユーザーに関する追加のメタデータ。 |
多要素 | MultiFactorUpdate設定 | ユーザーの多要素関連プロパティ。 |
パスワードハッシュ | バッファ | ユーザーのハッシュ化されたパスワードを表すバイトのバッファー。パスワード ハッシュを使用してユーザーをインポートする場合は、このハッシュの生成に使用されるハッシュ アルゴリズムを識別するためにUserImportOptionsを指定する必要があります。 |
パスワード塩 | バッファ | ユーザーのパスワードソルトを表すバイトのバッファー。 |
電話番号 | 弦 | ユーザーの主電話番号 (設定されている場合)。 |
写真URL | 弦 | ユーザーの写真の URL。 |
プロバイダーデータ | ユーザープロバイダーリクエスト[] | ユーザーにリンクされたプロバイダーの配列 (Google、Facebook など)。 |
テナントID | 弦 | ユーザーがインポートされるテナントの識別子。 admin.auth.Auth コンテキストで指定されない場合、ユーザーはデフォルトの親プロジェクトにアップロードされます。 admin.auth.TenantAwareAuth コンテキストで指定されていない場合、ユーザーは、そのTenantAwareAuth インスタンスのテナント ID に対応するテナントにアップロードされます。 |
UID | 弦 | ユーザーのuid 。 |
UserImportRecord.customClaims
ユーザーのカスタム クレーム オブジェクト (利用可能な場合)。通常はユーザー ロールの定義に使用され、認証されたユーザーの ID トークンに伝播されます。
サイン:
customClaims?: {
[key: string]: any;
};
UserImportRecord.disabled
ユーザーが無効かどうか: 無効の場合はtrue
。有効の場合はfalse
。
サイン:
disabled?: boolean;
UserImportRecord.displayName
ユーザーの表示名。
サイン:
displayName?: string;
UserImportRecord.email
ユーザーのプライマリ電子メール (設定されている場合)。
サイン:
email?: string;
UserImportRecord.email検証済み
ユーザーのプライマリ電子メールが検証されているかどうか。
サイン:
emailVerified?: boolean;
UserImportRecord.metadata
ユーザーに関する追加のメタデータ。
サイン:
metadata?: UserMetadataRequest;
UserImportRecord.multiFactor
ユーザーの多要素関連プロパティ。
サイン:
multiFactor?: MultiFactorUpdateSettings;
UserImportRecord.passwordHash
ユーザーのハッシュ化されたパスワードを表すバイトのバッファー。パスワード ハッシュを使用してユーザーをインポートする場合は、このハッシュの生成に使用されるハッシュ アルゴリズムを識別するためにUserImportOptionsを指定する必要があります。
サイン:
passwordHash?: Buffer;
UserImportRecord.passwordSalt
ユーザーのパスワードソルトを表すバイトのバッファー。
サイン:
passwordSalt?: Buffer;
UserImportRecord.phoneNumber
ユーザーの主電話番号 (設定されている場合)。
サイン:
phoneNumber?: string;
UserImportRecord.photoURL
ユーザーの写真の URL。
サイン:
photoURL?: string;
UserImportRecord.providerData
ユーザーにリンクされたプロバイダーの配列 (Google、Facebook など)。
サイン:
providerData?: UserProviderRequest[];
UserImportRecord.tenantId
ユーザーがインポートされるテナントの識別子。 admin.auth.Auth
コンテキストで指定されない場合、ユーザーはデフォルトの親プロジェクトにアップロードされます。 admin.auth.TenantAwareAuth
コンテキストで指定されていない場合、ユーザーは、そのTenantAwareAuth
インスタンスのテナント ID に対応するテナントにアップロードされます。
サイン:
tenantId?: string;
UserImportRecord.uid
ユーザーのuid
。
サイン:
uid: string;