openapi: 3.2.0
info:
  contact:
    email: info@portainer.io
  description: Portainer API is an HTTP API served by Portainer.
  license:
    name: zlib
    url: https://github.com/portainer/portainer/blob/develop/LICENSE
  title: PortainerCE Auth API
  version: 2.39.1
servers:
- url: /api
tags:
- description: Authenticate against Portainer HTTP API
  name: Auth
paths:
  /auth:
    post:
      description: '**Access policy**: public

        Use this environment(endpoint) to authenticate against Portainer using a username and password.'
      operationId: AuthenticateUser
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/auth.authenticateResponse'
        '400':
          description: Invalid request
        '422':
          description: Invalid Credentials
        '500':
          description: Server error
      summary: Authenticate
      tags:
      - Auth
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/auth.authenticatePayload'
        description: Credentials used for authentication
        required: true
  /auth/logout:
    post:
      description: '**Access policy**: public'
      operationId: Logout
      responses:
        '204':
          description: Success
        '500':
          description: Server error
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Logout
      tags:
      - Auth
  /auth/oauth/validate:
    post:
      description: '**Access policy**: public'
      operationId: ValidateOAuth
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/auth.authenticateResponse'
        '400':
          description: Invalid request
        '422':
          description: Invalid Credentials
        '500':
          description: Server error
      summary: Authenticate with OAuth
      tags:
      - Auth
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/auth.oauthPayload'
        description: OAuth Credentials used for authentication
        required: true
components:
  schemas:
    auth.authenticatePayload:
      properties:
        Password:
          description: Password
          example: mypassword
          type: string
        Username:
          description: Username
          example: admin
          type: string
      required:
      - Password
      - Username
      type: object
    auth.oauthPayload:
      properties:
        Code:
          description: OAuth code returned from OAuth Provided
          type: string
      type: object
    auth.authenticateResponse:
      properties:
        jwt:
          description: JWT token used to authenticate against the API
          example: abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789abcdefghijklmnopqrstuvwxyzAB
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-KEY
      type: apiKey
    jwt:
      in: header
      name: Authorization
      type: apiKey