Flatfile · Capability

API Reference — subpackage_roles

API Reference — subpackage_roles. 1 operations. Lead operation: List roles. Self-contained Naftiko capability covering one Flatfile business surface.

Run with Naftiko Flatfilesubpackage_roles

What You Can Do

GET
List — List roles
/v1/roles

MCP Tools

list-roles

List roles

read-only idempotent

Capability Spec

flatfile-subpackage-roles.yaml Raw ↑
naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_roles
  description: 'API Reference — subpackage_roles. 1 operations. Lead operation: List roles. Self-contained Naftiko capability
    covering one Flatfile business surface.'
  tags:
  - Flatfile
  - subpackage_roles
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FLATFILE_API_KEY: FLATFILE_API_KEY
capability:
  consumes:
  - type: http
    namespace: flatfile-subpackage-roles
    baseUri: https://api.x.flatfile.com/v1
    description: API Reference — subpackage_roles business capability. Self-contained, no shared references.
    resources:
    - name: roles
      path: /roles
      operations:
      - name: list
        method: GET
        description: List roles
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.FLATFILE_API_KEY}}'
  exposes:
  - type: rest
    namespace: flatfile-subpackage-roles-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_roles. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/roles
      name: roles
      description: REST surface for roles.
      operations:
      - method: GET
        name: list
        description: List roles
        call: flatfile-subpackage-roles.list
        with:
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: flatfile-subpackage-roles-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_roles. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-roles
      description: List roles
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: flatfile-subpackage-roles.list
      with:
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.