cloudfire-auth / UserRecord

Interface: UserRecord

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

Represents a user.

Properties

customClaims?

readonly optional customClaims: object

Defined in: types/firebase-admin/user-record.ts:271

The user's custom claims object if available, typically used to define user roles and propagated to an authenticated user's ID token. This is set via CloudFireAuth.setCustomUserClaims

Index Signature

[key: string]: any

---

disabled

readonly disabled: boolean

Defined in: types/firebase-admin/user-record.ts:240

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

---

displayName?

readonly optional displayName: string

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

The user's display name.

---

email?

readonly optional email: string

Defined in: types/firebase-admin/user-record.ts:219

The user's primary email, if set.

---

emailVerified

readonly emailVerified: boolean

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

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

---

metadata

readonly metadata: UserMetadata

Defined in: types/firebase-admin/user-record.ts:244

Additional metadata about the user.

---

multiFactor?

readonly optional multiFactor: MultiFactorSettings

Defined in: types/firebase-admin/user-record.ts:289

The multi-factor related properties for the current user, if available.

---

passwordHash?

readonly optional passwordHash: string

Defined in: types/firebase-admin/user-record.ts:257

The user's hashed password (base64-encoded), only if Firebase Auth hashing algorithm (SCRYPT) is used. If a different hashing algorithm had been used when uploading this user, as is typical when migrating from another Auth system, this will be an empty string. If no password is set, this is null. This is only available when the user is obtained from CloudFireAuth.listUsers.

---

passwordSalt?

readonly optional passwordSalt: string

Defined in: types/firebase-admin/user-record.ts:265

The user's password salt (base64-encoded), only if Firebase Auth hashing algorithm (SCRYPT) is used. If a different hashing algorithm had been used to upload this user, typical when migrating from another Auth system, this will be an empty string. If no password is set, this is null. This is only available when the user is obtained from CloudFireAuth.listUsers.

---

phoneNumber?

readonly optional phoneNumber: string

Defined in: types/firebase-admin/user-record.ts:235

The user's primary phone number, if set.

---

photoURL?

readonly optional photoURL: string

Defined in: types/firebase-admin/user-record.ts:231

The user's photo URL.

---

providerData

readonly providerData: UserInfo[]

Defined in: types/firebase-admin/user-record.ts:248

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

---

tenantId?

readonly optional tenantId: string | null

Defined in: types/firebase-admin/user-record.ts:277

The ID of the tenant the user belongs to, if available.

---

tokensValidAfterTime?

readonly optional tokensValidAfterTime: string

Defined in: types/firebase-admin/user-record.ts:285

The date the user's tokens are valid after, formatted as a UTC string. This is updated every time the user's refresh token are revoked either from the CloudFireAuth.revokeRefreshTokens API or from the Firebase Auth backend on big account changes (password resets, password or email updates, etc).

---

uid

readonly uid: string

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

The user's uid.

Methods

toJSON()

toJSON(): object

Defined in: types/firebase-admin/user-record.ts:295

Returns a JSON-serializable representation of this object.

Returns

object

A JSON-serializable representation of this object.