mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 20:37:47 +00:00
Update to powershell SDK docs: 13122455471
This commit is contained in:
developer-relations-sp
@@ -1,3 +1,4 @@
|
||||
|
||||
---
|
||||
id: v2024-sim-integrations
|
||||
title: SIMIntegrations
|
||||
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v2024/methods/sim-integrations
|
||||
tags: ['SDK', 'Software Development Kit', 'SIMIntegrations', 'V2024SIMIntegrations']
|
||||
---
|
||||
|
||||
|
||||
# SIMIntegrations
|
||||
Use this API to administer IdentityNow's Service Integration Module, or SIM integration with ServiceNow, so that it converts IdentityNow provisioning actions into tickets in ServiceNow.
|
||||
|
||||
@@ -33,9 +33,7 @@ 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
|
||||
|
||||
Create a new SIM Integrations.
|
||||
|
||||
### Parameters
|
||||
@@ -45,7 +43,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Body | SimIntegrationDetails | [**SimIntegrationDetails**](../models/sim-integration-details) | True | DTO containing the details of the SIM integration
|
||||
|
||||
### Return type
|
||||
|
||||
[**ServiceDeskIntegrationDto1**](../models/service-desk-integration-dto1)
|
||||
|
||||
### Responses
|
||||
@@ -60,7 +57,6 @@ Code | Description | Data Type
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
@@ -85,7 +81,9 @@ $SimIntegrationDetails = @"{
|
||||
"type" : "IDENTITY"
|
||||
}
|
||||
}"@
|
||||
|
||||
# Create new SIM integration
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails
|
||||
New-V2024SIMIntegration-V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result
|
||||
@@ -97,11 +95,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-sim-integration
|
||||
|
||||
Get the details of a SIM integration.
|
||||
|
||||
### Parameters
|
||||
@@ -111,7 +106,6 @@ Path | Id | **String** | True | The id of the integration to delete.
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
|
||||
(empty response body)
|
||||
|
||||
### Responses
|
||||
@@ -126,7 +120,6 @@ Code | Description | Data Type
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
@@ -134,7 +127,9 @@ Code | Description | Data Type
|
||||
```powershell
|
||||
$Id = "12345" # String | The id of the integration to delete.
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
|
||||
# Delete a SIM integration
|
||||
|
||||
try {
|
||||
Remove-V2024SIMIntegration-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
@@ -145,11 +140,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-sim-integration
|
||||
|
||||
Get the details of a SIM integration.
|
||||
|
||||
### Parameters
|
||||
@@ -159,7 +151,6 @@ Path | Id | **String** | True | The id of the integration.
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
|
||||
[**ServiceDeskIntegrationDto1**](../models/service-desk-integration-dto1)
|
||||
|
||||
### Responses
|
||||
@@ -174,7 +165,6 @@ Code | Description | Data Type
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
@@ -182,7 +172,9 @@ Code | Description | Data Type
|
||||
```powershell
|
||||
$Id = "12345" # String | The id of the integration.
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
|
||||
# Get a SIM integration details.
|
||||
|
||||
try {
|
||||
Get-V2024SIMIntegration-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
@@ -193,11 +185,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-sim-integrations
|
||||
|
||||
List the existing SIM integrations.
|
||||
|
||||
### Parameters
|
||||
@@ -206,7 +195,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
|
||||
[**ServiceDeskIntegrationDto1**](../models/service-desk-integration-dto1)
|
||||
|
||||
### Responses
|
||||
@@ -221,14 +209,15 @@ Code | Description | Data Type
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
|
||||
# List the existing SIM integrations.
|
||||
|
||||
try {
|
||||
Get-V2024SIMIntegrations-V2024XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
@@ -239,11 +228,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## patch-before-provisioning-rule
|
||||
|
||||
Patch a SIM beforeProvisioningRule attribute given a JsonPatch object.
|
||||
|
||||
### Parameters
|
||||
@@ -254,7 +240,6 @@ Path | Id | **String** | True | SIM integration id
|
||||
Body | JsonPatch | [**JsonPatch**](../models/json-patch) | True | The JsonPatch object that describes the changes of SIM beforeProvisioningRule.
|
||||
|
||||
### Return type
|
||||
|
||||
[**ServiceDeskIntegrationDto1**](../models/service-desk-integration-dto1)
|
||||
|
||||
### Responses
|
||||
@@ -269,7 +254,6 @@ Code | Description | Data Type
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json-patch+json
|
||||
- **Accept**: application/json
|
||||
|
||||
@@ -278,7 +262,9 @@ Code | Description | Data Type
|
||||
$Id = "12345" # String | SIM integration id
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]""@
|
||||
|
||||
# Patch a SIM beforeProvisioningRule attribute.
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch
|
||||
Update-V2024BeforeProvisioningRule-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result
|
||||
@@ -290,11 +276,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## patch-sim-attributes
|
||||
|
||||
Patch a SIM attribute given a JsonPatch object.
|
||||
|
||||
### Parameters
|
||||
@@ -305,7 +288,6 @@ Path | Id | **String** | True | SIM integration id
|
||||
Body | JsonPatch | [**JsonPatch**](../models/json-patch) | True | The JsonPatch object that describes the changes of SIM
|
||||
|
||||
### Return type
|
||||
|
||||
[**ServiceDeskIntegrationDto1**](../models/service-desk-integration-dto1)
|
||||
|
||||
### Responses
|
||||
@@ -320,7 +302,6 @@ Code | Description | Data Type
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json-patch+json
|
||||
- **Accept**: application/json
|
||||
|
||||
@@ -329,7 +310,9 @@ Code | Description | Data Type
|
||||
$Id = "12345" # String | SIM integration id
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]""@
|
||||
|
||||
# Patch a SIM attribute.
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch
|
||||
Update-V2024SIMAttributes-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result
|
||||
@@ -341,11 +324,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## put-sim-integration
|
||||
|
||||
Update an existing SIM integration.
|
||||
|
||||
### Parameters
|
||||
@@ -356,7 +336,6 @@ Path | Id | **String** | True | The id of the integration.
|
||||
Body | SimIntegrationDetails | [**SimIntegrationDetails**](../models/sim-integration-details) | True | The full DTO of the integration containing the updated model
|
||||
|
||||
### Return type
|
||||
|
||||
[**ServiceDeskIntegrationDto1**](../models/service-desk-integration-dto1)
|
||||
|
||||
### Responses
|
||||
@@ -371,7 +350,6 @@ Code | Description | Data Type
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
@@ -397,7 +375,9 @@ $SimIntegrationDetails = @"{
|
||||
"type" : "IDENTITY"
|
||||
}
|
||||
}"@
|
||||
|
||||
# Update an existing SIM integration
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails
|
||||
Send-V2024SIMIntegration-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result
|
||||
@@ -409,7 +389,4 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user