API Reference — subpackage_auth

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_auth
  description: 'API Reference — subpackage_auth. 2 operations. Lead operation: Obtain the publishable key for a specific environment.
    Self-contained Naftiko capability covering one Flatfile business surface.'
  tags:
  - Flatfile
  - subpackage_auth
  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-auth
    baseUri: https://api.x.flatfile.com/v1
    description: API Reference — subpackage_auth business capability. Self-contained, no shared references.
    resources:
    - name: auth-publishable-key
      path: /auth/publishable-key
      operations:
      - name: getpublishablekey
        method: GET
        description: Obtain the publishable key for a specific environment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: environmentId
          in: query
          type: string
          description: ID of environment to search
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
    - name: auth-sftp-credentials
      path: /auth/sftp-credentials
      operations:
      - name: getsftpcredentials
        method: GET
        description: Get SFTP credentials for Space
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: spaceId
          in: query
          type: string
          description: ID of space to get credentials for
          required: true
        - 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-auth-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_auth. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/auth/publishable-key
      name: auth-publishable-key
      description: REST surface for auth-publishable-key.
      operations:
      - method: GET
        name: getpublishablekey
        description: Obtain the publishable key for a specific environment
        call: flatfile-subpackage-auth.getpublishablekey
        with:
          environmentId: rest.environmentId
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/auth/sftp-credentials
      name: auth-sftp-credentials
      description: REST surface for auth-sftp-credentials.
      operations:
      - method: GET
        name: getsftpcredentials
        description: Get SFTP credentials for Space
        call: flatfile-subpackage-auth.getsftpcredentials
        with:
          spaceId: rest.spaceId
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: flatfile-subpackage-auth-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_auth. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: obtain-publishable-key-specific-environment
      description: Obtain the publishable key for a specific environment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: flatfile-subpackage-auth.getpublishablekey
      with:
        environmentId: tools.environmentId
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.
    - name: get-sftp-credentials-space
      description: Get SFTP credentials for Space
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: flatfile-subpackage-auth.getsftpcredentials
      with:
        spaceId: tools.spaceId
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.