Automated commit by github action: 10930420404

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

@@ -1334,6 +1334,10 @@ paths:
     $ref: ./v3/paths/configuration-hub/backup-uploads.yaml
   /configuration-hub/backups/uploads/{id}:
     $ref: ./v3/paths/configuration-hub/backup-uploads-id.yaml
+  /configuration-hub/backups:
+    $ref: ./v2024/paths/configuration-hub/backup.yaml
+  /configuration-hub/backups/{id}:
+    $ref: ./v2024/paths/configuration-hub/backup-id.yaml
   /configuration-hub/drafts:
     $ref: ./v2024/paths/configuration-hub/draft.yaml
   /configuration-hub/drafts/{id}:

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

@@ -0,0 +1,38 @@
+delete:
+  operationId: deleteBackup
+  security:
+    - UserContextAuth: [sp:config-backup:manage]
+  tags:
+    - Configuration Hub
+  summary: Delete a Backup
+  description: >-
+    This API deletes an existing backup for the current tenant.
+
+
+    On success, this endpoint will return an empty response.
+
+
+    The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint.
+  parameters:
+    - in: path
+      name: id
+      schema:
+        type: string
+      required: true
+      description: The id of the backup to delete.
+      example: 07659d7d-2cce-47c0-9e49-185787ee565a
+  responses:
+    '204':
+      $ref: '../../../v3/responses/204.yaml'
+    '400':
+      $ref: '../../../v3/responses/400.yaml'
+    '401':
+      $ref: '../../../v3/responses/401.yaml'
+    '403':
+      $ref: '../../../v3/responses/403.yaml'
+    '404':
+      $ref: '../../../v3/responses/404.yaml'
+    '429':
+      $ref: '../../../v3/responses/429.yaml'
+    '500':
+      $ref: '../../../v3/responses/500.yaml'

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

@@ -0,0 +1,77 @@
+get:
+  operationId: listBackups
+  security:
+    - UserContextAuth: [sp:config-backup:read, sp:config-backup:manage]
+  tags:
+    - Configuration Hub
+  summary: List Backups
+  description: >-
+    This API gets a list of existing backups for the current tenant.
+  parameters:
+    - in: query
+      name: filters
+      schema:
+        type: string
+      description: >-
+        Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
+        Filtering is supported for the following fields and operators:
+        
+        
+        **status**: *eq*
+      example: status eq "COMPLETE"
+      required: false
+  responses:
+    '200':
+      description: >-
+        List of existing backups.
+      content:
+        application/json:
+          schema:
+            type: array
+            items:
+              $ref: '../../schemas/configuration-hub/BackupResponse.yaml'
+          example:
+            [
+              {
+                "jobId": "09491993-9cb6-49a7-8d37-8bef54d33502",
+                "status": "COMPLETE",
+                "type": "BACKUP",
+                "tenant": "tenant-name",
+                "requesterName": "Requester Name",
+                "fileExists": true,
+                "created": "2024-02-19T19:54:15.373Z",
+                "modified": "2024-02-19T20:39:00.341Z",
+                "completed": "2024-02-19T19:54:15.605Z",
+                "name": "Backup name",
+                "userCanDelete": false,
+                "isPartial": true,
+                "backupType": "MANUAL",
+                "options": {
+                  "includeTypes": [
+                    "SOURCE"
+                  ],
+                  "objectOptions": {
+                    "SOURCE": {
+                      "includedNames": [
+                        "Source Name"
+                      ]
+                    }
+                  }
+                },
+                "hydrationStatus": "HYDRATED",
+                "totalObjectCount": 2,
+                "cloudStorageStatus": "SYNCED"
+              }
+            ]
+    '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'

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

@@ -0,0 +1,45 @@
+type: object
+nullable: true
+description: Backup options control what will be included in the backup.
+properties:
+  includeTypes:
+    type: array
+    description: Object type names to be included in a Configuration Hub backup command.
+    items:
+      type: string
+      enum:
+        - ACCESS_PROFILE
+        - ACCESS_REQUEST_CONFIG
+        - ATTR_SYNC_SOURCE_CONFIG
+        - AUTH_ORG
+        - CAMPAIGN_FILTER
+        - FORM_DEFINITION
+        - GOVERNANCE_GROUP
+        - IDENTITY_OBJECT_CONFIG
+        - IDENTITY_PROFILE
+        - LIFECYCLE_STATE
+        - NOTIFICATION_TEMPLATE
+        - PASSWORD_POLICY
+        - PASSWORD_SYNC_GROUP
+        - PUBLIC_IDENTITIES_CONFIG
+        - ROLE
+        - RULE
+        - SEGMENT
+        - SERVICE_DESK_INTEGRATION
+        - SOD_POLICY
+        - SOURCE
+        - TAG
+        - TRANSFORM
+        - TRIGGER_SUBSCRIPTION
+        - WORKFLOW
+      example: TRIGGER_SUBSCRIPTION
+  objectOptions:
+    description: Additional options targeting specific objects related to each item in the includeTypes field.
+    type: object
+    additionalProperties:
+      $ref: './ObjectExportImportNames.yaml'
+    example: {
+      "TRIGGER_SUBSCRIPTION": {
+        "includedNames": ["Trigger Subscription name"]
+      }
+    }

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

@@ -0,0 +1,103 @@
+type: object
+properties:
+  jobId:
+    type: string
+    description: Unique id assigned to this backup.
+    example: 3469b87d-48ca-439a-868f-2160001da8c1
+  status:
+    type: string
+    description: Status of the backup.
+    enum:
+      - NOT_STARTED
+      - IN_PROGRESS
+      - COMPLETE
+      - CANCELLED
+      - FAILED
+    example: COMPLETE
+  type:
+    type: string
+    description: Type of the job, will always be BACKUP for this type of job.
+    enum:
+      - BACKUP
+    example: BACKUP
+  tenant:
+    type: string
+    description: The name of the tenant performing the upload
+    example: tenant-name
+  requesterName:
+    type: string
+    description: The name of the requester.
+    example: Requester Name
+  fileExists:
+    type: boolean
+    default: true
+    description: Whether or not a file was created and stored for this backup.
+    example: true
+  created:
+    type: string
+    format: date-time
+    description: The time the job was started.
+    example: 2021-05-11T22:23:16Z
+  modified:
+    type: string
+    format: date-time
+    description: The time of the last update to the job.
+    example: 2021-05-11T22:23:16Z
+  completed:
+    type: string
+    format: date-time
+    description: The time the job was completed.
+    example: 2021-05-11T22:23:16Z
+  name:
+    type: string
+    description: The name assigned to the upload file in the request body.
+    example: Backup Name
+  userCanDelete:
+    type: boolean
+    default: true
+    description: Whether this backup can be deleted by a regular user.
+    example: false
+  isPartial:
+    type: boolean
+    default: false
+    description: Whether this backup contains all supported object types or only some of them.
+    example: false
+  backupType:
+    type: string
+    description: >-
+      Denotes how this backup was created.
+      
+      - MANUAL - The backup was created by a user.
+      
+      - AUTOMATED - The backup was created by devops.
+      
+      - AUTOMATED_DRAFT - The backup was created during a draft process.
+      
+      - UPLOADED - The backup was created by uploading an existing configuration file.
+    enum:
+      - UPLOADED
+      - AUTOMATED
+      - MANUAL
+    example: MANUAL
+  options:
+    $ref: './BackupOptions.yaml'
+  hydrationStatus:
+    type: string
+    description: Whether the object details of this backup are ready.
+    enum:
+      - HYDRATED
+      - NOT_HYDRATED
+    example: NOT_HYDRATED
+  totalObjectCount:
+    type: integer
+    format: int64
+    description: Number of objects contained in this backup.
+    example: 10
+  cloudStorageStatus:
+    type: string
+    description: Whether this backup has been transferred to a customer storage location.
+    enum:
+      - SYNCED
+      - NOT_SYNCED
+      - SYNC_FAILED
+    example: SYNCED

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

@@ -0,0 +1,8 @@
+type: object
+properties:
+  includedNames:
+    description: Object names to be included in a backup.
+    type: array
+    items:
+      type: string
+      example: "Test Object name"