Skip to main content
Version: 57.2.0

AdminConfig

Properties​

actions?​

optional actions?: AdminAction[]

adminAccess?​

optional adminAccess?: AdminAccessConfig

Fine-grained admin RBAC and optional ownership/custom authorization.

adminFilter?​

optional adminFilter?: (req) => Record<string, unknown> | Promise<Record<string, unknown>>

Parameters​

req​

Request

Returns​

Record<string, unknown> | Promise<Record<string, unknown>>

adminPermissions?​

optional adminPermissions?: Partial<{ create: PermissionMethod<unknown>[]; delete: PermissionMethod<unknown>[]; list: PermissionMethod<unknown>[]; read: PermissionMethod<unknown>[]; update: PermissionMethod<unknown>[]; }>

autocompleteFields?​

optional autocompleteFields?: string[]

bulkPatchAllowlist?​

optional bulkPatchAllowlist?: string[]

defaultSort?​

optional defaultSort?: string | string[]

displayName​

displayName: string

excludeFields?​

optional excludeFields?: string[]

fieldOrder?​

optional fieldOrder?: string[]

fieldOverrides?​

optional fieldOverrides?: Record<string, AdminFieldOverride>

fieldsets?​

optional fieldsets?: AdminFieldset[]

filters?​

optional filters?: AdminFilter[]

group?​

optional group?: string

hiddenFields?​

optional hiddenFields?: string[]

icon?​

optional icon?: string

includeDeleted?​

optional includeDeleted?: boolean

Forward-compat placeholder — no behavior in v1.

listDisplay?​

optional listDisplay?: string[]

optional listDisplayLinks?: string[]

listFields​

listFields: string[]

pageSize?​

optional pageSize?: number

readonlyFields?​

optional readonlyFields?: string[]

realtime?​

optional realtime?: boolean

When true, scrubbed admin:model.changed events fire after mutations (no socket transport).

recordTitleField?​

optional recordTitleField?: string

searchFields?​

optional searchFields?: string[]

sortableFields?​

optional sortableFields?: string[]