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.
ServiceNow is a software platform that supports IT service management and automates common business processes for requesting and fulfilling service requests across a business enterprise.
You must have an IdentityNow ServiceNow ServiceDesk license to use this integration. Contact your Customer Success Manager for more information.
Service Desk integration for IdentityNow and in deprecation - not available for new implementation, as of July 21st, 2021. As per SailPoint’s support policy, all existing SailPoint IdentityNow customers using this legacy integration will be supported until July 2022.
All URIs are relative to https://sailpoint.api.identitynow.com/beta
| Method | HTTP request | Description |
|---|---|---|
| New-BetaSIMIntegration | POST /sim-integrations | Create new SIM integration |
| Remove-BetaSIMIntegration | DELETE /sim-integrations/{id} | Delete a SIM integration |
| Get-BetaSIMIntegration | GET /sim-integrations/{id} | Get a SIM integration details. |
| Get-BetaSIMIntegrations | GET /sim-integrations | List the existing SIM integrations. |
| Update-BetaBeforeProvisioningRule | PATCH /sim-integrations/{id}/beforeProvisioningRule | Patch a SIM beforeProvisioningRule attribute. |
| Update-BetaSIMAttributes | PATCH /sim-integrations/{id} | Patch a SIM attribute. |
| Send-BetaSIMIntegration | PUT /sim-integrations/{id} | Update an existing SIM integration |
create-sim-integration
Create a new SIM Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| Body | SimIntegrationDetails | SimIntegrationDetails | True | DTO containing the details of the SIM integration |
Return type
Responses
| Code | Description | Data Type |
|---|---|---|
| 200 | details of the created integration | ServiceDeskIntegrationDto |
| 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto |
| 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response |
| 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto |
| 404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto |
| 429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response |
| 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto |
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
$SimIntegrationDetails = @"{
"cluster" : "xyzzy999",
"statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}",
"request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}",
"sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ],
"created" : "2023-01-03T21:16:22.432Z",
"name" : "aName",
"modified" : "2023-01-03T21:16:22.432Z",
"description" : "Integration description",
"attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"[email protected]\",\"lastname\":\"white\"}",
"id" : "id12345",
"type" : "ServiceNow Service Desk",
"beforeProvisioningRule" : {
"name" : "Example Rule",
"id" : "2c918085708c274401708c2a8a760001",
"type" : "IDENTITY"
}
}"@
# Create new SIM integration
try {
$Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails
New-BetaSIMIntegration -BetaSimIntegrationDetails $Result
# Below is a request that includes all optional parameters
# New-BetaSIMIntegration -BetaSimIntegrationDetails $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSIMIntegration"
Write-Host $_.ErrorDetails
}
delete-sim-integration
Get the details of a SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| Path | Id | String | True | The id of the integration to delete. |
Return type
(empty response body)
Responses
| Code | Description | Data Type |
|---|---|---|
| 200 | No content response | |
| 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto |
| 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response |
| 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto |
| 404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto |
| 429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response |
| 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto |
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
$Id = "12345" # String | The id of the integration to delete.
# Delete a SIM integration
try {
Remove-BetaSIMIntegration -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaSIMIntegration -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSIMIntegration"
Write-Host $_.ErrorDetails
}
get-sim-integration
Get the details of a SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| Path | Id | String | True | The id of the integration. |
Return type
Responses
| Code | Description | Data Type |
|---|---|---|
| 200 | The DTO containing the details of the SIM integration | ServiceDeskIntegrationDto |
| 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto |
| 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response |
| 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto |
| 404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto |
| 429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response |
| 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto |
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
$Id = "12345" # String | The id of the integration.
# Get a SIM integration details.
try {
Get-BetaSIMIntegration -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaSIMIntegration -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegration"
Write-Host $_.ErrorDetails
}
get-sim-integrations
List the existing SIM integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|
Return type
Responses
| Code | Description | Data Type |
|---|---|---|
| 200 | The DTO containing the details of the SIM integration | ServiceDeskIntegrationDto |
| 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto |
| 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response |
| 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto |
| 404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto |
| 429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response |
| 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto |
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
# List the existing SIM integrations.
try {
Get-BetaSIMIntegrations
# Below is a request that includes all optional parameters
# Get-BetaSIMIntegrations
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegrations"
Write-Host $_.ErrorDetails
}
patch-before-provisioning-rule
Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| Path | Id | String | True | SIM integration id |
| Body | JsonPatch | JsonPatch | True | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. |
Return type
Responses
| Code | Description | Data Type |
|---|---|---|
| 200 | The updated DTO containing the details of the SIM integration. | ServiceDeskIntegrationDto |
| 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto |
| 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response |
| 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto |
| 404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto |
| 429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response |
| 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto |
HTTP request headers
- Content-Type: application/json-patch+json
- Accept: application/json
Example
$Id = "12345" # String | SIM integration id
$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-BetaBeforeProvisioningRule -Id $Id -BetaJsonPatch $Result
# Below is a request that includes all optional parameters
# Update-BetaBeforeProvisioningRule -Id $Id -BetaJsonPatch $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaBeforeProvisioningRule"
Write-Host $_.ErrorDetails
}
patch-sim-attributes
Patch a SIM attribute given a JsonPatch object. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| Path | Id | String | True | SIM integration id |
| Body | JsonPatch | JsonPatch | True | The JsonPatch object that describes the changes of SIM |
Return type
Responses
| Code | Description | Data Type |
|---|---|---|
| 200 | The updated DTO containing the details of the SIM integration. | ServiceDeskIntegrationDto |
| 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto |
| 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response |
| 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto |
| 404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto |
| 429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response |
| 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto |
HTTP request headers
- Content-Type: application/json-patch+json
- Accept: application/json
Example
$Id = "12345" # String | SIM integration id
$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-BetaSIMAttributes -Id $Id -BetaJsonPatch $Result
# Below is a request that includes all optional parameters
# Update-BetaSIMAttributes -Id $Id -BetaJsonPatch $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSIMAttributes"
Write-Host $_.ErrorDetails
}
put-sim-integration
Update an existing SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| Path | Id | String | True | The id of the integration. |
| Body | SimIntegrationDetails | SimIntegrationDetails | True | The full DTO of the integration containing the updated model |
Return type
Responses
| Code | Description | Data Type |
|---|---|---|
| 200 | details of the updated integration | ServiceDeskIntegrationDto |
| 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto |
| 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response |
| 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto |
| 404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto |
| 429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response |
| 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto |
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
$Id = "12345" # String | The id of the integration.
$SimIntegrationDetails = @"{
"cluster" : "xyzzy999",
"statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}",
"request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}",
"sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ],
"created" : "2023-01-03T21:16:22.432Z",
"name" : "aName",
"modified" : "2023-01-03T21:16:22.432Z",
"description" : "Integration description",
"attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"[email protected]\",\"lastname\":\"white\"}",
"id" : "id12345",
"type" : "ServiceNow Service Desk",
"beforeProvisioningRule" : {
"name" : "Example Rule",
"id" : "2c918085708c274401708c2a8a760001",
"type" : "IDENTITY"
}
}"@
# Update an existing SIM integration
try {
$Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails
Send-BetaSIMIntegration -Id $Id -BetaSimIntegrationDetails $Result
# Below is a request that includes all optional parameters
# Send-BetaSIMIntegration -Id $Id -BetaSimIntegrationDetails $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSIMIntegration"
Write-Host $_.ErrorDetails
}