mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 12:27:47 +00:00
Update to powershell SDK docs: 14068083503
This commit is contained in:
@@ -31,10 +31,12 @@ Method | HTTP request | Description
|
|||||||
[**New-V2024Deploy**](#create-deploy) | **POST** `/configuration-hub/deploys` | Create a Deploy
|
[**New-V2024Deploy**](#create-deploy) | **POST** `/configuration-hub/deploys` | Create a Deploy
|
||||||
[**New-V2024ObjectMapping**](#create-object-mapping) | **POST** `/configuration-hub/object-mappings/{sourceOrg}` | Creates an object mapping
|
[**New-V2024ObjectMapping**](#create-object-mapping) | **POST** `/configuration-hub/object-mappings/{sourceOrg}` | Creates an object mapping
|
||||||
[**New-V2024ObjectMappings**](#create-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-create` | Bulk creates object mappings
|
[**New-V2024ObjectMappings**](#create-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-create` | Bulk creates object mappings
|
||||||
|
[**New-V2024ScheduledAction**](#create-scheduled-action) | **POST** `/configuration-hub/scheduled-actions` | Create Scheduled Action
|
||||||
[**New-V2024UploadedConfiguration**](#create-uploaded-configuration) | **POST** `/configuration-hub/backups/uploads` | Upload a Configuration
|
[**New-V2024UploadedConfiguration**](#create-uploaded-configuration) | **POST** `/configuration-hub/backups/uploads` | Upload a Configuration
|
||||||
[**Remove-V2024Backup**](#delete-backup) | **DELETE** `/configuration-hub/backups/{id}` | Delete a Backup
|
[**Remove-V2024Backup**](#delete-backup) | **DELETE** `/configuration-hub/backups/{id}` | Delete a Backup
|
||||||
[**Remove-V2024Draft**](#delete-draft) | **DELETE** `/configuration-hub/drafts/{id}` | Delete a draft
|
[**Remove-V2024Draft**](#delete-draft) | **DELETE** `/configuration-hub/drafts/{id}` | Delete a draft
|
||||||
[**Remove-V2024ObjectMapping**](#delete-object-mapping) | **DELETE** `/configuration-hub/object-mappings/{sourceOrg}/{objectMappingId}` | Deletes an object mapping
|
[**Remove-V2024ObjectMapping**](#delete-object-mapping) | **DELETE** `/configuration-hub/object-mappings/{sourceOrg}/{objectMappingId}` | Deletes an object mapping
|
||||||
|
[**Remove-V2024ScheduledAction**](#delete-scheduled-action) | **DELETE** `/configuration-hub/scheduled-actions/{id}` | Delete Scheduled Action
|
||||||
[**Remove-V2024UploadedConfiguration**](#delete-uploaded-configuration) | **DELETE** `/configuration-hub/backups/uploads/{id}` | Delete an Uploaded Configuration
|
[**Remove-V2024UploadedConfiguration**](#delete-uploaded-configuration) | **DELETE** `/configuration-hub/backups/uploads/{id}` | Delete an Uploaded Configuration
|
||||||
[**Get-V2024Deploy**](#get-deploy) | **GET** `/configuration-hub/deploys/{id}` | Get a Deploy
|
[**Get-V2024Deploy**](#get-deploy) | **GET** `/configuration-hub/deploys/{id}` | Get a Deploy
|
||||||
[**Get-V2024ObjectMappings**](#get-object-mappings) | **GET** `/configuration-hub/object-mappings/{sourceOrg}` | Gets list of object mappings
|
[**Get-V2024ObjectMappings**](#get-object-mappings) | **GET** `/configuration-hub/object-mappings/{sourceOrg}` | Gets list of object mappings
|
||||||
@@ -42,8 +44,10 @@ Method | HTTP request | Description
|
|||||||
[**Get-V2024Backups**](#list-backups) | **GET** `/configuration-hub/backups` | List Backups
|
[**Get-V2024Backups**](#list-backups) | **GET** `/configuration-hub/backups` | List Backups
|
||||||
[**Get-V2024Deploys**](#list-deploys) | **GET** `/configuration-hub/deploys` | List Deploys
|
[**Get-V2024Deploys**](#list-deploys) | **GET** `/configuration-hub/deploys` | List Deploys
|
||||||
[**Get-V2024Drafts**](#list-drafts) | **GET** `/configuration-hub/drafts` | List Drafts
|
[**Get-V2024Drafts**](#list-drafts) | **GET** `/configuration-hub/drafts` | List Drafts
|
||||||
|
[**Get-V2024ScheduledActions**](#list-scheduled-actions) | **GET** `/configuration-hub/scheduled-actions` | List Scheduled Actions
|
||||||
[**Get-V2024UploadedConfigurations**](#list-uploaded-configurations) | **GET** `/configuration-hub/backups/uploads` | List Uploaded Configurations
|
[**Get-V2024UploadedConfigurations**](#list-uploaded-configurations) | **GET** `/configuration-hub/backups/uploads` | List Uploaded Configurations
|
||||||
[**Update-V2024ObjectMappings**](#update-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-patch` | Bulk updates object mappings
|
[**Update-V2024ObjectMappings**](#update-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-patch` | Bulk updates object mappings
|
||||||
|
[**Update-V2024ScheduledAction**](#update-scheduled-action) | **PATCH** `/configuration-hub/scheduled-actions/{id}` | Update Scheduled Action
|
||||||
|
|
||||||
|
|
||||||
## create-deploy
|
## create-deploy
|
||||||
@@ -218,6 +222,74 @@ try {
|
|||||||
```
|
```
|
||||||
[[Back to top]](#)
|
[[Back to top]](#)
|
||||||
|
|
||||||
|
## 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 | ScheduledActionPayload | [**ScheduledActionPayload**](../models/scheduled-action-payload) | True | The scheduled action creation request body.
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
[**ScheduledActionResponse**](../models/scheduled-action-response)
|
||||||
|
|
||||||
|
### Responses
|
||||||
|
Code | Description | Data Type
|
||||||
|
------------- | ------------- | -------------
|
||||||
|
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
|
||||||
|
```powershell
|
||||||
|
$ScheduledActionPayload = @"{
|
||||||
|
"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"
|
||||||
|
}
|
||||||
|
}"@
|
||||||
|
|
||||||
|
# Create Scheduled Action
|
||||||
|
|
||||||
|
try {
|
||||||
|
$Result = ConvertFrom-JsonToScheduledActionPayload -Json $ScheduledActionPayload
|
||||||
|
New-V2024ScheduledAction -ScheduledActionPayload $Result
|
||||||
|
|
||||||
|
# Below is a request that includes all optional parameters
|
||||||
|
# New-V2024ScheduledAction -ScheduledActionPayload $Result
|
||||||
|
} catch {
|
||||||
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ScheduledAction"
|
||||||
|
Write-Host $_.ErrorDetails
|
||||||
|
}
|
||||||
|
```
|
||||||
|
[[Back to top]](#)
|
||||||
|
|
||||||
## create-uploaded-configuration
|
## create-uploaded-configuration
|
||||||
This API uploads a JSON configuration file into a tenant.
|
This API uploads a JSON configuration file into a tenant.
|
||||||
|
|
||||||
@@ -420,6 +492,52 @@ try {
|
|||||||
```
|
```
|
||||||
[[Back to top]](#)
|
[[Back to top]](#)
|
||||||
|
|
||||||
|
## 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 | ScheduledActionId | **String** | True | The ID of the scheduled action.
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
(empty response body)
|
||||||
|
|
||||||
|
### Responses
|
||||||
|
Code | Description | Data Type
|
||||||
|
------------- | ------------- | -------------
|
||||||
|
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
|
||||||
|
```powershell
|
||||||
|
$ScheduledActionId = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the scheduled action.
|
||||||
|
|
||||||
|
# Delete Scheduled Action
|
||||||
|
|
||||||
|
try {
|
||||||
|
Remove-V2024ScheduledAction -ScheduledActionId $ScheduledActionId
|
||||||
|
|
||||||
|
# Below is a request that includes all optional parameters
|
||||||
|
# Remove-V2024ScheduledAction -ScheduledActionId $ScheduledActionId
|
||||||
|
} catch {
|
||||||
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ScheduledAction"
|
||||||
|
Write-Host $_.ErrorDetails
|
||||||
|
}
|
||||||
|
```
|
||||||
|
[[Back to top]](#)
|
||||||
|
|
||||||
## delete-uploaded-configuration
|
## delete-uploaded-configuration
|
||||||
This API deletes an uploaded configuration based on Id.
|
This API deletes an uploaded configuration based on Id.
|
||||||
|
|
||||||
@@ -744,6 +862,49 @@ try {
|
|||||||
```
|
```
|
||||||
[[Back to top]](#)
|
[[Back to top]](#)
|
||||||
|
|
||||||
|
## 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
|
||||||
|
Param Type | Name | Data Type | Required | Description
|
||||||
|
------------- | ------------- | ------------- | ------------- | -------------
|
||||||
|
|
||||||
|
### Return type
|
||||||
|
[**ScheduledActionResponse[]**](../models/scheduled-action-response)
|
||||||
|
|
||||||
|
### Responses
|
||||||
|
Code | Description | Data Type
|
||||||
|
------------- | ------------- | -------------
|
||||||
|
200 | List of existing scheduled actions. | 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
|
||||||
|
```powershell
|
||||||
|
|
||||||
|
# List Scheduled Actions
|
||||||
|
|
||||||
|
try {
|
||||||
|
Get-V2024ScheduledActions
|
||||||
|
|
||||||
|
# Below is a request that includes all optional parameters
|
||||||
|
# Get-V2024ScheduledActions
|
||||||
|
} catch {
|
||||||
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledActions"
|
||||||
|
Write-Host $_.ErrorDetails
|
||||||
|
}
|
||||||
|
```
|
||||||
|
[[Back to top]](#)
|
||||||
|
|
||||||
## list-uploaded-configurations
|
## list-uploaded-configurations
|
||||||
This API gets a list of existing uploaded configurations for the current tenant.
|
This API gets a list of existing uploaded configurations for the current tenant.
|
||||||
|
|
||||||
@@ -854,3 +1015,62 @@ try {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
[[Back to top]](#)
|
[[Back to top]](#)
|
||||||
|
|
||||||
|
## 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 | ScheduledActionId | **String** | True | The ID of the scheduled action.
|
||||||
|
Body | JsonPatch | [**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
|
||||||
|
------------- | ------------- | -------------
|
||||||
|
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
|
||||||
|
```powershell
|
||||||
|
$ScheduledActionId = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the scheduled action.
|
||||||
|
$JsonPatch = @"{
|
||||||
|
"operations" : [ {
|
||||||
|
"op" : "replace",
|
||||||
|
"path" : "/description",
|
||||||
|
"value" : "New description"
|
||||||
|
}, {
|
||||||
|
"op" : "replace",
|
||||||
|
"path" : "/description",
|
||||||
|
"value" : "New description"
|
||||||
|
} ]
|
||||||
|
}"@
|
||||||
|
|
||||||
|
# Update Scheduled Action
|
||||||
|
|
||||||
|
try {
|
||||||
|
$Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch
|
||||||
|
Update-V2024ScheduledAction -ScheduledActionId $ScheduledActionId -JsonPatch $Result
|
||||||
|
|
||||||
|
# Below is a request that includes all optional parameters
|
||||||
|
# Update-V2024ScheduledAction -ScheduledActionId $ScheduledActionId -JsonPatch $Result
|
||||||
|
} catch {
|
||||||
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ScheduledAction"
|
||||||
|
Write-Host $_.ErrorDetails
|
||||||
|
}
|
||||||
|
```
|
||||||
|
[[Back to top]](#)
|
||||||
|
|||||||
@@ -0,0 +1,43 @@
|
|||||||
|
---
|
||||||
|
id: v2024-scheduled-action-payload
|
||||||
|
title: ScheduledActionPayload
|
||||||
|
pagination_label: ScheduledActionPayload
|
||||||
|
sidebar_label: ScheduledActionPayload
|
||||||
|
sidebar_class_name: powershellsdk
|
||||||
|
keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledActionPayload', 'V2024ScheduledActionPayload']
|
||||||
|
slug: /tools/sdk/powershell/v2024/models/scheduled-action-payload
|
||||||
|
tags: ['SDK', 'Software Development Kit', 'ScheduledActionPayload', 'V2024ScheduledActionPayload']
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
|
# ScheduledActionPayload
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**JobType** | **Enum** [ "BACKUP", "CREATE_DRAFT", "CONFIG_DEPLOY_DRAFT" ] | Type of the scheduled job. | [required]
|
||||||
|
**StartTime** | **System.DateTime** | The time when this scheduled action should start. Optional. | [optional]
|
||||||
|
**CronString** | **String** | Cron expression defining the schedule for this action. Optional for repeated events. | [optional]
|
||||||
|
**TimeZoneId** | **String** | Time zone ID for interpreting the cron expression. Optional, will default to current time zone. | [optional]
|
||||||
|
**Content** | [**ScheduledActionPayloadContent**](scheduled-action-payload-content) | | [required]
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
- Prepare the resource
|
||||||
|
```powershell
|
||||||
|
$ScheduledActionPayload = Initialize-PSSailpoint.V2024ScheduledActionPayload -JobType BACKUP `
|
||||||
|
-StartTime 2024-08-16T14:16:58.389Z `
|
||||||
|
-CronString 0 0 12 * * ? `
|
||||||
|
-TimeZoneId America/Chicago `
|
||||||
|
-Content null
|
||||||
|
```
|
||||||
|
|
||||||
|
- Convert the resource to JSON
|
||||||
|
```powershell
|
||||||
|
$ScheduledActionPayload | ConvertTo-JSON
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
[[Back to top]](#)
|
||||||
|
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
---
|
||||||
|
id: v2024-scheduled-action-payload-content
|
||||||
|
title: ScheduledActionPayloadContent
|
||||||
|
pagination_label: ScheduledActionPayloadContent
|
||||||
|
sidebar_label: ScheduledActionPayloadContent
|
||||||
|
sidebar_class_name: powershellsdk
|
||||||
|
keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledActionPayloadContent', 'V2024ScheduledActionPayloadContent']
|
||||||
|
slug: /tools/sdk/powershell/v2024/models/scheduled-action-payload-content
|
||||||
|
tags: ['SDK', 'Software Development Kit', 'ScheduledActionPayloadContent', 'V2024ScheduledActionPayloadContent']
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
|
# ScheduledActionPayloadContent
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**Name** | **String** | Name of the scheduled action (maximum 50 characters). | [required]
|
||||||
|
**BackupOptions** | [**ScheduledActionPayloadContentBackupOptions**](scheduled-action-payload-content-backup-options) | | [optional]
|
||||||
|
**SourceBackupId** | **String** | ID of the source backup. Required for CREATE_DRAFT jobs. | [optional]
|
||||||
|
**SourceTenant** | **String** | Source tenant identifier. Required for CREATE_DRAFT jobs. | [optional]
|
||||||
|
**DraftId** | **String** | ID of the draft to be deployed. Required for CONFIG_DEPLOY_DRAFT jobs. | [optional]
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
- Prepare the resource
|
||||||
|
```powershell
|
||||||
|
$ScheduledActionPayloadContent = Initialize-PSSailpoint.V2024ScheduledActionPayloadContent -Name Daily Backup `
|
||||||
|
-BackupOptions null `
|
||||||
|
-SourceBackupId 5678b87d-48ca-439a-868f-2160001da8c2 `
|
||||||
|
-SourceTenant tenant-name `
|
||||||
|
-DraftId 9012b87d-48ca-439a-868f-2160001da8c3
|
||||||
|
```
|
||||||
|
|
||||||
|
- Convert the resource to JSON
|
||||||
|
```powershell
|
||||||
|
$ScheduledActionPayloadContent | ConvertTo-JSON
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
[[Back to top]](#)
|
||||||
|
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
---
|
||||||
|
id: v2024-scheduled-action-payload-content-backup-options
|
||||||
|
title: ScheduledActionPayloadContentBackupOptions
|
||||||
|
pagination_label: ScheduledActionPayloadContentBackupOptions
|
||||||
|
sidebar_label: ScheduledActionPayloadContentBackupOptions
|
||||||
|
sidebar_class_name: powershellsdk
|
||||||
|
keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledActionPayloadContentBackupOptions', 'V2024ScheduledActionPayloadContentBackupOptions']
|
||||||
|
slug: /tools/sdk/powershell/v2024/models/scheduled-action-payload-content-backup-options
|
||||||
|
tags: ['SDK', 'Software Development Kit', 'ScheduledActionPayloadContentBackupOptions', 'V2024ScheduledActionPayloadContentBackupOptions']
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
|
# ScheduledActionPayloadContentBackupOptions
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**IncludeTypes** | **[]String** | Object types that are to be included in the backup. | [optional]
|
||||||
|
**ObjectOptions** | [**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]
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
- Prepare the resource
|
||||||
|
```powershell
|
||||||
|
$ScheduledActionPayloadContentBackupOptions = Initialize-PSSailpoint.V2024ScheduledActionPayloadContentBackupOptions -IncludeTypes [ROLE, IDENTITY_PROFILE] `
|
||||||
|
-ObjectOptions {SOURCE={includedNames=[Source1, Source2]}, ROLE={includedNames=[Admin Role, User Role]}}
|
||||||
|
```
|
||||||
|
|
||||||
|
- Convert the resource to JSON
|
||||||
|
```powershell
|
||||||
|
$ScheduledActionPayloadContentBackupOptions | ConvertTo-JSON
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
[[Back to top]](#)
|
||||||
|
|
||||||
@@ -0,0 +1,47 @@
|
|||||||
|
---
|
||||||
|
id: v2024-scheduled-action-response
|
||||||
|
title: ScheduledActionResponse
|
||||||
|
pagination_label: ScheduledActionResponse
|
||||||
|
sidebar_label: ScheduledActionResponse
|
||||||
|
sidebar_class_name: powershellsdk
|
||||||
|
keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledActionResponse', 'V2024ScheduledActionResponse']
|
||||||
|
slug: /tools/sdk/powershell/v2024/models/scheduled-action-response
|
||||||
|
tags: ['SDK', 'Software Development Kit', 'ScheduledActionResponse', 'V2024ScheduledActionResponse']
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
|
# ScheduledActionResponse
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**Id** | **String** | Unique identifier for this scheduled action. | [optional]
|
||||||
|
**Created** | **System.DateTime** | The time when this scheduled action was created. | [optional]
|
||||||
|
**JobType** | **Enum** [ "BACKUP", "CREATE_DRAFT", "CONFIG_DEPLOY_DRAFT" ] | Type of the scheduled job. | [optional]
|
||||||
|
**Content** | [**ScheduledActionResponseContent**](scheduled-action-response-content) | | [optional]
|
||||||
|
**StartTime** | **System.DateTime** | The time when this scheduled action should start. | [optional]
|
||||||
|
**CronString** | **String** | Cron expression defining the schedule for this action. | [optional]
|
||||||
|
**TimeZoneId** | **String** | Time zone ID for interpreting the cron expression. | [optional]
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
- Prepare the resource
|
||||||
|
```powershell
|
||||||
|
$ScheduledActionResponse = Initialize-PSSailpoint.V2024ScheduledActionResponse -Id 3469b87d-48ca-439a-868f-2160001da8c1 `
|
||||||
|
-Created 2021-05-11T22:23:16Z `
|
||||||
|
-JobType BACKUP `
|
||||||
|
-Content null `
|
||||||
|
-StartTime 2021-05-12T10:00Z `
|
||||||
|
-CronString 0 0 12 * * ? `
|
||||||
|
-TimeZoneId America/Chicago
|
||||||
|
```
|
||||||
|
|
||||||
|
- Convert the resource to JSON
|
||||||
|
```powershell
|
||||||
|
$ScheduledActionResponse | ConvertTo-JSON
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
[[Back to top]](#)
|
||||||
|
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
---
|
||||||
|
id: v2024-scheduled-action-response-content
|
||||||
|
title: ScheduledActionResponseContent
|
||||||
|
pagination_label: ScheduledActionResponseContent
|
||||||
|
sidebar_label: ScheduledActionResponseContent
|
||||||
|
sidebar_class_name: powershellsdk
|
||||||
|
keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledActionResponseContent', 'V2024ScheduledActionResponseContent']
|
||||||
|
slug: /tools/sdk/powershell/v2024/models/scheduled-action-response-content
|
||||||
|
tags: ['SDK', 'Software Development Kit', 'ScheduledActionResponseContent', 'V2024ScheduledActionResponseContent']
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
|
# ScheduledActionResponseContent
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**Name** | **String** | Name of the scheduled action (maximum 50 characters). | [optional]
|
||||||
|
**BackupOptions** | [**ScheduledActionResponseContentBackupOptions**](scheduled-action-response-content-backup-options) | | [optional]
|
||||||
|
**SourceBackupId** | **String** | ID of the source backup. Required for CREATE_DRAFT jobs only. | [optional]
|
||||||
|
**SourceTenant** | **String** | Source tenant identifier. Required for CREATE_DRAFT jobs only. | [optional]
|
||||||
|
**DraftId** | **String** | ID of the draft to be deployed. Required for CONFIG_DEPLOY_DRAFT jobs only. | [optional]
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
- Prepare the resource
|
||||||
|
```powershell
|
||||||
|
$ScheduledActionResponseContent = Initialize-PSSailpoint.V2024ScheduledActionResponseContent -Name Daily Backup `
|
||||||
|
-BackupOptions null `
|
||||||
|
-SourceBackupId 5678b87d-48ca-439a-868f-2160001da8c2 `
|
||||||
|
-SourceTenant tenant-name `
|
||||||
|
-DraftId 9012b87d-48ca-439a-868f-2160001da8c3
|
||||||
|
```
|
||||||
|
|
||||||
|
- Convert the resource to JSON
|
||||||
|
```powershell
|
||||||
|
$ScheduledActionResponseContent | ConvertTo-JSON
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
[[Back to top]](#)
|
||||||
|
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
---
|
||||||
|
id: v2024-scheduled-action-response-content-backup-options
|
||||||
|
title: ScheduledActionResponseContentBackupOptions
|
||||||
|
pagination_label: ScheduledActionResponseContentBackupOptions
|
||||||
|
sidebar_label: ScheduledActionResponseContentBackupOptions
|
||||||
|
sidebar_class_name: powershellsdk
|
||||||
|
keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledActionResponseContentBackupOptions', 'V2024ScheduledActionResponseContentBackupOptions']
|
||||||
|
slug: /tools/sdk/powershell/v2024/models/scheduled-action-response-content-backup-options
|
||||||
|
tags: ['SDK', 'Software Development Kit', 'ScheduledActionResponseContentBackupOptions', 'V2024ScheduledActionResponseContentBackupOptions']
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
|
# ScheduledActionResponseContentBackupOptions
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**IncludeTypes** | **[]String** | Object types that are to be included in the backup. | [optional]
|
||||||
|
**ObjectOptions** | [**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]
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
- Prepare the resource
|
||||||
|
```powershell
|
||||||
|
$ScheduledActionResponseContentBackupOptions = Initialize-PSSailpoint.V2024ScheduledActionResponseContentBackupOptions -IncludeTypes [ROLE, IDENTITY_PROFILE] `
|
||||||
|
-ObjectOptions {SOURCE={includedNames=[Source1, Source2]}, ROLE={includedNames=[Admin Role, User Role]}}
|
||||||
|
```
|
||||||
|
|
||||||
|
- Convert the resource to JSON
|
||||||
|
```powershell
|
||||||
|
$ScheduledActionResponseContentBackupOptions | ConvertTo-JSON
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
[[Back to top]](#)
|
||||||
|
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
---
|
||||||
|
id: v2024-scheduled-action-response-content-backup-options-object-options-value
|
||||||
|
title: ScheduledActionResponseContentBackupOptionsObjectOptionsValue
|
||||||
|
pagination_label: ScheduledActionResponseContentBackupOptionsObjectOptionsValue
|
||||||
|
sidebar_label: ScheduledActionResponseContentBackupOptionsObjectOptionsValue
|
||||||
|
sidebar_class_name: powershellsdk
|
||||||
|
keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledActionResponseContentBackupOptionsObjectOptionsValue', 'V2024ScheduledActionResponseContentBackupOptionsObjectOptionsValue']
|
||||||
|
slug: /tools/sdk/powershell/v2024/models/scheduled-action-response-content-backup-options-object-options-value
|
||||||
|
tags: ['SDK', 'Software Development Kit', 'ScheduledActionResponseContentBackupOptionsObjectOptionsValue', 'V2024ScheduledActionResponseContentBackupOptionsObjectOptionsValue']
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
|
# ScheduledActionResponseContentBackupOptionsObjectOptionsValue
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Name | Type | Description | Notes
|
||||||
|
------------ | ------------- | ------------- | -------------
|
||||||
|
**IncludedNames** | **[]String** | Set of names to be included. | [optional]
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
- Prepare the resource
|
||||||
|
```powershell
|
||||||
|
$ScheduledActionResponseContentBackupOptionsObjectOptionsValue = Initialize-PSSailpoint.V2024ScheduledActionResponseContentBackupOptionsObjectOptionsValue -IncludedNames [Admin Role, User Role]
|
||||||
|
```
|
||||||
|
|
||||||
|
- Convert the resource to JSON
|
||||||
|
```powershell
|
||||||
|
$ScheduledActionResponseContentBackupOptionsObjectOptionsValue | ConvertTo-JSON
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
[[Back to top]](#)
|
||||||
|
|
||||||
@@ -3307,6 +3307,50 @@
|
|||||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMappings"
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMappings"
|
||||||
Write-Host $_.ErrorDetails
|
Write-Host $_.ErrorDetails
|
||||||
}
|
}
|
||||||
|
- path: /configuration-hub/scheduled-actions
|
||||||
|
method: POST
|
||||||
|
xCodeSample:
|
||||||
|
- lang: PowerShell
|
||||||
|
label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#create-scheduled-action
|
||||||
|
source: |
|
||||||
|
$ScheduledActionPayload = @"
|
||||||
|
{
|
||||||
|
"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"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
"@
|
||||||
|
|
||||||
|
# Create Scheduled Action
|
||||||
|
|
||||||
|
try {
|
||||||
|
$Result = ConvertFrom-JsonToScheduledActionPayload -Json $ScheduledActionPayload
|
||||||
|
New-V2024ScheduledAction -ScheduledActionPayload $Result
|
||||||
|
|
||||||
|
# Below is a request that includes all optional parameters
|
||||||
|
# New-V2024ScheduledAction -ScheduledActionPayload $Result
|
||||||
|
} catch {
|
||||||
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ScheduledAction"
|
||||||
|
Write-Host $_.ErrorDetails
|
||||||
|
}
|
||||||
- path: /configuration-hub/backups/uploads
|
- path: /configuration-hub/backups/uploads
|
||||||
method: POST
|
method: POST
|
||||||
xCodeSample:
|
xCodeSample:
|
||||||
@@ -3385,6 +3429,25 @@
|
|||||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ObjectMapping"
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ObjectMapping"
|
||||||
Write-Host $_.ErrorDetails
|
Write-Host $_.ErrorDetails
|
||||||
}
|
}
|
||||||
|
- path: /configuration-hub/scheduled-actions/{id}
|
||||||
|
method: DELETE
|
||||||
|
xCodeSample:
|
||||||
|
- lang: PowerShell
|
||||||
|
label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#delete-scheduled-action
|
||||||
|
source: |
|
||||||
|
$ScheduledActionId = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the scheduled action.
|
||||||
|
|
||||||
|
# Delete Scheduled Action
|
||||||
|
|
||||||
|
try {
|
||||||
|
Remove-V2024ScheduledAction -ScheduledActionId $ScheduledActionId
|
||||||
|
|
||||||
|
# Below is a request that includes all optional parameters
|
||||||
|
# Remove-V2024ScheduledAction -ScheduledActionId $ScheduledActionId
|
||||||
|
} catch {
|
||||||
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ScheduledAction"
|
||||||
|
Write-Host $_.ErrorDetails
|
||||||
|
}
|
||||||
- path: /configuration-hub/backups/uploads/{id}
|
- path: /configuration-hub/backups/uploads/{id}
|
||||||
method: DELETE
|
method: DELETE
|
||||||
xCodeSample:
|
xCodeSample:
|
||||||
@@ -3517,6 +3580,24 @@
|
|||||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Drafts"
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Drafts"
|
||||||
Write-Host $_.ErrorDetails
|
Write-Host $_.ErrorDetails
|
||||||
}
|
}
|
||||||
|
- path: /configuration-hub/scheduled-actions
|
||||||
|
method: GET
|
||||||
|
xCodeSample:
|
||||||
|
- lang: PowerShell
|
||||||
|
label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#list-scheduled-actions
|
||||||
|
source: |
|
||||||
|
|
||||||
|
# List Scheduled Actions
|
||||||
|
|
||||||
|
try {
|
||||||
|
Get-V2024ScheduledActions
|
||||||
|
|
||||||
|
# Below is a request that includes all optional parameters
|
||||||
|
# Get-V2024ScheduledActions
|
||||||
|
} catch {
|
||||||
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledActions"
|
||||||
|
Write-Host $_.ErrorDetails
|
||||||
|
}
|
||||||
- path: /configuration-hub/backups/uploads
|
- path: /configuration-hub/backups/uploads
|
||||||
method: GET
|
method: GET
|
||||||
xCodeSample:
|
xCodeSample:
|
||||||
@@ -3572,6 +3653,39 @@
|
|||||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ObjectMappings"
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ObjectMappings"
|
||||||
Write-Host $_.ErrorDetails
|
Write-Host $_.ErrorDetails
|
||||||
}
|
}
|
||||||
|
- path: /configuration-hub/scheduled-actions/{id}
|
||||||
|
method: PATCH
|
||||||
|
xCodeSample:
|
||||||
|
- lang: PowerShell
|
||||||
|
label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#update-scheduled-action
|
||||||
|
source: |
|
||||||
|
$ScheduledActionId = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the scheduled action.
|
||||||
|
$JsonPatch = @"
|
||||||
|
{
|
||||||
|
"operations" : [ {
|
||||||
|
"op" : "replace",
|
||||||
|
"path" : "/description",
|
||||||
|
"value" : "New description"
|
||||||
|
}, {
|
||||||
|
"op" : "replace",
|
||||||
|
"path" : "/description",
|
||||||
|
"value" : "New description"
|
||||||
|
} ]
|
||||||
|
}
|
||||||
|
"@
|
||||||
|
|
||||||
|
# Update Scheduled Action
|
||||||
|
|
||||||
|
try {
|
||||||
|
$Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch
|
||||||
|
Update-V2024ScheduledAction -ScheduledActionId $ScheduledActionId -JsonPatch $Result
|
||||||
|
|
||||||
|
# Below is a request that includes all optional parameters
|
||||||
|
# Update-V2024ScheduledAction -ScheduledActionId $ScheduledActionId -JsonPatch $Result
|
||||||
|
} catch {
|
||||||
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ScheduledAction"
|
||||||
|
Write-Host $_.ErrorDetails
|
||||||
|
}
|
||||||
- path: /connector-rules
|
- path: /connector-rules
|
||||||
method: POST
|
method: POST
|
||||||
xCodeSample:
|
xCodeSample:
|
||||||
|
|||||||
Reference in New Issue
Block a user