NavResponse

The response body for the nav operation containing the menu structure and related info for the current user.

auth object

The authentication status of the current user.

abilitiesstring[]

The list of abilities of the current user. These are internal IDs of abilities. Abilities are granted to users via roles.

Example: ["userdel","accruals_del","admin"]

expiresnumber

The expiration time of the current user's session token as a Unix timestamp.

Example: 1728605420.527636

expiresSecondsinteger

The number of seconds until the current user's session token expires.

Example: 102000

groupsstring[]

The list of group IDs of the current user.

Example: ["5088C427E8B64EBEBE1C5B5961DB1902","3553F715A6F54DAB95D0D25B08468195"]

roles object[]

The list of roles of the current user.

Array [

idstring

Example: 1A40D7570AF94AFDB286D0697DEA5CF3

namestring

Example: Administrator

descriptionstring

Example: Access to the entire system.

]

userIdstring

The unique identifier for the current user.

classicHelpURLstring

The URL for the classic help system.

labelsobject

The UI Feature Labels for the current user, e.g., customized labels for things like Projects and Pay Types.

menu object[]

The navigation menu structure for the current user.

Array [

childrenobject[]

The child menu items for the current menu item.

labelstring

The label for the current menu item.

namestring

The internal menu item ID of the current menu item.

spaboolean

Whether the menu item is part of the single-page application. If False, the menu item is a link to a "classic" CGI page.

urluri

The URL for the current menu item.

openInNewWindow object

If this is present, the menu link should open in a new window.

featuresstring

The window features string for the new window.

targetstring

The target for the new window.

]

siteobject

General site settings.

ssoEnabledboolean

Whether single sign-on is enabled.

ssoTypestring

The type of single sign-on in use.

telemetry_configobject

The telemetry configuration for the current user.

uiPrefsobject

The UI preferences for the current user.

user object

Information about the current user.

emailstring

The email address of the current user.

Example: john_doe@example.com

firstNamestring

The first name of the current user.

Example: John

lastNamestring

The last name of the current user.

Example: Doe

fullNamestring

The full name (first and last) of the current user.

Example: John Doe

userIdstring

The unique identifier for the current user.

Example: 1A40D7570AF94AFDB286D0697DEA5CF3

usernamestring

The username (login ID) of the current user.

Example: john_doe@example.com

NavResponse

{
  "auth": {
    "abilities": [
      "userdel",
      "accruals_del",
      "admin"
    ],
    "expires": 1728605420.527636,
    "expiresSeconds": 102000,
    "groups": [
      "5088C427E8B64EBEBE1C5B5961DB1902",
      "3553F715A6F54DAB95D0D25B08468195"
    ],
    "roles": [
      {
        "id": "1A40D7570AF94AFDB286D0697DEA5CF3",
        "name": "Administrator",
        "description": "Access to the entire system."
      }
    ],
    "userId": "string"
  },
  "classicHelpURL": "string",
  "labels": {},
  "menu": [
    {
      "children": [
        {}
      ],
      "label": "string",
      "name": "string",
      "spa": true,
      "url": "string",
      "openInNewWindow": {
        "features": "string",
        "target": "string"
      }
    }
  ],
  "site": {},
  "ssoEnabled": true,
  "ssoType": "string",
  "telemetry_config": {},
  "uiPrefs": {},
  "user": {
    "email": "john_doe@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "fullName": "John Doe",
    "userId": "1A40D7570AF94AFDB286D0697DEA5CF3",
    "username": "john_doe@example.com"
  }
}