Skip to main content

AdminNavigationResponse

$schemauri

A URL to the JSON Schema for this object.

Example: https://example.com/schemas/AdminNavigationResponse.json
realms object[]required

Full unfiltered nav tree grouped by realm → section

  • Array [
  • keystringrequired
    labelstringrequired
    sections object[]required
  • Array [
  • items object[]required
  • Array [
  • activebooleanrequired
    childrenundefined[]nullable
    configSatisfiedbooleanrequired

    Whether the RequiresConfig gate is currently truthy

    declaredOrderint64required

    Sibling index as declared in the module's NavItems()

    effectiveOrderint64required

    Sibling index after applying persisted overrides

    groupstring

    Legacy v1 group label

    iconstring

    Icon identifier

    itemKeystringrequired

    Stable identifier; persisted overrides reference this

    minRolestring

    Lowest system role that sees this item

    moduleEnabledbooleanrequired

    Whether the owning module is enabled right now

    moduleNamestringrequired

    Owning module

    namestringrequired

    Display name

    overriddenbooleanrequired

    True when EffectiveOrder differs from DeclaredOrder

    pathstring

    Route the item navigates to

    realmstring
    requiresConfigstring

    Module config key that must be truthy for this item to appear

    sectionstring
    tierstring

    internal | external | '' (both)

    visibility object

    Effective visibility per role, split by tenant kind

    property name* NavRoleVisibility
    external objectrequired
    reasonstring

    Why hidden: module_disabled | config_off | tier_mismatch | role_below_min | parent_collapsed

    visiblebooleanrequired
    internal objectrequired
    reasonstring

    Why hidden: module_disabled | config_off | tier_mismatch | role_below_min | parent_collapsed

    visiblebooleanrequired
  • ]
  • labelstringrequired
  • ]
  • ]
  • realmsOverriddenbooleanrequired

    True when a persisted override changed the realm order

    realmsParentKeystringrequired

    Synthetic parentKey for reordering the realm cards

    rolesstring[]nullablerequired

    System role hierarchy, highest privilege first

    tenantKindsstring[]nullablerequired

    Tenant-kind values used by Tier filtering

    AdminNavigationResponse
    {
    "$schema": "https://example.com/schemas/AdminNavigationResponse.json",
    "realms": "Unknown Type: array,null",
    "realmsOverridden": true,
    "realmsParentKey": "string",
    "roles": "Unknown Type: array,null",
    "tenantKinds": "Unknown Type: array,null"
    }