UserImportRecord class

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

Constructors

UserImportRecord({required String uid, String? email, bool? emailVerified, String? displayName, String? phoneNumber, String? photoURL, bool? disabled, UserMetadataRequest? metadata, List<UserProviderRequest>? providerData, Map<String, Object?>? customClaims, Uint8List? passwordHash, Uint8List? passwordSalt, String? tenantId, MultiFactorUpdateSettings? multiFactor})

Properties

customClaims → Map<String, Object?>?
The user's custom claims object if available, typically used to define user roles and propagated to an authenticated user's ID token.
final
disabled → bool?
Whether or not the user is disabled: true for disabled; false for enabled.
final
displayName → String?
The user's display name.
final
email → String?
The user's primary email, if set.
final
emailVerified → bool?
Whether or not the user's primary email is verified.
final
hashCode → int
The hash code for this object.
no setterinherited
metadata → UserMetadataRequest?
Additional metadata about the user.
final
multiFactor → MultiFactorUpdateSettings?
The user's multi-factor related properties.
final
passwordHash → Uint8List?
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.
final
passwordSalt → Uint8List?
The buffer of bytes representing the user's password salt.
final
phoneNumber → String?
The user's primary phone number, if set.
final
photoURL → String?
The user's photo URL.
final
providerData → List<UserProviderRequest>?
An array of providers (for example, Google, Facebook) linked to the user.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tenantId → String?
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.
final
uid → String
The user's uid.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited