openapi: 3.1.0
info:
  title: Alteryx Server API V3 Collections Credentials 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: Credentials
  description: Manage stored credentials and credential sharing
paths:
  /v3/credentials:
    get:
      operationId: getCredentials
      summary: Retrieve All Credentials
      description: Retrieve all accessible credential records. Requires Curator role.
      tags:
      - Credentials
      parameters:
      - name: view
        in: query
        schema:
          type: string
          enum:
          - Default
          - Full
          default: Default
      - name: userId
        in: query
        description: Filter by user
        schema:
          type: string
      - name: userGroupId
        in: query
        description: Filter by user group
        schema:
          type: string
      responses:
        '200':
          description: List of credentials
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Credential'
        '401':
          description: Unauthorized
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createCredential
      summary: Create a New Credential
      description: Create a new credential record. Requires Curator role.
      tags:
      - Credentials
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - username
              - password
              properties:
                username:
                  type: string
                  description: Windows login username
                password:
                  type: string
                  format: password
                  description: User password
      responses:
        '201':
          description: Credential created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credential'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v3/credentials/{credentialId}:
    get:
      operationId: getCredential
      summary: Retrieve a Specific Credential
      description: Retrieve details for a specific credential record.
      tags:
      - Credentials
      parameters:
      - $ref: '#/components/parameters/credentialId'
      responses:
        '200':
          description: Credential details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credential'
        '401':
          description: Unauthorized
        '404':
          description: Credential not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateCredential
      summary: Update a Credential
      description: Update an existing credential record. Requires Curator role.
      tags:
      - Credentials
      parameters:
      - $ref: '#/components/parameters/credentialId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - username
              - NewPassword
              properties:
                username:
                  type: string
                  description: Windows login username
                NewPassword:
                  type: string
                  format: password
                  description: Replacement password
      responses:
        '200':
          description: Credential updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credential'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Credential not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteCredential
      summary: Delete a Credential
      description: Delete a credential from the system. Requires Curator role.
      tags:
      - Credentials
      parameters:
      - $ref: '#/components/parameters/credentialId'
      - name: force
        in: query
        description: Force deletion with share cleanup
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: Credential deleted successfully
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Credential not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v3/credentials/{credentialId}/users:
    post:
      operationId: shareCredentialWithUser
      summary: Share Credential With a User
      description: Grant a user access to a specific credential. Requires Curator role.
      tags:
      - Credentials
      parameters:
      - $ref: '#/components/parameters/credentialId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - userId
              properties:
                userId:
                  type: string
                  description: ID of the user to share with
      responses:
        '200':
          description: Credential shared successfully
        '400':
          description: Bad request
        '401':
          description: Unauthorized
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v3/credentials/{credentialId}/users/{userId}:
    delete:
      operationId: removeCredentialUserAccess
      summary: Remove User Access to Credential
      description: Remove a user's access to a specific credential. Requires Curator role.
      tags:
      - Credentials
      parameters:
      - $ref: '#/components/parameters/credentialId'
      - $ref: '#/components/parameters/userId'
      responses:
        '200':
          description: User access removed
        '401':
          description: Unauthorized
        '404':
          description: Not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v3/credentials/{credentialId}/userGroups:
    post:
      operationId: shareCredentialWithUserGroup
      summary: Share Credential With a User Group
      description: Grant a user group access to a specific credential. Requires Curator role.
      tags:
      - Credentials
      parameters:
      - $ref: '#/components/parameters/credentialId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - userGroupId
              properties:
                userGroupId:
                  type: string
                  description: ID of the user group to share with
      responses:
        '200':
          description: Credential shared successfully
        '400':
          description: Bad request
        '401':
          description: Unauthorized
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v3/credentials/{credentialId}/userGroups/{userGroupId}:
    delete:
      operationId: removeCredentialUserGroupAccess
      summary: Remove User Group Access to Credential
      description: Remove a user group's access to a specific credential. Requires Curator role.
      tags:
      - Credentials
      parameters:
      - $ref: '#/components/parameters/credentialId'
      - name: userGroupId
        in: path
        required: true
        description: Unique identifier of the user group
        schema:
          type: string
      responses:
        '200':
          description: User group access removed
        '401':
          description: Unauthorized
        '404':
          description: Not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Credential:
      type: object
      description: A stored credential for workflow execution
      properties:
        id:
          type: string
          description: Unique credential identifier
          example: abc123
        username:
          type: string
          description: Windows login username
          example: example_value
  parameters:
    credentialId:
      name: credentialId
      in: path
      required: true
      description: Unique identifier of the credential
      schema:
        type: string
    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