LukeParke/developer.sailpoint.com

Fork 0

mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 12:27:47 +00:00

Files

darrell-thobe-sp ed1043e2b5 updating method docs for python sdk

2025-02-20 13:59:30 -05:00

27 KiB

Raw Blame History

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags

title

pagination_label

sidebar_label

sidebar_class_name

keywords

slug

sailpoint.v2024.SIMIntegrationsApi

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/v2024

Method	HTTP request	Description
create-sim-integration	POST `/sim-integrations`	Create new SIM integration
delete-sim-integration	DELETE `/sim-integrations/{id}`	Delete a SIM integration
get-sim-integration	GET `/sim-integrations/{id}`	Get a SIM integration details.
get-sim-integrations	GET `/sim-integrations`	List the existing SIM integrations.
patch-before-provisioning-rule	PATCH `/sim-integrations/{id}/beforeProvisioningRule`	Patch a SIM beforeProvisioningRule attribute.
patch-sim-attributes	PATCH `/sim-integrations/{id}`	Patch a SIM attribute.
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 new SIM integration Create a new SIM Integrations.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
x_sail_point_experimental	str	True (default to 'true')	Use this header to enable this experimental API.
Body	sim_integration_details	SimIntegrationDetails	True	DTO containing the details of the SIM integration

Return type

ServiceDeskIntegrationDto1

Responses

Code	Description	Data Type	Response headers
200	details of the created integration	ServiceDeskIntegrationDto1	-
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.	ListAccessProfiles401Response	-
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.	ListAccessProfiles429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

Content-Type: application/json
Accept: application/json

Example

import sailpoint.v2024
from sailpoint.v2024.models.service_desk_integration_dto1 import ServiceDeskIntegrationDto1
from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    sim_integration_details = {
          "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\":\"walter@gmail.com\",\"lastname\":\"white\"}",
          "id" : "id12345",
          "type" : "ServiceNow Service Desk",
          "beforeProvisioningRule" : {
            "name" : "Example Rule",
            "id" : "2c918085708c274401708c2a8a760001",
            "type" : "IDENTITY"
          }
        } # SimIntegrationDetails | DTO containing the details of the SIM integration

    try:
        # Create new SIM integration
        Result = sim_integration_details.from_json(sim_integration_details)
        api_response = api_instance.create_sim_integration(x_sail_point_experimental, Result)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.create_sim_integration(x_sail_point_experimental, Result)
        print("The response of SIMIntegrationsApi->create_sim_integration:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e)

[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. ::: Delete a SIM integration Get the details of a SIM integration.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	id	str	True	The id of the integration to delete.
x_sail_point_experimental	str	True (default to 'true')	Use this header to enable this experimental API.

Return type

(empty response body)

Responses

Code	Description	Data Type	Response headers
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.	ListAccessProfiles401Response	-
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.	ListAccessProfiles429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete.
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')

    try:
        # Delete a SIM integration
        
        api_instance.delete_sim_integration(id, x_sail_point_experimental)
        
        # Below is a request that includes all optional parameters
        # api_instance.delete_sim_integration(id, x_sail_point_experimental)
    except Exception as e:
        print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e)

[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 a SIM integration details. Get the details of a SIM integration.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	id	str	True	The id of the integration.
x_sail_point_experimental	str	True (default to 'true')	Use this header to enable this experimental API.

Return type

ServiceDeskIntegrationDto1

Responses

Code	Description	Data Type	Response headers
200	The DTO containing the details of the SIM integration	ServiceDeskIntegrationDto1	-
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.	ListAccessProfiles401Response	-
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.	ListAccessProfiles429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import sailpoint.v2024
from sailpoint.v2024.models.service_desk_integration_dto1 import ServiceDeskIntegrationDto1
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    id = '12345' # str | The id of the integration. # str | The id of the integration.
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')

    try:
        # Get a SIM integration details.
        
        api_response = api_instance.get_sim_integration(id, x_sail_point_experimental)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.get_sim_integration(id, x_sail_point_experimental)
        print("The response of SIMIntegrationsApi->get_sim_integration:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e)

[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. List the existing SIM integrations.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
x_sail_point_experimental	str	True (default to 'true')	Use this header to enable this experimental API.

Return type

ServiceDeskIntegrationDto1

Responses

Code	Description	Data Type	Response headers
200	The DTO containing the details of the SIM integration	ServiceDeskIntegrationDto1	-
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.	ListAccessProfiles401Response	-
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.	ListAccessProfiles429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import sailpoint.v2024
from sailpoint.v2024.models.service_desk_integration_dto1 import ServiceDeskIntegrationDto1
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')

    try:
        # List the existing SIM integrations.
        
        api_response = api_instance.get_sim_integrations(x_sail_point_experimental)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.get_sim_integrations(x_sail_point_experimental)
        print("The response of SIMIntegrationsApi->get_sim_integrations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e)

[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. Patch a SIM beforeProvisioningRule attribute given a JsonPatch object.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	id	str	True	SIM integration id
x_sail_point_experimental	str	True (default to 'true')	Use this header to enable this experimental API.
Body	json_patch	JsonPatch	True	The JsonPatch object that describes the changes of SIM beforeProvisioningRule.

Return type

ServiceDeskIntegrationDto1

Responses

Code	Description	Data Type	Response headers
200	The updated DTO containing the details of the SIM integration.	ServiceDeskIntegrationDto1	-
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.	ListAccessProfiles401Response	-
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.	ListAccessProfiles429Response	-
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

import sailpoint.v2024
from sailpoint.v2024.models.json_patch import JsonPatch
from sailpoint.v2024.models.service_desk_integration_dto1 import ServiceDeskIntegrationDto1
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    id = '12345' # str | SIM integration id # str | SIM integration id
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    json_patch = "[\n  {\n\t  \"op\": \"replace\",\n\t  \"path\": \"/description\",\n\t  \"value\": \"A new description\"\n  }\n]" # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule.

    try:
        # Patch a SIM beforeProvisioningRule attribute.
        Result = json_patch.from_json(json_patch)
        api_response = api_instance.patch_before_provisioning_rule(id, x_sail_point_experimental, Result)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.patch_before_provisioning_rule(id, x_sail_point_experimental, Result)
        print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e)

[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. Patch a SIM attribute given a JsonPatch object.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	id	str	True	SIM integration id
x_sail_point_experimental	str	True (default to 'true')	Use this header to enable this experimental API.
Body	json_patch	JsonPatch	True	The JsonPatch object that describes the changes of SIM

Return type

ServiceDeskIntegrationDto1

Responses

Code	Description	Data Type	Response headers
200	The updated DTO containing the details of the SIM integration.	ServiceDeskIntegrationDto1	-
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.	ListAccessProfiles401Response	-
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.	ListAccessProfiles429Response	-
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

import sailpoint.v2024
from sailpoint.v2024.models.json_patch import JsonPatch
from sailpoint.v2024.models.service_desk_integration_dto1 import ServiceDeskIntegrationDto1
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    id = '12345' # str | SIM integration id # str | SIM integration id
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    json_patch = "[\n  {\n\t  \"op\": \"replace\",\n\t  \"path\": \"/description\",\n\t  \"value\": \"A new description\"\n  }\n]" # JsonPatch | The JsonPatch object that describes the changes of SIM

    try:
        # Patch a SIM attribute.
        Result = json_patch.from_json(json_patch)
        api_response = api_instance.patch_sim_attributes(id, x_sail_point_experimental, Result)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.patch_sim_attributes(id, x_sail_point_experimental, Result)
        print("The response of SIMIntegrationsApi->patch_sim_attributes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e)

[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 Update an existing SIM integration.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	id	str	True	The id of the integration.
x_sail_point_experimental	str	True (default to 'true')	Use this header to enable this experimental API.
Body	sim_integration_details	SimIntegrationDetails	True	The full DTO of the integration containing the updated model

Return type

ServiceDeskIntegrationDto1

Responses

Code	Description	Data Type	Response headers
200	details of the updated integration	ServiceDeskIntegrationDto1	-
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.	ListAccessProfiles401Response	-
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.	ListAccessProfiles429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

Content-Type: application/json
Accept: application/json

Example

import sailpoint.v2024
from sailpoint.v2024.models.service_desk_integration_dto1 import ServiceDeskIntegrationDto1
from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    id = '12345' # str | The id of the integration. # str | The id of the integration.
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    sim_integration_details = {
          "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\":\"walter@gmail.com\",\"lastname\":\"white\"}",
          "id" : "id12345",
          "type" : "ServiceNow Service Desk",
          "beforeProvisioningRule" : {
            "name" : "Example Rule",
            "id" : "2c918085708c274401708c2a8a760001",
            "type" : "IDENTITY"
          }
        } # SimIntegrationDetails | The full DTO of the integration containing the updated model

    try:
        # Update an existing SIM integration
        Result = sim_integration_details.from_json(sim_integration_details)
        api_response = api_instance.put_sim_integration(id, x_sail_point_experimental, Result)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.put_sim_integration(id, x_sail_point_experimental, Result)
        print("The response of SIMIntegrationsApi->put_sim_integration:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e)

[Back to top]

27 KiB Raw Blame History Unescape Escape

sailpoint.v2024.SIMIntegrationsApi

create-sim-integration

Parameters

Return type

Responses

HTTP request headers

Example

delete-sim-integration

Parameters

Return type

Responses

HTTP request headers

Example

get-sim-integration

Parameters

Return type

Responses

HTTP request headers

Example

get-sim-integrations

Parameters

Return type

Responses

HTTP request headers

Example

patch-before-provisioning-rule

Parameters

Return type

Responses

HTTP request headers

Example

patch-sim-attributes

Parameters

Return type

Responses

HTTP request headers

Example

put-sim-integration

Parameters

Return type

Responses

HTTP request headers

Example

27 KiB

Raw Blame History