AdminUserPreference

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.

type AdminUserPreference {
  id: ID!
  type: String!
  key: String!
  value: JSONObject!
  createdAt: DateTime!
  lastModifiedAt: DateTime!
  scope: AdminUserPreferenceScope!
  adminUser: AdminUser!
}

Fields

AdminUserPreference.id ● ID! non-null scalar

Unique identifier of the preference.

AdminUserPreference.type ● String! non-null scalar

The kind of preference, defined by the client. For example 'dataTable' for table column layouts or 'theme' for the colour theme.

AdminUserPreference.key ● String! non-null scalar

Identifies one preference within its type. For example the name of the table a 'dataTable' preference belongs to. Together with the type and the scope it is unique per admin user.

AdminUserPreference.value ● JSONObject! non-null scalar

The stored preference. A JSON object whose shape is owned by the client that stores it.

AdminUserPreference.createdAt ● DateTime! non-null scalar

Timestamp when the preference was created.

AdminUserPreference.lastModifiedAt ● DateTime! non-null scalar

Timestamp when the preference was last modified.

AdminUserPreference.scope ● AdminUserPreferenceScope! non-null enum

Whether the preference applies in every tenant (GLOBAL) or only in the tenant it was created in (TENANT).

AdminUserPreference.adminUser ● AdminUser! non-null object

The administrative user the preference belongs to.

Returned By

adminUserPreference query ● adminUserPreferenceCreate mutation ● adminUserPreferenceUpdate mutation

Member Of

AdminUserPreferenceResponse object