Automated commit 'IDNPALM- 4257 API Documentation for Bulk Update Acc…

…ess Profile (#1504)

* IDNPALM-4257 Access profile bulk update API documentation.

* IDNPALM-4257 Access profile bulk update API documentation.

* IDNPALM-4257 Lint errors resolved.

* IDNPALM-4257 Lint errors resolved.

* IDNPALM-4257 feature flag precondition response added.

* IDNPALM-4257 API name changed.

* IDNPALM-4249 Remove comment configuration options from POST /v3/access-profiles' by github action: 7841109100

idn/beta/paths/access-profile-bulk-update-requestable.yaml

@@ -0,0 +1,61 @@
+post:
+  operationId: updateAccessProfilesInBulk
+  summary: Update Access Profile(s) requestable field.
+  tags:
+    - Access Profiles
+  description: >-
+    This API initiates a bulk update of field requestable for one or more Access Profiles.
+    
+    
+    >  If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated**
+        list of the response.Requestable field of these Access Profiles marked as **true** or **false**.
+
+    >  If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound**
+    list of the response. Access Profiles marked as **notFound** will not be updated.
+
+    >  A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition,
+    a SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able
+    to administer.
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: '../../v3/schemas/access/AccessProfileBulkUpdateRequest.yaml'
+        example:
+          [
+              {
+                "id": "464ae7bf-791e-49fd-b746-06a2e4a89635",
+                "requestable": false
+              }
+          ]
+  responses:
+    '207':
+      description: List of updated and not updated Access Profiles.
+      content:
+        application/json:
+          schema:
+            $ref: '../../v3/schemas/access/AccessProfileBulkUpdateResponse.yaml'
+          example:
+            [
+              {
+                "id": "464ae7bf-791e-49fd-b746-06a2e4a89635",
+                "status": "201",
+                "requestable": false,
+                "description": "Access Profile updated successfully."
+              }
+            ]
+    '400':
+      $ref: '../../v3/responses/400.yaml'
+    '401':
+      $ref: '../../v3/responses/401.yaml'
+    '403':
+      $ref: '../../v3/responses/403.yaml'
+    '412':
+      $ref: '../../v3/responses/412.yaml'
+    '429':
+      $ref: '../../v3/responses/429.yaml'
+    '500':
+      $ref: '../../v3/responses/500.yaml'
+  security:
+    - UserContextAuth: [idn:access-profile:manage]

idn/sailpoint-api.beta.yaml

@@ -1069,6 +1069,8 @@ paths:
     $ref: './beta/paths/access-profile.yaml'
   /access-profiles/bulk-delete:
     $ref: './beta/paths/access-profile-bulk-delete.yaml'
+  /access-profiles/bulk-update-requestable:
+    $ref: './beta/paths/access-profile-bulk-update-requestable.yaml'
   /access-profiles/{id}/entitlements:
     $ref: './beta/paths/access-profile-entitlements.yaml'
   /access-requests:

idn/v3/responses/412.yaml

@@ -0,0 +1,9 @@
+description: Precondition Failed - Returned in response if API/Feature not enabled for an organization.
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        message:
+          description: A message describing the error
+          example: " API/Feature not enabled for your organization."

idn/v3/schemas/access/AccessProfileBulkUpdateRequest.yaml

@@ -0,0 +1,22 @@
+description: List of Access profiles to be updated.
+type: array
+items:
+  type: object
+  description: Access Profile's basic details.
+  properties:
+    id:
+      type: string
+      description: Access Profile ID.
+      example: 464ae7bf-791e-49fd-b746-06a2e4a8
+    requestable:
+      type: boolean
+      description:  Access Profile is requestable or not.
+      example: false
+example:
+  [
+    {
+      "id": "464ae7bf-791e-49fd-b746-06a2e4a8",
+      "requestable": false
+    }
+  ]
+required: [id, requestable]

idn/v3/schemas/access/AccessProfileBulkUpdateResponse.yaml

@@ -0,0 +1,13 @@
+description: Access Profile Bulk update response.
+type: array
+items:
+    $ref: "./AccessProfileUpdateItem.yaml"
+example:
+  [
+      {
+          "id": "464ae7bf-791e-49fd-b746-06a2e4a8",
+          "status": "201",
+          "requestable": false,
+          "description": "Access Profile updated successfully."
+      }
+  ]

idn/v3/schemas/access/AccessProfileUpdateItem.yaml

@@ -0,0 +1,36 @@
+type: object
+properties:
+  id:
+    description: Identifier of Access Profile in bulk update request.
+    type: string
+    example: "2c7180a46faadee4016fb4e018c20642"
+  requestable:
+    description: Access Profile requestable or not.
+    type: boolean
+    example: false
+  status:
+    description: >
+
+      The HTTP response status code returned for an individual Access Profile that is requested for update during a bulk update operation.
+      
+      
+      > 201   - Access profile is updated successfully.
+      
+
+      > 404   - Access profile not found.
+
+    type: string
+    example: "201"
+  description:
+    description: >
+      Human readable status description and containing additional
+      context information about success or failures etc.
+    type: string
+    example: >
+     
+      > Access profile is updated successfully.
+      
+      
+      > Referenced Access profile with Id "2c7180a46faadee4016fb4e018c20642" was not found.
+
+required: [id, requestable, status]