mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-08 04:19:37 +00:00
Update to powershell SDK docs: 13207859154
This commit is contained in:
developer-relations-sp
@@ -52,9 +52,12 @@ Method | HTTP request | Description
|
||||
[**Send-BetaServiceDeskIntegration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a Service Desk integration
|
||||
[**Update-BetaStatusCheckDetails**](#update-status-check-details) | **PUT** `/service-desk-integrations/status-check-configuration` | Update the time check configuration
|
||||
|
||||
|
||||
## create-service-desk-integration
|
||||
Create a new Service Desk integration.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-service-desk-integration)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -116,19 +119,22 @@ $ServiceDeskIntegrationDto = @"{
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto
|
||||
New-BetaServiceDeskIntegration -BetaServiceDeskIntegrationDto $Result
|
||||
New-BetaServiceDeskIntegration -BetaServiceDeskIntegrationDto $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# New-BetaServiceDeskIntegration -BetaServiceDeskIntegrationDto $ServiceDeskIntegrationDto
|
||||
# New-BetaServiceDeskIntegration -BetaServiceDeskIntegrationDto $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaServiceDeskIntegration"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-service-desk-integration
|
||||
Delete an existing Service Desk integration by ID.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-service-desk-integration)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -159,19 +165,22 @@ $Id = "anId" # String | ID of Service Desk integration to delete
|
||||
# Delete a Service Desk integration
|
||||
|
||||
try {
|
||||
Remove-BetaServiceDeskIntegration -BetaId $Id
|
||||
Remove-BetaServiceDeskIntegration -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Remove-BetaServiceDeskIntegration -BetaId $Id
|
||||
# Remove-BetaServiceDeskIntegration -Id $Id
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaServiceDeskIntegration"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-service-desk-integration
|
||||
Get an existing Service Desk integration by ID.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-service-desk-integration)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -202,19 +211,22 @@ $Id = "anId" # String | ID of the Service Desk integration to get
|
||||
# Get a Service Desk integration
|
||||
|
||||
try {
|
||||
Get-BetaServiceDeskIntegration -BetaId $Id
|
||||
Get-BetaServiceDeskIntegration -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-BetaServiceDeskIntegration -BetaId $Id
|
||||
# Get-BetaServiceDeskIntegration -Id $Id
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegration"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-service-desk-integration-list
|
||||
Get a list of Service Desk integration objects.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-service-desk-integration-list)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -253,19 +265,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
|
||||
# List existing Service Desk integrations
|
||||
|
||||
try {
|
||||
Get-BetaServiceDeskIntegrationList
|
||||
Get-BetaServiceDeskIntegrationList
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-BetaServiceDeskIntegrationList -BetaOffset $Offset -BetaLimit $Limit -BetaSorters $Sorters -BetaFilters $Filters -BetaCount $Count
|
||||
# Get-BetaServiceDeskIntegrationList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationList"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-service-desk-integration-template
|
||||
This API endpoint returns an existing Service Desk integration template by scriptName.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-service-desk-integration-template)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -296,19 +311,22 @@ $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk
|
||||
# Service Desk integration template by scriptName
|
||||
|
||||
try {
|
||||
Get-BetaServiceDeskIntegrationTemplate -BetaScriptName $ScriptName
|
||||
Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-BetaServiceDeskIntegrationTemplate -BetaScriptName $ScriptName
|
||||
# Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTemplate"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-service-desk-integration-types
|
||||
This API endpoint returns the current list of supported Service Desk integration types.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-service-desk-integration-types)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -337,7 +355,7 @@ Code | Description | Data Type
|
||||
# List Service Desk integration types
|
||||
|
||||
try {
|
||||
Get-BetaServiceDeskIntegrationTypes
|
||||
Get-BetaServiceDeskIntegrationTypes
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-BetaServiceDeskIntegrationTypes
|
||||
@@ -347,9 +365,12 @@ try {
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-status-check-details
|
||||
Get the time check configuration of queued SDIM tickets.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-status-check-details)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -378,7 +399,7 @@ Code | Description | Data Type
|
||||
# Get the time check configuration
|
||||
|
||||
try {
|
||||
Get-BetaStatusCheckDetails
|
||||
Get-BetaStatusCheckDetails
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-BetaStatusCheckDetails
|
||||
@@ -388,9 +409,12 @@ try {
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## patch-service-desk-integration
|
||||
Update an existing Service Desk integration by ID with a PATCH request.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-service-desk-integration)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -424,19 +448,22 @@ $PatchServiceDeskIntegrationRequest = @""@
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest
|
||||
Update-BetaServiceDeskIntegration -BetaId $Id -BetaPatchServiceDeskIntegrationRequest $Result
|
||||
Update-BetaServiceDeskIntegration -Id $Id -BetaPatchServiceDeskIntegrationRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Update-BetaServiceDeskIntegration -BetaId $Id -BetaPatchServiceDeskIntegrationRequest $PatchServiceDeskIntegrationRequest
|
||||
# Update-BetaServiceDeskIntegration -Id $Id -BetaPatchServiceDeskIntegrationRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## put-service-desk-integration
|
||||
Update an existing Service Desk integration by ID.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/put-service-desk-integration)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -500,19 +527,22 @@ $ServiceDeskIntegrationDto = @"{
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto
|
||||
Send-BetaServiceDeskIntegration -BetaId $Id -BetaServiceDeskIntegrationDto $Result
|
||||
Send-BetaServiceDeskIntegration -Id $Id -BetaServiceDeskIntegrationDto $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Send-BetaServiceDeskIntegration -BetaId $Id -BetaServiceDeskIntegrationDto $ServiceDeskIntegrationDto
|
||||
# Send-BetaServiceDeskIntegration -Id $Id -BetaServiceDeskIntegrationDto $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaServiceDeskIntegration"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## update-status-check-details
|
||||
Update the time check configuration of queued SDIM tickets.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/update-status-check-details)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -547,10 +577,10 @@ $QueuedCheckConfigDetails = @"{
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails
|
||||
Update-BetaStatusCheckDetails -BetaQueuedCheckConfigDetails $Result
|
||||
Update-BetaStatusCheckDetails -BetaQueuedCheckConfigDetails $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Update-BetaStatusCheckDetails -BetaQueuedCheckConfigDetails $QueuedCheckConfigDetails
|
||||
# Update-BetaStatusCheckDetails -BetaQueuedCheckConfigDetails $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaStatusCheckDetails"
|
||||
Write-Host $_.ErrorDetails
|
||||
|
||||
Reference in New Issue
Block a user