BetterCloud Platform API — Users

naftiko: 1.0.0-alpha2
info:
  label: BetterCloud Platform API — Users
  description: 'BetterCloud Platform API — Users. 5 operations. Lead operation: BetterCloud List Users. Self-contained Naftiko
    capability covering one Bettercloud business surface.'
  tags:
  - Bettercloud
  - Users
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BETTERCLOUD_API_KEY: BETTERCLOUD_API_KEY
capability:
  consumes:
  - type: http
    namespace: platform-users
    baseUri: https://api.bettercloud.com/v1
    description: BetterCloud Platform API — Users business capability. Self-contained, no shared references.
    resources:
    - name: users
      path: /users
      operations:
      - name: listusers
        method: GET
        description: BetterCloud List Users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: page
          in: query
          type: integer
          description: Page number for pagination.
        - name: per_page
          in: query
          type: integer
          description: Number of results per page (max 100).
        - name: email
          in: query
          type: string
          description: Filter users by email address.
        - name: status
          in: query
          type: string
          description: Filter users by status.
    - name: users-id
      path: /users/{id}
      operations:
      - name: getuser
        method: GET
        description: BetterCloud Get User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The unique identifier of the user.
          required: true
      - name: updateuser
        method: PATCH
        description: BetterCloud Update User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The unique identifier of the user.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: users-id-deprovision
      path: /users/{id}/deprovision
      operations:
      - name: deprovisionuser
        method: POST
        description: BetterCloud Deprovision User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The unique identifier of the user.
          required: true
    - name: users-id-suspend
      path: /users/{id}/suspend
      operations:
      - name: suspenduser
        method: POST
        description: BetterCloud Suspend User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The unique identifier of the user.
          required: true
    authentication:
      type: apikey
      key: X-API-Key
      value: '{{env.BETTERCLOUD_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: platform-users-rest
    port: 8080
    description: REST adapter for BetterCloud Platform API — Users. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/users
      name: users
      description: REST surface for users.
      operations:
      - method: GET
        name: listusers
        description: BetterCloud List Users
        call: platform-users.listusers
        with:
          page: rest.page
          per_page: rest.per_page
          email: rest.email
          status: rest.status
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{id}
      name: users-id
      description: REST surface for users-id.
      operations:
      - method: GET
        name: getuser
        description: BetterCloud Get User
        call: platform-users.getuser
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateuser
        description: BetterCloud Update User
        call: platform-users.updateuser
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{id}/deprovision
      name: users-id-deprovision
      description: REST surface for users-id-deprovision.
      operations:
      - method: POST
        name: deprovisionuser
        description: BetterCloud Deprovision User
        call: platform-users.deprovisionuser
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{id}/suspend
      name: users-id-suspend
      description: REST surface for users-id-suspend.
      operations:
      - method: POST
        name: suspenduser
        description: BetterCloud Suspend User
        call: platform-users.suspenduser
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: platform-users-mcp
    port: 9090
    transport: http
    description: MCP adapter for BetterCloud Platform API — Users. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: bettercloud-list-users
      description: BetterCloud List Users
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-users.listusers
      with:
        page: tools.page
        per_page: tools.per_page
        email: tools.email
        status: tools.status
      outputParameters:
      - type: object
        mapping: $.
    - name: bettercloud-get-user
      description: BetterCloud Get User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-users.getuser
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: bettercloud-update-user
      description: BetterCloud Update User
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: platform-users.updateuser
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: bettercloud-deprovision-user
      description: BetterCloud Deprovision User
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-users.deprovisionuser
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: bettercloud-suspend-user
      description: BetterCloud Suspend User
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-users.suspenduser
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.