Automated commit by github action: 14068063033

static/api-specs/idn/sailpoint-api.v2024.yaml

@@ -1461,6 +1461,10 @@ paths:
     $ref: ./v2024/paths/configuration-hub/object-mapping-bulk-create.yaml
   /configuration-hub/object-mappings/{sourceOrg}/bulk-patch:
     $ref: ./v2024/paths/configuration-hub/object-mapping-bulk-update.yaml
+  /configuration-hub/scheduled-actions:
+    $ref: ./v2024/paths/configuration-hub/scheduled-actions.yaml
+  /configuration-hub/scheduled-actions/{id}:
+    $ref: ./v2024/paths/configuration-hub/scheduled-actions-id.yaml
   /configuration-hub/backups/uploads:
     $ref: ./v2024/paths/configuration-hub/backup-uploads.yaml
   /configuration-hub/backups/uploads/{id}:

static/api-specs/idn/v2024/paths/configuration-hub/scheduled-actions-id.yaml

@@ -0,0 +1,115 @@
+patch:
+  operationId: updateScheduledAction
+  security:
+    - userAuth: [sp:config-scheduled-action:manage]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
+  tags:
+    - Configuration Hub
+  summary: Update Scheduled Action
+  description: >-
+    This API updates an existing scheduled action using JSON Patch format.
+  parameters:
+    - in: path
+      name: scheduledActionId
+      schema:
+        type: string
+      required: true
+      description: The ID of the scheduled action.
+      example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
+      x-sailpoint-resource-operation-id: listScheduledActions
+  requestBody:
+    description: >-
+      The JSON Patch document containing the changes to apply to the scheduled action.
+    required: true
+    content:
+      application/json-patch+json:
+        schema:
+          $ref: '../../schemas/JsonPatch.yaml'
+        example:
+          [
+            {
+              "op": "replace",
+              "path": "/content/name",
+              "value": "Updated Backup Name"
+            },
+            {
+              "op": "replace",
+              "path": "/cronString",
+              "value": "0 0 9 * * ?"
+            }
+          ]
+  responses:
+    '200':
+      description: >-
+        The updated scheduled action.
+      content:
+        application/json:
+          schema:
+            $ref: '../../schemas/configuration-hub/ScheduledActionResponse.yaml'
+          example:
+            {
+              "id": "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde",
+              "created": "2024-08-16T14:16:58.389Z",
+              "jobType": "BACKUP",
+              "content": {
+                "name": "Updated Backup Name",
+                "backupOptions": {
+                  "includeTypes": ["SOURCE", "IDENTITY"],
+                  "objectOptions": {
+                    "SOURCE": {
+                      "includedNames": ["Source1", "Source2"]
+                    }
+                  }
+                }
+              },
+              "startTime": "2024-08-16T14:16:58.389Z",
+              "cronString": "0 0 9 * * ?"
+            }
+    '400':
+      $ref: '../../responses/400.yaml'
+    '401':
+      $ref: '../../responses/401.yaml'
+    '403':
+      $ref: '../../responses/403.yaml'
+    '404':
+      $ref: '../../responses/404.yaml'
+    '429':
+      $ref: '../../responses/429.yaml'
+    '500':
+      $ref: '../../responses/500.yaml'
+delete:
+  operationId: deleteScheduledAction
+  security:
+    - userAuth: [sp:config-scheduled-action:manage]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
+  tags:
+    - Configuration Hub
+  summary: Delete Scheduled Action
+  description: >-
+    This API deletes an existing scheduled action.
+  parameters:
+    - in: path
+      name: scheduledActionId
+      schema:
+        type: string
+      required: true
+      description: The ID of the scheduled action.
+      example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
+      x-sailpoint-resource-operation-id: listScheduledActions
+  responses:
+    '204':
+      $ref: '../../responses/204.yaml'
+    '400':
+      $ref: '../../responses/400.yaml'
+    '401':
+      $ref: '../../responses/401.yaml'
+    '403':
+      $ref: '../../responses/403.yaml'
+    '404':
+      $ref: '../../responses/404.yaml'
+    '429':
+      $ref: '../../responses/429.yaml'
+    '500':
+      $ref: '../../responses/500.yaml'

static/api-specs/idn/v2024/paths/configuration-hub/scheduled-actions.yaml

@@ -0,0 +1,122 @@
+get:
+  operationId: listScheduledActions
+  security:
+    - userAuth: [sp:config-scheduled-action:read, sp:config-scheduled-action:manage]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
+  tags:
+    - Configuration Hub
+  summary: List Scheduled Actions
+  description: >-
+    This API gets a list of existing scheduled actions for the current tenant.
+  responses:
+    '200':
+      description: >-
+        List of existing scheduled actions.
+      content:
+        application/json:
+          schema:
+            type: array
+            items:
+              $ref: '../../schemas/configuration-hub/ScheduledActionResponse.yaml'
+          example:
+            [
+              {
+                "id": "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde",
+                "created": "2024-08-16T14:16:58.389Z",
+                "jobType": "BACKUP",
+                "content": {
+                  "name": "Backup Name",
+                  "backupOptions": {
+                    "includeTypes": ["SOURCE", "IDENTITY"], 
+                    "objectOptions": []
+                  }                
+                },
+                "startTime": "2024-08-16T14:16:58.389Z",
+                "cronString": "0 0 * * *"
+              }
+            ]
+    '400':
+      $ref: '../../responses/400.yaml'
+    '401':
+      $ref: '../../responses/401.yaml'
+    '403':
+      $ref: '../../responses/403.yaml'
+    '429':
+      $ref: '../../responses/429.yaml'
+    '500':
+      $ref: '../../responses/500.yaml'
+post:
+  operationId: createScheduledAction
+  security:
+    - userAuth: [sp:config-scheduled-action:manage]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
+  tags:
+    - Configuration Hub
+  summary: Create Scheduled Action
+  description: >-
+    This API creates a new scheduled action for the current tenant.
+  requestBody:
+    description: >-
+      The scheduled action creation request body.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: '../../schemas/configuration-hub/ScheduledActionPayload.yaml'
+        example:
+          {
+            "jobType": "BACKUP",
+            "startTime": "2024-08-16T14:16:58.389Z",
+            "cronString": "0 0 12 * * ?",
+            "timeZoneId": "America/Chicago",
+            "content": {
+              "name": "Daily Backup",
+              "backupOptions": {
+                "includeTypes": ["SOURCE", "IDENTITY"],
+                "objectOptions": {
+                  "SOURCE": {
+                    "includedNames": ["Source1", "Source2"]
+                  }
+                }
+              }
+            }
+          }
+  responses:
+    '200':
+      description: >-
+        The created scheduled action.
+      content:
+        application/json:
+          schema:
+            $ref: '../../schemas/configuration-hub/ScheduledActionResponse.yaml'
+          example:
+            {
+              "id": "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde",
+              "created": "2024-08-16T14:16:58.389Z",
+              "jobType": "BACKUP",
+              "content": {
+                "name": "Daily Backup",
+                "backupOptions": {
+                  "includeTypes": ["SOURCE", "IDENTITY"],
+                  "objectOptions": {
+                    "SOURCE": {
+                      "includedNames": ["Source1", "Source2"]
+                    }
+                  }
+                }
+              },
+              "startTime": "2024-08-16T14:16:58.389Z",
+              "cronString": "0 0 12 * * ?"
+            }
+    '400':
+      $ref: '../../responses/400.yaml'
+    '401':
+      $ref: '../../responses/401.yaml'
+    '403':
+      $ref: '../../responses/403.yaml'
+    '429':
+      $ref: '../../responses/429.yaml'
+    '500':
+      $ref: '../../responses/500.yaml'

static/api-specs/idn/v2024/schemas/configuration-hub/ScheduledActionPayload.yaml

@@ -0,0 +1,78 @@
+type: object
+required:
+  - jobType
+  - content
+properties:
+  jobType:
+    type: string
+    description: Type of the scheduled job.
+    enum:
+      - BACKUP
+      - CREATE_DRAFT
+      - CONFIG_DEPLOY_DRAFT
+    example: BACKUP
+  startTime:
+    type: string
+    format: date-time
+    description: The time when this scheduled action should start. Optional.
+    example: 2024-08-16T14:16:58.389Z
+  cronString:
+    type: string
+    description: Cron expression defining the schedule for this action. Optional for repeated events.
+    example: "0 0 12 * * ?"
+  timeZoneId:
+    type: string
+    description: Time zone ID for interpreting the cron expression. Optional, will default to current time zone.
+    example: "America/Chicago"
+  content:
+    type: object
+    required:
+      - name
+    properties:
+      name:
+        type: string
+        description: Name of the scheduled action (maximum 50 characters).
+        maxLength: 50
+        example: Daily Backup
+      backupOptions:
+        type: object
+        description: Options for BACKUP type jobs. Required for BACKUP jobs.
+        properties:
+          includeTypes:
+            type: array
+            description: Object types that are to be included in the backup.
+            items:
+              type: string
+            example: ["ROLE", "IDENTITY_PROFILE"]
+          objectOptions:
+            type: object
+            description: Map of objectType string to the options to be passed to the target service for that objectType.
+            additionalProperties:
+              type: object
+              properties:
+                includedNames:
+                  type: array
+                  description: Set of names to be included.
+                  items:
+                    type: string
+                  example: ["Admin Role", "User Role"]
+            example: {
+              "SOURCE": {
+                "includedNames": ["Source1", "Source2"]
+              },
+              "ROLE": {
+                "includedNames": ["Admin Role", "User Role"]
+              }
+            }
+      sourceBackupId:
+        type: string
+        description: ID of the source backup. Required for CREATE_DRAFT jobs.
+        example: 5678b87d-48ca-439a-868f-2160001da8c2
+      sourceTenant:
+        type: string
+        description: Source tenant identifier. Required for CREATE_DRAFT jobs.
+        example: tenant-name
+      draftId:
+        type: string
+        description: ID of the draft to be deployed. Required for CONFIG_DEPLOY_DRAFT jobs.
+        example: 9012b87d-48ca-439a-868f-2160001da8c3

static/api-specs/idn/v2024/schemas/configuration-hub/ScheduledActionResponse.yaml

@@ -0,0 +1,83 @@
+type: object
+properties:
+  id:
+    type: string
+    description: Unique identifier for this scheduled action.
+    example: 3469b87d-48ca-439a-868f-2160001da8c1
+  created:
+    type: string
+    format: date-time
+    description: The time when this scheduled action was created.
+    example: 2021-05-11T22:23:16Z
+  jobType:
+    type: string
+    description: Type of the scheduled job.
+    enum:
+      - BACKUP
+      - CREATE_DRAFT
+      - CONFIG_DEPLOY_DRAFT
+    example: BACKUP
+  content:
+    type: object
+    description: Content details for the scheduled action.
+    properties:
+      name:
+        type: string
+        description: Name of the scheduled action (maximum 50 characters).
+        maxLength: 50
+        example: Daily Backup
+      backupOptions:
+        type: object
+        description: Options for BACKUP type jobs. Optional, applicable for BACKUP jobs only.
+        properties:
+          includeTypes:
+            type: array
+            description: Object types that are to be included in the backup.
+            items:
+              type: string
+            example: ["ROLE", "IDENTITY_PROFILE"]
+          objectOptions:
+            type: object
+            description: Map of objectType string to the options to be passed to the target service for that objectType.
+            additionalProperties:
+              type: object
+              properties:
+                includedNames:
+                  type: array
+                  description: Set of names to be included.
+                  items:
+                    type: string
+                  example: ["Admin Role", "User Role"]
+            example: {
+              "SOURCE": {
+                "includedNames": ["Source1", "Source2"]
+              },
+              "ROLE": {
+                "includedNames": ["Admin Role", "User Role"]
+              }
+            }
+      sourceBackupId:
+        type: string
+        description: ID of the source backup. Required for CREATE_DRAFT jobs only.
+        example: 5678b87d-48ca-439a-868f-2160001da8c2
+      sourceTenant:
+        type: string
+        description: Source tenant identifier. Required for CREATE_DRAFT jobs only.
+        example: tenant-name
+      draftId:
+        type: string
+        description: ID of the draft to be deployed. Required for CONFIG_DEPLOY_DRAFT jobs only.
+        example: 9012b87d-48ca-439a-868f-2160001da8c3
+  startTime:
+    type: string
+    format: date-time
+    description: The time when this scheduled action should start.
+    example: 2021-05-12T10:00:00Z
+  cronString:
+    type: string
+    description: Cron expression defining the schedule for this action.
+    example: "0 0 12 * * ?"
+  timeZoneId:
+    type: string
+    description: Time zone ID for interpreting the cron expression.
+    example: "America/Chicago"