user

Returns the specified User object.

Access is permitted when any of the following condition(s) are met: 1. The specified object is the signed-in User. 2. The signed-in User has any of the following permissions for the associated Organization: [org_admin_users, org_view_users]. 3. The signed-in User has any of the following permissions for the associated Organization: [org_admin_customer_permissions, org_manage_customers, org_view_customers]. 4. The signed-in User has any of the following permissions for the object's 'customer' attribute: [customer_admin_users, customer_view_users].

Input fields#

ArgumentTypeDescription
idID!The ID of the User object.

Return fields (User)#

id (ID!)#

The ID of the object.

avatarUrl (String!)#

The URL for the avatar image.

email (String!)#

The email address associated with the User.

org (Organization)#

The Organization that the User belongs to, if any. If this is NULL then Customer will be specified.

customer (Customer)#

The Customer the user belongs to, if any. If this is NULL then Organization will be specified.

name (String!)#

The user's preferred name.

phone (String!)#

The preferred contact phone number for the User.

dateJoined (DateTime!)#

The date the User was created.

darkMode (Boolean!)#

Designates whether the User has dark mode activated or not.

darkModeSyncWithOs (Boolean!)#

Designates whether dark mode should be derived from the operating system.

featureFlags (SafeJSONString)#
allowChangeRoles (Boolean!)#

Specifies whether the signed-in User can change the Role of the User.

role (Role!)#

The Role associated with the User which determines its permissions.

appAvatarUrl (String!)#

The URL for the main avatar image that is displayed in Prismatic.

appName (String!)#

The app name displayed in Prismatic.

allowUpdate (Boolean!)#

Specifies whether the signed-in User can update the User.

allowRemove (Boolean!)#

Specifies whether the signed-in User can remove the User.