mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-08 20:37:46 +00:00
Update to python SDK docs: 14068093756
This commit is contained in:
developer-relations-sp
@@ -29,10 +29,12 @@ Method | HTTP request | Description
|
||||
[**create-deploy**](#create-deploy) | **POST** `/configuration-hub/deploys` | Create a Deploy
|
||||
[**create-object-mapping**](#create-object-mapping) | **POST** `/configuration-hub/object-mappings/{sourceOrg}` | Creates an object mapping
|
||||
[**create-object-mappings**](#create-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-create` | Bulk creates object mappings
|
||||
[**create-scheduled-action**](#create-scheduled-action) | **POST** `/configuration-hub/scheduled-actions` | Create Scheduled Action
|
||||
[**create-uploaded-configuration**](#create-uploaded-configuration) | **POST** `/configuration-hub/backups/uploads` | Upload a Configuration
|
||||
[**delete-backup**](#delete-backup) | **DELETE** `/configuration-hub/backups/{id}` | Delete a Backup
|
||||
[**delete-draft**](#delete-draft) | **DELETE** `/configuration-hub/drafts/{id}` | Delete a draft
|
||||
[**delete-object-mapping**](#delete-object-mapping) | **DELETE** `/configuration-hub/object-mappings/{sourceOrg}/{objectMappingId}` | Deletes an object mapping
|
||||
[**delete-scheduled-action**](#delete-scheduled-action) | **DELETE** `/configuration-hub/scheduled-actions/{id}` | Delete Scheduled Action
|
||||
[**delete-uploaded-configuration**](#delete-uploaded-configuration) | **DELETE** `/configuration-hub/backups/uploads/{id}` | Delete an Uploaded Configuration
|
||||
[**get-deploy**](#get-deploy) | **GET** `/configuration-hub/deploys/{id}` | Get a Deploy
|
||||
[**get-object-mappings**](#get-object-mappings) | **GET** `/configuration-hub/object-mappings/{sourceOrg}` | Gets list of object mappings
|
||||
@@ -40,8 +42,10 @@ Method | HTTP request | Description
|
||||
[**list-backups**](#list-backups) | **GET** `/configuration-hub/backups` | List Backups
|
||||
[**list-deploys**](#list-deploys) | **GET** `/configuration-hub/deploys` | List Deploys
|
||||
[**list-drafts**](#list-drafts) | **GET** `/configuration-hub/drafts` | List Drafts
|
||||
[**list-scheduled-actions**](#list-scheduled-actions) | **GET** `/configuration-hub/scheduled-actions` | List Scheduled Actions
|
||||
[**list-uploaded-configurations**](#list-uploaded-configurations) | **GET** `/configuration-hub/backups/uploads` | List Uploaded Configurations
|
||||
[**update-object-mappings**](#update-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-patch` | Bulk updates object mappings
|
||||
[**update-scheduled-action**](#update-scheduled-action) | **PATCH** `/configuration-hub/scheduled-actions/{id}` | Update Scheduled Action
|
||||
|
||||
|
||||
## create-deploy
|
||||
@@ -253,6 +257,87 @@ with ApiClient(configuration) as api_client:
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## create-scheduled-action
|
||||
Create Scheduled Action
|
||||
This API creates a new scheduled action for the current tenant.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-scheduled-action)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Body | scheduled_action_payload | [**ScheduledActionPayload**](../models/scheduled-action-payload) | True | The scheduled action creation request body.
|
||||
|
||||
### Return type
|
||||
[**ScheduledActionResponse**](../models/scheduled-action-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | The created scheduled action. | ScheduledActionResponse | - |
|
||||
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 | - |
|
||||
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
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.scheduled_action_payload import ScheduledActionPayload
|
||||
from sailpoint.v2024.models.scheduled_action_response import ScheduledActionResponse
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
scheduled_action_payload = '''{
|
||||
"cronString" : "0 0 12 * * ?",
|
||||
"timeZoneId" : "America/Chicago",
|
||||
"startTime" : "2024-08-16T14:16:58.389Z",
|
||||
"jobType" : "BACKUP",
|
||||
"content" : {
|
||||
"sourceTenant" : "tenant-name",
|
||||
"draftId" : "9012b87d-48ca-439a-868f-2160001da8c3",
|
||||
"name" : "Daily Backup",
|
||||
"backupOptions" : {
|
||||
"includeTypes" : [ "ROLE", "IDENTITY_PROFILE" ],
|
||||
"objectOptions" : {
|
||||
"SOURCE" : {
|
||||
"includedNames" : [ "Source1", "Source2" ]
|
||||
},
|
||||
"ROLE" : {
|
||||
"includedNames" : [ "Admin Role", "User Role" ]
|
||||
}
|
||||
}
|
||||
},
|
||||
"sourceBackupId" : "5678b87d-48ca-439a-868f-2160001da8c2"
|
||||
}
|
||||
}''' # ScheduledActionPayload | The scheduled action creation request body.
|
||||
|
||||
try:
|
||||
# Create Scheduled Action
|
||||
new_scheduled_action_payload = ScheduledActionPayload.from_json(scheduled_action_payload)
|
||||
results = ConfigurationHubApi(api_client).create_scheduled_action(scheduled_action_payload=new_scheduled_action_payload)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = ConfigurationHubApi(api_client).create_scheduled_action(new_scheduled_action_payload)
|
||||
print("The response of ConfigurationHubApi->create_scheduled_action:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling ConfigurationHubApi->create_scheduled_action: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## create-uploaded-configuration
|
||||
@@ -498,6 +583,62 @@ with ApiClient(configuration) as api_client:
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-scheduled-action
|
||||
Delete Scheduled Action
|
||||
This API deletes an existing scheduled action.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-scheduled-action)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | scheduled_action_id | **str** | True | The ID of the scheduled action.
|
||||
|
||||
### Return type
|
||||
(empty response body)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
204 | No content - indicates the request was successful but there is no content to be returned in the 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
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
scheduled_action_id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | The ID of the scheduled action. # str | The ID of the scheduled action.
|
||||
|
||||
try:
|
||||
# Delete Scheduled Action
|
||||
|
||||
ConfigurationHubApi(api_client).delete_scheduled_action(scheduled_action_id=scheduled_action_id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# ConfigurationHubApi(api_client).delete_scheduled_action(scheduled_action_id)
|
||||
except Exception as e:
|
||||
print("Exception when calling ConfigurationHubApi->delete_scheduled_action: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-uploaded-configuration
|
||||
@@ -908,6 +1049,60 @@ with ApiClient(configuration) as api_client:
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-scheduled-actions
|
||||
List Scheduled Actions
|
||||
This API gets a list of existing scheduled actions for the current tenant.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-scheduled-actions)
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
[**List[ScheduledActionResponse]**](../models/scheduled-action-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | List of existing scheduled actions. | List[ScheduledActionResponse] | - |
|
||||
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 | - |
|
||||
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
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.scheduled_action_response import ScheduledActionResponse
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
|
||||
try:
|
||||
# List Scheduled Actions
|
||||
|
||||
results = ConfigurationHubApi(api_client).list_scheduled_actions()
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = ConfigurationHubApi(api_client).list_scheduled_actions()
|
||||
print("The response of ConfigurationHubApi->list_scheduled_actions:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling ConfigurationHubApi->list_scheduled_actions: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-uploaded-configurations
|
||||
@@ -1045,6 +1240,78 @@ with ApiClient(configuration) as api_client:
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## update-scheduled-action
|
||||
Update Scheduled Action
|
||||
This API updates an existing scheduled action using JSON Patch format.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-scheduled-action)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | scheduled_action_id | **str** | True | The ID of the scheduled action.
|
||||
Body | json_patch | [**JsonPatch**](../models/json-patch) | True | The JSON Patch document containing the changes to apply to the scheduled action.
|
||||
|
||||
### Return type
|
||||
[**ScheduledActionResponse**](../models/scheduled-action-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | The updated scheduled action. | ScheduledActionResponse | - |
|
||||
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
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.json_patch import JsonPatch
|
||||
from sailpoint.v2024.models.scheduled_action_response import ScheduledActionResponse
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
scheduled_action_id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | The ID of the scheduled action. # str | The ID of the scheduled action.
|
||||
json_patch = '''{
|
||||
"operations" : [ {
|
||||
"op" : "replace",
|
||||
"path" : "/description",
|
||||
"value" : "New description"
|
||||
}, {
|
||||
"op" : "replace",
|
||||
"path" : "/description",
|
||||
"value" : "New description"
|
||||
} ]
|
||||
}''' # JsonPatch | The JSON Patch document containing the changes to apply to the scheduled action.
|
||||
|
||||
try:
|
||||
# Update Scheduled Action
|
||||
new_json_patch = JsonPatch.from_json(json_patch)
|
||||
results = ConfigurationHubApi(api_client).update_scheduled_action(scheduled_action_id=scheduled_action_id, json_patch=new_json_patch)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = ConfigurationHubApi(api_client).update_scheduled_action(scheduled_action_id, new_json_patch)
|
||||
print("The response of ConfigurationHubApi->update_scheduled_action:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling ConfigurationHubApi->update_scheduled_action: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user