SAP Business Intelligence Users API

openapi: 3.2.0
info:
  title: Sap Bi Users API
  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
  description: 'Operations tagged Users across 2 of this provider''s published API definitions: sap-bi-analytics-cloud-openapi.yml, sap-bi-businessobjects-platform-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{tenant}.sapanalytics.cloud/api/v1
  description: SAP Analytics Cloud Tenant
  variables:
    tenant:
      default: mytenant
      description: SAP Analytics Cloud tenant identifier
- url: https://{server}:{port}/biprws
  description: SAP BusinessObjects BI Platform Server
  variables:
    server:
      default: localhost
      description: BI Platform server hostname
    port:
      default: '6405'
      description: BI Platform server port
tags:
- name: Users
  description: Manage users and teams
paths:
  /users:
    get:
      operationId: listUsers
      summary: SAP Business Intelligence List users
      description: Retrieve a list of all users in the SAP Analytics Cloud tenant.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/offsetParam'
      responses:
        '200':
          description: List of users
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserCollection'
        '401':
          description: Unauthorized
      security:
      - oauth2: []
    servers:
    - url: https://{tenant}.sapanalytics.cloud/api/v1
      description: SAP Analytics Cloud Tenant
      variables:
        tenant:
          default: mytenant
          description: SAP Analytics Cloud tenant identifier
  /users/{userId}:
    get:
      operationId: getUser
      summary: SAP Business Intelligence Get a user
      description: Retrieve details of a specific user.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/userId'
      responses:
        '200':
          description: User details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '401':
          description: Unauthorized
        '404':
          description: User not found
      security:
      - oauth2: []
    servers:
    - url: https://{tenant}.sapanalytics.cloud/api/v1
      description: SAP Analytics Cloud Tenant
      variables:
        tenant:
          default: mytenant
          description: SAP Analytics Cloud tenant identifier
components:
  schemas:
    User:
      type: object
      properties:
        id:
          type: string
          description: User unique identifier
        userName:
          type: string
          description: Login username
        displayName:
          type: string
          description: Display name
        email:
          type: string
          format: email
          description: Email address
        roles:
          type: array
          items:
            type: string
          description: Assigned roles
        active:
          type: boolean
          description: Whether the user is active
        createdTime:
          type: string
          format: date-time
          description: When the user was created
    UserCollection:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/User'
        totalCount:
          type: integer
          description: Total number of users
    UserCollection_2:
      type: object
      properties:
        entries:
          type: array
          items:
            $ref: '#/components/schemas/BOBJUser'
        totalCount:
          type: integer
          description: Total number of users
    BOBJUser:
      type: object
      properties:
        SI_ID:
          type: integer
          description: User system identifier
        SI_NAME:
          type: string
          description: Username
        SI_DESCRIPTION:
          type: string
          description: User description
        SI_EMAIL_ADDRESS:
          type: string
          format: email
          description: User email address
        SI_DISABLED:
          type: boolean
          description: Whether the user account is disabled
        SI_NAMEDUSER:
          type: boolean
          description: Whether the user is a named user
  parameters:
    offsetParam:
      name: offset
      in: query
      description: Number of results to skip for pagination
      schema:
        type: integer
        default: 0
        minimum: 0
    limitParam:
      name: limit
      in: query
      description: Maximum number of results to return
      schema:
        type: integer
        default: 50
        minimum: 1
        maximum: 1000
    userId:
      name: userId
      in: path
      required: true
      description: User unique identifier
      schema:
        type: string
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0 authentication for SAP Analytics Cloud
      flows:
        clientCredentials:
          tokenUrl: https://{tenant}.sapanalytics.cloud/oauth/token
          scopes: {}
    logonToken:
      type: apiKey
      in: header
      name: X-SAP-LogonToken
      description: SAP BusinessObjects logon token obtained from the logon endpoint
x-refined-from:
- sap-bi-analytics-cloud-openapi.yml
- sap-bi-businessobjects-platform-openapi.yml