naftiko: 1.0.0-alpha2
info:
  label: Frontegg Audits API
  description: 'Frontegg Audits API capability. 8 operations. Lead operation: Get audits. Self-contained Naftiko capability for the Frontegg Frontegg Audits business surface.'
  tags:
  - Frontegg
  - Audits
  created: '2026-05-22'
  modified: '2026-05-22'
binds:
- namespace: env
  keys:
    FRONTEGG_CLIENT_ID: FRONTEGG_CLIENT_ID
    FRONTEGG_API_KEY: FRONTEGG_API_KEY
    FRONTEGG_BEARER_TOKEN: FRONTEGG_BEARER_TOKEN
capability:
  consumes:
  - type: http
    namespace: frontegg-audits
    baseUri: https://api.frontegg.com/audits
    description: Frontegg Audits API. Bearer JWT (environment or user token) authentication.
    resources:
    - name: root
      path: /
      operations:
      - name: AuditsController_getAudits
        method: GET
        description: Get audits
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: vendorId
          in: query
          type: string
          description: ''
          required: true
        - name: tenantId
          in: query
          type: string
          description: ''
          required: true
        - name: limit
          in: query
          type: number
          description: ''
          required: false
        - name: offset
          in: query
          type: number
          description: ''
          required: true
        - name: count
          in: query
          type: number
          description: ''
          required: true
        - name: paginationMode
          in: query
          type: string
          description: ''
          required: false
        - name: filter
          in: query
          type: string
          description: ''
          required: false
        - name: sortBy
          in: query
          type: string
          description: ''
          required: false
        - name: sortDirection
          in: query
          type: string
          description: ''
          required: false
        - name: frontegg-tenant-id
          in: header
          type: string
          description: The account (tenant) ID identifier
          required: false
      - name: AuditsController_addAudits
        method: POST
        description: Add audits
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: frontegg-tenant-id
          in: header
          type: string
          description: The account (tenant) ID identifier
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: stats
      path: /stats
      operations:
      - name: AuditsController_getAuditsStats
        method: GET
        description: Get audits statistics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: frontegg-tenant-id
          in: header
          type: string
          description: The account (tenant) ID identifier
          required: true
    - name: export-csv
      path: /export/csv
      operations:
      - name: AuditsController_exportCsv
        method: POST
        description: Export CSV
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: vendorId
          in: query
          type: string
          description: ''
          required: true
        - name: tenantId
          in: query
          type: string
          description: ''
          required: true
        - name: limit
          in: query
          type: number
          description: ''
          required: false
        - name: offset
          in: query
          type: number
          description: ''
          required: true
        - name: count
          in: query
          type: number
          description: ''
          required: true
        - name: paginationMode
          in: query
          type: string
          description: ''
          required: false
        - name: filter
          in: query
          type: string
          description: ''
          required: false
        - name: sortBy
          in: query
          type: string
          description: ''
          required: false
        - name: sortDirection
          in: query
          type: string
          description: ''
          required: false
        - name: frontegg-tenant-id
          in: header
          type: string
          description: The account (tenant) ID identifier
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: export-csv-v2
      path: /export/csv/v2
      operations:
      - name: AuditsController_exportCsvToStream
        method: POST
        description: Export CSV to stream
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: vendorId
          in: query
          type: string
          description: ''
          required: true
        - name: tenantId
          in: query
          type: string
          description: ''
          required: true
        - name: limit
          in: query
          type: number
          description: ''
          required: false
        - name: offset
          in: query
          type: number
          description: ''
          required: true
        - name: count
          in: query
          type: number
          description: ''
          required: true
        - name: paginationMode
          in: query
          type: string
          description: ''
          required: false
        - name: filter
          in: query
          type: string
          description: ''
          required: false
        - name: sortBy
          in: query
          type: string
          description: ''
          required: false
        - name: sortDirection
          in: query
          type: string
          description: ''
          required: false
        - name: frontegg-tenant-id
          in: header
          type: string
          description: The account (tenant) ID identifier
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: resources-audits-v2
      path: /resources/audits/v2
      operations:
      - name: AuditsController_V2_getAudits
        method: GET
        description: Get audits (V2)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: created_from
          in: query
          type: string
          description: ''
          required: false
        - name: created_to
          in: query
          type: string
          description: ''
          required: false
        - name: tenant_ids
          in: query
          type: array
          description: ''
          required: false
        - name: users
          in: query
          type: array
          description: ''
          required: false
        - name: email
          in: query
          type: array
          description: ''
          required: false
        - name: count
          in: query
          type: number
          description: ''
          required: true
        - name: offset
          in: query
          type: number
          description: ''
          required: true
        - name: sortBy
          in: query
          type: string
          description: ''
          required: false
        - name: sortDirection
          in: query
          type: string
          description: ''
          required: false
        - name: filter
          in: query
          type: string
          description: ''
          required: false
        - name: featureFlagId
          in: query
          type: string
          description: ''
          required: false
        - name: frontegg-tenant-id
          in: header
          type: string
          description: The account (tenant) ID identifier
          required: false
    - name: resources-audits-v2-export-csv
      path: /resources/audits/v2/export/csv
      operations:
      - name: AuditsController_V2_exportCsvToStream
        method: POST
        description: Export CSV to stream (V2)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: created_from
          in: query
          type: string
          description: ''
          required: false
        - name: created_to
          in: query
          type: string
          description: ''
          required: false
        - name: tenant_ids
          in: query
          type: array
          description: ''
          required: false
        - name: users
          in: query
          type: array
          description: ''
          required: false
        - name: email
          in: query
          type: array
          description: ''
          required: false
        - name: count
          in: query
          type: number
          description: ''
          required: true
        - name: offset
          in: query
          type: number
          description: ''
          required: true
        - name: sortBy
          in: query
          type: string
          description: ''
          required: false
        - name: sortDirection
          in: query
          type: string
          description: ''
          required: false
        - name: filter
          in: query
          type: string
          description: ''
          required: false
        - name: featureFlagId
          in: query
          type: string
          description: ''
          required: false
        - name: frontegg-tenant-id
          in: header
          type: string
          description: The account (tenant) ID identifier
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: resources-metrics-v1
      path: /resources/metrics/v1
      operations:
      - name: MetricsController_getMetrics
        method: GET
        description: Get metrics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: from
          in: query
          type: number
          description: ''
          required: false
        - name: to
          in: query
          type: number
          description: ''
          required: false
        - name: limit
          in: query
          type: number
          description: ''
          required: false
        - name: frequency
          in: query
          type: number
          description: ''
          required: false
  exposes:
  - type: rest
    namespace: frontegg-audits-rest
    port: 8080
    description: REST adapter for Frontegg Audits. One resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/
      name: root
      description: REST surface for root.
      operations:
      - method: GET
        name: AuditsController_getAudits
        description: Get audits
        call: frontegg-audits.AuditsController_getAudits
        with:
          vendorId: rest.vendorId
          tenantId: rest.tenantId
          limit: rest.limit
          offset: rest.offset
          count: rest.count
          paginationMode: rest.paginationMode
          filter: rest.filter
          sortBy: rest.sortBy
          sortDirection: rest.sortDirection
          frontegg-tenant-id: rest.frontegg-tenant-id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/
      name: root
      description: REST surface for root.
      operations:
      - method: POST
        name: AuditsController_addAudits
        description: Add audits
        call: frontegg-audits.AuditsController_addAudits
        with:
          frontegg-tenant-id: rest.frontegg-tenant-id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/stats
      name: stats
      description: REST surface for stats.
      operations:
      - method: GET
        name: AuditsController_getAuditsStats
        description: Get audits statistics
        call: frontegg-audits.AuditsController_getAuditsStats
        with:
          frontegg-tenant-id: rest.frontegg-tenant-id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/export/csv
      name: export-csv
      description: REST surface for export-csv.
      operations:
      - method: POST
        name: AuditsController_exportCsv
        description: Export CSV
        call: frontegg-audits.AuditsController_exportCsv
        with:
          vendorId: rest.vendorId
          tenantId: rest.tenantId
          limit: rest.limit
          offset: rest.offset
          count: rest.count
          paginationMode: rest.paginationMode
          filter: rest.filter
          sortBy: rest.sortBy
          sortDirection: rest.sortDirection
          frontegg-tenant-id: rest.frontegg-tenant-id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/export/csv/v2
      name: export-csv-v2
      description: REST surface for export-csv-v2.
      operations:
      - method: POST
        name: AuditsController_exportCsvToStream
        description: Export CSV to stream
        call: frontegg-audits.AuditsController_exportCsvToStream
        with:
          vendorId: rest.vendorId
          tenantId: rest.tenantId
          limit: rest.limit
          offset: rest.offset
          count: rest.count
          paginationMode: rest.paginationMode
          filter: rest.filter
          sortBy: rest.sortBy
          sortDirection: rest.sortDirection
          frontegg-tenant-id: rest.frontegg-tenant-id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/resources/audits/v2
      name: resources-audits-v2
      description: REST surface for resources-audits-v2.
      operations:
      - method: GET
        name: AuditsController_V2_getAudits
        description: Get audits (V2)
        call: frontegg-audits.AuditsController_V2_getAudits
        with:
          created_from: rest.created_from
          created_to: rest.created_to
          tenant_ids: rest.tenant_ids
          users: rest.users
          email: rest.email
          count: rest.count
          offset: rest.offset
          sortBy: rest.sortBy
          sortDirection: rest.sortDirection
          filter: rest.filter
          featureFlagId: rest.featureFlagId
          frontegg-tenant-id: rest.frontegg-tenant-id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/resources/audits/v2/export/csv
      name: resources-audits-v2-export-csv
      description: REST surface for resources-audits-v2-export-csv.
      operations:
      - method: POST
        name: AuditsController_V2_exportCsvToStream
        description: Export CSV to stream (V2)
        call: frontegg-audits.AuditsController_V2_exportCsvToStream
        with:
          created_from: rest.created_from
          created_to: rest.created_to
          tenant_ids: rest.tenant_ids
          users: rest.users
          email: rest.email
          count: rest.count
          offset: rest.offset
          sortBy: rest.sortBy
          sortDirection: rest.sortDirection
          filter: rest.filter
          featureFlagId: rest.featureFlagId
          frontegg-tenant-id: rest.frontegg-tenant-id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/resources/metrics/v1
      name: resources-metrics-v1
      description: REST surface for resources-metrics-v1.
      operations:
      - method: GET
        name: MetricsController_getMetrics
        description: Get metrics
        call: frontegg-audits.MetricsController_getMetrics
        with:
          from: rest.from
          to: rest.to
          limit: rest.limit
          frequency: rest.frequency
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: frontegg-audits-mcp
    port: 9090
    transport: http
    description: MCP adapter for Frontegg Audits. One tool per consumed operation.
    tools:
    - name: frontegg-audits-auditscontroller-getaudits
      description: Get audits
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: frontegg-audits.AuditsController_getAudits
      with:
        vendorId: tools.vendorId
        tenantId: tools.tenantId
        limit: tools.limit
        offset: tools.offset
        count: tools.count
        paginationMode: tools.paginationMode
        filter: tools.filter
        sortBy: tools.sortBy
        sortDirection: tools.sortDirection
        frontegg-tenant-id: tools.frontegg-tenant-id
      outputParameters:
      - type: object
        mapping: $.
    - name: frontegg-audits-auditscontroller-addaudits
      description: Add audits
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: frontegg-audits.AuditsController_addAudits
      with:
        frontegg-tenant-id: tools.frontegg-tenant-id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: frontegg-audits-auditscontroller-getauditsstats
      description: Get audits statistics
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: frontegg-audits.AuditsController_getAuditsStats
      with:
        frontegg-tenant-id: tools.frontegg-tenant-id
      outputParameters:
      - type: object
        mapping: $.
    - name: frontegg-audits-auditscontroller-exportcsv
      description: Export CSV
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: frontegg-audits.AuditsController_exportCsv
      with:
        vendorId: tools.vendorId
        tenantId: tools.tenantId
        limit: tools.limit
        offset: tools.offset
        count: tools.count
        paginationMode: tools.paginationMode
        filter: tools.filter
        sortBy: tools.sortBy
        sortDirection: tools.sortDirection
        frontegg-tenant-id: tools.frontegg-tenant-id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: frontegg-audits-auditscontroller-exportcsvtostream
      description: Export CSV to stream
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: frontegg-audits.AuditsController_exportCsvToStream
      with:
        vendorId: tools.vendorId
        tenantId: tools.tenantId
        limit: tools.limit
        offset: tools.offset
        count: tools.count
        paginationMode: tools.paginationMode
        filter: tools.filter
        sortBy: tools.sortBy
        sortDirection: tools.sortDirection
        frontegg-tenant-id: tools.frontegg-tenant-id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: frontegg-audits-auditscontroller-v2-getaudits
      description: Get audits (V2)
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: frontegg-audits.AuditsController_V2_getAudits
      with:
        created_from: tools.created_from
        created_to: tools.created_to
        tenant_ids: tools.tenant_ids
        users: tools.users
        email: tools.email
        count: tools.count
        offset: tools.offset
        sortBy: tools.sortBy
        sortDirection: tools.sortDirection
        filter: tools.filter
        featureFlagId: tools.featureFlagId
        frontegg-tenant-id: tools.frontegg-tenant-id
      outputParameters:
      - type: object
        mapping: $.
    - name: frontegg-audits-auditscontroller-v2-exportcsvtostream
      description: Export CSV to stream (V2)
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: frontegg-audits.AuditsController_V2_exportCsvToStream
      with:
        created_from: tools.created_from
        created_to: tools.created_to
        tenant_ids: tools.tenant_ids
        users: tools.users
        email: tools.email
        count: tools.count
        offset: tools.offset
        sortBy: tools.sortBy
        sortDirection: tools.sortDirection
        filter: tools.filter
        featureFlagId: tools.featureFlagId
        frontegg-tenant-id: tools.frontegg-tenant-id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: frontegg-audits-metricscontroller-getmetrics
      description: Get metrics
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: frontegg-audits.MetricsController_getMetrics
      with:
        from: tools.from
        to: tools.to
        limit: tools.limit
        frequency: tools.frequency
      outputParameters:
      - type: object
        mapping: $.