Box Platform API — Users

naftiko: 1.0.0-alpha2
info:
  label: Box Platform API — Users
  description: 'Box Platform API — Users. 6 operations. Lead operation: Box List enterprise users. Self-contained Naftiko
    capability covering one Box business surface.'
  tags:
  - Box
  - Users
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BOX_API_KEY: BOX_API_KEY
capability:
  consumes:
  - type: http
    namespace: box-users
    baseUri: https://api.box.com/2.0
    description: Box Platform API — Users business capability. Self-contained, no shared references.
    resources:
    - name: users
      path: /users
      operations:
      - name: getusers
        method: GET
        description: Box List enterprise users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter_term
          in: query
          type: string
          description: Limits the results to only users who's `name` or
        - name: user_type
          in: query
          type: string
          description: Limits the results to the kind of user specified.
        - name: external_app_user_id
          in: query
          type: string
          description: Limits the results to app users with the given
        - name: fields
          in: query
          type: array
          description: A comma-separated list of attributes to include in the
        - name: offset
          in: query
          type: integer
          description: The offset of the item at which to begin the response.
        - name: limit
          in: query
          type: integer
          description: The maximum number of items to return per page.
        - name: usemarker
          in: query
          type: boolean
          description: Specifies whether to use marker-based pagination instead of
        - name: marker
          in: query
          type: string
          description: Defines the position marker at which to begin returning results. This is
      - name: postusers
        method: POST
        description: Box Create user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: A comma-separated list of attributes to include in the
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: users-me
      path: /users/me
      operations:
      - name: getusersme
        method: GET
        description: Box Get current user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: A comma-separated list of attributes to include in the
    - name: users-user_id
      path: /users/{user_id}
      operations:
      - name: getusersid
        method: GET
        description: Box Get user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: user_id
          in: path
          type: string
          description: The ID of the user.
          required: true
        - name: fields
          in: query
          type: array
          description: A comma-separated list of attributes to include in the
      - name: putusersid
        method: PUT
        description: Box Update user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: user_id
          in: path
          type: string
          description: The ID of the user.
          required: true
        - name: fields
          in: query
          type: array
          description: A comma-separated list of attributes to include in the
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deleteusersid
        method: DELETE
        description: Box Delete user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: user_id
          in: path
          type: string
          description: The ID of the user.
          required: true
        - name: notify
          in: query
          type: boolean
          description: Whether the user will receive email notification of
        - name: force
          in: query
          type: boolean
          description: Whether the user should be deleted even if this user
    authentication:
      type: bearer
      token: '{{env.BOX_API_KEY}}'
  exposes:
  - type: rest
    namespace: box-users-rest
    port: 8080
    description: REST adapter for Box 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: getusers
        description: Box List enterprise users
        call: box-users.getusers
        with:
          filter_term: rest.filter_term
          user_type: rest.user_type
          external_app_user_id: rest.external_app_user_id
          fields: rest.fields
          offset: rest.offset
          limit: rest.limit
          usemarker: rest.usemarker
          marker: rest.marker
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postusers
        description: Box Create user
        call: box-users.postusers
        with:
          fields: rest.fields
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/me
      name: users-me
      description: REST surface for users-me.
      operations:
      - method: GET
        name: getusersme
        description: Box Get current user
        call: box-users.getusersme
        with:
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{user-id}
      name: users-user-id
      description: REST surface for users-user_id.
      operations:
      - method: GET
        name: getusersid
        description: Box Get user
        call: box-users.getusersid
        with:
          user_id: rest.user_id
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putusersid
        description: Box Update user
        call: box-users.putusersid
        with:
          user_id: rest.user_id
          fields: rest.fields
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteusersid
        description: Box Delete user
        call: box-users.deleteusersid
        with:
          user_id: rest.user_id
          notify: rest.notify
          force: rest.force
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: box-users-mcp
    port: 9090
    transport: http
    description: MCP adapter for Box Platform API — Users. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: box-list-enterprise-users
      description: Box List enterprise users
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: box-users.getusers
      with:
        filter_term: tools.filter_term
        user_type: tools.user_type
        external_app_user_id: tools.external_app_user_id
        fields: tools.fields
        offset: tools.offset
        limit: tools.limit
        usemarker: tools.usemarker
        marker: tools.marker
      outputParameters:
      - type: object
        mapping: $.
    - name: box-create-user
      description: Box Create user
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: box-users.postusers
      with:
        fields: tools.fields
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: box-get-current-user
      description: Box Get current user
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: box-users.getusersme
      with:
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: box-get-user
      description: Box Get user
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: box-users.getusersid
      with:
        user_id: tools.user_id
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: box-update-user
      description: Box Update user
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: box-users.putusersid
      with:
        user_id: tools.user_id
        fields: tools.fields
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: box-delete-user
      description: Box Delete user
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: box-users.deleteusersid
      with:
        user_id: tools.user_id
        notify: tools.notify
        force: tools.force
      outputParameters:
      - type: object
        mapping: $.