mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-08 04:19:37 +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]](#)
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
id: v2024-scheduled-action-payload
|
||||
title: ScheduledActionPayload
|
||||
pagination_label: ScheduledActionPayload
|
||||
sidebar_label: ScheduledActionPayload
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ScheduledActionPayload', 'V2024ScheduledActionPayload']
|
||||
slug: /tools/sdk/python/v2024/models/scheduled-action-payload
|
||||
tags: ['SDK', 'Software Development Kit', 'ScheduledActionPayload', 'V2024ScheduledActionPayload']
|
||||
---
|
||||
|
||||
# ScheduledActionPayload
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**job_type** | **Enum** [ 'BACKUP', 'CREATE_DRAFT', 'CONFIG_DEPLOY_DRAFT' ] | Type of the scheduled job. | [required]
|
||||
**start_time** | **datetime** | The time when this scheduled action should start. Optional. | [optional]
|
||||
**cron_string** | **str** | Cron expression defining the schedule for this action. Optional for repeated events. | [optional]
|
||||
**time_zone_id** | **str** | Time zone ID for interpreting the cron expression. Optional, will default to current time zone. | [optional]
|
||||
**content** | [**ScheduledActionPayloadContent**](scheduled-action-payload-content) | | [required]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.scheduled_action_payload import ScheduledActionPayload
|
||||
|
||||
scheduled_action_payload = ScheduledActionPayload(
|
||||
job_type='BACKUP',
|
||||
start_time='2024-08-16T14:16:58.389Z',
|
||||
cron_string='0 0 12 * * ?',
|
||||
time_zone_id='America/Chicago',
|
||||
content=sailpoint.v2024.models.scheduled_action_payload_content.ScheduledActionPayload_content(
|
||||
name = 'Daily Backup',
|
||||
backup_options = sailpoint.v2024.models.scheduled_action_payload_content_backup_options.ScheduledActionPayload_content_backupOptions(
|
||||
include_types = [ROLE, IDENTITY_PROFILE],
|
||||
object_options = {SOURCE={includedNames=[Source1, Source2]}, ROLE={includedNames=[Admin Role, User Role]}}, ),
|
||||
source_backup_id = '5678b87d-48ca-439a-868f-2160001da8c2',
|
||||
source_tenant = 'tenant-name',
|
||||
draft_id = '9012b87d-48ca-439a-868f-2160001da8c3', )
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
id: v2024-scheduled-action-payload-content
|
||||
title: ScheduledActionPayloadContent
|
||||
pagination_label: ScheduledActionPayloadContent
|
||||
sidebar_label: ScheduledActionPayloadContent
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ScheduledActionPayloadContent', 'V2024ScheduledActionPayloadContent']
|
||||
slug: /tools/sdk/python/v2024/models/scheduled-action-payload-content
|
||||
tags: ['SDK', 'Software Development Kit', 'ScheduledActionPayloadContent', 'V2024ScheduledActionPayloadContent']
|
||||
---
|
||||
|
||||
# ScheduledActionPayloadContent
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | Name of the scheduled action (maximum 50 characters). | [required]
|
||||
**backup_options** | [**ScheduledActionPayloadContentBackupOptions**](scheduled-action-payload-content-backup-options) | | [optional]
|
||||
**source_backup_id** | **str** | ID of the source backup. Required for CREATE_DRAFT jobs. | [optional]
|
||||
**source_tenant** | **str** | Source tenant identifier. Required for CREATE_DRAFT jobs. | [optional]
|
||||
**draft_id** | **str** | ID of the draft to be deployed. Required for CONFIG_DEPLOY_DRAFT jobs. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.scheduled_action_payload_content import ScheduledActionPayloadContent
|
||||
|
||||
scheduled_action_payload_content = ScheduledActionPayloadContent(
|
||||
name='Daily Backup',
|
||||
backup_options=sailpoint.v2024.models.scheduled_action_payload_content_backup_options.ScheduledActionPayload_content_backupOptions(
|
||||
include_types = [ROLE, IDENTITY_PROFILE],
|
||||
object_options = {SOURCE={includedNames=[Source1, Source2]}, ROLE={includedNames=[Admin Role, User Role]}}, ),
|
||||
source_backup_id='5678b87d-48ca-439a-868f-2160001da8c2',
|
||||
source_tenant='tenant-name',
|
||||
draft_id='9012b87d-48ca-439a-868f-2160001da8c3'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,36 @@
|
||||
---
|
||||
id: v2024-scheduled-action-payload-content-backup-options
|
||||
title: ScheduledActionPayloadContentBackupOptions
|
||||
pagination_label: ScheduledActionPayloadContentBackupOptions
|
||||
sidebar_label: ScheduledActionPayloadContentBackupOptions
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ScheduledActionPayloadContentBackupOptions', 'V2024ScheduledActionPayloadContentBackupOptions']
|
||||
slug: /tools/sdk/python/v2024/models/scheduled-action-payload-content-backup-options
|
||||
tags: ['SDK', 'Software Development Kit', 'ScheduledActionPayloadContentBackupOptions', 'V2024ScheduledActionPayloadContentBackupOptions']
|
||||
---
|
||||
|
||||
# ScheduledActionPayloadContentBackupOptions
|
||||
|
||||
Options for BACKUP type jobs. Required for BACKUP jobs.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**include_types** | **[]str** | Object types that are to be included in the backup. | [optional]
|
||||
**object_options** | [**map[string]ScheduledActionResponseContentBackupOptionsObjectOptionsValue**](scheduled-action-response-content-backup-options-object-options-value) | Map of objectType string to the options to be passed to the target service for that objectType. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.scheduled_action_payload_content_backup_options import ScheduledActionPayloadContentBackupOptions
|
||||
|
||||
scheduled_action_payload_content_backup_options = ScheduledActionPayloadContentBackupOptions(
|
||||
include_types=[ROLE, IDENTITY_PROFILE],
|
||||
object_options={SOURCE={includedNames=[Source1, Source2]}, ROLE={includedNames=[Admin Role, User Role]}}
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,52 @@
|
||||
---
|
||||
id: v2024-scheduled-action-response
|
||||
title: ScheduledActionResponse
|
||||
pagination_label: ScheduledActionResponse
|
||||
sidebar_label: ScheduledActionResponse
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ScheduledActionResponse', 'V2024ScheduledActionResponse']
|
||||
slug: /tools/sdk/python/v2024/models/scheduled-action-response
|
||||
tags: ['SDK', 'Software Development Kit', 'ScheduledActionResponse', 'V2024ScheduledActionResponse']
|
||||
---
|
||||
|
||||
# ScheduledActionResponse
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | Unique identifier for this scheduled action. | [optional]
|
||||
**created** | **datetime** | The time when this scheduled action was created. | [optional]
|
||||
**job_type** | **Enum** [ 'BACKUP', 'CREATE_DRAFT', 'CONFIG_DEPLOY_DRAFT' ] | Type of the scheduled job. | [optional]
|
||||
**content** | [**ScheduledActionResponseContent**](scheduled-action-response-content) | | [optional]
|
||||
**start_time** | **datetime** | The time when this scheduled action should start. | [optional]
|
||||
**cron_string** | **str** | Cron expression defining the schedule for this action. | [optional]
|
||||
**time_zone_id** | **str** | Time zone ID for interpreting the cron expression. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.scheduled_action_response import ScheduledActionResponse
|
||||
|
||||
scheduled_action_response = ScheduledActionResponse(
|
||||
id='3469b87d-48ca-439a-868f-2160001da8c1',
|
||||
created='2021-05-11T22:23:16Z',
|
||||
job_type='BACKUP',
|
||||
content=sailpoint.v2024.models.scheduled_action_response_content.ScheduledActionResponse_content(
|
||||
name = 'Daily Backup',
|
||||
backup_options = sailpoint.v2024.models.scheduled_action_response_content_backup_options.ScheduledActionResponse_content_backupOptions(
|
||||
include_types = [ROLE, IDENTITY_PROFILE],
|
||||
object_options = {SOURCE={includedNames=[Source1, Source2]}, ROLE={includedNames=[Admin Role, User Role]}}, ),
|
||||
source_backup_id = '5678b87d-48ca-439a-868f-2160001da8c2',
|
||||
source_tenant = 'tenant-name',
|
||||
draft_id = '9012b87d-48ca-439a-868f-2160001da8c3', ),
|
||||
start_time='2021-05-12T10:00Z',
|
||||
cron_string='0 0 12 * * ?',
|
||||
time_zone_id='America/Chicago'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
id: v2024-scheduled-action-response-content
|
||||
title: ScheduledActionResponseContent
|
||||
pagination_label: ScheduledActionResponseContent
|
||||
sidebar_label: ScheduledActionResponseContent
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ScheduledActionResponseContent', 'V2024ScheduledActionResponseContent']
|
||||
slug: /tools/sdk/python/v2024/models/scheduled-action-response-content
|
||||
tags: ['SDK', 'Software Development Kit', 'ScheduledActionResponseContent', 'V2024ScheduledActionResponseContent']
|
||||
---
|
||||
|
||||
# ScheduledActionResponseContent
|
||||
|
||||
Content details for the scheduled action.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | Name of the scheduled action (maximum 50 characters). | [optional]
|
||||
**backup_options** | [**ScheduledActionResponseContentBackupOptions**](scheduled-action-response-content-backup-options) | | [optional]
|
||||
**source_backup_id** | **str** | ID of the source backup. Required for CREATE_DRAFT jobs only. | [optional]
|
||||
**source_tenant** | **str** | Source tenant identifier. Required for CREATE_DRAFT jobs only. | [optional]
|
||||
**draft_id** | **str** | ID of the draft to be deployed. Required for CONFIG_DEPLOY_DRAFT jobs only. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.scheduled_action_response_content import ScheduledActionResponseContent
|
||||
|
||||
scheduled_action_response_content = ScheduledActionResponseContent(
|
||||
name='Daily Backup',
|
||||
backup_options=sailpoint.v2024.models.scheduled_action_response_content_backup_options.ScheduledActionResponse_content_backupOptions(
|
||||
include_types = [ROLE, IDENTITY_PROFILE],
|
||||
object_options = {SOURCE={includedNames=[Source1, Source2]}, ROLE={includedNames=[Admin Role, User Role]}}, ),
|
||||
source_backup_id='5678b87d-48ca-439a-868f-2160001da8c2',
|
||||
source_tenant='tenant-name',
|
||||
draft_id='9012b87d-48ca-439a-868f-2160001da8c3'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,36 @@
|
||||
---
|
||||
id: v2024-scheduled-action-response-content-backup-options
|
||||
title: ScheduledActionResponseContentBackupOptions
|
||||
pagination_label: ScheduledActionResponseContentBackupOptions
|
||||
sidebar_label: ScheduledActionResponseContentBackupOptions
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ScheduledActionResponseContentBackupOptions', 'V2024ScheduledActionResponseContentBackupOptions']
|
||||
slug: /tools/sdk/python/v2024/models/scheduled-action-response-content-backup-options
|
||||
tags: ['SDK', 'Software Development Kit', 'ScheduledActionResponseContentBackupOptions', 'V2024ScheduledActionResponseContentBackupOptions']
|
||||
---
|
||||
|
||||
# ScheduledActionResponseContentBackupOptions
|
||||
|
||||
Options for BACKUP type jobs. Optional, applicable for BACKUP jobs only.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**include_types** | **[]str** | Object types that are to be included in the backup. | [optional]
|
||||
**object_options** | [**map[string]ScheduledActionResponseContentBackupOptionsObjectOptionsValue**](scheduled-action-response-content-backup-options-object-options-value) | Map of objectType string to the options to be passed to the target service for that objectType. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.scheduled_action_response_content_backup_options import ScheduledActionResponseContentBackupOptions
|
||||
|
||||
scheduled_action_response_content_backup_options = ScheduledActionResponseContentBackupOptions(
|
||||
include_types=[ROLE, IDENTITY_PROFILE],
|
||||
object_options={SOURCE={includedNames=[Source1, Source2]}, ROLE={includedNames=[Admin Role, User Role]}}
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
---
|
||||
id: v2024-scheduled-action-response-content-backup-options-object-options-value
|
||||
title: ScheduledActionResponseContentBackupOptionsObjectOptionsValue
|
||||
pagination_label: ScheduledActionResponseContentBackupOptionsObjectOptionsValue
|
||||
sidebar_label: ScheduledActionResponseContentBackupOptionsObjectOptionsValue
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ScheduledActionResponseContentBackupOptionsObjectOptionsValue', 'V2024ScheduledActionResponseContentBackupOptionsObjectOptionsValue']
|
||||
slug: /tools/sdk/python/v2024/models/scheduled-action-response-content-backup-options-object-options-value
|
||||
tags: ['SDK', 'Software Development Kit', 'ScheduledActionResponseContentBackupOptionsObjectOptionsValue', 'V2024ScheduledActionResponseContentBackupOptionsObjectOptionsValue']
|
||||
---
|
||||
|
||||
# ScheduledActionResponseContentBackupOptionsObjectOptionsValue
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**included_names** | **[]str** | Set of names to be included. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.scheduled_action_response_content_backup_options_object_options_value import ScheduledActionResponseContentBackupOptionsObjectOptionsValue
|
||||
|
||||
scheduled_action_response_content_backup_options_object_options_value = ScheduledActionResponseContentBackupOptionsObjectOptionsValue(
|
||||
included_names=[Admin Role, User Role]
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
Reference in New Issue
Block a user