@iblai/iblai-api 4.41.1-core → 4.41.1-rbactest-core

package/sdk_schema.yml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: ibl-data-manager
-  version: 4.41.1-core
+  version: 4.40.1-core
   description: API for iblai
 paths:
   /api/analytics/learners/:
@@ -14927,6 +14927,12 @@ paths:
       description: Retrieve a list of RBAC groups. Can be filtered by platform_key.
       summary: List RBAC groups
       parameters:
+      - in: query
+        name: owner
+        schema:
+          type: string
+          minLength: 1
+        description: Filter groups by owner username
       - name: page
         required: false
         in: query
@@ -14945,6 +14951,7 @@ paths:
           type: string
           minLength: 1
         description: Filter groups by platform key
+        required: true
       tags:
       - core
       security:
@@ -15114,6 +15121,7 @@ paths:
           type: string
           minLength: 1
         description: platform key for authorization check
+        required: true
       tags:
       - core
       security:
@@ -15123,6 +15131,88 @@ paths:
           description: Group deleted successfully
         '404':
           description: Group not found
+  /api/core/rbac/mentor-access/:
+    get:
+      operationId: core_rbac_mentor_access_list
+      description: Retrieve current access information for a specific mentor, including
+        all groups and users that have access with their respective roles.
+      summary: Get mentor access status
+      parameters:
+      - in: query
+        name: mentor_id
+        schema:
+          type: integer
+        description: ID of the mentor to get access information for
+        required: true
+      - in: query
+        name: platform_key
+        schema:
+          type: string
+        description: Platform key where the mentor belongs
+        required: true
+      tags:
+      - core
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/MentorPolicy'
+          description: ''
+        '400':
+          description: Missing or invalid query parameters
+        '403':
+          description: Permission denied - ShareMentor permission required
+        '404':
+          description: Platform not found
+        '500':
+          description: Internal server error
+    post:
+      operationId: core_rbac_mentor_access_create
+      description: 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.
+      summary: Control which RbacGroups and/or Users have access to a mentor and with
+        what Role
+      tags:
+      - core
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/MentorPolicy'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/MentorPolicy'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/MentorPolicy'
+        required: true
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/MentorPolicy'
+          description: ''
+        '201':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/MentorPolicy'
+          description: ''
+        '400':
+          description: Invalid request data or validation errors
+        '403':
+          description: Permission denied - ShareMentor permission required
+        '404':
+          description: Platform or mentor not found
   /api/core/rbac/permissions/check/:
     post:
       operationId: core_rbac_permissions_check_create
@@ -15345,6 +15435,7 @@ paths:
           type: string
           minLength: 1
         description: platform key for authorization check
+        required: true
       tags:
       - core
       security:
@@ -15535,6 +15626,7 @@ paths:
           type: string
           minLength: 1
         description: platform key for authorization check
+        required: true
       tags:
       - core
       security:
@@ -15678,6 +15770,84 @@ paths:
           description: Permission denied - Tenant Admin access required
         '404':
           description: Platform not found
+  /api/core/rbac/user-group-access/:
+    get:
+      operationId: core_rbac_user_group_access_retrieve
+      description: Retrieve current group access information for a specific user,
+        including all groups the user has access to and whether they have mentor management
+        permissions.
+      summary: Get user group access status
+      parameters:
+      - in: query
+        name: platform_key
+        schema:
+          type: string
+        description: Platform key where the groups exist
+        required: true
+      - in: query
+        name: user_id
+        schema:
+          type: integer
+        description: ID of the user to check group access for
+        required: true
+      tags:
+      - core
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UserGroupAccess'
+          description: ''
+        '400':
+          description: Missing or invalid query parameters
+        '404':
+          description: Platform or user not found
+        '500':
+          description: Internal server error
+    post:
+      operationId: core_rbac_user_group_access_create
+      description: Create or update user access to groups by adding/removing group
+        access. Creates one policy per user with GROUP_MENTOR_MANAGER role for managing
+        mentor access.
+      summary: Manage user access to groups
+      tags:
+      - core
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UserGroupAccess'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/UserGroupAccess'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/UserGroupAccess'
+        required: true
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UserGroupAccess'
+          description: ''
+        '201':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UserGroupAccess'
+          description: ''
+        '400':
+          description: Invalid request data or validation errors
+        '404':
+          description: Platform or user not found
+        '500':
+          description: Internal server error
   /api/core/session/logout/:
     post:
       operationId: core_session_logout_create
@@ -32071,6 +32241,76 @@ components:
         * `document` - Document
         * `audio` - Audio
         * `other` - Other
+    MentorPolicy:
+      type: object
+      description: |-
+        Serializer for mentor-specific RBAC policies using ModelSerializer pattern.
+        Accepts mentor_id and role, generates resources and role internally.
+      properties:
+        id:
+          type: integer
+          readOnly: true
+        name:
+          type: string
+          readOnly: true
+          description: Policy name. If not supplied, defaults to a UUID4
+        platform_key:
+          type: string
+          description: Platform key where the mentor belongs
+          writeOnly: true
+        mentor_id:
+          type: integer
+          writeOnly: true
+          description: ID of the mentor to manage access for
+        role:
+          type: string
+          description: Role for accessing this mentor (viewer or editor)
+        resources:
+          readOnly: true
+          description: List of resources this policy applies to
+        users:
+          type: array
+          items:
+            $ref: '#/components/schemas/RbacUser'
+          readOnly: true
+        groups:
+          type: array
+          items:
+            $ref: '#/components/schemas/RbacPolicyGroup'
+          readOnly: true
+        groups_to_add:
+          type: array
+          items:
+            type: integer
+          writeOnly: true
+          description: List of group IDs to grant access to this mentor
+        groups_to_remove:
+          type: array
+          items:
+            type: integer
+          writeOnly: true
+          description: List of group IDs to revoke access from this mentor
+        users_to_add:
+          type: array
+          items:
+            type: integer
+          writeOnly: true
+          description: List of user IDs to grant access to this mentor
+        users_to_remove:
+          type: array
+          items:
+            type: integer
+          writeOnly: true
+          description: List of user IDs to revoke access from this mentor
+      required:
+      - groups
+      - id
+      - mentor_id
+      - name
+      - platform_key
+      - resources
+      - role
+      - users
     MetricDetail:
       type: object
       description: Base serializer for detailed metric data.
@@ -33294,6 +33534,10 @@ components:
         description:
           type: string
           description: Optional group description
+        owner:
+          allOf:
+          - $ref: '#/components/schemas/RbacUser'
+          readOnly: true
         users:
           type: array
           items:
@@ -36494,6 +36738,10 @@ components:
         description:
           type: string
           description: Optional group description
+        owner:
+          allOf:
+          - $ref: '#/components/schemas/RbacUser'
+          readOnly: true
         users:
           type: array
           items:
@@ -36513,6 +36761,7 @@ components:
           description: List of user IDs to remove from this group
       required:
       - id
+      - owner
       - platform
       - platform_key
       - unique_id
@@ -37990,9 +38239,6 @@ components:
             type: string
           description: 'List of LLM resource paths that students can access. Format:
             [''llms/openai/models/gpt-4'', ''llms/openai/'', ''llms/'']'
-        message:
-          type: string
-          description: Success message (only in set access response)
       required:
       - llm_resources
       - platform_key
@@ -38576,6 +38822,74 @@ components:
           type: string
       required:
       - message
+    UserGroupAccess:
+      type: object
+      description: ModelSerializer for user group access policies
+      properties:
+        platform_key:
+          type: string
+          description: Platform key where the groups exist
+          writeOnly: true
+        user_id:
+          type: integer
+          description: ID of the user to manage group access for
+          writeOnly: true
+        groups_to_add:
+          type: array
+          items:
+            type: integer
+          writeOnly: true
+          description: List of group IDs to grant access to
+        groups_to_remove:
+          type: array
+          items:
+            type: integer
+          writeOnly: true
+          description: List of group IDs to revoke access from
+        policy_id:
+          type: integer
+          readOnly: true
+          description: Policy ID
+        policy_name:
+          type: string
+          readOnly: true
+          description: Policy name
+        groups_with_access:
+          type: array
+          items:
+            $ref: '#/components/schemas/UserGroupAccessInfo'
+          readOnly: true
+          description: Groups with access
+      required:
+      - groups_with_access
+      - platform_key
+      - policy_id
+      - policy_name
+      - user_id
+    UserGroupAccessInfo:
+      type: object
+      description: Serializer for group access information in responses
+      properties:
+        id:
+          type: integer
+          description: Group ID
+        name:
+          type: string
+          description: Group name
+        description:
+          type: string
+          description: Group description
+        permissions:
+          type: array
+          items:
+            type: string
+          description: List of permissions user has for this group (e.g., ['read',
+            'manageMentors'])
+      required:
+      - description
+      - id
+      - name
+      - permissions
     UserInfo:
       type: object
       description: Serializer for user information.

package/src/core/OpenAPI.ts

@@ -21,7 +21,7 @@ export type OpenAPIConfig = {
 
 export const OpenAPI: OpenAPIConfig = {
     BASE: 'https://base.manager.iblai.app',
-    VERSION: '4.41.1-core',
+    VERSION: '4.40.1-core',
     WITH_CREDENTIALS: false,
     CREDENTIALS: 'include',
     TOKEN: undefined,

package/src/index.ts

@@ -149,6 +149,7 @@ export type { MarkAllReadRequest } from './models/MarkAllReadRequest';
 export type { MarkAllReadResponse } from './models/MarkAllReadResponse';
 export type { MediaResource } from './models/MediaResource';
 export { MediaTypeEnum } from './models/MediaTypeEnum';
+export type { MentorPolicy } from './models/MentorPolicy';
 export type { MetricDetail } from './models/MetricDetail';
 export { ModeEnum } from './models/ModeEnum';
 export type { NewPerLearnerList } from './models/NewPerLearnerList';
@@ -382,6 +383,8 @@ export type { UserApp } from './models/UserApp';
 export type { UserDeleteAPIError } from './models/UserDeleteAPIError';
 export type { UserDeleteAPIRequest } from './models/UserDeleteAPIRequest';
 export type { UserDeleteAPIResponse } from './models/UserDeleteAPIResponse';
+export type { UserGroupAccess } from './models/UserGroupAccess';
+export type { UserGroupAccessInfo } from './models/UserGroupAccessInfo';
 export type { UserInfo } from './models/UserInfo';
 export type { UserLicenseAssignmentCreate } from './models/UserLicenseAssignmentCreate';
 export type { UserLicenseAssignmentDetail } from './models/UserLicenseAssignmentDetail';

package/src/models/MentorPolicy.ts

@@ -0,0 +1,52 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { RbacPolicyGroup } from './RbacPolicyGroup';
+import type { RbacUser } from './RbacUser';
+/**
+ * Serializer for mentor-specific RBAC policies using ModelSerializer pattern.
+ * Accepts mentor_id and role, generates resources and role internally.
+ */
+export type MentorPolicy = {
+    readonly id: number;
+    /**
+     * Policy name. If not supplied, defaults to a UUID4
+     */
+    readonly name: string;
+    /**
+     * Platform key where the mentor belongs
+     */
+    platform_key: string;
+    /**
+     * ID of the mentor to manage access for
+     */
+    mentor_id: number;
+    /**
+     * Role for accessing this mentor (viewer or editor)
+     */
+    role: string;
+    /**
+     * List of resources this policy applies to
+     */
+    readonly resources: any;
+    readonly users: Array<RbacUser>;
+    readonly groups: Array<RbacPolicyGroup>;
+    /**
+     * List of group IDs to grant access to this mentor
+     */
+    groups_to_add?: Array<number>;
+    /**
+     * List of group IDs to revoke access from this mentor
+     */
+    groups_to_remove?: Array<number>;
+    /**
+     * List of user IDs to grant access to this mentor
+     */
+    users_to_add?: Array<number>;
+    /**
+     * List of user IDs to revoke access from this mentor
+     */
+    users_to_remove?: Array<number>;
+};
+

package/src/models/PatchedRbacGroup.ts

@@ -26,6 +26,7 @@ export type PatchedRbacGroup = {
      * Optional group description
      */
     description?: string;
+    readonly owner?: RbacUser;
     readonly users?: Array<RbacUser>;
     /**
      * List of user IDs to add to this group

package/src/models/RbacGroup.ts

@@ -26,6 +26,7 @@ export type RbacGroup = {
      * Optional group description
      */
     description?: string;
+    readonly owner: RbacUser;
     readonly users: Array<RbacUser>;
     /**
      * List of user IDs to add to this group

package/src/models/StudentLLMAccessResponse.ts

@@ -14,9 +14,5 @@ export type StudentLLMAccessResponse = {
      * List of LLM resource paths that students can access. Format: ['llms/openai/models/gpt-4', 'llms/openai/', 'llms/']
      */
     llm_resources: Array<string>;
-    /**
-     * Success message (only in set access response)
-     */
-    message?: string;
 };
 

package/src/models/UserGroupAccess.ts

@@ -0,0 +1,39 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { UserGroupAccessInfo } from './UserGroupAccessInfo';
+/**
+ * ModelSerializer for user group access policies
+ */
+export type UserGroupAccess = {
+    /**
+     * Platform key where the groups exist
+     */
+    platform_key: string;
+    /**
+     * ID of the user to manage group access for
+     */
+    user_id: number;
+    /**
+     * List of group IDs to grant access to
+     */
+    groups_to_add?: Array<number>;
+    /**
+     * List of group IDs to revoke access from
+     */
+    groups_to_remove?: Array<number>;
+    /**
+     * Policy ID
+     */
+    readonly policy_id: number;
+    /**
+     * Policy name
+     */
+    readonly policy_name: string;
+    /**
+     * Groups with access
+     */
+    readonly groups_with_access: Array<UserGroupAccessInfo>;
+};
+

package/src/models/UserGroupAccessInfo.ts

@@ -0,0 +1,26 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for group access information in responses
+ */
+export type UserGroupAccessInfo = {
+    /**
+     * Group ID
+     */
+    id: number;
+    /**
+     * Group name
+     */
+    name: string;
+    /**
+     * Group description
+     */
+    description: string;
+    /**
+     * List of permissions user has for this group (e.g., ['read', 'manageMentors'])
+     */
+    permissions: Array<string>;
+};
+