@iblai/iblai-api 4.297.0-core → 4.298.0-core

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/sdk_schema.yml CHANGED
@@ -1,7 +1,7 @@
1
1
  openapi: 3.0.3
2
2
  info:
3
3
  title: ibl-data-manager
4
- version: 4.297.0-core
4
+ version: 4.298.0-core
5
5
  description: API for iblai
6
6
  paths:
7
7
  /api/analytics/content/:
@@ -17043,6 +17043,158 @@ paths:
17043
17043
  schema:
17044
17044
  $ref: '#/components/schemas/PlatformList'
17045
17045
  description: ''
17046
+ /api/core/lti/1p3/provider/lti-agents/:
17047
+ get:
17048
+ operationId: core_lti_1p3_provider_lti_agents_list
17049
+ description: List your LTI Mentor's
17050
+ parameters:
17051
+ - in: query
17052
+ name: mentor_id
17053
+ schema:
17054
+ type: string
17055
+ minLength: 1
17056
+ description: The mentor's unique_id to filter for
17057
+ - in: query
17058
+ name: platform_key
17059
+ schema:
17060
+ type: string
17061
+ minLength: 1
17062
+ description: Platform Key
17063
+ required: true
17064
+ tags:
17065
+ - core
17066
+ security:
17067
+ - PlatformApiKeyAuthentication: []
17068
+ responses:
17069
+ '200':
17070
+ content:
17071
+ application/json:
17072
+ schema:
17073
+ type: array
17074
+ items:
17075
+ $ref: '#/components/schemas/LtiMentor'
17076
+ description: ''
17077
+ post:
17078
+ operationId: core_lti_1p3_provider_lti_agents_create
17079
+ description: Create a new LTI Mentor
17080
+ tags:
17081
+ - core
17082
+ requestBody:
17083
+ content:
17084
+ application/json:
17085
+ schema:
17086
+ $ref: '#/components/schemas/LtiMentor'
17087
+ application/scim+json:
17088
+ schema:
17089
+ $ref: '#/components/schemas/LtiMentor'
17090
+ application/x-www-form-urlencoded:
17091
+ schema:
17092
+ $ref: '#/components/schemas/LtiMentor'
17093
+ multipart/form-data:
17094
+ schema:
17095
+ $ref: '#/components/schemas/LtiMentor'
17096
+ '*/*':
17097
+ schema:
17098
+ $ref: '#/components/schemas/LtiMentor'
17099
+ required: true
17100
+ security:
17101
+ - PlatformApiKeyAuthentication: []
17102
+ responses:
17103
+ '201':
17104
+ content:
17105
+ application/json:
17106
+ schema:
17107
+ $ref: '#/components/schemas/LtiMentor'
17108
+ description: ''
17109
+ /api/core/lti/1p3/provider/lti-agents/{id}/:
17110
+ get:
17111
+ operationId: core_lti_1p3_provider_lti_agents_retrieve
17112
+ description: Get details about a specific LTI Mentor
17113
+ parameters:
17114
+ - in: path
17115
+ name: id
17116
+ schema:
17117
+ type: string
17118
+ required: true
17119
+ - in: query
17120
+ name: platform_key
17121
+ schema:
17122
+ type: string
17123
+ minLength: 1
17124
+ description: Platform Key
17125
+ required: true
17126
+ tags:
17127
+ - core
17128
+ security:
17129
+ - PlatformApiKeyAuthentication: []
17130
+ responses:
17131
+ '200':
17132
+ content:
17133
+ application/json:
17134
+ schema:
17135
+ $ref: '#/components/schemas/LtiMentor'
17136
+ description: ''
17137
+ put:
17138
+ operationId: core_lti_1p3_provider_lti_agents_update
17139
+ description: Update an LTI Mentor
17140
+ parameters:
17141
+ - in: path
17142
+ name: id
17143
+ schema:
17144
+ type: string
17145
+ required: true
17146
+ tags:
17147
+ - core
17148
+ requestBody:
17149
+ content:
17150
+ application/json:
17151
+ schema:
17152
+ $ref: '#/components/schemas/LtiMentor'
17153
+ application/scim+json:
17154
+ schema:
17155
+ $ref: '#/components/schemas/LtiMentor'
17156
+ application/x-www-form-urlencoded:
17157
+ schema:
17158
+ $ref: '#/components/schemas/LtiMentor'
17159
+ multipart/form-data:
17160
+ schema:
17161
+ $ref: '#/components/schemas/LtiMentor'
17162
+ '*/*':
17163
+ schema:
17164
+ $ref: '#/components/schemas/LtiMentor'
17165
+ required: true
17166
+ security:
17167
+ - PlatformApiKeyAuthentication: []
17168
+ responses:
17169
+ '200':
17170
+ content:
17171
+ application/json:
17172
+ schema:
17173
+ $ref: '#/components/schemas/LtiMentor'
17174
+ description: ''
17175
+ delete:
17176
+ operationId: core_lti_1p3_provider_lti_agents_destroy
17177
+ description: Delete an LTI Mentor
17178
+ parameters:
17179
+ - in: path
17180
+ name: id
17181
+ schema:
17182
+ type: string
17183
+ required: true
17184
+ - in: query
17185
+ name: platform_key
17186
+ schema:
17187
+ type: string
17188
+ minLength: 1
17189
+ description: Platform Key
17190
+ required: true
17191
+ tags:
17192
+ - core
17193
+ security:
17194
+ - PlatformApiKeyAuthentication: []
17195
+ responses:
17196
+ '204':
17197
+ description: No response body
17046
17198
  /api/core/lti/1p3/provider/lti-keys/:
17047
17199
  get:
17048
17200
  operationId: core_lti_1p3_provider_lti_keys_list
@@ -17192,7 +17344,10 @@ paths:
17192
17344
  /api/core/lti/1p3/provider/lti-mentors/:
17193
17345
  get:
17194
17346
  operationId: core_lti_1p3_provider_lti_mentors_list
17195
- description: List your LTI Mentor's
17347
+ description: |-
17348
+ **Deprecated — use `/api/core/lti/1p3/provider/lti-agents/` instead.** This `mentor`-spelled path is an alias kept for backward compatibility; it is equivalent to `/api/core/lti/1p3/provider/lti-agents/` (`mentor` → `agent`) and will be removed in a future release.
17349
+
17350
+ List your LTI Mentor's
17196
17351
  parameters:
17197
17352
  - in: query
17198
17353
  name: mentor_id
@@ -17220,9 +17375,13 @@ paths:
17220
17375
  items:
17221
17376
  $ref: '#/components/schemas/LtiMentor'
17222
17377
  description: ''
17378
+ deprecated: true
17223
17379
  post:
17224
17380
  operationId: core_lti_1p3_provider_lti_mentors_create
17225
- description: Create a new LTI Mentor
17381
+ description: |-
17382
+ **Deprecated — use `/api/core/lti/1p3/provider/lti-agents/` instead.** This `mentor`-spelled path is an alias kept for backward compatibility; it is equivalent to `/api/core/lti/1p3/provider/lti-agents/` (`mentor` → `agent`) and will be removed in a future release.
17383
+
17384
+ Create a new LTI Mentor
17226
17385
  tags:
17227
17386
  - core
17228
17387
  requestBody:
@@ -17252,10 +17411,14 @@ paths:
17252
17411
  schema:
17253
17412
  $ref: '#/components/schemas/LtiMentor'
17254
17413
  description: ''
17414
+ deprecated: true
17255
17415
  /api/core/lti/1p3/provider/lti-mentors/{id}/:
17256
17416
  get:
17257
17417
  operationId: core_lti_1p3_provider_lti_mentors_retrieve
17258
- description: Get details about a specific LTI Mentor
17418
+ description: |-
17419
+ **Deprecated — use `/api/core/lti/1p3/provider/lti-agents/{id}/` instead.** This `mentor`-spelled path is an alias kept for backward compatibility; it is equivalent to `/api/core/lti/1p3/provider/lti-agents/{id}/` (`mentor` → `agent`) and will be removed in a future release.
17420
+
17421
+ Get details about a specific LTI Mentor
17259
17422
  parameters:
17260
17423
  - in: path
17261
17424
  name: id
@@ -17280,9 +17443,13 @@ paths:
17280
17443
  schema:
17281
17444
  $ref: '#/components/schemas/LtiMentor'
17282
17445
  description: ''
17446
+ deprecated: true
17283
17447
  put:
17284
17448
  operationId: core_lti_1p3_provider_lti_mentors_update
17285
- description: Update an LTI Mentor
17449
+ description: |-
17450
+ **Deprecated — use `/api/core/lti/1p3/provider/lti-agents/{id}/` instead.** This `mentor`-spelled path is an alias kept for backward compatibility; it is equivalent to `/api/core/lti/1p3/provider/lti-agents/{id}/` (`mentor` → `agent`) and will be removed in a future release.
17451
+
17452
+ Update an LTI Mentor
17286
17453
  parameters:
17287
17454
  - in: path
17288
17455
  name: id
@@ -17318,9 +17485,13 @@ paths:
17318
17485
  schema:
17319
17486
  $ref: '#/components/schemas/LtiMentor'
17320
17487
  description: ''
17488
+ deprecated: true
17321
17489
  delete:
17322
17490
  operationId: core_lti_1p3_provider_lti_mentors_destroy
17323
- description: Delete an LTI Mentor
17491
+ description: |-
17492
+ **Deprecated — use `/api/core/lti/1p3/provider/lti-agents/{id}/` instead.** This `mentor`-spelled path is an alias kept for backward compatibility; it is equivalent to `/api/core/lti/1p3/provider/lti-agents/{id}/` (`mentor` → `agent`) and will be removed in a future release.
17493
+
17494
+ Delete an LTI Mentor
17324
17495
  parameters:
17325
17496
  - in: path
17326
17497
  name: id
@@ -17341,6 +17512,7 @@ paths:
17341
17512
  responses:
17342
17513
  '204':
17343
17514
  description: No response body
17515
+ deprecated: true
17344
17516
  /api/core/lti/1p3/provider/lti-tools/:
17345
17517
  get:
17346
17518
  operationId: core_lti_1p3_provider_lti_tools_list
@@ -19220,6 +19392,94 @@ paths:
19220
19392
  read: Read group information
19221
19393
  write: Modify group information
19222
19394
  description: ''
19395
+ /api/core/rbac/agent-access/:
19396
+ get:
19397
+ operationId: core_rbac_agent_access_list
19398
+ description: Retrieve current access information for a specific mentor, including
19399
+ all groups and users that have access with their respective roles.
19400
+ summary: Get mentor access status
19401
+ parameters:
19402
+ - in: query
19403
+ name: mentor_id
19404
+ schema:
19405
+ type: integer
19406
+ description: ID of the mentor to get access information for
19407
+ required: true
19408
+ - in: query
19409
+ name: platform_key
19410
+ schema:
19411
+ type: string
19412
+ description: Platform key where the mentor belongs
19413
+ required: true
19414
+ tags:
19415
+ - core
19416
+ security:
19417
+ - PlatformApiKeyAuthentication: []
19418
+ responses:
19419
+ '200':
19420
+ content:
19421
+ application/json:
19422
+ schema:
19423
+ type: array
19424
+ items:
19425
+ $ref: '#/components/schemas/MentorPolicy'
19426
+ description: ''
19427
+ '400':
19428
+ description: Missing or invalid query parameters
19429
+ '403':
19430
+ description: Permission denied - ShareMentor permission required
19431
+ '404':
19432
+ description: Platform not found
19433
+ '500':
19434
+ description: Internal server error
19435
+ post:
19436
+ operationId: core_rbac_agent_access_create
19437
+ description: Create or update RBAC policies to manage group and user access
19438
+ to specific mentors. Creates role-specific policies and handles adding/removing
19439
+ groups and users.
19440
+ summary: Control which RbacGroups and/or Users have access to a mentor and with
19441
+ what Role
19442
+ tags:
19443
+ - core
19444
+ requestBody:
19445
+ content:
19446
+ application/json:
19447
+ schema:
19448
+ $ref: '#/components/schemas/MentorPolicy'
19449
+ application/scim+json:
19450
+ schema:
19451
+ $ref: '#/components/schemas/MentorPolicy'
19452
+ application/x-www-form-urlencoded:
19453
+ schema:
19454
+ $ref: '#/components/schemas/MentorPolicy'
19455
+ multipart/form-data:
19456
+ schema:
19457
+ $ref: '#/components/schemas/MentorPolicy'
19458
+ '*/*':
19459
+ schema:
19460
+ $ref: '#/components/schemas/MentorPolicy'
19461
+ required: true
19462
+ security:
19463
+ - PlatformApiKeyAuthentication: []
19464
+ responses:
19465
+ '200':
19466
+ content:
19467
+ application/json:
19468
+ schema:
19469
+ $ref: '#/components/schemas/MentorPolicy'
19470
+ description: ''
19471
+ '201':
19472
+ content:
19473
+ application/json:
19474
+ schema:
19475
+ $ref: '#/components/schemas/MentorPolicy'
19476
+ description: ''
19477
+ '400':
19478
+ description: Invalid request data or validation errors
19479
+ '403':
19480
+ description: Permission denied - ShareMentor permission required
19481
+ '404':
19482
+ description: Platform or mentor not found
19223
19483
  /api/core/rbac/groups/:
19224
19484
  get:
19225
19485
  operationId: core_rbac_groups_list
@@ -19491,8 +19751,10 @@ paths:
19491
19751
  /api/core/rbac/mentor-access/:
19492
19752
  get:
19493
19753
  operationId: core_rbac_mentor_access_list
19494
- description: Retrieve current access information for a specific mentor, including
19495
- all groups and users that have access with their respective roles.
19754
+ description: |-
19755
+ **Deprecated use `/api/core/rbac/agent-access/` instead.** This `mentor`-spelled path is an alias kept for backward compatibility; it is equivalent to `/api/core/rbac/agent-access/` (`mentor` `agent`) and will be removed in a future release.
19756
+
19757
+ Retrieve current access information for a specific mentor, including all groups and users that have access with their respective roles.
19496
19758
  summary: Get mentor access status
19497
19759
  parameters:
19498
19760
  - in: query
@@ -19528,11 +19790,13 @@ paths:
19528
19790
  description: Platform not found
19529
19791
  '500':
19530
19792
  description: Internal server error
19793
+ deprecated: true
19531
19794
  post:
19532
19795
  operationId: core_rbac_mentor_access_create
19533
- description: Create or update RBAC policies to manage group and user access
19534
- to specific mentors. Creates role-specific policies and handles adding/removing
19535
- groups and users.
19796
+ description: |-
19797
+ **Deprecated use `/api/core/rbac/agent-access/` instead.** This `mentor`-spelled path is an alias kept for backward compatibility; it is equivalent to `/api/core/rbac/agent-access/` (`mentor` → `agent`) and will be removed in a future release.
19798
+
19799
+ Create or update RBAC policies to manage group and user access to specific mentors. Creates role-specific policies and handles adding/removing groups and users.
19536
19800
  summary: Control which RbacGroups and/or Users have access to a mentor and with
19537
19801
  what Role
19538
19802
  tags:
@@ -19576,6 +19840,7 @@ paths:
19576
19840
  description: Permission denied - ShareMentor permission required
19577
19841
  '404':
19578
19842
  description: Platform or mentor not found
19843
+ deprecated: true
19579
19844
  /api/core/rbac/permissions/check/:
19580
19845
  post:
19581
19846
  operationId: core_rbac_permissions_check_create
@@ -20118,6 +20383,79 @@ paths:
20118
20383
  description: Permission denied - insufficient RBAC permissions
20119
20384
  '404':
20120
20385
  description: Role not found
20386
+ /api/core/rbac/student-agent-creation/set/:
20387
+ post:
20388
+ operationId: core_rbac_student_agent_creation_set_create
20389
+ description: Enable or disable the ability for students to create mentors on
20390
+ a platform
20391
+ summary: Set student mentor creation permission
20392
+ tags:
20393
+ - core
20394
+ requestBody:
20395
+ content:
20396
+ application/json:
20397
+ schema:
20398
+ $ref: '#/components/schemas/SetStudentMentorCreationPermission'
20399
+ application/scim+json:
20400
+ schema:
20401
+ $ref: '#/components/schemas/SetStudentMentorCreationPermission'
20402
+ application/x-www-form-urlencoded:
20403
+ schema:
20404
+ $ref: '#/components/schemas/SetStudentMentorCreationPermission'
20405
+ multipart/form-data:
20406
+ schema:
20407
+ $ref: '#/components/schemas/SetStudentMentorCreationPermission'
20408
+ '*/*':
20409
+ schema:
20410
+ $ref: '#/components/schemas/SetStudentMentorCreationPermission'
20411
+ required: true
20412
+ security:
20413
+ - PlatformApiKeyAuthentication: []
20414
+ responses:
20415
+ '200':
20416
+ content:
20417
+ application/json:
20418
+ schema:
20419
+ $ref: '#/components/schemas/StudentMentorCreationPermissionResponse'
20420
+ description: ''
20421
+ '400':
20422
+ description: Invalid request data
20423
+ '403':
20424
+ description: Permission denied - Tenant Admin access required
20425
+ '404':
20426
+ description: Platform, students group, or mentor creators policy not found
20427
+ /api/core/rbac/student-agent-creation/status/:
20428
+ get:
20429
+ operationId: core_rbac_student_agent_creation_status_retrieve
20430
+ description: Check whether students are currently allowed to create mentors
20431
+ on a platform
20432
+ summary: Get student mentor creation permission status
20433
+ parameters:
20434
+ - in: query
20435
+ name: platform_key
20436
+ schema:
20437
+ type: string
20438
+ maxLength: 255
20439
+ minLength: 1
20440
+ description: The platform key to check
20441
+ required: true
20442
+ tags:
20443
+ - core
20444
+ security:
20445
+ - PlatformApiKeyAuthentication: []
20446
+ responses:
20447
+ '200':
20448
+ content:
20449
+ application/json:
20450
+ schema:
20451
+ $ref: '#/components/schemas/StudentMentorCreationPermissionResponse'
20452
+ description: ''
20453
+ '400':
20454
+ description: Missing platform_key parameter
20455
+ '403':
20456
+ description: Permission denied - Tenant Admin access required
20457
+ '404':
20458
+ description: Platform not found
20121
20459
  /api/core/rbac/student-llm-access/set/:
20122
20460
  post:
20123
20461
  operationId: core_rbac_student_llm_access_set_create
@@ -20194,8 +20532,10 @@ paths:
20194
20532
  /api/core/rbac/student-mentor-creation/set/:
20195
20533
  post:
20196
20534
  operationId: core_rbac_student_mentor_creation_set_create
20197
- description: Enable or disable the ability for students to create mentors on
20198
- a platform
20535
+ description: |-
20536
+ **Deprecated — use `/api/core/rbac/student-agent-creation/set/` instead.** This `mentor`-spelled path is an alias kept for backward compatibility; it is equivalent to `/api/core/rbac/student-agent-creation/set/` (`mentor` → `agent`) and will be removed in a future release.
20537
+
20538
+ Enable or disable the ability for students to create mentors on a platform
20199
20539
  summary: Set student mentor creation permission
20200
20540
  tags:
20201
20541
  - core
@@ -20232,11 +20572,14 @@ paths:
20232
20572
  description: Permission denied - Tenant Admin access required
20233
20573
  '404':
20234
20574
  description: Platform, students group, or mentor creators policy not found
20575
+ deprecated: true
20235
20576
  /api/core/rbac/student-mentor-creation/status/:
20236
20577
  get:
20237
20578
  operationId: core_rbac_student_mentor_creation_status_retrieve
20238
- description: Check whether students are currently allowed to create mentors
20239
- on a platform
20579
+ description: |-
20580
+ **Deprecated — use `/api/core/rbac/student-agent-creation/status/` instead.** This `mentor`-spelled path is an alias kept for backward compatibility; it is equivalent to `/api/core/rbac/student-agent-creation/status/` (`mentor` → `agent`) and will be removed in a future release.
20581
+
20582
+ Check whether students are currently allowed to create mentors on a platform
20240
20583
  summary: Get student mentor creation permission status
20241
20584
  parameters:
20242
20585
  - in: query
@@ -20264,6 +20607,7 @@ paths:
20264
20607
  description: Permission denied - Tenant Admin access required
20265
20608
  '404':
20266
20609
  description: Platform not found
20610
+ deprecated: true
20267
20611
  /api/core/rbac/teams/access/:
20268
20612
  get:
20269
20613
  operationId: core_rbac_teams_access_list
@@ -21,7 +21,7 @@ export type OpenAPIConfig = {
21
21
 
22
22
  export const OpenAPI: OpenAPIConfig = {
23
23
  BASE: 'https://base.manager.iblai.app',
24
- VERSION: '4.297.0-core',
24
+ VERSION: '4.298.0-core',
25
25
  WITH_CREDENTIALS: false,
26
26
  CREDENTIALS: 'include',
27
27
  TOKEN: undefined,