Shopfront Developers
User
Object
User
Implements
List of interfaces this object implements
| Fields | Type | Description |
|---|---|---|
|
id |
The ID of the user |
|
|
name |
String! |
The name of the user |
|
settings |
The settings for this object |
|
|
username |
String! |
The username of the user (unique among non-deleted users for this Vendor) |
|
|
String |
The email for this user |
|
phone |
String |
The phone number for this user |
|
image |
String |
This user's profile image |
|
role |
This user's role or null if the user has no role (has all permissions) |
|
|
pendingPasswordReset |
Boolean! |
Whether the user has a pending password reset |
|
isApiUser |
Boolean! |
Determine if this is an API user or not |
|
isAdmin |
Boolean |
Whether this user is the Shopfront super user |
|
dashboard |
The user dashboard for this user |
|
|
quickMenu |
The list of the quick menu items for this user |
|
|
scopes |
[String!]! |
The scopes this user has (only applicable for API users) |
|
darkMode |
The theme for the user that will override the register's "Dark Mode" setting |
|
|
reportingAccess |
The Outlet's this user has access to for running reports via the Reporting API |
|
|
formFavourites |
The users favourite fields for edit pages |