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