FusionAuth API — Connector

naftiko: 1.0.0-alpha2
info:
  label: FusionAuth API — Connector
  description: 'FusionAuth API — Connector. 6 operations. Lead operation: Retrieves the connector with the given Id.. Self-contained Naftiko capability covering one business surface.'
  tags:
  - FusionAuth
  - Connector
  created: '2026-05-20'
  modified: '2026-05-20'
binds:
- namespace: env
  keys:
    FUSIONAUTH_API_KEY: FUSIONAUTH_API_KEY
capability:
  consumes:
  - type: http
    namespace: fusionauth-connector
    baseUri: http://localhost:9011
    description: FusionAuth API — Connector business capability. Self-contained, no shared references.
    resources:
    - name: api-connector
      path: /api/connector
      operations:
      - name: createconnector
        method: POST
        description: Creates a connector.  You can optionally specify an Id for the connector, if not provided one will be generated.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-connector-connectorid
      path: /api/connector/{connectorId}
      operations:
      - name: createconnectorwithid
        method: POST
        description: Creates a connector.  You can optionally specify an Id for the connector, if not provided one will be generated.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: connectorId
          in: path
          type: string
          description: The Id for the connector. 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: deleteconnectorwithid
        method: DELETE
        description: Deletes the connector for the given Id.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: connectorId
          in: path
          type: string
          description: The Id of the connector to delete.
          required: true
      - name: patchconnectorwithid
        method: PATCH
        description: Updates, via PATCH, the connector with the given Id.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: connectorId
          in: path
          type: string
          description: The Id of the connector to update.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: retrieveconnectorwithid
        method: GET
        description: Retrieves the connector with the given Id.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: connectorId
          in: path
          type: string
          description: The Id of the connector.
          required: true
      - name: updateconnectorwithid
        method: PUT
        description: Updates the connector with the given Id.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: connectorId
          in: path
          type: string
          description: The Id of the connector to update.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
  exposes:
  - type: rest
    namespace: fusionauth-connector-rest
    port: 8080
    description: REST adapter for FusionAuth API — Connector. One resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/connector
      name: api-connector
      description: REST surface for api-connector.
      operations:
      - method: POST
        name: createconnector
        description: Creates a connector.  You can optionally specify an Id for the connector, if not provided one will be generated.
        call: fusionauth-connector.createconnector
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/connector/{connectorId}
      name: api-connector-connectorid
      description: REST surface for api-connector-connectorid.
      operations:
      - method: POST
        name: createconnectorwithid
        description: Creates a connector.  You can optionally specify an Id for the connector, if not provided one will be generated.
        call: fusionauth-connector.createconnectorwithid
        with:
          connectorId: rest.connectorId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteconnectorwithid
        description: Deletes the connector for the given Id.
        call: fusionauth-connector.deleteconnectorwithid
        with:
          connectorId: rest.connectorId
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchconnectorwithid
        description: Updates, via PATCH, the connector with the given Id.
        call: fusionauth-connector.patchconnectorwithid
        with:
          connectorId: rest.connectorId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: retrieveconnectorwithid
        description: Retrieves the connector with the given Id.
        call: fusionauth-connector.retrieveconnectorwithid
        with:
          connectorId: rest.connectorId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateconnectorwithid
        description: Updates the connector with the given Id.
        call: fusionauth-connector.updateconnectorwithid
        with:
          connectorId: rest.connectorId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: fusionauth-connector-mcp
    port: 9090
    transport: http
    description: MCP adapter for FusionAuth API — Connector. One tool per consumed operation, routed inline through this capability's consumes block.
    tools:
    - name: fusionauth-createconnector
      description: Creates a connector.  You can optionally specify an Id for the connector, if not provided one will be generated.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fusionauth-connector.createconnector
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-createconnectorwithid
      description: Creates a connector.  You can optionally specify an Id for the connector, if not provided one will be generated.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fusionauth-connector.createconnectorwithid
      with:
        connectorId: tools.connectorId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-deleteconnectorwithid
      description: Deletes the connector for the given Id.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: fusionauth-connector.deleteconnectorwithid
      with:
        connectorId: tools.connectorId
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-patchconnectorwithid
      description: Updates, via PATCH, the connector with the given Id.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fusionauth-connector.patchconnectorwithid
      with:
        connectorId: tools.connectorId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-retrieveconnectorwithid
      description: Retrieves the connector with the given Id.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fusionauth-connector.retrieveconnectorwithid
      with:
        connectorId: tools.connectorId
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-updateconnectorwithid
      description: Updates the connector with the given Id.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: fusionauth-connector.updateconnectorwithid
      with:
        connectorId: tools.connectorId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.