openapi: 3.0.3
info:
  title: Determined AI REST Authentication API
  description: 'Determined is an open-source deep learning platform that helps teams train

    models faster, share GPU resources, and collaborate. The REST API exposes

    cluster, experiment, model, checkpoint, template, user, and token

    management capabilities used by the CLI and Web UI.

    '
  version: latest
  contact:
    name: Determined AI
    url: https://www.determined.ai/
  license:
    name: Apache-2.0
    url: https://github.com/determined-ai/determined/blob/main/LICENSE
servers:
- url: https://master.example.com
  description: Determined master server (cluster-specific)
security:
- bearerAuth: []
tags:
- name: Authentication
  description: Log in to and out of the cluster
paths:
  /api/v1/auth/login:
    post:
      tags:
      - Authentication
      summary: Log in
      operationId: login
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoginRequest'
      responses:
        '200':
          description: Authenticated session token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoginResponse'
  /api/v1/auth/logout:
    post:
      tags:
      - Authentication
      summary: Log out
      operationId: logout
      responses:
        '200':
          description: Session terminated
components:
  schemas:
    LoginResponse:
      type: object
      properties:
        token:
          type: string
        user:
          $ref: '#/components/schemas/User'
    User:
      type: object
      properties:
        id:
          type: integer
        username:
          type: string
        admin:
          type: boolean
        active:
          type: boolean
        displayName:
          type: string
    LoginRequest:
      type: object
      required:
      - username
      - password
      properties:
        username:
          type: string
        password:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token issued by the /auth/login endpoint.