IBM MQ Login API

openapi: 3.1.0
info:
  title: IBM MQ Administration REST Channels Login API
  description: REST API for administering and monitoring IBM MQ queue managers, queues, topics, subscriptions, and channels. Provides programmatic access to manage MQ objects and retrieve status information.
  version: '2.0'
  contact:
    name: IBM Support
    url: https://www.ibm.com/mysupport
    email: support@ibm.com
  license:
    name: IBM License
    url: https://www.ibm.com/terms
servers:
- url: https://{host}:{port}/ibmmq/rest/v2
  description: IBM MQ REST API v2
  variables:
    host:
      default: localhost
      description: Hostname of the MQ web server
    port:
      default: '9443'
      description: HTTPS port of the MQ web server
security:
- basicAuth: []
- tokenAuth: []
tags:
- name: Login
  description: Authentication token management
paths:
  /login:
    post:
      operationId: login
      summary: IBM MQ Authenticate and obtain LTPA token
      description: Authenticate with the MQ web server and obtain an LTPA token cookie for subsequent requests.
      tags:
      - Login
      parameters:
      - $ref: '#/components/parameters/ibmMqRestCsrfToken'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - username
              - password
              properties:
                username:
                  type: string
                  description: MQ user name
                password:
                  type: string
                  description: MQ user password
      responses:
        '200':
          description: Authentication successful
          headers:
            Set-Cookie:
              description: LTPA token cookie
              schema:
                type: string
        '401':
          description: Authentication failed
      security: []
    delete:
      operationId: logout
      summary: IBM MQ Log out and invalidate token
      description: Invalidate the current LTPA token and end the session.
      tags:
      - Login
      parameters:
      - $ref: '#/components/parameters/ibmMqRestCsrfToken'
      responses:
        '204':
          description: Logged out successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    ibmMqRestCsrfToken:
      name: ibm-mq-rest-csrf-token
      in: header
      required: false
      description: CSRF token required for state-changing operations
      schema:
        type: string
  responses:
    Unauthorized:
      description: Authentication required or credentials invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        error:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                description: Error type
              msgId:
                type: string
                description: Message identifier
              explanation:
                type: string
                description: Explanation of the error
              action:
                type: string
                description: Suggested action
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication with MQ user credentials
    tokenAuth:
      type: apiKey
      in: cookie
      name: LtpaToken2
      description: LTPA token-based authentication via login endpoint
externalDocs:
  description: IBM MQ REST API Documentation
  url: https://www.ibm.com/docs/en/ibm-mq/latest?topic=api-rest