Vyond User API

openapi: 3.2.0
info:
  title: Vyond API Documentation User API
  version: 1.1.0
  description: 'APIs related to user

    '
tags:
- name: User
  description: 'APIs related to user

    '
paths:
  /rest/v1/users/me:
    get:
      operationId: UserController.getUser
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUserResBody'
          description: User information
        '401':
          description: Unauthorized - missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
          description: Forbidden - invalid owner type (non-user token)
        '429':
          description: Too Many Requests - rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
          description: Internal Server Error - unexpected error while retrieving user info
      summary: Get current user
      tags:
      - User
      security:
      - bearer: []
      description: Get information of current user based on the authorization
components:
  schemas:
    ApiErrorResponse:
      properties:
        err:
          type: string
          description: Error code identifying the specific error
        reason:
          type: string
          description: Additional reason describing why the error occurred
        message:
          type: string
          description: Error message, used as an alternative to reason for non-enumerated error messages
        scimType:
          type: string
          description: SCIM error type, present on SCIM 409 Conflict responses (e.g. uniqueness)
        details:
          items:
            $ref: '#/components/schemas/ValidationDetail'
          type: array
          description: Validation error details, present when err is REQUEST_VALIDATION_FAILED
      type: object
      required:
      - err
    GetUserResBody:
      properties:
        accountId:
          type: string
        email:
          type: string
        userId:
          type: string
        userPlan:
          type: string
        username:
          type: string
      type: object
      required:
      - accountId
      - email
      - userId
      - userPlan
      - username
    ValidationDetail:
      properties:
        property:
          type: string
          description: The property that failed validation
        message:
          items:
            type: string
          type: array
          description: Validation error messages for the property
      type: object
      required:
      - property
      - message
  securitySchemes:
    bearer:
      type: http
      scheme: bearer