SettingsStoreFieldConfig

name

The name of the field. This will be combined with the namespace to create the full key (e.g., 'dashboard.theme').

scope

Function that determines how this field should be scoped. Defaults to global scoping (no isolation).

readonly

Whether this field is readonly via the GraphQL API. Readonly fields can still be modified programmatically via a service.

requiresPermission

Permissions required to access this field. If not specified, basic authentication is required for admin API access.

Can be either:

• A single permission or array of permissions (applies to both read and write)
• An object with read and write properties for granular control

Example

// Single permission for both read and writerequiresPermission: Permission.UpdateSettings// Separate read and write permissionsrequiresPermission: {  read: Permission.ReadSettings,  write: Permission.UpdateSettings}// Using custom RwPermissionDefinitionrequiresPermission: {  read: dashboardSavedViews.Read,  write: dashboardSavedViews.Write}

validate

Custom validation function for field values.