mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 12:27:47 +00:00
Update PowerShell SDK docs: 16205707489
This commit is contained in:
developer-relations-sp
@@ -197,9 +197,6 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## close-access-request
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request's lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/).
|
||||
|
||||
To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND "Access Request". Use the Column Chooser to select 'Tracking Number', and use the 'Download' button to export a CSV containing the tracking numbers.
|
||||
@@ -218,7 +215,6 @@ This API triggers the [Provisioning Completed event trigger](https://developer.s
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
Body | CloseAccessRequest | [**CloseAccessRequest**](../models/close-access-request) | True |
|
||||
|
||||
### Return type
|
||||
@@ -240,7 +236,6 @@ Code | Description | Data Type
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$CloseAccessRequest = @"{
|
||||
"executionStatus" : "Terminated",
|
||||
"accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ],
|
||||
@@ -252,10 +247,10 @@ $CloseAccessRequest = @"{
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest
|
||||
Close-V2024AccessRequest -XSailPointExperimental $XSailPointExperimental -CloseAccessRequest $Result
|
||||
Close-V2024AccessRequest -CloseAccessRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Close-V2024AccessRequest -XSailPointExperimental $XSailPointExperimental -CloseAccessRequest $Result
|
||||
# Close-V2024AccessRequest -CloseAccessRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-V2024AccessRequest"
|
||||
Write-Host $_.ErrorDetails
|
||||
|
||||
@@ -31,9 +31,6 @@ Method | HTTP request | Description
|
||||
|
||||
|
||||
## get-account-aggregation-status
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far.
|
||||
|
||||
Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not.
|
||||
@@ -49,7 +46,6 @@ required to call this API.
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | The account aggregation id
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**AccountAggregationStatus**](../models/account-aggregation-status)
|
||||
@@ -58,6 +54,7 @@ Path | Id | **String** | True | The account aggregation id
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | An account aggregation status object | AccountAggregationStatus
|
||||
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
|
||||
@@ -71,15 +68,14 @@ Code | Description | Data Type
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
|
||||
# In-progress account aggregation status
|
||||
|
||||
try {
|
||||
Get-V2024AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
Get-V2024AccountAggregationStatus -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2024AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
# Get-V2024AccountAggregationStatus -Id $Id
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountAggregationStatus"
|
||||
Write-Host $_.ErrorDetails
|
||||
|
||||
@@ -178,9 +178,6 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-account-async
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation.
|
||||
|
||||
This endpoint is good for:
|
||||
@@ -195,7 +192,6 @@ This endpoint is good for:
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | The account id
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**TaskResultDto**](../models/task-result-dto)
|
||||
@@ -217,15 +213,14 @@ Code | Description | Data Type
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
|
||||
# Remove account
|
||||
|
||||
try {
|
||||
Remove-V2024AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
Remove-V2024AccountAsync -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Remove-V2024AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
# Remove-V2024AccountAsync -Id $Id
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccountAsync"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -286,9 +281,6 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## disable-account-for-identity
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
This API submits a task to disable IDN account for a single identity.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/disable-account-for-identity)
|
||||
@@ -297,7 +289,6 @@ This API submits a task to disable IDN account for a single identity.
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | The identity id.
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
|
||||
@@ -320,15 +311,14 @@ Code | Description | Data Type
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "2c91808384203c2d018437e631158309" # String | The identity id.
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
|
||||
# Disable idn account for identity
|
||||
|
||||
try {
|
||||
Disable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
Disable-V2024AccountForIdentity -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Disable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
# Disable-V2024AccountForIdentity -Id $Id
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountForIdentity"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -337,9 +327,6 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## disable-accounts-for-identities
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
This API submits tasks to disable IDN account for each identity provided in the request body.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/disable-accounts-for-identities)
|
||||
@@ -347,7 +334,6 @@ This API submits tasks to disable IDN account for each identity provided in the
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
Body | IdentitiesAccountsBulkRequest | [**IdentitiesAccountsBulkRequest**](../models/identities-accounts-bulk-request) | True |
|
||||
|
||||
### Return type
|
||||
@@ -369,7 +355,6 @@ Code | Description | Data Type
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$IdentitiesAccountsBulkRequest = @"{
|
||||
"identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
|
||||
}"@
|
||||
@@ -378,10 +363,10 @@ $IdentitiesAccountsBulkRequest = @"{
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest
|
||||
Disable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result
|
||||
Disable-V2024AccountsForIdentities -IdentitiesAccountsBulkRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Disable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result
|
||||
# Disable-V2024AccountsForIdentities -IdentitiesAccountsBulkRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountsForIdentities"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -442,9 +427,6 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## enable-account-for-identity
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
This API submits a task to enable IDN account for a single identity.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/enable-account-for-identity)
|
||||
@@ -453,7 +435,6 @@ This API submits a task to enable IDN account for a single identity.
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | The identity id.
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
|
||||
@@ -476,15 +457,14 @@ Code | Description | Data Type
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "2c91808384203c2d018437e631158309" # String | The identity id.
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
|
||||
# Enable idn account for identity
|
||||
|
||||
try {
|
||||
Enable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
Enable-V2024AccountForIdentity -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Enable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
# Enable-V2024AccountForIdentity -Id $Id
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountForIdentity"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -493,9 +473,6 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## enable-accounts-for-identities
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
This API submits tasks to enable IDN account for each identity provided in the request body.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/enable-accounts-for-identities)
|
||||
@@ -503,7 +480,6 @@ This API submits tasks to enable IDN account for each identity provided in the r
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
Body | IdentitiesAccountsBulkRequest | [**IdentitiesAccountsBulkRequest**](../models/identities-accounts-bulk-request) | True |
|
||||
|
||||
### Return type
|
||||
@@ -525,7 +501,6 @@ Code | Description | Data Type
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$IdentitiesAccountsBulkRequest = @"{
|
||||
"identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
|
||||
}"@
|
||||
@@ -534,10 +509,10 @@ $IdentitiesAccountsBulkRequest = @"{
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest
|
||||
Enable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result
|
||||
Enable-V2024AccountsForIdentities -IdentitiesAccountsBulkRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Enable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result
|
||||
# Enable-V2024AccountsForIdentities -IdentitiesAccountsBulkRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountsForIdentities"
|
||||
Write-Host $_.ErrorDetails
|
||||
|
||||
@@ -78,7 +78,7 @@ Method | HTTP request | Description
|
||||
[**New-V2024Source**](#create-source) | **POST** `/sources` | Creates a source in identitynow.
|
||||
[**New-V2024SourceSchedule**](#create-source-schedule) | **POST** `/sources/{sourceId}/schedules` | Create schedule on source
|
||||
[**New-V2024SourceSchema**](#create-source-schema) | **POST** `/sources/{sourceId}/schemas` | Create schema on source
|
||||
[**Remove-V2024AccountsAsync**](#delete-accounts-async) | **POST** `/sources/{id}/remove-accounts` | Remove all accounts in a source
|
||||
[**Remove-V2024AccountsAsync**](#delete-accounts-async) | **POST** `/sources/{id}/remove-accounts` | Remove all accounts in source
|
||||
[**Remove-V2024NativeChangeDetectionConfig**](#delete-native-change-detection-config) | **DELETE** `/sources/{sourceId}/native-change-detection-config` | Delete native change detection configuration
|
||||
[**Remove-V2024ProvisioningPolicy**](#delete-provisioning-policy) | **DELETE** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete provisioning policy by usagetype
|
||||
[**Remove-V2024Source**](#delete-source) | **DELETE** `/sources/{id}` | Delete source by id
|
||||
@@ -479,9 +479,6 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-accounts-async
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation.
|
||||
|
||||
This endpoint is good for:
|
||||
@@ -496,7 +493,6 @@ This endpoint is good for:
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | The source id
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**TaskResultDto**](../models/task-result-dto)
|
||||
@@ -518,15 +514,14 @@ Code | Description | Data Type
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "ebbf35756e1140699ce52b233121384a" # String | The source id
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
|
||||
# Remove all accounts in a source
|
||||
# Remove all accounts in source
|
||||
|
||||
try {
|
||||
Remove-V2024AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
Remove-V2024AccountsAsync -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Remove-V2024AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
# Remove-V2024AccountsAsync -Id $Id
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccountsAsync"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -1500,9 +1495,6 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## import-accounts
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Starts an account aggregation on the specified source.
|
||||
If the target source is a delimited file source, then the CSV file needs to be included in the request body.
|
||||
You will also need to set the Content-Type header to `multipart/form-data`.
|
||||
@@ -1513,7 +1505,6 @@ You will also need to set the Content-Type header to `multipart/form-data`.
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | Source Id
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
| File | **System.IO.FileInfo** | (optional) | The CSV file containing the source accounts to aggregate.
|
||||
| DisableOptimization | **String** | (optional) | Use this flag to reprocess every account whether or not the data has changed.
|
||||
|
||||
@@ -1537,17 +1528,16 @@ Code | Description | Data Type
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional)
|
||||
$DisableOptimization = "MyDisableOptimization" # String | Use this flag to reprocess every account whether or not the data has changed. (optional)
|
||||
|
||||
# Account aggregation
|
||||
|
||||
try {
|
||||
Import-V2024Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
Import-V2024Accounts -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Import-V2024Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental -File $File -DisableOptimization $DisableOptimization
|
||||
# Import-V2024Accounts -Id $Id -File $File -DisableOptimization $DisableOptimization
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024Accounts"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -1766,9 +1756,6 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## import-uncorrelated-accounts
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
File is required for upload. You will also need to set the Content-Type header to `multipart/form-data`
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-uncorrelated-accounts)
|
||||
@@ -1777,7 +1764,6 @@ File is required for upload. You will also need to set the Content-Type header t
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | Source Id
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
| File | **System.IO.FileInfo** | (optional) |
|
||||
|
||||
### Return type
|
||||
@@ -1800,16 +1786,15 @@ Code | Description | Data Type
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "75dbec1ebe154d5785da27b95e1dd5d7" # String | Source Id
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$File = # System.IO.FileInfo | (optional)
|
||||
|
||||
# Process uncorrelated accounts
|
||||
|
||||
try {
|
||||
Import-V2024UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
Import-V2024UncorrelatedAccounts -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Import-V2024UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental -File $File
|
||||
# Import-V2024UncorrelatedAccounts -Id $Id -File $File
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024UncorrelatedAccounts"
|
||||
Write-Host $_.ErrorDetails
|
||||
|
||||
@@ -20,6 +20,10 @@ Name | Type | Description | Notes
|
||||
**Status** | **Enum** [ "STARTED", "ACCOUNTS_COLLECTED", "COMPLETED", "CANCELLED", "RETRIED", "TERMINATED", "NOT_FOUND" ] | STARTED - Aggregation started, but source account iteration has not completed. ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed. COMPLETED - Aggregation completed (*possibly with errors*). CANCELLED - Aggregation cancelled by user. RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance. TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance. | [optional]
|
||||
**TotalAccounts** | **Int32** | The total number of *NEW, CHANGED and DELETED* accounts that need to be processed for this aggregation. This does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no new, changed or deleted accounts since the previous aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
|
||||
**ProcessedAccounts** | **Int32** | The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
|
||||
**TotalAccountsMarkedForDeletion** | **Int32** | The total number of accounts that have been marked for deletion during the aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
|
||||
**DeletedAccounts** | **Int32** | The number of accounts that have been deleted during the aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
|
||||
**TotalIdentities** | **Int32** | The total number of unique identities that have been marked for refresh. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
|
||||
**ProcessedIdentities** | **Int32** | The number of unique identities that have been refreshed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -28,7 +32,11 @@ Name | Type | Description | Notes
|
||||
$AccountAggregationStatus = Initialize-V2024AccountAggregationStatus -Start 2021-01-31T14:30:05.104Z `
|
||||
-Status ACCOUNTS_COLLECTED `
|
||||
-TotalAccounts 520 `
|
||||
-ProcessedAccounts 150
|
||||
-ProcessedAccounts 150 `
|
||||
-TotalAccountsMarkedForDeletion 10 `
|
||||
-DeletedAccounts 5 `
|
||||
-TotalIdentities 300 `
|
||||
-ProcessedIdentities 250
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -198,9 +198,6 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## close-access-request
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request's lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/).
|
||||
|
||||
To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND "Access Request". Use the Column Chooser to select 'Tracking Number', and use the 'Download' button to export a CSV containing the tracking numbers.
|
||||
@@ -219,7 +216,6 @@ This API triggers the [Provisioning Completed event trigger](https://developer.s
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
Body | CloseAccessRequest | [**CloseAccessRequest**](../models/close-access-request) | True |
|
||||
|
||||
### Return type
|
||||
@@ -241,7 +237,6 @@ Code | Description | Data Type
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$CloseAccessRequest = @"{
|
||||
"executionStatus" : "Terminated",
|
||||
"accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ],
|
||||
@@ -253,10 +248,10 @@ $CloseAccessRequest = @"{
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest
|
||||
Close-V2025AccessRequest -XSailPointExperimental $XSailPointExperimental -CloseAccessRequest $Result
|
||||
Close-V2025AccessRequest -CloseAccessRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Close-V2025AccessRequest -XSailPointExperimental $XSailPointExperimental -CloseAccessRequest $Result
|
||||
# Close-V2025AccessRequest -CloseAccessRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-V2025AccessRequest"
|
||||
Write-Host $_.ErrorDetails
|
||||
|
||||
@@ -31,9 +31,6 @@ Method | HTTP request | Description
|
||||
|
||||
|
||||
## get-account-aggregation-status
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far.
|
||||
|
||||
Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not.
|
||||
@@ -49,7 +46,6 @@ required to call this API.
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | The account aggregation id
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**AccountAggregationStatus**](../models/account-aggregation-status)
|
||||
@@ -58,6 +54,7 @@ Path | Id | **String** | True | The account aggregation id
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | An account aggregation status object | AccountAggregationStatus
|
||||
400 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
|
||||
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
|
||||
@@ -71,15 +68,14 @@ Code | Description | Data Type
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
|
||||
# In-progress account aggregation status
|
||||
|
||||
try {
|
||||
Get-V2025AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
Get-V2025AccountAggregationStatus -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2025AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
# Get-V2025AccountAggregationStatus -Id $Id
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccountAggregationStatus"
|
||||
Write-Host $_.ErrorDetails
|
||||
|
||||
@@ -178,9 +178,6 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-account-async
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation.
|
||||
|
||||
This endpoint is good for:
|
||||
@@ -195,7 +192,6 @@ This endpoint is good for:
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | The account id
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**TaskResultDto**](../models/task-result-dto)
|
||||
@@ -217,15 +213,14 @@ Code | Description | Data Type
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
|
||||
# Remove account
|
||||
|
||||
try {
|
||||
Remove-V2025AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
Remove-V2025AccountAsync -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Remove-V2025AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
# Remove-V2025AccountAsync -Id $Id
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccountAsync"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -286,9 +281,6 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## disable-account-for-identity
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
This API submits a task to disable IDN account for a single identity.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/disable-account-for-identity)
|
||||
@@ -297,7 +289,6 @@ This API submits a task to disable IDN account for a single identity.
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | The identity id.
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
|
||||
@@ -320,15 +311,14 @@ Code | Description | Data Type
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "2c91808384203c2d018437e631158309" # String | The identity id.
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
|
||||
# Disable idn account for identity
|
||||
|
||||
try {
|
||||
Disable-V2025AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
Disable-V2025AccountForIdentity -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Disable-V2025AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
# Disable-V2025AccountForIdentity -Id $Id
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2025AccountForIdentity"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -337,9 +327,6 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## disable-accounts-for-identities
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
This API submits tasks to disable IDN account for each identity provided in the request body.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/disable-accounts-for-identities)
|
||||
@@ -347,7 +334,6 @@ This API submits tasks to disable IDN account for each identity provided in the
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
Body | IdentitiesAccountsBulkRequest | [**IdentitiesAccountsBulkRequest**](../models/identities-accounts-bulk-request) | True |
|
||||
|
||||
### Return type
|
||||
@@ -369,7 +355,6 @@ Code | Description | Data Type
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$IdentitiesAccountsBulkRequest = @"{
|
||||
"identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
|
||||
}"@
|
||||
@@ -378,10 +363,10 @@ $IdentitiesAccountsBulkRequest = @"{
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest
|
||||
Disable-V2025AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result
|
||||
Disable-V2025AccountsForIdentities -IdentitiesAccountsBulkRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Disable-V2025AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result
|
||||
# Disable-V2025AccountsForIdentities -IdentitiesAccountsBulkRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2025AccountsForIdentities"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -442,9 +427,6 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## enable-account-for-identity
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
This API submits a task to enable IDN account for a single identity.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/enable-account-for-identity)
|
||||
@@ -453,7 +435,6 @@ This API submits a task to enable IDN account for a single identity.
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | The identity id.
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
|
||||
@@ -476,15 +457,14 @@ Code | Description | Data Type
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "2c91808384203c2d018437e631158309" # String | The identity id.
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
|
||||
# Enable idn account for identity
|
||||
|
||||
try {
|
||||
Enable-V2025AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
Enable-V2025AccountForIdentity -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Enable-V2025AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
# Enable-V2025AccountForIdentity -Id $Id
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2025AccountForIdentity"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -493,9 +473,6 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## enable-accounts-for-identities
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
This API submits tasks to enable IDN account for each identity provided in the request body.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/enable-accounts-for-identities)
|
||||
@@ -503,7 +480,6 @@ This API submits tasks to enable IDN account for each identity provided in the r
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
Body | IdentitiesAccountsBulkRequest | [**IdentitiesAccountsBulkRequest**](../models/identities-accounts-bulk-request) | True |
|
||||
|
||||
### Return type
|
||||
@@ -525,7 +501,6 @@ Code | Description | Data Type
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$IdentitiesAccountsBulkRequest = @"{
|
||||
"identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
|
||||
}"@
|
||||
@@ -534,10 +509,10 @@ $IdentitiesAccountsBulkRequest = @"{
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest
|
||||
Enable-V2025AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result
|
||||
Enable-V2025AccountsForIdentities -IdentitiesAccountsBulkRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Enable-V2025AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result
|
||||
# Enable-V2025AccountsForIdentities -IdentitiesAccountsBulkRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2025AccountsForIdentities"
|
||||
Write-Host $_.ErrorDetails
|
||||
|
||||
@@ -78,7 +78,7 @@ Method | HTTP request | Description
|
||||
[**New-V2025Source**](#create-source) | **POST** `/sources` | Creates a source in identitynow.
|
||||
[**New-V2025SourceSchedule**](#create-source-schedule) | **POST** `/sources/{sourceId}/schedules` | Create schedule on source
|
||||
[**New-V2025SourceSchema**](#create-source-schema) | **POST** `/sources/{sourceId}/schemas` | Create schema on source
|
||||
[**Remove-V2025AccountsAsync**](#delete-accounts-async) | **POST** `/sources/{id}/remove-accounts` | Remove all accounts in a source
|
||||
[**Remove-V2025AccountsAsync**](#delete-accounts-async) | **POST** `/sources/{id}/remove-accounts` | Remove all accounts in source
|
||||
[**Remove-V2025NativeChangeDetectionConfig**](#delete-native-change-detection-config) | **DELETE** `/sources/{sourceId}/native-change-detection-config` | Delete native change detection configuration
|
||||
[**Remove-V2025ProvisioningPolicy**](#delete-provisioning-policy) | **DELETE** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete provisioning policy by usagetype
|
||||
[**Remove-V2025Source**](#delete-source) | **DELETE** `/sources/{id}` | Delete source by id
|
||||
@@ -479,9 +479,6 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-accounts-async
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation.
|
||||
|
||||
This endpoint is good for:
|
||||
@@ -496,7 +493,6 @@ This endpoint is good for:
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | The source id
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**TaskResultDto**](../models/task-result-dto)
|
||||
@@ -518,15 +514,14 @@ Code | Description | Data Type
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "ebbf35756e1140699ce52b233121384a" # String | The source id
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
|
||||
# Remove all accounts in a source
|
||||
# Remove all accounts in source
|
||||
|
||||
try {
|
||||
Remove-V2025AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
Remove-V2025AccountsAsync -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Remove-V2025AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
# Remove-V2025AccountsAsync -Id $Id
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccountsAsync"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -1761,9 +1756,6 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## import-uncorrelated-accounts
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
File is required for upload. You will also need to set the Content-Type header to `multipart/form-data`
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/import-uncorrelated-accounts)
|
||||
@@ -1772,7 +1764,6 @@ File is required for upload. You will also need to set the Content-Type header t
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | Source Id
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
| File | **System.IO.FileInfo** | (optional) |
|
||||
|
||||
### Return type
|
||||
@@ -1795,16 +1786,15 @@ Code | Description | Data Type
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "75dbec1ebe154d5785da27b95e1dd5d7" # String | Source Id
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$File = # System.IO.FileInfo | (optional)
|
||||
|
||||
# Process uncorrelated accounts
|
||||
|
||||
try {
|
||||
Import-V2025UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
Import-V2025UncorrelatedAccounts -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Import-V2025UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental -File $File
|
||||
# Import-V2025UncorrelatedAccounts -Id $Id -File $File
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025UncorrelatedAccounts"
|
||||
Write-Host $_.ErrorDetails
|
||||
|
||||
@@ -20,6 +20,10 @@ Name | Type | Description | Notes
|
||||
**Status** | **Enum** [ "STARTED", "ACCOUNTS_COLLECTED", "COMPLETED", "CANCELLED", "RETRIED", "TERMINATED", "NOT_FOUND" ] | STARTED - Aggregation started, but source account iteration has not completed. ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed. COMPLETED - Aggregation completed (*possibly with errors*). CANCELLED - Aggregation cancelled by user. RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance. TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance. | [optional]
|
||||
**TotalAccounts** | **Int32** | The total number of *NEW, CHANGED and DELETED* accounts that need to be processed for this aggregation. This does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no new, changed or deleted accounts since the previous aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
|
||||
**ProcessedAccounts** | **Int32** | The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
|
||||
**TotalAccountsMarkedForDeletion** | **Int32** | The total number of accounts that have been marked for deletion during the aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
|
||||
**DeletedAccounts** | **Int32** | The number of accounts that have been deleted during the aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
|
||||
**TotalIdentities** | **Int32** | The total number of unique identities that have been marked for refresh. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
|
||||
**ProcessedIdentities** | **Int32** | The number of unique identities that have been refreshed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -28,7 +32,11 @@ Name | Type | Description | Notes
|
||||
$AccountAggregationStatus = Initialize-V2025AccountAggregationStatus -Start 2021-01-31T14:30:05.104Z `
|
||||
-Status ACCOUNTS_COLLECTED `
|
||||
-TotalAccounts 520 `
|
||||
-ProcessedAccounts 150
|
||||
-ProcessedAccounts 150 `
|
||||
-TotalAccountsMarkedForDeletion 10 `
|
||||
-DeletedAccounts 5 `
|
||||
-TotalIdentities 300 `
|
||||
-ProcessedIdentities 250
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
Reference in New Issue
Block a user