SAP Business Intelligence Logon API

openapi: 3.1.0
info:
  title: SAP Business Intelligence SAP Analytics Cloud Catalog Logon API
  description: REST API for SAP Analytics Cloud enabling data integration, story management, model administration, and analytics operations. Provides programmatic access to create and manage stories, models, data imports, and user administration within SAP Analytics Cloud.
  version: '1.0'
  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: https://{tenant}.sapanalytics.cloud/api/v1
  description: SAP Analytics Cloud Tenant
  variables:
    tenant:
      default: mytenant
      description: SAP Analytics Cloud tenant identifier
security:
- oauth2: []
tags:
- name: Logon
  description: Authentication and session management
paths:
  /logon/long:
    post:
      operationId: logon
      summary: SAP Business Intelligence Log on to BI Platform
      description: Authenticate to the BI Platform and obtain a logon token for subsequent API calls.
      tags:
      - Logon
      security: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LogonRequest'
      responses:
        '200':
          description: Logon successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LogonResponse'
        '401':
          description: Invalid credentials
  /logoff:
    post:
      operationId: logoff
      summary: SAP Business Intelligence Log off from BI Platform
      description: Invalidate the current logon token and end the session.
      tags:
      - Logon
      responses:
        '200':
          description: Logoff successful
        '401':
          description: Unauthorized
components:
  schemas:
    LogonRequest:
      type: object
      required:
      - userName
      - password
      - auth
      properties:
        userName:
          type: string
          description: Login username
        password:
          type: string
          description: Login password
        auth:
          type: string
          enum:
          - secEnterprise
          - secLDAP
          - secWinAD
          - secSAPR3
          description: Authentication type
    LogonResponse:
      type: object
      properties:
        logonToken:
          type: string
          description: Authentication token for subsequent requests
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0 authentication for SAP Analytics Cloud
      flows:
        clientCredentials:
          tokenUrl: https://{tenant}.sapanalytics.cloud/oauth/token
          scopes: {}
externalDocs:
  description: SAP Analytics Cloud API Documentation
  url: https://help.sap.com/docs/SAP_ANALYTICS_CLOUD