Skip to main content

NavigationResponse

$schemauri

A URL to the JSON Schema for this object.

Example: https://example.com/schemas/NavigationResponse.json
cacheKeystringrequired

Cache invalidation key

expiresInint64required

Cache TTL in seconds

groups object[]required

Navigation route groups (v1, deprecated)

  • Array [
  • children object[]required

    Navigation items in this group

  • Array [
  • activebooleanrequired

    Whether the item is active/enabled

    badge object

    Optional badge to display

    textstringrequired

    Badge display text

    typestringrequired

    Badge type (success, warning, danger, info, etc.)

    childrenundefined[]nullable

    Nested navigation items

    exactboolean

    Require exact path match for active state

    icon

    Icon identifier (string or array for FontAwesome)

    labelstring

    Additional label text

    namestringrequired

    Display name of the navigation item

    newtabboolean

    Open link in new tab

    tostring

    Route path for navigation

  • ]
  • labelstringrequired

    Group label displayed in navigation

    labelDisableboolean

    Hide the group label

  • ]
  • realms object[]required

    Navigation grouped by realm → section (v2)

  • Array [
  • keystringrequired

    Realm key (personal | platform | business | shared)

    labelstringrequired

    Realm display label

    sections object[]required

    Sections within this realm, in display order

  • Array [
  • children object[]required

    Navigation items in this section

  • Array [
  • activebooleanrequired

    Whether the item is active/enabled

    badge object

    Optional badge to display

    textstringrequired

    Badge display text

    typestringrequired

    Badge type (success, warning, danger, info, etc.)

    childrenundefined[]nullable

    Nested navigation items

    exactboolean

    Require exact path match for active state

    icon

    Icon identifier (string or array for FontAwesome)

    labelstring

    Additional label text

    namestringrequired

    Display name of the navigation item

    newtabboolean

    Open link in new tab

    tostring

    Route path for navigation

  • ]
  • labelstringrequired

    Section label displayed under the realm header

  • ]
  • ]
  • tenantKindstring

    Current tenant kind: internal | external | ''

    userRolestringrequired

    Current user's system role

    NavigationResponse
    {
    "$schema": "https://example.com/schemas/NavigationResponse.json",
    "cacheKey": "string",
    "expiresIn": 0,
    "groups": "Unknown Type: array,null",
    "realms": "Unknown Type: array,null",
    "tenantKind": "string",
    "userRole": "string"
    }