IBM WebSphere Authentication API

openapi: 3.2.0
info:
  title: IBM MQ REST Authentication API
  description: 'REST API for IBM MQ messaging operations including sending and receiving messages, queue management, topic management, and monitoring. Supports both administration and messaging endpoints for point-to-point and publish-subscribe patterns. The API provides two main categories: the administrative REST API for managing MQ objects and the messaging REST API for sending and receiving messages.'
  version: 9.3.0
  license:
    name: IBM International License Agreement
    url: https://www.ibm.com/legal/terms
  contact:
    name: IBM Support
    url: https://www.ibm.com/mysupport
servers:
- url: https://localhost:9443/ibmmq/rest/v2
  description: IBM MQ REST API v2 Server
security:
- basicAuth: []
- tokenAuth: []
tags:
- name: Authentication
  description: Authentication and authorization
paths:
  /login:
    post:
      operationId: login
      summary: Authenticate and Get Ltpa Token
      description: Authenticates the user and returns an LTPA token cookie for subsequent requests.
      tags:
      - Authentication
      security: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - username
              - password
              properties:
                username:
                  type: string
                password:
                  type: string
                  format: password
            examples:
              LoginRequestExample:
                summary: Default login request
                x-microcks-default: true
                value:
                  username: example_value
                  password: example_value
      responses:
        '200':
          description: Authentication successful
          headers:
            Set-Cookie:
              description: LTPA token cookie
              schema:
                type: string
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Login401Example:
                  summary: Default login 401 response
                  x-microcks-default: true
                  value:
                    error:
                    - type: example_value
                      msgId: '500123'
                      explanation: example_value
                      action: example_value
                      message: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /logout:
    post:
      operationId: logout
      summary: Logout and Invalidate Token
      description: Invalidates the current LTPA token.
      tags:
      - Authentication
      responses:
        '204':
          description: Logout successful
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
              msgId:
                type: string
              explanation:
                type: string
              action:
                type: string
              message:
                type: string
          example: []
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication
    tokenAuth:
      type: apiKey
      in: cookie
      name: LtpaToken2
      description: LTPA token authentication
externalDocs:
  description: IBM MQ REST API Documentation
  url: https://www.ibm.com/docs/en/ibm-mq/9.3?topic=api-rest-reference