mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-08 12:27:47 +00:00
Update python SDK docs: 15116515953
This commit is contained in:
developer-relations-sp
@@ -39,20 +39,20 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create-service-desk-integration**](#create-service-desk-integration) | **POST** `/service-desk-integrations` | Create new Service Desk integration
|
||||
[**delete-service-desk-integration**](#delete-service-desk-integration) | **DELETE** `/service-desk-integrations/{id}` | Delete a Service Desk integration
|
||||
[**get-service-desk-integration**](#get-service-desk-integration) | **GET** `/service-desk-integrations/{id}` | Get a Service Desk integration
|
||||
[**get-service-desk-integration-list**](#get-service-desk-integration-list) | **GET** `/service-desk-integrations` | List existing Service Desk integrations
|
||||
[**get-service-desk-integration-template**](#get-service-desk-integration-template) | **GET** `/service-desk-integrations/templates/{scriptName}` | Service Desk integration template by scriptName
|
||||
[**get-service-desk-integration-types**](#get-service-desk-integration-types) | **GET** `/service-desk-integrations/types` | List Service Desk integration types
|
||||
[**create-service-desk-integration**](#create-service-desk-integration) | **POST** `/service-desk-integrations` | Create new service desk integration
|
||||
[**delete-service-desk-integration**](#delete-service-desk-integration) | **DELETE** `/service-desk-integrations/{id}` | Delete a service desk integration
|
||||
[**get-service-desk-integration**](#get-service-desk-integration) | **GET** `/service-desk-integrations/{id}` | Get a service desk integration
|
||||
[**get-service-desk-integration-list**](#get-service-desk-integration-list) | **GET** `/service-desk-integrations` | List existing service desk integrations
|
||||
[**get-service-desk-integration-template**](#get-service-desk-integration-template) | **GET** `/service-desk-integrations/templates/{scriptName}` | Service desk integration template by scriptname
|
||||
[**get-service-desk-integration-types**](#get-service-desk-integration-types) | **GET** `/service-desk-integrations/types` | List service desk integration types
|
||||
[**get-status-check-details**](#get-status-check-details) | **GET** `/service-desk-integrations/status-check-configuration` | Get the time check configuration
|
||||
[**patch-service-desk-integration**](#patch-service-desk-integration) | **PATCH** `/service-desk-integrations/{id}` | Patch a Service Desk Integration
|
||||
[**put-service-desk-integration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a Service Desk integration
|
||||
[**patch-service-desk-integration**](#patch-service-desk-integration) | **PATCH** `/service-desk-integrations/{id}` | Patch a service desk integration
|
||||
[**put-service-desk-integration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a service desk integration
|
||||
[**update-status-check-details**](#update-status-check-details) | **PUT** `/service-desk-integrations/status-check-configuration` | Update the time check configuration
|
||||
|
||||
|
||||
## create-service-desk-integration
|
||||
Create new Service Desk integration
|
||||
Create new service desk integration
|
||||
Create a new Service Desk integration.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-service-desk-integration)
|
||||
@@ -125,7 +125,7 @@ with ApiClient(configuration) as api_client:
|
||||
}''' # ServiceDeskIntegrationDto | The specifics of a new integration to create
|
||||
|
||||
try:
|
||||
# Create new Service Desk integration
|
||||
# Create new service desk integration
|
||||
new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto)
|
||||
results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(service_desk_integration_dto=new_service_desk_integration_dto)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -141,7 +141,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-service-desk-integration
|
||||
Delete a Service Desk integration
|
||||
Delete a service desk integration
|
||||
Delete an existing Service Desk integration by ID.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-service-desk-integration)
|
||||
@@ -183,7 +183,7 @@ with ApiClient(configuration) as api_client:
|
||||
id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete
|
||||
|
||||
try:
|
||||
# Delete a Service Desk integration
|
||||
# Delete a service desk integration
|
||||
|
||||
ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -197,7 +197,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-service-desk-integration
|
||||
Get a Service Desk integration
|
||||
Get a service desk integration
|
||||
Get an existing Service Desk integration by ID.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-service-desk-integration)
|
||||
@@ -240,7 +240,7 @@ with ApiClient(configuration) as api_client:
|
||||
id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get
|
||||
|
||||
try:
|
||||
# Get a Service Desk integration
|
||||
# Get a service desk integration
|
||||
|
||||
results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -256,7 +256,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-service-desk-integration-list
|
||||
List existing Service Desk integrations
|
||||
List existing service desk integrations
|
||||
Get a list of Service Desk integration objects.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-service-desk-integration-list)
|
||||
@@ -307,7 +307,7 @@ with ApiClient(configuration) as api_client:
|
||||
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False)
|
||||
|
||||
try:
|
||||
# List existing Service Desk integrations
|
||||
# List existing service desk integrations
|
||||
|
||||
results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list()
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -324,7 +324,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-service-desk-integration-template
|
||||
Service Desk integration template by scriptName
|
||||
Service desk integration template by scriptname
|
||||
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)
|
||||
@@ -367,7 +367,7 @@ with ApiClient(configuration) as api_client:
|
||||
script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get
|
||||
|
||||
try:
|
||||
# Service Desk integration template by scriptName
|
||||
# Service desk integration template by scriptname
|
||||
|
||||
results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name=script_name)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -383,7 +383,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-service-desk-integration-types
|
||||
List Service Desk integration types
|
||||
List 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)
|
||||
@@ -422,7 +422,7 @@ configuration = Configuration()
|
||||
with ApiClient(configuration) as api_client:
|
||||
|
||||
try:
|
||||
# List Service Desk integration types
|
||||
# List service desk integration types
|
||||
|
||||
results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types()
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -494,7 +494,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## patch-service-desk-integration
|
||||
Patch a Service Desk Integration
|
||||
Patch a 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)
|
||||
@@ -540,7 +540,7 @@ with ApiClient(configuration) as api_client:
|
||||
json_patch_operation = '''[sailpoint.beta.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed.
|
||||
|
||||
try:
|
||||
# Patch a Service Desk Integration
|
||||
# Patch a service desk integration
|
||||
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
|
||||
results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, json_patch_operation=new_json_patch_operation)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -556,7 +556,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## put-service-desk-integration
|
||||
Update a Service Desk integration
|
||||
Update a service desk integration
|
||||
Update an existing Service Desk integration by ID.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/put-service-desk-integration)
|
||||
@@ -631,7 +631,7 @@ with ApiClient(configuration) as api_client:
|
||||
}''' # ServiceDeskIntegrationDto | The specifics of the integration to update
|
||||
|
||||
try:
|
||||
# Update a Service Desk integration
|
||||
# Update a service desk integration
|
||||
new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto)
|
||||
results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id=id, service_desk_integration_dto=new_service_desk_integration_dto)
|
||||
# Below is a request that includes all optional parameters
|
||||
|
||||
Reference in New Issue
Block a user