@iblai/iblai-api 2025.11.13-teams-bot-renovation-ai → 2025.11.13-teams-bot-renovation-3-ai

package/sdk_schema.yml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: ibl-data-manager
-  version: 4.89.4-ai-plus
+  version: 4.90.2-ai-plus
   description: API for iblai
 paths:
   /api/ai-account/connected-services/callback/:
@@ -36,9 +36,6 @@ paths:
         name: provider
         schema:
           type: string
-          enum:
-          - google
-        description: '* `google` - Google'
       - name: search
         required: false
         in: query
@@ -49,16 +46,6 @@ paths:
         name: service
         schema:
           type: string
-          enum:
-          - google_calendar
-          - google_document
-          - google_drive
-          - google_slides
-        description: |-
-          * `google_drive` - Google Drive
-          * `google_document` - Google Document
-          * `google_slides` - Google Slides
-          * `google_calendar` - Google Calendar
       - in: path
         name: user_id
         schema:
@@ -1041,6 +1028,87 @@ paths:
                       display_name: Google
                   summary: LLM credentials example
           description: ''
+  /api/ai-account/orgs/{org}/oauth-services/:
+    get:
+      operationId: ai_account_orgs_oauth_services_list
+      description: |-
+        Return the list of OAuth services that can be used for connected services.
+
+        Query Parameters:
+            name (optional): Filter by exact service name (case-insensitive).
+            include_disabled (optional): Set to `true` to include disabled services.
+      parameters:
+      - in: path
+        name: org
+        schema:
+          type: string
+        required: true
+      tags:
+      - ai-account
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/OAuthProvider'
+              examples:
+                OAuthServices:
+                  value:
+                  - - name: google
+                      description: Google OAuth service
+                      auth_url: https://accounts.google.com/o/oauth2/v2/auth
+                      token_url: https://oauth2.googleapis.com/token
+                      scope_map:
+                        drive: https://www.googleapis.com/auth/drive
+                      scopes:
+                      - oauth_service: google
+                        name: google_drive
+                        scope: https://www.googleapis.com/auth/drive
+                  summary: OAuth services
+          description: ''
+  /api/ai-account/orgs/{org}/oauth-services/{service_name}/scopes/:
+    get:
+      operationId: ai_account_orgs_oauth_services_scopes_list
+      description: |-
+        Return the available scopes for the specified OAuth service.
+
+        Query Parameters:
+            include_disabled (optional): Set to `true` to include scopes from disabled services.
+      parameters:
+      - in: path
+        name: org
+        schema:
+          type: string
+        required: true
+      - in: path
+        name: service_name
+        schema:
+          type: string
+        required: true
+      tags:
+      - ai-account
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/OAuthService'
+              examples:
+                OAuthScopes:
+                  value:
+                  - - oauth_service: google
+                      name: google_drive
+                      scope: https://www.googleapis.com/auth/drive
+                  summary: OAuth scopes
+          description: ''
   /api/ai-account/orgs/{org}/use-default-llm-key/:
     post:
       operationId: ai_account_orgs_use_default_llm_key_create
@@ -21529,6 +21597,315 @@ paths:
           description: ''
         '404':
           description: User not found
+  /api/ai-mentor/orgs/{org}/users/{user_id}/mcp-server-connections/:
+    get:
+      operationId: ai_mentor_orgs_users_mcp_server_connections_list
+      description: |-
+        ViewSet for MCP server connections.
+
+        Tenant administrators can create user- or platform-scoped connections that
+        encapsulate the authentication configuration for invoking an MCP server.
+      parameters:
+      - in: query
+        name: auth_type
+        schema:
+          type: string
+          enum:
+          - none
+          - oauth2
+          - token
+        description: |-
+          * `none` - None
+          * `token` - Token
+          * `oauth2` - Oauth2
+      - in: query
+        name: is_active
+        schema:
+          type: boolean
+      - in: query
+        name: mentor
+        schema:
+          type: string
+      - in: path
+        name: org
+        schema:
+          type: string
+        required: true
+      - name: page
+        required: false
+        in: query
+        description: A page number within the paginated result set.
+        schema:
+          type: integer
+      - name: page_size
+        required: false
+        in: query
+        description: Number of results to return per page.
+        schema:
+          type: integer
+      - in: query
+        name: scope
+        schema:
+          type: string
+          enum:
+          - mentor
+          - platform
+          - user
+        description: |-
+          Whether this connection is scoped to a user or shared across a platform.
+
+          * `user` - User
+          * `mentor` - Mentor
+          * `platform` - Platform
+      - name: search
+        required: false
+        in: query
+        description: A search term.
+        schema:
+          type: string
+      - in: query
+        name: server
+        schema:
+          type: number
+      - in: query
+        name: user
+        schema:
+          type: string
+      - in: path
+        name: user_id
+        schema:
+          type: string
+        required: true
+      tags:
+      - ai-mentor
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PaginatedMCPServerConnectionList'
+          description: ''
+    post:
+      operationId: ai_mentor_orgs_users_mcp_server_connections_create
+      description: |-
+        ViewSet for MCP server connections.
+
+        Tenant administrators can create user- or platform-scoped connections that
+        encapsulate the authentication configuration for invoking an MCP server.
+      parameters:
+      - in: path
+        name: org
+        schema:
+          type: string
+        required: true
+      - in: path
+        name: user_id
+        schema:
+          type: string
+        required: true
+      tags:
+      - ai-mentor
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/MCPServerConnection'
+          application/scim+json:
+            schema:
+              $ref: '#/components/schemas/MCPServerConnection'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/MCPServerConnection'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/MCPServerConnection'
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/MCPServerConnection'
+        required: true
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '201':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/MCPServerConnection'
+          description: ''
+  /api/ai-mentor/orgs/{org}/users/{user_id}/mcp-server-connections/{id}/:
+    get:
+      operationId: ai_mentor_orgs_users_mcp_server_connections_retrieve
+      description: |-
+        ViewSet for MCP server connections.
+
+        Tenant administrators can create user- or platform-scoped connections that
+        encapsulate the authentication configuration for invoking an MCP server.
+      parameters:
+      - in: path
+        name: id
+        schema:
+          type: integer
+        description: A unique integer value identifying this mcp server connection.
+        required: true
+      - in: path
+        name: org
+        schema:
+          type: string
+        required: true
+      - in: path
+        name: user_id
+        schema:
+          type: string
+        required: true
+      tags:
+      - ai-mentor
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/MCPServerConnection'
+          description: ''
+    put:
+      operationId: ai_mentor_orgs_users_mcp_server_connections_update
+      description: |-
+        ViewSet for MCP server connections.
+
+        Tenant administrators can create user- or platform-scoped connections that
+        encapsulate the authentication configuration for invoking an MCP server.
+      parameters:
+      - in: path
+        name: id
+        schema:
+          type: integer
+        description: A unique integer value identifying this mcp server connection.
+        required: true
+      - in: path
+        name: org
+        schema:
+          type: string
+        required: true
+      - in: path
+        name: user_id
+        schema:
+          type: string
+        required: true
+      tags:
+      - ai-mentor
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/MCPServerConnection'
+          application/scim+json:
+            schema:
+              $ref: '#/components/schemas/MCPServerConnection'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/MCPServerConnection'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/MCPServerConnection'
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/MCPServerConnection'
+        required: true
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/MCPServerConnection'
+          description: ''
+    patch:
+      operationId: ai_mentor_orgs_users_mcp_server_connections_partial_update
+      description: |-
+        ViewSet for MCP server connections.
+
+        Tenant administrators can create user- or platform-scoped connections that
+        encapsulate the authentication configuration for invoking an MCP server.
+      parameters:
+      - in: path
+        name: id
+        schema:
+          type: integer
+        description: A unique integer value identifying this mcp server connection.
+        required: true
+      - in: path
+        name: org
+        schema:
+          type: string
+        required: true
+      - in: path
+        name: user_id
+        schema:
+          type: string
+        required: true
+      tags:
+      - ai-mentor
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PatchedMCPServerConnection'
+          application/scim+json:
+            schema:
+              $ref: '#/components/schemas/PatchedMCPServerConnection'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/PatchedMCPServerConnection'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/PatchedMCPServerConnection'
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/PatchedMCPServerConnection'
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/MCPServerConnection'
+          description: ''
+    delete:
+      operationId: ai_mentor_orgs_users_mcp_server_connections_destroy
+      description: |-
+        ViewSet for MCP server connections.
+
+        Tenant administrators can create user- or platform-scoped connections that
+        encapsulate the authentication configuration for invoking an MCP server.
+      parameters:
+      - in: path
+        name: id
+        schema:
+          type: integer
+        description: A unique integer value identifying this mcp server connection.
+        required: true
+      - in: path
+        name: org
+        schema:
+          type: string
+        required: true
+      - in: path
+        name: user_id
+        schema:
+          type: string
+        required: true
+      tags:
+      - ai-mentor
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '204':
+          description: No response body
   /api/ai-mentor/orgs/{org}/users/{user_id}/mcp-servers/:
     get:
       operationId: ai_mentor_orgs_users_mcp_servers_list
@@ -69648,20 +70025,42 @@ components:
       - value
     ConnectedService:
       type: object
+      description: |-
+        Serializer for representing connected OAuth services.
+
+        Includes both the legacy `service` / `scope` string values and structured
+        representations so that consumers can reason about individual scope names.
       properties:
         id:
           type: integer
           readOnly: true
         provider:
-          $ref: '#/components/schemas/ConnectedServiceProviderEnum'
+          type: string
+          maxLength: 128
         service:
-          $ref: '#/components/schemas/ServiceEnum'
+          type: string
+          maxLength: 255
         expires_at:
           type: string
           format: date-time
           nullable: true
         scope:
           type: string
+        scope_names:
+          type: array
+          items:
+            type: string
+          description: Return the canonical list of scope identifiers for the connection.
+          readOnly: true
+        scopes:
+          type: array
+          items:
+            type: string
+          description: Return the OAuth scope strings associated with the connection.
+          readOnly: true
+        token_type:
+          type: string
+          maxLength: 32
         service_info:
           allOf:
           - $ref: '#/components/schemas/ExternalServiceInfo'
@@ -69669,14 +70068,9 @@ components:
       required:
       - id
       - provider
-      - scope
-      - service
+      - scope_names
+      - scopes
       - service_info
-    ConnectedServiceProviderEnum:
-      enum:
-      - google
-      type: string
-      description: '* `google` - Google'
     ConsumerChannel:
       type: object
       description: Serializer for channel
@@ -72338,7 +72732,7 @@ components:
           type: integer
           readOnly: true
         scope:
-          $ref: '#/components/schemas/ScopeEnum'
+          $ref: '#/components/schemas/DisclaimerScopeEnum'
         platform:
           type: integer
           readOnly: true
@@ -72406,6 +72800,14 @@ components:
       - platform_key
       - user
       - user_id
+    DisclaimerScopeEnum:
+      enum:
+      - platform
+      - mentor
+      type: string
+      description: |-
+        * `platform` - Platform
+        * `mentor` - Mentor
     DiscordConfig:
       type: object
       properties:
@@ -74694,9 +75096,10 @@ components:
           $ref: '#/components/schemas/TransportEnum'
         credentials:
           type: string
-          description: 'Authorization credentials to uauthenticate to the mcp server.
-            if provided takes priority over connected service and headers. Token here
-            must be the full authorization value. For example: `<scheme> <credentials>`'
+          description: 'Authorization credentials to authenticate to the MCP server.
+            If provided, these take priority over any headers configured on the server.
+            Token here must be the full authorization value. For example: `<scheme>
+            <credentials>`'
         extra_headers:
           description: Headers to send to the MCP server. Useful for authentication,
         platform_key:
@@ -74733,6 +75136,94 @@ components:
       - platform_key
       - updated_at
       - url
+    MCPServerConnection:
+      type: object
+      description: |-
+        Serializer for managing `MCPServerConnection` records via the API.
+
+        The serializer enforces the business rules for combining scope, platform,
+        and authentication configuration while exposing a masked view of any stored
+        credentials.
+      properties:
+        id:
+          type: integer
+          readOnly: true
+        server:
+          type: integer
+        server_name:
+          type: string
+          readOnly: true
+        scope:
+          allOf:
+          - $ref: '#/components/schemas/MCPServerConnectionScopeEnum'
+          description: |-
+            Whether this connection is scoped to a user or shared across a platform.
+
+            * `user` - User
+            * `mentor` - Mentor
+            * `platform` - Platform
+        auth_type:
+          $ref: '#/components/schemas/AuthTypeEnum'
+        platform:
+          type: integer
+          nullable: true
+        platform_key:
+          type: string
+          nullable: true
+          readOnly: true
+        user:
+          type: string
+          nullable: true
+          description: edX username
+        mentor:
+          type: string
+          format: uuid
+          nullable: true
+        connected_service:
+          type: integer
+          nullable: true
+        connected_service_summary:
+          type: object
+          additionalProperties: {}
+          nullable: true
+          readOnly: true
+        credentials:
+          type: string
+          description: Static credential/token value for token-based authentication.
+        authorization_scheme:
+          type: string
+          description: Authorization scheme to prefix tokens with (e.g. 'Bearer').
+          maxLength: 50
+        extra_headers:
+          description: Additional headers to include when connecting to the MCP server.
+        is_active:
+          type: boolean
+        created_at:
+          type: string
+          format: date-time
+          readOnly: true
+        updated_at:
+          type: string
+          format: date-time
+          readOnly: true
+      required:
+      - connected_service_summary
+      - created_at
+      - id
+      - platform_key
+      - server
+      - server_name
+      - updated_at
+    MCPServerConnectionScopeEnum:
+      enum:
+      - user
+      - mentor
+      - platform
+      type: string
+      description: |-
+        * `user` - User
+        * `mentor` - Mentor
+        * `platform` - Platform
     ManagerAuthToken:
       type: object
       description: Manager auth token serializer
@@ -77576,6 +78067,114 @@ components:
     NullEnum:
       enum:
       - null
+    OAuthProvider:
+      type: object
+      description: Read-only serializer for OAuth providers, including the services
+        they expose.
+      properties:
+        id:
+          type: integer
+          readOnly: true
+        name:
+          type: string
+          readOnly: true
+        description:
+          type: string
+          readOnly: true
+        url:
+          type: string
+          format: uri
+          readOnly: true
+        image:
+          type: string
+          format: uri
+          readOnly: true
+          nullable: true
+        scope_map:
+          readOnly: true
+        auth_url:
+          type: string
+          format: uri
+          readOnly: true
+        token_url:
+          type: string
+          format: uri
+          readOnly: true
+        is_enabled:
+          type: boolean
+          readOnly: true
+        created_at:
+          type: string
+          format: date-time
+          readOnly: true
+        updated_at:
+          type: string
+          format: date-time
+          readOnly: true
+        services:
+          type: array
+          items:
+            $ref: '#/components/schemas/OAuthService'
+          readOnly: true
+      required:
+      - auth_url
+      - created_at
+      - description
+      - id
+      - image
+      - is_enabled
+      - name
+      - scope_map
+      - services
+      - token_url
+      - updated_at
+      - url
+    OAuthService:
+      type: object
+      description: Read-only serializer exposing details about an OAuth service.
+      properties:
+        id:
+          type: integer
+          readOnly: true
+        oauth_provider:
+          type: string
+          readOnly: true
+        name:
+          type: string
+          readOnly: true
+        display_name:
+          type: string
+          readOnly: true
+          description: Human readable label for the OAuth service scope.
+        description:
+          type: string
+          readOnly: true
+        scope:
+          type: string
+          readOnly: true
+        image:
+          type: string
+          format: uri
+          readOnly: true
+          nullable: true
+        created_at:
+          type: string
+          format: date-time
+          readOnly: true
+        updated_at:
+          type: string
+          format: date-time
+          readOnly: true
+      required:
+      - created_at
+      - description
+      - display_name
+      - id
+      - image
+      - name
+      - oauth_provider
+      - scope
+      - updated_at
     OAuthStartResponse:
       type: object
       properties:
@@ -78372,6 +78971,29 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/JobRun'
+    PaginatedMCPServerConnectionList:
+      type: object
+      required:
+      - count
+      - results
+      properties:
+        count:
+          type: integer
+          example: 123
+        next:
+          type: string
+          nullable: true
+          format: uri
+          example: http://api.example.org/accounts/?page=4
+        previous:
+          type: string
+          nullable: true
+          format: uri
+          example: http://api.example.org/accounts/?page=2
+        results:
+          type: array
+          items:
+            $ref: '#/components/schemas/MCPServerConnection'
     PaginatedMCPServerList:
       type: object
       required:
@@ -79657,7 +80279,7 @@ components:
           type: integer
           readOnly: true
         scope:
-          $ref: '#/components/schemas/ScopeEnum'
+          $ref: '#/components/schemas/DisclaimerScopeEnum'
         platform:
           type: integer
           readOnly: true
@@ -79816,9 +80438,10 @@ components:
           $ref: '#/components/schemas/TransportEnum'
         credentials:
           type: string
-          description: 'Authorization credentials to uauthenticate to the mcp server.
-            if provided takes priority over connected service and headers. Token here
-            must be the full authorization value. For example: `<scheme> <credentials>`'
+          description: 'Authorization credentials to authenticate to the MCP server.
+            If provided, these take priority over any headers configured on the server.
+            Token here must be the full authorization value. For example: `<scheme>
+            <credentials>`'
         extra_headers:
           description: Headers to send to the MCP server. Useful for authentication,
         platform_key:
@@ -79847,6 +80470,76 @@ components:
           type: string
           format: date-time
           readOnly: true
+    PatchedMCPServerConnection:
+      type: object
+      description: |-
+        Serializer for managing `MCPServerConnection` records via the API.
+
+        The serializer enforces the business rules for combining scope, platform,
+        and authentication configuration while exposing a masked view of any stored
+        credentials.
+      properties:
+        id:
+          type: integer
+          readOnly: true
+        server:
+          type: integer
+        server_name:
+          type: string
+          readOnly: true
+        scope:
+          allOf:
+          - $ref: '#/components/schemas/MCPServerConnectionScopeEnum'
+          description: |-
+            Whether this connection is scoped to a user or shared across a platform.
+
+            * `user` - User
+            * `mentor` - Mentor
+            * `platform` - Platform
+        auth_type:
+          $ref: '#/components/schemas/AuthTypeEnum'
+        platform:
+          type: integer
+          nullable: true
+        platform_key:
+          type: string
+          nullable: true
+          readOnly: true
+        user:
+          type: string
+          nullable: true
+          description: edX username
+        mentor:
+          type: string
+          format: uuid
+          nullable: true
+        connected_service:
+          type: integer
+          nullable: true
+        connected_service_summary:
+          type: object
+          additionalProperties: {}
+          nullable: true
+          readOnly: true
+        credentials:
+          type: string
+          description: Static credential/token value for token-based authentication.
+        authorization_scheme:
+          type: string
+          description: Authorization scheme to prefix tokens with (e.g. 'Bearer').
+          maxLength: 50
+        extra_headers:
+          description: Additional headers to include when connecting to the MCP server.
+        is_active:
+          type: boolean
+        created_at:
+          type: string
+          format: date-time
+          readOnly: true
+        updated_at:
+          type: string
+          format: date-time
+          readOnly: true
     PatchedMediaResource:
       type: object
       properties:
@@ -86743,14 +87436,6 @@ components:
           type: string
       required:
       - message
-    ScopeEnum:
-      enum:
-      - platform
-      - mentor
-      type: string
-      description: |-
-        * `platform` - Platform
-        * `mentor` - Mentor
     Section:
       type: object
       properties:
@@ -86860,18 +87545,6 @@ components:
       required:
       - sentiment_distribution
       - total_sentiments
-    ServiceEnum:
-      enum:
-      - google_drive
-      - google_document
-      - google_slides
-      - google_calendar
-      type: string
-      description: |-
-        * `google_drive` - Google Drive
-        * `google_document` - Google Document
-        * `google_slides` - Google Slides
-        * `google_calendar` - Google Calendar
     SessionBrowserScreenshot:
       type: object
       properties: