API Reference — subpackage_users

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_users
  description: 'API Reference — subpackage_users. 12 operations. Lead operation: ✨ Get current user info. Self-contained Naftiko
    capability covering one Label Studio business surface.'
  tags:
  - Label Studio
  - subpackage_users
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    LABEL_STUDIO_API_KEY: LABEL_STUDIO_API_KEY
capability:
  consumes:
  - type: http
    namespace: label-studio-subpackage-users
    baseUri: http://localhost:8000
    description: API Reference — subpackage_users business capability. Self-contained, no shared references.
    resources:
    - name: api-current-user
      path: /api/current-user
      operations:
      - name: getcurrentuser
        method: GET
        description: ✨ Get current user info
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
      - name: updatecurrentuser
        method: PATCH
        description: ✨ Update current user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-current-user-hotkeys
      path: /api/current-user/hotkeys/
      operations:
      - name: gethotkeys
        method: GET
        description: Get user hotkeys
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
      - name: updatehotkeys
        method: PATCH
        description: Update user hotkeys
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-current-user-reset-token
      path: /api/current-user/reset-token/
      operations:
      - name: resettoken
        method: POST
        description: Reset user token
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
    - name: api-current-user-token
      path: /api/current-user/token
      operations:
      - name: gettoken
        method: GET
        description: Get user token
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
    - name: api-current-user-whoami
      path: /api/current-user/whoami
      operations:
      - name: whoami
        method: GET
        description: Retrieve my user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
    - name: api-users
      path: /api/users/
      operations:
      - name: list
        method: GET
        description: List users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ordering
          in: query
          type: string
          description: Which field to use when ordering the results.
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
      - name: create
        method: POST
        description: Create new user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-users-id
      path: /api/users/{id}/
      operations:
      - name: get
        method: GET
        description: Get user info
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: User ID
          required: true
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
      - name: delete
        method: DELETE
        description: Delete user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: User ID
          required: true
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
      - name: update
        method: PATCH
        description: Update user details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: User ID
          required: true
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.LABEL_STUDIO_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: label-studio-subpackage-users-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_users. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/current-user
      name: api-current-user
      description: REST surface for api-current-user.
      operations:
      - method: GET
        name: getcurrentuser
        description: ✨ Get current user info
        call: label-studio-subpackage-users.getcurrentuser
        with:
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatecurrentuser
        description: ✨ Update current user
        call: label-studio-subpackage-users.updatecurrentuser
        with:
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/current-user/hotkeys
      name: api-current-user-hotkeys
      description: REST surface for api-current-user-hotkeys.
      operations:
      - method: GET
        name: gethotkeys
        description: Get user hotkeys
        call: label-studio-subpackage-users.gethotkeys
        with:
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatehotkeys
        description: Update user hotkeys
        call: label-studio-subpackage-users.updatehotkeys
        with:
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/current-user/reset-token
      name: api-current-user-reset-token
      description: REST surface for api-current-user-reset-token.
      operations:
      - method: POST
        name: resettoken
        description: Reset user token
        call: label-studio-subpackage-users.resettoken
        with:
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/current-user/token
      name: api-current-user-token
      description: REST surface for api-current-user-token.
      operations:
      - method: GET
        name: gettoken
        description: Get user token
        call: label-studio-subpackage-users.gettoken
        with:
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/current-user/whoami
      name: api-current-user-whoami
      description: REST surface for api-current-user-whoami.
      operations:
      - method: GET
        name: whoami
        description: Retrieve my user
        call: label-studio-subpackage-users.whoami
        with:
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/users
      name: api-users
      description: REST surface for api-users.
      operations:
      - method: GET
        name: list
        description: List users
        call: label-studio-subpackage-users.list
        with:
          ordering: rest.ordering
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: create
        description: Create new user
        call: label-studio-subpackage-users.create
        with:
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/users/{id}
      name: api-users-id
      description: REST surface for api-users-id.
      operations:
      - method: GET
        name: get
        description: Get user info
        call: label-studio-subpackage-users.get
        with:
          id: rest.id
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: Delete user
        call: label-studio-subpackage-users.delete
        with:
          id: rest.id
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: update
        description: Update user details
        call: label-studio-subpackage-users.update
        with:
          id: rest.id
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: label-studio-subpackage-users-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_users. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-current-user-info
      description: ✨ Get current user info
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio-subpackage-users.getcurrentuser
      with:
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: update-current-user
      description: ✨ Update current user
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: label-studio-subpackage-users.updatecurrentuser
      with:
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-user-hotkeys
      description: Get user hotkeys
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio-subpackage-users.gethotkeys
      with:
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: update-user-hotkeys
      description: Update user hotkeys
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: label-studio-subpackage-users.updatehotkeys
      with:
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: reset-user-token
      description: Reset user token
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio-subpackage-users.resettoken
      with:
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: get-user-token
      description: Get user token
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio-subpackage-users.gettoken
      with:
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-my-user
      description: Retrieve my user
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio-subpackage-users.whoami
      with:
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: list-users
      description: List users
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio-subpackage-users.list
      with:
        ordering: tools.ordering
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: create-new-user
      description: Create new user
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio-subpackage-users.create
      with:
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-user-info
      description: Get user info
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio-subpackage-users.get
      with:
        id: tools.id
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-user
      description: Delete user
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: label-studio-subpackage-users.delete
      with:
        id: tools.id
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: update-user-details
      description: Update user details
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: label-studio-subpackage-users.update
      with:
        id: tools.id
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.