Alteryx Server API V3 — Credentials

naftiko: 1.0.0-alpha2
info:
  label: Alteryx Server API V3 — Credentials
  description: 'Alteryx Server API V3 — Credentials. 9 operations. Lead operation: Retrieve All Credentials. Self-contained
    Naftiko capability covering one Alteryx business surface.'
  tags:
  - Alteryx
  - Credentials
  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-credentials
    baseUri: https://{serverHostname}/webapi
    description: Alteryx Server API V3 — Credentials business capability. Self-contained, no shared references.
    resources:
    - name: v3-credentials
      path: /v3/credentials
      operations:
      - name: getcredentials
        method: GET
        description: Retrieve All Credentials
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: view
          in: query
          type: string
        - name: userId
          in: query
          type: string
          description: Filter by user
        - name: userGroupId
          in: query
          type: string
          description: Filter by user group
      - name: createcredential
        method: POST
        description: Create a New Credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v3-credentials-credentialId
      path: /v3/credentials/{credentialId}
      operations:
      - name: getcredential
        method: GET
        description: Retrieve a Specific Credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatecredential
        method: PUT
        description: Update a Credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletecredential
        method: DELETE
        description: Delete a Credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: force
          in: query
          type: boolean
          description: Force deletion with share cleanup
    - name: v3-credentials-credentialId-userGroups
      path: /v3/credentials/{credentialId}/userGroups
      operations:
      - name: sharecredentialwithusergroup
        method: POST
        description: Share Credential With a User Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v3-credentials-credentialId-userGroups-userGroupId
      path: /v3/credentials/{credentialId}/userGroups/{userGroupId}
      operations:
      - name: removecredentialusergroupaccess
        method: DELETE
        description: Remove User Group Access to Credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: userGroupId
          in: path
          type: string
          description: Unique identifier of the user group
          required: true
    - name: v3-credentials-credentialId-users
      path: /v3/credentials/{credentialId}/users
      operations:
      - name: sharecredentialwithuser
        method: POST
        description: Share Credential With a User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v3-credentials-credentialId-users-userId
      path: /v3/credentials/{credentialId}/users/{userId}
      operations:
      - name: removecredentialuseraccess
        method: DELETE
        description: Remove User Access to Credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.ALTERYX_API_KEY}}'
  exposes:
  - type: rest
    namespace: server-api-v3-credentials-rest
    port: 8080
    description: REST adapter for Alteryx Server API V3 — Credentials. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v3/credentials
      name: v3-credentials
      description: REST surface for v3-credentials.
      operations:
      - method: GET
        name: getcredentials
        description: Retrieve All Credentials
        call: server-api-v3-credentials.getcredentials
        with:
          view: rest.view
          userId: rest.userId
          userGroupId: rest.userGroupId
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcredential
        description: Create a New Credential
        call: server-api-v3-credentials.createcredential
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/credentials/{credentialid}
      name: v3-credentials-credentialid
      description: REST surface for v3-credentials-credentialId.
      operations:
      - method: GET
        name: getcredential
        description: Retrieve a Specific Credential
        call: server-api-v3-credentials.getcredential
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatecredential
        description: Update a Credential
        call: server-api-v3-credentials.updatecredential
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecredential
        description: Delete a Credential
        call: server-api-v3-credentials.deletecredential
        with:
          force: rest.force
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/credentials/{credentialid}/usergroups
      name: v3-credentials-credentialid-usergroups
      description: REST surface for v3-credentials-credentialId-userGroups.
      operations:
      - method: POST
        name: sharecredentialwithusergroup
        description: Share Credential With a User Group
        call: server-api-v3-credentials.sharecredentialwithusergroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/credentials/{credentialid}/usergroups/{usergroupid}
      name: v3-credentials-credentialid-usergroups-usergroupid
      description: REST surface for v3-credentials-credentialId-userGroups-userGroupId.
      operations:
      - method: DELETE
        name: removecredentialusergroupaccess
        description: Remove User Group Access to Credential
        call: server-api-v3-credentials.removecredentialusergroupaccess
        with:
          userGroupId: rest.userGroupId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/credentials/{credentialid}/users
      name: v3-credentials-credentialid-users
      description: REST surface for v3-credentials-credentialId-users.
      operations:
      - method: POST
        name: sharecredentialwithuser
        description: Share Credential With a User
        call: server-api-v3-credentials.sharecredentialwithuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/credentials/{credentialid}/users/{userid}
      name: v3-credentials-credentialid-users-userid
      description: REST surface for v3-credentials-credentialId-users-userId.
      operations:
      - method: DELETE
        name: removecredentialuseraccess
        description: Remove User Access to Credential
        call: server-api-v3-credentials.removecredentialuseraccess
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: server-api-v3-credentials-mcp
    port: 9090
    transport: http
    description: MCP adapter for Alteryx Server API V3 — Credentials. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: retrieve-all-credentials
      description: Retrieve All Credentials
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: server-api-v3-credentials.getcredentials
      with:
        view: tools.view
        userId: tools.userId
        userGroupId: tools.userGroupId
      outputParameters:
      - type: object
        mapping: $.
    - name: create-new-credential
      description: Create a New Credential
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: server-api-v3-credentials.createcredential
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-specific-credential
      description: Retrieve a Specific Credential
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: server-api-v3-credentials.getcredential
      outputParameters:
      - type: object
        mapping: $.
    - name: update-credential
      description: Update a Credential
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: server-api-v3-credentials.updatecredential
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-credential
      description: Delete a Credential
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: server-api-v3-credentials.deletecredential
      with:
        force: tools.force
      outputParameters:
      - type: object
        mapping: $.
    - name: share-credential-user-group
      description: Share Credential With a User Group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: server-api-v3-credentials.sharecredentialwithusergroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: remove-user-group-access-credential
      description: Remove User Group Access to Credential
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: server-api-v3-credentials.removecredentialusergroupaccess
      with:
        userGroupId: tools.userGroupId
      outputParameters:
      - type: object
        mapping: $.
    - name: share-credential-user
      description: Share Credential With a User
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: server-api-v3-credentials.sharecredentialwithuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: remove-user-access-credential
      description: Remove User Access to Credential
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: server-api-v3-credentials.removecredentialuseraccess
      outputParameters:
      - type: object
        mapping: $.