Automated commit 'ISCAIM-21767 - add remove account(s) docs (#1598)' by github action: 8520704082

idn/beta/paths/remove-account.yaml

@@ -0,0 +1,46 @@
+post:
+  operationId: deleteAccountAsync
+  summary: Remove Account
+  tags:
+    - Accounts
+  description: |
+    Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation.
+
+    This endpoint is good for:
+    * Removing accounts that no longer exist on the source.
+    * Removing accounts that won't be aggregated following updates to the source configuration.
+    * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc.
+
+  parameters:
+    - in: path
+      name: id
+      schema:
+        type: string
+      required: true
+      description: The account id
+      example: c350d6aa4f104c61b062cb632421ad10
+  responses:
+    "202":
+      description: Accepted. Returns task result details of removal request.
+      content:
+        application/json:
+          schema:
+            $ref: "../../v3/schemas/TaskResultDto.yaml"
+          example:
+            {
+              "type": "TASK_RESULT",
+              "id": "464ae7bf791e49fdb74606a2e4a89635",
+              "name": null
+            }
+    "400":
+      $ref: "../../v3/responses/400.yaml"
+    "401":
+      $ref: "../../v3/responses/401.yaml"
+    "403":
+      $ref: "../../v3/responses/403.yaml"
+    "429":
+      $ref: "../../v3/responses/429.yaml"
+    "500":
+      $ref: "../../v3/responses/500.yaml"
+  security:
+    - UserContextAuth: [ idn:account:remove ]

idn/beta/paths/remove-accounts.yaml

@@ -0,0 +1,46 @@
+post:
+  operationId: deleteAccountsAsync
+  summary: Remove All Accounts
+  tags:
+    - Accounts
+  description: |
+    Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation.
+
+    This endpoint is good for:
+    * Removing accounts that no longer exist on the source.
+    * Removing accounts that won't be aggregated following updates to the source configuration.
+    * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc.
+
+  parameters:
+    - in: path
+      name: id
+      schema:
+        type: string
+      required: true
+      description: The source id
+      example: ebbf35756e1140699ce52b233121384a
+  responses:
+    "202":
+      description: Accepted. Returns task result details of removal request.
+      content:
+        application/json:
+          schema:
+            $ref: "../../v3/schemas/TaskResultDto.yaml"
+          example:
+            {
+              "type": "TASK_RESULT",
+              "id": "464ae7bf791e49fdb74606a2e4a89635",
+              "name": null
+            }
+    "400":
+      $ref: "../../v3/responses/400.yaml"
+    "401":
+      $ref: "../../v3/responses/401.yaml"
+    "403":
+      $ref: "../../v3/responses/403.yaml"
+    "429":
+      $ref: "../../v3/responses/429.yaml"
+    "500":
+      $ref: "../../v3/responses/500.yaml"
+  security:
+    - UserContextAuth: [ idn:account:remove ]

idn/sailpoint-api.beta.yaml

@@ -1130,6 +1130,8 @@ paths:
     $ref: './beta/paths/accounts-id-disable.yaml'
   /accounts/{id}/unlock:
     $ref: './beta/paths/accounts-id-unlock.yaml'
+  /accounts/{id}/remove:
+    $ref: './beta/paths/remove-account.yaml'
   /identities-accounts/{id}/enable:
     $ref: './beta/paths/identity-accounts-id-enable.yaml'
   /identities-accounts/{id}/disable:
@@ -1554,6 +1556,8 @@ paths:
     $ref: './v3/paths/provisioning-policy.yaml'
   /sources/{sourceId}/provisioning-policies/bulk-update:
     $ref: './v3/paths/provisioning-policies-bulk-update.yaml'
+  /sources/{id}/remove-accounts:
+    $ref: './beta/paths/remove-accounts.yaml'
   /sources/{sourceId}/schemas:
     $ref: './beta/paths/schemas.yaml'
   /sources/{sourceId}/schemas/{schemaId}: