cloudfire-auth / UserImportRecord

Interface: UserImportRecord

Defined in: types/firebase-admin/user-import.ts:160

Interface representing a user to import to Firebase Auth via the CloudFireAuth.importUsers method.

Properties

customClaims?

optional customClaims: object

Defined in: types/firebase-admin/user-import.ts:202

The user's custom claims object if available, typically used to define user roles and propagated to an authenticated user's ID token.

Index Signature

[key: string]: any

---

disabled?

optional disabled: boolean

Defined in: types/firebase-admin/user-import.ts:189

Whether or not the user is disabled: true for disabled; false for enabled.

---

displayName?

optional displayName: string

Defined in: types/firebase-admin/user-import.ts:176

The user's display name.

---

email?

optional email: string

Defined in: types/firebase-admin/user-import.ts:168

The user's primary email, if set.

---

emailVerified?

optional emailVerified: boolean

Defined in: types/firebase-admin/user-import.ts:172

Whether or not the user's primary email is verified.

---

metadata?

optional metadata: UserMetadataRequest

Defined in: types/firebase-admin/user-import.ts:193

Additional metadata about the user.

---

multiFactor?

optional multiFactor: MultiFactorUpdateSettings

Defined in: types/firebase-admin/user-import.ts:227

The user's multi-factor related properties.

---

passwordHash?

optional passwordHash: Uint8Array<ArrayBufferLike>

Defined in: types/firebase-admin/user-import.ts:211

The buffer of bytes representing the user's hashed password. When a user is to be imported with a password hash, UserImportOptions are required to be specified to identify the hashing algorithm used to generate this hash.

---

passwordSalt?

optional passwordSalt: Uint8Array<ArrayBufferLike>

Defined in: types/firebase-admin/user-import.ts:215

The buffer of bytes representing the user's password salt.

---

phoneNumber?

optional phoneNumber: string

Defined in: types/firebase-admin/user-import.ts:180

The user's primary phone number, if set.

---

photoURL?

optional photoURL: string

Defined in: types/firebase-admin/user-import.ts:184

The user's photo URL.

---

providerData?

optional providerData: UserProviderRequest[]

Defined in: types/firebase-admin/user-import.ts:197

An array of providers (for example, Google, Facebook) linked to the user.

---

tenantId?

optional tenantId: string

Defined in: types/firebase-admin/user-import.ts:223

The identifier of the tenant where user is to be imported to. When not provided in an admin.auth.Auth context, the user is uploaded to the default parent project. When not provided in an admin.auth.TenantAwareAuth context, the user is uploaded to the tenant corresponding to that TenantAwareAuth instance's tenant ID.

---

uid

uid: string

Defined in: types/firebase-admin/user-import.ts:164

The user's uid.