Type Alias: User
User:
object
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.
Type declaration​
displayName​
readonly
displayName:string
|null
The display name of the user.
email​
readonly
email:string
|null
The email of the user.
getIdToken()?​
optional
getIdToken: (forceRefresh
?) =>Promise
<string
>
Parameters​
• forceRefresh?: boolean
Returns​
Promise
<string
>
isAnonymous​
readonly
isAnonymous:boolean
photoURL​
readonly
photoURL:string
|null
The profile photo URL of the user.
providerId​
readonly
providerId:string
The provider used to authenticate the user.
roles?​
optional
roles:Role
[]
uid​
readonly
uid:string
The user's unique ID, scoped to the project.