PSSailpointBeta.PSSailpointBeta/Api.BetaSPConfigApi

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

Method	HTTP request	Description
Export-BetaSpConfig	POST /sp-config/export	Initiates Configuration Objects Export Job.
Export-BetaSpConfigDownload	GET /sp-config/export/{id}/download	Download Result of Export Job
Export-BetaSpConfigJobStatus	GET /sp-config/export/{id}	Get Status of Export Job
Import-BetaSpConfig	POST /sp-config/import	Initiates Configuration Objects Import Job.
Import-BetaSpConfigDownload	GET /sp-config/import/{id}/download	Download Result of Import Job
Import-BetaSpConfigJobStatus	GET /sp-config/import/{id}	Get Status of Import Job
Get-BetaSpConfigObjects	GET /sp-config/config-objects	Get Config Object details

Export-BetaSpConfig

SpConfigJob Export-BetaSpConfig
[-ExportPayload]

Initiates Configuration Objects Export Job.

This post will export objects from the tenant to a JSON configuration file. Request will need one of the following security scopes: - sp:config:read - sp:config:manage

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-Configuration
# Configure OAuth2 access token for authorization: oauth2
$Configuration.AccessToken = "YOUR_ACCESS_TOKEN"

# Configure OAuth2 access token for authorization: oauth2
$Configuration.AccessToken = "YOUR_ACCESS_TOKEN"

"SOURCE""SOURCE"
$ObjectExportImportOptions = Initialize-ObjectExportImportOptions -IncludedIds "be9e116d-08e1-49fc-ab7f-fa585e96c9e4" -IncludedNames "Test Object"
$ExportPayload = Initialize-ExportPayload -Description "Export Job 1 Test" -ExcludeTypes "SOURCE" -IncludeTypes "SOURCE""SOURCE" -ObjectOptions @{ key_example = $ObjectExportImportOptions } # ExportPayload | Export options control what will be included in the export.

# Initiates Configuration Objects Export Job.
try {
    $Result = Export-BetaSpConfig -ExportPayload $ExportPayload
} catch {
    Write-Host ("Exception occurred when calling Export-BetaSpConfig: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
ExportPayload	ExportPayload	Export options control what will be included in the export.

Return type

SpConfigJob (PSCustomObject)

Authorization

oauth2, oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Export-BetaSpConfigDownload

SpConfigExportResults Export-BetaSpConfigDownload
[-Id]

Download Result of Export Job

This gets 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: - sp:config:read - sp:config:manage

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-Configuration
# Configure OAuth2 access token for authorization: oauth2
$Configuration.AccessToken = "YOUR_ACCESS_TOKEN"

# Configure OAuth2 access token for authorization: oauth2
$Configuration.AccessToken = "YOUR_ACCESS_TOKEN"

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job for which the results will be downloaded.

# Download Result of Export Job
try {
    $Result = Export-BetaSpConfigDownload -Id $Id
} catch {
    Write-Host ("Exception occurred when calling Export-BetaSpConfigDownload: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
Id	String	The ID of the export job for which the results will be downloaded.

Return type

SpConfigExportResults (PSCustomObject)

Authorization

oauth2, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Export-BetaSpConfigJobStatus

SpConfigJob Export-BetaSpConfigJobStatus
[-Id]

Get Status of Export Job

This gets the status of the export job identified by the id parameter. Request will need one of the following security scopes: - sp:config:read - sp:config:manage

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-Configuration
# Configure OAuth2 access token for authorization: oauth2
$Configuration.AccessToken = "YOUR_ACCESS_TOKEN"

# Configure OAuth2 access token for authorization: oauth2
$Configuration.AccessToken = "YOUR_ACCESS_TOKEN"

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job for which status will be returned.

# Get Status of Export Job
try {
    $Result = Export-BetaSpConfigJobStatus -Id $Id
} catch {
    Write-Host ("Exception occurred when calling Export-BetaSpConfigJobStatus: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
Id	String	The ID of the export job for which status will be returned.

Return type

SpConfigJob (PSCustomObject)

Authorization

oauth2, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Import-BetaSpConfig

SpConfigJob Import-BetaSpConfig
        [-Data] <System.IO.FileInfo>
        [-Preview] <System.Nullable[Boolean]>
        [-Options]

Initiates Configuration Objects Import Job.

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. Request will need the following security scope: - sp:config:manage

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-Configuration
# Configure OAuth2 access token for authorization: oauth2
$Configuration.AccessToken = "YOUR_ACCESS_TOKEN"

# Configure OAuth2 access token for authorization: oauth2
$Configuration.AccessToken = "YOUR_ACCESS_TOKEN"

$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 affect on the target tenant. If 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)
$ObjectExportImportOptions = Initialize-ObjectExportImportOptions -IncludedIds "be9e116d-08e1-49fc-ab7f-fa585e96c9e4" -IncludedNames "Test Object"
$BaseReferenceDto = Initialize-BaseReferenceDto -Type "ACCOUNT_CORRELATION_CONFIG" -Id "2c91808568c529c60168cca6f90c1313" -Name "William Wilson"
$ImportOptions = Initialize-ImportOptions -ExcludeTypes "SOURCE" -IncludeTypes "TRIGGER_SUBSCRIPTION" -ObjectOptions @{ key_example = $ObjectExportImportOptions } -DefaultReferences $BaseReferenceDto -ExcludeBackup $false # ImportOptions |  (optional)

# Initiates Configuration Objects Import Job.
try {
    $Result = Import-BetaSpConfig -Data $Data -Preview $Preview -Options $Options
} catch {
    Write-Host ("Exception occurred when calling Import-BetaSpConfig: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
Data	System.IO.FileInfoSystem.IO.FileInfo	JSON file containing the objects to be imported.
Preview	Boolean	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 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	ImportOptions		[optional]

Return type

SpConfigJob (PSCustomObject)

Authorization

oauth2, oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Import-BetaSpConfigDownload

SpConfigImportResults Import-BetaSpConfigDownload
[-Id]

Download Result of Import Job

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: - sp:config:manage

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-Configuration
# Configure OAuth2 access token for authorization: oauth2
$Configuration.AccessToken = "YOUR_ACCESS_TOKEN"

# Configure OAuth2 access token for authorization: oauth2
$Configuration.AccessToken = "YOUR_ACCESS_TOKEN"

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job for which the results will be downloaded.

# Download Result of Import Job
try {
    $Result = Import-BetaSpConfigDownload -Id $Id
} catch {
    Write-Host ("Exception occurred when calling Import-BetaSpConfigDownload: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
Id	String	The ID of the import job for which the results will be downloaded.

Return type

SpConfigImportResults (PSCustomObject)

Authorization

oauth2, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Import-BetaSpConfigJobStatus

SpConfigJob Import-BetaSpConfigJobStatus
[-Id]

Get Status of Import Job

This gets the status of the import job identified by the id parameter. Request will need the following security scope: - sp:config:manage

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-Configuration
# Configure OAuth2 access token for authorization: oauth2
$Configuration.AccessToken = "YOUR_ACCESS_TOKEN"

# Configure OAuth2 access token for authorization: oauth2
$Configuration.AccessToken = "YOUR_ACCESS_TOKEN"

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job for which status will be returned.

# Get Status of Import Job
try {
    $Result = Import-BetaSpConfigJobStatus -Id $Id
} catch {
    Write-Host ("Exception occurred when calling Import-BetaSpConfigJobStatus: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
Id	String	The ID of the import job for which status will be returned.

Return type

SpConfigJob (PSCustomObject)

Authorization

oauth2, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Get-BetaSpConfigObjects

SpConfigObject[] Get-BetaSpConfigObjects

Get Config Object details

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. Request will need one of the following security scopes: - sp:config:read - sp:config:manage

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-Configuration
# Configure OAuth2 access token for authorization: oauth2
$Configuration.AccessToken = "YOUR_ACCESS_TOKEN"

# Configure OAuth2 access token for authorization: oauth2
$Configuration.AccessToken = "YOUR_ACCESS_TOKEN"


# Get Config Object details
try {
    $Result = Get-BetaSpConfigObjects
} catch {
    Write-Host ("Exception occurred when calling Get-BetaSpConfigObjects: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

This endpoint does not need any parameter.

Return type

SpConfigObject[] (PSCustomObject)

Authorization

oauth2, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

BetaSPConfigApi.md

Latest commit

History

BetaSPConfigApi.md

File metadata and controls

PSSailpointBeta.PSSailpointBeta/Api.BetaSPConfigApi

Export-BetaSpConfig

Example

Parameters

Return type

Authorization

HTTP request headers

Export-BetaSpConfigDownload

Example

Parameters

Return type

Authorization

HTTP request headers

Export-BetaSpConfigJobStatus

Example

Parameters

Return type

Authorization

HTTP request headers

Import-BetaSpConfig

Example

Parameters

Return type

Authorization

HTTP request headers

Import-BetaSpConfigDownload

Example

Parameters

Return type

Authorization

HTTP request headers

Import-BetaSpConfigJobStatus

Example

Parameters

Return type

Authorization

HTTP request headers

Get-BetaSpConfigObjects

Example

Parameters

Return type

Authorization

HTTP request headers