mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-06 04:19:31 +00:00
Automated commit by github action: 5626063882
This commit is contained in:
@@ -1,14 +1,14 @@
|
|||||||
get:
|
get:
|
||||||
operationId: exportSpConfigDownload
|
operationId: getSpConfigExport
|
||||||
# security:
|
# security:
|
||||||
# - oauth2: [sp:config:export]
|
# - oauth2: [sp:config:export]
|
||||||
tags:
|
tags:
|
||||||
- SP-Config
|
- SP-Config
|
||||||
summary: Download Result of Export Job
|
summary: Download export job result.
|
||||||
description: >-
|
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:read
|
||||||
- sp:config:manage
|
- sp:config:manage
|
||||||
@@ -18,7 +18,7 @@ get:
|
|||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
required: true
|
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
|
example: ef38f94347e94562b5bb8424a56397d8
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
|
|||||||
@@ -1,14 +1,14 @@
|
|||||||
get:
|
get:
|
||||||
operationId: exportSpConfigJobStatus
|
operationId: getSpConfigExportStatus
|
||||||
# security:
|
# security:
|
||||||
# - oauth2: [sp:config:export]
|
# - oauth2: [sp:config:export]
|
||||||
tags:
|
tags:
|
||||||
- SP-Config
|
- SP-Config
|
||||||
summary: Get Status of Export Job
|
summary: Get export job status
|
||||||
description: >-
|
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:read
|
||||||
- sp:config:manage
|
- sp:config:manage
|
||||||
@@ -18,7 +18,7 @@ get:
|
|||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
required: true
|
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
|
example: ef38f94347e94562b5bb8424a56397d8
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
|
|||||||
@@ -4,10 +4,12 @@ post:
|
|||||||
- oauth2: [sp:config:read, sp:config:manage]
|
- oauth2: [sp:config:read, sp:config:manage]
|
||||||
tags:
|
tags:
|
||||||
- SP-Config
|
- SP-Config
|
||||||
summary: Initiates Configuration Objects Export Job.
|
summary: Initiates configuration objects export job
|
||||||
description: >-
|
description: >-
|
||||||
This post will export objects from the tenant to a JSON configuration file.
|
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:
|
requestBody:
|
||||||
description: Export options control what will be included in the export.
|
description: Export options control what will be included in the export.
|
||||||
required: true
|
required: true
|
||||||
|
|||||||
@@ -1,16 +1,16 @@
|
|||||||
get:
|
get:
|
||||||
operationId: importSpConfigDownload
|
operationId: getSpConfigImport
|
||||||
# security:
|
# security:
|
||||||
# - oauth2: [sp:config:import]
|
# - oauth2: [sp:config:import]
|
||||||
tags:
|
tags:
|
||||||
- SP-Config
|
- SP-Config
|
||||||
summary: Download Result of Import Job
|
summary: Download import job result
|
||||||
description: >-
|
description: >-
|
||||||
This gets import file resulting from the import job with the requested id and downloads it to a file.
|
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
|
The downloaded file will contain the results of the import operation, including any error, warning or informational
|
||||||
messages associated with the import.
|
messages associated with the import.
|
||||||
|
|
||||||
Request will need the following security scope:
|
The request will need the following security scope:
|
||||||
|
|
||||||
- sp:config:manage
|
- sp:config:manage
|
||||||
parameters:
|
parameters:
|
||||||
@@ -19,12 +19,12 @@ get:
|
|||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
required: true
|
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
|
example: ef38f94347e94562b5bb8424a56397d8
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
description: >-
|
description: >-
|
||||||
Import Results JSON object, containing detailed results of the import operation.
|
Import results JSON object, containing detailed results of the import operation.
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
|
|||||||
@@ -1,14 +1,16 @@
|
|||||||
get:
|
get:
|
||||||
operationId: importSpConfigJobStatus
|
operationId: getSpConfigImportStatus
|
||||||
# security:
|
# security:
|
||||||
# - oauth2: [sp:config:import]
|
# - oauth2: [sp:config:import]
|
||||||
tags:
|
tags:
|
||||||
- SP-Config
|
- SP-Config
|
||||||
summary: Get Status of Import Job
|
summary: Get import job status
|
||||||
description: >-
|
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
|
- sp:config:manage
|
||||||
parameters:
|
parameters:
|
||||||
@@ -17,7 +19,7 @@ get:
|
|||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
required: true
|
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
|
example: ef38f94347e94562b5bb8424a56397d8
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ post:
|
|||||||
# - oauth2: [sp:config:import]
|
# - oauth2: [sp:config:import]
|
||||||
tags:
|
tags:
|
||||||
- SP-Config
|
- SP-Config
|
||||||
summary: Initiates Configuration Objects Import Job.
|
summary: Initiates configuration objects import job
|
||||||
description: >-
|
description: >-
|
||||||
This post will import objects from a JSON configuration file into a tenant.
|
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.
|
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.
|
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
|
- sp:config:manage
|
||||||
parameters:
|
parameters:
|
||||||
@@ -27,8 +29,8 @@ post:
|
|||||||
required: false
|
required: false
|
||||||
description: >-
|
description: >-
|
||||||
This option is intended to give the user information about how an import operation would proceed, without
|
This option is intended to give the user information about how an import operation would proceed, without
|
||||||
having any affect on the target tenant.
|
having any effect on the target tenant.
|
||||||
If true, no objects will be imported. Instead, the import process will pre-process the import file and
|
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
|
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,
|
pertaining to how specific references were resolved, any errors associated with the preprocessing,
|
||||||
and messages indicating which objects would be imported.
|
and messages indicating which objects would be imported.
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ get:
|
|||||||
- oauth2: [sp:config:read, sp:config:manage]
|
- oauth2: [sp:config:read, sp:config:manage]
|
||||||
tags:
|
tags:
|
||||||
- SP-Config
|
- SP-Config
|
||||||
summary: Get Config Object details
|
summary: Get config object details
|
||||||
description: >-
|
description: >-
|
||||||
This gets the list of object configurations which are known to the tenant export/import service.
|
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.
|
Object configurations that contain "importUrl" and "exportUrl" are available for export/import.
|
||||||
|
|||||||
@@ -1457,5 +1457,5 @@ paths:
|
|||||||
$ref: './beta/paths/form-instance.yaml'
|
$ref: './beta/paths/form-instance.yaml'
|
||||||
/form-instances/{formInstanceID}/data-source/{formElementID}:
|
/form-instances/{formInstanceID}/data-source/{formElementID}:
|
||||||
$ref: './beta/paths/form-instance-data-source.yaml'
|
$ref: './beta/paths/form-instance-data-source.yaml'
|
||||||
/predefined-select-options:
|
/form-definitions/predefined-select-options:
|
||||||
$ref: './beta/paths/forms-predefined-select-options.yaml'
|
$ref: './beta/paths/form-definitions-predefined-select-options.yaml'
|
||||||
|
|||||||
Reference in New Issue
Block a user