Merge pull request #5528 from mpmadhavig/bulk-api

Add operation-scope definition

Author: mpmadhavig

en/asgardeo/docs/apis/organization-apis/restapis/scim-bulk.yaml

@@ -24,7 +24,7 @@ paths:
           - **DELETE** operation: Removes an existing resource.
         Learn more about [defining batch operations](../../scim2-batch-operations).
 
-         <b>Scope(Permission) required:</b> `internal_org_bulk_resource_create`
+        <b>Scopes required:</b> ``internal_org_bulk_resource_create`` or a [operation-wise scope](../../../scim2/scim2-batch-operations/#scopepermission-required-for-batch-operations)
       operationId: createBulkUsers
       requestBody:
         content:

en/asgardeo/docs/apis/restapis/scim2-bulk.yaml

@@ -8,22 +8,23 @@ servers:
   - url: 'https://api.asgardeo.io/t/{organization-name}/scim2'
 tags:
   - name: Bulk Endpoint
-    description: This endpoint is used to create/update/delete SCIM resources (users and/or groups) in bulk.
+    description: |
+      This endpoint is used to create/update/delete SCIM resources (users and/or groups) in bulk.
 paths:
   /Bulk:
     post:
       tags:
       - Bulk Endpoint
       summary: Create/Update/Replace/Delete SCIM Resources (Users/ Groups) in Bulk
-      description: "This API is used to create/update/replace/delete SCIM resources in bulk. You need to specify different operations in the request payload corresponding to the type of bulk update: </br>
-                      </br>
-                    - **POST** operation: Adds new resources. </br>
-                    - **PUT** operation: Replaces an existing resource. </br>
-                    - **PATCH** operation: Updates attributes of an existing resource. </br>
-                    - **DELETE** operation: Removes an existing resource. </br>
-                   
-                   - <b>Scopes required:</b> ``internal_bulk_resource_create``\n\n
-                   - <b>Flow type:</b> Client Credentials OAuth Flow"
+      description: |
+        This API is used to create/update/replace/delete SCIM resources in bulk. You need to specify different operations in the request payload corresponding to the type of bulk update: </br></br>
+          - **POST** operation: Adds new resources. </br>
+          - **PUT** operation: Replaces an existing resource. </br>
+          - **PATCH** operation: Updates attributes of an existing resource. </br>
+          - **DELETE** operation: Removes an existing resource. </br>
+          - <b>Scopes required:</b> ``internal_bulk_resource_create`` or an [operation-wise scope](../../scim2/scim2-batch-operations/#scopepermission-required-for-batch-operations)
+          - <b>Flow type:</b> Client Credentials OAuth Flow
+
       operationId: createBulkUsers
       requestBody:
         content:

en/asgardeo/docs/apis/scim2/index.md

@@ -5,6 +5,7 @@ The SCIM2 Rest APIs of {{product_name}} implements the SCIM 2.0 protocol accordi
 - [SCIM2 Users API]({{base_path}}/apis/scim2/scim2-users-rest-api/)
 - [SCIM2 Groups API]({{base_path}}/apis/scim2/scim2-groups-rest-api/)
 - [SCIM2 Bulk API]({{base_path}}/apis/scim2/scim2-bulk-rest-api/)
+- [SCIM2 Batch Operations]({{base_path}}/apis/scim2/scim2-batch-operations/)
 - [SCIM2 Resource Types API]({{base_path}}/apis/scim2/scim2-resource-types-rest-api/)
 - [SCIM2 Service Provider Configs API]({{base_path}}/apis/scim2/scim2-service-provider-configs-rest-api/)
 - [SCIM2 Build User Creation Payload]({{base_path}}/apis/scim2/build-scim2-user-creation-payload/)

en/asgardeo/docs/apis/scim2/scim2-batch-operations.md

@@ -0,0 +1 @@
+{% include "../../../../includes/apis/scim2/scim2-batch-operations.md" %}

en/asgardeo/mkdocs.yml

@@ -639,6 +639,7 @@ nav:
           - SCIM 2.0 Users API: apis/scim2/scim2-users-rest-api.md
           - SCIM 2.0 Groups API: apis/scim2/scim2-groups-rest-api.md
           - SCIM 2.0 Bulk API: apis/scim2/scim2-bulk-rest-api.md
+          - SCIM 2.0 Batch Operations: apis/scim2/scim2-batch-operations.md
           - SCIM 2.0 Resource types API: apis/scim2/scim2-resource-types-rest-api.md
           - SCIM 2.0 Service provider configs API: apis/scim2/scim2-service-provider-configs-rest-api.md
           - SCIM 2.0 Build user creation payload: apis/scim2/build-scim2-user-creation-payload.md

en/identity-server/next/docs/apis/organization-apis/restapis/scim2-bulk.yaml

@@ -28,7 +28,7 @@ paths:
           - **DELETE** operation: Removes an existing resource.
         Learn more about [defining batch operations](../../scim2-batch-operations).
 
-         <b>Scope(Permission) required:</b> `internal_org_bulk_resource_create`
+        <b>Scopes required:</b> ``internal_org_bulk_resource_create`` or a [operation-wise scope](../../scim2-batch-operations/#scopepermission-required-for-batch-operations)
       operationId: createBulkUsers
       requestBody:
         content:

en/identity-server/next/docs/apis/restapis/scim2-bulk.yaml

@@ -28,7 +28,7 @@ paths:
           - **DELETE** operation: Removes an existing resource.
         Learn more about [defining batch operations](../scim2-batch-operations).
 
-         <b>Scope(Permission) required:</b> `internal_bulk_resource_create`
+        <b>Scopes required:</b> ``internal_bulk_resource_create`` or a [operation-wise scope](../scim2-batch-operations/#scopepermission-required-for-batch-operations)
       operationId: createBulkUsers
       requestBody:
         content: