SP-Config Import

Identity Security Cloud (ISC) ISC Discussion and Questions
1

To make sure I understand the process correctly, we need to download the json from the export/download operation and manually modify the file based on values in the new environment, is that correct? Manual modification of a file introduces human error which is what this process is designed to help us avoid. Can you confirm if I am missing a step here? Thanks for your help!

2

Hello justinrhaines,

You are correct that you will have to manually modify any information that will change between environments.

Below is the process to follow when exporting/importing configurations:

Exporting Configurations

Prerequisites

  • Need to have credentials as a tenant administrator ( ORG_ADMIN )
  • Understanding of what objects you’d like to export
  1. Start Export - Start the export process by configuring a JSON payload for the export options. This should then be sent to POST /beta/sp-config/export .
  2. Response with Export Status - An export status will given in response. This contains a jobId and a status which should be used to subsequently monitor the process. Initially this might have a status of NOT_STARTED .
  3. Get Export Status - Using the jobId from the previous status, call GET /beta/sp-config/export/{id} where the {id} is the jobId .
  4. Response with Export Status - An export status will given in response. This contains a jobId and a status which should be used to subsequently monitor the process. After a period of time, the process status should move to either COMPLETE or FAILED . Depending on the amount of objects being exported, this could take awhile. It might be necessary to iterate over steps 3 and 4 until the status reflects a completion. If it takes too long, the export process may expire.
  5. Get Export Results - Once the status is COMPLETE , download the export results by calling GET /beta/sp-config/export/{id}/download where the {id} is the jobId .
  6. Response with Export Results - In response, the export process should produce a set of JSON objects which you can download as an export result set. These should reflect the objects that were selected in the export options earlier.

Importing Configurations

Prerequisites

  • Need to have credentials as a tenant administrator ( ORG_ADMIN )
  • Prepare any objects to be imported into the system, as well as import options.
  1. Start Import - Start the import process by configuring a JSON payload for the import options. This should then be sent to POST /beta/sp-config/import .
  2. Response with Import Status - An import status will given in response. This contains a jobId and a status which should be used to subsequently monitor the process. Initially this might have a status of NOT_STARTED .
  3. Get Import Status - Using the jobId from the previous status, call GET /beta/sp-config/import/{id} where the {id} is the jobId .
  4. Response with Import Status - An import status will given in response. This contains a jobId and a status which should be used to subsequently monitor the process. After a period of time, the process status should move to either COMPLETE or FAILED . Depending on the amount of objects being imported, this could take awhile. It might be necessary to iterate over steps 3 and 4 until the status reflects a completion. If it takes too long, the import process may expire.
  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 should reflect the objects that were selected to be imported earlier.

Note : Import also has a “preview” option if you would like to see what an import might look like without actually having to import and change your tenant. Any errors discovered during reference or resource resolution will be provided. To use this, simply set query option preview to true .

Example: POST /beta/sp-config/import?preview=true

2 Likes
3

This information can also be found in our docs at SaaS Configuration | SailPoint Developer Community.

4

Do we need to clean ID’s from exported json file ?.

5

Hi All,

Even i have same question on the id’s which are generated by IDN in the tenant.
Do we have to remove the id’s before import.

6

You should not need to remove the IDs. They should be ignored by the import operation.

7

Thnak You Colin that clarifies my doubt on the “id’s”.
When I was going through the sources one thing I was not able to find was account aggregation configurations. So, when the sources are exported will I not get the account aggregation configurations also which are configured via UI.

If yes how can I get them. Can you let me know.

8

Which account aggregation configurations are you referring to?

9

image
image1587Ă—271 10.9 KB

I meant this configured settings in the source.

10

Yes, that’s missing in the source API and I don’t think that will be carried over via SP config. The UI is using some private APIs to configure the schedule, so I’ll have to talk to product to see if they are able to bring that into the v3 sources API.

11

Oh got it. Can you help us in adding it because we have like 900+ sources to import and configuring just the account aggregation for all the imported sources via UI will be a tuff task.
Thank You