Skip to main content

adminUserPreference

Retrieve one preference of an administrative user.

Returns the preference when it belongs to the authenticated admin user and is either global or scoped to the tenant of the request. With a role, the preference of any admin user can be retrieved.

Possible errors:

  • ADMIN_USER_PREFERENCE_NOT_FOUND_ERROR: No such preference, or it belongs to another admin user
  • ADMIN_USER_PREFERENCE_AUTH_ERROR: The request neither identifies an admin user nor carries a role
  • ADMIN_USER_PREFERENCE_GET_ERROR: Error occurred while retrieving the preference

AUTH: Role=[user.OWNER,user.EDITOR,user.VIEWER] OR ('user is authenticated')

adminUserPreference(
  id: ID!
): AdminUserPreference!

Arguments​

adminUserPreference.id ● ID! non-null scalar​

Unique identifier of the preference to retrieve.

Type​

AdminUserPreference object​

A single preference of an administrative user, such as the column layout of one table or the chosen theme. The value is opaque to the platform: its shape is owned by the client that stores it.