Trojai Authentication

generated: '2026-07-21'
method: searched
source: https://docs.troj.ai/reference/eng-api
docs: https://docs.troj.ai/reference/eng-api
summary:
  types: [apiKey]
  api_key_in: [header]
  oauth2_flows: []
  notes: >-
    The TrojAI platform is self-hosted / single-tenant (Cloud or Enterprise),
    so the API host is per-deployment (https://<your_trojai_host>). The platform
    API and the Firewall Proxy API use two distinct header-based keys. Platform
    user identity is backed by Keycloak (upgraded to Keycloak 26 in v2.17.0);
    rotating the identity provider invalidates existing API keys, which must be
    regenerated.
schemes:
  - name: platform-api-key
    type: apiKey
    in: header
    parameter: x-trojai-api-key
    applies_to: Platform API (/api/v2 endpoints)
    description: >-
      Raw API key generated in the web application (profile menu > API Keys >
      Generate API Key). Sent verbatim in the x-trojai-api-key header, NOT
      prefixed with "Bearer". Shown only once at creation. Authenticates
      management calls (users, datasets, models, firewall configs, firewall
      events, red team jobs/results, secrets).
    source: https://docs.troj.ai/reference/eng-api
  - name: firewall-proxy-client-id
    type: apiKey
    in: header
    parameter: x-eag-clientid
    applies_to: Firewall Proxy API (TrojAI Defend)
    description: >-
      Client-ID header used by the Defend Firewall Proxy API to select which
      firewall policy applies to a proxied request. Distinct from the platform
      x-trojai-api-key.
    source: https://docs.troj.ai/trojai-defend/eng-proxy-api