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

110
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConfigurationHubApi.md
View File

@@ -45,9 +45,12 @@ Method | HTTP request | Description
[**Get-V2024UploadedConfigurations**](#list-uploaded-configurations) | **GET** `/configuration-hub/backups/uploads` | List Uploaded Configurations
[**Update-V2024ObjectMappings**](#update-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-patch` | Bulk updates object mappings
## create-deploy
This API performs a deploy based on an existing daft.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-deploy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -80,22 +83,25 @@ $DeployRequest = @"{
try {
$Result = ConvertFrom-JsonToDeployRequest -Json $DeployRequest
New-V2024Deploy -V2024DeployRequest $Result
New-V2024Deploy -V2024DeployRequest $Result
# Below is a request that includes all optional parameters
# New-V2024Deploy -V2024DeployRequest $DeployRequest
# New-V2024Deploy -V2024DeployRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Deploy"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-object-mapping
This creates an object mapping between current org and source org.
Source org should be "default" when creating an object mapping that is not to be associated to any particular org.
The request will need the following security scope:
- sp:config-object-mapping:manage
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-object-mapping)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -135,22 +141,25 @@ $ObjectMappingRequest = @"{
try {
$Result = ConvertFrom-JsonToObjectMappingRequest -Json $ObjectMappingRequest
New-V2024ObjectMapping -V2024SourceOrg $SourceOrg -V2024ObjectMappingRequest $Result
New-V2024ObjectMapping -SourceOrg $SourceOrg -V2024ObjectMappingRequest $Result
# Below is a request that includes all optional parameters
# New-V2024ObjectMapping -V2024SourceOrg $SourceOrg -V2024ObjectMappingRequest $ObjectMappingRequest
# New-V2024ObjectMapping -SourceOrg $SourceOrg -V2024ObjectMappingRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMapping"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-object-mappings
This creates a set of object mappings (Max 25) between current org and source org.
Source org should be "default" when creating object mappings that are not to be associated to any particular org.
The request will need the following security scope:
- sp:config-object-mapping:manage
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-object-mappings)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -198,16 +207,17 @@ $ObjectMappingBulkCreateRequest = @"{
try {
$Result = ConvertFrom-JsonToObjectMappingBulkCreateRequest -Json $ObjectMappingBulkCreateRequest
New-V2024ObjectMappings -V2024SourceOrg $SourceOrg -V2024ObjectMappingBulkCreateRequest $Result
New-V2024ObjectMappings -SourceOrg $SourceOrg -V2024ObjectMappingBulkCreateRequest $Result
# Below is a request that includes all optional parameters
# New-V2024ObjectMappings -V2024SourceOrg $SourceOrg -V2024ObjectMappingBulkCreateRequest $ObjectMappingBulkCreateRequest
# New-V2024ObjectMappings -SourceOrg $SourceOrg -V2024ObjectMappingBulkCreateRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMappings"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-uploaded-configuration
This API uploads a JSON configuration file into a tenant.
@@ -215,6 +225,8 @@ Configuration files can be managed and deployed via Configuration Hub by uploadi
Refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects) for more information about supported objects.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-uploaded-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -246,16 +258,17 @@ $Name = "MyName" # String | Name that will be assigned to the uploaded configura
# Upload a Configuration
try {
New-V2024UploadedConfiguration -V2024Data $Data -V2024Name $Name
New-V2024UploadedConfiguration -Data $Data -Name $Name
# Below is a request that includes all optional parameters
# New-V2024UploadedConfiguration -V2024Data $Data -V2024Name $Name
# New-V2024UploadedConfiguration -Data $Data -Name $Name
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024UploadedConfiguration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-backup
This API deletes an existing backup for the current tenant.
@@ -263,6 +276,8 @@ On success, this endpoint will return an empty response.
The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-backup)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -293,16 +308,17 @@ $Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the backup to
# Delete a Backup
try {
Remove-V2024Backup -V2024Id $Id
Remove-V2024Backup -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024Backup -V2024Id $Id
# Remove-V2024Backup -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Backup"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-draft
This API deletes an existing draft for the current tenant.
@@ -310,6 +326,8 @@ On success, this endpoint will return an empty response.
The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-draft)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -340,22 +358,25 @@ $Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the draft to d
# Delete a draft
try {
Remove-V2024Draft -V2024Id $Id
Remove-V2024Draft -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024Draft -V2024Id $Id
# Remove-V2024Draft -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Draft"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-object-mapping
This deletes an existing object mapping.
Source org should be "default" when deleting an object mapping that is not associated to any particular org.
The request will need the following security scope:
- sp:config-object-mapping:manage
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-object-mapping)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -388,16 +409,17 @@ $ObjectMappingId = "3d6e0144-963f-4bd6-8d8d-d77b4e507ce4" # String | The id of t
# Deletes an object mapping
try {
Remove-V2024ObjectMapping -V2024SourceOrg $SourceOrg -V2024ObjectMappingId $ObjectMappingId
Remove-V2024ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId
# Below is a request that includes all optional parameters
# Remove-V2024ObjectMapping -V2024SourceOrg $SourceOrg -V2024ObjectMappingId $ObjectMappingId
# Remove-V2024ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ObjectMapping"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-uploaded-configuration
This API deletes an uploaded configuration based on Id.
@@ -405,6 +427,8 @@ On success, this endpoint will return an empty response.
The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-uploaded-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -435,19 +459,22 @@ $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded c
# Delete an Uploaded Configuration
try {
Remove-V2024UploadedConfiguration -V2024Id $Id
Remove-V2024UploadedConfiguration -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024UploadedConfiguration -V2024Id $Id
# Remove-V2024UploadedConfiguration -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024UploadedConfiguration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-deploy
This API gets an existing deploy for the current tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-deploy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -478,22 +505,25 @@ $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the deploy.
# Get a Deploy
try {
Get-V2024Deploy -V2024Id $Id
Get-V2024Deploy -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024Deploy -V2024Id $Id
# Get-V2024Deploy -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Deploy"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-object-mappings
This gets a list of existing object mappings between current org and source org.
Source org should be "default" when getting object mappings that are not associated to any particular org.
The request will need the following security scope:
- sp:config-object-mapping:read
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-object-mappings)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -524,19 +554,22 @@ $SourceOrg = "source-org" # String | The name of the source org.
# Gets list of object mappings
try {
Get-V2024ObjectMappings -V2024SourceOrg $SourceOrg
Get-V2024ObjectMappings -SourceOrg $SourceOrg
# Below is a request that includes all optional parameters
# Get-V2024ObjectMappings -V2024SourceOrg $SourceOrg
# Get-V2024ObjectMappings -SourceOrg $SourceOrg
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ObjectMappings"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-uploaded-configuration
This API gets an existing uploaded configuration for the current tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-uploaded-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -567,19 +600,22 @@ $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded c
# Get an Uploaded Configuration
try {
Get-V2024UploadedConfiguration -V2024Id $Id
Get-V2024UploadedConfiguration -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024UploadedConfiguration -V2024Id $Id
# Get-V2024UploadedConfiguration -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UploadedConfiguration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-backups
This API gets a list of existing backups for the current tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-backups)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -609,19 +645,22 @@ $Filters = 'status eq "COMPLETE"' # String | Filter results using the standard s
# List Backups
try {
Get-V2024Backups
Get-V2024Backups
# Below is a request that includes all optional parameters
# Get-V2024Backups -V2024Filters $Filters
# Get-V2024Backups -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Backups"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-deploys
This API gets a list of deploys for the current tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-deploys)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -649,7 +688,7 @@ Code | Description | Data Type
# List Deploys
try {
Get-V2024Deploys
Get-V2024Deploys
# Below is a request that includes all optional parameters
# Get-V2024Deploys
@@ -659,9 +698,12 @@ try {
}
```
[[Back to top]](#)
## list-drafts
This API gets a list of existing drafts for the current tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-drafts)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -691,19 +733,22 @@ $Filters = 'status eq "COMPLETE"' # String | Filter results using the standard s
# List Drafts
try {
Get-V2024Drafts
Get-V2024Drafts
# Below is a request that includes all optional parameters
# Get-V2024Drafts -V2024Filters $Filters
# Get-V2024Drafts -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Drafts"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-uploaded-configurations
This API gets a list of existing uploaded configurations for the current tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-uploaded-configurations)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -734,22 +779,25 @@ $Filters = 'status eq "COMPLETE"' # String | Filter results using the standard s
# List Uploaded Configurations
try {
Get-V2024UploadedConfigurations
Get-V2024UploadedConfigurations
# Below is a request that includes all optional parameters
# Get-V2024UploadedConfigurations -V2024Filters $Filters
# Get-V2024UploadedConfigurations -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UploadedConfigurations"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-object-mappings
This updates a set of object mappings, only enabled and targetValue fields can be updated.
Source org should be "default" when updating object mappings that are not associated to any particular org.
The request will need the following security scope:
- sp:config-object-mapping:manage
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-object-mappings)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -796,10 +844,10 @@ $ObjectMappingBulkPatchRequest = @"{
try {
$Result = ConvertFrom-JsonToObjectMappingBulkPatchRequest -Json $ObjectMappingBulkPatchRequest
Update-V2024ObjectMappings -V2024SourceOrg $SourceOrg -V2024ObjectMappingBulkPatchRequest $Result
Update-V2024ObjectMappings -SourceOrg $SourceOrg -V2024ObjectMappingBulkPatchRequest $Result
# Below is a request that includes all optional parameters
# Update-V2024ObjectMappings -V2024SourceOrg $SourceOrg -V2024ObjectMappingBulkPatchRequest $ObjectMappingBulkPatchRequest
# Update-V2024ObjectMappings -SourceOrg $SourceOrg -V2024ObjectMappingBulkPatchRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ObjectMappings"
Write-Host $_.ErrorDetails