LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 04:19:37 +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

70
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SIMIntegrationsApi.md
View File

@@ -32,9 +32,15 @@ Method | HTTP request | Description
[**Update-V2024SIMAttributes**](#patch-sim-attributes) | **PATCH** `/sim-integrations/{id}` | Patch a SIM attribute.
[**Send-V2024SIMIntegration**](#put-sim-integration) | **PUT** `/sim-integrations/{id}` | Update an existing SIM integration
## create-sim-integration
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Create a new SIM Integrations.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-sim-integration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -85,19 +91,25 @@ $SimIntegrationDetails = @"{
try {
$Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails
New-V2024SIMIntegration -V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result
New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result
# Below is a request that includes all optional parameters
# New-V2024SIMIntegration -V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $SimIntegrationDetails
# New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SIMIntegration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-sim-integration
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Get the details of a SIM integration.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-sim-integration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -130,19 +142,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Delete a SIM integration
try {
Remove-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SIMIntegration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sim-integration
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Get the details of a SIM integration.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sim-integration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -175,19 +193,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get a SIM integration details.
try {
Get-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sim-integrations
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
List the existing SIM integrations.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sim-integrations)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -218,19 +242,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# List the existing SIM integrations.
try {
Get-V2024SIMIntegrations -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SIMIntegrations -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegrations"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-before-provisioning-rule
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Patch a SIM beforeProvisioningRule attribute given a JsonPatch object.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-before-provisioning-rule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -266,19 +296,25 @@ $JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\"
try {
$Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch
Update-V2024BeforeProvisioningRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result
Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result
# Below is a request that includes all optional parameters
# Update-V2024BeforeProvisioningRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $JsonPatch
# Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024BeforeProvisioningRule"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-sim-attributes
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Patch a SIM attribute given a JsonPatch object.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-sim-attributes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -314,19 +350,25 @@ $JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\"
try {
$Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch
Update-V2024SIMAttributes -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result
Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result
# Below is a request that includes all optional parameters
# Update-V2024SIMAttributes -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $JsonPatch
# Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SIMAttributes"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-sim-integration
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Update an existing SIM integration.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-sim-integration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -379,10 +421,10 @@ $SimIntegrationDetails = @"{
try {
$Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails
Send-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result
Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result
# Below is a request that includes all optional parameters
# Send-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $SimIntegrationDetails
# Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SIMIntegration"
Write-Host $_.ErrorDetails