User

@firecms/core

---

@firecms/core / User

Type Alias: User

User = object

Defined in: types/user.ts:13

This interface represents a user. It has some of the same fields as a Firebase User. Note that in the default implementation, we simply take the Firebase user and use it as a FireCMS user, so that means that even if they are not mapped in this interface, it contains all the methods of the former, such as delete, getIdToken, etc.

Properties

displayName

readonly displayName: string | null

Defined in: types/user.ts:21

The display name of the user.

---

email

readonly email: string | null

Defined in: types/user.ts:25

The email of the user.

---

getIdToken()?

optional getIdToken: (forceRefresh?) => Promise<string>

Defined in: types/user.ts:44

Parameters

forceRefresh?

boolean

Returns

Promise<string>

---

isAnonymous

readonly isAnonymous: boolean

Defined in: types/user.ts:37

---

photoURL

readonly photoURL: string | null

Defined in: types/user.ts:29

The profile photo URL of the user.

---

providerId

readonly providerId: string

Defined in: types/user.ts:33

The provider used to authenticate the user.

---

roles?

optional roles: Role[]

Defined in: types/user.ts:42

Custom roles assigned to the user.

---

uid

readonly uid: string

Defined in: types/user.ts:17

The user’s unique ID, scoped to the project.