FusionAuth · Capability

FusionAuth API — Key

FusionAuth API — Key. 9 operations. Lead operation: Retrieves all the keys.. Self-contained Naftiko capability covering one business surface.

FusionAuth API — Key is a Naftiko capability published by FusionAuth, one of 33 capabilities the APIs.io network indexes for this provider. It bundles 9 operations across the POST, GET, DELETE, and PUT methods rooted at /v1/api/key.

The capability includes 2 read-only operations and 7 state-changing operations. Lead operation: Retrieves all the keys. Can be deployed as a REST endpoint, MCP tool, or Agent Skill via Naftiko.

Tagged areas include FusionAuth and Key.

Run with Naftiko FusionAuthKey

What You Can Do

GET
Retrievekeyswithid — Retrieves all the keys.
/v1/api/key
POST
Generatekey — Generate a new RSA or EC key pair or an HMAC secret.
/v1/api/key/generate
POST
Generatekeywithid — Generate a new RSA or EC key pair or an HMAC secret.
/v1/api/key/generate/{keyId}
POST
Importkey — Import an existing RSA or EC key pair or an HMAC secret.
/v1/api/key/import
POST
Importkeywithid — Import an existing RSA or EC key pair or an HMAC secret.
/v1/api/key/import/{keyId}
POST
Searchkeyswithid — Searches keys with the specified criteria and pagination.
/v1/api/key/search
DELETE
Deletekeywithid — Deletes the key for the given Id.
/v1/api/key/{keyId}
GET
Retrievekeywithid — Retrieves the key for the given Id.
/v1/api/key/{keyId}
PUT
Updatekeywithid — Updates the key with the given Id.
/v1/api/key/{keyId}

MCP Tools

fusionauth-retrievekeyswithid

Retrieves all the keys.

read-only idempotent
fusionauth-generatekey

Generate a new RSA or EC key pair or an HMAC secret.

fusionauth-generatekeywithid

Generate a new RSA or EC key pair or an HMAC secret.

fusionauth-importkey

Import an existing RSA or EC key pair or an HMAC secret.

fusionauth-importkeywithid

Import an existing RSA or EC key pair or an HMAC secret.

fusionauth-searchkeyswithid

Searches keys with the specified criteria and pagination.

fusionauth-deletekeywithid

Deletes the key for the given Id.

idempotent
fusionauth-retrievekeywithid

Retrieves the key for the given Id.

read-only idempotent
fusionauth-updatekeywithid

Updates the key with the given Id.

idempotent

Capability Spec

fusionauth-key.yaml Raw ↑ 
naftiko: 1.0.0-alpha2
info:
  label: FusionAuth API — Key
  description: 'FusionAuth API — Key. 9 operations. Lead operation: Retrieves all the keys.. Self-contained Naftiko capability covering one business surface.'
  tags:
  - FusionAuth
  - 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-key
    baseUri: http://localhost:9011
    description: FusionAuth API — Key business capability. Self-contained, no shared references.
    resources:
    - name: api-key
      path: /api/key
      operations:
      - name: retrievekeyswithid
        method: GET
        description: Retrieves all the keys.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters: []
    - name: api-key-generate
      path: /api/key/generate
      operations:
      - name: generatekey
        method: POST
        description: Generate a new RSA or EC key pair or an HMAC secret.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-key-generate-keyid
      path: /api/key/generate/{keyId}
      operations:
      - name: generatekeywithid
        method: POST
        description: Generate a new RSA or EC key pair or an HMAC secret.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: keyId
          in: path
          type: string
          description: The Id for the key. If not provided a secure random UUID will be generated.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-key-import
      path: /api/key/import
      operations:
      - name: importkey
        method: POST
        description: Import an existing RSA or EC key pair or an HMAC secret.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-key-import-keyid
      path: /api/key/import/{keyId}
      operations:
      - name: importkeywithid
        method: POST
        description: Import an existing RSA or EC key pair or an HMAC secret.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: keyId
          in: path
          type: string
          description: The Id for the key. If not provided a secure random UUID will be generated.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-key-search
      path: /api/key/search
      operations:
      - name: searchkeyswithid
        method: POST
        description: Searches keys with the specified criteria and pagination.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-key-keyid
      path: /api/key/{keyId}
      operations:
      - name: deletekeywithid
        method: DELETE
        description: Deletes the 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 key to delete.
          required: true
      - name: retrievekeywithid
        method: GET
        description: Retrieves the 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 key.
          required: true
      - name: updatekeywithid
        method: PUT
        description: Updates the 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 key to update.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
  exposes:
  - type: rest
    namespace: fusionauth-key-rest
    port: 8080
    description: REST adapter for FusionAuth API — Key. One resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/key
      name: api-key
      description: REST surface for api-key.
      operations:
      - method: GET
        name: retrievekeyswithid
        description: Retrieves all the keys.
        call: fusionauth-key.retrievekeyswithid
        with: {}
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/key/generate
      name: api-key-generate
      description: REST surface for api-key-generate.
      operations:
      - method: POST
        name: generatekey
        description: Generate a new RSA or EC key pair or an HMAC secret.
        call: fusionauth-key.generatekey
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/key/generate/{keyId}
      name: api-key-generate-keyid
      description: REST surface for api-key-generate-keyid.
      operations:
      - method: POST
        name: generatekeywithid
        description: Generate a new RSA or EC key pair or an HMAC secret.
        call: fusionauth-key.generatekeywithid
        with:
          keyId: rest.keyId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/key/import
      name: api-key-import
      description: REST surface for api-key-import.
      operations:
      - method: POST
        name: importkey
        description: Import an existing RSA or EC key pair or an HMAC secret.
        call: fusionauth-key.importkey
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/key/import/{keyId}
      name: api-key-import-keyid
      description: REST surface for api-key-import-keyid.
      operations:
      - method: POST
        name: importkeywithid
        description: Import an existing RSA or EC key pair or an HMAC secret.
        call: fusionauth-key.importkeywithid
        with:
          keyId: rest.keyId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/key/search
      name: api-key-search
      description: REST surface for api-key-search.
      operations:
      - method: POST
        name: searchkeyswithid
        description: Searches keys with the specified criteria and pagination.
        call: fusionauth-key.searchkeyswithid
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/key/{keyId}
      name: api-key-keyid
      description: REST surface for api-key-keyid.
      operations:
      - method: DELETE
        name: deletekeywithid
        description: Deletes the key for the given Id.
        call: fusionauth-key.deletekeywithid
        with:
          keyId: rest.keyId
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: retrievekeywithid
        description: Retrieves the key for the given Id.
        call: fusionauth-key.retrievekeywithid
        with:
          keyId: rest.keyId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatekeywithid
        description: Updates the key with the given Id.
        call: fusionauth-key.updatekeywithid
        with:
          keyId: rest.keyId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: fusionauth-key-mcp
    port: 9090
    transport: http
    description: MCP adapter for FusionAuth API — Key. One tool per consumed operation, routed inline through this capability's consumes block.
    tools:
    - name: fusionauth-retrievekeyswithid
      description: Retrieves all the keys.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fusionauth-key.retrievekeyswithid
      with: {}
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-generatekey
      description: Generate a new RSA or EC key pair or an HMAC secret.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fusionauth-key.generatekey
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-generatekeywithid
      description: Generate a new RSA or EC key pair or an HMAC secret.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fusionauth-key.generatekeywithid
      with:
        keyId: tools.keyId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-importkey
      description: Import an existing RSA or EC key pair or an HMAC secret.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fusionauth-key.importkey
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-importkeywithid
      description: Import an existing RSA or EC key pair or an HMAC secret.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fusionauth-key.importkeywithid
      with:
        keyId: tools.keyId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-searchkeyswithid
      description: Searches keys with the specified criteria and pagination.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fusionauth-key.searchkeyswithid
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-deletekeywithid
      description: Deletes the key for the given Id.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: fusionauth-key.deletekeywithid
      with:
        keyId: tools.keyId
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-retrievekeywithid
      description: Retrieves the key for the given Id.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fusionauth-key.retrievekeywithid
      with:
        keyId: tools.keyId
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-updatekeywithid
      description: Updates the key with the given Id.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: fusionauth-key.updatekeywithid
      with:
        keyId: tools.keyId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.