naftiko: 1.0.0-alpha2
info:
  label: FusionAuth API — API Key
  description: 'FusionAuth API — API Key. 6 operations. Lead operation: Retrieves an authentication API key for the given Id.. Self-contained Naftiko capability covering one business surface.'
  tags:
  - FusionAuth
  - API Key
  created: '2026-05-20'
  modified: '2026-05-20'
binds:
- namespace: env
  keys:
    FUSIONAUTH_API_KEY: FUSIONAUTH_API_KEY
capability:
  consumes:
  - type: http
    namespace: fusionauth-api-key
    baseUri: http://localhost:9011
    description: FusionAuth API — API Key business capability. Self-contained, no shared references.
    resources:
    - name: api-api-key
      path: /api/api-key
      operations:
      - name: createapikey
        method: POST
        description: Creates an API key. You can optionally specify a unique Id for the key, if not provided one will be generated. an API key can only be create
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-api-key-keyid
      path: /api/api-key/{keyId}
      operations:
      - name: createapikeywithid
        method: POST
        description: Creates an API key. You can optionally specify a unique Id for the key, if not provided one will be generated. an API key can only be create
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: keyId
          in: path
          type: string
          description: The unique Id of the API key. If not provided a secure random Id will be generated.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deleteapikeywithid
        method: DELETE
        description: Deletes the API key for the given Id.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: keyId
          in: path
          type: string
          description: The Id of the authentication API key to delete.
          required: true
      - name: patchapikeywithid
        method: PATCH
        description: Updates an API key with the given Id.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: keyId
          in: path
          type: string
          description: The Id of the API key. If not provided a secure random api key will be generated.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: retrieveapikeywithid
        method: GET
        description: Retrieves an authentication API key for the given Id.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: keyId
          in: path
          type: string
          description: The Id of the API key to retrieve.
          required: true
      - name: updateapikeywithid
        method: PUT
        description: Updates an API key with the given Id.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: keyId
          in: path
          type: string
          description: The Id of the API key to update.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
  exposes:
  - type: rest
    namespace: fusionauth-api-key-rest
    port: 8080
    description: REST adapter for FusionAuth API — API Key. One resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/api-key
      name: api-api-key
      description: REST surface for api-api-key.
      operations:
      - method: POST
        name: createapikey
        description: Creates an API key. You can optionally specify a unique Id for the key, if not provided one will be generated. an API key can only be create
        call: fusionauth-api-key.createapikey
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/api-key/{keyId}
      name: api-api-key-keyid
      description: REST surface for api-api-key-keyid.
      operations:
      - method: POST
        name: createapikeywithid
        description: Creates an API key. You can optionally specify a unique Id for the key, if not provided one will be generated. an API key can only be create
        call: fusionauth-api-key.createapikeywithid
        with:
          keyId: rest.keyId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteapikeywithid
        description: Deletes the API key for the given Id.
        call: fusionauth-api-key.deleteapikeywithid
        with:
          keyId: rest.keyId
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchapikeywithid
        description: Updates an API key with the given Id.
        call: fusionauth-api-key.patchapikeywithid
        with:
          keyId: rest.keyId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: retrieveapikeywithid
        description: Retrieves an authentication API key for the given Id.
        call: fusionauth-api-key.retrieveapikeywithid
        with:
          keyId: rest.keyId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateapikeywithid
        description: Updates an API key with the given Id.
        call: fusionauth-api-key.updateapikeywithid
        with:
          keyId: rest.keyId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: fusionauth-api-key-mcp
    port: 9090
    transport: http
    description: MCP adapter for FusionAuth API — API Key. One tool per consumed operation, routed inline through this capability's consumes block.
    tools:
    - name: fusionauth-createapikey
      description: Creates an API key. You can optionally specify a unique Id for the key, if not provided one will be generated. an API key can only be create
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fusionauth-api-key.createapikey
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-createapikeywithid
      description: Creates an API key. You can optionally specify a unique Id for the key, if not provided one will be generated. an API key can only be create
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fusionauth-api-key.createapikeywithid
      with:
        keyId: tools.keyId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-deleteapikeywithid
      description: Deletes the API key for the given Id.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: fusionauth-api-key.deleteapikeywithid
      with:
        keyId: tools.keyId
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-patchapikeywithid
      description: Updates an API key with the given Id.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fusionauth-api-key.patchapikeywithid
      with:
        keyId: tools.keyId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-retrieveapikeywithid
      description: Retrieves an authentication API key for the given Id.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fusionauth-api-key.retrieveapikeywithid
      with:
        keyId: tools.keyId
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-updateapikeywithid
      description: Updates an API key with the given Id.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: fusionauth-api-key.updateapikeywithid
      with:
        keyId: tools.keyId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.