openapi: 3.1.0
info:
  title: OptScale REST Authentication API
  description: OptScale is an open-source FinOps and cloud cost optimization platform by Hystax. The REST API exposes endpoints for managing organizations, cloud accounts, employees, pools, resources, expenses, recommendations, and optimization runs across AWS, Azure, GCP, Alibaba Cloud, and Kubernetes.
  version: '2.0'
  contact:
    name: Hystax OptScale
    url: https://hystax.com/optscale/
    email: info@hystax.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://{host}/restapi/v2
  description: OptScale REST API server
  variables:
    host:
      default: my.optscale.com
      description: OptScale hostname
security:
- bearerAuth: []
tags:
- name: Authentication
  description: User authentication and token management
paths:
  /auth/v2/tokens:
    post:
      tags:
      - Authentication
      summary: Create an authentication token
      operationId: createToken
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                  format: email
                password:
                  type: string
                  format: password
              required:
              - email
              - password
      responses:
        '201':
          description: Token created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Token'
components:
  schemas:
    Token:
      type: object
      properties:
        token:
          type: string
        user_id:
          type: string
        valid_until:
          type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
externalDocs:
  description: OptScale Documentation
  url: https://hystax.com/documentation/optscale/