@iblai/iblai-api 4.92.0-ai → 4.92.1-ai

package/sdk_schema.yml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: ibl-data-manager
-  version: 4.92.0-ai-plus
+  version: 4.92.1-ai-plus
   description: API for iblai
 paths:
   /api/ai-account/connected-services/callback/:
@@ -54477,7 +54477,7 @@ paths:
       responses:
         '200':
           description: No response body
-  /api/credentials/orgs/{org}/users/{user_id}/:
+  /api/credentials/orgs/{platform_key}/users/{username}/:
     get:
       operationId: credentials_orgs_users_retrieve
       description: |-
@@ -54492,12 +54492,12 @@ paths:
         - program: Program ID to filter credentials
       parameters:
       - in: path
-        name: org
+        name: platform_key
         schema:
           type: string
         required: true
       - in: path
-        name: user_id
+        name: username
         schema:
           type: string
         required: true
@@ -54593,12 +54593,12 @@ paths:
             - Only public credentials are returned by default
       parameters:
       - in: path
-        name: org
+        name: platform_key
         schema:
           type: string
         required: true
       - in: path
-        name: user_id
+        name: username
         schema:
           type: string
         required: true
@@ -54631,7 +54631,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/Credential'
           description: ''
-  /api/credentials/orgs/{org}/users/{user_id}/{entity_id}:
+  /api/credentials/orgs/{platform_key}/users/{username}/{entity_id}:
     get:
       operationId: credentials_orgs_users_retrieve_2
       description: |-
@@ -54696,12 +54696,12 @@ paths:
           type: string
         required: true
       - in: path
-        name: org
+        name: platform_key
         schema:
           type: string
         required: true
       - in: path
-        name: user_id
+        name: username
         schema:
           type: string
         required: true
@@ -54780,12 +54780,12 @@ paths:
           type: string
         required: true
       - in: path
-        name: org
+        name: platform_key
         schema:
           type: string
         required: true
       - in: path
-        name: user_id
+        name: username
         schema:
           type: string
         required: true
@@ -54882,12 +54882,12 @@ paths:
           type: string
         required: true
       - in: path
-        name: org
+        name: platform_key
         schema:
           type: string
         required: true
       - in: path
-        name: user_id
+        name: username
         schema:
           type: string
         required: true
@@ -54898,7 +54898,7 @@ paths:
       responses:
         '204':
           description: No response body
-  /api/credentials/orgs/{org}/users/{user_id}/{entity_id}/assertions/:
+  /api/credentials/orgs/{platform_key}/users/{username}/{entity_id}/assertions/:
     get:
       operationId: credentials_orgs_users_assertions_retrieve_3
       description: |-
@@ -54937,12 +54937,12 @@ paths:
           type: string
         required: true
       - in: path
-        name: org
+        name: platform_key
         schema:
           type: string
         required: true
       - in: path
-        name: user_id
+        name: username
         schema:
           type: string
         required: true
@@ -54995,12 +54995,12 @@ paths:
           type: string
         required: true
       - in: path
-        name: org
+        name: platform_key
         schema:
           type: string
         required: true
       - in: path
-        name: user_id
+        name: username
         schema:
           type: string
         required: true
@@ -55033,7 +55033,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/Assertion'
           description: ''
-  /api/credentials/orgs/{org}/users/{user_id}/{entity_id}/assertions/bulk/:
+  /api/credentials/orgs/{platform_key}/users/{username}/{entity_id}/assertions/bulk/:
     post:
       operationId: credentials_orgs_users_assertions_bulk_create
       description: |-
@@ -55071,12 +55071,12 @@ paths:
           type: string
         required: true
       - in: path
-        name: org
+        name: platform_key
         schema:
           type: string
         required: true
       - in: path
-        name: user_id
+        name: username
         schema:
           type: string
         required: true
@@ -55109,7 +55109,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/BulkCreateAssertion'
           description: ''
-  /api/credentials/orgs/{org}/users/{user_id}/assertions/:
+  /api/credentials/orgs/{platform_key}/users/{username}/assertions/:
     get:
       operationId: credentials_orgs_users_assertions_retrieve
       description: |-
@@ -55154,11 +55154,6 @@ paths:
         name: include_revoked
         schema:
           type: boolean
-      - in: path
-        name: org
-        schema:
-          type: string
-        required: true
       - in: query
         name: page
         schema:
@@ -55171,7 +55166,12 @@ paths:
           maximum: 1000
           minimum: 1
       - in: path
-        name: user_id
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      - in: path
+        name: username
         schema:
           type: string
         required: true
@@ -55186,7 +55186,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/PaginatedAssertionsResponse'
           description: ''
-  /api/credentials/orgs/{org}/users/{user_id}/assertions-over-time/:
+  /api/credentials/orgs/{platform_key}/users/{username}/assertions-over-time/:
     get:
       operationId: credentials_orgs_users_assertions_over_time_retrieve
       description: Get all credentials of a given tenant
@@ -55222,7 +55222,7 @@ paths:
           default: true
         description: Include main platform data
       - in: path
-        name: org
+        name: platform_key
         schema:
           type: string
         required: true
@@ -55233,7 +55233,7 @@ paths:
           minLength: 1
         description: start date. ISO 8601
       - in: path
-        name: user_id
+        name: username
         schema:
           type: string
         required: true
@@ -55248,7 +55248,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/OvertimeWithChangeInfo'
           description: ''
-  /api/credentials/orgs/{org}/users/{user_id}/assertions/{entity_id}:
+  /api/credentials/orgs/{platform_key}/users/{username}/assertions/{entity_id}:
     get:
       operationId: credentials_orgs_users_assertions_retrieve_2
       description: |-
@@ -55288,12 +55288,12 @@ paths:
           type: string
         required: true
       - in: path
-        name: org
+        name: platform_key
         schema:
           type: string
         required: true
       - in: path
-        name: user_id
+        name: username
         schema:
           type: string
         required: true
@@ -55347,12 +55347,12 @@ paths:
           type: string
         required: true
       - in: path
-        name: org
+        name: platform_key
         schema:
           type: string
         required: true
       - in: path
-        name: user_id
+        name: username
         schema:
           type: string
         required: true
@@ -55385,7 +55385,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/Assertion'
           description: ''
-  /api/credentials/orgs/{org}/users/{user_id}/assignments/{assignment_id}:
+  /api/credentials/orgs/{platform_key}/users/{username}/assignments/{assignment_id}:
     delete:
       operationId: credentials_orgs_users_assignments_destroy
       description: |-
@@ -55398,12 +55398,12 @@ paths:
           type: string
         required: true
       - in: path
-        name: org
+        name: platform_key
         schema:
           type: string
         required: true
       - in: path
-        name: user_id
+        name: username
         schema:
           type: string
         required: true
@@ -55414,18 +55414,18 @@ paths:
       responses:
         '204':
           description: No response body
-  /api/credentials/orgs/{org}/users/{user_id}/assignments/groups/:
+  /api/credentials/orgs/{platform_key}/users/{username}/assignments/groups/:
     get:
       operationId: credentials_orgs_users_assignments_groups_retrieve
       description: Get group assignments with department-aware filtering
       parameters:
       - in: path
-        name: org
+        name: platform_key
         schema:
           type: string
         required: true
       - in: path
-        name: user_id
+        name: username
         schema:
           type: string
         required: true
@@ -55441,12 +55441,12 @@ paths:
       description: Create group assignment with department access validation
       parameters:
       - in: path
-        name: org
+        name: platform_key
         schema:
           type: string
         required: true
       - in: path
-        name: user_id
+        name: username
         schema:
           type: string
         required: true
@@ -55457,7 +55457,7 @@ paths:
       responses:
         '200':
           description: No response body
-  /api/credentials/orgs/{org}/users/{user_id}/assignments/users/:
+  /api/credentials/orgs/{platform_key}/users/{username}/assignments/users/:
     get:
       operationId: credentials_orgs_users_assignments_users_retrieve
       description: |-
@@ -55467,12 +55467,12 @@ paths:
         - Department admins: get assignments for users in their department groups
       parameters:
       - in: path
-        name: org
+        name: platform_key
         schema:
           type: string
         required: true
       - in: path
-        name: user_id
+        name: username
         schema:
           type: string
         required: true
@@ -55488,12 +55488,12 @@ paths:
       description: Create assignments with department access validation
       parameters:
       - in: path
-        name: org
+        name: platform_key
         schema:
           type: string
         required: true
       - in: path
-        name: user_id
+        name: username
         schema:
           type: string
         required: true
@@ -55504,7 +55504,7 @@ paths:
       responses:
         '200':
           description: No response body
-  /api/credentials/orgs/{org}/users/{user_id}/course-assertions-over-time/:
+  /api/credentials/orgs/{platform_key}/users/{username}/course-assertions-over-time/:
     get:
       operationId: credentials_orgs_users_course_assertions_over_time_retrieve
       description: Get all credentials of a given tenant
@@ -55540,7 +55540,7 @@ paths:
           default: true
         description: Include main platform data
       - in: path
-        name: org
+        name: platform_key
         schema:
           type: string
         required: true
@@ -55551,7 +55551,7 @@ paths:
           minLength: 1
         description: start date. ISO 8601
       - in: path
-        name: user_id
+        name: username
         schema:
           type: string
         required: true
@@ -55566,7 +55566,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/OverTime'
           description: ''
-  /api/credentials/orgs/{org}/users/{user_id}/course-credentials/:
+  /api/credentials/orgs/{platform_key}/users/{username}/course-credentials/:
     get:
       operationId: credentials_orgs_users_course_credentials_list
       description: |-
@@ -55592,11 +55592,6 @@ paths:
             404 Not Found: If the organization doesn't exist
             500 Internal Server Error: If an unexpected error occurs
       parameters:
-      - in: path
-        name: org
-        schema:
-          type: string
-        required: true
       - name: page
         required: false
         in: query
@@ -55610,7 +55605,12 @@ paths:
         schema:
           type: integer
       - in: path
-        name: user_id
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      - in: path
+        name: username
         schema:
           type: string
         required: true
@@ -55621,7 +55621,7 @@ paths:
       responses:
         '200':
           description: No response body
-  /api/credentials/orgs/{org}/users/{user_id}/credentials-over-time/:
+  /api/credentials/orgs/{platform_key}/users/{username}/credentials-over-time/:
     get:
       operationId: credentials_orgs_users_credentials_over_time_retrieve
       description: Get all credentials of a given tenant
@@ -55657,7 +55657,7 @@ paths:
           default: true
         description: Include main platform data
       - in: path
-        name: org
+        name: platform_key
         schema:
           type: string
         required: true
@@ -55668,7 +55668,7 @@ paths:
           minLength: 1
         description: start date. ISO 8601
       - in: path
-        name: user_id
+        name: username
         schema:
           type: string
         required: true
@@ -55683,7 +55683,132 @@ paths:
               schema:
                 $ref: '#/components/schemas/OverTime'
           description: ''
-  /api/credentials/orgs/{org}/users/{user_id}/images/:
+  /api/credentials/orgs/{platform_key}/users/{username}/external-mapping/:
+    get:
+      operationId: credentials_orgs_users_external_mapping_retrieve
+      description: |-
+        Retrieve external credential mappings for the platform.
+
+        Query Parameters:
+            credential_id (str, optional): Filter by credential entity_id
+            provider_name (str, optional): Filter by provider name
+            page (int, optional): Page number
+            page_size (int, optional): Items per page
+
+        Returns all mappings for the platform if the user is an admin.
+      parameters:
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      - in: path
+        name: username
+        schema:
+          type: string
+        required: true
+      tags:
+      - credentials
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ExternalCredentialMapping'
+          description: ''
+    post:
+      operationId: credentials_orgs_users_external_mapping_create
+      description: |-
+        Create or update an external credential mapping.
+
+        If a mapping doesn't exist for the credential + platform + provider combination,
+        it will be created. If it exists, it will be updated.
+
+        Request Body:
+            {
+                "credential_id": "credential-entity-id",  // Required
+                "provider_name": "accredible",            // Required
+                "external_template_id": "123456",         // Optional
+                "metadata": {}                            // Optional
+            }
+
+        Returns:
+            - 201 Created: When creating a new mapping
+            - 200 OK: When updating an existing mapping
+      parameters:
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      - in: path
+        name: username
+        schema:
+          type: string
+        required: true
+      tags:
+      - credentials
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/ExternalCredentialMapping'
+          application/scim+json:
+            schema:
+              $ref: '#/components/schemas/ExternalCredentialMapping'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/ExternalCredentialMapping'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/ExternalCredentialMapping'
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/ExternalCredentialMapping'
+        required: true
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ExternalCredentialMapping'
+          description: ''
+    delete:
+      operationId: credentials_orgs_users_external_mapping_destroy
+      description: |-
+        Delete an external credential mapping.
+
+        Request Body:
+            {
+                "credential_id": "credential-entity-id",  // Required
+                "provider_name": "accredible"             // Required
+            }
+
+        Returns:
+            A JSON response confirming deletion
+      parameters:
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      - in: path
+        name: username
+        schema:
+          type: string
+        required: true
+      tags:
+      - credentials
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '204':
+          description: No response body
+  /api/credentials/orgs/{platform_key}/users/{username}/images/:
     get:
       operationId: credentials_orgs_users_images_retrieve
       description: |-
@@ -55742,12 +55867,12 @@ paths:
             - Only authenticated users with appropriate permissions can upload and retrieve images
       parameters:
       - in: path
-        name: org
+        name: platform_key
         schema:
           type: string
         required: true
       - in: path
-        name: user_id
+        name: username
         schema:
           type: string
         required: true
@@ -55820,12 +55945,12 @@ paths:
             - Only authenticated users with appropriate permissions can upload and retrieve images
       parameters:
       - in: path
-        name: org
+        name: platform_key
         schema:
           type: string
         required: true
       - in: path
-        name: user_id
+        name: username
         schema:
           type: string
         required: true
@@ -55857,7 +55982,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/UploadedImage'
           description: ''
-  /api/credentials/orgs/{org}/users/{user_id}/issuers/:
+  /api/credentials/orgs/{platform_key}/users/{username}/issuers/:
     get:
       operationId: credentials_orgs_users_issuers_retrieve
       description: |-
@@ -55924,7 +56049,7 @@ paths:
             - Only authenticated users with appropriate permissions can manage issuers
       parameters:
       - in: path
-        name: org
+        name: platform_key
         schema:
           type: string
         required: true
@@ -55935,7 +56060,7 @@ paths:
           minLength: 1
         required: true
       - in: path
-        name: user_id
+        name: username
         schema:
           type: string
         required: true
@@ -56016,7 +56141,7 @@ paths:
             - Only authenticated users with appropriate permissions can manage issuers
       parameters:
       - in: path
-        name: org
+        name: platform_key
         schema:
           type: string
         required: true
@@ -56027,7 +56152,7 @@ paths:
           minLength: 1
         required: true
       - in: path
-        name: user_id
+        name: username
         schema:
           type: string
         required: true
@@ -56060,7 +56185,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/Issuer'
           description: ''
-  /api/credentials/orgs/{org}/users/{user_id}/issuers/{entity_id}:
+  /api/credentials/orgs/{platform_key}/users/{username}/issuers/{entity_id}:
     get:
       operationId: credentials_orgs_users_issuers_retrieve_2
       description: |-
@@ -56136,12 +56261,12 @@ paths:
           type: string
         required: true
       - in: path
-        name: org
+        name: platform_key
         schema:
           type: string
         required: true
       - in: path
-        name: user_id
+        name: username
         schema:
           type: string
         required: true
@@ -56231,12 +56356,12 @@ paths:
           type: string
         required: true
       - in: path
-        name: org
+        name: platform_key
         schema:
           type: string
         required: true
       - in: path
-        name: user_id
+        name: username
         schema:
           type: string
         required: true
@@ -56344,12 +56469,12 @@ paths:
           type: string
         required: true
       - in: path
-        name: org
+        name: platform_key
         schema:
           type: string
         required: true
       - in: path
-        name: user_id
+        name: username
         schema:
           type: string
         required: true
@@ -56360,7 +56485,7 @@ paths:
       responses:
         '204':
           description: No response body
-  /api/credentials/orgs/{org}/users/{user_id}/issuers/authority/:
+  /api/credentials/orgs/{platform_key}/users/{username}/issuers/authority/:
     post:
       operationId: credentials_orgs_users_issuers_authority_create
       description: |-
@@ -56407,12 +56532,12 @@ paths:
             - Only authenticated users with appropriate permissions can manage authorities
       parameters:
       - in: path
-        name: org
+        name: platform_key
         schema:
           type: string
         required: true
       - in: path
-        name: user_id
+        name: username
         schema:
           type: string
         required: true
@@ -56445,6 +56570,136 @@ paths:
               schema:
                 $ref: '#/components/schemas/IssuerAuthority'
           description: ''
+  /api/credentials/orgs/{platform_key}/users/{username}/provider-config/:
+    get:
+      operationId: credentials_orgs_users_provider_config_retrieve
+      description: |-
+        Retrieve provider configurations for the platform.
+
+        Query Parameters:
+            provider_name (str, optional): Filter to a specific provider
+            page (int, optional): Page number
+            page_size (int, optional): Items per page
+
+        Returns all configurations for the platform if the user is an admin.
+      parameters:
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      - in: path
+        name: username
+        schema:
+          type: string
+        required: true
+      tags:
+      - credentials
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CredentialProviderConfig'
+          description: ''
+    post:
+      operationId: credentials_orgs_users_provider_config_create
+      description: |-
+        Create or update a provider configuration.
+
+        If a configuration doesn't exist for the platform and provider, it will be created.
+        If it exists, it will be updated.
+
+        Request Body:
+            {
+                "provider_name": "accredible",  // Required
+                "config": {...},                 // Optional
+                "enabled": true                  // Optional
+            }
+
+        Returns:
+            - 201 Created: When creating a new configuration
+            - 200 OK: When updating an existing configuration
+      parameters:
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      - in: path
+        name: username
+        schema:
+          type: string
+        required: true
+      tags:
+      - credentials
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CredentialProviderConfig'
+          application/scim+json:
+            schema:
+              $ref: '#/components/schemas/CredentialProviderConfig'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/CredentialProviderConfig'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/CredentialProviderConfig'
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/CredentialProviderConfig'
+        required: true
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CredentialProviderConfig'
+          description: ''
+    delete:
+      operationId: credentials_orgs_users_provider_config_destroy
+      description: |-
+        Deactivate a provider configuration (sets enabled=False).
+
+        Request Body:
+            {
+                "provider_name": "accredible"  // Required
+            }
+      parameters:
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      - in: path
+        name: username
+        schema:
+          type: string
+        required: true
+      tags:
+      - credentials
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '204':
+          description: No response body
+  /api/credentials/providers/:
+    get:
+      operationId: credentials_providers_retrieve
+      description: Get list of enabled credential providers with pagination.
+      tags:
+      - credentials
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          description: No response body
   /api/credentials/public/assertions/{entity_id}/:
     get:
       operationId: credentials_public_assertions_retrieve
@@ -72734,6 +72989,53 @@ components:
       - credential_url
       - name
       - revoked
+    CredentialProviderConfig:
+      type: object
+      description: |-
+        Serializer for CredentialProviderConfig model.
+
+        Serializes provider configuration including platform, provider name,
+        config JSON, enabled status, and timestamps.
+      properties:
+        id:
+          type: integer
+          readOnly: true
+        platform_key:
+          type: string
+          readOnly: true
+        platform_name:
+          type: string
+          readOnly: true
+        provider_name:
+          type: string
+          description: The credential provider name (references CredentialProvider.name)
+          maxLength: 100
+        provider_name_display:
+          type: string
+          description: Get display name from provider if available, otherwise use
+            provider_name.
+          readOnly: true
+        config:
+          description: Provider-specific configuration in JSON format
+        enabled:
+          type: boolean
+          description: Whether this provider integration is enabled for the platform
+        created:
+          type: string
+          format: date-time
+          readOnly: true
+        updated:
+          type: string
+          format: date-time
+          readOnly: true
+      required:
+      - created
+      - id
+      - platform_key
+      - platform_name
+      - provider_name
+      - provider_name_display
+      - updated
     CredentialRequest:
       type: object
       properties:
@@ -73810,6 +74112,77 @@ components:
       - updated_at
       - user
       - user_info
+    ExternalCredentialMapping:
+      type: object
+      description: |-
+        Serializer for ExternalCredentialMapping model.
+
+        Serializes external credential mappings including credential, platform,
+        provider, external_template_id, and metadata.
+      properties:
+        id:
+          type: integer
+          readOnly: true
+        credential_id:
+          type: string
+          readOnly: true
+        credential_name:
+          type: string
+          readOnly: true
+        platform_key:
+          type: string
+          readOnly: true
+        platform_name:
+          type: string
+          readOnly: true
+        provider:
+          type: integer
+          readOnly: true
+          nullable: true
+          description: The credential provider
+        provider_name:
+          type: string
+          description: The credential provider name (references CredentialProvider.name)
+          maxLength: 100
+        provider_name_display:
+          type: string
+          description: Get display name from provider if available, otherwise use
+            provider_name.
+          readOnly: true
+        external_template_id:
+          type: string
+          nullable: true
+          description: The template ID in the external system (e.g., Accredible template
+            ID)
+          maxLength: 255
+        group_id:
+          type: string
+          nullable: true
+          description: The group ID in the external system (e.g., Accredible group
+            ID). If not set, will fall back to the provider config's group_id.
+          maxLength: 255
+        metadata:
+          description: Additional metadata stored as JSON (for general mapping information,
+            not sync status)
+        created:
+          type: string
+          format: date-time
+          readOnly: true
+        updated:
+          type: string
+          format: date-time
+          readOnly: true
+      required:
+      - created
+      - credential_id
+      - credential_name
+      - id
+      - platform_key
+      - platform_name
+      - provider
+      - provider_name
+      - provider_name_display
+      - updated
     ExternalServiceInfo:
       type: object
       properties: