Skip to main content

AdminUserPreferenceCreateInput

Input for creating a preference of an administrative user.

input AdminUserPreferenceCreateInput {
  adminUserId: Int
  type: String!
  key: String!
  scope: AdminUserPreferenceScope!
  value: JSONObject!
}

Fields​

AdminUserPreferenceCreateInput.adminUserId ● Int scalar​

Identifier of the administrative user the preference is created for. Defaults to the authenticated admin user. Creating a preference for another admin user requires a role.

AdminUserPreferenceCreateInput.type ● String! non-null scalar​

The kind of preference, defined by the client. For example 'dataTable' for table column layouts. Between 1 and 64 characters.

AdminUserPreferenceCreateInput.key ● String! non-null scalar​

Identifies one preference within its type, for example the name of a table. Must not be empty. Between 1 and 128 characters.

AdminUserPreferenceCreateInput.scope ● AdminUserPreferenceScope! non-null enum​

Whether the preference applies in every tenant (GLOBAL) or only in the tenant of this request (TENANT). Cannot be changed afterwards.

AdminUserPreferenceCreateInput.value ● JSONObject! non-null scalar​

The preference to store. Must be a JSON object of at most 32 KB when serialized.

Member Of​

adminUserPreferenceCreate mutation