LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-07 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update to powershell SDK docs: 13207859154

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-07 20:53:08 +00:00
parent fea17715f4
commit 09ed592191
244 changed files with 12907 additions and 6931 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
docs/tools/sdk/powershell/Reference/V3/Methods/AccessProfilesApi.md
View File

@@ -59,11 +59,14 @@ Method | HTTP request | Description
[**Get-AccessProfiles**](#list-access-profiles) | **GET** `/access-profiles` | List Access Profiles
[**Update-AccessProfile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified Access Profile
## create-access-profile
Use this API to create an access profile.
A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source.
The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-access-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -178,16 +181,17 @@ $AccessProfile = @"{
try {
$Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile
New-AccessProfile -AccessProfile $Result
New-AccessProfile -AccessProfile $Result
# Below is a request that includes all optional parameters
# New-AccessProfile -AccessProfile $AccessProfile
# New-AccessProfile -AccessProfile $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AccessProfile"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-access-profile
This API deletes an existing Access Profile.
@@ -195,6 +199,8 @@ The Access Profile must not be in use, for example, Access Profile can not be de
A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-access-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -234,6 +240,7 @@ try {
}
```
[[Back to top]](#)
## delete-access-profiles-in-bulk
This endpoint initiates a bulk deletion of one or more access profiles.
When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information.
@@ -241,6 +248,8 @@ This endpoint can only bulk delete up to a limit of 50 access profiles per reque
By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted.
A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they're able to administer.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-access-profiles-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -275,19 +284,22 @@ $AccessProfileBulkDeleteRequest = @"{
try {
$Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest
Remove-AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result
Remove-AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result
# Below is a request that includes all optional parameters
# Remove-AccessProfilesInBulk -AccessProfileBulkDeleteRequest $AccessProfileBulkDeleteRequest
# Remove-AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-AccessProfilesInBulk"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-access-profile
This API returns an Access Profile by its ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-access-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -327,11 +339,14 @@ try {
}
```
[[Back to top]](#)
## get-access-profile-entitlements
Use this API to get a list of an access profile's entitlements.
A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile.
>**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-access-profile-entitlements)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -381,10 +396,13 @@ try {
}
```
[[Back to top]](#)
## list-access-profiles
Use this API to get a list of access profiles.
>**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-access-profiles)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -428,7 +446,7 @@ $IncludeUnsegmented = $false # Boolean | Indicates whether the response list sho
# List Access Profiles
try {
Get-AccessProfiles
Get-AccessProfiles
# Below is a request that includes all optional parameters
# Get-AccessProfiles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented
@@ -438,6 +456,7 @@ try {
}
```
[[Back to top]](#)
## patch-access-profile
This API updates an existing Access Profile. The following fields are patchable:
@@ -470,6 +489,8 @@ A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which
> You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile's source.
[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-access-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -507,10 +528,10 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-AccessProfile -Id $Id -JsonPatchOperation $Result
Update-AccessProfile -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-AccessProfile -Id $Id -JsonPatchOperation $JsonPatchOperation
# Update-AccessProfile -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AccessProfile"
Write-Host $_.ErrorDetails

38
docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestApprovalsApi.md
View File

@@ -41,9 +41,12 @@ Method | HTTP request | Description
[**Get-PendingApprovals**](#list-pending-approvals) | **GET** `/access-request-approvals/pending` | Pending Access Request Approvals List
[**Deny-AccessRequest**](#reject-access-request) | **POST** `/access-request-approvals/{approvalId}/reject` | Reject Access Request Approval
## approve-access-request
Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.
[API Spec](https://developer.sailpoint.com/docs/api/v3/approve-access-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -87,16 +90,19 @@ try {
Approve-AccessRequest -ApprovalId $ApprovalId
# Below is a request that includes all optional parameters
# Approve-AccessRequest -ApprovalId $ApprovalId -CommentDto $CommentDto
# Approve-AccessRequest -ApprovalId $ApprovalId -CommentDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-AccessRequest"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## forward-access-request
Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.
[API Spec](https://developer.sailpoint.com/docs/api/v3/forward-access-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -133,19 +139,22 @@ $ForwardApprovalDto = @"{
try {
$Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto
Invoke-ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result
Invoke-ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result
# Below is a request that includes all optional parameters
# Invoke-ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $ForwardApprovalDto
# Invoke-ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ForwardAccessRequest"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-access-request-approval-summary
Use this API to return the number of pending, approved and rejected access requests approvals. See the "owner-id" query parameter for authorization information. info.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-access-request-approval-summary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -177,7 +186,7 @@ $FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and tim
# Get Access Requests Approvals Number
try {
Get-AccessRequestApprovalSummary
Get-AccessRequestApprovalSummary
# Below is a request that includes all optional parameters
# Get-AccessRequestApprovalSummary -OwnerId $OwnerId -FromDate $FromDate
@@ -187,9 +196,12 @@ try {
}
```
[[Back to top]](#)
## list-completed-approvals
This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-completed-approvals)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -229,7 +241,7 @@ $Sorters = "modified" # String | Sort results using the standard syntax describe
# Completed Access Request Approvals List
try {
Get-CompletedApprovals
Get-CompletedApprovals
# Below is a request that includes all optional parameters
# Get-CompletedApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
@@ -239,9 +251,12 @@ try {
}
```
[[Back to top]](#)
## list-pending-approvals
This endpoint returns a list of pending approvals. See "owner-id" query parameter below for authorization info.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-pending-approvals)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -249,7 +264,7 @@ Param Type | Name | Data Type | Required | Description
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in*
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in*
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified**
### Return type
@@ -275,13 +290,13 @@ $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value r
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (optional)
$Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional)
$Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional)
# Pending Access Request Approvals List
try {
Get-PendingApprovals
Get-PendingApprovals
# Below is a request that includes all optional parameters
# Get-PendingApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
@@ -291,9 +306,12 @@ try {
}
```
[[Back to top]](#)
## reject-access-request
Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action.
[API Spec](https://developer.sailpoint.com/docs/api/v3/reject-access-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -335,10 +353,10 @@ $CommentDto = @"{
try {
$Result = ConvertFrom-JsonToCommentDto -Json $CommentDto
Deny-AccessRequest -ApprovalId $ApprovalId -CommentDto $Result
Deny-AccessRequest -ApprovalId $ApprovalId -CommentDto $Result
# Below is a request that includes all optional parameters
# Deny-AccessRequest -ApprovalId $ApprovalId -CommentDto $CommentDto
# Deny-AccessRequest -ApprovalId $ApprovalId -CommentDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-AccessRequest"
Write-Host $_.ErrorDetails

31
docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestsApi.md
View File

@@ -38,10 +38,13 @@ Method | HTTP request | Description
[**Get-AccessRequestStatus**](#list-access-request-status) | **GET** `/access-request-status` | Access Request Status
[**Set-AccessRequestConfig**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration
## cancel-access-request
This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step.
In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it.
[API Spec](https://developer.sailpoint.com/docs/api/v3/cancel-access-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -76,16 +79,17 @@ $CancelAccessRequest = @"{
try {
$Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest
Suspend-AccessRequest -CancelAccessRequest $Result
Suspend-AccessRequest -CancelAccessRequest $Result
# Below is a request that includes all optional parameters
# Suspend-AccessRequest -CancelAccessRequest $CancelAccessRequest
# Suspend-AccessRequest -CancelAccessRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-AccessRequest"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-access-request
Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes.
@@ -119,6 +123,8 @@ __REVOKE_ACCESS__
* Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-access-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -202,19 +208,22 @@ $AccessRequest = @"{
try {
$Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest
New-AccessRequest -AccessRequest $Result
New-AccessRequest -AccessRequest $Result
# Below is a request that includes all optional parameters
# New-AccessRequest -AccessRequest $AccessRequest
# New-AccessRequest -AccessRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AccessRequest"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-access-request-config
This endpoint returns the current access-request configuration.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-access-request-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -242,7 +251,7 @@ Code | Description | Data Type
# Get Access Request Configuration
try {
Get-AccessRequestConfig
Get-AccessRequestConfig
# Below is a request that includes all optional parameters
# Get-AccessRequestConfig
@@ -252,11 +261,14 @@ try {
}
```
[[Back to top]](#)
## list-access-request-status
Use this API to return a list of access request statuses based on the specified query parameters.
If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses.
Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-access-request-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -304,7 +316,7 @@ $RequestState = "request-state=EXECUTING" # String | Filter the results by the s
# Access Request Status
try {
Get-AccessRequestStatus
Get-AccessRequestStatus
# Below is a request that includes all optional parameters
# Get-AccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState
@@ -314,9 +326,12 @@ try {
}
```
[[Back to top]](#)
## set-access-request-config
This endpoint replaces the current access-request configuration.
[API Spec](https://developer.sailpoint.com/docs/api/v3/set-access-request-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -372,10 +387,10 @@ $AccessRequestConfig = @"{
try {
$Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig
Set-AccessRequestConfig -AccessRequestConfig $Result
Set-AccessRequestConfig -AccessRequestConfig $Result
# Below is a request that includes all optional parameters
# Set-AccessRequestConfig -AccessRequestConfig $AccessRequestConfig
# Set-AccessRequestConfig -AccessRequestConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-AccessRequestConfig"
Write-Host $_.ErrorDetails

8
docs/tools/sdk/powershell/Reference/V3/Methods/AccountActivitiesApi.md
View File

@@ -53,9 +53,12 @@ Method | HTTP request | Description
[**Get-AccountActivity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get an Account Activity
[**Get-AccountActivities**](#list-account-activities) | **GET** `/account-activities` | List Account Activities
## get-account-activity
This gets a single account activity by its id.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-account-activity)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -96,9 +99,12 @@ try {
}
```
[[Back to top]](#)
## list-account-activities
This gets a collection of account activities that satisfy the given query parameters.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-account-activities)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -142,7 +148,7 @@ $Sorters = "created" # String | Sort results using the standard syntax described
# List Account Activities
try {
Get-AccountActivities
Get-AccountActivities
# Below is a request that includes all optional parameters
# Get-AccountActivities -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters

3
docs/tools/sdk/powershell/Reference/V3/Methods/AccountUsagesApi.md
View File

@@ -22,9 +22,12 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-UsagesByAccountId**](#get-usages-by-account-id) | **GET** `/account-usages/{accountId}/summaries` | Returns account usage insights
## get-usages-by-account-id
This API returns a summary of account usage insights for past 12 months.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-usages-by-account-id)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------

59
docs/tools/sdk/powershell/Reference/V3/Methods/AccountsApi.md
View File

@@ -56,6 +56,7 @@ Method | HTTP request | Description
[**Unlock-Account**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock Account
[**Update-Account**](#update-account) | **PATCH** `/accounts/{id}` | Update Account
## create-account
Submit an account creation task - the API then returns the task ID.
@@ -70,6 +71,8 @@ The endpoint doesn't actually provision the account on the target source, which
By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -109,22 +112,25 @@ $AccountAttributesCreate = @"{
try {
$Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate
New-Account -AccountAttributesCreate $Result
New-Account -AccountAttributesCreate $Result
# Below is a request that includes all optional parameters
# New-Account -AccountAttributesCreate $AccountAttributesCreate
# New-Account -AccountAttributesCreate $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Account"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-account
Use this API to delete an account.
This endpoint submits an account delete task and returns the task ID.
This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future.
>**NOTE: You can only delete accounts from sources of the "DelimitedFile" type.**
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -165,9 +171,12 @@ try {
}
```
[[Back to top]](#)
## disable-account
This API submits a task to disable the account and returns the task ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/disable-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -204,19 +213,22 @@ $AccountToggleRequest = @"{
try {
$Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest
Disable-Account -Id $Id -AccountToggleRequest $Result
Disable-Account -Id $Id -AccountToggleRequest $Result
# Below is a request that includes all optional parameters
# Disable-Account -Id $Id -AccountToggleRequest $AccountToggleRequest
# Disable-Account -Id $Id -AccountToggleRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-Account"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## enable-account
This API submits a task to enable account and returns the task ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/enable-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -253,19 +265,22 @@ $AccountToggleRequest = @"{
try {
$Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest
Enable-Account -Id $Id -AccountToggleRequest $Result
Enable-Account -Id $Id -AccountToggleRequest $Result
# Below is a request that includes all optional parameters
# Enable-Account -Id $Id -AccountToggleRequest $AccountToggleRequest
# Enable-Account -Id $Id -AccountToggleRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-Account"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-account
Use this API to return the details for a single account by its ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -306,9 +321,12 @@ try {
}
```
[[Back to top]](#)
## get-account-entitlements
This API returns entitlements of the account.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-account-entitlements)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -355,9 +373,12 @@ try {
}
```
[[Back to top]](#)
## list-accounts
List accounts.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-accounts)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -397,7 +418,7 @@ $Sorters = "id,name" # String | Sort results using the standard syntax described
# Accounts List
try {
Get-Accounts
Get-Accounts
# Below is a request that includes all optional parameters
# Get-Accounts -Limit $Limit -Offset $Offset -Count $Count -DetailLevel $DetailLevel -Filters $Filters -Sorters $Sorters
@@ -407,6 +428,7 @@ try {
}
```
[[Back to top]](#)
## put-account
Use this API to update an account with a PUT request.
@@ -415,6 +437,8 @@ This endpoint submits an account update task and returns the task ID.
>**Note: You can only use this PUT endpoint to update accounts from flat file sources.**
[API Spec](https://developer.sailpoint.com/docs/api/v3/put-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -456,19 +480,22 @@ $AccountAttributes = @"{
try {
$Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes
Send-Account -Id $Id -AccountAttributes $Result
Send-Account -Id $Id -AccountAttributes $Result
# Below is a request that includes all optional parameters
# Send-Account -Id $Id -AccountAttributes $AccountAttributes
# Send-Account -Id $Id -AccountAttributes $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Account"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## submit-reload-account
This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process.
[API Spec](https://developer.sailpoint.com/docs/api/v3/submit-reload-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -509,10 +536,13 @@ try {
}
```
[[Back to top]](#)
## unlock-account
This API submits a task to unlock an account and returns the task ID.
To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required.
[API Spec](https://developer.sailpoint.com/docs/api/v3/unlock-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -550,16 +580,17 @@ $AccountUnlockRequest = @"{
try {
$Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest
Unlock-Account -Id $Id -AccountUnlockRequest $Result
Unlock-Account -Id $Id -AccountUnlockRequest $Result
# Below is a request that includes all optional parameters
# Unlock-Account -Id $Id -AccountUnlockRequest $AccountUnlockRequest
# Unlock-Account -Id $Id -AccountUnlockRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-Account"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-account
Use this API to update account details.
@@ -573,6 +604,8 @@ All accounts that are reassigned will be set to `manuallyCorrelated: true` unles
>**Note:** The `attributes` field can only be modified for flat file accounts.
[API Spec](https://developer.sailpoint.com/docs/api/v3/update-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -608,10 +641,10 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of account update operat
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Update-Account -Id $Id -RequestBody $Result
Update-Account -Id $Id -RequestBody $Result
# Below is a request that includes all optional parameters
# Update-Account -Id $Id -RequestBody $RequestBody
# Update-Account -Id $Id -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Account"
Write-Host $_.ErrorDetails

13
docs/tools/sdk/powershell/Reference/V3/Methods/ApplicationDiscoveryApi.md
View File

@@ -23,10 +23,13 @@ Method | HTTP request | Description
[**Get-ManualDiscoverApplicationsCsvTemplate**](#get-manual-discover-applications-csv-template) | **GET** `/manual-discover-applications-template` | Download CSV Template for Discovery
[**Send-ManualDiscoverApplicationsCsvTemplate**](#send-manual-discover-applications-csv-template) | **POST** `/manual-discover-applications` | Upload CSV to Discover Applications
## get-discovered-applications
Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-discovered-applications)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -64,7 +67,7 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
# Get Discovered Applications for Tenant
try {
Get-DiscoveredApplications
Get-DiscoveredApplications
# Below is a request that includes all optional parameters
# Get-DiscoveredApplications -Limit $Limit -Offset $Offset -Detail $Detail -Filter $Filter -Sorters $Sorters
@@ -74,12 +77,15 @@ try {
}
```
[[Back to top]](#)
## get-manual-discover-applications-csv-template
Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values 'Example Application' and 'Example Description'.
The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-manual-discover-applications-csv-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -107,7 +113,7 @@ Code | Description | Data Type
# Download CSV Template for Discovery
try {
Get-ManualDiscoverApplicationsCsvTemplate
Get-ManualDiscoverApplicationsCsvTemplate
# Below is a request that includes all optional parameters
# Get-ManualDiscoverApplicationsCsvTemplate
@@ -117,10 +123,13 @@ try {
}
```
[[Back to top]](#)
## send-manual-discover-applications-csv-template
Uploading a CSV file with application data for manual correlation to specific ISC connectors.
If a suitable ISC connector is unavailable, the system will recommend generic connectors instead.
[API Spec](https://developer.sailpoint.com/docs/api/v3/send-manual-discover-applications-csv-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------

10
docs/tools/sdk/powershell/Reference/V3/Methods/AuthUsersApi.md
View File

@@ -25,9 +25,12 @@ Method | HTTP request | Description
[**Get-AuthUser**](#get-auth-user) | **GET** `/auth-users/{id}` | Auth User Details
[**Update-AuthUser**](#patch-auth-user) | **PATCH** `/auth-users/{id}` | Auth User Update
## get-auth-user
Return the specified user's authentication system details.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-auth-user)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -68,6 +71,7 @@ try {
}
```
[[Back to top]](#)
## patch-auth-user
Use a PATCH request to update an existing user in the authentication system.
Use this endpoint to modify these fields:
@@ -75,6 +79,8 @@ Use this endpoint to modify these fields:
A '400.1.1 Illegal update attempt' detail code indicates that you attempted to PATCH a field that is not allowed.
[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-auth-user)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -113,10 +119,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-AuthUser -Id $Id -JsonPatchOperation $Result
Update-AuthUser -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-AuthUser -Id $Id -JsonPatchOperation $JsonPatchOperation
# Update-AuthUser -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthUser"
Write-Host $_.ErrorDetails

21
docs/tools/sdk/powershell/Reference/V3/Methods/BrandingApi.md
View File

@@ -28,9 +28,12 @@ Method | HTTP request | Description
[**Get-BrandingList**](#get-branding-list) | **GET** `/brandings` | List of branding items
[**Set-BrandingItem**](#set-branding-item) | **PUT** `/brandings/{name}` | Update a branding item
## create-branding-item
This API endpoint creates a branding item.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-branding-item)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -74,7 +77,7 @@ $FileStandard = # System.IO.FileInfo | png file with logo (optional)
# Create a branding item
try {
New-BrandingItem -Name $Name -ProductName $ProductName
New-BrandingItem -Name $Name -ProductName $ProductName
# Below is a request that includes all optional parameters
# New-BrandingItem -Name $Name -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard
@@ -84,9 +87,12 @@ try {
}
```
[[Back to top]](#)
## delete-branding
This API endpoint delete information for an existing branding item by name.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-branding)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -127,9 +133,12 @@ try {
}
```
[[Back to top]](#)
## get-branding
This API endpoint retrieves information for an existing branding item by name.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-branding)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -170,9 +179,12 @@ try {
}
```
[[Back to top]](#)
## get-branding-list
This API endpoint returns a list of branding items.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-branding-list)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -200,7 +212,7 @@ Code | Description | Data Type
# List of branding items
try {
Get-BrandingList
Get-BrandingList
# Below is a request that includes all optional parameters
# Get-BrandingList
@@ -210,9 +222,12 @@ try {
}
```
[[Back to top]](#)
## set-branding-item
This API endpoint updates information for an existing branding item.
[API Spec](https://developer.sailpoint.com/docs/api/v3/set-branding-item)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -259,7 +274,7 @@ $FileStandard = # System.IO.FileInfo | png file with logo (optional)
# Update a branding item
try {
Set-BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName
Set-BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName
# Below is a request that includes all optional parameters
# Set-BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard

29
docs/tools/sdk/powershell/Reference/V3/Methods/CertificationCampaignFiltersApi.md
View File

@@ -50,9 +50,12 @@ Method | HTTP request | Description
[**Get-CampaignFilters**](#list-campaign-filters) | **GET** `/campaign-filters` | List Campaign Filters
[**Update-CampaignFilter**](#update-campaign-filter) | **POST** `/campaign-filters/{id}` | Updates a Campaign Filter
## create-campaign-filter
Use this API to create a campaign filter based on filter details and criteria.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-campaign-filter)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -100,19 +103,22 @@ $CampaignFilterDetails = @"{
try {
$Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails
New-CampaignFilter -CampaignFilterDetails $Result
New-CampaignFilter -CampaignFilterDetails $Result
# Below is a request that includes all optional parameters
# New-CampaignFilter -CampaignFilterDetails $CampaignFilterDetails
# New-CampaignFilter -CampaignFilterDetails $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CampaignFilter"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-campaign-filters
Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-campaign-filters)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -146,19 +152,22 @@ $RequestBody = "MyRequestBody" # String[] | A json list of IDs of campaign filte
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Remove-CampaignFilters -RequestBody $Result
Remove-CampaignFilters -RequestBody $Result
# Below is a request that includes all optional parameters
# Remove-CampaignFilters -RequestBody $RequestBody
# Remove-CampaignFilters -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CampaignFilters"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-campaign-filter-by-id
Retrieves information for an existing campaign filter using the filter's ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign-filter-by-id)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -199,9 +208,12 @@ try {
}
```
[[Back to top]](#)
## list-campaign-filters
Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-campaign-filters)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -235,7 +247,7 @@ $IncludeSystemFilters = $true # Boolean | If this is true, the API includes syst
# List Campaign Filters
try {
Get-CampaignFilters
Get-CampaignFilters
# Below is a request that includes all optional parameters
# Get-CampaignFilters -Limit $Limit -Start $Start -IncludeSystemFilters $IncludeSystemFilters
@@ -245,9 +257,12 @@ try {
}
```
[[Back to top]](#)
## update-campaign-filter
Updates an existing campaign filter using the filter's ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/update-campaign-filter)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -297,10 +312,10 @@ $CampaignFilterDetails = @"{
try {
$Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails
Update-CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result
Update-CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result
# Below is a request that includes all optional parameters
# Update-CampaignFilter -FilterId $FilterId -CampaignFilterDetails $CampaignFilterDetails
# Update-CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-CampaignFilter"
Write-Host $_.ErrorDetails

108
docs/tools/sdk/powershell/Reference/V3/Methods/CertificationCampaignsApi.md
View File

@@ -105,6 +105,7 @@ Method | HTTP request | Description
[**Start-GenerateCampaignTemplate**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a Campaign from Template
[**Update-Campaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a Campaign
## complete-campaign
:::caution
@@ -118,6 +119,8 @@ Use this API to complete a certification campaign. This functionality is provide
can complete a certification even if all items have not been completed.
[API Spec](https://developer.sailpoint.com/docs/api/v3/complete-campaign)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -155,17 +158,20 @@ try {
Complete-Campaign -Id $Id
# Below is a request that includes all optional parameters
# Complete-Campaign -Id $Id -CampaignCompleteOptions $CampaignCompleteOptions
# Complete-Campaign -Id $Id -CampaignCompleteOptions $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-Campaign"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-campaign
Use this API to create a certification campaign with the information provided in the request body.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-campaign)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -304,20 +310,23 @@ $Campaign = @"{
try {
$Result = ConvertFrom-JsonToCampaign -Json $Campaign
New-Campaign -Campaign $Result
New-Campaign -Campaign $Result
# Below is a request that includes all optional parameters
# New-Campaign -Campaign $Campaign
# New-Campaign -Campaign $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Campaign"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-campaign-template
Use this API to create a certification campaign template based on campaign.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-campaign-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -471,20 +480,23 @@ $CampaignTemplate = @"{
try {
$Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate
New-CampaignTemplate -CampaignTemplate $Result
New-CampaignTemplate -CampaignTemplate $Result
# Below is a request that includes all optional parameters
# New-CampaignTemplate -CampaignTemplate $CampaignTemplate
# New-CampaignTemplate -CampaignTemplate $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CampaignTemplate"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-campaign-template
Use this API to delete a certification campaign template by ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -525,10 +537,13 @@ try {
}
```
[[Back to top]](#)
## delete-campaign-template-schedule
Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template-schedule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -569,10 +584,13 @@ try {
}
```
[[Back to top]](#)
## delete-campaigns
Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-campaigns)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -606,20 +624,23 @@ $CampaignsDeleteRequest = @"{
try {
$Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest
Remove-Campaigns -CampaignsDeleteRequest $Result
Remove-Campaigns -CampaignsDeleteRequest $Result
# Below is a request that includes all optional parameters
# Remove-Campaigns -CampaignsDeleteRequest $CampaignsDeleteRequest
# Remove-Campaigns -CampaignsDeleteRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Campaigns"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-active-campaigns
Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-active-campaigns)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -659,7 +680,7 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
# List Campaigns
try {
Get-ActiveCampaigns
Get-ActiveCampaigns
# Below is a request that includes all optional parameters
# Get-ActiveCampaigns -Detail $Detail -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
@@ -669,10 +690,13 @@ try {
}
```
[[Back to top]](#)
## get-campaign
Use this API to get information for an existing certification campaign by the campaign's ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -715,10 +739,13 @@ try {
}
```
[[Back to top]](#)
## get-campaign-reports
Use this API to fetch all reports for a certification campaign by campaign ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -759,10 +786,13 @@ try {
}
```
[[Back to top]](#)
## get-campaign-reports-config
Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -790,7 +820,7 @@ Code | Description | Data Type
# Get Campaign Reports Configuration
try {
Get-CampaignReportsConfig
Get-CampaignReportsConfig
# Below is a request that includes all optional parameters
# Get-CampaignReportsConfig
@@ -800,10 +830,13 @@ try {
}
```
[[Back to top]](#)
## get-campaign-template
Use this API to fetch a certification campaign template by ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -844,10 +877,13 @@ try {
}
```
[[Back to top]](#)
## get-campaign-template-schedule
Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign-template-schedule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -888,12 +924,15 @@ try {
}
```
[[Back to top]](#)
## get-campaign-templates
Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params.
The API returns all campaign templates matching the query parameters.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign-templates)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -931,7 +970,7 @@ $Filters = 'name eq "manager template"' # String | Filter results using the stan
# List Campaign Templates
try {
Get-CampaignTemplates
Get-CampaignTemplates
# Below is a request that includes all optional parameters
# Get-CampaignTemplates -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters
@@ -941,10 +980,13 @@ try {
}
```
[[Back to top]](#)
## move
This API reassigns the specified certifications from one identity to another.
[API Spec](https://developer.sailpoint.com/docs/api/v3/move)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -985,20 +1027,23 @@ $AdminReviewReassign = @"{
try {
$Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign
Move- -Id $Id -AdminReviewReassign $Result
Move- -Id $Id -AdminReviewReassign $Result
# Below is a request that includes all optional parameters
# Move- -Id $Id -AdminReviewReassign $AdminReviewReassign
# Move- -Id $Id -AdminReviewReassign $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-campaign-template
Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-campaign-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1037,20 +1082,23 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-CampaignTemplate -Id $Id -JsonPatchOperation $Result
Update-CampaignTemplate -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-CampaignTemplate -Id $Id -JsonPatchOperation $JsonPatchOperation
# Update-CampaignTemplate -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-CampaignTemplate"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-campaign-reports-config
Use this API to overwrite the configuration for campaign reports.
[API Spec](https://developer.sailpoint.com/docs/api/v3/set-campaign-reports-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1083,20 +1131,23 @@ $CampaignReportsConfig = @"{
try {
$Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig
Set-CampaignReportsConfig -CampaignReportsConfig $Result
Set-CampaignReportsConfig -CampaignReportsConfig $Result
# Below is a request that includes all optional parameters
# Set-CampaignReportsConfig -CampaignReportsConfig $CampaignReportsConfig
# Set-CampaignReportsConfig -CampaignReportsConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-CampaignReportsConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-campaign-template-schedule
Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one.
[API Spec](https://developer.sailpoint.com/docs/api/v3/set-campaign-template-schedule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1151,17 +1202,20 @@ try {
Set-CampaignTemplateSchedule -Id $Id
# Below is a request that includes all optional parameters
# Set-CampaignTemplateSchedule -Id $Id -Schedule $Schedule
# Set-CampaignTemplateSchedule -Id $Id -Schedule $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-CampaignTemplateSchedule"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-campaign
Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged.
[API Spec](https://developer.sailpoint.com/docs/api/v3/start-campaign)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1199,17 +1253,20 @@ try {
Start-Campaign -Id $Id
# Below is a request that includes all optional parameters
# Start-Campaign -Id $Id -ActivateCampaignOptions $ActivateCampaignOptions
# Start-Campaign -Id $Id -ActivateCampaignOptions $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-Campaign"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-campaign-remediation-scan
Use this API to run a remediation scan task for a certification campaign.
[API Spec](https://developer.sailpoint.com/docs/api/v3/start-campaign-remediation-scan)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1250,10 +1307,13 @@ try {
}
```
[[Back to top]](#)
## start-campaign-report
Use this API to run a report for a certification campaign.
[API Spec](https://developer.sailpoint.com/docs/api/v3/start-campaign-report)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1286,7 +1346,7 @@ $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run.
# Run Campaign Report
try {
Start-CampaignReport -Id $Id -Type $Type
Start-CampaignReport -Id $Id -Type $Type
# Below is a request that includes all optional parameters
# Start-CampaignReport -Id $Id -Type $Type
@@ -1296,6 +1356,7 @@ try {
}
```
[[Back to top]](#)
## start-generate-campaign-template
Use this API to generate a new certification campaign from a campaign template.
@@ -1310,6 +1371,8 @@ campaign called "Campaign for 2020" (assuming the year at generation time is 202
Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html).
[API Spec](https://developer.sailpoint.com/docs/api/v3/start-generate-campaign-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1349,10 +1412,13 @@ try {
}
```
[[Back to top]](#)
## update-campaign
Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
[API Spec](https://developer.sailpoint.com/docs/api/v3/update-campaign)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1391,10 +1457,10 @@ $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-Campaign -Id $Id -JsonPatchOperation $Result
Update-Campaign -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-Campaign -Id $Id -JsonPatchOperation $JsonPatchOperation
# Update-Campaign -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Campaign"
Write-Host $_.ErrorDetails

16
docs/tools/sdk/powershell/Reference/V3/Methods/CertificationSummariesApi.md
View File

@@ -36,9 +36,12 @@ Method | HTTP request | Description
[**Get-IdentitySummaries**](#get-identity-summaries) | **GET** `/certifications/{id}/identity-summaries` | Identity Summaries for Campaign Certification
[**Get-IdentitySummary**](#get-identity-summary) | **GET** `/certifications/{id}/identity-summaries/{identitySummaryId}` | Summary for Identity
## get-identity-access-summaries
This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-access-summaries)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -81,7 +84,7 @@ $Sorters = "access.name" # String | Sort results using the standard syntax descr
# Access Summaries
try {
Get-IdentityAccessSummaries -Id $Id -Type $Type
Get-IdentityAccessSummaries -Id $Id -Type $Type
# Below is a request that includes all optional parameters
# Get-IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
@@ -91,9 +94,12 @@ try {
}
```
[[Back to top]](#)
## get-identity-decision-summary
This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-decision-summary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -136,9 +142,12 @@ try {
}
```
[[Back to top]](#)
## get-identity-summaries
This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-summaries)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -189,9 +198,12 @@ try {
}
```
[[Back to top]](#)
## get-identity-summary
This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-summary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -224,7 +236,7 @@ $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity
# Summary for Identity
try {
Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId
Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId
# Below is a request that includes all optional parameters
# Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId

51
docs/tools/sdk/powershell/Reference/V3/Methods/CertificationsApi.md
View File

@@ -52,9 +52,12 @@ Method | HTTP request | Description
[**Invoke-SignOffIdentityCertification**](#sign-off-identity-certification) | **POST** `/certifications/{id}/sign-off` | Finalize Identity Certification Decisions
[**Submit-ReassignCertsAsync**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously
## get-certification-task
This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-certification-task)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -95,9 +98,12 @@ try {
}
```
[[Back to top]](#)
## get-identity-certification
This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-certification)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -138,9 +144,12 @@ try {
}
```
[[Back to top]](#)
## get-identity-certification-item-permissions
This API returns the permissions associated with an entitlement certification item based on the certification item's ID. Reviewers for this certification can also call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-certification-item-permissions)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -181,7 +190,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Permissions for Entitlement Certification Item
try {
Get-IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId
Get-IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId
# Below is a request that includes all optional parameters
# Get-IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count
@@ -191,9 +200,12 @@ try {
}
```
[[Back to top]](#)
## get-pending-certification-tasks
This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-pending-certification-tasks)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -232,7 +244,7 @@ $Filters = 'type eq "ADMIN_REASSIGN"' # String | Filter results using the standa
# List of Pending Certification Tasks
try {
Get-PendingCertificationTasks
Get-PendingCertificationTasks
# Below is a request that includes all optional parameters
# Get-PendingCertificationTasks -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters
@@ -242,9 +254,12 @@ try {
}
```
[[Back to top]](#)
## list-certification-reviewers
This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-certification-reviewers)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -295,9 +310,12 @@ try {
}
```
[[Back to top]](#)
## list-identity-access-review-items
This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-identity-access-review-items)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -354,9 +372,12 @@ try {
}
```
[[Back to top]](#)
## list-identity-certifications
Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-identity-certifications)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -396,7 +417,7 @@ $Sorters = "name,due" # String | Sort results using the standard syntax describe
# List Identity Campaign Certifications
try {
Get-IdentityCertifications
Get-IdentityCertifications
# Below is a request that includes all optional parameters
# Get-IdentityCertifications -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
@@ -406,9 +427,12 @@ try {
}
```
[[Back to top]](#)
## make-identity-decision
The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
[API Spec](https://developer.sailpoint.com/docs/api/v3/make-identity-decision)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -454,19 +478,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campa
try {
$Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision
Select-IdentityDecision -Id $Id -ReviewDecision $Result
Select-IdentityDecision -Id $Id -ReviewDecision $Result
# Below is a request that includes all optional parameters
# Select-IdentityDecision -Id $Id -ReviewDecision $ReviewDecision
# Select-IdentityDecision -Id $Id -ReviewDecision $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Select-IdentityDecision"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## reassign-identity-certifications
This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
[API Spec](https://developer.sailpoint.com/docs/api/v3/reassign-identity-certifications)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -510,19 +537,22 @@ $ReviewReassign = @"{
try {
$Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign
Invoke-ReassignIdentityCertifications -Id $Id -ReviewReassign $Result
Invoke-ReassignIdentityCertifications -Id $Id -ReviewReassign $Result
# Below is a request that includes all optional parameters
# Invoke-ReassignIdentityCertifications -Id $Id -ReviewReassign $ReviewReassign
# Invoke-ReassignIdentityCertifications -Id $Id -ReviewReassign $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ReassignIdentityCertifications"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## sign-off-identity-certification
This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
[API Spec](https://developer.sailpoint.com/docs/api/v3/sign-off-identity-certification)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -563,6 +593,7 @@ try {
}
```
[[Back to top]](#)
## submit-reassign-certs-async
This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another
reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the
@@ -571,6 +602,8 @@ reassignment is complete.
Reviewers for this certification can also call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v3/submit-reassign-certs-async)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -614,10 +647,10 @@ $ReviewReassign = @"{
try {
$Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign
Submit-ReassignCertsAsync -Id $Id -ReviewReassign $Result
Submit-ReassignCertsAsync -Id $Id -ReviewReassign $Result
# Below is a request that includes all optional parameters
# Submit-ReassignCertsAsync -Id $Id -ReviewReassign $ReviewReassign
# Submit-ReassignCertsAsync -Id $Id -ReviewReassign $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-ReassignCertsAsync"
Write-Host $_.ErrorDetails

45
docs/tools/sdk/powershell/Reference/V3/Methods/ConfigurationHubApi.md
View File

@@ -36,12 +36,15 @@ Method | HTTP request | Description
[**Get-UploadedConfigurations**](#list-uploaded-configurations) | **GET** `/configuration-hub/backups/uploads` | List Uploaded Configurations
[**Update-ObjectMappings**](#update-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-patch` | Bulk updates object mappings
## create-object-mapping
This creates an object mapping between current org and source org.
Source org should be "default" when creating an object mapping that is not to be associated to any particular org.
The request will need the following security scope:
- sp:config-object-mapping:manage
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-object-mapping)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -81,22 +84,25 @@ $ObjectMappingRequest = @"{
try {
$Result = ConvertFrom-JsonToObjectMappingRequest -Json $ObjectMappingRequest
New-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result
New-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result
# Below is a request that includes all optional parameters
# New-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $ObjectMappingRequest
# New-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ObjectMapping"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-object-mappings
This creates a set of object mappings (Max 25) between current org and source org.
Source org should be "default" when creating object mappings that are not to be associated to any particular org.
The request will need the following security scope:
- sp:config-object-mapping:manage
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-object-mappings)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -144,16 +150,17 @@ $ObjectMappingBulkCreateRequest = @"{
try {
$Result = ConvertFrom-JsonToObjectMappingBulkCreateRequest -Json $ObjectMappingBulkCreateRequest
New-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result
New-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result
# Below is a request that includes all optional parameters
# New-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $ObjectMappingBulkCreateRequest
# New-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ObjectMappings"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-uploaded-configuration
This API uploads a JSON configuration file into a tenant.
@@ -161,6 +168,8 @@ Configuration files can be managed and deployed via Configuration Hub by uploadi
Refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects) for more information about supported objects.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-uploaded-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -192,7 +201,7 @@ $Name = "MyName" # String | Name that will be assigned to the uploaded configura
# Upload a Configuration
try {
New-UploadedConfiguration -Data $Data -Name $Name
New-UploadedConfiguration -Data $Data -Name $Name
# Below is a request that includes all optional parameters
# New-UploadedConfiguration -Data $Data -Name $Name
@@ -202,12 +211,15 @@ try {
}
```
[[Back to top]](#)
## delete-object-mapping
This deletes an existing object mapping.
Source org should be "default" when deleting an object mapping that is not associated to any particular org.
The request will need the following security scope:
- sp:config-object-mapping:manage
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-object-mapping)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -240,7 +252,7 @@ $ObjectMappingId = "3d6e0144-963f-4bd6-8d8d-d77b4e507ce4" # String | The id of t
# Deletes an object mapping
try {
Remove-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId
Remove-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId
# Below is a request that includes all optional parameters
# Remove-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId
@@ -250,6 +262,7 @@ try {
}
```
[[Back to top]](#)
## delete-uploaded-configuration
This API deletes an uploaded configuration based on Id.
@@ -257,6 +270,8 @@ On success, this endpoint will return an empty response.
The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-uploaded-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -297,12 +312,15 @@ try {
}
```
[[Back to top]](#)
## get-object-mappings
This gets a list of existing object mappings between current org and source org.
Source org should be "default" when getting object mappings that are not associated to any particular org.
The request will need the following security scope:
- sp:config-object-mapping:read
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-object-mappings)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -343,9 +361,12 @@ try {
}
```
[[Back to top]](#)
## get-uploaded-configuration
This API gets an existing uploaded configuration for the current tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-uploaded-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -386,9 +407,12 @@ try {
}
```
[[Back to top]](#)
## list-uploaded-configurations
This API gets a list of existing uploaded configurations for the current tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-uploaded-configurations)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -419,7 +443,7 @@ $Filters = 'status eq "COMPLETE"' # String | Filter results using the standard s
# List Uploaded Configurations
try {
Get-UploadedConfigurations
Get-UploadedConfigurations
# Below is a request that includes all optional parameters
# Get-UploadedConfigurations -Filters $Filters
@@ -429,12 +453,15 @@ try {
}
```
[[Back to top]](#)
## update-object-mappings
This updates a set of object mappings, only enabled and targetValue fields can be updated.
Source org should be "default" when updating object mappings that are not associated to any particular org.
The request will need the following security scope:
- sp:config-object-mapping:manage
[API Spec](https://developer.sailpoint.com/docs/api/v3/update-object-mappings)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -481,10 +508,10 @@ $ObjectMappingBulkPatchRequest = @"{
try {
$Result = ConvertFrom-JsonToObjectMappingBulkPatchRequest -Json $ObjectMappingBulkPatchRequest
Update-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result
Update-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result
# Below is a request that includes all optional parameters
# Update-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $ObjectMappingBulkPatchRequest
# Update-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ObjectMappings"
Write-Host $_.ErrorDetails

51
docs/tools/sdk/powershell/Reference/V3/Methods/ConnectorsApi.md
View File

@@ -43,9 +43,12 @@ Method | HTTP request | Description
[**Send-ConnectorTranslations**](#put-connector-translations) | **PUT** `/connectors/{scriptName}/translations/{locale}` | Update Connector Translations
[**Update-Connector**](#update-connector) | **PATCH** `/connectors/{scriptName}` | Update Connector by Script Name
## create-custom-connector
Create custom connector.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-custom-connector)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -83,19 +86,22 @@ $V3CreateConnectorDto = @"{
try {
$Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto
New-CustomConnector -V3CreateConnectorDto $Result
New-CustomConnector -V3CreateConnectorDto $Result
# Below is a request that includes all optional parameters
# New-CustomConnector -V3CreateConnectorDto $V3CreateConnectorDto
# New-CustomConnector -V3CreateConnectorDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CustomConnector"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-custom-connector
Delete a custom connector that using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-custom-connector)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -136,9 +142,12 @@ try {
}
```
[[Back to top]](#)
## get-connector
Fetches a connector that using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -181,9 +190,12 @@ try {
}
```
[[Back to top]](#)
## get-connector-list
Fetches list of connectors that have 'RELEASED' status using filtering and pagination.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector-list)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -222,7 +234,7 @@ $Locale = "de" # String | The locale to apply to the config. If no viable locale
# Get Connector List
try {
Get-ConnectorList
Get-ConnectorList
# Below is a request that includes all optional parameters
# Get-ConnectorList -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count -Locale $Locale
@@ -232,9 +244,12 @@ try {
}
```
[[Back to top]](#)
## get-connector-source-config
Fetches a connector's source config using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector-source-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -275,9 +290,12 @@ try {
}
```
[[Back to top]](#)
## get-connector-source-template
Fetches a connector's source template using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector-source-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -318,9 +336,12 @@ try {
}
```
[[Back to top]](#)
## get-connector-translations
Fetches a connector's translations using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector-translations)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -353,7 +374,7 @@ $Locale = "de" # String | The locale to apply to the config. If no viable locale
# Get Connector Translations
try {
Get-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale
Get-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale
# Below is a request that includes all optional parameters
# Get-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale
@@ -363,9 +384,12 @@ try {
}
```
[[Back to top]](#)
## put-connector-source-config
Update a connector's source config using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v3/put-connector-source-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -398,7 +422,7 @@ $File = # System.IO.FileInfo | connector source config xml file
# Update Connector Source Configuration
try {
Send-ConnectorSourceConfig -ScriptName $ScriptName -File $File
Send-ConnectorSourceConfig -ScriptName $ScriptName -File $File
# Below is a request that includes all optional parameters
# Send-ConnectorSourceConfig -ScriptName $ScriptName -File $File
@@ -408,9 +432,12 @@ try {
}
```
[[Back to top]](#)
## put-connector-source-template
Update a connector's source template using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v3/put-connector-source-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -443,7 +470,7 @@ $File = # System.IO.FileInfo | connector source template xml file
# Update Connector Source Template
try {
Send-ConnectorSourceTemplate -ScriptName $ScriptName -File $File
Send-ConnectorSourceTemplate -ScriptName $ScriptName -File $File
# Below is a request that includes all optional parameters
# Send-ConnectorSourceTemplate -ScriptName $ScriptName -File $File
@@ -453,9 +480,12 @@ try {
}
```
[[Back to top]](#)
## put-connector-translations
Update a connector's translations using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v3/put-connector-translations)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -488,7 +518,7 @@ $Locale = "de" # String | The locale to apply to the config. If no viable locale
# Update Connector Translations
try {
Send-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale
Send-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale
# Below is a request that includes all optional parameters
# Send-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale
@@ -498,6 +528,7 @@ try {
}
```
[[Back to top]](#)
## update-connector
This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
@@ -513,6 +544,8 @@ The following fields are patchable:
* sourceConfigXml
[API Spec](https://developer.sailpoint.com/docs/api/v3/update-connector)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -551,10 +584,10 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Sc
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-Connector -ScriptName $ScriptName -JsonPatchOperation $Result
Update-Connector -ScriptName $ScriptName -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-Connector -ScriptName $ScriptName -JsonPatchOperation $JsonPatchOperation
# Update-Connector -ScriptName $ScriptName -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Connector"
Write-Host $_.ErrorDetails

55
docs/tools/sdk/powershell/Reference/V3/Methods/GlobalTenantSecuritySettingsApi.md
View File

@@ -30,9 +30,12 @@ Method | HTTP request | Description
[**Update-AuthOrgServiceProviderConfig**](#patch-auth-org-service-provider-config) | **PATCH** `/auth-org/service-provider-config` | Update Service Provider Configuration
[**Update-AuthOrgSessionConfig**](#patch-auth-org-session-config) | **PATCH** `/auth-org/session-config` | Update Auth Org Session Configuration
## create-auth-org-network-config
This API returns the details of an org's network auth configuration. Requires security scope of: 'sp:auth-org:manage'
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-auth-org-network-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -68,19 +71,22 @@ $NetworkConfiguration = @"{
try {
$Result = ConvertFrom-JsonToNetworkConfiguration -Json $NetworkConfiguration
New-AuthOrgNetworkConfig -NetworkConfiguration $Result
New-AuthOrgNetworkConfig -NetworkConfiguration $Result
# Below is a request that includes all optional parameters
# New-AuthOrgNetworkConfig -NetworkConfiguration $NetworkConfiguration
# New-AuthOrgNetworkConfig -NetworkConfiguration $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AuthOrgNetworkConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-auth-org-lockout-config
This API returns the details of an org's lockout auth configuration.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-auth-org-lockout-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -109,7 +115,7 @@ Code | Description | Data Type
# Get Auth Org Lockout Configuration.
try {
Get-AuthOrgLockoutConfig
Get-AuthOrgLockoutConfig
# Below is a request that includes all optional parameters
# Get-AuthOrgLockoutConfig
@@ -119,9 +125,12 @@ try {
}
```
[[Back to top]](#)
## get-auth-org-network-config
This API returns the details of an org's network auth configuration.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-auth-org-network-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -150,7 +159,7 @@ Code | Description | Data Type
# Get security network configuration.
try {
Get-AuthOrgNetworkConfig
Get-AuthOrgNetworkConfig
# Below is a request that includes all optional parameters
# Get-AuthOrgNetworkConfig
@@ -160,9 +169,12 @@ try {
}
```
[[Back to top]](#)
## get-auth-org-service-provider-config
This API returns the details of an org's service provider auth configuration.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-auth-org-service-provider-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -191,7 +203,7 @@ Code | Description | Data Type
# Get Service Provider Configuration.
try {
Get-AuthOrgServiceProviderConfig
Get-AuthOrgServiceProviderConfig
# Below is a request that includes all optional parameters
# Get-AuthOrgServiceProviderConfig
@@ -201,9 +213,12 @@ try {
}
```
[[Back to top]](#)
## get-auth-org-session-config
This API returns the details of an org's session auth configuration.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-auth-org-session-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -232,7 +247,7 @@ Code | Description | Data Type
# Get Auth Org Session Configuration.
try {
Get-AuthOrgSessionConfig
Get-AuthOrgSessionConfig
# Below is a request that includes all optional parameters
# Get-AuthOrgSessionConfig
@@ -242,10 +257,13 @@ try {
}
```
[[Back to top]](#)
## patch-auth-org-lockout-config
This API updates an existing lockout configuration for an org using PATCH
[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-auth-org-lockout-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -282,20 +300,23 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-AuthOrgLockoutConfig -JsonPatchOperation $Result
Update-AuthOrgLockoutConfig -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-AuthOrgLockoutConfig -JsonPatchOperation $JsonPatchOperation
# Update-AuthOrgLockoutConfig -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgLockoutConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-auth-org-network-config
This API updates an existing network configuration for an org using PATCH
Requires security scope of: 'sp:auth-org:manage'
[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-auth-org-network-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -332,19 +353,22 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-AuthOrgNetworkConfig -JsonPatchOperation $Result
Update-AuthOrgNetworkConfig -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-AuthOrgNetworkConfig -JsonPatchOperation $JsonPatchOperation
# Update-AuthOrgNetworkConfig -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgNetworkConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-auth-org-service-provider-config
This API updates an existing service provider configuration for an org using PATCH.
[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-auth-org-service-provider-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -381,19 +405,22 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-AuthOrgServiceProviderConfig -JsonPatchOperation $Result
Update-AuthOrgServiceProviderConfig -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-AuthOrgServiceProviderConfig -JsonPatchOperation $JsonPatchOperation
# Update-AuthOrgServiceProviderConfig -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgServiceProviderConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-auth-org-session-config
This API updates an existing session configuration for an org using PATCH.
[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-auth-org-session-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -430,10 +457,10 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-AuthOrgSessionConfig -JsonPatchOperation $Result
Update-AuthOrgSessionConfig -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-AuthOrgSessionConfig -JsonPatchOperation $JsonPatchOperation
# Update-AuthOrgSessionConfig -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgSessionConfig"
Write-Host $_.ErrorDetails

57
docs/tools/sdk/powershell/Reference/V3/Methods/IdentityProfilesApi.md
View File

@@ -39,9 +39,12 @@ Method | HTTP request | Description
[**Sync-IdentityProfile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile
[**Update-IdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update the Identity Profile
## create-identity-profile
This creates an Identity Profile.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-identity-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -120,16 +123,17 @@ $IdentityProfile = @"{
try {
$Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile
New-IdentityProfile -IdentityProfile $Result
New-IdentityProfile -IdentityProfile $Result
# Below is a request that includes all optional parameters
# New-IdentityProfile -IdentityProfile $IdentityProfile
# New-IdentityProfile -IdentityProfile $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-IdentityProfile"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-identity-profile
This deletes an Identity Profile based on ID.
@@ -138,6 +142,8 @@ On success, this endpoint will return a reference to the bulk delete task result
The following rights are required to access this endpoint: idn:identity-profile:delete
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-identity-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -178,6 +184,7 @@ try {
}
```
[[Back to top]](#)
## delete-identity-profiles
This deletes multiple Identity Profiles via a list of supplied IDs.
@@ -185,6 +192,8 @@ On success, this endpoint will return a reference to the bulk delete task result
The following rights are required to access this endpoint: idn:identity-profile:delete
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-identity-profiles)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -217,19 +226,22 @@ $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Remove-IdentityProfiles -RequestBody $Result
Remove-IdentityProfiles -RequestBody $Result
# Below is a request that includes all optional parameters
# Remove-IdentityProfiles -RequestBody $RequestBody
# Remove-IdentityProfiles -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-IdentityProfiles"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## export-identity-profiles
This exports existing identity profiles in the format specified by the sp-config service.
[API Spec](https://developer.sailpoint.com/docs/api/v3/export-identity-profiles)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -267,7 +279,7 @@ $Sorters = "id,name" # String | Sort results using the standard syntax described
# Export Identity Profiles
try {
Export-IdentityProfiles
Export-IdentityProfiles
# Below is a request that includes all optional parameters
# Export-IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
@@ -277,9 +289,12 @@ try {
}
```
[[Back to top]](#)
## get-default-identity-attribute-config
This returns the default identity attribute config.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-default-identity-attribute-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -320,9 +335,12 @@ try {
}
```
[[Back to top]](#)
## get-identity-profile
This returns a single Identity Profile based on ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -363,9 +381,12 @@ try {
}
```
[[Back to top]](#)
## import-identity-profiles
This imports previously exported identity profiles.
[API Spec](https://developer.sailpoint.com/docs/api/v3/import-identity-profiles)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -458,19 +479,22 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject
Import-IdentityProfiles -IdentityProfileExportedObject $Result
Import-IdentityProfiles -IdentityProfileExportedObject $Result
# Below is a request that includes all optional parameters
# Import-IdentityProfiles -IdentityProfileExportedObject $IdentityProfileExportedObject
# Import-IdentityProfiles -IdentityProfileExportedObject $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-IdentityProfiles"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-identity-profiles
This returns a list of Identity Profiles based on the specified query parameters.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-identity-profiles)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -508,7 +532,7 @@ $Sorters = "id,name" # String | Sort results using the standard syntax described
# Identity Profiles List
try {
Get-IdentityProfiles
Get-IdentityProfiles
# Below is a request that includes all optional parameters
# Get-IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
@@ -518,10 +542,13 @@ try {
}
```
[[Back to top]](#)
## show-identity-preview
Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body.
This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body.
[API Spec](https://developer.sailpoint.com/docs/api/v3/show-identity-preview)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -578,16 +605,17 @@ $IdentityPreviewRequest = @"{
try {
$Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest
Show-IdentityPreview -IdentityPreviewRequest $Result
Show-IdentityPreview -IdentityPreviewRequest $Result
# Below is a request that includes all optional parameters
# Show-IdentityPreview -IdentityPreviewRequest $IdentityPreviewRequest
# Show-IdentityPreview -IdentityPreviewRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-IdentityPreview"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## sync-identity-profile
Process identities under the profile
This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized.
@@ -595,6 +623,8 @@ This should only be run on identity profiles that have the `identityRefreshRequi
This operation will perform the following activities on all identities under the identity profile.
1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity's correct manager through manager correlation. 3. Updates the identity's access according to their assigned lifecycle state. 4. Updates the identity's access based on role assignment criteria.
[API Spec](https://developer.sailpoint.com/docs/api/v3/sync-identity-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -635,6 +665,7 @@ try {
}
```
[[Back to top]](#)
## update-identity-profile
This updates the specified Identity Profile.
@@ -648,6 +679,8 @@ Some fields of the Schema cannot be updated. These fields are listed below:
* identityRefreshRequired
* Authoritative Source and Identity Attribute Configuration cannot be modified at once.
[API Spec](https://developer.sailpoint.com/docs/api/v3/update-identity-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -686,10 +719,10 @@ $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result
Update-IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $JsonPatchOperation
# Update-IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-IdentityProfile"
Write-Host $_.ErrorDetails

34
docs/tools/sdk/powershell/Reference/V3/Methods/LifecycleStatesApi.md
View File

@@ -62,9 +62,12 @@ Method | HTTP request | Description
[**Set-LifecycleState**](#set-lifecycle-state) | **POST** `/identities/{identity-id}/set-lifecycle-state` | Set Lifecycle State
[**Update-LifecycleStates**](#update-lifecycle-states) | **PATCH** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State
## create-lifecycle-state
Use this endpoint to create a lifecycle state.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-lifecycle-state)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -121,19 +124,22 @@ $LifecycleState = @"{
try {
$Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState
New-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result
New-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result
# Below is a request that includes all optional parameters
# New-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $LifecycleState
# New-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-LifecycleState"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-lifecycle-state
Use this endpoint to delete the lifecycle state by its ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-lifecycle-state)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -166,7 +172,7 @@ $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle stat
# Delete Lifecycle State
try {
Remove-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
Remove-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
# Below is a request that includes all optional parameters
# Remove-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
@@ -176,9 +182,12 @@ try {
}
```
[[Back to top]](#)
## get-lifecycle-state
Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-lifecycle-state)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -211,7 +220,7 @@ $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle stat
# Get Lifecycle State
try {
Get-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
Get-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
# Below is a request that includes all optional parameters
# Get-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
@@ -221,9 +230,12 @@ try {
}
```
[[Back to top]](#)
## get-lifecycle-states
Use this endpoint to list all lifecycle states by their associated identity profiles.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-lifecycle-states)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -271,9 +283,12 @@ try {
}
```
[[Back to top]](#)
## set-lifecycle-state
Use this API to set/update an identity's lifecycle state to the one provided and update the corresponding identity profile.
[API Spec](https://developer.sailpoint.com/docs/api/v3/set-lifecycle-state)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -307,19 +322,22 @@ $SetLifecycleStateRequest = @""@
try {
$Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest
Set-LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result
Set-LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result
# Below is a request that includes all optional parameters
# Set-LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $SetLifecycleStateRequest
# Set-LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-LifecycleState"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-lifecycle-states
Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
[API Spec](https://developer.sailpoint.com/docs/api/v3/update-lifecycle-states)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -360,10 +378,10 @@ $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle stat
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result
Update-LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $JsonPatchOperation
# Update-LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-LifecycleStates"
Write-Host $_.ErrorDetails

42
docs/tools/sdk/powershell/Reference/V3/Methods/MFAConfigurationApi.md
View File

@@ -26,9 +26,12 @@ Method | HTTP request | Description
[**Set-MFAOktaConfig**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set Okta MFA configuration
[**Test-MFAConfig**](#test-mfa-config) | **GET** `/mfa/{method}/test` | MFA method's test configuration
## delete-mfa-config
This API removes the configuration for the specified MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-mfa-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -68,9 +71,12 @@ try {
}
```
[[Back to top]](#)
## get-mfa-duo-config
This API returns the configuration of an Duo MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-mfa-duo-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -98,7 +104,7 @@ Code | Description | Data Type
# Configuration of Duo MFA method
try {
Get-MFADuoConfig
Get-MFADuoConfig
# Below is a request that includes all optional parameters
# Get-MFADuoConfig
@@ -108,9 +114,12 @@ try {
}
```
[[Back to top]](#)
## get-mfa-kba-config
This API returns the KBA configuration for MFA.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-mfa-kba-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -140,7 +149,7 @@ $AllLanguages = $false # Boolean | Indicator whether the question text should be
# Configuration of KBA MFA method
try {
Get-MFAKbaConfig
Get-MFAKbaConfig
# Below is a request that includes all optional parameters
# Get-MFAKbaConfig -AllLanguages $AllLanguages
@@ -150,9 +159,12 @@ try {
}
```
[[Back to top]](#)
## get-mfa-okta-config
This API returns the configuration of an Okta MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-mfa-okta-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -180,7 +192,7 @@ Code | Description | Data Type
# Configuration of Okta MFA method
try {
Get-MFAOktaConfig
Get-MFAOktaConfig
# Below is a request that includes all optional parameters
# Get-MFAOktaConfig
@@ -190,9 +202,12 @@ try {
}
```
[[Back to top]](#)
## set-mfa-duo-config
This API sets the configuration of an Duo MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/v3/set-mfa-duo-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -233,19 +248,22 @@ $MfaDuoConfig = @"{
try {
$Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig
Set-MFADuoConfig -MfaDuoConfig $Result
Set-MFADuoConfig -MfaDuoConfig $Result
# Below is a request that includes all optional parameters
# Set-MFADuoConfig -MfaDuoConfig $MfaDuoConfig
# Set-MFADuoConfig -MfaDuoConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFADuoConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-mfakba-config
This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration.
[API Spec](https://developer.sailpoint.com/docs/api/v3/set-mfakba-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -280,19 +298,22 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem
Set-MFAKBAConfig -KbaAnswerRequestItem $Result
Set-MFAKBAConfig -KbaAnswerRequestItem $Result
# Below is a request that includes all optional parameters
# Set-MFAKBAConfig -KbaAnswerRequestItem $KbaAnswerRequestItem
# Set-MFAKBAConfig -KbaAnswerRequestItem $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFAKBAConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-mfa-okta-config
This API sets the configuration of an Okta MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/v3/set-mfa-okta-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -329,19 +350,22 @@ $MfaOktaConfig = @"{
try {
$Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig
Set-MFAOktaConfig -MfaOktaConfig $Result
Set-MFAOktaConfig -MfaOktaConfig $Result
# Below is a request that includes all optional parameters
# Set-MFAOktaConfig -MfaOktaConfig $MfaOktaConfig
# Set-MFAOktaConfig -MfaOktaConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFAOktaConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## test-mfa-config
This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter.
[API Spec](https://developer.sailpoint.com/docs/api/v3/test-mfa-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------

42
docs/tools/sdk/powershell/Reference/V3/Methods/MFAControllerApi.md
View File

@@ -24,9 +24,12 @@ Method | HTTP request | Description
[**Send-OktaVerifyRequest**](#send-okta-verify-request) | **POST** `/mfa/okta-verify/verify` | Verifying authentication via Okta method
[**Send-TokenAuthRequest**](#send-token-auth-request) | **POST** `/mfa/token/authenticate` | Authenticate Token provided MFA method
## create-send-token
This API send token request.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-send-token)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -60,19 +63,22 @@ $SendTokenRequest = @"{
try {
$Result = ConvertFrom-JsonToSendTokenRequest -Json $SendTokenRequest
New-SendToken -SendTokenRequest $Result
New-SendToken -SendTokenRequest $Result
# Below is a request that includes all optional parameters
# New-SendToken -SendTokenRequest $SendTokenRequest
# New-SendToken -SendTokenRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SendToken"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## ping-verification-status
This API poll the VerificationPollRequest for the specified MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/v3/ping-verification-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -107,19 +113,22 @@ $VerificationPollRequest = @"{
try {
$Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest
Ping-VerificationStatus -Method $Method -VerificationPollRequest $Result
Ping-VerificationStatus -Method $Method -VerificationPollRequest $Result
# Below is a request that includes all optional parameters
# Ping-VerificationStatus -Method $Method -VerificationPollRequest $VerificationPollRequest
# Ping-VerificationStatus -Method $Method -VerificationPollRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-VerificationStatus"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## send-duo-verify-request
This API Authenticates the user via Duo-Web MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/v3/send-duo-verify-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -153,19 +162,22 @@ $DuoVerificationRequest = @"{
try {
$Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest
Send-DuoVerifyRequest -DuoVerificationRequest $Result
Send-DuoVerifyRequest -DuoVerificationRequest $Result
# Below is a request that includes all optional parameters
# Send-DuoVerifyRequest -DuoVerificationRequest $DuoVerificationRequest
# Send-DuoVerifyRequest -DuoVerificationRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-DuoVerifyRequest"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## send-kba-answers
This API Authenticate user in KBA MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/v3/send-kba-answers)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -200,19 +212,22 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem
Send-KbaAnswers -KbaAnswerRequestItem $Result
Send-KbaAnswers -KbaAnswerRequestItem $Result
# Below is a request that includes all optional parameters
# Send-KbaAnswers -KbaAnswerRequestItem $KbaAnswerRequestItem
# Send-KbaAnswers -KbaAnswerRequestItem $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-KbaAnswers"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## send-okta-verify-request
This API Authenticates the user via Okta-Verify MFA method. Request requires a header called 'slpt-forwarding', and it must contain a remote IP Address of caller.
[API Spec](https://developer.sailpoint.com/docs/api/v3/send-okta-verify-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -245,19 +260,22 @@ $OktaVerificationRequest = @"{
try {
$Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest
Send-OktaVerifyRequest -OktaVerificationRequest $Result
Send-OktaVerifyRequest -OktaVerificationRequest $Result
# Below is a request that includes all optional parameters
# Send-OktaVerifyRequest -OktaVerificationRequest $OktaVerificationRequest
# Send-OktaVerifyRequest -OktaVerificationRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-OktaVerifyRequest"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## send-token-auth-request
This API Authenticate user in Token MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/v3/send-token-auth-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -292,10 +310,10 @@ $TokenAuthRequest = @"{
try {
$Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest
Send-TokenAuthRequest -TokenAuthRequest $Result
Send-TokenAuthRequest -TokenAuthRequest $Result
# Below is a request that includes all optional parameters
# Send-TokenAuthRequest -TokenAuthRequest $TokenAuthRequest
# Send-TokenAuthRequest -TokenAuthRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TokenAuthRequest"
Write-Host $_.ErrorDetails

30
docs/tools/sdk/powershell/Reference/V3/Methods/ManagedClientsApi.md
View File

@@ -26,10 +26,13 @@ Method | HTTP request | Description
[**Get-ManagedClients**](#get-managed-clients) | **GET** `/managed-clients` | Get Managed Clients
[**Update-ManagedClient**](#update-managed-client) | **PATCH** `/managed-clients/{id}` | Update Managed Client
## create-managed-client
Create a new managed client.
The API returns a result that includes the managed client ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-managed-client)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -65,19 +68,22 @@ $ManagedClientRequest = @"{
try {
$Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest
New-ManagedClient -ManagedClientRequest $Result
New-ManagedClient -ManagedClientRequest $Result
# Below is a request that includes all optional parameters
# New-ManagedClient -ManagedClientRequest $ManagedClientRequest
# New-ManagedClient -ManagedClientRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedClient"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-managed-client
Delete an existing managed client.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-managed-client)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -117,9 +123,12 @@ try {
}
```
[[Back to top]](#)
## get-managed-client
Get managed client by ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-client)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -160,9 +169,12 @@ try {
}
```
[[Back to top]](#)
## get-managed-client-status
Get a managed client's status, using its ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-client-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -195,7 +207,7 @@ $Type = "CCG" # ManagedClientType | Managed client type to get status for.
# Get Managed Client Status
try {
Get-ManagedClientStatus -Id $Id -Type $Type
Get-ManagedClientStatus -Id $Id -Type $Type
# Below is a request that includes all optional parameters
# Get-ManagedClientStatus -Id $Id -Type $Type
@@ -205,9 +217,12 @@ try {
}
```
[[Back to top]](#)
## get-managed-clients
List managed clients.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-clients)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -243,7 +258,7 @@ $Filters = 'name eq "client name"' # String | Filter results using the standard
# Get Managed Clients
try {
Get-ManagedClients
Get-ManagedClients
# Below is a request that includes all optional parameters
# Get-ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters
@@ -253,9 +268,12 @@ try {
}
```
[[Back to top]](#)
## update-managed-client
Update an existing managed client.
[API Spec](https://developer.sailpoint.com/docs/api/v3/update-managed-client)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -294,10 +312,10 @@ $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID.
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-ManagedClient -Id $Id -JsonPatchOperation $Result
Update-ManagedClient -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-ManagedClient -Id $Id -JsonPatchOperation $JsonPatchOperation
# Update-ManagedClient -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedClient"
Write-Host $_.ErrorDetails

35
docs/tools/sdk/powershell/Reference/V3/Methods/ManagedClustersApi.md
View File

@@ -27,10 +27,13 @@ Method | HTTP request | Description
[**Send-ClientLogConfiguration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update Managed Cluster Log Configuration
[**Update-ManagedCluster**](#update-managed-cluster) | **PATCH** `/managed-clusters/{id}` | Update Managed Cluster
## create-managed-cluster
Create a new Managed Cluster.
The API returns a result that includes the managed cluster ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-managed-cluster)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -69,19 +72,22 @@ $ManagedClusterRequest = @"{
try {
$Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest
New-ManagedCluster -ManagedClusterRequest $Result
New-ManagedCluster -ManagedClusterRequest $Result
# Below is a request that includes all optional parameters
# New-ManagedCluster -ManagedClusterRequest $ManagedClusterRequest
# New-ManagedCluster -ManagedClusterRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedCluster"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-managed-cluster
Delete an existing managed cluster.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-managed-cluster)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -123,9 +129,12 @@ try {
}
```
[[Back to top]](#)
## get-client-log-configuration
Get a managed cluster's log configuration.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-client-log-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -167,9 +176,12 @@ try {
}
```
[[Back to top]](#)
## get-managed-cluster
Get a managed cluster by ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-cluster)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -210,9 +222,12 @@ try {
}
```
[[Back to top]](#)
## get-managed-clusters
List current organization's managed clusters, based on request context.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-clusters)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -248,7 +263,7 @@ $Filters = 'operational eq "operation"' # String | Filter results using the stan
# Get Managed Clusters
try {
Get-ManagedClusters
Get-ManagedClusters
# Below is a request that includes all optional parameters
# Get-ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters
@@ -258,9 +273,12 @@ try {
}
```
[[Back to top]](#)
## put-client-log-configuration
Update a managed cluster's log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240.
[API Spec](https://developer.sailpoint.com/docs/api/v3/put-client-log-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -294,19 +312,22 @@ $PutClientLogConfigurationRequest = @""@
try {
$Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest
Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result
Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result
# Below is a request that includes all optional parameters
# Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $PutClientLogConfigurationRequest
# Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ClientLogConfiguration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-managed-cluster
Update an existing managed cluster.
[API Spec](https://developer.sailpoint.com/docs/api/v3/update-managed-cluster)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -345,10 +366,10 @@ $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID.
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-ManagedCluster -Id $Id -JsonPatchOperation $Result
Update-ManagedCluster -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-ManagedCluster -Id $Id -JsonPatchOperation $JsonPatchOperation
# Update-ManagedCluster -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedCluster"
Write-Host $_.ErrorDetails

150
docs/tools/sdk/powershell/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md
View File

@@ -81,9 +81,12 @@ Method | HTTP request | Description
[**Deny-NonEmployeeRequest**](#reject-non-employee-request) | **POST** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request
[**Update-NonEmployeeRecord**](#update-non-employee-record) | **PUT** `/non-employee-records/{id}` | Update Non-Employee Record
## approve-non-employee-request
Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver.
[API Spec](https://developer.sailpoint.com/docs/api/v3/approve-non-employee-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -118,20 +121,23 @@ $NonEmployeeApprovalDecision = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision
Approve-NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result
Approve-NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result
# Below is a request that includes all optional parameters
# Approve-NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $NonEmployeeApprovalDecision
# Approve-NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-NonEmployeeRequest"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-non-employee-record
This request will create a non-employee record.
Requires role context of `idn:nesr:create`
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-non-employee-record)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -175,19 +181,22 @@ $NonEmployeeRequestBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody
New-NonEmployeeRecord -NonEmployeeRequestBody $Result
New-NonEmployeeRecord -NonEmployeeRequestBody $Result
# Below is a request that includes all optional parameters
# New-NonEmployeeRecord -NonEmployeeRequestBody $NonEmployeeRequestBody
# New-NonEmployeeRecord -NonEmployeeRequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeRecord"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-non-employee-request
This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-non-employee-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -231,19 +240,22 @@ $NonEmployeeRequestBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody
New-NonEmployeeRequest -NonEmployeeRequestBody $Result
New-NonEmployeeRequest -NonEmployeeRequestBody $Result
# Below is a request that includes all optional parameters
# New-NonEmployeeRequest -NonEmployeeRequestBody $NonEmployeeRequestBody
# New-NonEmployeeRequest -NonEmployeeRequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeRequest"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-non-employee-source
This request will create a non-employee source. Requires role context of `idn:nesr:create`
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-non-employee-source)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -299,20 +311,23 @@ $NonEmployeeSourceRequestBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody
New-NonEmployeeSource -NonEmployeeSourceRequestBody $Result
New-NonEmployeeSource -NonEmployeeSourceRequestBody $Result
# Below is a request that includes all optional parameters
# New-NonEmployeeSource -NonEmployeeSourceRequestBody $NonEmployeeSourceRequestBody
# New-NonEmployeeSource -NonEmployeeSourceRequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeSource"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-non-employee-source-schema-attributes
This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response.
Requires role context of `idn:nesr:create`
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-non-employee-source-schema-attributes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -352,20 +367,23 @@ $NonEmployeeSchemaAttributeBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody
New-NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result
New-NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result
# Below is a request that includes all optional parameters
# New-NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $NonEmployeeSchemaAttributeBody
# New-NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeSourceSchemaAttributes"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-non-employee-record
This request will delete a non-employee record.
Requires role context of `idn:nesr:delete`
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-record)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -405,9 +423,12 @@ try {
}
```
[[Back to top]](#)
## delete-non-employee-records-in-bulk
This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete`
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-records-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -438,20 +459,23 @@ $DeleteNonEmployeeRecordsInBulkRequest = @""@
try {
$Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest
Remove-NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result
Remove-NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result
# Below is a request that includes all optional parameters
# Remove-NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $DeleteNonEmployeeRecordsInBulkRequest
# Remove-NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRecordsInBulk"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-non-employee-request
This request will delete a non-employee request.
Requires role context of `idn:nesr:delete`
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -492,11 +516,14 @@ try {
}
```
[[Back to top]](#)
## delete-non-employee-schema-attribute
This end-point deletes a specific schema attribute for a non-employee source.
Requires role context of `idn:nesr:delete`
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-schema-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -528,7 +555,7 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
# Delete a Schema Attribute for Non-Employee Source
try {
Remove-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
Remove-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
# Below is a request that includes all optional parameters
# Remove-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
@@ -538,9 +565,12 @@ try {
}
```
[[Back to top]](#)
## delete-non-employee-source
This request will delete a non-employee source. Requires role context of `idn:nesr:delete`.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-source)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -580,9 +610,12 @@ try {
}
```
[[Back to top]](#)
## delete-non-employee-source-schema-attributes
This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete`
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-source-schema-attributes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -622,9 +655,12 @@ try {
}
```
[[Back to top]](#)
## export-non-employee-records
This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read`
[API Spec](https://developer.sailpoint.com/docs/api/v3/export-non-employee-records)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -665,9 +701,12 @@ try {
}
```
[[Back to top]](#)
## export-non-employee-source-schema-template
This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read`
[API Spec](https://developer.sailpoint.com/docs/api/v3/export-non-employee-source-schema-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -708,12 +747,15 @@ try {
}
```
[[Back to top]](#)
## get-non-employee-approval
Gets a non-employee approval item detail. There are two contextual uses for this endpoint:
1. The user has the role context of `idn:nesr:read`, in which case they
can get any approval.
2. The user owns the requested approval.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-approval)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -755,6 +797,7 @@ try {
}
```
[[Back to top]](#)
## get-non-employee-approval-summary
This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter:
1. The user has the role context of `idn:nesr:read`, in which case he or
@@ -762,6 +805,8 @@ she may request a summary of all non-employee approval requests assigned to a pa
2. The current user is an approver, in which case "me" should be provided
as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-approval-summary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -801,11 +846,14 @@ try {
}
```
[[Back to top]](#)
## get-non-employee-bulk-upload-status
The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source.
Requires role context of `idn:nesr:read`
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-bulk-upload-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -845,10 +893,13 @@ try {
}
```
[[Back to top]](#)
## get-non-employee-record
This gets a non-employee record.
Requires role context of `idn:nesr:read`
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-record)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -888,6 +939,7 @@ try {
}
```
[[Back to top]](#)
## get-non-employee-request
This gets a non-employee request.
There are two contextual uses for this endpoint:
@@ -895,6 +947,8 @@ There are two contextual uses for this endpoint:
can get the non-employee request for any user.
2. The user must be the owner of the non-employee request.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -935,6 +989,7 @@ try {
}
```
[[Back to top]](#)
## get-non-employee-request-summary
This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter:
1. The user has the role context of `idn:nesr:read`, in which case he or
@@ -942,6 +997,8 @@ she may request a summary of all non-employee approval requests assigned to a pa
2. The current user is an account manager, in which case "me" should be
provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-request-summary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -981,9 +1038,12 @@ try {
}
```
[[Back to top]](#)
## get-non-employee-schema-attribute
This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-schema-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1015,7 +1075,7 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
# Get Schema Attribute Non-Employee Source
try {
Get-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
Get-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
@@ -1025,6 +1085,7 @@ try {
}
```
[[Back to top]](#)
## get-non-employee-source
This gets a non-employee source. There are two contextual uses for the requested-for path parameter:
1. The user has the role context of `idn:nesr:read`, in which case he or
@@ -1032,6 +1093,8 @@ she may request any source.
2. The current user is an account manager, in which case the user can only
request sources that they own.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-source)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1071,10 +1134,13 @@ try {
}
```
[[Back to top]](#)
## get-non-employee-source-schema-attributes
This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned.
Requires role context of `idn:nesr:read` or the user must be an account manager of the source.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-source-schema-attributes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1115,9 +1181,12 @@ try {
}
```
[[Back to top]](#)
## import-non-employee-records-in-bulk
This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create`
[API Spec](https://developer.sailpoint.com/docs/api/v3/import-non-employee-records-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1150,7 +1219,7 @@ $Data = # System.IO.FileInfo |
# Imports, or Updates, Non-Employee Records
try {
Import-NonEmployeeRecordsInBulk -Id $Id -Data $Data
Import-NonEmployeeRecordsInBulk -Id $Id -Data $Data
# Below is a request that includes all optional parameters
# Import-NonEmployeeRecordsInBulk -Id $Id -Data $Data
@@ -1160,6 +1229,7 @@ try {
}
```
[[Back to top]](#)
## list-non-employee-approvals
This gets a list of non-employee approval requests.
There are two contextual uses for this endpoint:
@@ -1167,6 +1237,8 @@ There are two contextual uses for this endpoint:
can list the approvals for any approver.
2. The user owns the requested approval.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-non-employee-approvals)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1206,7 +1278,7 @@ $Sorters = "created" # String | Sort results using the standard syntax described
# Get List of Non-Employee Approval Requests
try {
Get-NonEmployeeApprovals
Get-NonEmployeeApprovals
# Below is a request that includes all optional parameters
# Get-NonEmployeeApprovals -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
@@ -1216,11 +1288,14 @@ try {
}
```
[[Back to top]](#)
## list-non-employee-records
This gets a list of non-employee records. There are two contextual uses for this endpoint:
1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees.
2. The user is an account manager, in which case they can get a list of the non-employees that they manage.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-non-employee-records)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1258,7 +1333,7 @@ $Filters = 'sourceId eq "2c91808568c529c60168cca6f90c1313"' # String | Filter re
# List Non-Employee Records
try {
Get-NonEmployeeRecords
Get-NonEmployeeRecords
# Below is a request that includes all optional parameters
# Get-NonEmployeeRecords -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters
@@ -1268,6 +1343,7 @@ try {
}
```
[[Back to top]](#)
## list-non-employee-requests
This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter:
1. The user has the role context of `idn:nesr:read`, in which case he or
@@ -1275,6 +1351,8 @@ she may request a list non-employee requests assigned to a particular account ma
2. The current user is an account manager, in which case "me" should be
provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-non-employee-requests)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1324,6 +1402,7 @@ try {
}
```
[[Back to top]](#)
## list-non-employee-sources
This gets a list of non-employee sources. There are two contextual uses for the requested-for path parameter:
1. The user has the role context of `idn:nesr:read`, in which case he or
@@ -1331,6 +1410,8 @@ she may request a list sources assigned to a particular account manager by passi
2. The current user is an account manager, in which case "me" should be
provided as the `requested-for` value. This will provide the user with a list of the sources that he or she owns.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-non-employee-sources)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1380,6 +1461,7 @@ try {
}
```
[[Back to top]](#)
## patch-non-employee-record
This request will patch a non-employee record. There are two contextual uses for this endpoint:
1. The user has the role context of `idn:nesr:update`, in which case they
@@ -1387,6 +1469,8 @@ update all available fields.
2. The user is owner of the source, in this case they can only update the
end date.
[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-non-employee-record)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1425,21 +1509,24 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-NonEmployeeRecord -Id $Id -JsonPatchOperation $Result
Update-NonEmployeeRecord -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-NonEmployeeRecord -Id $Id -JsonPatchOperation $JsonPatchOperation
# Update-NonEmployeeRecord -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeRecord"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-non-employee-schema-attribute
This end-point patches a specific schema attribute for a non-employee SourceId.
Requires role context of `idn:nesr:update`
[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-non-employee-schema-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1480,19 +1567,22 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result
Update-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $JsonPatchOperation
# Update-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeSchemaAttribute"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-non-employee-source
patch a non-employee source. (partial update) <br/> Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`.
[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-non-employee-source)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1530,19 +1620,22 @@ $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result
Update-NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $JsonPatchOperation
# Update-NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeSource"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## reject-non-employee-request
This endpoint will reject an approval item request and notify user. The current user must be the requested approver.
[API Spec](https://developer.sailpoint.com/docs/api/v3/reject-non-employee-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1577,16 +1670,17 @@ $NonEmployeeRejectApprovalDecision = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision
Deny-NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result
Deny-NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result
# Below is a request that includes all optional parameters
# Deny-NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $NonEmployeeRejectApprovalDecision
# Deny-NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-NonEmployeeRequest"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-non-employee-record
This request will update a non-employee record. There are two contextual uses for this endpoint:
1. The user has the role context of `idn:nesr:update`, in which case they
@@ -1594,6 +1688,8 @@ update all available fields.
2. The user is owner of the source, in this case they can only update the
end date.
[API Spec](https://developer.sailpoint.com/docs/api/v3/update-non-employee-record)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1640,10 +1736,10 @@ $NonEmployeeRequestBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody
Update-NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result
Update-NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result
# Below is a request that includes all optional parameters
# Update-NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $NonEmployeeRequestBody
# Update-NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeRecord"
Write-Host $_.ErrorDetails

25
docs/tools/sdk/powershell/Reference/V3/Methods/OAuthClientsApi.md
View File

@@ -26,9 +26,12 @@ Method | HTTP request | Description
[**Get-OauthClients**](#list-oauth-clients) | **GET** `/oauth-clients` | List OAuth Clients
[**Update-OauthClient**](#patch-oauth-client) | **PATCH** `/oauth-clients/{id}` | Patch OAuth Client
## create-oauth-client
This creates an OAuth client.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-oauth-client)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -75,19 +78,22 @@ $CreateOAuthClientRequest = @"{
try {
$Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest
New-OauthClient -CreateOAuthClientRequest $Result
New-OauthClient -CreateOAuthClientRequest $Result
# Below is a request that includes all optional parameters
# New-OauthClient -CreateOAuthClientRequest $CreateOAuthClientRequest
# New-OauthClient -CreateOAuthClientRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-OauthClient"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-oauth-client
This deletes an OAuth client.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-oauth-client)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -128,9 +134,12 @@ try {
}
```
[[Back to top]](#)
## get-oauth-client
This gets details of an OAuth client.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-oauth-client)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -171,9 +180,12 @@ try {
}
```
[[Back to top]](#)
## list-oauth-clients
This gets a list of OAuth clients.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-oauth-clients)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -203,7 +215,7 @@ $Filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # String | Filter results usin
# List OAuth Clients
try {
Get-OauthClients
Get-OauthClients
# Below is a request that includes all optional parameters
# Get-OauthClients -Filters $Filters
@@ -213,9 +225,12 @@ try {
}
```
[[Back to top]](#)
## patch-oauth-client
This performs a targeted update to the field(s) of an OAuth client.
[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-oauth-client)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -254,10 +269,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-OauthClient -Id $Id -JsonPatchOperation $Result
Update-OauthClient -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-OauthClient -Id $Id -JsonPatchOperation $JsonPatchOperation
# Update-OauthClient -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-OauthClient"
Write-Host $_.ErrorDetails

19
docs/tools/sdk/powershell/Reference/V3/Methods/PasswordConfigurationApi.md
View File

@@ -27,11 +27,14 @@ Method | HTTP request | Description
[**Get-PasswordOrgConfig**](#get-password-org-config) | **GET** `/password-org-config` | Get Password Org Config
[**Send-PasswordOrgConfig**](#put-password-org-config) | **PUT** `/password-org-config` | Update Password Org Config
## create-password-org-config
This API creates the password org config. Unspecified fields will use default value.
To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true".
Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write'
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-password-org-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -67,19 +70,22 @@ $PasswordOrgConfig = @"{
try {
$Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig
New-PasswordOrgConfig -PasswordOrgConfig $Result
New-PasswordOrgConfig -PasswordOrgConfig $Result
# Below is a request that includes all optional parameters
# New-PasswordOrgConfig -PasswordOrgConfig $PasswordOrgConfig
# New-PasswordOrgConfig -PasswordOrgConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordOrgConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-password-org-config
This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read'
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-org-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -107,7 +113,7 @@ Code | Description | Data Type
# Get Password Org Config
try {
Get-PasswordOrgConfig
Get-PasswordOrgConfig
# Below is a request that includes all optional parameters
# Get-PasswordOrgConfig
@@ -117,11 +123,14 @@ try {
}
```
[[Back to top]](#)
## put-password-org-config
This API updates the password org config for specified fields. Other fields will keep original value.
You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions.
Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write'
[API Spec](https://developer.sailpoint.com/docs/api/v3/put-password-org-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -157,10 +166,10 @@ $PasswordOrgConfig = @"{
try {
$Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig
Send-PasswordOrgConfig -PasswordOrgConfig $Result
Send-PasswordOrgConfig -PasswordOrgConfig $Result
# Below is a request that includes all optional parameters
# Send-PasswordOrgConfig -PasswordOrgConfig $PasswordOrgConfig
# Send-PasswordOrgConfig -PasswordOrgConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PasswordOrgConfig"
Write-Host $_.ErrorDetails

10
docs/tools/sdk/powershell/Reference/V3/Methods/PasswordDictionaryApi.md
View File

@@ -67,6 +67,7 @@ Method | HTTP request | Description
[**Get-PasswordDictionary**](#get-password-dictionary) | **GET** `/password-dictionary` | Get Password Dictionary
[**Send-PasswordDictionary**](#put-password-dictionary) | **PUT** `/password-dictionary` | Update Password Dictionary
## get-password-dictionary
This gets password dictionary for the organization.
The password dictionary file can contain lines that are:
@@ -98,6 +99,8 @@ qazxsws
```
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-dictionary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -126,7 +129,7 @@ Code | Description | Data Type
# Get Password Dictionary
try {
Get-PasswordDictionary
Get-PasswordDictionary
# Below is a request that includes all optional parameters
# Get-PasswordDictionary
@@ -136,6 +139,7 @@ try {
}
```
[[Back to top]](#)
## put-password-dictionary
This updates password dictionary for the organization.
The password dictionary file can contain lines that are:
@@ -167,6 +171,8 @@ qazxsws
```
[API Spec](https://developer.sailpoint.com/docs/api/v3/put-password-dictionary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -198,7 +204,7 @@ $File = # System.IO.FileInfo | (optional)
# Update Password Dictionary
try {
Send-PasswordDictionary
Send-PasswordDictionary
# Below is a request that includes all optional parameters
# Send-PasswordDictionary -File $File

17
docs/tools/sdk/powershell/Reference/V3/Methods/PasswordManagementApi.md
View File

@@ -45,9 +45,12 @@ Method | HTTP request | Description
[**Search-PasswordInfo**](#query-password-info) | **POST** `/query-password-info` | Query Password Info
[**Set-Password**](#set-password) | **POST** `/set-password` | Set Identity&#39;s Password
## get-password-change-status
This API returns the status of a password change request.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-change-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -88,10 +91,13 @@ try {
}
```
[[Back to top]](#)
## query-password-info
This API is used to query password related information.
[API Spec](https://developer.sailpoint.com/docs/api/v3/query-password-info)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -125,16 +131,17 @@ $PasswordInfoQueryDTO = @"{
try {
$Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO
Search-PasswordInfo -PasswordInfoQueryDTO $Result
Search-PasswordInfo -PasswordInfoQueryDTO $Result
# Below is a request that includes all optional parameters
# Search-PasswordInfo -PasswordInfoQueryDTO $PasswordInfoQueryDTO
# Search-PasswordInfo -PasswordInfoQueryDTO $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-PasswordInfo"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-password
This API is used to set a password for an identity.
@@ -157,6 +164,8 @@ If you are using a Windows machine, refer to this [guide](https://tecadmin.net/i
You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password.
[API Spec](https://developer.sailpoint.com/docs/api/v3/set-password)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -193,10 +202,10 @@ $PasswordChangeRequest = @"{
try {
$Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest
Set-Password -PasswordChangeRequest $Result
Set-Password -PasswordChangeRequest $Result
# Below is a request that includes all optional parameters
# Set-Password -PasswordChangeRequest $PasswordChangeRequest
# Set-Password -PasswordChangeRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-Password"
Write-Host $_.ErrorDetails

25
docs/tools/sdk/powershell/Reference/V3/Methods/PasswordPoliciesApi.md
View File

@@ -31,9 +31,12 @@ Method | HTTP request | Description
[**Get-PasswordPolicies**](#list-password-policies) | **GET** `/password-policies` | List Password Policies
[**Set-PasswordPolicy**](#set-password-policy) | **PUT** `/password-policies/{id}` | Update Password Policy by ID
## create-password-policy
This API creates the specified password policy.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-password-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -97,19 +100,22 @@ $PasswordPolicyV3Dto = @"{
try {
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
New-PasswordPolicy -PasswordPolicyV3Dto $Result
New-PasswordPolicy -PasswordPolicyV3Dto $Result
# Below is a request that includes all optional parameters
# New-PasswordPolicy -PasswordPolicyV3Dto $PasswordPolicyV3Dto
# New-PasswordPolicy -PasswordPolicyV3Dto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordPolicy"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-password-policy
This API deletes the specified password policy.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-password-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -150,9 +156,12 @@ try {
}
```
[[Back to top]](#)
## get-password-policy-by-id
This API returns the password policy for the specified ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-policy-by-id)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -193,10 +202,13 @@ try {
}
```
[[Back to top]](#)
## list-password-policies
This gets list of all Password Policies.
Requires role of ORG_ADMIN
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-password-policies)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -230,7 +242,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# List Password Policies
try {
Get-PasswordPolicies
Get-PasswordPolicies
# Below is a request that includes all optional parameters
# Get-PasswordPolicies -Limit $Limit -Offset $Offset -Count $Count
@@ -240,9 +252,12 @@ try {
}
```
[[Back to top]](#)
## set-password-policy
This API updates the specified password policy.
[API Spec](https://developer.sailpoint.com/docs/api/v3/set-password-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -308,10 +323,10 @@ $PasswordPolicyV3Dto = @"{
try {
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
Set-PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result
Set-PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result
# Below is a request that includes all optional parameters
# Set-PasswordPolicy -Id $Id -PasswordPolicyV3Dto $PasswordPolicyV3Dto
# Set-PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-PasswordPolicy"
Write-Host $_.ErrorDetails

25
docs/tools/sdk/powershell/Reference/V3/Methods/PasswordSyncGroupsApi.md
View File

@@ -55,9 +55,12 @@ Method | HTTP request | Description
[**Get-PasswordSyncGroups**](#get-password-sync-groups) | **GET** `/password-sync-groups` | Get Password Sync Group List
[**Update-PasswordSyncGroup**](#update-password-sync-group) | **PUT** `/password-sync-groups/{id}` | Update Password Sync Group by ID
## create-password-sync-group
This API creates a password sync group based on the specifications provided.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-password-sync-group)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -95,19 +98,22 @@ $PasswordSyncGroup = @"{
try {
$Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup
New-PasswordSyncGroup -PasswordSyncGroup $Result
New-PasswordSyncGroup -PasswordSyncGroup $Result
# Below is a request that includes all optional parameters
# New-PasswordSyncGroup -PasswordSyncGroup $PasswordSyncGroup
# New-PasswordSyncGroup -PasswordSyncGroup $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordSyncGroup"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-password-sync-group
This API deletes the specified password sync group.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-password-sync-group)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -147,9 +153,12 @@ try {
}
```
[[Back to top]](#)
## get-password-sync-group
This API returns the sync group for the specified ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-sync-group)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -190,9 +199,12 @@ try {
}
```
[[Back to top]](#)
## get-password-sync-groups
This API returns a list of password sync groups.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-sync-groups)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -226,7 +238,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Get Password Sync Group List
try {
Get-PasswordSyncGroups
Get-PasswordSyncGroups
# Below is a request that includes all optional parameters
# Get-PasswordSyncGroups -Limit $Limit -Offset $Offset -Count $Count
@@ -236,9 +248,12 @@ try {
}
```
[[Back to top]](#)
## update-password-sync-group
This API updates the specified password sync group.
[API Spec](https://developer.sailpoint.com/docs/api/v3/update-password-sync-group)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -279,10 +294,10 @@ $PasswordSyncGroup = @"{
try {
$Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup
Update-PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result
Update-PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result
# Below is a request that includes all optional parameters
# Update-PasswordSyncGroup -Id $Id -PasswordSyncGroup $PasswordSyncGroup
# Update-PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PasswordSyncGroup"
Write-Host $_.ErrorDetails

22
docs/tools/sdk/powershell/Reference/V3/Methods/PersonalAccessTokensApi.md
View File

@@ -33,9 +33,12 @@ Method | HTTP request | Description
[**Get-PersonalAccessTokens**](#list-personal-access-tokens) | **GET** `/personal-access-tokens` | List Personal Access Tokens
[**Update-PersonalAccessToken**](#patch-personal-access-token) | **PATCH** `/personal-access-tokens/{id}` | Patch Personal Access Token
## create-personal-access-token
This creates a personal access token.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-personal-access-token)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -70,19 +73,22 @@ $CreatePersonalAccessTokenRequest = @"{
try {
$Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest
New-PersonalAccessToken -CreatePersonalAccessTokenRequest $Result
New-PersonalAccessToken -CreatePersonalAccessTokenRequest $Result
# Below is a request that includes all optional parameters
# New-PersonalAccessToken -CreatePersonalAccessTokenRequest $CreatePersonalAccessTokenRequest
# New-PersonalAccessToken -CreatePersonalAccessTokenRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PersonalAccessToken"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-personal-access-token
This deletes a personal access token.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-personal-access-token)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -123,9 +129,12 @@ try {
}
```
[[Back to top]](#)
## list-personal-access-tokens
This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-personal-access-tokens)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -157,7 +166,7 @@ $Filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # String | Filter results usin
# List Personal Access Tokens
try {
Get-PersonalAccessTokens
Get-PersonalAccessTokens
# Below is a request that includes all optional parameters
# Get-PersonalAccessTokens -OwnerId $OwnerId -Filters $Filters
@@ -167,10 +176,13 @@ try {
}
```
[[Back to top]](#)
## patch-personal-access-token
This performs a targeted update to the field(s) of a Personal Access Token.
Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens.
[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-personal-access-token)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -209,10 +221,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-PersonalAccessToken -Id $Id -JsonPatchOperation $Result
Update-PersonalAccessToken -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-PersonalAccessToken -Id $Id -JsonPatchOperation $JsonPatchOperation
# Update-PersonalAccessToken -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PersonalAccessToken"
Write-Host $_.ErrorDetails

5
docs/tools/sdk/powershell/Reference/V3/Methods/PublicIdentitiesApi.md
View File

@@ -22,9 +22,12 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-PublicIdentities**](#get-public-identities) | **GET** `/public-identities` | Get list of public identities
## get-public-identities
Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-public-identities)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -64,7 +67,7 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
# Get list of public identities
try {
Get-PublicIdentities
Get-PublicIdentities
# Below is a request that includes all optional parameters
# Get-PublicIdentities -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -AddCoreFilters $AddCoreFilters -Sorters $Sorters

12
docs/tools/sdk/powershell/Reference/V3/Methods/PublicIdentitiesConfigApi.md
View File

@@ -30,9 +30,12 @@ Method | HTTP request | Description
[**Get-PublicIdentityConfig**](#get-public-identity-config) | **GET** `/public-identities-config` | Get the Public Identities Configuration
[**Update-PublicIdentityConfig**](#update-public-identity-config) | **PUT** `/public-identities-config` | Update the Public Identities Configuration
## get-public-identity-config
Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-public-identity-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -60,7 +63,7 @@ Code | Description | Data Type
# Get the Public Identities Configuration
try {
Get-PublicIdentityConfig
Get-PublicIdentityConfig
# Below is a request that includes all optional parameters
# Get-PublicIdentityConfig
@@ -70,9 +73,12 @@ try {
}
```
[[Back to top]](#)
## update-public-identity-config
Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns.
[API Spec](https://developer.sailpoint.com/docs/api/v3/update-public-identity-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -117,10 +123,10 @@ $PublicIdentityConfig = @"{
try {
$Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig
Update-PublicIdentityConfig -PublicIdentityConfig $Result
Update-PublicIdentityConfig -PublicIdentityConfig $Result
# Below is a request that includes all optional parameters
# Update-PublicIdentityConfig -PublicIdentityConfig $PublicIdentityConfig
# Update-PublicIdentityConfig -PublicIdentityConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PublicIdentityConfig"
Write-Host $_.ErrorDetails

18
docs/tools/sdk/powershell/Reference/V3/Methods/ReportsDataExtractionApi.md
View File

@@ -25,9 +25,12 @@ Method | HTTP request | Description
[**Get-ReportResult**](#get-report-result) | **GET** `/reports/{taskResultId}/result` | Get Report Result
[**Start-Report**](#start-report) | **POST** `/reports/run` | Run Report
## cancel-report
Cancels a running report.
[API Spec](https://developer.sailpoint.com/docs/api/v3/cancel-report)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -67,9 +70,12 @@ try {
}
```
[[Back to top]](#)
## get-report
Gets a report in file format.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-report)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -106,7 +112,7 @@ $Auditable = $true # Boolean | Enables auditing for current report download. Wil
# Get Report File
try {
Get-Report -TaskResultId $TaskResultId -FileFormat $FileFormat
Get-Report -TaskResultId $TaskResultId -FileFormat $FileFormat
# Below is a request that includes all optional parameters
# Get-Report -TaskResultId $TaskResultId -FileFormat $FileFormat -Name $Name -Auditable $Auditable
@@ -116,9 +122,12 @@ try {
}
```
[[Back to top]](#)
## get-report-result
Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-report-result)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -160,9 +169,12 @@ try {
}
```
[[Back to top]](#)
## start-report
Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns.
[API Spec](https://developer.sailpoint.com/docs/api/v3/start-report)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -199,10 +211,10 @@ $ReportDetails = @"{
try {
$Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails
Start-Report -ReportDetails $Result
Start-Report -ReportDetails $Result
# Below is a request that includes all optional parameters
# Start-Report -ReportDetails $ReportDetails
# Start-Report -ReportDetails $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-Report"
Write-Host $_.ErrorDetails

5
docs/tools/sdk/powershell/Reference/V3/Methods/RequestableObjectsApi.md
View File

@@ -22,10 +22,13 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-RequestableObjects**](#list-requestable-objects) | **GET** `/requestable-objects` | Requestable Objects List
## list-requestable-objects
This endpoint returns a list of acccess items that that can be requested through the Access Request endpoints. Access items are marked with AVAILABLE, PENDING or ASSIGNED with respect to the identity provided using *identity-id* query param.
Any authenticated token can call this endpoint to see their requestable access items.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-requestable-objects)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -75,7 +78,7 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
# Requestable Objects List
try {
Get-RequestableObjects
Get-RequestableObjects
# Below is a request that includes all optional parameters
# Get-RequestableObjects -IdentityId $IdentityId -Types $Types -Term $Term -Statuses $Statuses -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters

35
docs/tools/sdk/powershell/Reference/V3/Methods/RolesApi.md
View File

@@ -62,12 +62,15 @@ Method | HTTP request | Description
[**Get-Roles**](#list-roles) | **GET** `/roles` | List Roles
[**Update-Role**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified Role
## create-role
This API creates a role.
In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves.
The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -255,22 +258,25 @@ $Role = @"{
try {
$Result = ConvertFrom-JsonToRole -Json $Role
New-Role -Role $Result
New-Role -Role $Result
# Below is a request that includes all optional parameters
# New-Role -Role $Role
# New-Role -Role $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Role"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-bulk-roles
This endpoint initiates a bulk deletion of one or more roles.
When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information.
This endpoint can only bulk delete up to a limit of 50 roles per request.
A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-bulk-roles)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -303,21 +309,24 @@ $RoleBulkDeleteRequest = @"{
try {
$Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest
Remove-BulkRoles -RoleBulkDeleteRequest $Result
Remove-BulkRoles -RoleBulkDeleteRequest $Result
# Below is a request that includes all optional parameters
# Remove-BulkRoles -RoleBulkDeleteRequest $RoleBulkDeleteRequest
# Remove-BulkRoles -RoleBulkDeleteRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BulkRoles"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-role
This API deletes a Role by its ID.
A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -357,10 +366,13 @@ try {
}
```
[[Back to top]](#)
## get-role
This API returns a Role by its ID.
A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -400,9 +412,12 @@ try {
}
```
[[Back to top]](#)
## get-role-assigned-identities
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-role-assigned-identities)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -452,9 +467,12 @@ try {
}
```
[[Back to top]](#)
## list-roles
This API returns a list of Roles.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-roles)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -498,7 +516,7 @@ $IncludeUnsegmented = $false # Boolean | Whether or not the response list should
# List Roles
try {
Get-Roles
Get-Roles
# Below is a request that includes all optional parameters
# Get-Roles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented
@@ -508,6 +526,7 @@ try {
}
```
[[Back to top]](#)
## patch-role
This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
The following fields are patchable:
@@ -530,6 +549,8 @@ The maximum supported length for the description field is 2000 characters. Longe
When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time.
[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -567,10 +588,10 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-Role -Id $Id -JsonPatchOperation $Result
Update-Role -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-Role -Id $Id -JsonPatchOperation $JsonPatchOperation
# Update-Role -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Role"
Write-Host $_.ErrorDetails

77
docs/tools/sdk/powershell/Reference/V3/Methods/SODPoliciesApi.md
View File

@@ -61,10 +61,13 @@ Method | HTTP request | Description
[**Start-SodAllPoliciesForOrg**](#start-sod-all-policies-for-org) | **POST** `/sod-violation-report/run` | Runs all policies for org
[**Start-SodPolicy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report
## create-sod-policy
This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy.
Requires role of ORG_ADMIN.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-sod-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -150,20 +153,23 @@ $SodPolicy = @"{
try {
$Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy
New-SodPolicy -SodPolicy $Result
New-SodPolicy -SodPolicy $Result
# Below is a request that includes all optional parameters
# New-SodPolicy -SodPolicy $SodPolicy
# New-SodPolicy -SodPolicy $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SodPolicy"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-sod-policy
This deletes a specified SOD policy.
Requires role of ORG_ADMIN.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-sod-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -206,9 +212,12 @@ try {
}
```
[[Back to top]](#)
## delete-sod-policy-schedule
This deletes schedule for a specified SOD policy by ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-sod-policy-schedule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -249,9 +258,12 @@ try {
}
```
[[Back to top]](#)
## get-custom-violation-report
This allows to download a specified named violation report for a given report reference.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-custom-violation-report)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -284,7 +296,7 @@ $FileName = "custom-name" # String | Custom Name for the file.
# Download custom violation report
try {
Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName
Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName
# Below is a request that includes all optional parameters
# Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName
@@ -294,9 +306,12 @@ try {
}
```
[[Back to top]](#)
## get-default-violation-report
This allows to download a violation report for a given report reference.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-default-violation-report)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -337,9 +352,12 @@ try {
}
```
[[Back to top]](#)
## get-sod-all-report-run-status
This endpoint gets the status for a violation report for all policy run.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-all-report-run-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -367,7 +385,7 @@ Code | Description | Data Type
# Get multi-report run task status
try {
Get-SodAllReportRunStatus
Get-SodAllReportRunStatus
# Below is a request that includes all optional parameters
# Get-SodAllReportRunStatus
@@ -377,10 +395,13 @@ try {
}
```
[[Back to top]](#)
## get-sod-policy
This gets specified SOD policy.
Requires role of ORG_ADMIN.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -421,9 +442,12 @@ try {
}
```
[[Back to top]](#)
## get-sod-policy-schedule
This endpoint gets a specified SOD policy's schedule.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-policy-schedule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -463,9 +487,12 @@ try {
}
```
[[Back to top]](#)
## get-sod-violation-report-run-status
This gets the status for a violation report run task that has already been invoked.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-violation-report-run-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -506,9 +533,12 @@ try {
}
```
[[Back to top]](#)
## get-sod-violation-report-status
This gets the status for a violation report run task that has already been invoked.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-violation-report-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -549,10 +579,13 @@ try {
}
```
[[Back to top]](#)
## list-sod-policies
This gets list of all SOD policies.
Requires role of ORG_ADMIN
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-sod-policies)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -590,7 +623,7 @@ $Sorters = "id,name" # String | Sort results using the standard syntax described
# List SOD policies
try {
Get-SodPolicies
Get-SodPolicies
# Below is a request that includes all optional parameters
# Get-SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
@@ -600,11 +633,14 @@ try {
}
```
[[Back to top]](#)
## patch-sod-policy
Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
Requires role of ORG_ADMIN.
This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception.
[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-sod-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -643,19 +679,22 @@ $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-SodPolicy -Id $Id -JsonPatchOperation $Result
Update-SodPolicy -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-SodPolicy -Id $Id -JsonPatchOperation $JsonPatchOperation
# Update-SodPolicy -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SodPolicy"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-policy-schedule
This updates schedule for a specified SOD policy.
[API Spec](https://developer.sailpoint.com/docs/api/v3/put-policy-schedule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -725,20 +764,23 @@ $SodPolicySchedule = @"{
try {
$Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule
Send-PolicySchedule -Id $Id -SodPolicySchedule $Result
Send-PolicySchedule -Id $Id -SodPolicySchedule $Result
# Below is a request that includes all optional parameters
# Send-PolicySchedule -Id $Id -SodPolicySchedule $SodPolicySchedule
# Send-PolicySchedule -Id $Id -SodPolicySchedule $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PolicySchedule"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-sod-policy
This updates a specified SOD policy.
Requires role of ORG_ADMIN.
[API Spec](https://developer.sailpoint.com/docs/api/v3/put-sod-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -827,19 +869,22 @@ $SodPolicy = @"{
try {
$Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy
Send-SodPolicy -Id $Id -SodPolicy $Result
Send-SodPolicy -Id $Id -SodPolicy $Result
# Below is a request that includes all optional parameters
# Send-SodPolicy -Id $Id -SodPolicy $SodPolicy
# Send-SodPolicy -Id $Id -SodPolicy $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SodPolicy"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-evaluate-sod-policy
Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/start-evaluate-sod-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -879,9 +924,12 @@ try {
}
```
[[Back to top]](#)
## start-sod-all-policies-for-org
Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided.
[API Spec](https://developer.sailpoint.com/docs/api/v3/start-sod-all-policies-for-org)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -913,19 +961,22 @@ $MultiPolicyRequest = @"{
# Runs all policies for org
try {
Start-SodAllPoliciesForOrg
Start-SodAllPoliciesForOrg
# Below is a request that includes all optional parameters
# Start-SodAllPoliciesForOrg -MultiPolicyRequest $MultiPolicyRequest
# Start-SodAllPoliciesForOrg -MultiPolicyRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodAllPoliciesForOrg"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-sod-policy
This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message.
[API Spec](https://developer.sailpoint.com/docs/api/v3/start-sod-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------

14
docs/tools/sdk/powershell/Reference/V3/Methods/SODViolationsApi.md
View File

@@ -38,9 +38,12 @@ Method | HTTP request | Description
[**Start-PredictSodViolations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict SOD violations for identity.
[**Start-ViolationCheck**](#start-violation-check) | **POST** `/sod-violations/check` | Check SOD violations
## start-predict-sod-violations
This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused.
[API Spec](https://developer.sailpoint.com/docs/api/v3/start-predict-sod-violations)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -83,19 +86,22 @@ $IdentityWithNewAccess = @"{
try {
$Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess
Start-PredictSodViolations -IdentityWithNewAccess $Result
Start-PredictSodViolations -IdentityWithNewAccess $Result
# Below is a request that includes all optional parameters
# Start-PredictSodViolations -IdentityWithNewAccess $IdentityWithNewAccess
# Start-PredictSodViolations -IdentityWithNewAccess $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-PredictSodViolations"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-violation-check
This API initiates a SOD policy verification asynchronously.
[API Spec](https://developer.sailpoint.com/docs/api/v3/start-violation-check)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -127,10 +133,10 @@ $IdentityWithNewAccess1 = @"{identityId=2c91808568c529c60168cca6f90c1313, access
try {
$Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1
Start-ViolationCheck -IdentityWithNewAccess1 $Result
Start-ViolationCheck -IdentityWithNewAccess1 $Result
# Below is a request that includes all optional parameters
# Start-ViolationCheck -IdentityWithNewAccess1 $IdentityWithNewAccess1
# Start-ViolationCheck -IdentityWithNewAccess1 $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-ViolationCheck"
Write-Host $_.ErrorDetails

32
docs/tools/sdk/powershell/Reference/V3/Methods/SavedSearchApi.md
View File

@@ -34,10 +34,13 @@ Method | HTTP request | Description
[**Get-SavedSearches**](#list-saved-searches) | **GET** `/saved-searches` | A list of Saved Searches
[**Send-SavedSearch**](#put-saved-search) | **PUT** `/saved-searches/{id}` | Updates an existing saved search
## create-saved-search
Creates a new saved search.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-saved-search)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -68,20 +71,23 @@ $CreateSavedSearchRequest = @""@
try {
$Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest
New-SavedSearch -CreateSavedSearchRequest $Result
New-SavedSearch -CreateSavedSearchRequest $Result
# Below is a request that includes all optional parameters
# New-SavedSearch -CreateSavedSearchRequest $CreateSavedSearchRequest
# New-SavedSearch -CreateSavedSearchRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SavedSearch"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-saved-search
Deletes the specified saved search.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-saved-search)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -122,10 +128,13 @@ try {
}
```
[[Back to top]](#)
## execute-saved-search
Executes the specified saved search.
[API Spec](https://developer.sailpoint.com/docs/api/v3/execute-saved-search)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -169,20 +178,23 @@ $SearchArguments = @"{
try {
$Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments
Invoke-ExecuteSavedSearch -Id $Id -SearchArguments $Result
Invoke-ExecuteSavedSearch -Id $Id -SearchArguments $Result
# Below is a request that includes all optional parameters
# Invoke-ExecuteSavedSearch -Id $Id -SearchArguments $SearchArguments
# Invoke-ExecuteSavedSearch -Id $Id -SearchArguments $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ExecuteSavedSearch"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-saved-search
Returns the specified saved search.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-saved-search)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -223,10 +235,13 @@ try {
}
```
[[Back to top]](#)
## list-saved-searches
Returns a list of saved searches.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-saved-searches)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -262,7 +277,7 @@ $Filters = 'owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"' # String | Filte
# A list of Saved Searches
try {
Get-SavedSearches
Get-SavedSearches
# Below is a request that includes all optional parameters
# Get-SavedSearches -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters
@@ -272,12 +287,15 @@ try {
}
```
[[Back to top]](#)
## put-saved-search
Updates an existing saved search.
>**NOTE: You cannot update the `owner` of the saved search.**
[API Spec](https://developer.sailpoint.com/docs/api/v3/put-saved-search)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -354,10 +372,10 @@ $SavedSearch = @"{
try {
$Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch
Send-SavedSearch -Id $Id -SavedSearch $Result
Send-SavedSearch -Id $Id -SavedSearch $Result
# Below is a request that includes all optional parameters
# Send-SavedSearch -Id $Id -SavedSearch $SavedSearch
# Send-SavedSearch -Id $Id -SavedSearch $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SavedSearch"
Write-Host $_.ErrorDetails

32
docs/tools/sdk/powershell/Reference/V3/Methods/ScheduledSearchApi.md
View File

@@ -50,10 +50,13 @@ Method | HTTP request | Description
[**Invoke-UnsubscribeScheduledSearch**](#unsubscribe-scheduled-search) | **POST** `/scheduled-searches/{id}/unsubscribe` | Unsubscribe a recipient from Scheduled Search
[**Update-ScheduledSearch**](#update-scheduled-search) | **PUT** `/scheduled-searches/{id}` | Update an existing Scheduled Search
## create-scheduled-search
Creates a new scheduled search.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-scheduled-search)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -85,20 +88,23 @@ $CreateScheduledSearchRequest = @"{savedSearchId=9c620e13-cd33-4804-a13d-403bd7b
try {
$Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest
New-ScheduledSearch -CreateScheduledSearchRequest $Result
New-ScheduledSearch -CreateScheduledSearchRequest $Result
# Below is a request that includes all optional parameters
# New-ScheduledSearch -CreateScheduledSearchRequest $CreateScheduledSearchRequest
# New-ScheduledSearch -CreateScheduledSearchRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ScheduledSearch"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-scheduled-search
Deletes the specified scheduled search.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-scheduled-search)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -139,9 +145,12 @@ try {
}
```
[[Back to top]](#)
## get-scheduled-search
Returns the specified scheduled search.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-scheduled-search)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -182,10 +191,13 @@ try {
}
```
[[Back to top]](#)
## list-scheduled-search
Returns a list of scheduled searches.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-scheduled-search)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -222,7 +234,7 @@ $Filters = 'savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"' # String |
# List scheduled searches
try {
Get-ScheduledSearch
Get-ScheduledSearch
# Below is a request that includes all optional parameters
# Get-ScheduledSearch -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters
@@ -232,10 +244,13 @@ try {
}
```
[[Back to top]](#)
## unsubscribe-scheduled-search
Unsubscribes a recipient from the specified scheduled search.
[API Spec](https://developer.sailpoint.com/docs/api/v3/unsubscribe-scheduled-search)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -269,20 +284,23 @@ $TypedReference = @"{
try {
$Result = ConvertFrom-JsonToTypedReference -Json $TypedReference
Invoke-UnsubscribeScheduledSearch -Id $Id -TypedReference $Result
Invoke-UnsubscribeScheduledSearch -Id $Id -TypedReference $Result
# Below is a request that includes all optional parameters
# Invoke-UnsubscribeScheduledSearch -Id $Id -TypedReference $TypedReference
# Invoke-UnsubscribeScheduledSearch -Id $Id -TypedReference $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-UnsubscribeScheduledSearch"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-scheduled-search
Updates an existing scheduled search.
[API Spec](https://developer.sailpoint.com/docs/api/v3/update-scheduled-search)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -358,10 +376,10 @@ $ScheduledSearch = @"{
try {
$Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch
Update-ScheduledSearch -Id $Id -ScheduledSearch $Result
Update-ScheduledSearch -Id $Id -ScheduledSearch $Result
# Below is a request that includes all optional parameters
# Update-ScheduledSearch -Id $Id -ScheduledSearch $ScheduledSearch
# Update-ScheduledSearch -Id $Id -ScheduledSearch $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ScheduledSearch"
Write-Host $_.ErrorDetails

34
docs/tools/sdk/powershell/Reference/V3/Methods/SearchApi.md
View File

@@ -45,9 +45,12 @@ Method | HTTP request | Description
[**Search-Get**](#search-get) | **GET** `/search/{index}/{id}` | Get a Document by ID
[**Search-Post**](#search-post) | **POST** `/search` | Perform Search
## search-aggregate
Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging.
[API Spec](https://developer.sailpoint.com/docs/api/v3/search-aggregate)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -200,19 +203,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
try {
$Result = ConvertFrom-JsonToSearch -Json $Search
Search-Aggregate -Search $Result
Search-Aggregate -Search $Result
# Below is a request that includes all optional parameters
# Search-Aggregate -Search $Search -Offset $Offset -Limit $Limit -Count $Count
# Search-Aggregate -Search $Result -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Aggregate"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## search-count
Performs a search with a provided query and returns the count of results in the X-Total-Count header.
[API Spec](https://developer.sailpoint.com/docs/api/v3/search-count)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -359,19 +365,22 @@ $Search = @"{
try {
$Result = ConvertFrom-JsonToSearch -Json $Search
Search-Count -Search $Result
Search-Count -Search $Result
# Below is a request that includes all optional parameters
# Search-Count -Search $Search
# Search-Count -Search $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Count"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## search-get
Fetches a single document from the specified index, using the specified document ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/search-get)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -379,12 +388,12 @@ Path | Index | **String** | True | The index from which to fetch the specifie
Path | Id | **String** | True | ID of the requested document.
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
[**SearchDocument**](../models/search-document)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | The requested document. | SystemCollectionsHashtable
200 | The requested document. | SearchDocument
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&#39;t have access to this end-point. | ErrorResponseDto
@@ -404,7 +413,7 @@ $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document
# Get a Document by ID
try {
Search-Get -Index $Index -Id $Id
Search-Get -Index $Index -Id $Id
# Below is a request that includes all optional parameters
# Search-Get -Index $Index -Id $Id
@@ -414,9 +423,12 @@ try {
}
```
[[Back to top]](#)
## search-post
Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging.
[API Spec](https://developer.sailpoint.com/docs/api/v3/search-post)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -426,12 +438,12 @@ Param Type | Name | Data Type | Required | Description
Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
### Return type
[**SystemCollectionsHashtable[]**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
[**SearchDocument[]**](../models/search-document)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | List of matching documents. | SystemCollectionsHashtable[]
200 | List of matching documents. | SearchDocument[]
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&#39;t have access to this end-point. | ErrorResponseDto
@@ -569,10 +581,10 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
try {
$Result = ConvertFrom-JsonToSearch -Json $Search
Search-Post -Search $Result
Search-Post -Search $Result
# Below is a request that includes all optional parameters
# Search-Post -Search $Search -Offset $Offset -Limit $Limit -Count $Count
# Search-Post -Search $Result -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Post"
Write-Host $_.ErrorDetails

25
docs/tools/sdk/powershell/Reference/V3/Methods/SearchAttributeConfigurationApi.md
View File

@@ -41,9 +41,12 @@ Method | HTTP request | Description
[**Get-SingleSearchAttributeConfig**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute
[**Update-SearchAttributeConfig**](#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute
## create-search-attribute-config
Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create and attribute promotion configuration in the Link ObjectConfig.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-search-attribute-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -82,19 +85,22 @@ $SearchAttributeConfig = @"{
try {
$Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig
New-SearchAttributeConfig -SearchAttributeConfig $Result
New-SearchAttributeConfig -SearchAttributeConfig $Result
# Below is a request that includes all optional parameters
# New-SearchAttributeConfig -SearchAttributeConfig $SearchAttributeConfig
# New-SearchAttributeConfig -SearchAttributeConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SearchAttributeConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-search-attribute-config
Delete an extended attribute configuration by name.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-search-attribute-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -135,9 +141,12 @@ try {
}
```
[[Back to top]](#)
## get-search-attribute-config
Get a list of attribute/application associates currently configured in Identity Security Cloud (ISC).
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-search-attribute-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -165,7 +174,7 @@ Code | Description | Data Type
# List Extended Search Attributes
try {
Get-SearchAttributeConfig
Get-SearchAttributeConfig
# Below is a request that includes all optional parameters
# Get-SearchAttributeConfig
@@ -175,9 +184,12 @@ try {
}
```
[[Back to top]](#)
## get-single-search-attribute-config
Get an extended attribute configuration by name.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-single-search-attribute-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -219,11 +231,14 @@ try {
}
```
[[Back to top]](#)
## patch-search-attribute-config
Update an existing search attribute configuration.
You can patch these fields:
* name * displayName * applicationAttributes
[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-search-attribute-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -262,10 +277,10 @@ $Name = "promotedMailAttribute" # String | Name of the search attribute configur
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-SearchAttributeConfig -Name $Name -JsonPatchOperation $Result
Update-SearchAttributeConfig -Name $Name -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-SearchAttributeConfig -Name $Name -JsonPatchOperation $JsonPatchOperation
# Update-SearchAttributeConfig -Name $Name -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SearchAttributeConfig"
Write-Host $_.ErrorDetails

25
docs/tools/sdk/powershell/Reference/V3/Methods/SegmentsApi.md
View File

@@ -40,10 +40,13 @@ Method | HTTP request | Description
[**Get-Segments**](#list-segments) | **GET** `/segments` | List Segments
[**Update-Segment**](#patch-segment) | **PATCH** `/segments/{id}` | Update Segment
## create-segment
This API creates a segment.
>**Note:** Segment definitions may take time to propagate to all identities.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-segment)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -97,20 +100,23 @@ $Segment = @"{
try {
$Result = ConvertFrom-JsonToSegment -Json $Segment
New-Segment -Segment $Result
New-Segment -Segment $Result
# Below is a request that includes all optional parameters
# New-Segment -Segment $Segment
# New-Segment -Segment $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Segment"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-segment
This API deletes the segment specified by the given ID.
>**Note:** that segment deletion may take some time to become effective.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-segment)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -151,9 +157,12 @@ try {
}
```
[[Back to top]](#)
## get-segment
This API returns the segment specified by the given ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-segment)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -194,9 +203,12 @@ try {
}
```
[[Back to top]](#)
## list-segments
This API returns a list of all segments.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-segments)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -230,7 +242,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# List Segments
try {
Get-Segments
Get-Segments
# Below is a request that includes all optional parameters
# Get-Segments -Limit $Limit -Offset $Offset -Count $Count
@@ -240,10 +252,13 @@ try {
}
```
[[Back to top]](#)
## patch-segment
Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
>**Note:** Changes to a segment may take some time to propagate to all identities.
[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-segment)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -279,10 +294,10 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operat
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Update-Segment -Id $Id -RequestBody $Result
Update-Segment -Id $Id -RequestBody $Result
# Below is a request that includes all optional parameters
# Update-Segment -Id $Id -RequestBody $RequestBody
# Update-Segment -Id $Id -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Segment"
Write-Host $_.ErrorDetails

52
docs/tools/sdk/powershell/Reference/V3/Methods/ServiceDeskIntegrationApi.md
View File

@@ -52,9 +52,12 @@ Method | HTTP request | Description
[**Send-ServiceDeskIntegration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a Service Desk integration
[**Update-StatusCheckDetails**](#update-status-check-details) | **PUT** `/service-desk-integrations/status-check-configuration` | Update the time check configuration
## create-service-desk-integration
Create a new Service Desk integration.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-service-desk-integration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -119,19 +122,22 @@ $ServiceDeskIntegrationDto = @"{
try {
$Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto
New-ServiceDeskIntegration -ServiceDeskIntegrationDto $Result
New-ServiceDeskIntegration -ServiceDeskIntegrationDto $Result
# Below is a request that includes all optional parameters
# New-ServiceDeskIntegration -ServiceDeskIntegrationDto $ServiceDeskIntegrationDto
# New-ServiceDeskIntegration -ServiceDeskIntegrationDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ServiceDeskIntegration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-service-desk-integration
Delete an existing Service Desk integration by ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-service-desk-integration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -172,9 +178,12 @@ try {
}
```
[[Back to top]](#)
## get-service-desk-integration
Get an existing Service Desk integration by ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-service-desk-integration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -215,9 +224,12 @@ try {
}
```
[[Back to top]](#)
## get-service-desk-integration-template
This API endpoint returns an existing Service Desk integration template by scriptName.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-service-desk-integration-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -258,9 +270,12 @@ try {
}
```
[[Back to top]](#)
## get-service-desk-integration-types
This API endpoint returns the current list of supported Service Desk integration types.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-service-desk-integration-types)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -289,7 +304,7 @@ Code | Description | Data Type
# List Service Desk integration types
try {
Get-ServiceDeskIntegrationTypes
Get-ServiceDeskIntegrationTypes
# Below is a request that includes all optional parameters
# Get-ServiceDeskIntegrationTypes
@@ -299,9 +314,12 @@ try {
}
```
[[Back to top]](#)
## get-service-desk-integrations
Get a list of Service Desk integration objects.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-service-desk-integrations)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -340,7 +358,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# List existing Service Desk integrations
try {
Get-ServiceDeskIntegrations
Get-ServiceDeskIntegrations
# Below is a request that includes all optional parameters
# Get-ServiceDeskIntegrations -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count
@@ -350,9 +368,12 @@ try {
}
```
[[Back to top]](#)
## get-status-check-details
Get the time check configuration of queued SDIM tickets.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-status-check-details)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -381,7 +402,7 @@ Code | Description | Data Type
# Get the time check configuration
try {
Get-StatusCheckDetails
Get-StatusCheckDetails
# Below is a request that includes all optional parameters
# Get-StatusCheckDetails
@@ -391,9 +412,12 @@ try {
}
```
[[Back to top]](#)
## patch-service-desk-integration
Update an existing Service Desk integration by ID with a PATCH request.
[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-service-desk-integration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -427,19 +451,22 @@ $PatchServiceDeskIntegrationRequest = @""@
try {
$Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest
Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result
Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result
# Below is a request that includes all optional parameters
# Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $PatchServiceDeskIntegrationRequest
# Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ServiceDeskIntegration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-service-desk-integration
Update an existing Service Desk integration by ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/put-service-desk-integration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -506,19 +533,22 @@ $ServiceDeskIntegrationDto = @"{
try {
$Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto
Send-ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result
Send-ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result
# Below is a request that includes all optional parameters
# Send-ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $ServiceDeskIntegrationDto
# Send-ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ServiceDeskIntegration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-status-check-details
Update the time check configuration of queued SDIM tickets.
[API Spec](https://developer.sailpoint.com/docs/api/v3/update-status-check-details)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -553,10 +583,10 @@ $QueuedCheckConfigDetails = @"{
try {
$Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails
Update-StatusCheckDetails -QueuedCheckConfigDetails $Result
Update-StatusCheckDetails -QueuedCheckConfigDetails $Result
# Below is a request that includes all optional parameters
# Update-StatusCheckDetails -QueuedCheckConfigDetails $QueuedCheckConfigDetails
# Update-StatusCheckDetails -QueuedCheckConfigDetails $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-StatusCheckDetails"
Write-Host $_.ErrorDetails

6
docs/tools/sdk/powershell/Reference/V3/Methods/SourceUsagesApi.md
View File

@@ -23,9 +23,12 @@ Method | HTTP request | Description
[**Get-StatusBySourceId**](#get-status-by-source-id) | **GET** `/source-usages/{sourceId}/status` | Finds status of source usage
[**Get-UsagesBySourceId**](#get-usages-by-source-id) | **GET** `/source-usages/{sourceId}/summaries` | Returns source usage insights
## get-status-by-source-id
This API returns the status of the source usage insights setup by IDN source ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-status-by-source-id)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -65,9 +68,12 @@ try {
}
```
[[Back to top]](#)
## get-usages-by-source-id
This API returns a summary of source usage insights for past 12 months.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-usages-by-source-id)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------

128
docs/tools/sdk/powershell/Reference/V3/Methods/SourcesApi.md
View File

@@ -101,11 +101,14 @@ Method | HTTP request | Description
[**Update-Source**](#update-source) | **PATCH** `/sources/{id}` | Update Source (Partial)
[**Update-SourceSchema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial)
## create-provisioning-policy
This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types.
Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.
Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-provisioning-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -178,19 +181,22 @@ $ProvisioningPolicyDto = @"{
try {
$Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto
New-ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result
New-ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result
# Below is a request that includes all optional parameters
# New-ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $ProvisioningPolicyDto
# New-ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ProvisioningPolicy"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-source
This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-source)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -305,20 +311,23 @@ $ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures
try {
$Result = ConvertFrom-JsonToSource -Json $Source
New-Source -Source $Result
New-Source -Source $Result
# Below is a request that includes all optional parameters
# New-Source -Source $Source -ProvisionAsCsv $ProvisionAsCsv
# New-Source -Source $Result -ProvisionAsCsv $ProvisionAsCsv
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Source"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-source-schema
Use this API to create a new schema on the specified source in Identity Security Cloud (ISC).
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-source-schema)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -384,19 +393,22 @@ $Schema = @"{
try {
$Result = ConvertFrom-JsonToSchema -Json $Schema
New-SourceSchema -SourceId $SourceId -Schema $Result
New-SourceSchema -SourceId $SourceId -Schema $Result
# Below is a request that includes all optional parameters
# New-SourceSchema -SourceId $SourceId -Schema $Schema
# New-SourceSchema -SourceId $SourceId -Schema $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SourceSchema"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-provisioning-policy
Deletes the provisioning policy with the specified usage on an application.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-provisioning-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -429,7 +441,7 @@ $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In I
# Delete Provisioning Policy by UsageType
try {
Remove-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType
Remove-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType
# Below is a request that includes all optional parameters
# Remove-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType
@@ -439,10 +451,13 @@ try {
}
```
[[Back to top]](#)
## delete-source
Use this API to delete a specific source in Identity Security Cloud (ISC).
The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}`
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-source)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -483,9 +498,12 @@ try {
}
```
[[Back to top]](#)
## delete-source-schema
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-source-schema)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -518,7 +536,7 @@ $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id.
# Delete Source Schema by ID
try {
Remove-SourceSchema -SourceId $SourceId -SchemaId $SchemaId
Remove-SourceSchema -SourceId $SourceId -SchemaId $SchemaId
# Below is a request that includes all optional parameters
# Remove-SourceSchema -SourceId $SourceId -SchemaId $SchemaId
@@ -528,10 +546,13 @@ try {
}
```
[[Back to top]](#)
## get-accounts-schema
This API downloads the CSV schema that defines the account attributes on a source.
>**NOTE: This API is designated only for Delimited File sources.**
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-accounts-schema)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -572,11 +593,14 @@ try {
}
```
[[Back to top]](#)
## get-entitlements-schema
This API downloads the CSV schema that defines the entitlement attributes on a source.
>**NOTE: This API is designated only for Delimited File sources.**
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-entitlements-schema)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -619,9 +643,12 @@ try {
}
```
[[Back to top]](#)
## get-provisioning-policy
This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-provisioning-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -654,7 +681,7 @@ $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In I
# Get Provisioning Policy by UsageType
try {
Get-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType
Get-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType
# Below is a request that includes all optional parameters
# Get-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType
@@ -664,9 +691,12 @@ try {
}
```
[[Back to top]](#)
## get-source
Use this API to get a source by a specified ID in Identity Security Cloud (ISC).
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-source)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -707,9 +737,12 @@ try {
}
```
[[Back to top]](#)
## get-source-connections
Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC).
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-source-connections)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -750,9 +783,12 @@ try {
}
```
[[Back to top]](#)
## get-source-health
This endpoint fetches source health by source's id
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-source-health)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -793,10 +829,13 @@ try {
}
```
[[Back to top]](#)
## get-source-schema
Get the Source Schema by ID in IdentityNow.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-source-schema)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -829,7 +868,7 @@ $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id.
# Get Source Schema by ID
try {
Get-SourceSchema -SourceId $SourceId -SchemaId $SchemaId
Get-SourceSchema -SourceId $SourceId -SchemaId $SchemaId
# Below is a request that includes all optional parameters
# Get-SourceSchema -SourceId $SourceId -SchemaId $SchemaId
@@ -839,9 +878,12 @@ try {
}
```
[[Back to top]](#)
## get-source-schemas
Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC).
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-source-schemas)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -886,6 +928,7 @@ try {
}
```
[[Back to top]](#)
## import-accounts-schema
This API uploads a source schema template file to configure a source's account attributes.
@@ -895,6 +938,8 @@ Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Imp
>**NOTE: This API is designated only for Delimited File sources.**
[API Spec](https://developer.sailpoint.com/docs/api/v3/import-accounts-schema)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -936,9 +981,12 @@ try {
}
```
[[Back to top]](#)
## import-connector-file
This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events.
[API Spec](https://developer.sailpoint.com/docs/api/v3/import-connector-file)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -980,6 +1028,7 @@ try {
}
```
[[Back to top]](#)
## import-entitlements-schema
This API uploads a source schema template file to configure a source's entitlement attributes.
@@ -989,6 +1038,8 @@ Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Imp
>**NOTE: This API is designated only for Delimited File sources.**
[API Spec](https://developer.sailpoint.com/docs/api/v3/import-entitlements-schema)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1032,9 +1083,12 @@ try {
}
```
[[Back to top]](#)
## list-provisioning-policies
This end-point lists all the ProvisioningPolicies in IdentityNow.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-provisioning-policies)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1075,9 +1129,12 @@ try {
}
```
[[Back to top]](#)
## list-sources
This end-point lists all the sources in IdentityNow.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-sources)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1120,7 +1177,7 @@ $IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the resp
# Lists all sources in IdentityNow.
try {
Get-Sources
Get-Sources
# Below is a request that includes all optional parameters
# Get-Sources -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSubadmin $ForSubadmin -IncludeIDNSource $IncludeIDNSource
@@ -1130,11 +1187,14 @@ try {
}
```
[[Back to top]](#)
## put-provisioning-policy
This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow.
Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.
Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.
[API Spec](https://developer.sailpoint.com/docs/api/v3/put-provisioning-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1209,16 +1269,17 @@ $ProvisioningPolicyDto = @"{
try {
$Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto
Send-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result
Send-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result
# Below is a request that includes all optional parameters
# Send-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $ProvisioningPolicyDto
# Send-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ProvisioningPolicy"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-source
Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration.
@@ -1234,6 +1295,8 @@ These fields are immutable, so they cannot be changed:
Attempts to modify these fields will result in a 400 error.
[API Spec](https://developer.sailpoint.com/docs/api/v3/put-source)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1349,16 +1412,17 @@ $Source = @"{
try {
$Result = ConvertFrom-JsonToSource -Json $Source
Send-Source -Id $Id -Source $Result
Send-Source -Id $Id -Source $Result
# Below is a request that includes all optional parameters
# Send-Source -Id $Id -Source $Source
# Send-Source -Id $Id -Source $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Source"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-source-schema
This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below.
@@ -1372,6 +1436,8 @@ Any attempt to modify these fields will result in an error response with a statu
> `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error.
[API Spec](https://developer.sailpoint.com/docs/api/v3/put-source-schema)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1440,19 +1506,22 @@ $Schema = @"{
try {
$Result = ConvertFrom-JsonToSchema -Json $Schema
Send-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result
Send-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result
# Below is a request that includes all optional parameters
# Send-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Schema
# Send-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SourceSchema"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-provisioning-policies-in-bulk
This end-point updates a list of provisioning policies on the specified source in IdentityNow.
[API Spec](https://developer.sailpoint.com/docs/api/v3/update-provisioning-policies-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1526,21 +1595,24 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
try {
$Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto
Update-ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result
Update-ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result
# Below is a request that includes all optional parameters
# Update-ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $ProvisioningPolicyDto
# Update-ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ProvisioningPoliciesInBulk"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-provisioning-policy
This API selectively updates an existing Provisioning Policy using a JSONPatch payload.
Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.
Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.
[API Spec](https://developer.sailpoint.com/docs/api/v3/update-provisioning-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1581,16 +1653,17 @@ $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In I
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result
Update-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $JsonPatchOperation
# Update-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ProvisioningPolicy"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-source
Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the
[JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
@@ -1609,6 +1682,8 @@ These fields are immutable, so they cannot be changed:
Attempts to modify these fields will result in a 400 error.
[API Spec](https://developer.sailpoint.com/docs/api/v3/update-source)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1647,16 +1722,17 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-Source -Id $Id -JsonPatchOperation $Result
Update-Source -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-Source -Id $Id -JsonPatchOperation $JsonPatchOperation
# Update-Source -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Source"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-source-schema
Use this API to selectively update an existing Schema using a JSONPatch payload.
@@ -1689,6 +1765,8 @@ To switch an account attribute to a group entitlement, you need to have the foll
```
[API Spec](https://developer.sailpoint.com/docs/api/v3/update-source-schema)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1729,10 +1807,10 @@ $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id.
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result
Update-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $JsonPatchOperation
# Update-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SourceSchema"
Write-Host $_.ErrorDetails

46
docs/tools/sdk/powershell/Reference/V3/Methods/TaggedObjectsApi.md
View File

@@ -79,9 +79,12 @@ Method | HTTP request | Description
[**Set-TagToObject**](#set-tag-to-object) | **POST** `/tagged-objects` | Add Tag to Object
[**Set-TagsToManyObjects**](#set-tags-to-many-objects) | **POST** `/tagged-objects/bulk-add` | Tag Multiple Objects
## delete-tagged-object
Delete all tags from a tagged object.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-tagged-object)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -113,7 +116,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to dele
# Delete Object Tags
try {
Remove-TaggedObject -Type $Type -Id $Id
Remove-TaggedObject -Type $Type -Id $Id
# Below is a request that includes all optional parameters
# Remove-TaggedObject -Type $Type -Id $Id
@@ -123,9 +126,12 @@ try {
}
```
[[Back to top]](#)
## delete-tags-to-many-object
This API removes tags from multiple objects.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-tags-to-many-object)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -167,19 +173,22 @@ $BulkRemoveTaggedObject = @"{
try {
$Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject
Remove-TagsToManyObject -BulkRemoveTaggedObject $Result
Remove-TagsToManyObject -BulkRemoveTaggedObject $Result
# Below is a request that includes all optional parameters
# Remove-TagsToManyObject -BulkRemoveTaggedObject $BulkRemoveTaggedObject
# Remove-TagsToManyObject -BulkRemoveTaggedObject $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-TagsToManyObject"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-tagged-object
This gets a tagged object for the specified type.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-tagged-object)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -211,7 +220,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object referen
# Get Tagged Object
try {
Get-TaggedObject -Type $Type -Id $Id
Get-TaggedObject -Type $Type -Id $Id
# Below is a request that includes all optional parameters
# Get-TaggedObject -Type $Type -Id $Id
@@ -221,11 +230,14 @@ try {
}
```
[[Back to top]](#)
## list-tagged-objects
This API returns a list of all tagged objects.
Any authenticated token may be used to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-tagged-objects)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -261,7 +273,7 @@ $Filters = 'tagName eq "BU_FINANCE"' # String | Filter results using the standar
# List Tagged Objects
try {
Get-TaggedObjects
Get-TaggedObjects
# Below is a request that includes all optional parameters
# Get-TaggedObjects -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters
@@ -271,11 +283,14 @@ try {
}
```
[[Back to top]](#)
## list-tagged-objects-by-type
This API returns a list of all tagged objects by type.
Any authenticated token may be used to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-tagged-objects-by-type)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -323,9 +338,12 @@ try {
}
```
[[Back to top]](#)
## put-tagged-object
This updates a tagged object for the specified type.
[API Spec](https://developer.sailpoint.com/docs/api/v3/put-tagged-object)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -367,21 +385,24 @@ $TaggedObject = @"{
try {
$Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject
Send-TaggedObject -Type $Type -Id $Id -TaggedObject $Result
Send-TaggedObject -Type $Type -Id $Id -TaggedObject $Result
# Below is a request that includes all optional parameters
# Send-TaggedObject -Type $Type -Id $Id -TaggedObject $TaggedObject
# Send-TaggedObject -Type $Type -Id $Id -TaggedObject $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TaggedObject"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-tag-to-object
This adds a tag to an object.
Any authenticated token may be used to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v3/set-tag-to-object)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -419,19 +440,22 @@ $TaggedObject = @"{
try {
$Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject
Set-TagToObject -TaggedObject $Result
Set-TagToObject -TaggedObject $Result
# Below is a request that includes all optional parameters
# Set-TagToObject -TaggedObject $TaggedObject
# Set-TagToObject -TaggedObject $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-TagToObject"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-tags-to-many-objects
This API adds tags to multiple objects.
[API Spec](https://developer.sailpoint.com/docs/api/v3/set-tags-to-many-objects)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -474,10 +498,10 @@ $BulkAddTaggedObject = @"{
try {
$Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject
Set-TagsToManyObjects -BulkAddTaggedObject $Result
Set-TagsToManyObjects -BulkAddTaggedObject $Result
# Below is a request that includes all optional parameters
# Set-TagsToManyObjects -BulkAddTaggedObject $BulkAddTaggedObject
# Set-TagsToManyObjects -BulkAddTaggedObject $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-TagsToManyObjects"
Write-Host $_.ErrorDetails

23
docs/tools/sdk/powershell/Reference/V3/Methods/TransformsApi.md
View File

@@ -29,9 +29,12 @@ Method | HTTP request | Description
[**Get-Transforms**](#list-transforms) | **GET** `/transforms` | List transforms
[**Update-Transform**](#update-transform) | **PUT** `/transforms/{id}` | Update a transform
## create-transform
Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-transform)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -83,19 +86,22 @@ $Transform = @"{
try {
$Result = ConvertFrom-JsonToTransform -Json $Transform
New-Transform -Transform $Result
New-Transform -Transform $Result
# Below is a request that includes all optional parameters
# New-Transform -Transform $Transform
# New-Transform -Transform $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Transform"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-transform
Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-transform)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -136,9 +142,12 @@ try {
}
```
[[Back to top]](#)
## get-transform
This API returns the transform specified by the given ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-transform)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -179,9 +188,12 @@ try {
}
```
[[Back to top]](#)
## list-transforms
Gets a list of all saved transform objects.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-transforms)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -220,7 +232,7 @@ $Filters = 'name eq "Uppercase"' # String | Filter results using the standard sy
# List transforms
try {
Get-Transforms
Get-Transforms
# Below is a request that includes all optional parameters
# Get-Transforms -Offset $Offset -Limit $Limit -Count $Count -Name $Name -Filters $Filters
@@ -230,9 +242,12 @@ try {
}
```
[[Back to top]](#)
## update-transform
Replaces the transform specified by the given ID with the transform provided in the request body. Only the "attributes" field is mutable. Attempting to change other properties (ex. "name" and "type") will result in an error.
[API Spec](https://developer.sailpoint.com/docs/api/v3/update-transform)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -288,7 +303,7 @@ try {
Update-Transform -Id $Id
# Below is a request that includes all optional parameters
# Update-Transform -Id $Id -Transform $Transform
# Update-Transform -Id $Id -Transform $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Transform"
Write-Host $_.ErrorDetails

19
docs/tools/sdk/powershell/Reference/V3/Methods/VendorConnectorMappingsApi.md
View File

@@ -21,10 +21,13 @@ Method | HTTP request | Description
[**Remove-VendorConnectorMapping**](#delete-vendor-connector-mapping) | **DELETE** `/vendor-connector-mappings` | Delete Vendor Connector Mapping
[**Get-VendorConnectorMappings**](#get-vendor-connector-mappings) | **GET** `/vendor-connector-mappings` | List Vendor Connector Mappings
## create-vendor-connector-mapping
Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-vendor-connector-mapping)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -78,20 +81,23 @@ $VendorConnectorMapping = @"{
try {
$Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping
New-VendorConnectorMapping -VendorConnectorMapping $Result
New-VendorConnectorMapping -VendorConnectorMapping $Result
# Below is a request that includes all optional parameters
# New-VendorConnectorMapping -VendorConnectorMapping $VendorConnectorMapping
# New-VendorConnectorMapping -VendorConnectorMapping $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-VendorConnectorMapping"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-vendor-connector-mapping
Soft delete a mapping between a SaaS vendor and an ISC connector, removing the established correlation.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-vendor-connector-mapping)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -145,20 +151,23 @@ $VendorConnectorMapping = @"{
try {
$Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping
Remove-VendorConnectorMapping -VendorConnectorMapping $Result
Remove-VendorConnectorMapping -VendorConnectorMapping $Result
# Below is a request that includes all optional parameters
# Remove-VendorConnectorMapping -VendorConnectorMapping $VendorConnectorMapping
# Remove-VendorConnectorMapping -VendorConnectorMapping $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-VendorConnectorMapping"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-vendor-connector-mappings
Get a list of mappings between SaaS vendors and ISC connectors, detailing the connections established for correlation.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-vendor-connector-mappings)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -187,7 +196,7 @@ Code | Description | Data Type
# List Vendor Connector Mappings
try {
Get-VendorConnectorMappings
Get-VendorConnectorMappings
# Below is a request that includes all optional parameters
# Get-VendorConnectorMappings

61
docs/tools/sdk/powershell/Reference/V3/Methods/WorkItemsApi.md
View File

@@ -45,9 +45,12 @@ Method | HTTP request | Description
[**Send-WorkItemForward**](#send-work-item-forward) | **POST** `/work-items/{id}/forward` | Forward a Work Item
[**Submit-AccountSelection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit Account Selections
## approve-approval-item
This API approves an Approval Item. Either an admin, or the owning/current user must make this request.
[API Spec](https://developer.sailpoint.com/docs/api/v3/approve-approval-item)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -80,7 +83,7 @@ $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the ap
# Approve an Approval Item
try {
Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId
Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId
# Below is a request that includes all optional parameters
# Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId
@@ -90,9 +93,12 @@ try {
}
```
[[Back to top]](#)
## approve-approval-items-in-bulk
This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request.
[API Spec](https://developer.sailpoint.com/docs/api/v3/approve-approval-items-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -133,9 +139,12 @@ try {
}
```
[[Back to top]](#)
## complete-work-item
This API completes a work item. Either an admin, or the owning/current user must make this request.
[API Spec](https://developer.sailpoint.com/docs/api/v3/complete-work-item)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -176,9 +185,12 @@ try {
}
```
[[Back to top]](#)
## get-completed-work-items
This gets a collection of completed work items belonging to either the specified user(admin required), or the current user.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-completed-work-items)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -214,7 +226,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Completed Work Items
try {
Get-CompletedWorkItems
Get-CompletedWorkItems
# Below is a request that includes all optional parameters
# Get-CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count
@@ -224,9 +236,12 @@ try {
}
```
[[Back to top]](#)
## get-count-completed-work-items
This gets a count of completed work items belonging to either the specified user(admin required), or the current user.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-count-completed-work-items)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -256,7 +271,7 @@ $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item own
# Count Completed Work Items
try {
Get-CountCompletedWorkItems
Get-CountCompletedWorkItems
# Below is a request that includes all optional parameters
# Get-CountCompletedWorkItems -OwnerId $OwnerId
@@ -266,9 +281,12 @@ try {
}
```
[[Back to top]](#)
## get-count-work-items
This gets a count of work items belonging to either the specified user(admin required), or the current user.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-count-work-items)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -298,7 +316,7 @@ $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item own
# Count Work Items
try {
Get-CountWorkItems
Get-CountWorkItems
# Below is a request that includes all optional parameters
# Get-CountWorkItems -OwnerId $OwnerId
@@ -308,9 +326,12 @@ try {
}
```
[[Back to top]](#)
## get-work-item
This gets the details of a Work Item belonging to either the specified user(admin required), or the current user.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-work-item)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -350,9 +371,12 @@ try {
}
```
[[Back to top]](#)
## get-work-items-summary
This gets a summary of work items belonging to either the specified user(admin required), or the current user.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-work-items-summary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -382,7 +406,7 @@ $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item own
# Work Items Summary
try {
Get-WorkItemsSummary
Get-WorkItemsSummary
# Below is a request that includes all optional parameters
# Get-WorkItemsSummary -OwnerId $OwnerId
@@ -392,9 +416,12 @@ try {
}
```
[[Back to top]](#)
## list-work-items
This gets a collection of work items belonging to either the specified user(admin required), or the current user.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-work-items)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -430,7 +457,7 @@ $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item own
# List Work Items
try {
Get-WorkItems
Get-WorkItems
# Below is a request that includes all optional parameters
# Get-WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId
@@ -440,9 +467,12 @@ try {
}
```
[[Back to top]](#)
## reject-approval-item
This API rejects an Approval Item. Either an admin, or the owning/current user must make this request.
[API Spec](https://developer.sailpoint.com/docs/api/v3/reject-approval-item)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -475,7 +505,7 @@ $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the ap
# Reject an Approval Item
try {
Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId
Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId
# Below is a request that includes all optional parameters
# Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId
@@ -485,9 +515,12 @@ try {
}
```
[[Back to top]](#)
## reject-approval-items-in-bulk
This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request.
[API Spec](https://developer.sailpoint.com/docs/api/v3/reject-approval-items-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -528,9 +561,12 @@ try {
}
```
[[Back to top]](#)
## send-work-item-forward
This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. Accessible to work-item Owner, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN.
[API Spec](https://developer.sailpoint.com/docs/api/v3/send-work-item-forward)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -567,19 +603,22 @@ $WorkItemForward = @"{
try {
$Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward
Send-WorkItemForward -Id $Id -WorkItemForward $Result
Send-WorkItemForward -Id $Id -WorkItemForward $Result
# Below is a request that includes all optional parameters
# Send-WorkItemForward -Id $Id -WorkItemForward $WorkItemForward
# Send-WorkItemForward -Id $Id -WorkItemForward $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-WorkItemForward"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## submit-account-selection
This API submits account selections. Either an admin, or the owning/current user must make this request.
[API Spec](https://developer.sailpoint.com/docs/api/v3/submit-account-selection)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -613,10 +652,10 @@ $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Sele
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Submit-AccountSelection -Id $Id -RequestBody $Result
Submit-AccountSelection -Id $Id -RequestBody $Result
# Below is a request that includes all optional parameters
# Submit-AccountSelection -Id $Id -RequestBody $RequestBody
# Submit-AccountSelection -Id $Id -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-AccountSelection"
Write-Host $_.ErrorDetails

84
docs/tools/sdk/powershell/Reference/V3/Methods/WorkflowsApi.md
View File

@@ -37,9 +37,12 @@ Method | HTTP request | Description
[**Test-ExternalExecuteWorkflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger
[**Test-Workflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test Workflow By Id
## cancel-workflow-execution
Use this API to cancel a running workflow execution.
[API Spec](https://developer.sailpoint.com/docs/api/v3/cancel-workflow-execution)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -80,9 +83,12 @@ try {
}
```
[[Back to top]](#)
## create-external-execute-workflow
This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the "External Trigger" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-external-execute-workflow)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -117,16 +123,19 @@ try {
New-ExternalExecuteWorkflow -Id $Id
# Below is a request that includes all optional parameters
# New-ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $CreateExternalExecuteWorkflowRequest
# New-ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ExternalExecuteWorkflow"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-workflow
Create a new workflow with the desired trigger and steps specified in the request body.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-workflow)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -157,19 +166,22 @@ $CreateWorkflowRequest = @"{name=Send Email, owner={type=IDENTITY, id=2c91808568
try {
$Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest
New-Workflow -CreateWorkflowRequest $Result
New-Workflow -CreateWorkflowRequest $Result
# Below is a request that includes all optional parameters
# New-Workflow -CreateWorkflowRequest $CreateWorkflowRequest
# New-Workflow -CreateWorkflowRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Workflow"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-workflow-external-trigger
Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-workflow-external-trigger)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -209,9 +221,12 @@ try {
}
```
[[Back to top]](#)
## delete-workflow
Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled.
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-workflow)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -251,9 +266,12 @@ try {
}
```
[[Back to top]](#)
## get-workflow
Get a single workflow by id.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-workflow)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -293,9 +311,12 @@ try {
}
```
[[Back to top]](#)
## get-workflow-execution
Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-workflow-execution)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -336,9 +357,12 @@ try {
}
```
[[Back to top]](#)
## get-workflow-execution-history
Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-workflow-execution-history)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -379,6 +403,7 @@ try {
}
```
[[Back to top]](#)
## get-workflow-executions
Use this API to list a specified workflow's executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following:
1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows.
@@ -392,6 +417,8 @@ Use this API to list a specified workflow's executions. Workflow executions are
For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250.
Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-workflow-executions)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -440,9 +467,12 @@ try {
}
```
[[Back to top]](#)
## list-complete-workflow-library
This lists all triggers, actions, and operators in the library
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-complete-workflow-library)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -474,7 +504,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
# List Complete Workflow Library
try {
Get-CompleteWorkflowLibrary
Get-CompleteWorkflowLibrary
# Below is a request that includes all optional parameters
# Get-CompleteWorkflowLibrary -Limit $Limit -Offset $Offset
@@ -484,9 +514,12 @@ try {
}
```
[[Back to top]](#)
## list-workflow-library-actions
This lists the workflow actions available to you.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-workflow-library-actions)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -520,7 +553,7 @@ $Filters = 'id eq "sp:create-campaign"' # String | Filter results using the stan
# List Workflow Library Actions
try {
Get-WorkflowLibraryActions
Get-WorkflowLibraryActions
# Below is a request that includes all optional parameters
# Get-WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters
@@ -530,9 +563,12 @@ try {
}
```
[[Back to top]](#)
## list-workflow-library-operators
This lists the workflow operators available to you
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-workflow-library-operators)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -560,7 +596,7 @@ Code | Description | Data Type
# List Workflow Library Operators
try {
Get-WorkflowLibraryOperators
Get-WorkflowLibraryOperators
# Below is a request that includes all optional parameters
# Get-WorkflowLibraryOperators
@@ -570,9 +606,12 @@ try {
}
```
[[Back to top]](#)
## list-workflow-library-triggers
This lists the workflow triggers available to you
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-workflow-library-triggers)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -606,7 +645,7 @@ $Filters = 'id eq "idn:identity-attributes-changed"' # String | Filter results u
# List Workflow Library Triggers
try {
Get-WorkflowLibraryTriggers
Get-WorkflowLibraryTriggers
# Below is a request that includes all optional parameters
# Get-WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters
@@ -616,9 +655,12 @@ try {
}
```
[[Back to top]](#)
## list-workflows
List all workflows in the tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-workflows)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -646,7 +688,7 @@ Code | Description | Data Type
# List Workflows
try {
Get-Workflows
Get-Workflows
# Below is a request that includes all optional parameters
# Get-Workflows
@@ -656,9 +698,12 @@ try {
}
```
[[Back to top]](#)
## patch-workflow
Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-workflow)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -696,19 +741,22 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-Workflow -Id $Id -JsonPatchOperation $Result
Update-Workflow -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-Workflow -Id $Id -JsonPatchOperation $JsonPatchOperation
# Update-Workflow -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Workflow"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-workflow
Perform a full update of a workflow. The updated workflow object is returned in the response.
[API Spec](https://developer.sailpoint.com/docs/api/v3/put-workflow)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -779,19 +827,22 @@ $WorkflowBody = @"{
try {
$Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody
Send-Workflow -Id $Id -WorkflowBody $Result
Send-Workflow -Id $Id -WorkflowBody $Result
# Below is a request that includes all optional parameters
# Send-Workflow -Id $Id -WorkflowBody $WorkflowBody
# Send-Workflow -Id $Id -WorkflowBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Workflow"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## test-external-execute-workflow
Validate a workflow with an "External Trigger" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow.
[API Spec](https://developer.sailpoint.com/docs/api/v3/test-external-execute-workflow)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -826,18 +877,21 @@ try {
Test-ExternalExecuteWorkflow -Id $Id
# Below is a request that includes all optional parameters
# Test-ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $TestExternalExecuteWorkflowRequest
# Test-ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-ExternalExecuteWorkflow"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## test-workflow
Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/idn/docs/event-triggers/available) for an example input for the trigger that initiates this workflow.
This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint.
**This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.**
[API Spec](https://developer.sailpoint.com/docs/api/v3/test-workflow)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -870,10 +924,10 @@ $TestWorkflowRequest = @"{input={identity={id=ee769173319b41d19ccec6cea52f237b,
try {
$Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest
Test-Workflow -Id $Id -TestWorkflowRequest $Result
Test-Workflow -Id $Id -TestWorkflowRequest $Result
# Below is a request that includes all optional parameters
# Test-Workflow -Id $Id -TestWorkflowRequest $TestWorkflowRequest
# Test-Workflow -Id $Id -TestWorkflowRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-Workflow"
Write-Host $_.ErrorDetails

1
docs/tools/sdk/powershell/Reference/V3/Methods/index.md
View File

@@ -11,7 +11,6 @@ tags: ['SDK', 'Software Development Kit', 'v3', 'methods']
---
Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it.
## Key Features
- Purpose & Overview: Explains the purpose of the method and its role in the API.
- Parameters: Describe the required input parameters, including their data types.