Add OpenAPI spec for IP whitelisting.

Author: apognu

packages/marble-api/openapis/marblecore-api.yaml

@@ -273,6 +273,8 @@ paths:
     $ref: ./marblecore-api/admin.yml#/~1organizations
   /organizations/{organizationId}:
     $ref: ./marblecore-api/admin.yml#/~1organizations~1{organizationId}
+  /organizations/{organizationId}/subnets:
+    $ref: ./marblecore-api/admin.yml#/~1organizations~1{organizationId}~1subnets
   /organizations/{organizationId}/users:
     $ref: ./marblecore-api/admin.yml#/~1organizations~1{organizationId}~1users
   /editor/{scenarioId}/identifiers:

packages/marble-api/openapis/marblecore-api/_schemas.yml

@@ -348,6 +348,8 @@ CreateOrganizationBodyDto:
   $ref: admin.yml#/components/schemas/CreateOrganizationBodyDto
 UpdateOrganizationBodyDto:
   $ref: admin.yml#/components/schemas/UpdateOrganizationBodyDto
+OrganizationSubnetsDto:
+  $ref: admin.yml#/components/schemas/OrganizationSubnetsDto
 UserDto:
   $ref: admin.yml#/components/schemas/UserDto
 CreateUser:

packages/marble-api/openapis/marblecore-api/admin.yml

@@ -405,6 +405,41 @@
         $ref: 'components.yml#/responses/403'
       '404':
         $ref: 'components.yml#/responses/404'
+/organizations/{organizationId}/subnets:
+  put:
+    tags:
+      - Admin
+      - Organizations
+    summary: Update organization subnets
+    operationId: updateOrganizationSubnets
+    security:
+      - bearerAuth: []
+    parameters:
+      - name: organizationId
+        description: ID of the organization
+        in: path
+        required: true
+        schema:
+          type: string
+          format: uuid
+    requestBody:
+      description: Object containing the list of subnets to allow
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/OrganizationSubnetsDto'
+      required: true
+    responses:
+      '200':
+        description: The list of users of the organization
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/OrganizationSubnetsDto'
+      '400':
+        $ref: 'components.yml#/responses/400'
+      '422':
+        $ref: 'components.yml#/responses/422'
 /organizations/{organizationId}/users:
   get:
     tags:
@@ -452,6 +487,7 @@ components:
         - name
         - sanction_threshold
         - sanction_limit
+        - allowed_networks
       properties:
         id:
           type: string
@@ -471,6 +507,9 @@ components:
         auto_assign_queue_limit:
           type: number
           description: Maximum number of assignable cases for a user
+        allowed_networks:
+          type: array
+          format: string
     CreateOrganizationBodyDto:
       type: object
       required:
@@ -489,6 +528,14 @@ components:
           type: number
         auto_assign_queue_limit:
           type: number
+    OrganizationSubnetsDto:
+      type: object
+      properties:
+        subnets:
+          description: List of CIDR subnets (x.x.x.x/yy)
+          type: array
+          items:
+            type: string
     UserDto:
       type: object
       required:

packages/marble-api/src/generated/marblecore-api.ts

@@ -1143,6 +1143,7 @@ export type OrganizationDto = {
     sanctions_limit?: number;
     /** Maximum number of assignable cases for a user */
     auto_assign_queue_limit?: number;
+    allowed_networks: any;
 };
 export type CreateOrganizationBodyDto = {
     name: string;
@@ -1153,6 +1154,10 @@ export type UpdateOrganizationBodyDto = {
     sanctions_limit?: number;
     auto_assign_queue_limit?: number;
 };
+export type OrganizationSubnetsDto = {
+    /** List of CIDR subnets (x.x.x.x/yy) */
+    subnets?: string[];
+};
 export type InboxUserDto = {
     id: string;
     inbox_id: string;
@@ -3873,6 +3878,25 @@ export function deleteOrganization(organizationId: string, opts?: Oazapfts.Reque
         method: "DELETE"
     }));
 }
+/**
+ * Update organization subnets
+ */
+export function updateOrganizationSubnets(organizationId: string, organizationSubnetsDto: OrganizationSubnetsDto, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: OrganizationSubnetsDto;
+    } | {
+        status: 400;
+        data: string;
+    } | {
+        status: 422;
+        data: object;
+    }>(`/organizations/${encodeURIComponent(organizationId)}/subnets`, oazapfts.json({
+        ...opts,
+        method: "PUT",
+        body: organizationSubnetsDto
+    })));
+}
 /**
  * List all users of an organization
  */