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
@@ -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