Skip to content

App shell navigation data​

GET
/api/navigation

Returns navbar links, pending access request notifications, and locked user alerts for the authenticated user. Used by the SPA app shell on every page load after authentication.

Authorizations​

cookieAuth
Type
API Key (cookie: _vulcan_session)
or
tokenAuth

Personal access token authentication. Send via Authorization header: Authorization: Token vulcan_xxx. Tokens are SHA-256 hashed server-side (never stored in plaintext). Scopes: read (GET), write (mutations), admin (everything). Create tokens via Settings → API Tokens in the web UI.

Type
HTTP (token)

Responses​

Navigation data for app shell

application/json
JSON
{
  
"nav_links": [
  
  
{
  
  
  
"icon": "folder2-open",
  
  
  
"name": "Projects",
  
  
  
"link": "/projects"
  
  
},
  
  
{
  
  
  
"icon": "patch-check-fill",
  
  
  
"name": "Released Components",
  
  
  
"link": "/components"
  
  
}
  
],
  
"access_requests": [
  
  
{
  
  
  
"id": 1,
  
  
  
"user": {
  
  
  
  
"id": 42,
  
  
  
  
"name": "Jane Doe",
  
  
  
  
"email": "jane@example.com"
  
  
  
},
  
  
  
"project": {
  
  
  
  
"id": 7,
  
  
  
  
"name": "RHEL 9 STIG"
  
  
  
}
  
  
}
  
],
  
"locked_users": [
  
  
{
  
  
  
"id": 99,
  
  
  
"name": "Locked User",
  
  
  
"email": "locked@example.com"
  
  
}
  
]
}

Playground​

Authorization

Samples​

Powered by VitePress OpenAPI

Part of the MITRE Security Automation Framework (SAF)