SAP BI Tools Authentication API

openapi: 3.2.0
info:
  title: SAP BI Tools SAP BusinessObjects BI Platform RESTful Web Services Authentication API
  description: REST API for SAP BusinessObjects BI Platform (biprws) for managing documents, users, scheduling reports, and querying the CMS repository. The API provides endpoints for authentication via logon tokens, browsing the InfoStore repository, managing BI Inbox items, scheduling report execution, and performing CMS queries. Supports both JSON and XML response formats. Requires a logon token obtained through the logon endpoint for subsequent API calls.
  version: '4.3'
  contact:
    name: SAP Support
    url: https://support.sap.com/en/index.html
  termsOfService: https://www.sap.com/about/legal/terms-of-use.html
servers:
- url: http://{server}:{port}/biprws
  description: SAP BusinessObjects BI Platform Server
  variables:
    server:
      default: localhost
      description: The BI Platform server hostname
    port:
      default: '6405'
      description: The WACS port number
security:
- logonToken: []
tags:
- name: Authentication
  description: Logon and logoff endpoints for obtaining and invalidating session tokens required for all subsequent API calls.
paths:
  /logon/long:
    post:
      operationId: logon
      summary: SAP BI Tools Log on to BI Platform
      description: Authenticates a user against the BI Platform and returns a logon token that must be included in subsequent API requests. Supports Enterprise, LDAP, and Windows AD authentication types.
      tags:
      - Authentication
      security: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LogonRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/LogonRequest'
      responses:
        '200':
          description: Successfully authenticated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LogonResponse'
        '401':
          description: Authentication failed - invalid credentials
  /logoff:
    post:
      operationId: logoff
      summary: SAP BI Tools Log off from BI Platform
      description: Invalidates the current logon token and terminates the session. The logon token provided in the header is no longer valid after this call.
      tags:
      - Authentication
      responses:
        '200':
          description: Successfully logged off
        '401':
          description: Invalid or expired logon token
components:
  schemas:
    LogonResponse:
      type: object
      description: Response containing the logon token and session information
      properties:
        logonToken:
          type: string
          description: The logon token to use in subsequent API requests via the X-SAP-LogonToken header
    LogonRequest:
      type: object
      description: Authentication credentials for logging on to the BI Platform
      required:
      - userName
      - password
      - auth
      properties:
        userName:
          type: string
          description: The username for authentication
        password:
          type: string
          description: The password for authentication
          format: password
        auth:
          type: string
          description: The authentication type (secEnterprise, secLDAP, secWinAD)
          enum:
          - secEnterprise
          - secLDAP
          - secWinAD
          default: secEnterprise
  securitySchemes:
    logonToken:
      type: apiKey
      in: header
      name: X-SAP-LogonToken
      description: Logon token obtained from the /logon/long endpoint. Must be included in all subsequent API requests.
externalDocs:
  description: SAP BusinessObjects BI Platform RESTful Web Services Documentation
  url: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/e8c2e5877e9e44f9bfcc3085595b9208/