FusionAuth API — Form

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