JetBrains Users API

openapi: 3.0.3
info:
  title: JetBrains Hub REST Activities Users API
  description: The JetBrains Hub REST API provides programmatic access to Hub, the centralized authentication and authorization service for JetBrains tools. It allows management of users, groups, projects, roles, permissions, and OAuth 2.0 services. Hub serves as the identity provider for YouTrack, TeamCity, and other connected JetBrains services.
  version: 2024.1.0
  contact:
    name: JetBrains
    url: https://www.jetbrains.com/help/youtrack/devportal/hub-rest-api-reference.html
  license:
    name: Proprietary
    url: https://www.jetbrains.com/legal/
servers:
- url: https://{instance}.youtrack.cloud/hub/api/rest
  description: Hub API (via YouTrack Cloud)
  variables:
    instance:
      default: myinstance
      description: Your instance name
security:
- bearerAuth: []
tags:
- name: Users
  description: User management
paths:
  /users:
    get:
      summary: JetBrains List Users
      description: Returns a list of Hub users.
      operationId: listUsers
      tags:
      - Users
      parameters:
      - name: fields
        in: query
        schema:
          type: string
      - name: $skip
        in: query
        schema:
          type: integer
      - name: $top
        in: query
        schema:
          type: integer
      responses:
        '200':
          description: Successful response with user list
  /users/{userId}:
    get:
      summary: JetBrains Get User
      description: Returns details of a specific user.
      operationId: getUser
      tags:
      - Users
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response with user details
  /users/me:
    get:
      summary: JetBrains Get Current User
      description: Returns the currently authenticated user.
      operationId: getCurrentUser
      tags:
      - Users
      responses:
        '200':
          description: Successful response with current user details
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Permanent token or OAuth 2.0 Bearer Token