naftiko: 1.0.0-alpha2
info:
  label: FusionAuth API — User Action
  description: 'FusionAuth API — User Action. 7 operations. Lead operation: Retrieves the user action for the given Id. If you pass in null for the Id, this will return all the user actions. OR Retrieves all the user. Self-contained Naftiko capability covering one business surface.'
  tags:
  - FusionAuth
  - User Action
  created: '2026-05-20'
  modified: '2026-05-20'
binds:
- namespace: env
  keys:
    FUSIONAUTH_API_KEY: FUSIONAUTH_API_KEY
capability:
  consumes:
  - type: http
    namespace: fusionauth-user-action
    baseUri: http://localhost:9011
    description: FusionAuth API — User Action business capability. Self-contained, no shared references.
    resources:
    - name: api-user-action
      path: /api/user-action
      operations:
      - name: createuseraction
        method: POST
        description: Creates a user action. This action cannot be taken on a user until this call successfully returns. Anytime after that the user action can be
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: X-FusionAuth-TenantId
          in: header
          type: string
          description: The unique Id of the tenant used to scope this API request. Only required when there is more than one tenant and the API key is not tenant-scoped.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: retrieveuseraction
        method: GET
        description: Retrieves the user action for the given Id. If you pass in null for the Id, this will return all the user actions. OR Retrieves all the user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: X-FusionAuth-TenantId
          in: header
          type: string
          description: The unique Id of the tenant used to scope this API request. Only required when there is more than one tenant and the API key is not tenant-scoped.
        - name: inactive
          in: query
          type: string
          description: query parameter inactive.
    - name: api-user-action-useractionid
      path: /api/user-action/{userActionId}
      operations:
      - name: createuseractionwithid
        method: POST
        description: Creates a user action. This action cannot be taken on a user until this call successfully returns. Anytime after that the user action can be
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: userActionId
          in: path
          type: string
          description: The Id for the user action. If not provided a secure random UUID will be generated.
          required: true
        - name: X-FusionAuth-TenantId
          in: header
          type: string
          description: The unique Id of the tenant used to scope this API request. Only required when there is more than one tenant and the API key is not tenant-scoped.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deleteuseractionwithid
        method: DELETE
        description: Deletes the user action for the given Id. This permanently deletes the user action and also any history and logs of the action being applied
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: hardDelete
          in: query
          type: string
          description: query parameter hardDelete.
        - name: userActionId
          in: path
          type: string
          description: The Id of the user action to delete.
          required: true
        - name: X-FusionAuth-TenantId
          in: header
          type: string
          description: The unique Id of the tenant used to scope this API request. Only required when there is more than one tenant and the API key is not tenant-scoped.
      - name: patchuseractionwithid
        method: PATCH
        description: Updates, via PATCH, the user action with the given Id.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: userActionId
          in: path
          type: string
          description: The Id of the user action to update.
          required: true
        - name: X-FusionAuth-TenantId
          in: header
          type: string
          description: The unique Id of the tenant used to scope this API request. Only required when there is more than one tenant and the API key is not tenant-scoped.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: updateuseractionwithid
        method: PUT
        description: Updates the user action with the given Id. OR Reactivates the user action with the given Id.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: userActionId
          in: path
          type: string
          description: The Id of the user action to update.
          required: true
        - name: X-FusionAuth-TenantId
          in: header
          type: string
          description: The unique Id of the tenant used to scope this API request. Only required when there is more than one tenant and the API key is not tenant-scoped.
        - name: reactivate
          in: query
          type: string
          description: query parameter reactivate.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: retrieveuseractionwithid
        method: GET
        description: Retrieves the user action for the given Id. If you pass in null for the Id, this will return all the user actions.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: userActionId
          in: path
          type: string
          description: The Id of the user action.
          required: true
        - name: X-FusionAuth-TenantId
          in: header
          type: string
          description: The unique Id of the tenant used to scope this API request. Only required when there is more than one tenant and the API key is not tenant-scoped.
  exposes:
  - type: rest
    namespace: fusionauth-user-action-rest
    port: 8080
    description: REST adapter for FusionAuth API — User Action. One resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/user-action
      name: api-user-action
      description: REST surface for api-user-action.
      operations:
      - method: POST
        name: createuseraction
        description: Creates a user action. This action cannot be taken on a user until this call successfully returns. Anytime after that the user action can be
        call: fusionauth-user-action.createuseraction
        with:
          X-FusionAuth-TenantId: rest.X-FusionAuth-TenantId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: retrieveuseraction
        description: Retrieves the user action for the given Id. If you pass in null for the Id, this will return all the user actions. OR Retrieves all the user
        call: fusionauth-user-action.retrieveuseraction
        with:
          X-FusionAuth-TenantId: rest.X-FusionAuth-TenantId
          inactive: rest.inactive
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/user-action/{userActionId}
      name: api-user-action-useractionid
      description: REST surface for api-user-action-useractionid.
      operations:
      - method: POST
        name: createuseractionwithid
        description: Creates a user action. This action cannot be taken on a user until this call successfully returns. Anytime after that the user action can be
        call: fusionauth-user-action.createuseractionwithid
        with:
          userActionId: rest.userActionId
          X-FusionAuth-TenantId: rest.X-FusionAuth-TenantId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteuseractionwithid
        description: Deletes the user action for the given Id. This permanently deletes the user action and also any history and logs of the action being applied
        call: fusionauth-user-action.deleteuseractionwithid
        with:
          hardDelete: rest.hardDelete
          userActionId: rest.userActionId
          X-FusionAuth-TenantId: rest.X-FusionAuth-TenantId
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchuseractionwithid
        description: Updates, via PATCH, the user action with the given Id.
        call: fusionauth-user-action.patchuseractionwithid
        with:
          userActionId: rest.userActionId
          X-FusionAuth-TenantId: rest.X-FusionAuth-TenantId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateuseractionwithid
        description: Updates the user action with the given Id. OR Reactivates the user action with the given Id.
        call: fusionauth-user-action.updateuseractionwithid
        with:
          userActionId: rest.userActionId
          X-FusionAuth-TenantId: rest.X-FusionAuth-TenantId
          reactivate: rest.reactivate
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: retrieveuseractionwithid
        description: Retrieves the user action for the given Id. If you pass in null for the Id, this will return all the user actions.
        call: fusionauth-user-action.retrieveuseractionwithid
        with:
          userActionId: rest.userActionId
          X-FusionAuth-TenantId: rest.X-FusionAuth-TenantId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: fusionauth-user-action-mcp
    port: 9090
    transport: http
    description: MCP adapter for FusionAuth API — User Action. One tool per consumed operation, routed inline through this capability's consumes block.
    tools:
    - name: fusionauth-createuseraction
      description: Creates a user action. This action cannot be taken on a user until this call successfully returns. Anytime after that the user action can be
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fusionauth-user-action.createuseraction
      with:
        X-FusionAuth-TenantId: tools.X-FusionAuth-TenantId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-retrieveuseraction
      description: Retrieves the user action for the given Id. If you pass in null for the Id, this will return all the user actions. OR Retrieves all the user
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fusionauth-user-action.retrieveuseraction
      with:
        X-FusionAuth-TenantId: tools.X-FusionAuth-TenantId
        inactive: tools.inactive
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-createuseractionwithid
      description: Creates a user action. This action cannot be taken on a user until this call successfully returns. Anytime after that the user action can be
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fusionauth-user-action.createuseractionwithid
      with:
        userActionId: tools.userActionId
        X-FusionAuth-TenantId: tools.X-FusionAuth-TenantId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-deleteuseractionwithid
      description: Deletes the user action for the given Id. This permanently deletes the user action and also any history and logs of the action being applied
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: fusionauth-user-action.deleteuseractionwithid
      with:
        hardDelete: tools.hardDelete
        userActionId: tools.userActionId
        X-FusionAuth-TenantId: tools.X-FusionAuth-TenantId
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-patchuseractionwithid
      description: Updates, via PATCH, the user action with the given Id.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fusionauth-user-action.patchuseractionwithid
      with:
        userActionId: tools.userActionId
        X-FusionAuth-TenantId: tools.X-FusionAuth-TenantId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-updateuseractionwithid
      description: Updates the user action with the given Id. OR Reactivates the user action with the given Id.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: fusionauth-user-action.updateuseractionwithid
      with:
        userActionId: tools.userActionId
        X-FusionAuth-TenantId: tools.X-FusionAuth-TenantId
        reactivate: tools.reactivate
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-retrieveuseractionwithid
      description: Retrieves the user action for the given Id. If you pass in null for the Id, this will return all the user actions.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fusionauth-user-action.retrieveuseractionwithid
      with:
        userActionId: tools.userActionId
        X-FusionAuth-TenantId: tools.X-FusionAuth-TenantId
      outputParameters:
      - type: object
        mapping: $.