Alteryx Server API V3 — Users

naftiko: 1.0.0-alpha2
info:
  label: Alteryx Server API V3 — Users
  description: 'Alteryx Server API V3 — Users. 9 operations. Lead operation: Create a New User. Self-contained Naftiko capability
    covering one Alteryx business surface.'
  tags:
  - Alteryx
  - Users
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ALTERYX_API_KEY: ALTERYX_API_KEY
capability:
  consumes:
  - type: http
    namespace: server-api-v3-users
    baseUri: https://{serverHostname}/webapi
    description: Alteryx Server API V3 — Users business capability. Self-contained, no shared references.
    resources:
    - name: v3-users
      path: /v3/users
      operations:
      - name: createuser
        method: POST
        description: Create a New User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: getusers
        method: GET
        description: Retrieve All Users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: view
          in: query
          type: string
          description: Level of detail in the response
        - name: active
          in: query
          type: boolean
          description: Filter by active status
        - name: email
          in: query
          type: string
          description: Filter by email address
        - name: role
          in: query
          type: string
          description: Filter by user role
        - name: firstName
          in: query
          type: string
          description: Filter by first name
        - name: lastName
          in: query
          type: string
          description: Filter by last name
        - name: createdAfter
          in: query
          type: string
          description: Filter users created after this date (ISO 8601)
        - name: createdBefore
          in: query
          type: string
          description: Filter users created before this date (ISO 8601)
    - name: v3-users-userId
      path: /v3/users/{userId}
      operations:
      - name: getuser
        method: GET
        description: Retrieve a Specific User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateuser
        method: PUT
        description: Update a User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteuser
        method: DELETE
        description: Delete a User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v3-users-userId-assetTransfer
      path: /v3/users/{userId}/assetTransfer
      operations:
      - name: transferuserassets
        method: PUT
        description: Transfer User Assets
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v3-users-userId-assets
      path: /v3/users/{userId}/assets
      operations:
      - name: getuserassets
        method: GET
        description: Retrieve User Assets
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: assetType
          in: query
          type: string
          description: Filter by asset type
    - name: v3-users-userId-deactivate
      path: /v3/users/{userId}/deactivate
      operations:
      - name: deactivateuser
        method: POST
        description: Deactivate a User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v3-users-userId-passwordReset
      path: /v3/users/{userId}/passwordReset
      operations:
      - name: resetuserpassword
        method: POST
        description: Send Password Reset Email
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.ALTERYX_API_KEY}}'
  exposes:
  - type: rest
    namespace: server-api-v3-users-rest
    port: 8080
    description: REST adapter for Alteryx Server API V3 — Users. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v3/users
      name: v3-users
      description: REST surface for v3-users.
      operations:
      - method: POST
        name: createuser
        description: Create a New User
        call: server-api-v3-users.createuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getusers
        description: Retrieve All Users
        call: server-api-v3-users.getusers
        with:
          view: rest.view
          active: rest.active
          email: rest.email
          role: rest.role
          firstName: rest.firstName
          lastName: rest.lastName
          createdAfter: rest.createdAfter
          createdBefore: rest.createdBefore
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/users/{userid}
      name: v3-users-userid
      description: REST surface for v3-users-userId.
      operations:
      - method: GET
        name: getuser
        description: Retrieve a Specific User
        call: server-api-v3-users.getuser
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateuser
        description: Update a User
        call: server-api-v3-users.updateuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteuser
        description: Delete a User
        call: server-api-v3-users.deleteuser
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/users/{userid}/assettransfer
      name: v3-users-userid-assettransfer
      description: REST surface for v3-users-userId-assetTransfer.
      operations:
      - method: PUT
        name: transferuserassets
        description: Transfer User Assets
        call: server-api-v3-users.transferuserassets
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/users/{userid}/assets
      name: v3-users-userid-assets
      description: REST surface for v3-users-userId-assets.
      operations:
      - method: GET
        name: getuserassets
        description: Retrieve User Assets
        call: server-api-v3-users.getuserassets
        with:
          assetType: rest.assetType
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/users/{userid}/deactivate
      name: v3-users-userid-deactivate
      description: REST surface for v3-users-userId-deactivate.
      operations:
      - method: POST
        name: deactivateuser
        description: Deactivate a User
        call: server-api-v3-users.deactivateuser
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/users/{userid}/passwordreset
      name: v3-users-userid-passwordreset
      description: REST surface for v3-users-userId-passwordReset.
      operations:
      - method: POST
        name: resetuserpassword
        description: Send Password Reset Email
        call: server-api-v3-users.resetuserpassword
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: server-api-v3-users-mcp
    port: 9090
    transport: http
    description: MCP adapter for Alteryx Server API V3 — Users. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: create-new-user
      description: Create a New User
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: server-api-v3-users.createuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-all-users
      description: Retrieve All Users
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: server-api-v3-users.getusers
      with:
        view: tools.view
        active: tools.active
        email: tools.email
        role: tools.role
        firstName: tools.firstName
        lastName: tools.lastName
        createdAfter: tools.createdAfter
        createdBefore: tools.createdBefore
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-specific-user
      description: Retrieve a Specific User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: server-api-v3-users.getuser
      outputParameters:
      - type: object
        mapping: $.
    - name: update-user
      description: Update a User
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: server-api-v3-users.updateuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-user
      description: Delete a User
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: server-api-v3-users.deleteuser
      outputParameters:
      - type: object
        mapping: $.
    - name: transfer-user-assets
      description: Transfer User Assets
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: server-api-v3-users.transferuserassets
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-user-assets
      description: Retrieve User Assets
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: server-api-v3-users.getuserassets
      with:
        assetType: tools.assetType
      outputParameters:
      - type: object
        mapping: $.
    - name: deactivate-user
      description: Deactivate a User
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: server-api-v3-users.deactivateuser
      outputParameters:
      - type: object
        mapping: $.
    - name: send-password-reset-email
      description: Send Password Reset Email
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: server-api-v3-users.resetuserpassword
      outputParameters:
      - type: object
        mapping: $.