LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-06 04:19:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Automated commit by github action: 5626063882

Browse Source
This commit is contained in:
GitHub Action Bot
2023-07-21 19:51:23 +00:00
parent 399e771344
commit 5e86b3e445
9 changed files with 34 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

0
static/api-specs/idn/beta/paths/forms-predefined-select-options.yaml → static/api-specs/idn/beta/paths/form-definitions-predefined-select-options.yaml
View File

10
static/api-specs/idn/beta/paths/sp-config-export-download.yaml
View File

@@ -1,14 +1,14 @@
get:
operationId: exportSpConfigDownload
operationId: getSpConfigExport
# security:
# - oauth2: [sp:config:export]
tags:
- SP-Config
summary: Download Result of Export Job
summary: Download export job result.
description: >-
This gets export file resulting from the export job with the requested id and downloads it to a file.
This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file.
Request will need one of the following security scopes:
The request will need one of the following security scopes:
- sp:config:read
- sp:config:manage
@@ -18,7 +18,7 @@ get:
schema:
type: string
required: true
description: The ID of the export job for which the results will be downloaded.
description: The ID of the export job whose results will be downloaded.
example: ef38f94347e94562b5bb8424a56397d8
responses:
'200':

10
static/api-specs/idn/beta/paths/sp-config-export-status.yaml
View File

@@ -1,14 +1,14 @@
get:
operationId: exportSpConfigJobStatus
operationId: getSpConfigExportStatus
# security:
# - oauth2: [sp:config:export]
tags:
- SP-Config
summary: Get Status of Export Job
summary: Get export job status
description: >-
This gets the status of the export job identified by the id parameter.
This gets the status of the export job identified by the `id` parameter.
Request will need one of the following security scopes:
The request will need one of the following security scopes:
- sp:config:read
- sp:config:manage
@@ -18,7 +18,7 @@ get:
schema:
type: string
required: true
description: The ID of the export job for which status will be returned.
description: The ID of the export job whose status will be returned.
example: ef38f94347e94562b5bb8424a56397d8
responses:
'200':

4
static/api-specs/idn/beta/paths/sp-config-export.yaml
View File

@@ -4,10 +4,12 @@ post:
- oauth2: [sp:config:read, sp:config:manage]
tags:
- SP-Config
summary: Initiates Configuration Objects Export Job.
summary: Initiates configuration objects export job
description: >-
This post will export objects from the tenant to a JSON configuration file.
For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
requestBody:
description: Export options control what will be included in the export.
required: true

10
static/api-specs/idn/beta/paths/sp-config-import-download.yaml
View File

@@ -1,16 +1,16 @@
get:
operationId: importSpConfigDownload
operationId: getSpConfigImport
# security:
# - oauth2: [sp:config:import]
tags:
- SP-Config
summary: Download Result of Import Job
summary: Download import job result
description: >-
This gets import file resulting from the import job with the requested id and downloads it to a file.
The downloaded file will contain the results of the import operation, including any error, warning or informational
messages associated with the import.
Request will need the following security scope:
The request will need the following security scope:
- sp:config:manage
parameters:
@@ -19,12 +19,12 @@ get:
schema:
type: string
required: true
description: The ID of the import job for which the results will be downloaded.
description: The ID of the import job whose results will be downloaded.
example: ef38f94347e94562b5bb8424a56397d8
responses:
'200':
description: >-
Import Results JSON object, containing detailed results of the import operation.
Import results JSON object, containing detailed results of the import operation.
content:
application/json:
schema:

12
static/api-specs/idn/beta/paths/sp-config-import-status.yaml
View File

@@ -1,14 +1,16 @@
get:
operationId: importSpConfigJobStatus
operationId: getSpConfigImportStatus
# security:
# - oauth2: [sp:config:import]
tags:
- SP-Config
summary: Get Status of Import Job
summary: Get import job status
description: >-
This gets the status of the import job identified by the id parameter.
This gets the status of the import job identified by the `id` parameter.
Request will need the following security scope:
For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
The request will need the following security scope:
- sp:config:manage
parameters:
@@ -17,7 +19,7 @@ get:
schema:
type: string
required: true
description: The ID of the import job for which status will be returned.
description: The ID of the import job whose status will be returned.
example: ef38f94347e94562b5bb8424a56397d8
responses:
'200':

10
static/api-specs/idn/beta/paths/sp-config-import.yaml
View File

@@ -4,7 +4,7 @@ post:
# - oauth2: [sp:config:import]
tags:
- SP-Config
summary: Initiates Configuration Objects Import Job.
summary: Initiates configuration objects import job
description: >-
This post will import objects from a JSON configuration file into a tenant.
By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted.
@@ -15,7 +15,9 @@ post:
You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data.
Request will need the following security scope:
For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
The request will need the following security scope:
- sp:config:manage
parameters:
@@ -27,8 +29,8 @@ post:
required: false
description: >-
This option is intended to give the user information about how an import operation would proceed, without
having any affect on the target tenant.
If true, no objects will be imported. Instead, the import process will pre-process the import file and
having any effect on the target tenant.
If this parameter is "true", no objects will be imported. Instead, the import process will pre-process the import file and
attempt to resolve references within imported objects. The import result file will contain messages
pertaining to how specific references were resolved, any errors associated with the preprocessing,
and messages indicating which objects would be imported.

2
static/api-specs/idn/beta/paths/sp-config-objects.yaml
View File

@@ -4,7 +4,7 @@ get:
- oauth2: [sp:config:read, sp:config:manage]
tags:
- SP-Config
summary: Get Config Object details
summary: Get config object details
description: >-
This gets the list of object configurations which are known to the tenant export/import service.
Object configurations that contain "importUrl" and "exportUrl" are available for export/import.

4
static/api-specs/idn/sailpoint-api.beta.yaml
View File

@@ -1457,5 +1457,5 @@ paths:
$ref: './beta/paths/form-instance.yaml'
/form-instances/{formInstanceID}/data-source/{formElementID}:
$ref: './beta/paths/form-instance-data-source.yaml'
/predefined-select-options:
$ref: './beta/paths/forms-predefined-select-options.yaml'
/form-definitions/predefined-select-options:
$ref: './beta/paths/form-definitions-predefined-select-options.yaml'