@iblai/iblai-api 4.43.5-core → 4.44.0-core

package/src/services/CoreService.ts

@@ -11,6 +11,7 @@ import type { LauncherViewPostRequest } from '../models/LauncherViewPostRequest'
 import type { LtiKey } from '../models/LtiKey';
 import type { LtiMentor } from '../models/LtiMentor';
 import type { LtiTool } from '../models/LtiTool';
+import type { MentorPolicy } from '../models/MentorPolicy';
 import type { PaginatedRbacGroupList } from '../models/PaginatedRbacGroupList';
 import type { PaginatedRbacPolicyList } from '../models/PaginatedRbacPolicyList';
 import type { PaginatedRbacRoleList } from '../models/PaginatedRbacRoleList';
@@ -42,6 +43,7 @@ import type { TokenProxyInput } from '../models/TokenProxyInput';
 import type { TokenProxyOutput } from '../models/TokenProxyOutput';
 import type { UserDeleteAPIRequest } from '../models/UserDeleteAPIRequest';
 import type { UserDeleteAPIResponse } from '../models/UserDeleteAPIResponse';
+import type { UserGroupAccess } from '../models/UserGroupAccess';
 import type { UserPlatformLink } from '../models/UserPlatformLink';
 import type { UserPlatformManagementListViewGetResponse } from '../models/UserPlatformManagementListViewGetResponse';
 import type { UserPlatformSelfLinkRequest } from '../models/UserPlatformSelfLinkRequest';
@@ -1209,10 +1211,19 @@ export class CoreService {
      * @throws ApiError
      */
     public static coreRbacGroupsList({
+        platformKey,
+        owner,
         page,
         pageSize,
-        platformKey,
     }: {
+        /**
+         * Filter groups by platform key
+         */
+        platformKey: string,
+        /**
+         * Filter groups by owner username
+         */
+        owner?: string,
         /**
          * A page number within the paginated result set.
          */
@@ -1221,15 +1232,12 @@ export class CoreService {
          * Number of results to return per page.
          */
         pageSize?: number,
-        /**
-         * Filter groups by platform key
-         */
-        platformKey?: string,
     }): CancelablePromise<PaginatedRbacGroupList> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/core/rbac/groups/',
             query: {
+                'owner': owner,
                 'page': page,
                 'page_size': pageSize,
                 'platform_key': platformKey,
@@ -1365,7 +1373,7 @@ export class CoreService {
         /**
          * platform key for authorization check
          */
-        platformKey?: string,
+        platformKey: string,
     }): CancelablePromise<void> {
         return __request(OpenAPI, {
             method: 'DELETE',
@@ -1381,6 +1389,63 @@ export class CoreService {
             },
         });
     }
+    /**
+     * Get mentor access status
+     * Retrieve current access information for a specific mentor, including all groups and users that have access with their respective roles.
+     * @returns MentorPolicy
+     * @throws ApiError
+     */
+    public static coreRbacMentorAccessList({
+        mentorId,
+        platformKey,
+    }: {
+        /**
+         * ID of the mentor to get access information for
+         */
+        mentorId: number,
+        /**
+         * Platform key where the mentor belongs
+         */
+        platformKey: string,
+    }): CancelablePromise<Array<MentorPolicy>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/core/rbac/mentor-access/',
+            query: {
+                'mentor_id': mentorId,
+                'platform_key': platformKey,
+            },
+            errors: {
+                400: `Missing or invalid query parameters`,
+                403: `Permission denied - ShareMentor permission required`,
+                404: `Platform not found`,
+                500: `Internal server error`,
+            },
+        });
+    }
+    /**
+     * Control which RbacGroups and/or Users have access to a mentor and with what Role
+     * 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.
+     * @returns MentorPolicy
+     * @throws ApiError
+     */
+    public static coreRbacMentorAccessCreate({
+        requestBody,
+    }: {
+        requestBody: MentorPolicy,
+    }): CancelablePromise<MentorPolicy> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/core/rbac/mentor-access/',
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Invalid request data or validation errors`,
+                403: `Permission denied - ShareMentor permission required`,
+                404: `Platform or mentor not found`,
+            },
+        });
+    }
     /**
      * Check user permissions
      * Check user permissions for specified resources
@@ -1567,7 +1632,7 @@ export class CoreService {
         /**
          * platform key for authorization check
          */
-        platformKey?: string,
+        platformKey: string,
     }): CancelablePromise<void> {
         return __request(OpenAPI, {
             method: 'DELETE',
@@ -1740,7 +1805,7 @@ export class CoreService {
         /**
          * platform key for authorization check
          */
-        platformKey?: string,
+        platformKey: string,
     }): CancelablePromise<void> {
         return __request(OpenAPI, {
             method: 'DELETE',
@@ -1856,6 +1921,62 @@ export class CoreService {
             },
         });
     }
+    /**
+     * Get user group access status
+     * Retrieve current group access information for a specific user, including all groups the user has access to and whether they have mentor management permissions.
+     * @returns UserGroupAccess
+     * @throws ApiError
+     */
+    public static coreRbacUserGroupAccessRetrieve({
+        platformKey,
+        userId,
+    }: {
+        /**
+         * Platform key where the groups exist
+         */
+        platformKey: string,
+        /**
+         * ID of the user to check group access for
+         */
+        userId: number,
+    }): CancelablePromise<UserGroupAccess> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/core/rbac/user-group-access/',
+            query: {
+                'platform_key': platformKey,
+                'user_id': userId,
+            },
+            errors: {
+                400: `Missing or invalid query parameters`,
+                404: `Platform or user not found`,
+                500: `Internal server error`,
+            },
+        });
+    }
+    /**
+     * Manage user access to groups
+     * 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.
+     * @returns UserGroupAccess
+     * @throws ApiError
+     */
+    public static coreRbacUserGroupAccessCreate({
+        requestBody,
+    }: {
+        requestBody: UserGroupAccess,
+    }): CancelablePromise<UserGroupAccess> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/core/rbac/user-group-access/',
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Invalid request data or validation errors`,
+                404: `Platform or user not found`,
+                500: `Internal server error`,
+            },
+        });
+    }
     /**
      * Invalidate all tokens for the authenticated user
      * @returns any No response body