SAP BI Tools Users API

openapi: 3.1.0
info:
  title: SAP BI Tools SAP Analytics Cloud Administration Users API
  description: RESTful API for SAP Analytics Cloud enabling programmatic access to system data stored on an SAP Analytics Cloud tenant. The API provides endpoints for managing stories, models, users, teams, calendars, and other resources. It supports SCIM 2.0 for user provisioning, OData for data access, and standard REST patterns for content management. Authentication uses OAuth 2.0 with SAML bearer assertion or authorization code grant flows.
  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}.{datacenter}.sapanalytics.cloud
  description: SAP Analytics Cloud Tenant
  variables:
    tenant:
      default: my-tenant
      description: The SAP Analytics Cloud tenant name
    datacenter:
      default: eu1
      description: The data center region (e.g., eu1, eu10, us1, us10, ap1)
security:
- oauth2: []
tags:
- name: Users
  description: SCIM 2.0 endpoints for managing user accounts, provisioning, and deprovisioning in SAP Analytics Cloud.
paths:
  /api/v1/scim/Users:
    get:
      operationId: listUsersScim1
      summary: SAP BI Tools List users (SCIM 1.1)
      description: Retrieves a list of users provisioned in SAP Analytics Cloud using SCIM 1.1 protocol. Supports filtering by user attributes such as userName and email. Returns user records with profile information, roles, and team memberships.
      tags:
      - Users
      parameters:
      - name: filter
        in: query
        description: SCIM filter expression (e.g., userName eq "john.doe")
        schema:
          type: string
      - $ref: '#/components/parameters/CountParam'
      - name: startIndex
        in: query
        description: The starting index for pagination (1-based)
        schema:
          type: integer
          default: 1
      responses:
        '200':
          description: Successfully retrieved list of users
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScimListResponse'
        '401':
          description: Unauthorized - invalid or missing authentication token
  /api/v1/scim2/Users:
    get:
      operationId: listUsersScim2
      summary: SAP BI Tools List users (SCIM 2.0)
      description: Retrieves a list of users provisioned in SAP Analytics Cloud using SCIM 2.0 protocol. Supports filtering by user attributes such as userName, email, and custom attributes. Returns user records with profile information, roles, and team memberships.
      tags:
      - Users
      parameters:
      - name: filter
        in: query
        description: SCIM 2.0 filter expression (e.g., userName eq "john.doe")
        schema:
          type: string
      - $ref: '#/components/parameters/CountParam'
      - name: startIndex
        in: query
        description: The starting index for pagination (1-based)
        schema:
          type: integer
          default: 1
      responses:
        '200':
          description: Successfully retrieved list of users
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScimListResponse'
        '401':
          description: Unauthorized - invalid or missing authentication token
    post:
      operationId: createUserScim2
      summary: SAP BI Tools Create a user (SCIM 2.0)
      description: Creates a new user in SAP Analytics Cloud using SCIM 2.0 protocol. Requires user profile attributes including userName, name, and email. Returns the created user record with its assigned ID.
      tags:
      - Users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScimUser'
      responses:
        '201':
          description: User created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScimUser'
        '400':
          description: Bad request - invalid user data
        '401':
          description: Unauthorized - invalid or missing authentication token
        '409':
          description: Conflict - user already exists
  /api/v1/scim2/Users/{userId}:
    get:
      operationId: getUserScim2
      summary: SAP BI Tools Get a user by ID (SCIM 2.0)
      description: Retrieves detailed information about a specific user identified by their unique user ID using SCIM 2.0 protocol.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/UserIdParam'
      responses:
        '200':
          description: Successfully retrieved user details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScimUser'
        '401':
          description: Unauthorized - invalid or missing authentication token
        '404':
          description: User not found
    put:
      operationId: updateUserScim2
      summary: SAP BI Tools Update a user (SCIM 2.0)
      description: Updates an existing user in SAP Analytics Cloud using SCIM 2.0 protocol. Replaces the entire user record with the provided data.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/UserIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScimUser'
      responses:
        '200':
          description: User updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScimUser'
        '400':
          description: Bad request - invalid user data
        '401':
          description: Unauthorized - invalid or missing authentication token
        '404':
          description: User not found
    delete:
      operationId: deleteUserScim2
      summary: SAP BI Tools Delete a user (SCIM 2.0)
      description: Deletes a user from SAP Analytics Cloud using SCIM 2.0 protocol. Permanently removes the user account and associated data.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/UserIdParam'
      responses:
        '204':
          description: User deleted successfully
        '401':
          description: Unauthorized - invalid or missing authentication token
        '404':
          description: User not found
components:
  parameters:
    UserIdParam:
      name: userId
      in: path
      required: true
      description: The unique identifier of the user
      schema:
        type: string
    CountParam:
      name: count
      in: query
      description: Maximum number of results to return per page
      schema:
        type: integer
  schemas:
    ScimListResponse:
      type: object
      description: A paginated list response conforming to SCIM 2.0 protocol.
      properties:
        totalResults:
          type: integer
          description: The total number of results matching the query
        itemsPerPage:
          type: integer
          description: The number of results returned per page
        startIndex:
          type: integer
          description: The starting index of the returned results
        Resources:
          type: array
          description: The list of resources in the current page
          items:
            type: object
    ScimUser:
      type: object
      description: A user record conforming to SCIM 2.0 protocol. Contains user profile attributes, roles, and team memberships.
      properties:
        id:
          type: string
          description: The unique identifier assigned to the user
        userName:
          type: string
          description: The login username for the user
        name:
          type: object
          description: The user's name components
          properties:
            givenName:
              type: string
              description: The first name of the user
            familyName:
              type: string
              description: The last name of the user
            formatted:
              type: string
              description: The full formatted name of the user
        displayName:
          type: string
          description: The display name of the user
        emails:
          type: array
          description: The email addresses for the user
          items:
            type: object
            properties:
              value:
                type: string
                format: email
                description: The email address
              primary:
                type: boolean
                description: Whether this is the primary email
        active:
          type: boolean
          description: Whether the user account is active
        roles:
          type: array
          description: The roles assigned to the user
          items:
            type: object
            properties:
              value:
                type: string
                description: The role identifier
        groups:
          type: array
          description: The teams the user belongs to
          items:
            type: object
            properties:
              value:
                type: string
                description: The team (group) identifier
              display:
                type: string
                description: The team display name
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0 authentication using SAML bearer assertion or authorization code grant flow.
      flows:
        authorizationCode:
          authorizationUrl: https://{tenant}.authentication.{region}.hana.ondemand.com/oauth/authorize
          tokenUrl: https://{tenant}.authentication.{region}.hana.ondemand.com/oauth/token
          scopes: {}
externalDocs:
  description: SAP Analytics Cloud REST API Documentation
  url: https://help.sap.com/docs/SAP_ANALYTICS_CLOUD/14cac91febef464dbb1efce20e3f1613/3ccfab3348dd407db089accb66cff9a2.html