Tableau REST API — Users

naftiko: 1.0.0-alpha2
info:
  label: Tableau REST API — Users
  description: 'Tableau REST API — Users. 9 operations. Lead operation: Tableau Get Group Members. Self-contained Naftiko
    capability covering one Tableau business surface.'
  tags:
  - Tableau
  - Users
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TABLEAU_API_KEY: TABLEAU_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-users
    baseUri: https://{server}/api/{api-version}
    description: Tableau REST API — Users business capability. Self-contained, no shared references.
    resources:
    - name: sites-site-id-groups-group-id-users
      path: /sites/{site-id}/groups/{group-id}/users
      operations:
      - name: getgroupmembers
        method: GET
        description: Tableau Get Group Members
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: addusertogroup
        method: POST
        description: Tableau Add User to Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: sites-site-id-groups-group-id-users-user-id
      path: /sites/{site-id}/groups/{group-id}/users/{user-id}
      operations:
      - name: removeuserfromgroup
        method: DELETE
        description: Tableau Remove User From Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: sites-site-id-users
      path: /sites/{site-id}/users
      operations:
      - name: getusers
        method: GET
        description: Tableau Get Users on Site
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: addusertosite
        method: POST
        description: Tableau Add User to Site
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: sites-site-id-users-user-id
      path: /sites/{site-id}/users/{user-id}
      operations:
      - name: queryuser
        method: GET
        description: Tableau Query User on Site
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateuser
        method: PUT
        description: Tableau Update User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: removeuserfromsite
        method: DELETE
        description: Tableau Remove User From Site
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: sites-site-id-users-user-id-workbooks
      path: /sites/{site-id}/users/{user-id}/workbooks
      operations:
      - name: queryworkbooksforuser
        method: GET
        description: Tableau Query Workbooks for User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: X-Tableau-Auth
      value: '{{env.TABLEAU_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: rest-users-rest
    port: 8080
    description: REST adapter for Tableau REST API — Users. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/sites/{site-id}/groups/{group-id}/users
      name: sites-site-id-groups-group-id-users
      description: REST surface for sites-site-id-groups-group-id-users.
      operations:
      - method: GET
        name: getgroupmembers
        description: Tableau Get Group Members
        call: rest-users.getgroupmembers
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: addusertogroup
        description: Tableau Add User to Group
        call: rest-users.addusertogroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sites/{site-id}/groups/{group-id}/users/{user-id}
      name: sites-site-id-groups-group-id-users-user-id
      description: REST surface for sites-site-id-groups-group-id-users-user-id.
      operations:
      - method: DELETE
        name: removeuserfromgroup
        description: Tableau Remove User From Group
        call: rest-users.removeuserfromgroup
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sites/{site-id}/users
      name: sites-site-id-users
      description: REST surface for sites-site-id-users.
      operations:
      - method: GET
        name: getusers
        description: Tableau Get Users on Site
        call: rest-users.getusers
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: addusertosite
        description: Tableau Add User to Site
        call: rest-users.addusertosite
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sites/{site-id}/users/{user-id}
      name: sites-site-id-users-user-id
      description: REST surface for sites-site-id-users-user-id.
      operations:
      - method: GET
        name: queryuser
        description: Tableau Query User on Site
        call: rest-users.queryuser
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateuser
        description: Tableau Update User
        call: rest-users.updateuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: removeuserfromsite
        description: Tableau Remove User From Site
        call: rest-users.removeuserfromsite
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sites/{site-id}/users/{user-id}/workbooks
      name: sites-site-id-users-user-id-workbooks
      description: REST surface for sites-site-id-users-user-id-workbooks.
      operations:
      - method: GET
        name: queryworkbooksforuser
        description: Tableau Query Workbooks for User
        call: rest-users.queryworkbooksforuser
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-users-mcp
    port: 9090
    transport: http
    description: MCP adapter for Tableau REST API — Users. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: tableau-get-group-members
      description: Tableau Get Group Members
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-users.getgroupmembers
      outputParameters:
      - type: object
        mapping: $.
    - name: tableau-add-user-group
      description: Tableau Add User to Group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-users.addusertogroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: tableau-remove-user-group
      description: Tableau Remove User From Group
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-users.removeuserfromgroup
      outputParameters:
      - type: object
        mapping: $.
    - name: tableau-get-users-site
      description: Tableau Get Users on Site
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-users.getusers
      outputParameters:
      - type: object
        mapping: $.
    - name: tableau-add-user-site
      description: Tableau Add User to Site
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-users.addusertosite
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: tableau-query-user-site
      description: Tableau Query User on Site
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-users.queryuser
      outputParameters:
      - type: object
        mapping: $.
    - name: tableau-update-user
      description: Tableau Update User
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-users.updateuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: tableau-remove-user-site
      description: Tableau Remove User From Site
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-users.removeuserfromsite
      outputParameters:
      - type: object
        mapping: $.
    - name: tableau-query-workbooks-user
      description: Tableau Query Workbooks for User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-users.queryworkbooksforuser
      outputParameters:
      - type: object
        mapping: $.