LukeParke/developer.sailpoint.com

Fork 0

mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-07 12:27:47 +00:00

Files

developer-relations-sp bdb088c15d Update to powershell SDK docs: 13122455471

2025-02-03 20:42:04 +00:00

20 KiB

Raw Blame History

id: v2024-sp-config title: SPConfig pagination_label: SPConfig sidebar_label: SPConfig sidebar_class_name: powershellsdk keywords: ['powershell', 'PowerShell', 'sdk', 'SPConfig', 'V2024SPConfig'] slug: /tools/sdk/powershell/v2024/methods/sp-config tags: ['SDK', 'Software Development Kit', 'SPConfig', 'V2024SPConfig']

SPConfig

Import and export configuration for some objects between tenants.

All URIs are relative to https://sailpoint.api.identitynow.com/v2024

Method	HTTP request	Description
Export-V2024SpConfig	POST `/sp-config/export`	Initiates configuration objects export job
Get-V2024SpConfigExport	GET `/sp-config/export/{id}/download`	Download export job result.
Get-V2024SpConfigExportStatus	GET `/sp-config/export/{id}`	Get export job status
Get-V2024SpConfigImport	GET `/sp-config/import/{id}/download`	Download import job result
Get-V2024SpConfigImportStatus	GET `/sp-config/import/{id}`	Get import job status
Import-V2024SpConfig	POST `/sp-config/import`	Initiates configuration objects import job
Get-V2024SpConfigObjects	GET `/sp-config/config-objects`	Get config object details

export-sp-config

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.

Parameters

Param Type	Name	Data Type	Required	Description
XSailPointExperimental	String	True (default to "true")	Use this header to enable this experimental API.
Body	ExportPayload	ExportPayload	True	Export options control what will be included in the export.

Return type

SpConfigExportJob

Responses

Code	Description	Data Type
202	Export job accepted and queued for processing.	SpConfigExportJob
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: application/json
Accept: application/json

Example

$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$ExportPayload = @"{
  "description" : "Export Job 1 Test"
}"@

# Initiates configuration objects export job

try {
    $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload
    Export-V2024SpConfig-V2024XSailPointExperimental $XSailPointExperimental -V2024ExportPayload $Result
    
    # Below is a request that includes all optional parameters
    # Export-V2024SpConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024ExportPayload $ExportPayload  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024SpConfig"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-sp-config-export

This endpoint gets the export file resulting from the export job with the requested id and downloads it to a file. The request will need one of the following security scopes:

sp:config:read - sp:config:manage

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	The ID of the export job whose results will be downloaded.
XSailPointExperimental	String	True (default to "true")	Use this header to enable this experimental API.

Return type

SpConfigExportResults

Responses

Code	Description	Data Type
200	Exported JSON objects.	SpConfigExportResults
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")

# Download export job result.

try {
    Get-V2024SpConfigExport-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
    # Get-V2024SpConfigExport -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExport"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-sp-config-export-status

This gets the status of the export job identified by the id parameter. The request will need one of the following security scopes:

sp:config:read - sp:config:manage

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	The ID of the export job whose status will be returned.
XSailPointExperimental	String	True (default to "true")	Use this header to enable this experimental API.

Return type

SpConfigExportJobStatus

Responses

Code	Description	Data Type
200	Export job status successfully returned.	SpConfigExportJobStatus
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")

# Get export job status

try {
    Get-V2024SpConfigExportStatus-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
    # Get-V2024SpConfigExportStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExportStatus"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-sp-config-import

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. The request will need the following security scope:

sp:config:manage

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	The ID of the import job whose results will be downloaded.
XSailPointExperimental	String	True (default to "true")	Use this header to enable this experimental API.

Return type

SpConfigImportResults

Responses

Code	Description	Data Type
200	Import results JSON object, containing detailed results of the import operation.	SpConfigImportResults
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")

# Download import job result

try {
    Get-V2024SpConfigImport-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
    # Get-V2024SpConfigImport -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImport"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-sp-config-import-status

'This gets the status of the import job identified by the id parameter.

For more information about the object types that currently support import functionality, refer to SaaS Configuration.'

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	The ID of the import job whose status will be returned.
XSailPointExperimental	String	True (default to "true")	Use this header to enable this experimental API.

Return type

SpConfigImportJobStatus

Responses

Code	Description	Data Type
200	Import job status successfully returned.	SpConfigImportJobStatus
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")

# Get import job status

try {
    Get-V2024SpConfigImportStatus-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
    # Get-V2024SpConfigImportStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImportStatus"
    Write-Host $_.ErrorDetails
}

[Back to top]

import-sp-config

"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. The backup is provided
\ so that the state of the configuration prior to the import is available for
\ inspection or restore if needed. The backup can be skipped by setting "excludeBackup"
\ to true in the import options. If a backup is performed, the id of the backup
\ will be provided in the ImportResult as the "exportJobId". This can be downloaded
\ using the /sp-config/export/{exportJobId}/download endpoint.\nYou cannot currently
\ import from the Non-Employee Lifecycle Management (NELM) source. You cannot
\ use this endpoint to back up or store NELM data. \nFor more information about
\ the object types that currently support import functionality, refer to SaaS
\ Configuration."

Parameters

Param Type	Name	Data Type	Required	Description
XSailPointExperimental	String	True (default to "true")	Use this header to enable this experimental API.
Data	System.IO.FileInfo	True	JSON file containing the objects to be imported.
Query	Preview	Boolean	(optional) (default to $false)	This option is intended to give the user information about how an import operation would proceed, without 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.
Options	ImportOptions	(optional)

Return type

SpConfigJob

Responses

Code	Description	Data Type
202	Import job accepted and queued for processing.	SpConfigJob
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

Example

$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Data =  # System.IO.FileInfo | JSON file containing the objects to be imported.
$Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without 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.  (optional) (default to $false)
$Options = @""@

# Initiates configuration objects import job

try {
    Import-V2024SpConfig-V2024XSailPointExperimental $XSailPointExperimental -V2024Data $Data 
    
    # Below is a request that includes all optional parameters
    # Import-V2024SpConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024Data $Data -V2024Preview $Preview -V2024Options $Options  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024SpConfig"
    Write-Host $_.ErrorDetails
}

[Back to top]

list-sp-config-objects

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.

Parameters

Param Type	Name	Data Type	Required	Description
XSailPointExperimental	String	True (default to "true")	Use this header to enable this experimental API.

Return type

SpConfigObject[]

Responses

Code	Description	Data Type
200	Object configurations returned successfully.	SpConfigObject[]
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")

# Get config object details

try {
    Get-V2024SpConfigObjects-V2024XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
    # Get-V2024SpConfigObjects -V2024XSailPointExperimental $XSailPointExperimental  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigObjects"
    Write-Host $_.ErrorDetails
}

[Back to top]

20 KiB Raw Blame History

SPConfig

export-sp-config

Parameters

Return type

Responses

HTTP request headers

Example

get-sp-config-export

Parameters

Return type

Responses

HTTP request headers

Example

get-sp-config-export-status

Parameters

Return type

Responses

HTTP request headers

Example

get-sp-config-import

Parameters

Return type

Responses

HTTP request headers

Example

get-sp-config-import-status

Parameters

Return type

Responses

HTTP request headers

Example

import-sp-config

Parameters

Return type

Responses

HTTP request headers

Example

list-sp-config-objects

Parameters

Return type

Responses

HTTP request headers

Example

20 KiB

Raw Blame History