LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-07 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update to powershell SDK docs: 13207859154

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-07 20:53:08 +00:00
parent fea17715f4
commit 09ed592191
244 changed files with 12907 additions and 6931 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSPConfigApi.md
View File

@@ -25,10 +25,13 @@ Method | HTTP request | Description
[**Import-BetaSpConfig**](#import-sp-config) | **POST** `/sp-config/import` | Initiates configuration objects import job
[**Get-BetaSpConfigObjects**](#list-sp-config-objects) | **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](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
[API Spec](https://developer.sailpoint.com/docs/api/beta/export-sp-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -62,21 +65,24 @@ $ExportPayload = @"{
try {
$Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload
Export-BetaSpConfig -BetaExportPayload $Result
Export-BetaSpConfig -BetaExportPayload $Result
# Below is a request that includes all optional parameters
# Export-BetaSpConfig -BetaExportPayload $ExportPayload
# Export-BetaSpConfig -BetaExportPayload $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaSpConfig"
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
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sp-config-export)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -107,21 +113,24 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job who
# Download export job result.
try {
Get-BetaSpConfigExport -BetaId $Id
Get-BetaSpConfigExport -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaSpConfigExport -BetaId $Id
# Get-BetaSpConfigExport -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExport"
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
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sp-config-export-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -152,21 +161,24 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job who
# Get export job status
try {
Get-BetaSpConfigExportStatus -BetaId $Id
Get-BetaSpConfigExportStatus -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaSpConfigExportStatus -BetaId $Id
# Get-BetaSpConfigExportStatus -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExportStatus"
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
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sp-config-import)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -197,20 +209,23 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job who
# Download import job result
try {
Get-BetaSpConfigImport -BetaId $Id
Get-BetaSpConfigImport -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaSpConfigImport -BetaId $Id
# Get-BetaSpConfigImport -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImport"
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](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sp-config-import-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -241,16 +256,17 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job who
# Get import job status
try {
Get-BetaSpConfigImportStatus -BetaId $Id
Get-BetaSpConfigImportStatus -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaSpConfigImportStatus -BetaId $Id
# Get-BetaSpConfigImportStatus -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImportStatus"
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.
@@ -264,6 +280,8 @@ You cannot currently import from the Non-Employee Lifecycle Management (NELM) so
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).
[API Spec](https://developer.sailpoint.com/docs/api/beta/import-sp-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -298,19 +316,22 @@ $Options = @""@
# Initiates configuration objects import job
try {
Import-BetaSpConfig -BetaData $Data
Import-BetaSpConfig -Data $Data
# Below is a request that includes all optional parameters
# Import-BetaSpConfig -BetaData $Data -BetaPreview $Preview -BetaOptions $Options
# Import-BetaSpConfig -Data $Data -Preview $Preview -BetaOptions $Options
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSpConfig"
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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-sp-config-objects)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -339,7 +360,7 @@ Code | Description | Data Type
# Get config object details
try {
Get-BetaSpConfigObjects
Get-BetaSpConfigObjects
# Below is a request that includes all optional parameters
# Get-BetaSpConfigObjects