From 67fa4ec3f95c719543b7acf1a5c9d2483dca1903 Mon Sep 17 00:00:00 2001 From: "james.haytko" Date: Fri, 5 May 2023 10:00:37 -0500 Subject: [PATCH 1/3] Added backup info, links. --- .../docs/identity-now/saas-configuration.mdx | 41 +++++++++++++++---- 1 file changed, 34 insertions(+), 7 deletions(-) diff --git a/products/idn/docs/identity-now/saas-configuration.mdx b/products/idn/docs/identity-now/saas-configuration.mdx index e9c6199bd..5d75b5049 100644 --- a/products/idn/docs/identity-now/saas-configuration.mdx +++ b/products/idn/docs/identity-now/saas-configuration.mdx @@ -77,6 +77,7 @@ The available supported objects are also available via REST API! See List Config 5. **Get Import Results** - Once the status is `COMPLETE`, download the import results by calling `GET /beta/sp-config/import/{id}/download` where the `{id}` is the `jobId`. 6. **Response with Import Results** - In response, the import process should produce listing of object that successfully imported, as well as any errors, warnings, or information about the import process. This result set will reflect the objects that were selected to be imported earlier. + ## API Reference Guide | **Description** | **REST API Endpoint** | @@ -93,7 +94,8 @@ The available supported objects are also available via REST API! See List Config **Description** -Lists all available objects that can be imported and exported into the system. +[This endpoint](https://developer.sailpoint.com/idn/api/beta/list-sp-config-objects) gets the list of object configurations known to the tenant export/import service. +Object configurations containing "importUrl" and "exportUrl" are available for export/import. @@ -197,7 +199,7 @@ Content-Type: application/json **Description** -Starts an export process to export selected objects from the system. +[This endpoint](https://developer.sailpoint.com/idn/api/beta/export-sp-config) exports selected objects from the tenant to a JSON configuration file. @@ -273,7 +275,11 @@ Content-Type: application/json **Description** -Gets the status of an export process. +[This endpoint](https://developer.sailpoint.com/idn/api/beta/export-sp-config-job-status) gets the status of the export job identified by its `id` parameter. + +This request requires one of the following security scopes: + +- `sp:config:read` - `sp:config:manage` @@ -310,7 +316,11 @@ Content-Type: application/json **Description** -Gets the results of an export process. +[This endpoint](https://developer.sailpoint.com/idn/api/beta/export-sp-config-download) gets the export job's resulting export file by using the requested `id` and downloads it to a file. + +This request requires one of the following security scopes: + +- `sp:config:read` - `sp:config:manage` @@ -470,7 +480,15 @@ Content-Type: application/json **Description** -Starts an import process to import selected objects into the system. +[This post(https://developer.sailpoint.com/idn/api/beta/import-sp-config)] imports objects from a JSON configuration file into a tenant. +By default, every import job first exports all existing objects supported by sp-config as a backup before attempting the import. +The import job provides a backup so the configuration's import status is available for inspection or restore if needed. +You can skip the backup by setting `excludeBackup` to `true` in the import options. +If a backup occurs, the ImportResult provides the backup's ID as the `exportJobId`. + +This request requires the following security scope: + +- sp:config:manage @@ -518,7 +536,11 @@ Example: POST /beta/sp-config/import?preview=true **Description** -Gets the status of an import process. +[This endpoint](https://developer.sailpoint.com/idn/api/beta/import-sp-config-job-status) gets the status of the import job identified by its `id` parameter. + +This request requires the following security scope: + +- `sp:config:manage` @@ -555,7 +577,12 @@ Content-Type: application/json **Description** -Gets the results of an import process. +[This endpoint](https://developer.sailpoint.com/idn/api/beta/import-sp-config-download) gets the import job's resulting import file by using the requested `id` and downloads the file. +The downloaded file will contain the import job's results, including any associated error, warning or informational messages. + +This request requires the following security scope: + +- `sp:config:manage` From b46b3089f00218e92cad19c4b793dec56d8697da Mon Sep 17 00:00:00 2001 From: "james.haytko" Date: Fri, 5 May 2023 10:02:13 -0500 Subject: [PATCH 2/3] Typo --- products/idn/docs/identity-now/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/products/idn/docs/identity-now/index.mdx b/products/idn/docs/identity-now/index.mdx index 057c9c926..1f5b2e4c2 100644 --- a/products/idn/docs/identity-now/index.mdx +++ b/products/idn/docs/identity-now/index.mdx @@ -24,7 +24,7 @@ tags: ['Introduction', 'Getting Started'] import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -🧭 There are many different ways in which you are able to extend the IdentityNow platfrom beyond what comes out of the box. Please, explore our documentation and see what is possible! This documentation assumes that you are a current customer or partner and already have access to the IdentityNow application. +🧭 There are many different ways in which you are able to extend the IdentityNow platform beyond what comes out of the box. Please, explore our documentation and see what is possible! This documentation assumes that you are a current customer or partner and already have access to the IdentityNow application. :::info Are you a partner? From 86996cee461756ae074cf94246421f6dae5d129f Mon Sep 17 00:00:00 2001 From: "james.haytko" Date: Fri, 5 May 2023 10:06:09 -0500 Subject: [PATCH 3/3] Fixed bracket --- products/idn/docs/identity-now/saas-configuration.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/products/idn/docs/identity-now/saas-configuration.mdx b/products/idn/docs/identity-now/saas-configuration.mdx index 5d75b5049..79a3a4453 100644 --- a/products/idn/docs/identity-now/saas-configuration.mdx +++ b/products/idn/docs/identity-now/saas-configuration.mdx @@ -480,7 +480,7 @@ Content-Type: application/json **Description** -[This post(https://developer.sailpoint.com/idn/api/beta/import-sp-config)] imports objects from a JSON configuration file into a tenant. +[This endpoint](https://developer.sailpoint.com/idn/api/beta/import-sp-config) imports objects from a JSON configuration file into a tenant. By default, every import job first exports all existing objects supported by sp-config as a backup before attempting the import. The import job provides a backup so the configuration's import status is available for inspection or restore if needed. You can skip the backup by setting `excludeBackup` to `true` in the import options.