Avalara AvaTax APIs — Users

naftiko: 1.0.0-alpha2
info:
  label: Avalara AvaTax APIs — Users
  description: 'Avalara AvaTax APIs — Users. 8 operations. Lead operation: Avalara CreateUsers. Self-contained Naftiko capability
    covering one Avalara business surface.'
  tags:
  - Avalara
  - Users
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    AVALARA_API_KEY: AVALARA_API_KEY
capability:
  consumes:
  - type: http
    namespace: avatax-apis-users
    baseUri: http://{{baseurl}}
    description: Avalara AvaTax APIs — Users business capability. Self-contained, no shared references.
    resources:
    - name: api-v2-accounts-accountId-users
      path: /api/v2/accounts/{accountId}/users
      operations:
      - name: post
        method: POST
        description: Avalara CreateUsers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Content-Type
          in: header
          type: string
        - name: X-Avalara-Client
          in: header
          type: string
          description: Identifies the software you are using to call this API. For more information on the client header,
            see [Client Headers](https://developer.avalara.com/avatax/cli
        - name: accountId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: get
        method: GET
        description: Avalara ListUsersByAccount
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: X-Avalara-Client
          in: header
          type: string
          description: Identifies the software you are using to call this API. For more information on the client header,
            see [Client Headers](https://developer.avalara.com/avatax/cli
        - name: accountId
          in: path
          type: string
          required: true
    - name: api-v2-accounts-accountId-users-id
      path: /api/v2/accounts/{accountId}/users/{id}
      operations:
      - name: delete
        method: DELETE
        description: Avalara DeleteUser
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: X-Avalara-Client
          in: header
          type: string
          description: Identifies the software you are using to call this API. For more information on the client header,
            see [Client Headers](https://developer.avalara.com/avatax/cli
        - name: accountId
          in: path
          type: string
          required: true
        - name: id
          in: path
          type: string
          required: true
      - name: get
        method: GET
        description: Avalara GetUser
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: X-Avalara-Client
          in: header
          type: string
          description: Identifies the software you are using to call this API. For more information on the client header,
            see [Client Headers](https://developer.avalara.com/avatax/cli
        - name: accountId
          in: path
          type: string
          required: true
        - name: id
          in: path
          type: string
          required: true
      - name: put
        method: PUT
        description: Avalara UpdateUser
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Content-Type
          in: header
          type: string
        - name: X-Avalara-Client
          in: header
          type: string
          description: Identifies the software you are using to call this API. For more information on the client header,
            see [Client Headers](https://developer.avalara.com/avatax/cli
        - name: accountId
          in: path
          type: string
          required: true
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-v2-accounts-accountId-users-id-entitlements
      path: /api/v2/accounts/{accountId}/users/{id}/entitlements
      operations:
      - name: get
        method: GET
        description: Avalara GetUserEntitlements
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: X-Avalara-Client
          in: header
          type: string
          description: Identifies the software you are using to call this API. For more information on the client header,
            see [Client Headers](https://developer.avalara.com/avatax/cli
        - name: accountId
          in: path
          type: string
          required: true
        - name: id
          in: path
          type: string
          required: true
    - name: api-v2-passwords
      path: /api/v2/passwords
      operations:
      - name: put
        method: PUT
        description: Avalara ChangePassword
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Content-Type
          in: header
          type: string
        - name: X-Avalara-Client
          in: header
          type: string
          description: Identifies the software you are using to call this API. For more information on the client header,
            see [Client Headers](https://developer.avalara.com/avatax/cli
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-v2-users
      path: /api/v2/users
      operations:
      - name: get
        method: GET
        description: Avalara QueryUsers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: X-Avalara-Client
          in: header
          type: string
          description: Identifies the software you are using to call this API. For more information on the client header,
            see [Client Headers](https://developer.avalara.com/avatax/cli
    authentication:
      type: basic
      username: '{{env.AVALARA_USER}}'
      password: '{{env.AVALARA_PASS}}'
  exposes:
  - type: rest
    namespace: avatax-apis-users-rest
    port: 8080
    description: REST adapter for Avalara AvaTax APIs — Users. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api/v2/accounts/{accountid}/users
      name: api-v2-accounts-accountid-users
      description: REST surface for api-v2-accounts-accountId-users.
      operations:
      - method: POST
        name: post
        description: Avalara CreateUsers
        call: avatax-apis-users.post
        with:
          Content-Type: rest.Content-Type
          X-Avalara-Client: rest.X-Avalara-Client
          accountId: rest.accountId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: get
        description: Avalara ListUsersByAccount
        call: avatax-apis-users.get
        with:
          X-Avalara-Client: rest.X-Avalara-Client
          accountId: rest.accountId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v2/accounts/{accountid}/users/{id}
      name: api-v2-accounts-accountid-users-id
      description: REST surface for api-v2-accounts-accountId-users-id.
      operations:
      - method: DELETE
        name: delete
        description: Avalara DeleteUser
        call: avatax-apis-users.delete
        with:
          X-Avalara-Client: rest.X-Avalara-Client
          accountId: rest.accountId
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: get
        description: Avalara GetUser
        call: avatax-apis-users.get
        with:
          X-Avalara-Client: rest.X-Avalara-Client
          accountId: rest.accountId
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: put
        description: Avalara UpdateUser
        call: avatax-apis-users.put
        with:
          Content-Type: rest.Content-Type
          X-Avalara-Client: rest.X-Avalara-Client
          accountId: rest.accountId
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v2/accounts/{accountid}/users/{id}/entitlements
      name: api-v2-accounts-accountid-users-id-entitlements
      description: REST surface for api-v2-accounts-accountId-users-id-entitlements.
      operations:
      - method: GET
        name: get
        description: Avalara GetUserEntitlements
        call: avatax-apis-users.get
        with:
          X-Avalara-Client: rest.X-Avalara-Client
          accountId: rest.accountId
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v2/passwords
      name: api-v2-passwords
      description: REST surface for api-v2-passwords.
      operations:
      - method: PUT
        name: put
        description: Avalara ChangePassword
        call: avatax-apis-users.put
        with:
          Content-Type: rest.Content-Type
          X-Avalara-Client: rest.X-Avalara-Client
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v2/users
      name: api-v2-users
      description: REST surface for api-v2-users.
      operations:
      - method: GET
        name: get
        description: Avalara QueryUsers
        call: avatax-apis-users.get
        with:
          X-Avalara-Client: rest.X-Avalara-Client
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: avatax-apis-users-mcp
    port: 9090
    transport: http
    description: MCP adapter for Avalara AvaTax APIs — Users. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: avalara-createusers
      description: Avalara CreateUsers
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: avatax-apis-users.post
      with:
        Content-Type: tools.Content-Type
        X-Avalara-Client: tools.X-Avalara-Client
        accountId: tools.accountId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: avalara-listusersbyaccount
      description: Avalara ListUsersByAccount
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: avatax-apis-users.get
      with:
        X-Avalara-Client: tools.X-Avalara-Client
        accountId: tools.accountId
      outputParameters:
      - type: object
        mapping: $.
    - name: avalara-deleteuser
      description: Avalara DeleteUser
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: avatax-apis-users.delete
      with:
        X-Avalara-Client: tools.X-Avalara-Client
        accountId: tools.accountId
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: avalara-getuser
      description: Avalara GetUser
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: avatax-apis-users.get
      with:
        X-Avalara-Client: tools.X-Avalara-Client
        accountId: tools.accountId
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: avalara-updateuser
      description: Avalara UpdateUser
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: avatax-apis-users.put
      with:
        Content-Type: tools.Content-Type
        X-Avalara-Client: tools.X-Avalara-Client
        accountId: tools.accountId
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: avalara-getuserentitlements
      description: Avalara GetUserEntitlements
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: avatax-apis-users.get
      with:
        X-Avalara-Client: tools.X-Avalara-Client
        accountId: tools.accountId
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: avalara-changepassword
      description: Avalara ChangePassword
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: avatax-apis-users.put
      with:
        Content-Type: tools.Content-Type
        X-Avalara-Client: tools.X-Avalara-Client
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: avalara-queryusers
      description: Avalara QueryUsers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: avatax-apis-users.get
      with:
        X-Avalara-Client: tools.X-Avalara-Client
      outputParameters:
      - type: object
        mapping: $.