openapi: 3.1.0
info:
  title: Alteryx Server API V3 Collections Users API
  description: The Alteryx Server API V3 provides administrative capabilities for managing workflows, schedules, users, user groups, credentials, collections, and server connections. It uses OAuth 2 authentication and implements POST, PUT, GET, DELETE, and PATCH operations so administrators can automate tasks and integrate Server with existing API automation tools.
  version: 3.0.0
  contact:
    name: Alteryx Support
    email: support@alteryx.com
    url: https://community.alteryx.com
  license:
    name: Proprietary
    url: https://www.alteryx.com/terms-and-conditions
  termsOfService: https://www.alteryx.com/terms-and-conditions
  x-logo:
    url: https://www.alteryx.com/sites/default/files/alteryx-logo-2021.svg
servers:
- url: https://{serverHostname}/webapi
  description: Alteryx Server instance
  variables:
    serverHostname:
      default: your-server.example.com
      description: Hostname of your Alteryx Server instance
security:
- oauth2: []
tags:
- name: Users
  description: Manage user accounts, permissions, and asset transfers
paths:
  /v3/users:
    post:
      operationId: createUser
      summary: Create a New User
      description: Create a new user account on the Alteryx Server. Requires Curator role.
      tags:
      - Users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUserContract'
      responses:
        '201':
          description: User created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDetail'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden - insufficient permissions
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      operationId: getUsers
      summary: Retrieve All Users
      description: Retrieve information about all user records with optional filtering. Requires Curator role.
      tags:
      - Users
      parameters:
      - name: view
        in: query
        description: Level of detail in the response
        schema:
          type: string
          enum:
          - Default
          - Full
          default: Default
      - name: active
        in: query
        description: Filter by active status
        schema:
          type: boolean
      - name: email
        in: query
        description: Filter by email address
        schema:
          type: string
      - name: role
        in: query
        description: Filter by user role
        schema:
          type: string
          enum:
          - NoAccess
          - Viewer
          - Member
          - Artisan
          - Curator
          - Evaluated
      - name: firstName
        in: query
        description: Filter by first name
        schema:
          type: string
      - name: lastName
        in: query
        description: Filter by last name
        schema:
          type: string
      - name: createdAfter
        in: query
        description: Filter users created after this date (ISO 8601)
        schema:
          type: string
          format: date-time
      - name: createdBefore
        in: query
        description: Filter users created before this date (ISO 8601)
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: List of user records
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserDetail'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v3/users/{userId}:
    get:
      operationId: getUser
      summary: Retrieve a Specific User
      description: Retrieve detailed information about a specific user. Requires Curator role.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/userId'
      responses:
        '200':
          description: User details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDetail'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: User not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateUser
      summary: Update a User
      description: Update user account details and permissions. Requires Curator role.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/userId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUserContract'
      responses:
        '200':
          description: User updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDetail'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: User not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteUser
      summary: Delete a User
      description: Delete a user from the system. The user must not own any assets or belong to any groups. Requires Curator role.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/userId'
      responses:
        '200':
          description: User deleted successfully
        '400':
          description: Bad request - user owns assets or belongs to groups
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: User not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v3/users/{userId}/deactivate:
    post:
      operationId: deactivateUser
      summary: Deactivate a User
      description: Deactivate a user account and remove them from all user groups. Requires Curator role.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/userId'
      responses:
        '200':
          description: User deactivated successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
                description: Array of user group IDs from which the user was removed
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: User not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v3/users/{userId}/passwordReset:
    post:
      operationId: resetUserPassword
      summary: Send Password Reset Email
      description: Send a password reset email to the user. Not available for Windows or SAML authentication methods. Requires Curator role.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/userId'
      responses:
        '200':
          description: Password reset email sent successfully
        '400':
          description: Bad request - authentication method not supported
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: User not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v3/users/{userId}/assets:
    get:
      operationId: getUserAssets
      summary: Retrieve User Assets
      description: List all assets (workflows, schedules, collections) owned by a specific user. Requires Curator role.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/userId'
      - name: assetType
        in: query
        description: Filter by asset type
        schema:
          type: string
          default: All
      responses:
        '200':
          description: List of user assets
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserAsset'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: User not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v3/users/{userId}/assetTransfer:
    put:
      operationId: transferUserAssets
      summary: Transfer User Assets
      description: Transfer all assets (workflows, schedules, and collections) owned by one user to another. The receiving user must have Artisan or Curator role. Requires Curator role.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/userId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - ownerId
              - transferWorkflows
              - transferSchedules
              - transferCollections
              properties:
                ownerId:
                  type: string
                  description: ID of the user receiving the assets
                transferWorkflows:
                  type: boolean
                  description: Whether to transfer workflows
                transferSchedules:
                  type: boolean
                  description: Whether to transfer schedules
                transferCollections:
                  type: boolean
                  description: Whether to transfer collections
      responses:
        '200':
          description: Assets transferred successfully
        '400':
          description: Bad request - receiving user lacks required role
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: User not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    CreateUserContract:
      type: object
      description: Contract for creating a new user
      required:
      - firstName
      - lastName
      - email
      properties:
        firstName:
          type: string
          description: User's first name
          example: example_value
        lastName:
          type: string
          description: User's last name
          example: example_value
        email:
          type: string
          format: email
          description: User's email address
          example: user@example.com
        role:
          type: string
          enum:
          - NoAccess
          - Viewer
          - Member
          - Artisan
          - Curator
          - Evaluated
          description: User role determining access level
          example: NoAccess
        defaultWorkerTag:
          type: string
          description: Default worker tag for the user
          example: example_value
        canScheduleJobs:
          type: boolean
          description: Whether the user can create schedules
          example: true
        canPrioritizeJobs:
          type: boolean
          description: Whether the user can set job priority
          example: true
        canAssignJobs:
          type: boolean
          description: Whether the user can assign jobs to workers
          example: true
        canCreateCollections:
          type: boolean
          description: Whether the user can create collections
          example: true
        isApiEnabled:
          type: boolean
          description: Whether API access is enabled for the user
          example: true
        defaultCredentialId:
          type: string
          description: Default credential ID for the user
          example: '500123'
        isActive:
          type: boolean
          description: Whether the user account is active
          example: true
        timeZone:
          type: string
          description: User's preferred time zone
          example: example_value
        canCreateAndUpdateDcm:
          type: boolean
          description: Whether the user can create and update DCM connections
          example: true
        canShareForExecutionDcm:
          type: boolean
          description: Whether the user can share DCM connections for execution
          example: true
        canShareForCollaborationDcm:
          type: boolean
          description: Whether the user can share DCM connections for collaboration
          example: true
        canManageGenericVaultsDcm:
          type: boolean
          description: Whether the user can manage generic DCM vaults
          example: true
    UserDetail:
      type: object
      description: Detailed representation of a user account
      properties:
        id:
          type: string
          description: Unique user identifier
          example: abc123
        firstName:
          type: string
          description: User's first name
          example: example_value
        lastName:
          type: string
          description: User's last name
          example: example_value
        email:
          type: string
          format: email
          description: User's email address
          example: user@example.com
        role:
          type: string
          enum:
          - NoAccess
          - Viewer
          - Member
          - Artisan
          - Curator
          - Evaluated
          description: User role
          example: NoAccess
        dateCreated:
          type: string
          format: date-time
          description: Date the user was created
          example: '2026-01-15T10:30:00Z'
        defaultWorkerTag:
          type: string
          description: Default worker tag
          example: example_value
        canScheduleJobs:
          type: boolean
          example: true
        canPrioritizeJobs:
          type: boolean
          example: true
        canAssignJobs:
          type: boolean
          example: true
        canCreateCollections:
          type: boolean
          example: true
        isApiEnabled:
          type: boolean
          example: true
        defaultCredentialId:
          type: string
          example: '500123'
        isAccountLocked:
          type: boolean
          example: true
        isActive:
          type: boolean
          example: true
        isValidated:
          type: boolean
          example: true
        timeZone:
          type: string
          example: example_value
        language:
          type: string
          example: example_value
        canCreateAndUpdateDcm:
          type: boolean
          example: true
        canShareForExecutionDcm:
          type: boolean
          example: true
        canShareForCollaborationDcm:
          type: boolean
          example: true
        canManageGenericVaultsDcm:
          type: boolean
          example: true
    UpdateUserContract:
      type: object
      description: Contract for updating an existing user
      required:
      - firstName
      - lastName
      - email
      - role
      - defaultWorkerTag
      - canScheduleJobs
      - canPrioritizeJobs
      - canAssignJobs
      - isApiEnabled
      - defaultCredentialId
      - isActive
      - isValidated
      - timeZone
      properties:
        id:
          type: string
          description: User ID (optional, for verification)
          example: abc123
        firstName:
          type: string
          example: example_value
        lastName:
          type: string
          example: example_value
        email:
          type: string
          format: email
          example: user@example.com
        role:
          type: string
          enum:
          - NoAccess
          - Viewer
          - Member
          - Artisan
          - Curator
          - Evaluated
          example: NoAccess
        defaultWorkerTag:
          type: string
          example: example_value
        canScheduleJobs:
          type: boolean
          example: true
        canPrioritizeJobs:
          type: boolean
          example: true
        canAssignJobs:
          type: boolean
          example: true
        canCreateCollections:
          type: boolean
          example: true
        isApiEnabled:
          type: boolean
          example: true
        defaultCredentialId:
          type: string
          example: '500123'
        isAccountLocked:
          type: boolean
          description: Whether the account is locked
          example: true
        isActive:
          type: boolean
          example: true
        isValidated:
          type: boolean
          description: Whether the user's email has been validated
          example: true
        timeZone:
          type: string
          example: example_value
        language:
          type: string
          enum:
          - de-de
          - en-us
          - es-es
          - fr-fr
          - it-it
          - ja-jp
          - pt-br
          - zh-cn
          description: User's preferred language
          example: de-de
        canCreateAndUpdateDcm:
          type: boolean
          example: true
        canShareForExecutionDcm:
          type: boolean
          example: true
        canShareForCollaborationDcm:
          type: boolean
          example: true
        canManageGenericVaultsDcm:
          type: boolean
          example: true
    ErrorResponse:
      type: object
      description: Standard error response
      properties:
        message:
          type: string
          description: Human-readable error message
          example: example_value
        errors:
          type: array
          description: Detailed error information
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
          example: []
    UserAsset:
      type: object
      description: An asset owned by a user
      properties:
        id:
          type: string
          description: Asset identifier
          example: abc123
        type:
          type: string
          description: Type of asset (workflow, schedule, collection)
          example: example_value
        name:
          type: string
          description: Name of the asset
          example: Example Title
  parameters:
    userId:
      name: userId
      in: path
      required: true
      description: Unique identifier of the user
      schema:
        type: string
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0 authentication using API Access Key and API Access Secret obtained from the Server User Interface under the Keys section.
      flows:
        clientCredentials:
          tokenUrl: https://{serverHostname}/webapi/oauth2/token
          scopes: {}
externalDocs:
  description: Alteryx Server API V3 Documentation
  url: https://help.alteryx.com/current/en/server/api-overview/alteryx-server-api-v3.html