LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-07 04:19:34 +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

40
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessModelMetadataApi.md
View File

@@ -32,9 +32,15 @@ Method | HTTP request | Description
[**Get-V2024AccessModelMetadataAttribute**](#list-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes` | List Access Model Metadata Attributes
[**Get-V2024AccessModelMetadataAttributeValue**](#list-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values` | List Access Model Metadata Values
## get-access-model-metadata-attribute
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Get single Access Model Metadata Attribute
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-model-metadata-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -66,19 +72,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get Access Model Metadata Attribute
try {
Get-V2024AccessModelMetadataAttribute -V2024Key $Key -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AccessModelMetadataAttribute -V2024Key $Key -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttribute"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-access-model-metadata-attribute-value
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Get single Access Model Metadata Attribute Value
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-model-metadata-attribute-value)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -112,19 +124,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get Access Model Metadata Value
try {
Get-V2024AccessModelMetadataAttributeValue -V2024Key $Key -V2024Value $Value -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AccessModelMetadataAttributeValue -V2024Key $Key -V2024Value $Value -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttributeValue"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-access-model-metadata-attribute
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Get a list of Access Model Metadata Attributes
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-access-model-metadata-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -156,19 +174,25 @@ $Filters = 'name eq "Privacy"' # String | Filter results using the standard synt
# List Access Model Metadata Attributes
try {
Get-V2024AccessModelMetadataAttribute -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AccessModelMetadataAttribute -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters
# Get-V2024AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttribute"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-access-model-metadata-attribute-value
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Get a list of Access Model Metadata Attribute Values
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-access-model-metadata-attribute-value)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -200,10 +224,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# List Access Model Metadata Values
try {
Get-V2024AccessModelMetadataAttributeValue -V2024Key $Key -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AccessModelMetadataAttributeValue -V2024Key $Key -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttributeValue"
Write-Host $_.ErrorDetails

59
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessProfilesApi.md
View File

@@ -60,11 +60,14 @@ Method | HTTP request | Description
[**Update-V2024AccessProfile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified Access Profile
[**Update-V2024AccessProfilesInBulk**](#update-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-update-requestable` | Update Access Profile(s) requestable field.
## 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/v2024/create-access-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -179,16 +182,17 @@ $AccessProfile = @"{
try {
$Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile
New-V2024AccessProfile -V2024AccessProfile $Result
New-V2024AccessProfile -V2024AccessProfile $Result
# Below is a request that includes all optional parameters
# New-V2024AccessProfile -V2024AccessProfile $AccessProfile
# New-V2024AccessProfile -V2024AccessProfile $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessProfile"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-access-profile
This API deletes an existing Access Profile.
@@ -196,6 +200,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/v2024/delete-access-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -225,16 +231,17 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to
# Delete the specified Access Profile
try {
Remove-V2024AccessProfile -V2024Id $Id
Remove-V2024AccessProfile -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024AccessProfile -V2024Id $Id
# Remove-V2024AccessProfile -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfile"
Write-Host $_.ErrorDetails
}
```
[[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.
@@ -242,6 +249,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/v2024/delete-access-profiles-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -276,19 +285,22 @@ $AccessProfileBulkDeleteRequest = @"{
try {
$Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest
Remove-V2024AccessProfilesInBulk -V2024AccessProfileBulkDeleteRequest $Result
Remove-V2024AccessProfilesInBulk -V2024AccessProfileBulkDeleteRequest $Result
# Below is a request that includes all optional parameters
# Remove-V2024AccessProfilesInBulk -V2024AccessProfileBulkDeleteRequest $AccessProfileBulkDeleteRequest
# Remove-V2024AccessProfilesInBulk -V2024AccessProfileBulkDeleteRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfilesInBulk"
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/v2024/get-access-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -318,21 +330,24 @@ $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile
# Get an Access Profile
try {
Get-V2024AccessProfile -V2024Id $Id
Get-V2024AccessProfile -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024AccessProfile -V2024Id $Id
# Get-V2024AccessProfile -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfile"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-access-profile-entitlements)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -372,20 +387,23 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de
# List Access Profile's Entitlements
try {
Get-V2024AccessProfileEntitlements -V2024Id $Id
Get-V2024AccessProfileEntitlements -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024AccessProfileEntitlements -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024AccessProfileEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfileEntitlements"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/list-access-profiles)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -429,16 +447,17 @@ $IncludeUnsegmented = $false # Boolean | Indicates whether the response list sho
# List Access Profiles
try {
Get-V2024AccessProfiles
Get-V2024AccessProfiles
# Below is a request that includes all optional parameters
# Get-V2024AccessProfiles -V2024ForSubadmin $ForSubadmin -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters -V2024ForSegmentIds $ForSegmentIds -V2024IncludeUnsegmented $IncludeUnsegmented
# Get-V2024AccessProfiles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfiles"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-access-profile
This API updates an existing Access Profile. The following fields are patchable:
@@ -471,6 +490,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/v2024/patch-access-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -508,17 +529,21 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024AccessProfile -V2024Id $Id -V2024JsonPatchOperation $Result
Update-V2024AccessProfile -Id $Id -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024AccessProfile -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024AccessProfile -Id $Id -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AccessProfile"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-access-profiles-in-bulk
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API initiates a bulk update of field requestable for one or more Access Profiles.
> If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated**
@@ -527,6 +552,8 @@ This API initiates a bulk update of field requestable for one or more Access Pro
> If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated.
A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-access-profiles-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -561,10 +588,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner
Update-V2024AccessProfilesInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessProfileBulkUpdateRequestInner $Result
Update-V2024AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -V2024AccessProfileBulkUpdateRequestInner $Result
# Below is a request that includes all optional parameters
# Update-V2024AccessProfilesInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessProfileBulkUpdateRequestInner $AccessProfileBulkUpdateRequestInner
# Update-V2024AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -V2024AccessProfileBulkUpdateRequestInner $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AccessProfilesInBulk"
Write-Host $_.ErrorDetails

53
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestApprovalsApi.md
View File

@@ -42,9 +42,12 @@ Method | HTTP request | Description
[**Get-V2024PendingApprovals**](#list-pending-approvals) | **GET** `/access-request-approvals/pending` | Pending Access Request Approvals List
[**Deny-V2024AccessRequest**](#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/v2024/approve-access-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -85,19 +88,22 @@ $CommentDto = @"{
# Approve Access Request Approval
try {
Approve-V2024AccessRequest -V2024ApprovalId $ApprovalId
Approve-V2024AccessRequest -ApprovalId $ApprovalId
# Below is a request that includes all optional parameters
# Approve-V2024AccessRequest -V2024ApprovalId $ApprovalId -V2024CommentDto $CommentDto
# Approve-V2024AccessRequest -ApprovalId $ApprovalId -V2024CommentDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024AccessRequest"
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/v2024/forward-access-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -134,19 +140,22 @@ $ForwardApprovalDto = @"{
try {
$Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto
Invoke-V2024ForwardAccessRequest -V2024ApprovalId $ApprovalId -V2024ForwardApprovalDto $Result
Invoke-V2024ForwardAccessRequest -ApprovalId $ApprovalId -V2024ForwardApprovalDto $Result
# Below is a request that includes all optional parameters
# Invoke-V2024ForwardAccessRequest -V2024ApprovalId $ApprovalId -V2024ForwardApprovalDto $ForwardApprovalDto
# Invoke-V2024ForwardAccessRequest -ApprovalId $ApprovalId -V2024ForwardApprovalDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ForwardAccessRequest"
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/v2024/get-access-request-approval-summary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -178,20 +187,23 @@ $FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and tim
# Get Access Requests Approvals Number
try {
Get-V2024AccessRequestApprovalSummary
Get-V2024AccessRequestApprovalSummary
# Below is a request that includes all optional parameters
# Get-V2024AccessRequestApprovalSummary -V2024OwnerId $OwnerId -V2024FromDate $FromDate
# Get-V2024AccessRequestApprovalSummary -OwnerId $OwnerId -FromDate $FromDate
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestApprovalSummary"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-access-request-approvers
This API endpoint returns the list of approvers for the given access request id.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-access-request-approvers)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -228,19 +240,22 @@ $Count = $false # Boolean | If this is true, the *X-Total-Count* response header
# Access Request Approvers
try {
Get-V2024AccessRequestApprovers -V2024AccessRequestId $AccessRequestId
Get-V2024AccessRequestApprovers -AccessRequestId $AccessRequestId
# Below is a request that includes all optional parameters
# Get-V2024AccessRequestApprovers -V2024AccessRequestId $AccessRequestId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count
# Get-V2024AccessRequestApprovers -AccessRequestId $AccessRequestId -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestApprovers"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/list-completed-approvals)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -280,19 +295,22 @@ $Sorters = "modified" # String | Sort results using the standard syntax describe
# Completed Access Request Approvals List
try {
Get-V2024CompletedApprovals
Get-V2024CompletedApprovals
# Below is a request that includes all optional parameters
# Get-V2024CompletedApprovals -V2024OwnerId $OwnerId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024CompletedApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompletedApprovals"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/list-pending-approvals)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -300,7 +318,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
@@ -326,25 +344,28 @@ $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-V2024PendingApprovals
Get-V2024PendingApprovals
# Below is a request that includes all optional parameters
# Get-V2024PendingApprovals -V2024OwnerId $OwnerId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024PendingApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingApprovals"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/reject-access-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -386,10 +407,10 @@ $CommentDto = @"{
try {
$Result = ConvertFrom-JsonToCommentDto -Json $CommentDto
Deny-V2024AccessRequest -V2024ApprovalId $ApprovalId -V2024CommentDto $Result
Deny-V2024AccessRequest -ApprovalId $ApprovalId -V2024CommentDto $Result
# Below is a request that includes all optional parameters
# Deny-V2024AccessRequest -V2024ApprovalId $ApprovalId -V2024CommentDto $CommentDto
# Deny-V2024AccessRequest -ApprovalId $ApprovalId -V2024CommentDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024AccessRequest"
Write-Host $_.ErrorDetails

10
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestIdentityMetricsApi.md
View File

@@ -23,9 +23,15 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024AccessRequestIdentityMetrics**](#get-access-request-identity-metrics) | **GET** `/access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type}` | Return access request identity metrics
## get-access-request-identity-metrics
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Use this API to return information access metrics.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-identity-metrics)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -61,10 +67,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Return access request identity metrics
try {
Get-V2024AccessRequestIdentityMetrics -V2024IdentityId $IdentityId -V2024RequestedObjectId $RequestedObjectId -V2024Type $Type -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AccessRequestIdentityMetrics -V2024IdentityId $IdentityId -V2024RequestedObjectId $RequestedObjectId -V2024Type $Type -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestIdentityMetrics"
Write-Host $_.ErrorDetails

64
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md
View File

@@ -42,9 +42,12 @@ Method | HTTP request | Description
[**Get-V2024AdministratorsAccessRequestStatus**](#list-administrators-access-request-status) | **GET** `/access-request-administration` | Access Request Status for Administrators
[**Set-V2024AccessRequestConfig**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration
## approve-bulk-access-request
This API endpoint allows approving pending access requests in bulk. Maximum of 50 approval ids can be provided in the request for one single invocation. ORG_ADMIN or users with rights "idn:access-request-administration:write" can approve the access requests in bulk.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/approve-bulk-access-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -79,20 +82,23 @@ $BulkApproveAccessRequest = @"{
try {
$Result = ConvertFrom-JsonToBulkApproveAccessRequest -Json $BulkApproveAccessRequest
Approve-V2024BulkAccessRequest -V2024BulkApproveAccessRequest $Result
Approve-V2024BulkAccessRequest -V2024BulkApproveAccessRequest $Result
# Below is a request that includes all optional parameters
# Approve-V2024BulkAccessRequest -V2024BulkApproveAccessRequest $BulkApproveAccessRequest
# Approve-V2024BulkAccessRequest -V2024BulkApproveAccessRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024BulkAccessRequest"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## 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/v2024/cancel-access-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -127,20 +133,23 @@ $CancelAccessRequest = @"{
try {
$Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest
Suspend-V2024AccessRequest -V2024CancelAccessRequest $Result
Suspend-V2024AccessRequest -V2024CancelAccessRequest $Result
# Below is a request that includes all optional parameters
# Suspend-V2024AccessRequest -V2024CancelAccessRequest $CancelAccessRequest
# Suspend-V2024AccessRequest -V2024CancelAccessRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024AccessRequest"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## cancel-access-request-in-bulk
This API endpoint allows cancelling pending access requests in bulk. Maximum of 50 access request ids can be provided in the request for one single invocation.
Only ORG_ADMIN or users with rights "idn:access-request-administration:write" can cancel the access requests in bulk.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/cancel-access-request-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -175,17 +184,21 @@ $BulkCancelAccessRequest = @"{
try {
$Result = ConvertFrom-JsonToBulkCancelAccessRequest -Json $BulkCancelAccessRequest
Suspend-V2024AccessRequestInBulk -V2024BulkCancelAccessRequest $Result
Suspend-V2024AccessRequestInBulk -V2024BulkCancelAccessRequest $Result
# Below is a request that includes all optional parameters
# Suspend-V2024AccessRequestInBulk -V2024BulkCancelAccessRequest $BulkCancelAccessRequest
# Suspend-V2024AccessRequestInBulk -V2024BulkCancelAccessRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024AccessRequestInBulk"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## close-access-request
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request's lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/).
To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND "Access Request". Use the Column Chooser to select 'Tracking Number', and use the 'Download' button to export a CSV containing the tracking numbers.
@@ -199,6 +212,8 @@ To track the status of endpoint requests, navigate to Search and use this query:
This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/provisioning-completed/) for each access request that is closed.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/close-access-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -236,16 +251,17 @@ $CloseAccessRequest = @"{
try {
$Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest
Close-V2024AccessRequest -V2024XSailPointExperimental $XSailPointExperimental -V2024CloseAccessRequest $Result
Close-V2024AccessRequest -XSailPointExperimental $XSailPointExperimental -V2024CloseAccessRequest $Result
# Below is a request that includes all optional parameters
# Close-V2024AccessRequest -V2024XSailPointExperimental $XSailPointExperimental -V2024CloseAccessRequest $CloseAccessRequest
# Close-V2024AccessRequest -XSailPointExperimental $XSailPointExperimental -V2024CloseAccessRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-V2024AccessRequest"
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.
@@ -279,6 +295,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/v2024/create-access-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -362,19 +380,22 @@ $AccessRequest = @"{
try {
$Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest
New-V2024AccessRequest -V2024AccessRequest $Result
New-V2024AccessRequest -V2024AccessRequest $Result
# Below is a request that includes all optional parameters
# New-V2024AccessRequest -V2024AccessRequest $AccessRequest
# New-V2024AccessRequest -V2024AccessRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessRequest"
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/v2024/get-access-request-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -402,7 +423,7 @@ Code | Description | Data Type
# Get Access Request Configuration
try {
Get-V2024AccessRequestConfig
Get-V2024AccessRequestConfig
# Below is a request that includes all optional parameters
# Get-V2024AccessRequestConfig
@@ -412,11 +433,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/v2024/list-access-request-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -464,20 +488,23 @@ $RequestState = "request-state=EXECUTING" # String | Filter the results by the s
# Access Request Status
try {
Get-V2024AccessRequestStatus
Get-V2024AccessRequestStatus
# Below is a request that includes all optional parameters
# Get-V2024AccessRequestStatus -V2024RequestedFor $RequestedFor -V2024RequestedBy $RequestedBy -V2024RegardingIdentity $RegardingIdentity -V2024AssignedTo $AssignedTo -V2024Count $Count -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters -V2024Sorters $Sorters -V2024RequestState $RequestState
# Get-V2024AccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestStatus"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-administrators-access-request-status
Use this API to get access request statuses of all the access requests in the org based on the specified query parameters.
Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-administrators-access-request-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -525,19 +552,22 @@ $RequestState = "request-state=EXECUTING" # String | Filter the results by the s
# Access Request Status for Administrators
try {
Get-V2024AdministratorsAccessRequestStatus
Get-V2024AdministratorsAccessRequestStatus
# Below is a request that includes all optional parameters
# Get-V2024AdministratorsAccessRequestStatus -V2024RequestedFor $RequestedFor -V2024RequestedBy $RequestedBy -V2024RegardingIdentity $RegardingIdentity -V2024AssignedTo $AssignedTo -V2024Count $Count -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters -V2024Sorters $Sorters -V2024RequestState $RequestState
# Get-V2024AdministratorsAccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AdministratorsAccessRequestStatus"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-access-request-config
This endpoint replaces the current access-request configuration.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-access-request-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -593,10 +623,10 @@ $AccessRequestConfig = @"{
try {
$Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig
Set-V2024AccessRequestConfig -V2024AccessRequestConfig $Result
Set-V2024AccessRequestConfig -V2024AccessRequestConfig $Result
# Below is a request that includes all optional parameters
# Set-V2024AccessRequestConfig -V2024AccessRequestConfig $AccessRequestConfig
# Set-V2024AccessRequestConfig -V2024AccessRequestConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024AccessRequestConfig"
Write-Host $_.ErrorDetails

14
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountActivitiesApi.md
View File

@@ -53,9 +53,12 @@ Method | HTTP request | Description
[**Get-V2024AccountActivity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get an Account Activity
[**Get-V2024AccountActivities**](#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/v2024/get-account-activity)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -86,19 +89,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id
# Get an Account Activity
try {
Get-V2024AccountActivity -V2024Id $Id
Get-V2024AccountActivity -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024AccountActivity -V2024Id $Id
# Get-V2024AccountActivity -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountActivity"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/list-account-activities)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -142,10 +148,10 @@ $Sorters = "created" # String | Sort results using the standard syntax described
# List Account Activities
try {
Get-V2024AccountActivities
Get-V2024AccountActivities
# Below is a request that includes all optional parameters
# Get-V2024AccountActivities -V2024RequestedFor $RequestedFor -V2024RequestedBy $RequestedBy -V2024RegardingIdentity $RegardingIdentity -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024AccountActivities -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountActivities"
Write-Host $_.ErrorDetails

10
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountAggregationsApi.md
View File

@@ -29,7 +29,11 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024AccountAggregationStatus**](#get-account-aggregation-status) | **GET** `/account-aggregations/{id}/status` | In-progress Account Aggregation status
## get-account-aggregation-status
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far.
Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not.
@@ -39,6 +43,8 @@ Since this endpoint reports on the status of an *in-progress* account aggregatio
*Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.*
required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-account-aggregation-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -70,10 +76,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# In-progress Account Aggregation status
try {
Get-V2024AccountAggregationStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AccountAggregationStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountAggregationStatus"
Write-Host $_.ErrorDetails

7
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountUsagesApi.md
View File

@@ -22,9 +22,12 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024UsagesByAccountId**](#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/v2024/get-usages-by-account-id)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -62,10 +65,10 @@ $Sorters = "-date" # String | Sort results using the standard syntax described i
# Returns account usage insights
try {
Get-V2024UsagesByAccountId -V2024AccountId $AccountId
Get-V2024UsagesByAccountId -AccountId $AccountId
# Below is a request that includes all optional parameters
# Get-V2024UsagesByAccountId -V2024AccountId $AccountId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters
# Get-V2024UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesByAccountId"
Write-Host $_.ErrorDetails

127
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountsApi.md
View File

@@ -61,6 +61,7 @@ Method | HTTP request | Description
[**Unlock-V2024Account**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock Account
[**Update-V2024Account**](#update-account) | **PATCH** `/accounts/{id}` | Update Account
## create-account
Submit an account creation task - the API then returns the task ID.
@@ -75,6 +76,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/v2024/create-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -114,22 +117,25 @@ $AccountAttributesCreate = @"{
try {
$Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate
New-V2024Account -V2024AccountAttributesCreate $Result
New-V2024Account -V2024AccountAttributesCreate $Result
# Below is a request that includes all optional parameters
# New-V2024Account -V2024AccountAttributesCreate $AccountAttributesCreate
# New-V2024Account -V2024AccountAttributesCreate $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Account"
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/v2024/delete-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -160,17 +166,21 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
# Delete Account
try {
Remove-V2024Account -V2024Id $Id
Remove-V2024Account -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024Account -V2024Id $Id
# Remove-V2024Account -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Account"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-account-async
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation.
This endpoint is good for:
@@ -179,6 +189,8 @@ This endpoint is good for:
* Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-account-async)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -210,19 +222,22 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Remove Account
try {
Remove-V2024AccountAsync -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Remove-V2024AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024AccountAsync -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Remove-V2024AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccountAsync"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/disable-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -259,19 +274,25 @@ $AccountToggleRequest = @"{
try {
$Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest
Disable-V2024Account -V2024Id $Id -V2024AccountToggleRequest $Result
Disable-V2024Account -Id $Id -V2024AccountToggleRequest $Result
# Below is a request that includes all optional parameters
# Disable-V2024Account -V2024Id $Id -V2024AccountToggleRequest $AccountToggleRequest
# Disable-V2024Account -Id $Id -V2024AccountToggleRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024Account"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## disable-account-for-identity
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API submits a task to disable IDN account for a single identity.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/disable-account-for-identity)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -304,19 +325,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Disable IDN Account for Identity
try {
Disable-V2024AccountForIdentity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Disable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Disable-V2024AccountForIdentity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Disable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountForIdentity"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## disable-accounts-for-identities
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API submits tasks to disable IDN account for each identity provided in the request body.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/disable-accounts-for-identities)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -351,19 +378,22 @@ $IdentitiesAccountsBulkRequest = @"{
try {
$Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest
Disable-V2024AccountsForIdentities -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result
Disable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result
# Below is a request that includes all optional parameters
# Disable-V2024AccountsForIdentities -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $IdentitiesAccountsBulkRequest
# Disable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountsForIdentities"
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/v2024/enable-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -400,19 +430,25 @@ $AccountToggleRequest = @"{
try {
$Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest
Enable-V2024Account -V2024Id $Id -V2024AccountToggleRequest $Result
Enable-V2024Account -Id $Id -V2024AccountToggleRequest $Result
# Below is a request that includes all optional parameters
# Enable-V2024Account -V2024Id $Id -V2024AccountToggleRequest $AccountToggleRequest
# Enable-V2024Account -Id $Id -V2024AccountToggleRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024Account"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## enable-account-for-identity
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API submits a task to enable IDN account for a single identity.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/enable-account-for-identity)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -445,19 +481,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Enable IDN Account for Identity
try {
Enable-V2024AccountForIdentity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Enable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Enable-V2024AccountForIdentity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Enable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountForIdentity"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## enable-accounts-for-identities
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API submits tasks to enable IDN account for each identity provided in the request body.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/enable-accounts-for-identities)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -492,19 +534,22 @@ $IdentitiesAccountsBulkRequest = @"{
try {
$Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest
Enable-V2024AccountsForIdentities -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result
Enable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result
# Below is a request that includes all optional parameters
# Enable-V2024AccountsForIdentities -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $IdentitiesAccountsBulkRequest
# Enable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountsForIdentities"
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/v2024/get-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -535,19 +580,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
# Account Details
try {
Get-V2024Account -V2024Id $Id
Get-V2024Account -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024Account -V2024Id $Id
# Get-V2024Account -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Account"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-account-entitlements
This API returns entitlements of the account.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-account-entitlements)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -584,19 +632,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Account Entitlements
try {
Get-V2024AccountEntitlements -V2024Id $Id
Get-V2024AccountEntitlements -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024AccountEntitlements -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count
# Get-V2024AccountEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountEntitlements"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-accounts
List accounts.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-accounts)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -636,16 +687,17 @@ $Sorters = "id,name" # String | Sort results using the standard syntax described
# Accounts List
try {
Get-V2024Accounts
Get-V2024Accounts
# Below is a request that includes all optional parameters
# Get-V2024Accounts -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024DetailLevel $DetailLevel -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024Accounts -Limit $Limit -Offset $Offset -Count $Count -DetailLevel $DetailLevel -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Accounts"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-account
Use this API to update an account with a PUT request.
@@ -654,6 +706,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/v2024/put-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -695,19 +749,22 @@ $AccountAttributes = @"{
try {
$Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes
Send-V2024Account -V2024Id $Id -V2024AccountAttributes $Result
Send-V2024Account -Id $Id -V2024AccountAttributes $Result
# Below is a request that includes all optional parameters
# Send-V2024Account -V2024Id $Id -V2024AccountAttributes $AccountAttributes
# Send-V2024Account -Id $Id -V2024AccountAttributes $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Account"
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/v2024/submit-reload-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -738,20 +795,23 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id
# Reload Account
try {
Submit-V2024ReloadAccount -V2024Id $Id
Submit-V2024ReloadAccount -Id $Id
# Below is a request that includes all optional parameters
# Submit-V2024ReloadAccount -V2024Id $Id
# Submit-V2024ReloadAccount -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024ReloadAccount"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/unlock-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -789,16 +849,17 @@ $AccountUnlockRequest = @"{
try {
$Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest
Unlock-V2024Account -V2024Id $Id -V2024AccountUnlockRequest $Result
Unlock-V2024Account -Id $Id -V2024AccountUnlockRequest $Result
# Below is a request that includes all optional parameters
# Unlock-V2024Account -V2024Id $Id -V2024AccountUnlockRequest $AccountUnlockRequest
# Unlock-V2024Account -Id $Id -V2024AccountUnlockRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-V2024Account"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-account
Use this API to update account details.
@@ -812,6 +873,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/v2024/update-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -847,10 +910,10 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of account update operat
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Update-V2024Account -V2024Id $Id -V2024RequestBody $Result
Update-V2024Account -Id $Id -RequestBody $Result
# Below is a request that includes all optional parameters
# Update-V2024Account -V2024Id $Id -V2024RequestBody $RequestBody
# Update-V2024Account -Id $Id -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Account"
Write-Host $_.ErrorDetails

19
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ApplicationDiscoveryApi.md
View File

@@ -23,10 +23,13 @@ Method | HTTP request | Description
[**Get-V2024ManualDiscoverApplicationsCsvTemplate**](#get-manual-discover-applications-csv-template) | **GET** `/manual-discover-applications-template` | Download CSV Template for Discovery
[**Send-V2024ManualDiscoverApplicationsCsvTemplate**](#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/v2024/get-discovered-applications)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -64,22 +67,25 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
# Get Discovered Applications for Tenant
try {
Get-V2024DiscoveredApplications
Get-V2024DiscoveredApplications
# Below is a request that includes all optional parameters
# Get-V2024DiscoveredApplications -V2024Limit $Limit -V2024Offset $Offset -V2024Detail $Detail -V2024Filter $Filter -V2024Sorters $Sorters
# Get-V2024DiscoveredApplications -Limit $Limit -Offset $Offset -Detail $Detail -Filter $Filter -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DiscoveredApplications"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/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-V2024ManualDiscoverApplicationsCsvTemplate
Get-V2024ManualDiscoverApplicationsCsvTemplate
# Below is a request that includes all optional parameters
# Get-V2024ManualDiscoverApplicationsCsvTemplate
@@ -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/v2024/send-manual-discover-applications-csv-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -150,10 +159,10 @@ $File = # System.IO.FileInfo | The CSV file to upload containing `application_n
# Upload CSV to Discover Applications
try {
Send-V2024ManualDiscoverApplicationsCsvTemplate -V2024File $File
Send-V2024ManualDiscoverApplicationsCsvTemplate -File $File
# Below is a request that includes all optional parameters
# Send-V2024ManualDiscoverApplicationsCsvTemplate -V2024File $File
# Send-V2024ManualDiscoverApplicationsCsvTemplate -File $File
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ManualDiscoverApplicationsCsvTemplate"
Write-Host $_.ErrorDetails

20
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ApprovalsApi.md
View File

@@ -23,9 +23,15 @@ Method | HTTP request | Description
[**Get-V2024Approval**](#get-approval) | **GET** `/generic-approvals/{id}` | Get an approval
[**Get-V2024Approvals**](#get-approvals) | **GET** `/generic-approvals` | Get Approvals
## get-approval
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Retrieve a single approval for a given approval ID. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-approval)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -57,20 +63,26 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get an approval
try {
Get-V2024Approval -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024Approval -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024Approval -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024Approval -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Approval"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-approvals
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Retrieve a list of approvals, which can be filtered by requester ID, status, or reference type. "Mine" query parameter can be used and it will return all approvals for the current approver. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals.
Absence of all query parameters will will default to mine=true.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-approvals)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -106,10 +118,10 @@ $Filters = 'filters=status eq PENDING' # String | Filter results using the stand
# Get Approvals
try {
Get-V2024Approvals -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024Approvals -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024Approvals -V2024XSailPointExperimental $XSailPointExperimental -V2024Mine $Mine -V2024RequesterId $RequesterId -V2024Filters $Filters
# Get-V2024Approvals -XSailPointExperimental $XSailPointExperimental -Mine $Mine -RequesterId $RequesterId -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Approvals"
Write-Host $_.ErrorDetails

140
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AppsApi.md
View File

@@ -34,9 +34,15 @@ Method | HTTP request | Description
[**Update-V2024UserApp**](#patch-user-app) | **PATCH** `/user-apps/{id}` | Patch user app by ID
[**Update-V2024SourceAppsInBulk**](#update-source-apps-in-bulk) | **POST** `/source-apps/bulk-update` | Bulk update source apps
## create-source-app
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This endpoint creates a source app using the given source app payload
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-source-app)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -78,19 +84,25 @@ $SourceAppCreateDto = @"{
try {
$Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto
New-V2024SourceApp -V2024XSailPointExperimental $XSailPointExperimental -V2024SourceAppCreateDto $Result
New-V2024SourceApp -XSailPointExperimental $XSailPointExperimental -V2024SourceAppCreateDto $Result
# Below is a request that includes all optional parameters
# New-V2024SourceApp -V2024XSailPointExperimental $XSailPointExperimental -V2024SourceAppCreateDto $SourceAppCreateDto
# New-V2024SourceApp -XSailPointExperimental $XSailPointExperimental -V2024SourceAppCreateDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceApp"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-access-profiles-from-source-app-by-bulk
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns the final list of access profiles for the specified source app after removing
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-access-profiles-from-source-app-by-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -129,19 +141,25 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Remove-V2024AccessProfilesFromSourceAppByBulk -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $Result
Remove-V2024AccessProfilesFromSourceAppByBulk -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result
# Below is a request that includes all optional parameters
# Remove-V2024AccessProfilesFromSourceAppByBulk -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $RequestBody -V2024Limit $Limit
# Remove-V2024AccessProfilesFromSourceAppByBulk -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result -Limit $Limit
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfilesFromSourceAppByBulk"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-source-app
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Use this API to delete a specific source app
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-source-app)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -173,19 +191,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Delete source app by ID
try {
Remove-V2024SourceApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Remove-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024SourceApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Remove-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SourceApp"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-source-app
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns a source app by its ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-app)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -218,19 +242,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get source app by ID
try {
Get-V2024SourceApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SourceApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceApp"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-access-profiles-for-source-app
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns the list of access profiles for the specified source app
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-access-profiles-for-source-app)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -268,19 +298,25 @@ $Filters = 'name eq "developer access profile"' # String | Filter results using
# List access profiles for the specified source app
try {
Get-V2024AccessProfilesForSourceApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024AccessProfilesForSourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AccessProfilesForSourceApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters
# Get-V2024AccessProfilesForSourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfilesForSourceApp"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-all-source-app
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns the list of all source apps for the org.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-all-source-app)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -320,20 +356,26 @@ $Filters = 'enabled eq true' # String | Filter results using the standard syntax
# List all source apps
try {
Get-V2024AllSourceApp -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024AllSourceApp -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AllSourceApp -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset -V2024Sorters $Sorters -V2024Filters $Filters
# Get-V2024AllSourceApp -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllSourceApp"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-all-user-apps
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns the list of all user apps with specified filters.
This API must be used with **filters** query parameter.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-all-user-apps)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -371,19 +413,25 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
# List all user apps
try {
Get-V2024AllUserApps -V2024Filters $Filters -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024AllUserApps -Filters $Filters -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AllUserApps -V2024Filters $Filters -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset
# Get-V2024AllUserApps -Filters $Filters -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllUserApps"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-assigned-source-app
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns the list of source apps assigned for logged in user.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-assigned-source-app)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -423,19 +471,25 @@ $Filters = 'name eq "source app name"' # String | Filter results using the stand
# List assigned source apps
try {
Get-V2024AssignedSourceApp -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024AssignedSourceApp -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AssignedSourceApp -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset -V2024Sorters $Sorters -V2024Filters $Filters
# Get-V2024AssignedSourceApp -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AssignedSourceApp"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-available-accounts-for-user-app
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-available-accounts-for-user-app)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -471,19 +525,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# List available accounts for user app
try {
Get-V2024AvailableAccountsForUserApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024AvailableAccountsForUserApp -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AvailableAccountsForUserApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count
# Get-V2024AvailableAccountsForUserApp -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AvailableAccountsForUserApp"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-available-source-apps
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns the list of source apps available for access request.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-available-source-apps)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -523,19 +583,25 @@ $Filters = 'name eq "source app name"' # String | Filter results using the stand
# List available source apps
try {
Get-V2024AvailableSourceApps -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024AvailableSourceApps -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AvailableSourceApps -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset -V2024Sorters $Sorters -V2024Filters $Filters
# Get-V2024AvailableSourceApps -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AvailableSourceApps"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-owned-user-apps
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns the list of user apps assigned to logged in user
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-owned-user-apps)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -573,21 +639,27 @@ $Filters = 'name eq "user app name"' # String | Filter results using the standar
# List owned user apps
try {
Get-V2024OwnedUserApps -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024OwnedUserApps -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024OwnedUserApps -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset -V2024Filters $Filters
# Get-V2024OwnedUserApps -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OwnedUserApps"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-source-app
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**.
Name, description and owner can't be empty or null.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-source-app)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -627,20 +699,26 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Patch source app by ID
try {
Update-V2024SourceApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Update-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Update-V2024SourceApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceApp"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-user-app
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
The following fields are patchable: **account**
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-user-app)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -680,21 +758,27 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Patch user app by ID
try {
Update-V2024UserApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Update-V2024UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Update-V2024UserApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024UserApp"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-source-apps-in-bulk
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch.
The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**.
Name, description and owner can't be empty or null.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-source-apps-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -738,10 +822,10 @@ $SourceAppBulkUpdateRequest = @"{
# Bulk update source apps
try {
Update-V2024SourceAppsInBulk -V2024XSailPointExperimental $XSailPointExperimental
Update-V2024SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Update-V2024SourceAppsInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024SourceAppBulkUpdateRequest $SourceAppBulkUpdateRequest
# Update-V2024SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental -V2024SourceAppBulkUpdateRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceAppsInBulk"
Write-Host $_.ErrorDetails

30
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AuthProfileApi.md
View File

@@ -27,9 +27,15 @@ Method | HTTP request | Description
[**Get-V2024ProfileConfigList**](#get-profile-config-list) | **GET** `/auth-profiles` | Get list of Auth Profiles.
[**Update-V2024ProfileConfig**](#patch-profile-config) | **PATCH** `/auth-profiles/{id}` | Patch a specified Auth Profile
## get-profile-config
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns auth profile information.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-profile-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -62,19 +68,25 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to pa
# Get Auth Profile.
try {
Get-V2024ProfileConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024Id $Id
Get-V2024ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024ProfileConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024Id $Id
# Get-V2024ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProfileConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-profile-config-list
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns a list of auth profiles.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-profile-config-list)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -104,20 +116,26 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get list of Auth Profiles.
try {
Get-V2024ProfileConfigList -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024ProfileConfigList -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024ProfileConfigList -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024ProfileConfigList -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProfileConfigList"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-profile-config
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API updates an existing Auth Profile. The following fields are patchable:
**offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type**
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-profile-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -157,10 +175,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024ProfileConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
Update-V2024ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024ProfileConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProfileConfig"
Write-Host $_.ErrorDetails

14
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AuthUsersApi.md
View File

@@ -25,9 +25,12 @@ Method | HTTP request | Description
[**Get-V2024AuthUser**](#get-auth-user) | **GET** `/auth-users/{id}` | Auth User Details
[**Update-V2024AuthUser**](#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/v2024/get-auth-user)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -58,16 +61,17 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID
# Auth User Details
try {
Get-V2024AuthUser -V2024Id $Id
Get-V2024AuthUser -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024AuthUser -V2024Id $Id
# Get-V2024AuthUser -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthUser"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/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-V2024AuthUser -V2024Id $Id -V2024JsonPatchOperation $Result
Update-V2024AuthUser -Id $Id -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024AuthUser -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024AuthUser -Id $Id -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthUser"
Write-Host $_.ErrorDetails

33
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024BrandingApi.md
View File

@@ -28,9 +28,12 @@ Method | HTTP request | Description
[**Get-V2024BrandingList**](#get-branding-list) | **GET** `/brandings` | List of branding items
[**Set-V2024BrandingItem**](#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/v2024/create-branding-item)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -74,19 +77,22 @@ $FileStandard = # System.IO.FileInfo | png file with logo (optional)
# Create a branding item
try {
New-V2024BrandingItem -V2024Name $Name -V2024ProductName $ProductName
New-V2024BrandingItem -Name $Name -ProductName $ProductName
# Below is a request that includes all optional parameters
# New-V2024BrandingItem -V2024Name $Name -V2024ProductName $ProductName -V2024ActionButtonColor $ActionButtonColor -V2024ActiveLinkColor $ActiveLinkColor -V2024NavigationColor $NavigationColor -V2024EmailFromAddress $EmailFromAddress -V2024LoginInformationalMessage $LoginInformationalMessage -V2024FileStandard $FileStandard
# New-V2024BrandingItem -Name $Name -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024BrandingItem"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/delete-branding)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -117,19 +123,22 @@ $Name = "default" # String | The name of the branding item to be deleted
# Delete a branding item
try {
Remove-V2024Branding -V2024Name $Name
Remove-V2024Branding -Name $Name
# Below is a request that includes all optional parameters
# Remove-V2024Branding -V2024Name $Name
# Remove-V2024Branding -Name $Name
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Branding"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-branding)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -160,19 +169,22 @@ $Name = "default" # String | The name of the branding item to be retrieved
# Get a branding item
try {
Get-V2024Branding -V2024Name $Name
Get-V2024Branding -Name $Name
# Below is a request that includes all optional parameters
# Get-V2024Branding -V2024Name $Name
# Get-V2024Branding -Name $Name
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Branding"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-branding-list
This API endpoint returns a list of branding items.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/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-V2024BrandingList
Get-V2024BrandingList
# Below is a request that includes all optional parameters
# Get-V2024BrandingList
@@ -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/v2024/set-branding-item)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -259,10 +274,10 @@ $FileStandard = # System.IO.FileInfo | png file with logo (optional)
# Update a branding item
try {
Set-V2024BrandingItem -V2024Name $Name -V2024Name2 $Name2 -V2024ProductName $ProductName
Set-V2024BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName
# Below is a request that includes all optional parameters
# Set-V2024BrandingItem -V2024Name $Name -V2024Name2 $Name2 -V2024ProductName $ProductName -V2024ActionButtonColor $ActionButtonColor -V2024ActiveLinkColor $ActiveLinkColor -V2024NavigationColor $NavigationColor -V2024EmailFromAddress $EmailFromAddress -V2024LoginInformationalMessage $LoginInformationalMessage -V2024FileStandard $FileStandard
# Set-V2024BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024BrandingItem"
Write-Host $_.ErrorDetails

35
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignFiltersApi.md
View File

@@ -50,9 +50,12 @@ Method | HTTP request | Description
[**Get-V2024CampaignFilters**](#list-campaign-filters) | **GET** `/campaign-filters` | List Campaign Filters
[**Update-V2024CampaignFilter**](#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/v2024/create-campaign-filter)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -100,19 +103,22 @@ $CampaignFilterDetails = @"{
try {
$Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails
New-V2024CampaignFilter -V2024CampaignFilterDetails $Result
New-V2024CampaignFilter -V2024CampaignFilterDetails $Result
# Below is a request that includes all optional parameters
# New-V2024CampaignFilter -V2024CampaignFilterDetails $CampaignFilterDetails
# New-V2024CampaignFilter -V2024CampaignFilterDetails $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CampaignFilter"
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/v2024/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-V2024CampaignFilters -V2024RequestBody $Result
Remove-V2024CampaignFilters -RequestBody $Result
# Below is a request that includes all optional parameters
# Remove-V2024CampaignFilters -V2024RequestBody $RequestBody
# Remove-V2024CampaignFilters -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CampaignFilters"
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/v2024/get-campaign-filter-by-id)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -189,19 +198,22 @@ $Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filte
# Get Campaign Filter by ID
try {
Get-V2024CampaignFilterById -V2024Id $Id
Get-V2024CampaignFilterById -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024CampaignFilterById -V2024Id $Id
# Get-V2024CampaignFilterById -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignFilterById"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/list-campaign-filters)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -235,19 +247,22 @@ $IncludeSystemFilters = $true # Boolean | If this is true, the API includes syst
# List Campaign Filters
try {
Get-V2024CampaignFilters
Get-V2024CampaignFilters
# Below is a request that includes all optional parameters
# Get-V2024CampaignFilters -V2024Limit $Limit -V2024Start $Start -V2024IncludeSystemFilters $IncludeSystemFilters
# Get-V2024CampaignFilters -Limit $Limit -Start $Start -IncludeSystemFilters $IncludeSystemFilters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignFilters"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-campaign-filter
Updates an existing campaign filter using the filter's ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-campaign-filter)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -297,10 +312,10 @@ $CampaignFilterDetails = @"{
try {
$Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails
Update-V2024CampaignFilter -V2024FilterId $FilterId -V2024CampaignFilterDetails $Result
Update-V2024CampaignFilter -FilterId $FilterId -V2024CampaignFilterDetails $Result
# Below is a request that includes all optional parameters
# Update-V2024CampaignFilter -V2024FilterId $FilterId -V2024CampaignFilterDetails $CampaignFilterDetails
# Update-V2024CampaignFilter -FilterId $FilterId -V2024CampaignFilterDetails $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CampaignFilter"
Write-Host $_.ErrorDetails

152
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignsApi.md
View File

@@ -105,6 +105,7 @@ Method | HTTP request | Description
[**Start-V2024GenerateCampaignTemplate**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a Campaign from Template
[**Update-V2024Campaign**](#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/v2024/complete-campaign)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -152,20 +155,23 @@ $CampaignCompleteOptions = @"{
# Complete a Campaign
try {
Complete-V2024Campaign -V2024Id $Id
Complete-V2024Campaign -Id $Id
# Below is a request that includes all optional parameters
# Complete-V2024Campaign -V2024Id $Id -V2024CampaignCompleteOptions $CampaignCompleteOptions
# Complete-V2024Campaign -Id $Id -V2024CampaignCompleteOptions $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024Campaign"
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/v2024/create-campaign)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -304,20 +310,23 @@ $Campaign = @"{
try {
$Result = ConvertFrom-JsonToCampaign -Json $Campaign
New-V2024Campaign -V2024Campaign $Result
New-V2024Campaign -V2024Campaign $Result
# Below is a request that includes all optional parameters
# New-V2024Campaign -V2024Campaign $Campaign
# New-V2024Campaign -V2024Campaign $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Campaign"
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/v2024/create-campaign-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -471,20 +480,23 @@ $CampaignTemplate = @"{
try {
$Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate
New-V2024CampaignTemplate -V2024CampaignTemplate $Result
New-V2024CampaignTemplate -V2024CampaignTemplate $Result
# Below is a request that includes all optional parameters
# New-V2024CampaignTemplate -V2024CampaignTemplate $CampaignTemplate
# New-V2024CampaignTemplate -V2024CampaignTemplate $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CampaignTemplate"
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/v2024/delete-campaign-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -515,20 +527,23 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template
# Delete a Campaign Template
try {
Remove-V2024CampaignTemplate -V2024Id $Id
Remove-V2024CampaignTemplate -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024CampaignTemplate -V2024Id $Id
# Remove-V2024CampaignTemplate -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CampaignTemplate"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/delete-campaign-template-schedule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -559,20 +574,23 @@ $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template
# Delete Campaign Template Schedule
try {
Remove-V2024CampaignTemplateSchedule -V2024Id $Id
Remove-V2024CampaignTemplateSchedule -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024CampaignTemplateSchedule -V2024Id $Id
# Remove-V2024CampaignTemplateSchedule -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CampaignTemplateSchedule"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/delete-campaigns)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -606,20 +624,23 @@ $CampaignsDeleteRequest = @"{
try {
$Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest
Remove-V2024Campaigns -V2024CampaignsDeleteRequest $Result
Remove-V2024Campaigns -V2024CampaignsDeleteRequest $Result
# Below is a request that includes all optional parameters
# Remove-V2024Campaigns -V2024CampaignsDeleteRequest $CampaignsDeleteRequest
# Remove-V2024Campaigns -V2024CampaignsDeleteRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Campaigns"
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/v2024/get-active-campaigns)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -659,20 +680,23 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
# List Campaigns
try {
Get-V2024ActiveCampaigns
Get-V2024ActiveCampaigns
# Below is a request that includes all optional parameters
# Get-V2024ActiveCampaigns -V2024Detail $Detail -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024ActiveCampaigns -Detail $Detail -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ActiveCampaigns"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-campaign)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -705,20 +729,23 @@ $Detail = "SLIM" # String | Determines whether slim, or increased level of detai
# Get Campaign
try {
Get-V2024Campaign -V2024Id $Id
Get-V2024Campaign -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024Campaign -V2024Id $Id -V2024Detail $Detail
# Get-V2024Campaign -Id $Id -Detail $Detail
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Campaign"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-campaign-reports)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -749,20 +776,23 @@ $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose rep
# Get Campaign Reports
try {
Get-V2024CampaignReports -V2024Id $Id
Get-V2024CampaignReports -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024CampaignReports -V2024Id $Id
# Get-V2024CampaignReports -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignReports"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/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-V2024CampaignReportsConfig
Get-V2024CampaignReportsConfig
# Below is a request that includes all optional parameters
# Get-V2024CampaignReportsConfig
@@ -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/v2024/get-campaign-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -834,20 +867,23 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template'
# Get a Campaign Template
try {
Get-V2024CampaignTemplate -V2024Id $Id
Get-V2024CampaignTemplate -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024CampaignTemplate -V2024Id $Id
# Get-V2024CampaignTemplate -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignTemplate"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-campaign-template-schedule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -878,22 +914,25 @@ $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template
# Get Campaign Template Schedule
try {
Get-V2024CampaignTemplateSchedule -V2024Id $Id
Get-V2024CampaignTemplateSchedule -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024CampaignTemplateSchedule -V2024Id $Id
# Get-V2024CampaignTemplateSchedule -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignTemplateSchedule"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-campaign-templates)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -931,20 +970,23 @@ $Filters = 'name eq "manager template"' # String | Filter results using the stan
# List Campaign Templates
try {
Get-V2024CampaignTemplates
Get-V2024CampaignTemplates
# Below is a request that includes all optional parameters
# Get-V2024CampaignTemplates -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters
# Get-V2024CampaignTemplates -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignTemplates"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## move
This API reassigns the specified certifications from one identity to another.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/move)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -985,20 +1027,23 @@ $AdminReviewReassign = @"{
try {
$Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign
Move-V2024 -V2024Id $Id -V2024AdminReviewReassign $Result
Move-V2024 -Id $Id -V2024AdminReviewReassign $Result
# Below is a request that includes all optional parameters
# Move-V2024 -V2024Id $Id -V2024AdminReviewReassign $AdminReviewReassign
# Move-V2024 -Id $Id -V2024AdminReviewReassign $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-V2024"
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/v2024/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-V2024CampaignTemplate -V2024Id $Id -V2024JsonPatchOperation $Result
Update-V2024CampaignTemplate -Id $Id -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024CampaignTemplate -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024CampaignTemplate -Id $Id -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CampaignTemplate"
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/v2024/set-campaign-reports-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1083,20 +1131,23 @@ $CampaignReportsConfig = @"{
try {
$Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig
Set-V2024CampaignReportsConfig -V2024CampaignReportsConfig $Result
Set-V2024CampaignReportsConfig -V2024CampaignReportsConfig $Result
# Below is a request that includes all optional parameters
# Set-V2024CampaignReportsConfig -V2024CampaignReportsConfig $CampaignReportsConfig
# Set-V2024CampaignReportsConfig -V2024CampaignReportsConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024CampaignReportsConfig"
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/v2024/set-campaign-template-schedule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1148,20 +1199,23 @@ $Schedule = @"{
# Set Campaign Template Schedule
try {
Set-V2024CampaignTemplateSchedule -V2024Id $Id
Set-V2024CampaignTemplateSchedule -Id $Id
# Below is a request that includes all optional parameters
# Set-V2024CampaignTemplateSchedule -V2024Id $Id -V2024Schedule $Schedule
# Set-V2024CampaignTemplateSchedule -Id $Id -V2024Schedule $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024CampaignTemplateSchedule"
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/v2024/start-campaign)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1196,20 +1250,23 @@ $ActivateCampaignOptions = @"{
# Activate a Campaign
try {
Start-V2024Campaign -V2024Id $Id
Start-V2024Campaign -Id $Id
# Below is a request that includes all optional parameters
# Start-V2024Campaign -V2024Id $Id -V2024ActivateCampaignOptions $ActivateCampaignOptions
# Start-V2024Campaign -Id $Id -V2024ActivateCampaignOptions $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024Campaign"
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/v2024/start-campaign-remediation-scan)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1240,20 +1297,23 @@ $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remed
# Run Campaign Remediation Scan
try {
Start-V2024CampaignRemediationScan -V2024Id $Id
Start-V2024CampaignRemediationScan -Id $Id
# Below is a request that includes all optional parameters
# Start-V2024CampaignRemediationScan -V2024Id $Id
# Start-V2024CampaignRemediationScan -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024CampaignRemediationScan"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/start-campaign-report)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1286,16 +1346,17 @@ $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run.
# Run Campaign Report
try {
Start-V2024CampaignReport -V2024Id $Id -V2024Type $Type
Start-V2024CampaignReport -Id $Id -Type $Type
# Below is a request that includes all optional parameters
# Start-V2024CampaignReport -V2024Id $Id -V2024Type $Type
# Start-V2024CampaignReport -Id $Id -Type $Type
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024CampaignReport"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/start-generate-campaign-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1339,20 +1402,23 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template
# Generate a Campaign from Template
try {
Start-V2024GenerateCampaignTemplate -V2024Id $Id
Start-V2024GenerateCampaignTemplate -Id $Id
# Below is a request that includes all optional parameters
# Start-V2024GenerateCampaignTemplate -V2024Id $Id
# Start-V2024GenerateCampaignTemplate -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024GenerateCampaignTemplate"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/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-V2024Campaign -V2024Id $Id -V2024JsonPatchOperation $Result
Update-V2024Campaign -Id $Id -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024Campaign -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024Campaign -Id $Id -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Campaign"
Write-Host $_.ErrorDetails

28
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationSummariesApi.md
View File

@@ -36,9 +36,12 @@ Method | HTTP request | Description
[**Get-V2024IdentitySummaries**](#get-identity-summaries) | **GET** `/certifications/{id}/identity-summaries` | Identity Summaries for Campaign Certification
[**Get-V2024IdentitySummary**](#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/v2024/get-identity-access-summaries)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -81,19 +84,22 @@ $Sorters = "access.name" # String | Sort results using the standard syntax descr
# Access Summaries
try {
Get-V2024IdentityAccessSummaries -V2024Id $Id -V2024Type $Type
Get-V2024IdentityAccessSummaries -Id $Id -Type $Type
# Below is a request that includes all optional parameters
# Get-V2024IdentityAccessSummaries -V2024Id $Id -V2024Type $Type -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessSummaries"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-identity-decision-summary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -126,19 +132,22 @@ $Filters = 'identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"' # String |
# Summary of Certification Decisions
try {
Get-V2024IdentityDecisionSummary -V2024Id $Id
Get-V2024IdentityDecisionSummary -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024IdentityDecisionSummary -V2024Id $Id -V2024Filters $Filters
# Get-V2024IdentityDecisionSummary -Id $Id -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityDecisionSummary"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-identity-summaries)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -179,19 +188,22 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
# Identity Summaries for Campaign Certification
try {
Get-V2024IdentitySummaries -V2024Id $Id
Get-V2024IdentitySummaries -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024IdentitySummaries -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummaries"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-identity-summary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -224,10 +236,10 @@ $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity
# Summary for Identity
try {
Get-V2024IdentitySummary -V2024Id $Id -V2024IdentitySummaryId $IdentitySummaryId
Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId
# Below is a request that includes all optional parameters
# Get-V2024IdentitySummary -V2024Id $Id -V2024IdentitySummaryId $IdentitySummaryId
# Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummary"
Write-Host $_.ErrorDetails

77
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationsApi.md
View File

@@ -52,9 +52,12 @@ Method | HTTP request | Description
[**Invoke-V2024SignOffIdentityCertification**](#sign-off-identity-certification) | **POST** `/certifications/{id}/sign-off` | Finalize Identity Certification Decisions
[**Submit-V2024ReassignCertsAsync**](#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/v2024/get-certification-task)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -85,19 +88,22 @@ $Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID
# Certification Task by ID
try {
Get-V2024CertificationTask -V2024Id $Id
Get-V2024CertificationTask -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024CertificationTask -V2024Id $Id
# Get-V2024CertificationTask -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CertificationTask"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-identity-certification)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -128,19 +134,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id
# Identity Certification by ID
try {
Get-V2024IdentityCertification -V2024Id $Id
Get-V2024IdentityCertification -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024IdentityCertification -V2024Id $Id
# Get-V2024IdentityCertification -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityCertification"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-identity-certification-item-permissions)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -181,19 +190,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Permissions for Entitlement Certification Item
try {
Get-V2024IdentityCertificationItemPermissions -V2024CertificationId $CertificationId -V2024ItemId $ItemId
Get-V2024IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId
# Below is a request that includes all optional parameters
# Get-V2024IdentityCertificationItemPermissions -V2024CertificationId $CertificationId -V2024ItemId $ItemId -V2024Filters $Filters -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count
# Get-V2024IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityCertificationItemPermissions"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-pending-certification-tasks)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -232,19 +244,22 @@ $Filters = 'type eq "ADMIN_REASSIGN"' # String | Filter results using the standa
# List of Pending Certification Tasks
try {
Get-V2024PendingCertificationTasks
Get-V2024PendingCertificationTasks
# Below is a request that includes all optional parameters
# Get-V2024PendingCertificationTasks -V2024ReviewerIdentity $ReviewerIdentity -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters
# Get-V2024PendingCertificationTasks -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingCertificationTasks"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/list-certification-reviewers)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -285,19 +300,22 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
# List of Reviewers for certification
try {
Get-V2024CertificationReviewers -V2024Id $Id
Get-V2024CertificationReviewers -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024CertificationReviewers -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024CertificationReviewers -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CertificationReviewers"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/list-identity-access-review-items)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -344,19 +362,22 @@ $Roles = "userRole" # String | Filter results to view access review items that p
# List of Access Review Items
try {
Get-V2024IdentityAccessReviewItems -V2024Id $Id
Get-V2024IdentityAccessReviewItems -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024IdentityAccessReviewItems -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters -V2024Entitlements $Entitlements -V2024AccessProfiles $AccessProfiles -V2024Roles $Roles
# Get-V2024IdentityAccessReviewItems -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -Entitlements $Entitlements -AccessProfiles $AccessProfiles -Roles $Roles
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessReviewItems"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/list-identity-certifications)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -396,19 +417,22 @@ $Sorters = "name,due" # String | Sort results using the standard syntax describe
# List Identity Campaign Certifications
try {
Get-V2024IdentityCertifications
Get-V2024IdentityCertifications
# Below is a request that includes all optional parameters
# Get-V2024IdentityCertifications -V2024ReviewerIdentity $ReviewerIdentity -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024IdentityCertifications -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityCertifications"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/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-V2024IdentityDecision -V2024Id $Id -V2024ReviewDecision $Result
Select-V2024IdentityDecision -Id $Id -V2024ReviewDecision $Result
# Below is a request that includes all optional parameters
# Select-V2024IdentityDecision -V2024Id $Id -V2024ReviewDecision $ReviewDecision
# Select-V2024IdentityDecision -Id $Id -V2024ReviewDecision $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Select-V2024IdentityDecision"
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/v2024/reassign-identity-certifications)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -510,19 +537,22 @@ $ReviewReassign = @"{
try {
$Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign
Invoke-V2024ReassignIdentityCertifications -V2024Id $Id -V2024ReviewReassign $Result
Invoke-V2024ReassignIdentityCertifications -Id $Id -V2024ReviewReassign $Result
# Below is a request that includes all optional parameters
# Invoke-V2024ReassignIdentityCertifications -V2024Id $Id -V2024ReviewReassign $ReviewReassign
# Invoke-V2024ReassignIdentityCertifications -Id $Id -V2024ReviewReassign $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ReassignIdentityCertifications"
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/v2024/sign-off-identity-certification)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -553,16 +583,17 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certif
# Finalize Identity Certification Decisions
try {
Invoke-V2024SignOffIdentityCertification -V2024Id $Id
Invoke-V2024SignOffIdentityCertification -Id $Id
# Below is a request that includes all optional parameters
# Invoke-V2024SignOffIdentityCertification -V2024Id $Id
# Invoke-V2024SignOffIdentityCertification -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024SignOffIdentityCertification"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/submit-reassign-certs-async)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -614,10 +647,10 @@ $ReviewReassign = @"{
try {
$Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign
Submit-V2024ReassignCertsAsync -V2024Id $Id -V2024ReviewReassign $Result
Submit-V2024ReassignCertsAsync -Id $Id -V2024ReviewReassign $Result
# Below is a request that includes all optional parameters
# Submit-V2024ReassignCertsAsync -V2024Id $Id -V2024ReviewReassign $ReviewReassign
# Submit-V2024ReassignCertsAsync -Id $Id -V2024ReviewReassign $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024ReassignCertsAsync"
Write-Host $_.ErrorDetails

110
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConfigurationHubApi.md
View File

@@ -45,9 +45,12 @@ Method | HTTP request | Description
[**Get-V2024UploadedConfigurations**](#list-uploaded-configurations) | **GET** `/configuration-hub/backups/uploads` | List Uploaded Configurations
[**Update-V2024ObjectMappings**](#update-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-patch` | Bulk updates object mappings
## create-deploy
This API performs a deploy based on an existing daft.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-deploy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -80,22 +83,25 @@ $DeployRequest = @"{
try {
$Result = ConvertFrom-JsonToDeployRequest -Json $DeployRequest
New-V2024Deploy -V2024DeployRequest $Result
New-V2024Deploy -V2024DeployRequest $Result
# Below is a request that includes all optional parameters
# New-V2024Deploy -V2024DeployRequest $DeployRequest
# New-V2024Deploy -V2024DeployRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Deploy"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## 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/v2024/create-object-mapping)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -135,22 +141,25 @@ $ObjectMappingRequest = @"{
try {
$Result = ConvertFrom-JsonToObjectMappingRequest -Json $ObjectMappingRequest
New-V2024ObjectMapping -V2024SourceOrg $SourceOrg -V2024ObjectMappingRequest $Result
New-V2024ObjectMapping -SourceOrg $SourceOrg -V2024ObjectMappingRequest $Result
# Below is a request that includes all optional parameters
# New-V2024ObjectMapping -V2024SourceOrg $SourceOrg -V2024ObjectMappingRequest $ObjectMappingRequest
# New-V2024ObjectMapping -SourceOrg $SourceOrg -V2024ObjectMappingRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMapping"
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/v2024/create-object-mappings)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -198,16 +207,17 @@ $ObjectMappingBulkCreateRequest = @"{
try {
$Result = ConvertFrom-JsonToObjectMappingBulkCreateRequest -Json $ObjectMappingBulkCreateRequest
New-V2024ObjectMappings -V2024SourceOrg $SourceOrg -V2024ObjectMappingBulkCreateRequest $Result
New-V2024ObjectMappings -SourceOrg $SourceOrg -V2024ObjectMappingBulkCreateRequest $Result
# Below is a request that includes all optional parameters
# New-V2024ObjectMappings -V2024SourceOrg $SourceOrg -V2024ObjectMappingBulkCreateRequest $ObjectMappingBulkCreateRequest
# New-V2024ObjectMappings -SourceOrg $SourceOrg -V2024ObjectMappingBulkCreateRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMappings"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-uploaded-configuration
This API uploads a JSON configuration file into a tenant.
@@ -215,6 +225,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/v2024/create-uploaded-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -246,16 +258,17 @@ $Name = "MyName" # String | Name that will be assigned to the uploaded configura
# Upload a Configuration
try {
New-V2024UploadedConfiguration -V2024Data $Data -V2024Name $Name
New-V2024UploadedConfiguration -Data $Data -Name $Name
# Below is a request that includes all optional parameters
# New-V2024UploadedConfiguration -V2024Data $Data -V2024Name $Name
# New-V2024UploadedConfiguration -Data $Data -Name $Name
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024UploadedConfiguration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-backup
This API deletes an existing backup for the current tenant.
@@ -263,6 +276,8 @@ On success, this endpoint will return an empty response.
The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-backup)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -293,16 +308,17 @@ $Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the backup to
# Delete a Backup
try {
Remove-V2024Backup -V2024Id $Id
Remove-V2024Backup -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024Backup -V2024Id $Id
# Remove-V2024Backup -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Backup"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-draft
This API deletes an existing draft for the current tenant.
@@ -310,6 +326,8 @@ On success, this endpoint will return an empty response.
The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-draft)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -340,22 +358,25 @@ $Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the draft to d
# Delete a draft
try {
Remove-V2024Draft -V2024Id $Id
Remove-V2024Draft -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024Draft -V2024Id $Id
# Remove-V2024Draft -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Draft"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/delete-object-mapping)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -388,16 +409,17 @@ $ObjectMappingId = "3d6e0144-963f-4bd6-8d8d-d77b4e507ce4" # String | The id of t
# Deletes an object mapping
try {
Remove-V2024ObjectMapping -V2024SourceOrg $SourceOrg -V2024ObjectMappingId $ObjectMappingId
Remove-V2024ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId
# Below is a request that includes all optional parameters
# Remove-V2024ObjectMapping -V2024SourceOrg $SourceOrg -V2024ObjectMappingId $ObjectMappingId
# Remove-V2024ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ObjectMapping"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-uploaded-configuration
This API deletes an uploaded configuration based on Id.
@@ -405,6 +427,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/v2024/delete-uploaded-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -435,19 +459,22 @@ $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded c
# Delete an Uploaded Configuration
try {
Remove-V2024UploadedConfiguration -V2024Id $Id
Remove-V2024UploadedConfiguration -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024UploadedConfiguration -V2024Id $Id
# Remove-V2024UploadedConfiguration -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024UploadedConfiguration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-deploy
This API gets an existing deploy for the current tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-deploy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -478,22 +505,25 @@ $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the deploy.
# Get a Deploy
try {
Get-V2024Deploy -V2024Id $Id
Get-V2024Deploy -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024Deploy -V2024Id $Id
# Get-V2024Deploy -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Deploy"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-object-mappings)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -524,19 +554,22 @@ $SourceOrg = "source-org" # String | The name of the source org.
# Gets list of object mappings
try {
Get-V2024ObjectMappings -V2024SourceOrg $SourceOrg
Get-V2024ObjectMappings -SourceOrg $SourceOrg
# Below is a request that includes all optional parameters
# Get-V2024ObjectMappings -V2024SourceOrg $SourceOrg
# Get-V2024ObjectMappings -SourceOrg $SourceOrg
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ObjectMappings"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-uploaded-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -567,19 +600,22 @@ $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded c
# Get an Uploaded Configuration
try {
Get-V2024UploadedConfiguration -V2024Id $Id
Get-V2024UploadedConfiguration -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024UploadedConfiguration -V2024Id $Id
# Get-V2024UploadedConfiguration -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UploadedConfiguration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-backups
This API gets a list of existing backups for the current tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-backups)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -609,19 +645,22 @@ $Filters = 'status eq "COMPLETE"' # String | Filter results using the standard s
# List Backups
try {
Get-V2024Backups
Get-V2024Backups
# Below is a request that includes all optional parameters
# Get-V2024Backups -V2024Filters $Filters
# Get-V2024Backups -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Backups"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-deploys
This API gets a list of deploys for the current tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-deploys)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -649,7 +688,7 @@ Code | Description | Data Type
# List Deploys
try {
Get-V2024Deploys
Get-V2024Deploys
# Below is a request that includes all optional parameters
# Get-V2024Deploys
@@ -659,9 +698,12 @@ try {
}
```
[[Back to top]](#)
## list-drafts
This API gets a list of existing drafts for the current tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-drafts)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -691,19 +733,22 @@ $Filters = 'status eq "COMPLETE"' # String | Filter results using the standard s
# List Drafts
try {
Get-V2024Drafts
Get-V2024Drafts
# Below is a request that includes all optional parameters
# Get-V2024Drafts -V2024Filters $Filters
# Get-V2024Drafts -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Drafts"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/list-uploaded-configurations)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -734,22 +779,25 @@ $Filters = 'status eq "COMPLETE"' # String | Filter results using the standard s
# List Uploaded Configurations
try {
Get-V2024UploadedConfigurations
Get-V2024UploadedConfigurations
# Below is a request that includes all optional parameters
# Get-V2024UploadedConfigurations -V2024Filters $Filters
# Get-V2024UploadedConfigurations -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UploadedConfigurations"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/update-object-mappings)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -796,10 +844,10 @@ $ObjectMappingBulkPatchRequest = @"{
try {
$Result = ConvertFrom-JsonToObjectMappingBulkPatchRequest -Json $ObjectMappingBulkPatchRequest
Update-V2024ObjectMappings -V2024SourceOrg $SourceOrg -V2024ObjectMappingBulkPatchRequest $Result
Update-V2024ObjectMappings -SourceOrg $SourceOrg -V2024ObjectMappingBulkPatchRequest $Result
# Below is a request that includes all optional parameters
# Update-V2024ObjectMappings -V2024SourceOrg $SourceOrg -V2024ObjectMappingBulkPatchRequest $ObjectMappingBulkPatchRequest
# Update-V2024ObjectMappings -SourceOrg $SourceOrg -V2024ObjectMappingBulkPatchRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ObjectMappings"
Write-Host $_.ErrorDetails

60
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorRuleManagementApi.md
View File

@@ -31,9 +31,15 @@ Method | HTTP request | Description
[**Send-V2024ConnectorRule**](#put-connector-rule) | **PUT** `/connector-rules/{id}` | Update Connector Rule
[**Test-V2024ConnectorRule**](#test-connector-rule) | **POST** `/connector-rules/validate` | Validate Connector Rule
## create-connector-rule
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Create a connector rule from the available types.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-connector-rule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -91,19 +97,25 @@ $ConnectorRuleCreateRequest = @"{
try {
$Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest
New-V2024ConnectorRule -V2024XSailPointExperimental $XSailPointExperimental -V2024ConnectorRuleCreateRequest $Result
New-V2024ConnectorRule -XSailPointExperimental $XSailPointExperimental -V2024ConnectorRuleCreateRequest $Result
# Below is a request that includes all optional parameters
# New-V2024ConnectorRule -V2024XSailPointExperimental $XSailPointExperimental -V2024ConnectorRuleCreateRequest $ConnectorRuleCreateRequest
# New-V2024ConnectorRule -XSailPointExperimental $XSailPointExperimental -V2024ConnectorRuleCreateRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ConnectorRule"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-connector-rule
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Delete the connector rule for the given ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-connector-rule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -136,19 +148,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Delete Connector Rule
try {
Remove-V2024ConnectorRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Remove-V2024ConnectorRule -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024ConnectorRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Remove-V2024ConnectorRule -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ConnectorRule"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-connector-rule
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Get a connector rule by ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-rule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -181,19 +199,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get Connector Rule
try {
Get-V2024ConnectorRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024ConnectorRule -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024ConnectorRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024ConnectorRule -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorRule"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-connector-rule-list
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
List existing connector rules.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-rule-list)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -229,19 +253,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# List Connector Rules
try {
Get-V2024ConnectorRuleList -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024ConnectorRuleList -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024ConnectorRuleList -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count
# Get-V2024ConnectorRuleList -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorRuleList"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-connector-rule
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type`
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-rule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -302,19 +332,25 @@ $ConnectorRuleUpdateRequest = @"{
# Update Connector Rule
try {
Send-V2024ConnectorRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Send-V2024ConnectorRule -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Send-V2024ConnectorRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024ConnectorRuleUpdateRequest $ConnectorRuleUpdateRequest
# Send-V2024ConnectorRule -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024ConnectorRuleUpdateRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorRule"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## test-connector-rule
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Detect issues within the connector rule's code to fix and list them.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/test-connector-rule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -350,10 +386,10 @@ $SourceCode = @"{
try {
$Result = ConvertFrom-JsonToSourceCode -Json $SourceCode
Test-V2024ConnectorRule -V2024XSailPointExperimental $XSailPointExperimental -V2024SourceCode $Result
Test-V2024ConnectorRule -XSailPointExperimental $XSailPointExperimental -V2024SourceCode $Result
# Below is a request that includes all optional parameters
# Test-V2024ConnectorRule -V2024XSailPointExperimental $XSailPointExperimental -V2024SourceCode $SourceCode
# Test-V2024ConnectorRule -XSailPointExperimental $XSailPointExperimental -V2024SourceCode $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ConnectorRule"
Write-Host $_.ErrorDetails

91
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorsApi.md
View File

@@ -45,9 +45,12 @@ Method | HTTP request | Description
[**Send-V2024ConnectorTranslations**](#put-connector-translations) | **PUT** `/connectors/{scriptName}/translations/{locale}` | Update Connector Translations
[**Update-V2024Connector**](#update-connector) | **PATCH** `/connectors/{scriptName}` | Update Connector by Script Name
## create-custom-connector
Create custom connector.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-custom-connector)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -85,19 +88,22 @@ $V3CreateConnectorDto = @"{
try {
$Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto
New-V2024CustomConnector -V2024V3CreateConnectorDto $Result
New-V2024CustomConnector -V2024V3CreateConnectorDto $Result
# Below is a request that includes all optional parameters
# New-V2024CustomConnector -V2024V3CreateConnectorDto $V3CreateConnectorDto
# New-V2024CustomConnector -V2024V3CreateConnectorDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CustomConnector"
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/v2024/delete-custom-connector)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -128,19 +134,22 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Sc
# Delete Connector by Script Name
try {
Remove-V2024CustomConnector -V2024ScriptName $ScriptName
Remove-V2024CustomConnector -ScriptName $ScriptName
# Below is a request that includes all optional parameters
# Remove-V2024CustomConnector -V2024ScriptName $ScriptName
# Remove-V2024CustomConnector -ScriptName $ScriptName
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CustomConnector"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-connector
Fetches a connector that using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -173,19 +182,22 @@ $Locale = "de" # String | The locale to apply to the config. If no viable locale
# Get Connector by Script Name
try {
Get-V2024Connector -V2024ScriptName $ScriptName
Get-V2024Connector -ScriptName $ScriptName
# Below is a request that includes all optional parameters
# Get-V2024Connector -V2024ScriptName $ScriptName -V2024Locale $Locale
# Get-V2024Connector -ScriptName $ScriptName -Locale $Locale
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Connector"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-connector-correlation-config
Fetches a connector's correlation config using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-correlation-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -216,19 +228,22 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Sc
# Get Connector Correlation Configuration
try {
Get-V2024ConnectorCorrelationConfig -V2024ScriptName $ScriptName
Get-V2024ConnectorCorrelationConfig -ScriptName $ScriptName
# Below is a request that includes all optional parameters
# Get-V2024ConnectorCorrelationConfig -V2024ScriptName $ScriptName
# Get-V2024ConnectorCorrelationConfig -ScriptName $ScriptName
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorCorrelationConfig"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-connector-list)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -267,19 +282,22 @@ $Locale = "de" # String | The locale to apply to the config. If no viable locale
# Get Connector List
try {
Get-V2024ConnectorList
Get-V2024ConnectorList
# Below is a request that includes all optional parameters
# Get-V2024ConnectorList -V2024Filters $Filters -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Locale $Locale
# Get-V2024ConnectorList -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count -Locale $Locale
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorList"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-connector-source-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -310,19 +328,22 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Sc
# Get Connector Source Configuration
try {
Get-V2024ConnectorSourceConfig -V2024ScriptName $ScriptName
Get-V2024ConnectorSourceConfig -ScriptName $ScriptName
# Below is a request that includes all optional parameters
# Get-V2024ConnectorSourceConfig -V2024ScriptName $ScriptName
# Get-V2024ConnectorSourceConfig -ScriptName $ScriptName
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorSourceConfig"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-connector-source-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -353,19 +374,22 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Sc
# Get Connector Source Template
try {
Get-V2024ConnectorSourceTemplate -V2024ScriptName $ScriptName
Get-V2024ConnectorSourceTemplate -ScriptName $ScriptName
# Below is a request that includes all optional parameters
# Get-V2024ConnectorSourceTemplate -V2024ScriptName $ScriptName
# Get-V2024ConnectorSourceTemplate -ScriptName $ScriptName
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorSourceTemplate"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-connector-translations
Fetches a connector's translations using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-translations)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -398,19 +422,22 @@ $Locale = "de" # String | The locale to apply to the config. If no viable locale
# Get Connector Translations
try {
Get-V2024ConnectorTranslations -V2024ScriptName $ScriptName -V2024Locale $Locale
Get-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale
# Below is a request that includes all optional parameters
# Get-V2024ConnectorTranslations -V2024ScriptName $ScriptName -V2024Locale $Locale
# Get-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorTranslations"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-connector-correlation-config
Update a connector's correlation config using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-correlation-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -443,19 +470,22 @@ $File = # System.IO.FileInfo | connector correlation config xml file
# Update Connector Correlation Configuration
try {
Send-V2024ConnectorCorrelationConfig -V2024ScriptName $ScriptName -V2024File $File
Send-V2024ConnectorCorrelationConfig -ScriptName $ScriptName -File $File
# Below is a request that includes all optional parameters
# Send-V2024ConnectorCorrelationConfig -V2024ScriptName $ScriptName -V2024File $File
# Send-V2024ConnectorCorrelationConfig -ScriptName $ScriptName -File $File
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorCorrelationConfig"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/put-connector-source-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -488,19 +518,22 @@ $File = # System.IO.FileInfo | connector source config xml file
# Update Connector Source Configuration
try {
Send-V2024ConnectorSourceConfig -V2024ScriptName $ScriptName -V2024File $File
Send-V2024ConnectorSourceConfig -ScriptName $ScriptName -File $File
# Below is a request that includes all optional parameters
# Send-V2024ConnectorSourceConfig -V2024ScriptName $ScriptName -V2024File $File
# Send-V2024ConnectorSourceConfig -ScriptName $ScriptName -File $File
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorSourceConfig"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/put-connector-source-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -533,19 +566,22 @@ $File = # System.IO.FileInfo | connector source template xml file
# Update Connector Source Template
try {
Send-V2024ConnectorSourceTemplate -V2024ScriptName $ScriptName -V2024File $File
Send-V2024ConnectorSourceTemplate -ScriptName $ScriptName -File $File
# Below is a request that includes all optional parameters
# Send-V2024ConnectorSourceTemplate -V2024ScriptName $ScriptName -V2024File $File
# Send-V2024ConnectorSourceTemplate -ScriptName $ScriptName -File $File
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorSourceTemplate"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-connector-translations
Update a connector's translations using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-translations)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -578,16 +614,17 @@ $Locale = "de" # String | The locale to apply to the config. If no viable locale
# Update Connector Translations
try {
Send-V2024ConnectorTranslations -V2024ScriptName $ScriptName -V2024Locale $Locale
Send-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale
# Below is a request that includes all optional parameters
# Send-V2024ConnectorTranslations -V2024ScriptName $ScriptName -V2024Locale $Locale
# Send-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorTranslations"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-connector
This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
@@ -603,6 +640,8 @@ The following fields are patchable:
* sourceConfigXml
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-connector)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -641,10 +680,10 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Sc
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024Connector -V2024ScriptName $ScriptName -V2024JsonPatchOperation $Result
Update-V2024Connector -ScriptName $ScriptName -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024Connector -V2024ScriptName $ScriptName -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024Connector -ScriptName $ScriptName -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Connector"
Write-Host $_.ErrorDetails

194
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CustomFormsApi.md
View File

@@ -44,8 +44,14 @@ Method | HTTP request | Description
[**Search-V2024PreDefinedSelectOptions**](#search-pre-defined-select-options) | **GET** `/form-definitions/predefined-select-options` | List predefined select options.
[**Show-V2024PreviewDataSource**](#show-preview-data-source) | **POST** `/form-definitions/{formDefinitionID}/data-source` | Preview form definition data source.
## create-form-definition
## create-form-definition
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-form-definition)
### Parameters
Param Type | Name | Data Type | Required | Description
@@ -188,18 +194,24 @@ $Body = @"{
# Creates a form definition.
try {
New-V2024FormDefinition -V2024XSailPointExperimental $XSailPointExperimental
New-V2024FormDefinition -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# New-V2024FormDefinition -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body
# New-V2024FormDefinition -XSailPointExperimental $XSailPointExperimental -V2024Body $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinition"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-form-definition-dynamic-schema
## create-form-definition-dynamic-schema
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-form-definition-dynamic-schema)
### Parameters
Param Type | Name | Data Type | Required | Description
@@ -241,19 +253,25 @@ $Body = @"{
# Generate JSON Schema dynamically.
try {
New-V2024FormDefinitionDynamicSchema -V2024XSailPointExperimental $XSailPointExperimental
New-V2024FormDefinitionDynamicSchema -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# New-V2024FormDefinitionDynamicSchema -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body
# New-V2024FormDefinitionDynamicSchema -XSailPointExperimental $XSailPointExperimental -V2024Body $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionDynamicSchema"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-form-definition-file-request
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Parameter `{formDefinitionID}` should match a form definition ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-form-definition-file-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -291,18 +309,24 @@ $File = # System.IO.FileInfo | File specifying the multipart
# Upload new form definition file.
try {
New-V2024FormDefinitionFileRequest -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental -V2024File $File
New-V2024FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -File $File
# Below is a request that includes all optional parameters
# New-V2024FormDefinitionFileRequest -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental -V2024File $File
# New-V2024FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -File $File
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionFileRequest"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-form-instance
## create-form-instance
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-form-instance)
### Parameters
Param Type | Name | Data Type | Required | Description
@@ -355,19 +379,25 @@ $Body = @"{
# Creates a form instance.
try {
New-V2024FormInstance -V2024XSailPointExperimental $XSailPointExperimental
New-V2024FormInstance -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# New-V2024FormInstance -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body
# New-V2024FormInstance -XSailPointExperimental $XSailPointExperimental -V2024Body $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormInstance"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-form-definition
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Parameter `{formDefinitionID}` should match a form definition ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-form-definition)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -400,19 +430,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Deletes a form definition.
try {
Remove-V2024FormDefinition -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental
Remove-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024FormDefinition -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental
# Remove-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024FormDefinition"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## export-form-definitions-by-tenant
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
No parameters required.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-form-definitions-by-tenant)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -450,18 +486,24 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
# List form definitions by tenant.
try {
Export-V2024FormDefinitionsByTenant -V2024XSailPointExperimental $XSailPointExperimental
Export-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Export-V2024FormDefinitionsByTenant -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Filters $Filters -V2024Sorters $Sorters
# Export-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024FormDefinitionsByTenant"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-file-from-s3
## get-file-from-s3
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-file-from-s3)
### Parameters
Param Type | Name | Data Type | Required | Description
@@ -498,19 +540,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Download definition file by fileId.
try {
Get-V2024FileFromS3 -V2024FormDefinitionID $FormDefinitionID -V2024FileID $FileID -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024FileFromS3 -V2024FormDefinitionID $FormDefinitionID -V2024FileID $FileID -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FileFromS3"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-form-definition-by-key
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Parameter `{formDefinitionID}` should match a form definition ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-form-definition-by-key)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -543,19 +591,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Return a form definition.
try {
Get-V2024FormDefinitionByKey -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024FormDefinitionByKey -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024FormDefinitionByKey -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024FormDefinitionByKey -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormDefinitionByKey"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-form-instance-by-key
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Parameter `{formInstanceID}` should match a form instance ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-form-instance-by-key)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -588,18 +642,24 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Returns a form instance.
try {
Get-V2024FormInstanceByKey -V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024FormInstanceByKey -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024FormInstanceByKey -V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024FormInstanceByKey -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceByKey"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-form-instance-file
## get-form-instance-file
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-form-instance-file)
### Parameters
Param Type | Name | Data Type | Required | Description
@@ -636,18 +696,24 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Download instance file by fileId.
try {
Get-V2024FormInstanceFile -V2024FormInstanceID $FormInstanceID -V2024FileID $FileID -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024FormInstanceFile -V2024FormInstanceID $FormInstanceID -V2024FileID $FileID -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceFile"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## import-form-definitions
## import-form-definitions
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-form-definitions)
### Parameters
Param Type | Name | Data Type | Required | Description
@@ -687,19 +753,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Import form definitions from export.
try {
Import-V2024FormDefinitions -V2024XSailPointExperimental $XSailPointExperimental
Import-V2024FormDefinitions -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Import-V2024FormDefinitions -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body
# Import-V2024FormDefinitions -XSailPointExperimental $XSailPointExperimental -V2024Body $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024FormDefinitions"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-form-definition
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Parameter `{formDefinitionID}` should match a form definition ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-form-definition)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -736,19 +808,25 @@ $Body = @{ key_example = } # Map[] | Body is the request payload to patch a for
# Patch a form definition.
try {
Update-V2024FormDefinition -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental
Update-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Update-V2024FormDefinition -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body
# Update-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -Body $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormDefinition"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-form-instance
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Parameter `{formInstanceID}` should match a form instance ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-form-instance)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -786,19 +864,25 @@ $Body = @{ key_example = } # Map[] | Body is the request payload to patch a for
# Patch a form instance.
try {
Update-V2024FormInstance -V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental
Update-V2024FormInstance -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Update-V2024FormInstance -V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body
# Update-V2024FormInstance -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental -Body $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormInstance"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## search-form-definitions-by-tenant
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
No parameters required.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-form-definitions-by-tenant)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -836,20 +920,26 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
# Export form definitions by tenant.
try {
Search-V2024FormDefinitionsByTenant -V2024XSailPointExperimental $XSailPointExperimental
Search-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Search-V2024FormDefinitionsByTenant -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Filters $Filters -V2024Sorters $Sorters
# Search-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormDefinitionsByTenant"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## search-form-element-data-by-element-id
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Parameter `{formInstanceID}` should match a form instance ID.
Parameter `{formElementID}` should match a form element ID at the data source configuration.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-form-element-data-by-element-id)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -890,19 +980,25 @@ $Query = "support" # String | String that is passed to the underlying API to fil
# Retrieves dynamic data by element.
try {
Search-V2024FormElementDataByElementID -V2024FormInstanceID $FormInstanceID -V2024FormElementID $FormElementID -V2024XSailPointExperimental $XSailPointExperimental
Search-V2024FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Search-V2024FormElementDataByElementID -V2024FormInstanceID $FormInstanceID -V2024FormElementID $FormElementID -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Filters $Filters -V2024Query $Query
# Search-V2024FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Filters $Filters -Query $Query
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormElementDataByElementID"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## search-form-instances-by-tenant
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
No parameters required.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-form-instances-by-tenant)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -932,19 +1028,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# List form instances by tenant.
try {
Search-V2024FormInstancesByTenant -V2024XSailPointExperimental $XSailPointExperimental
Search-V2024FormInstancesByTenant -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Search-V2024FormInstancesByTenant -V2024XSailPointExperimental $XSailPointExperimental
# Search-V2024FormInstancesByTenant -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormInstancesByTenant"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## search-pre-defined-select-options
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
No parameters required.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-pre-defined-select-options)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -974,18 +1076,24 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# List predefined select options.
try {
Search-V2024PreDefinedSelectOptions -V2024XSailPointExperimental $XSailPointExperimental
Search-V2024PreDefinedSelectOptions -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Search-V2024PreDefinedSelectOptions -V2024XSailPointExperimental $XSailPointExperimental
# Search-V2024PreDefinedSelectOptions -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024PreDefinedSelectOptions"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## show-preview-data-source
## show-preview-data-source
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
[API Spec](https://developer.sailpoint.com/docs/api/v2024/show-preview-data-source)
### Parameters
Param Type | Name | Data Type | Required | Description
@@ -1037,10 +1145,10 @@ $FormElementPreviewRequest = @"{
# Preview form definition data source.
try {
Show-V2024PreviewDataSource -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental
Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Show-V2024PreviewDataSource -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Filters $Filters -V2024Query $Query -V2024FormElementPreviewRequest $FormElementPreviewRequest
# Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Filters $Filters -Query $Query -V2024FormElementPreviewRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2024PreviewDataSource"
Write-Host $_.ErrorDetails

30
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CustomPasswordInstructionsApi.md
View File

@@ -32,9 +32,15 @@ Method | HTTP request | Description
[**Remove-V2024CustomPasswordInstructions**](#delete-custom-password-instructions) | **DELETE** `/custom-password-instructions/{pageId}` | Delete Custom Password Instructions by page ID
[**Get-V2024CustomPasswordInstructions**](#get-custom-password-instructions) | **GET** `/custom-password-instructions/{pageId}` | Get Custom Password Instructions by Page ID
## create-custom-password-instructions
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API creates the custom password instructions for the specified page ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-custom-password-instructions)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -69,19 +75,25 @@ $CustomPasswordInstruction = @"{
try {
$Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction
New-V2024CustomPasswordInstructions -V2024XSailPointExperimental $XSailPointExperimental -V2024CustomPasswordInstruction $Result
New-V2024CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -V2024CustomPasswordInstruction $Result
# Below is a request that includes all optional parameters
# New-V2024CustomPasswordInstructions -V2024XSailPointExperimental $XSailPointExperimental -V2024CustomPasswordInstruction $CustomPasswordInstruction
# New-V2024CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -V2024CustomPasswordInstruction $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CustomPasswordInstructions"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-custom-password-instructions
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API delete the custom password instructions for the specified page ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-custom-password-instructions)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -114,19 +126,25 @@ $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47
# Delete Custom Password Instructions by page ID
try {
Remove-V2024CustomPasswordInstructions -V2024PageId $PageId -V2024XSailPointExperimental $XSailPointExperimental
Remove-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024CustomPasswordInstructions -V2024PageId $PageId -V2024XSailPointExperimental $XSailPointExperimental -V2024Locale $Locale
# Remove-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental -Locale $Locale
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CustomPasswordInstructions"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-custom-password-instructions
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns the custom password instructions for the specified page ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-custom-password-instructions)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -159,10 +177,10 @@ $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47
# Get Custom Password Instructions by Page ID
try {
Get-V2024CustomPasswordInstructions -V2024PageId $PageId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024CustomPasswordInstructions -V2024PageId $PageId -V2024XSailPointExperimental $XSailPointExperimental -V2024Locale $Locale
# Get-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental -Locale $Locale
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomPasswordInstructions"
Write-Host $_.ErrorDetails

77
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024DataSegmentationApi.md
View File

@@ -28,10 +28,13 @@ Method | HTTP request | Description
[**Update-V2024DataSegment**](#patch-data-segment) | **PATCH** `/data-segments/{segmentId}` | Update Segment
[**Publish-V2024DataSegment**](#publish-data-segment) | **POST** `/data-segments/{segmentId}` | Publish segment by ID
## create-data-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/v2024/create-data-segment)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -62,19 +65,25 @@ $DataSegment = @""@
try {
$Result = ConvertFrom-JsonToDataSegment -Json $DataSegment
New-V2024DataSegment -V2024DataSegment $Result
New-V2024DataSegment -V2024DataSegment $Result
# Below is a request that includes all optional parameters
# New-V2024DataSegment -V2024DataSegment $DataSegment
# New-V2024DataSegment -V2024DataSegment $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DataSegment"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-data-segment
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API deletes the segment specified by the given ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-data-segment)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -109,19 +118,25 @@ $Published = $false # Boolean | This determines which version of the segment to
# Delete Segment by ID
try {
Remove-V2024DataSegment -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Remove-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024DataSegment -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Published $Published
# Remove-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -Published $Published
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024DataSegment"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-data-segment
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns the segment specified by the given ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-data-segment)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -154,19 +169,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get Segment by ID
try {
Get-V2024DataSegment -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024DataSegment -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegment"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-data-segment-identity-membership
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns the segment membership specified by the given identity ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-data-segment-identity-membership)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -199,19 +220,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get SegmentMembership by Identity ID
try {
Get-V2024DataSegmentIdentityMembership -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024DataSegmentIdentityMembership -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024DataSegmentIdentityMembership -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024DataSegmentIdentityMembership -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegmentIdentityMembership"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-data-segmentation-enabled-for-user
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns whether or not segmentation is enabled for the identity.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-data-segmentation-enabled-for-user)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -244,19 +271,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Is Segmentation enabled by Identity
try {
Get-V2024DataSegmentationEnabledForUser -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024DataSegmentationEnabledForUser -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024DataSegmentationEnabledForUser -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024DataSegmentationEnabledForUser -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegmentationEnabledForUser"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-data-segments
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns the segment specified by the given ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-data-segments)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -301,19 +334,25 @@ $Filters = 'name eq ""' # String | Filter results using the standard syntax desc
# Get Segments
try {
Get-V2024DataSegments -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024DataSegments -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024DataSegments -V2024XSailPointExperimental $XSailPointExperimental -V2024Enabled $Enabled -V2024Unique $Unique -V2024Published $Published -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters
# Get-V2024DataSegments -XSailPointExperimental $XSailPointExperimental -Enabled $Enabled -Unique $Unique -Published $Published -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegments"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-data-segment
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-data-segment)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -351,19 +390,25 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operat
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Update-V2024DataSegment -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $Result
Update-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result
# Below is a request that includes all optional parameters
# Update-V2024DataSegment -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $RequestBody
# Update-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024DataSegment"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## publish-data-segment
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This will publish the segment so that it starts applying the segmentation to the desired users if enabled
[API Spec](https://developer.sailpoint.com/docs/api/v2024/publish-data-segment)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -401,10 +446,10 @@ $PublishAll = $true # Boolean | This flag decides whether you want to publish al
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Publish-V2024DataSegment -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $Result
Publish-V2024DataSegment -XSailPointExperimental $XSailPointExperimental -RequestBody $Result
# Below is a request that includes all optional parameters
# Publish-V2024DataSegment -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $RequestBody -V2024PublishAll $PublishAll
# Publish-V2024DataSegment -XSailPointExperimental $XSailPointExperimental -RequestBody $Result -PublishAll $PublishAll
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Publish-V2024DataSegment"
Write-Host $_.ErrorDetails

56
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024DimensionsApi.md
View File

@@ -27,12 +27,15 @@ Method | HTTP request | Description
[**Get-V2024Dimensions**](#list-dimensions) | **GET** `/roles/{roleId}/dimensions` | List Dimensions
[**Update-V2024Dimension**](#patch-dimension) | **PATCH** `/roles/{roleId}/dimensions/{dimensionId}` | Patch a specified Dimension
## create-dimension
This API creates a dimension.
You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API.
Additionally, a ROLE_SUBADMIN cannot create a dimension that includes an access profile or entitlement if that access profile or entitlement is linked to a source that the ROLE_SUBADMIN is not associated with.
The maximum supported length for the description field is 2000 characters.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-dimension)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -151,22 +154,25 @@ $Dimension = @"{
try {
$Result = ConvertFrom-JsonToDimension -Json $Dimension
New-V2024Dimension -V2024RoleId $RoleId -V2024Dimension $Result
New-V2024Dimension -RoleId $RoleId -V2024Dimension $Result
# Below is a request that includes all optional parameters
# New-V2024Dimension -V2024RoleId $RoleId -V2024Dimension $Dimension
# New-V2024Dimension -RoleId $RoleId -V2024Dimension $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Dimension"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-bulk-dimensions
This endpoint initiates a bulk deletion of one or more dimensions.
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 token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions 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/v2024/delete-bulk-dimensions)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -201,20 +207,23 @@ $DimensionBulkDeleteRequest = @"{
try {
$Result = ConvertFrom-JsonToDimensionBulkDeleteRequest -Json $DimensionBulkDeleteRequest
Remove-V2024BulkDimensions -V2024RoleId $RoleId -V2024DimensionBulkDeleteRequest $Result
Remove-V2024BulkDimensions -RoleId $RoleId -V2024DimensionBulkDeleteRequest $Result
# Below is a request that includes all optional parameters
# Remove-V2024BulkDimensions -V2024RoleId $RoleId -V2024DimensionBulkDeleteRequest $DimensionBulkDeleteRequest
# Remove-V2024BulkDimensions -RoleId $RoleId -V2024DimensionBulkDeleteRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024BulkDimensions"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-dimension
This API deletes a Dimension by its ID.
A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles/Entitlements included in the Dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-dimension)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -246,21 +255,24 @@ $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension
# Delete a Dimension
try {
Remove-V2024Dimension -V2024RoleId $RoleId -V2024DimensionId $DimensionId
Remove-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId
# Below is a request that includes all optional parameters
# Remove-V2024Dimension -V2024RoleId $RoleId -V2024DimensionId $DimensionId
# Remove-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Dimension"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-dimension
This API returns a Dimension by its ID.
A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles or Entitlements included in the Dimension or Parent Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-dimension)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -292,21 +304,24 @@ $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension
# Get a Dimension under Role.
try {
Get-V2024Dimension -V2024RoleId $RoleId -V2024DimensionId $DimensionId
Get-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId
# Below is a request that includes all optional parameters
# Get-V2024Dimension -V2024RoleId $RoleId -V2024DimensionId $DimensionId
# Get-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Dimension"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-dimension-entitlements
This API lists the Entitlements associated with a given dimension.
A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-dimension-entitlements)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -348,21 +363,24 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de
# List Dimension's Entitlements
try {
Get-V2024DimensionEntitlements -V2024RoleId $RoleId -V2024DimensionId $DimensionId
Get-V2024DimensionEntitlements -RoleId $RoleId -DimensionId $DimensionId
# Below is a request that includes all optional parameters
# Get-V2024DimensionEntitlements -V2024RoleId $RoleId -V2024DimensionId $DimensionId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024DimensionEntitlements -RoleId $RoleId -DimensionId $DimensionId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DimensionEntitlements"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-dimension-access-profiles
This API lists the Access Profiles associated with a given Dimension
A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token 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/v2024/list-dimension-access-profiles)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -405,21 +423,24 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de
# List Dimension's Access Profiles
try {
Get-V2024DimensionAccessProfiles -V2024RoleId $RoleId -V2024DimensionId $DimensionId
Get-V2024DimensionAccessProfiles -RoleId $RoleId -DimensionId $DimensionId
# Below is a request that includes all optional parameters
# Get-V2024DimensionAccessProfiles -V2024RoleId $RoleId -V2024DimensionId $DimensionId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024DimensionAccessProfiles -RoleId $RoleId -DimensionId $DimensionId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DimensionAccessProfiles"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-dimensions
This API returns a list of dimensions under a specified role.
A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-dimensions)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -461,16 +482,17 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de
# List Dimensions
try {
Get-V2024Dimensions -V2024RoleId $RoleId
Get-V2024Dimensions -RoleId $RoleId
# Below is a request that includes all optional parameters
# Get-V2024Dimensions -V2024RoleId $RoleId -V2024ForSubadmin $ForSubadmin -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024Dimensions -RoleId $RoleId -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Dimensions"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-dimension
This API updates an existing dimension using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
The following fields are patchable: **name** **description** **owner** **accessProfiles** **entitlements** **membership**
@@ -478,6 +500,8 @@ A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required
The maximum supported length for the description field is 2000 characters.
When you use this API to modify a dimension'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/v2024/patch-dimension)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -517,10 +541,10 @@ $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024Dimension -V2024RoleId $RoleId -V2024DimensionId $DimensionId -V2024JsonPatchOperation $Result
Update-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024Dimension -V2024RoleId $RoleId -V2024DimensionId $DimensionId -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Dimension"
Write-Host $_.ErrorDetails

123
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024EntitlementsApi.md
View File

@@ -79,9 +79,15 @@ Method | HTTP request | Description
[**Reset-V2024SourceEntitlements**](#reset-source-entitlements) | **POST** `/entitlements/reset/sources/{id}` | Reset Source Entitlements
[**Update-V2024EntitlementsInBulk**](#update-entitlements-in-bulk) | **POST** `/entitlements/bulk-update` | Bulk update an entitlement list
## create-access-model-metadata-for-entitlement
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Add single Access Model Metadata to an entitlement.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-access-model-metadata-for-entitlement)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -117,19 +123,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Add metadata to an entitlement.
try {
New-V2024AccessModelMetadataForEntitlement -V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue -V2024XSailPointExperimental $XSailPointExperimental
New-V2024AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# New-V2024AccessModelMetadataForEntitlement -V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue -V2024XSailPointExperimental $XSailPointExperimental
# New-V2024AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessModelMetadataForEntitlement"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-access-model-metadata-from-entitlement
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Remove single Access Model Metadata from an entitlement.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-access-model-metadata-from-entitlement)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -165,19 +177,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Remove metadata from an entitlement.
try {
Remove-V2024AccessModelMetadataFromEntitlement -V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue -V2024XSailPointExperimental $XSailPointExperimental
Remove-V2024AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024AccessModelMetadataFromEntitlement -V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue -V2024XSailPointExperimental $XSailPointExperimental
# Remove-V2024AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessModelMetadataFromEntitlement"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-entitlement
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns an entitlement by its ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlement)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -210,19 +228,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get an entitlement
try {
Get-V2024Entitlement -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024Entitlement -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Entitlement"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-entitlement-request-config
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns the entitlement request config for a specified entitlement.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlement-request-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -255,23 +279,32 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get Entitlement Request Config
try {
Get-V2024EntitlementRequestConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024EntitlementRequestConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementRequestConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## import-entitlements-by-source
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements).
If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error.
If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-entitlements-by-source)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -305,19 +338,25 @@ $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlemen
# Aggregate Entitlements
try {
Import-V2024EntitlementsBySource -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Import-V2024EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Import-V2024EntitlementsBySource -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024CsvFile $CsvFile
# Import-V2024EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental -CsvFile $CsvFile
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024EntitlementsBySource"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-entitlement-children
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns a list of all child entitlements of a given entitlement.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-entitlement-children)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -360,19 +399,25 @@ $Filters = 'attribute eq "memberOf"' # String | Filter results using the standar
# List of entitlements children
try {
Get-V2024EntitlementChildren -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024EntitlementChildren -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters
# Get-V2024EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementChildren"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-entitlement-parents
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns a list of all parent entitlements of a given entitlement.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-entitlement-parents)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -415,23 +460,29 @@ $Filters = 'attribute eq "memberOf"' # String | Filter results using the standar
# List of entitlements parents
try {
Get-V2024EntitlementParents -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024EntitlementParents -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters
# Get-V2024EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementParents"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-entitlements
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns a list of entitlements.
This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive).
Any authenticated token can call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-entitlements)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -479,23 +530,29 @@ $Filters = 'attribute eq "memberOf"' # String | Filter results using the standar
# Gets a list of entitlements.
try {
Get-V2024Entitlements -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024Entitlements -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024Entitlements -V2024XSailPointExperimental $XSailPointExperimental -V2024AccountId $AccountId -V2024SegmentedForIdentity $SegmentedForIdentity -V2024ForSegmentIds $ForSegmentIds -V2024IncludeUnsegmented $IncludeUnsegmented -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters
# Get-V2024Entitlements -XSailPointExperimental $XSailPointExperimental -AccountId $AccountId -SegmentedForIdentity $SegmentedForIdentity -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Entitlements"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-entitlement
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields**
When you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-entitlement)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -535,19 +592,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Patch an entitlement
try {
Update-V2024Entitlement -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Update-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Update-V2024Entitlement -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Entitlement"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-entitlement-request-config
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API replaces the entitlement request config for a specified entitlement.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-entitlement-request-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -595,20 +658,26 @@ $EntitlementRequestConfig = @"{
try {
$Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig
Send-V2024EntitlementRequestConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024EntitlementRequestConfig $Result
Send-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024EntitlementRequestConfig $Result
# Below is a request that includes all optional parameters
# Send-V2024EntitlementRequestConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024EntitlementRequestConfig $EntitlementRequestConfig
# Send-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024EntitlementRequestConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024EntitlementRequestConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## reset-source-entitlements
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Remove all entitlements from a specific source.
To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/reset-source-entitlements)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -640,17 +709,21 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Reset Source Entitlements
try {
Reset-V2024SourceEntitlements -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Reset-V2024SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Reset-V2024SourceEntitlements -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Reset-V2024SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2024SourceEntitlements"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-entitlements-in-bulk
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
"This API applies an update to every entitlement of the list.\n\nThe\
\ number of entitlements to update is limited to 50 items maximum.\n\nThe JsonPatch\
\ update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\
@@ -659,6 +732,8 @@ try {
: boolean }**`"
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-entitlements-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -702,10 +777,10 @@ $EntitlementBulkUpdateRequest = @"{
try {
$Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest
Update-V2024EntitlementsInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024EntitlementBulkUpdateRequest $Result
Update-V2024EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -V2024EntitlementBulkUpdateRequest $Result
# Below is a request that includes all optional parameters
# Update-V2024EntitlementsInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024EntitlementBulkUpdateRequest $EntitlementBulkUpdateRequest
# Update-V2024EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -V2024EntitlementBulkUpdateRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024EntitlementsInBulk"
Write-Host $_.ErrorDetails

19
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GlobalTenantSecuritySettingsApi.md
View File

@@ -24,9 +24,12 @@ Method | HTTP request | Description
[**Get-V2024AuthOrgNetworkConfig**](#get-auth-org-network-config) | **GET** `/auth-org/network-config` | Get security network configuration.
[**Update-V2024AuthOrgNetworkConfig**](#patch-auth-org-network-config) | **PATCH** `/auth-org/network-config` | Update security network 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/v2024/create-auth-org-network-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -62,19 +65,22 @@ $NetworkConfiguration = @"{
try {
$Result = ConvertFrom-JsonToNetworkConfiguration -Json $NetworkConfiguration
New-V2024AuthOrgNetworkConfig -V2024NetworkConfiguration $Result
New-V2024AuthOrgNetworkConfig -V2024NetworkConfiguration $Result
# Below is a request that includes all optional parameters
# New-V2024AuthOrgNetworkConfig -V2024NetworkConfiguration $NetworkConfiguration
# New-V2024AuthOrgNetworkConfig -V2024NetworkConfiguration $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AuthOrgNetworkConfig"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-auth-org-network-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -103,7 +109,7 @@ Code | Description | Data Type
# Get security network configuration.
try {
Get-V2024AuthOrgNetworkConfig
Get-V2024AuthOrgNetworkConfig
# Below is a request that includes all optional parameters
# Get-V2024AuthOrgNetworkConfig
@@ -113,10 +119,13 @@ try {
}
```
[[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/v2024/patch-auth-org-network-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -153,10 +162,10 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024AuthOrgNetworkConfig -V2024JsonPatchOperation $Result
Update-V2024AuthOrgNetworkConfig -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024AuthOrgNetworkConfig -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024AuthOrgNetworkConfig -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgNetworkConfig"
Write-Host $_.ErrorDetails

100
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GovernanceGroupsApi.md
View File

@@ -33,9 +33,15 @@ Method | HTTP request | Description
[**Update-V2024Workgroup**](#patch-workgroup) | **PATCH** `/workgroups/{id}` | Patch a Governance Group
[**Update-V2024WorkgroupMembers**](#update-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-add` | Add members to Governance Group
## create-workgroup
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API creates a new Governance Group.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-workgroup)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -83,19 +89,25 @@ $WorkgroupDto = @"{
try {
$Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto
New-V2024Workgroup -V2024XSailPointExperimental $XSailPointExperimental -V2024WorkgroupDto $Result
New-V2024Workgroup -XSailPointExperimental $XSailPointExperimental -V2024WorkgroupDto $Result
# Below is a request that includes all optional parameters
# New-V2024Workgroup -V2024XSailPointExperimental $XSailPointExperimental -V2024WorkgroupDto $WorkgroupDto
# New-V2024Workgroup -XSailPointExperimental $XSailPointExperimental -V2024WorkgroupDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workgroup"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-workgroup
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API deletes a Governance Group by its ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-workgroup)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -127,22 +139,28 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Delete a Governance Group
try {
Remove-V2024Workgroup -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Remove-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024Workgroup -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Remove-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workgroup"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-workgroup-members
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API removes one or more members from a Governance Group. A
> **Following field of Identity is an optional field in the request.**
> **name**
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-workgroup-members)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -178,17 +196,21 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity
Remove-V2024WorkgroupMembers -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result
Remove-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result
# Below is a request that includes all optional parameters
# Remove-V2024WorkgroupMembers -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $IdentityPreviewResponseIdentity
# Remove-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024WorkgroupMembers"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-workgroups-in-bulk
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API initiates a bulk deletion of one or more Governance Groups.
@@ -202,6 +224,8 @@ This API initiates a bulk deletion of one or more Governance Groups.
> **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.**
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-workgroups-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -236,19 +260,25 @@ $WorkgroupBulkDeleteRequest = @"{
try {
$Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest
Remove-V2024WorkgroupsInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024WorkgroupBulkDeleteRequest $Result
Remove-V2024WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -V2024WorkgroupBulkDeleteRequest $Result
# Below is a request that includes all optional parameters
# Remove-V2024WorkgroupsInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024WorkgroupBulkDeleteRequest $WorkgroupBulkDeleteRequest
# Remove-V2024WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -V2024WorkgroupBulkDeleteRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024WorkgroupsInBulk"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-workgroup
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns a Governance Groups by its ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-workgroup)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -280,19 +310,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get Governance Group by Id
try {
Get-V2024Workgroup -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024Workgroup -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workgroup"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-connections
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns list of connections associated with a Governance Group.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-connections)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -332,19 +368,25 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de
# List connections for Governance Group
try {
Get-V2024Connections -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024Connections -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024Connections -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters
# Get-V2024Connections -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Connections"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-workgroup-members
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns list of members associated with a Governance Group.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workgroup-members)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -384,19 +426,25 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de
# List Governance Group Members
try {
Get-V2024WorkgroupMembers -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024WorkgroupMembers -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters
# Get-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkgroupMembers"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-workgroups
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns list of Governance Groups
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workgroups)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -436,22 +484,28 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de
# List Governance Groups
try {
Get-V2024Workgroups -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024Workgroups -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024Workgroups -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024Workgroups -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workgroups"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-workgroup
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API updates an existing governance group by ID. The following fields and objects are patchable:
* name
* description
* owner
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-workgroup)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -490,23 +544,29 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Patch a Governance Group
try {
Update-V2024Workgroup -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Update-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Update-V2024Workgroup -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workgroup"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-workgroup-members
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API.
> **Following field of Identity is an optional field in the request.**
> **name**
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-workgroup-members)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -542,10 +602,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity
Update-V2024WorkgroupMembers -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result
Update-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result
# Below is a request that includes all optional parameters
# Update-V2024WorkgroupMembers -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $IdentityPreviewResponseIdentity
# Update-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024WorkgroupMembers"
Write-Host $_.ErrorDetails

80
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIAccessRequestRecommendationsApi.md
View File

@@ -26,9 +26,15 @@ Method | HTTP request | Description
[**Get-V2024AccessRequestRecommendationsRequestedItems**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List of Requested Access Request Recommendations
[**Get-V2024AccessRequestRecommendationsViewedItems**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List of Viewed Access Request Recommendations
## add-access-request-recommendations-ignored-item
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/add-access-request-recommendations-ignored-item)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -67,19 +73,25 @@ $AccessRequestRecommendationActionItemDto = @"{
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
Add-V2024AccessRequestRecommendationsIgnoredItem -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result
Add-V2024AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result
# Below is a request that includes all optional parameters
# Add-V2024AccessRequestRecommendationsIgnoredItem -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto
# Add-V2024AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsIgnoredItem"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## add-access-request-recommendations-requested-item
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/add-access-request-recommendations-requested-item)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -118,19 +130,25 @@ $AccessRequestRecommendationActionItemDto = @"{
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
Add-V2024AccessRequestRecommendationsRequestedItem -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result
Add-V2024AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result
# Below is a request that includes all optional parameters
# Add-V2024AccessRequestRecommendationsRequestedItem -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto
# Add-V2024AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsRequestedItem"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## add-access-request-recommendations-viewed-item
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/add-access-request-recommendations-viewed-item)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -169,19 +187,25 @@ $AccessRequestRecommendationActionItemDto = @"{
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
Add-V2024AccessRequestRecommendationsViewedItem -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result
Add-V2024AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result
# Below is a request that includes all optional parameters
# Add-V2024AccessRequestRecommendationsViewedItem -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto
# Add-V2024AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsViewedItem"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## add-access-request-recommendations-viewed-items
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/add-access-request-recommendations-viewed-items)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -221,19 +245,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
Add-V2024AccessRequestRecommendationsViewedItems -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result
Add-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result
# Below is a request that includes all optional parameters
# Add-V2024AccessRequestRecommendationsViewedItems -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto
# Add-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsViewedItems"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-access-request-recommendations
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -277,19 +307,25 @@ $Sorters = "MySorters" # String | Sort results using the standard syntax describ
# Identity Access Request Recommendations
try {
Get-V2024AccessRequestRecommendations -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024AccessRequestRecommendations -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AccessRequestRecommendations -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityId $IdentityId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024IncludeTranslationMessages $IncludeTranslationMessages -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024AccessRequestRecommendations -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendations"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-access-request-recommendations-ignored-items
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns the list of ignored access request recommendations.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations-ignored-items)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -329,19 +365,25 @@ $Sorters = "access.id" # String | Sort results using the standard syntax describ
# List of Ignored Access Request Recommendations
try {
Get-V2024AccessRequestRecommendationsIgnoredItems -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AccessRequestRecommendationsIgnoredItems -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsIgnoredItems"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-access-request-recommendations-requested-items
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns a list of requested access request recommendations.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations-requested-items)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -381,19 +423,25 @@ $Sorters = "MySorters" # String | Sort results using the standard syntax describ
# List of Requested Access Request Recommendations
try {
Get-V2024AccessRequestRecommendationsRequestedItems -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AccessRequestRecommendationsRequestedItems -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsRequestedItems"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-access-request-recommendations-viewed-items
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns the list of viewed access request recommendations.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations-viewed-items)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -433,10 +481,10 @@ $Sorters = "MySorters" # String | Sort results using the standard syntax describ
# List of Viewed Access Request Recommendations
try {
Get-V2024AccessRequestRecommendationsViewedItems -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AccessRequestRecommendationsViewedItems -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsViewedItems"
Write-Host $_.ErrorDetails

30
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAICommonAccessApi.md
View File

@@ -21,9 +21,15 @@ Method | HTTP request | Description
[**Get-V2024CommonAccess**](#get-common-access) | **GET** `/common-access` | Get a paginated list of common access
[**Update-V2024CommonAccessStatusInBulk**](#update-common-access-status-in-bulk) | **POST** `/common-access/update-status` | Bulk update common access status
## create-common-access
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-common-access)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -66,19 +72,25 @@ $CommonAccessItemRequest = @"{
try {
$Result = ConvertFrom-JsonToCommonAccessItemRequest -Json $CommonAccessItemRequest
New-V2024CommonAccess -V2024XSailPointExperimental $XSailPointExperimental -V2024CommonAccessItemRequest $Result
New-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental -V2024CommonAccessItemRequest $Result
# Below is a request that includes all optional parameters
# New-V2024CommonAccess -V2024XSailPointExperimental $XSailPointExperimental -V2024CommonAccessItemRequest $CommonAccessItemRequest
# New-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental -V2024CommonAccessItemRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CommonAccess"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-common-access
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-common-access)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -117,19 +129,25 @@ $Sorters = "access.name" # String | Sort results using the standard syntax descr
# Get a paginated list of common access
try {
Get-V2024CommonAccess -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024CommonAccess -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CommonAccess"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-common-access-status-in-bulk
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-common-access-status-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -166,10 +184,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToCommonAccessIDStatus -Json $CommonAccessIDStatus
Update-V2024CommonAccessStatusInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024CommonAccessIDStatus $Result
Update-V2024CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -V2024CommonAccessIDStatus $Result
# Below is a request that includes all optional parameters
# Update-V2024CommonAccessStatusInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024CommonAccessIDStatus $CommonAccessIDStatus
# Update-V2024CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -V2024CommonAccessIDStatus $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CommonAccessStatusInBulk"
Write-Host $_.ErrorDetails

90
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIOutliersApi.md
View File

@@ -27,12 +27,18 @@ Method | HTTP request | Description
[**Get-V2024OutliersContributingFeatureAccessItems**](#list-outliers-contributing-feature-access-items) | **GET** `/outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items` | Gets a list of access items associated with each identity outlier contributing feature
[**Invoke-V2024UnIgnoreIdentityOutliers**](#un-ignore-identity-outliers) | **POST** `/outliers/unignore` | IAI Identity Outliers Unignore
## export-outliers-zip
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported.
Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes).
[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-outliers-zip)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -64,19 +70,25 @@ $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to fi
# IAI Identity Outliers Export
try {
Export-V2024OutliersZip -V2024XSailPointExperimental $XSailPointExperimental
Export-V2024OutliersZip -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Export-V2024OutliersZip -V2024XSailPointExperimental $XSailPointExperimental -V2024Type $Type
# Export-V2024OutliersZip -XSailPointExperimental $XSailPointExperimental -Type $Type
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024OutliersZip"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-outlier-snapshots
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-outlier-snapshots)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -117,19 +129,25 @@ $Sorters = "snapshotDate" # String | Sort results using the standard syntax desc
# IAI Identity Outliers Summary
try {
Get-V2024IdentityOutlierSnapshots -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024IdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024IdentityOutlierSnapshots -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Type $Type -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024IdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Type $Type -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOutlierSnapshots"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-outliers
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-outliers)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -171,19 +189,25 @@ $Sorters = "attributes.displayName,firstDetectionDate,-score" # String | Sort re
# IAI Get Identity Outliers
try {
Get-V2024IdentityOutliers -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024IdentityOutliers -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024IdentityOutliers -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Type $Type -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024IdentityOutliers -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Type $Type -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOutliers"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-latest-identity-outlier-snapshots
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-latest-identity-outlier-snapshots)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -216,22 +240,28 @@ $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to fi
# IAI Identity Outliers Latest Summary
try {
Get-V2024LatestIdentityOutlierSnapshots -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024LatestIdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024LatestIdentityOutlierSnapshots -V2024XSailPointExperimental $XSailPointExperimental -V2024Type $Type
# Get-V2024LatestIdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental -Type $Type
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024LatestIdentityOutlierSnapshots"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-outlier-contributing-feature-summary
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns a summary of a contributing feature for an identity outlier.
The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-outlier-contributing-feature-summary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -264,22 +294,28 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get identity outlier contibuting feature summary
try {
Get-V2024OutlierContributingFeatureSummary -V2024OutlierFeatureId $OutlierFeatureId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024OutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024OutlierContributingFeatureSummary -V2024OutlierFeatureId $OutlierFeatureId -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024OutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OutlierContributingFeatureSummary"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-peer-group-outliers-contributing-features
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns a list of contributing feature objects for a single outlier.
The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-peer-group-outliers-contributing-features)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -322,19 +358,25 @@ $Sorters = "importance" # String | Sort results using the standard syntax descri
# Get identity outlier's contibuting features
try {
Get-V2024PeerGroupOutliersContributingFeatures -V2024OutlierId $OutlierId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024PeerGroupOutliersContributingFeatures -OutlierId $OutlierId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024PeerGroupOutliersContributingFeatures -V2024OutlierId $OutlierId -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024IncludeTranslationMessages $IncludeTranslationMessages -V2024Sorters $Sorters
# Get-V2024PeerGroupOutliersContributingFeatures -OutlierId $OutlierId -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PeerGroupOutliersContributingFeatures"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## ignore-identity-outliers
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API receives a list of identity IDs in the request, changes the outliers to be ignored.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/ignore-identity-outliers)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -369,22 +411,28 @@ $RequestBody = "MyRequestBody" # String[] |
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Invoke-V2024IgnoreIdentityOutliers -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $Result
Invoke-V2024IgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result
# Below is a request that includes all optional parameters
# Invoke-V2024IgnoreIdentityOutliers -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $RequestBody
# Invoke-V2024IgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024IgnoreIdentityOutliers"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-outliers-contributing-feature-access-items
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns a list of the enriched access items associated with each feature filtered by the access item type.
The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-outliers-contributing-feature-access-items)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -429,19 +477,25 @@ $Sorters = "displayName" # String | Sort results using the standard syntax descr
# Gets a list of access items associated with each identity outlier contributing feature
try {
Get-V2024OutliersContributingFeatureAccessItems -V2024OutlierId $OutlierId -V2024ContributingFeatureName $ContributingFeatureName -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024OutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024OutliersContributingFeatureAccessItems -V2024OutlierId $OutlierId -V2024ContributingFeatureName $ContributingFeatureName -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024AccessType $AccessType -V2024Sorters $Sorters
# Get-V2024OutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -AccessType $AccessType -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OutliersContributingFeatureAccessItems"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## un-ignore-identity-outliers
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API receives a list of identity IDs in the request, changes the outliers to be un-ignored.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/un-ignore-identity-outliers)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -476,10 +530,10 @@ $RequestBody = "MyRequestBody" # String[] |
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Invoke-V2024UnIgnoreIdentityOutliers -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $Result
Invoke-V2024UnIgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result
# Below is a request that includes all optional parameters
# Invoke-V2024UnIgnoreIdentityOutliers -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $RequestBody
# Invoke-V2024UnIgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024UnIgnoreIdentityOutliers"
Write-Host $_.ErrorDetails

13
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIPeerGroupStrategiesApi.md
View File

@@ -19,9 +19,18 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024PeerGroupOutliers**](#get-peer-group-outliers) | **GET** `/peer-group-strategies/{strategy}/identity-outliers` | Identity Outliers List
## get-peer-group-outliers
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
-- Deprecated : See 'IAI Outliers' This API will be used by Identity Governance systems to identify identities that are not included in an organization's peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-peer-group-outliers)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -59,10 +68,10 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Identity Outliers List
try {
Get-V2024PeerGroupOutliers -V2024Strategy $Strategy -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024PeerGroupOutliers -Strategy $Strategy -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024PeerGroupOutliers -V2024Strategy $Strategy -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count
# Get-V2024PeerGroupOutliers -Strategy $Strategy -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PeerGroupOutliers"
Write-Host $_.ErrorDetails

30
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIRecommendationsApi.md
View File

@@ -21,9 +21,15 @@ Method | HTTP request | Description
[**Get-V2024RecommendationsConfig**](#get-recommendations-config) | **GET** `/recommendations/config` | Get certification recommendation config values
[**Update-V2024RecommendationsConfig**](#update-recommendations-config) | **PUT** `/recommendations/config` | Update certification recommendation config values
## get-recommendations
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-recommendations)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -74,19 +80,25 @@ $RecommendationRequestDto = @"{
try {
$Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto
Get-V2024Recommendations -V2024XSailPointExperimental $XSailPointExperimental -V2024RecommendationRequestDto $Result
Get-V2024Recommendations -XSailPointExperimental $XSailPointExperimental -V2024RecommendationRequestDto $Result
# Below is a request that includes all optional parameters
# Get-V2024Recommendations -V2024XSailPointExperimental $XSailPointExperimental -V2024RecommendationRequestDto $RecommendationRequestDto
# Get-V2024Recommendations -XSailPointExperimental $XSailPointExperimental -V2024RecommendationRequestDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Recommendations"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-recommendations-config
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Retrieves configuration attributes used by certification recommendations.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-recommendations-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -115,19 +127,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get certification recommendation config values
try {
Get-V2024RecommendationsConfig -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RecommendationsConfig -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RecommendationsConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-recommendations-config
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Updates configuration attributes used by certification recommendations.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-recommendations-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -164,10 +182,10 @@ $RecommendationConfigDto = @"{
try {
$Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto
Update-V2024RecommendationsConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024RecommendationConfigDto $Result
Update-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -V2024RecommendationConfigDto $Result
# Below is a request that includes all optional parameters
# Update-V2024RecommendationsConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024RecommendationConfigDto $RecommendationConfigDto
# Update-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -V2024RecommendationConfigDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RecommendationsConfig"
Write-Host $_.ErrorDetails

250
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIRoleMiningApi.md
View File

@@ -43,9 +43,15 @@ Method | HTTP request | Description
[**Update-V2024RoleMiningSession**](#patch-role-mining-session) | **PATCH** `/role-mining-sessions/{sessionId}` | Patch a role mining session
[**Update-V2024EntitlementsPotentialRole**](#update-entitlements-potential-role) | **POST** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements` | Edit entitlements for a potential role to exclude some entitlements
## create-potential-role-provision-request
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This method starts a job to provision a potential role
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-potential-role-provision-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -91,19 +97,25 @@ $RoleMiningPotentialRoleProvisionRequest = @"{
# Create request to provision a potential role into an actual role.
try {
New-V2024PotentialRoleProvisionRequest -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental
New-V2024PotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# New-V2024PotentialRoleProvisionRequest -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024MinEntitlementPopularity $MinEntitlementPopularity -V2024IncludeCommonAccess $IncludeCommonAccess -V2024RoleMiningPotentialRoleProvisionRequest $RoleMiningPotentialRoleProvisionRequest
# New-V2024PotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -MinEntitlementPopularity $MinEntitlementPopularity -IncludeCommonAccess $IncludeCommonAccess -V2024RoleMiningPotentialRoleProvisionRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PotentialRoleProvisionRequest"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-role-mining-sessions
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This submits a create role mining session request to the role mining application.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-role-mining-sessions)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -167,19 +179,25 @@ $RoleMiningSessionDto = @"{
try {
$Result = ConvertFrom-JsonToRoleMiningSessionDto -Json $RoleMiningSessionDto
New-V2024RoleMiningSessions -V2024XSailPointExperimental $XSailPointExperimental -V2024RoleMiningSessionDto $Result
New-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -V2024RoleMiningSessionDto $Result
# Below is a request that includes all optional parameters
# New-V2024RoleMiningSessions -V2024XSailPointExperimental $XSailPointExperimental -V2024RoleMiningSessionDto $RoleMiningSessionDto
# New-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -V2024RoleMiningSessionDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024RoleMiningSessions"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## download-role-mining-potential-role-zip
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This endpoint downloads a completed export of information for a potential role in a role mining session.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/download-role-mining-potential-role-zip)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -214,19 +232,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Export (download) details for a potential role in a role mining session
try {
Invoke-V2024DownloadRoleMiningPotentialRoleZip -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024ExportId $ExportId -V2024XSailPointExperimental $XSailPointExperimental
Invoke-V2024DownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Invoke-V2024DownloadRoleMiningPotentialRoleZip -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024ExportId $ExportId -V2024XSailPointExperimental $XSailPointExperimental
# Invoke-V2024DownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024DownloadRoleMiningPotentialRoleZip"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## export-role-mining-potential-role
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-role-mining-potential-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -259,19 +283,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Export (download) details for a potential role in a role mining session
try {
Export-V2024RoleMiningPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental
Export-V2024RoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Export-V2024RoleMiningPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental
# Export-V2024RoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRole"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## export-role-mining-potential-role-async
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-role-mining-potential-role-async)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -309,19 +339,25 @@ $RoleMiningPotentialRoleExportRequest = @"{
# Asynchronously export details for a potential role in a role mining session and upload to S3
try {
Export-V2024RoleMiningPotentialRoleAsync -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental
Export-V2024RoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Export-V2024RoleMiningPotentialRoleAsync -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024RoleMiningPotentialRoleExportRequest $RoleMiningPotentialRoleExportRequest
# Export-V2024RoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -V2024RoleMiningPotentialRoleExportRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRoleAsync"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## export-role-mining-potential-role-status
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This endpoint retrieves information about the current status of a potential role export.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-role-mining-potential-role-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -356,19 +392,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Retrieve status of a potential role export job
try {
Export-V2024RoleMiningPotentialRoleStatus -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024ExportId $ExportId -V2024XSailPointExperimental $XSailPointExperimental
Export-V2024RoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Export-V2024RoleMiningPotentialRoleStatus -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024ExportId $ExportId -V2024XSailPointExperimental $XSailPointExperimental
# Export-V2024RoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRoleStatus"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-all-potential-role-summaries
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Returns all potential role summaries that match the query parameters
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-all-potential-role-summaries)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -408,19 +450,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Retrieves all potential role summaries
try {
Get-V2024AllPotentialRoleSummaries -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024AllPotentialRoleSummaries -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AllPotentialRoleSummaries -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count
# Get-V2024AllPotentialRoleSummaries -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllPotentialRoleSummaries"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-entitlement-distribution-potential-role
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This method returns entitlement popularity distribution for a potential role in a role mining session.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlement-distribution-potential-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -455,19 +503,25 @@ $IncludeCommonAccess = $true # Boolean | Boolean determining whether common acce
# Retrieves entitlement popularity distribution for a potential role in a role mining session
try {
Get-V2024EntitlementDistributionPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024EntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024EntitlementDistributionPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024IncludeCommonAccess $IncludeCommonAccess
# Get-V2024EntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -IncludeCommonAccess $IncludeCommonAccess
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementDistributionPotentialRole"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-entitlements-potential-role
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This method returns entitlements for a potential role in a role mining session.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlements-potential-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -513,19 +567,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Retrieves entitlements for a potential role in a role mining session
try {
Get-V2024EntitlementsPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024EntitlementsPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024IncludeCommonAccess $IncludeCommonAccess -V2024Sorters $Sorters -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count
# Get-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -IncludeCommonAccess $IncludeCommonAccess -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementsPotentialRole"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-excluded-entitlements-potential-role
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This method returns excluded entitlements for a potential role in a role mining session.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-excluded-entitlements-potential-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -568,19 +628,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Retrieves excluded entitlements for a potential role in a role mining session
try {
Get-V2024ExcludedEntitlementsPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024ExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024ExcludedEntitlementsPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count
# Get-V2024ExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ExcludedEntitlementsPotentialRole"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identities-potential-role
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This method returns identities for a potential role in a role mining session.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identities-potential-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -623,19 +689,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Retrieves identities for a potential role in a role mining session
try {
Get-V2024IdentitiesPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024IdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024IdentitiesPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count
# Get-V2024IdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitiesPotentialRole"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-potential-role
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This method returns a specific potential role for a role mining session.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-potential-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -669,19 +741,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Retrieves a specific potential role
try {
Get-V2024PotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024PotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRole"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-potential-role-applications
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This method returns the applications of a potential role for a role mining session.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-potential-role-applications)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -723,19 +801,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Retrieves the applications of a potential role for a role mining session
try {
Get-V2024PotentialRoleApplications -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024PotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024PotentialRoleApplications -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count
# Get-V2024PotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleApplications"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-potential-role-entitlements
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This method returns the entitlements of a potential role for a role mining session.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-potential-role-entitlements)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -777,19 +861,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Retrieves the entitlements of a potential role for a role mining session
try {
Get-V2024PotentialRoleEntitlements -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024PotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024PotentialRoleEntitlements -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count
# Get-V2024PotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleEntitlements"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-potential-role-source-identity-usage
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-potential-role-source-identity-usage)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -831,19 +921,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Retrieves potential role source usage
try {
Get-V2024PotentialRoleSourceIdentityUsage -V2024PotentialRoleId $PotentialRoleId -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024PotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024PotentialRoleSourceIdentityUsage -V2024PotentialRoleId $PotentialRoleId -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count
# Get-V2024PotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleSourceIdentityUsage"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-potential-role-summaries
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This method returns the potential role summaries for a role mining session.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-potential-role-summaries)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -885,19 +981,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Retrieves all potential role summaries
try {
Get-V2024PotentialRoleSummaries -V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024PotentialRoleSummaries -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024PotentialRoleSummaries -V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count
# Get-V2024PotentialRoleSummaries -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleSummaries"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-mining-potential-role
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This method returns a specific potential role.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-mining-potential-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -929,19 +1031,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Retrieves a specific potential role
try {
Get-V2024RoleMiningPotentialRole -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024RoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleMiningPotentialRole -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024RoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningPotentialRole"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-mining-session
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
The method retrieves a role mining session.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-mining-session)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -974,19 +1082,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get a role mining session
try {
Get-V2024RoleMiningSession -V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleMiningSession -V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSession"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-mining-session-status
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This method returns a role mining session status for a customer.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-mining-session-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1017,19 +1131,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get role mining session status state
try {
Get-V2024RoleMiningSessionStatus -V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024RoleMiningSessionStatus -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleMiningSessionStatus -V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024RoleMiningSessionStatus -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSessionStatus"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-mining-sessions
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Returns all role mining sessions that match the query parameters
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-mining-sessions)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1069,19 +1189,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Retrieves all role mining sessions
try {
Get-V2024RoleMiningSessions -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleMiningSessions -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters -V2024Sorters $Sorters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count
# Get-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSessions"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-saved-potential-roles
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This method returns all saved potential roles (draft roles).
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-saved-potential-roles)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1119,17 +1245,21 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Retrieves all saved potential roles
try {
Get-V2024SavedPotentialRoles -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024SavedPotentialRoles -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SavedPotentialRoles -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count
# Get-V2024SavedPotentialRoles -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedPotentialRoles"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-potential-role
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
The method updates an existing potential role using.
The following fields can be modified:
@@ -1144,6 +1274,8 @@ The following fields can be modified:
>**NOTE: All other fields cannot be modified.**
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-potential-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1182,17 +1314,21 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner
Update-V2024PotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $Result
Update-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $Result
# Below is a request that includes all optional parameters
# Update-V2024PotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $PatchPotentialRoleRequestInner
# Update-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PotentialRole"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-potential-role-0
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
The method updates an existing potential role using.
The following fields can be modified:
@@ -1207,6 +1343,8 @@ The following fields can be modified:
>**NOTE: All other fields cannot be modified.**
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-potential-role-0)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1245,19 +1383,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner
Update-V2024PotentialRole0 -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $Result
Update-V2024PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $Result
# Below is a request that includes all optional parameters
# Update-V2024PotentialRole0 -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $PatchPotentialRoleRequestInner
# Update-V2024PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PotentialRole0"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-role-mining-session
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
The method updates an existing role mining session using PATCH. Supports op in {"replace"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-role-mining-session)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1298,19 +1442,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024RoleMiningSession -V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
Update-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024RoleMiningSession -V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RoleMiningSession"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-entitlements-potential-role
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This endpoint adds or removes entitlements from an exclusion list for a potential role.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-entitlements-potential-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1349,10 +1499,10 @@ $RoleMiningPotentialRoleEditEntitlements = @"{
try {
$Result = ConvertFrom-JsonToRoleMiningPotentialRoleEditEntitlements -Json $RoleMiningPotentialRoleEditEntitlements
Update-V2024EntitlementsPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024RoleMiningPotentialRoleEditEntitlements $Result
Update-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -V2024RoleMiningPotentialRoleEditEntitlements $Result
# Below is a request that includes all optional parameters
# Update-V2024EntitlementsPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024RoleMiningPotentialRoleEditEntitlements $RoleMiningPotentialRoleEditEntitlements
# Update-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -V2024RoleMiningPotentialRoleEditEntitlements $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024EntitlementsPotentialRole"
Write-Host $_.ErrorDetails

20
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IconsApi.md
View File

@@ -22,9 +22,15 @@ Method | HTTP request | Description
[**Remove-V2024Icon**](#delete-icon) | **DELETE** `/icons/{objectType}/{objectId}` | Delete an icon
[**Set-V2024Icon**](#set-icon) | **PUT** `/icons/{objectType}/{objectId}` | Update an icon
## delete-icon
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-icon)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -59,19 +65,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Delete an icon
try {
Remove-V2024Icon -V2024ObjectType $ObjectType -V2024ObjectId $ObjectId -V2024XSailPointExperimental $XSailPointExperimental
Remove-V2024Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024Icon -V2024ObjectType $ObjectType -V2024ObjectId $ObjectId -V2024XSailPointExperimental $XSailPointExperimental
# Remove-V2024Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Icon"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-icon
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-icon)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -108,10 +120,10 @@ $Image = # System.IO.FileInfo | file with icon. Allowed mime-types ['image/png'
# Update an icon
try {
Set-V2024Icon -V2024ObjectType $ObjectType -V2024ObjectId $ObjectId -V2024XSailPointExperimental $XSailPointExperimental -V2024Image $Image
Set-V2024Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental -Image $Image
# Below is a request that includes all optional parameters
# Set-V2024Icon -V2024ObjectType $ObjectType -V2024ObjectId $ObjectId -V2024XSailPointExperimental $XSailPointExperimental -V2024Image $Image
# Set-V2024Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental -Image $Image
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024Icon"
Write-Host $_.ErrorDetails

112
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentitiesApi.md
View File

@@ -44,9 +44,15 @@ Method | HTTP request | Description
[**Start-V2024IdentityProcessing**](#start-identity-processing) | **POST** `/identities/process` | Process a list of identityIds
[**Sync-V2024hronizeAttributesForIdentity**](#synchronize-attributes-for-identity) | **POST** `/identities/{identityId}/synchronize-attributes` | Attribute synchronization for single identity.
## delete-identity
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
The API returns successful response if the requested identity was deleted.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -79,19 +85,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Delete identity
try {
Remove-V2024Identity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Remove-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024Identity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Remove-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Identity"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns a single identity using the Identity ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -124,21 +136,27 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Identity Details
try {
Get-V2024Identity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024Identity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Identity"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-ownership-details
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Use this API to return an identity's owned objects that will cause problems for deleting the identity.
Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity.
For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity's owned objects.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-ownership-details)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -171,18 +189,24 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get ownership details
try {
Get-V2024IdentityOwnershipDetails -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024IdentityOwnershipDetails -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024IdentityOwnershipDetails -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024IdentityOwnershipDetails -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOwnershipDetails"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-assignment
## get-role-assignment
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-assignment)
### Parameters
Param Type | Name | Data Type | Required | Description
@@ -218,19 +242,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Role assignment details
try {
Get-V2024RoleAssignment -V2024IdentityId $IdentityId -V2024AssignmentId $AssignmentId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024RoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleAssignment -V2024IdentityId $IdentityId -V2024AssignmentId $AssignmentId -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024RoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignment"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-assignments
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-assignments)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -267,19 +297,25 @@ $RoleName = "Engineer" # String | Role name to filter the role assignments with
# List role assignments
try {
Get-V2024RoleAssignments -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024RoleAssignments -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleAssignments -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental -V2024RoleId $RoleId -V2024RoleName $RoleName
# Get-V2024RoleAssignments -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -RoleId $RoleId -RoleName $RoleName
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignments"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-identities
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns a list of identities.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identities)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -321,19 +357,25 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
# List Identities
try {
Get-V2024Identities -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024Identities -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024Identities -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters -V2024Sorters $Sorters -V2024DefaultFilter $DefaultFilter -V2024Count $Count -V2024Limit $Limit -V2024Offset $Offset
# Get-V2024Identities -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -DefaultFilter $DefaultFilter -Count $Count -Limit $Limit -Offset $Offset
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Identities"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## reset-identity
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Use this endpoint to reset a user's identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/reset-identity)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -366,20 +408,26 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Reset an identity
try {
Reset-V2024Identity -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental
Reset-V2024Identity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Reset-V2024Identity -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental
# Reset-V2024Identity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2024Identity"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## send-identity-verification-account-token
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/send-identity-verification-account-token)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -418,17 +466,21 @@ $SendAccountVerificationRequest = @"{
try {
$Result = ConvertFrom-JsonToSendAccountVerificationRequest -Json $SendAccountVerificationRequest
Send-V2024IdentityVerificationAccountToken -V2024XSailPointExperimental $XSailPointExperimental -V2024Id $Id -V2024SendAccountVerificationRequest $Result
Send-V2024IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -V2024SendAccountVerificationRequest $Result
# Below is a request that includes all optional parameters
# Send-V2024IdentityVerificationAccountToken -V2024XSailPointExperimental $XSailPointExperimental -V2024Id $Id -V2024SendAccountVerificationRequest $SendAccountVerificationRequest
# Send-V2024IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -V2024SendAccountVerificationRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024IdentityVerificationAccountToken"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-identities-invite
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options.
This task will send an invitation email only for unregistered identities.
@@ -436,6 +488,8 @@ This task will send an invitation email only for unregistered identities.
The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status).
[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-identities-invite)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -472,17 +526,21 @@ $InviteIdentitiesRequest = @"{
try {
$Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest
Start-V2024IdentitiesInvite -V2024XSailPointExperimental $XSailPointExperimental -V2024InviteIdentitiesRequest $Result
Start-V2024IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -V2024InviteIdentitiesRequest $Result
# Below is a request that includes all optional parameters
# Start-V2024IdentitiesInvite -V2024XSailPointExperimental $XSailPointExperimental -V2024InviteIdentitiesRequest $InviteIdentitiesRequest
# Start-V2024IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -V2024InviteIdentitiesRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024IdentitiesInvite"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-identity-processing
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This 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.
This endpoint will perform the following tasks:
@@ -492,6 +550,8 @@ This endpoint will perform the following tasks:
4. Recalculate manager relationships.
5. Potentially clean-up identity processing errors, assuming the error has been resolved.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-identity-processing)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -527,19 +587,25 @@ $ProcessIdentitiesRequest = @"{
try {
$Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest
Start-V2024IdentityProcessing -V2024XSailPointExperimental $XSailPointExperimental -V2024ProcessIdentitiesRequest $Result
Start-V2024IdentityProcessing -XSailPointExperimental $XSailPointExperimental -V2024ProcessIdentitiesRequest $Result
# Below is a request that includes all optional parameters
# Start-V2024IdentityProcessing -V2024XSailPointExperimental $XSailPointExperimental -V2024ProcessIdentitiesRequest $ProcessIdentitiesRequest
# Start-V2024IdentityProcessing -XSailPointExperimental $XSailPointExperimental -V2024ProcessIdentitiesRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024IdentityProcessing"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## synchronize-attributes-for-identity
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/synchronize-attributes-for-identity)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -572,10 +638,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Attribute synchronization for single identity.
try {
Sync-V2024hronizeAttributesForIdentity -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental
Sync-V2024hronizeAttributesForIdentity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Sync-V2024hronizeAttributesForIdentity -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental
# Sync-V2024hronizeAttributesForIdentity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2024hronizeAttributesForIdentity"
Write-Host $_.ErrorDetails

60
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityAttributesApi.md
View File

@@ -24,9 +24,15 @@ Method | HTTP request | Description
[**Get-V2024IdentityAttributes**](#list-identity-attributes) | **GET** `/identity-attributes` | List Identity Attributes
[**Send-V2024IdentityAttribute**](#put-identity-attribute) | **PUT** `/identity-attributes/{name}` | Update Identity Attribute
## create-identity-attribute
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Use this API to create a new identity attribute.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-identity-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -81,19 +87,25 @@ $IdentityAttribute = @"{
try {
$Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute
New-V2024IdentityAttribute -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result
New-V2024IdentityAttribute -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result
# Below is a request that includes all optional parameters
# New-V2024IdentityAttribute -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $IdentityAttribute
# New-V2024IdentityAttribute -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityAttribute"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-identity-attribute
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -126,19 +138,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Delete Identity Attribute
try {
Remove-V2024IdentityAttribute -V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental
Remove-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024IdentityAttribute -V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental
# Remove-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityAttribute"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-identity-attributes-in-bulk
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to 'false' before you can delete an identity attribute.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity-attributes-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -174,19 +192,25 @@ $IdentityAttributeNames = @"{
try {
$Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames
Remove-V2024IdentityAttributesInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttributeNames $Result
Remove-V2024IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttributeNames $Result
# Below is a request that includes all optional parameters
# Remove-V2024IdentityAttributesInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttributeNames $IdentityAttributeNames
# Remove-V2024IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttributeNames $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityAttributesInBulk"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-attribute
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This gets an identity attribute for a given technical name.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -219,19 +243,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get Identity Attribute
try {
Get-V2024IdentityAttribute -V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024IdentityAttribute -V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAttribute"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-identity-attributes
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Use this API to get a collection of identity attributes.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-attributes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -269,19 +299,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# List Identity Attributes
try {
Get-V2024IdentityAttributes -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024IdentityAttributes -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024IdentityAttributes -V2024XSailPointExperimental $XSailPointExperimental -V2024IncludeSystem $IncludeSystem -V2024IncludeSilent $IncludeSilent -V2024SearchableOnly $SearchableOnly -V2024Count $Count
# Get-V2024IdentityAttributes -XSailPointExperimental $XSailPointExperimental -IncludeSystem $IncludeSystem -IncludeSilent $IncludeSilent -SearchableOnly $SearchableOnly -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAttributes"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-identity-attribute
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-identity-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -338,10 +374,10 @@ $IdentityAttribute = @"{
try {
$Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute
Send-V2024IdentityAttribute -V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result
Send-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result
# Below is a request that includes all optional parameters
# Send-V2024IdentityAttribute -V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $IdentityAttribute
# Send-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024IdentityAttribute"
Write-Host $_.ErrorDetails

110
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityHistoryApi.md
View File

@@ -29,9 +29,15 @@ Method | HTTP request | Description
[**Get-V2024IdentitySnapshotAccessItems**](#list-identity-snapshot-access-items) | **GET** `/historical-identities/{id}/snapshots/{date}/access-items` | Gets the list of identity access items at a given date filterd by item type
[**Get-V2024IdentitySnapshots**](#list-identity-snapshots) | **GET** `/historical-identities/{id}/snapshots` | Lists all the snapshots for the identity
## compare-identity-snapshots
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read'
[API Spec](https://developer.sailpoint.com/docs/api/v2024/compare-identity-snapshots)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -77,19 +83,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Gets a difference of count for each access item types for the given identity between 2 snapshots
try {
Compare-V2024IdentitySnapshots -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Compare-V2024IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Compare-V2024IdentitySnapshots -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Snapshot1 $Snapshot1 -V2024Snapshot2 $Snapshot2 -V2024AccessItemTypes $AccessItemTypes -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count
# Compare-V2024IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2024IdentitySnapshots"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## compare-identity-snapshots-access-type
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read'
[API Spec](https://developer.sailpoint.com/docs/api/v2024/compare-identity-snapshots-access-type)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -135,19 +147,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Gets a list of differences of specific accessType for the given identity between 2 snapshots
try {
Compare-V2024IdentitySnapshotsAccessType -V2024Id $Id -V2024AccessType $AccessType -V2024XSailPointExperimental $XSailPointExperimental
Compare-V2024IdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Compare-V2024IdentitySnapshotsAccessType -V2024Id $Id -V2024AccessType $AccessType -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessAssociated $AccessAssociated -V2024Snapshot1 $Snapshot1 -V2024Snapshot2 $Snapshot2 -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count
# Compare-V2024IdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -XSailPointExperimental $XSailPointExperimental -AccessAssociated $AccessAssociated -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2024IdentitySnapshotsAccessType"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-historical-identity
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This method retrieves a specified identity Requires authorization scope of 'idn:identity-history:read'
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-historical-identity)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -179,19 +197,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get latest snapshot of identity
try {
Get-V2024HistoricalIdentity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024HistoricalIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024HistoricalIdentity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024HistoricalIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentity"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-historical-identity-events
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This method retrieves all access events for the identity Requires authorization scope of 'idn:identity-history:read'
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-historical-identity-events)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -240,19 +264,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Lists all events for the given identity
try {
Get-V2024HistoricalIdentityEvents -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024HistoricalIdentityEvents -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024HistoricalIdentityEvents -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024From $From -V2024EventTypes $EventTypes -V2024AccessItemTypes $AccessItemTypes -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count
# Get-V2024HistoricalIdentityEvents -Id $Id -XSailPointExperimental $XSailPointExperimental -From $From -EventTypes $EventTypes -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentityEvents"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-snapshot
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This method retrieves a specified identity snapshot at a given date Requires authorization scope of 'idn:identity-history:read'
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-snapshot)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -286,19 +316,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Gets an identity snapshot at a given date
try {
Get-V2024IdentitySnapshot -V2024Id $Id -V2024Date $Date -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024IdentitySnapshot -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024IdentitySnapshot -V2024Id $Id -V2024Date $Date -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024IdentitySnapshot -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshot"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-snapshot-summary
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of 'idn:identity-history:read'
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-snapshot-summary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -342,19 +378,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Gets the summary for the event count for a specific identity
try {
Get-V2024IdentitySnapshotSummary -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024IdentitySnapshotSummary -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024IdentitySnapshotSummary -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Before $Before -V2024Interval $Interval -V2024TimeZone $TimeZone -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count
# Get-V2024IdentitySnapshotSummary -Id $Id -XSailPointExperimental $XSailPointExperimental -Before $Before -Interval $Interval -TimeZone $TimeZone -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshotSummary"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-start-date
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This method retrieves start date of the identity Requires authorization scope of 'idn:identity-history:read'
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-start-date)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -386,19 +428,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Gets the start date of the identity
try {
Get-V2024IdentityStartDate -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024IdentityStartDate -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024IdentityStartDate -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024IdentityStartDate -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityStartDate"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-historical-identities
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of 'idn:identity-history:read'
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-historical-identities)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -438,20 +486,26 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
# Lists all the identities
try {
Get-V2024HistoricalIdentities -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024HistoricalIdentities -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024HistoricalIdentities -V2024XSailPointExperimental $XSailPointExperimental -V2024StartsWithQuery $StartsWithQuery -V2024IsDeleted $IsDeleted -V2024IsActive $IsActive -V2024Limit $Limit -V2024Offset $Offset
# Get-V2024HistoricalIdentities -XSailPointExperimental $XSailPointExperimental -StartsWithQuery $StartsWithQuery -IsDeleted $IsDeleted -IsActive $IsActive -Limit $Limit -Offset $Offset
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentities"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-identity-access-items
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This method retrieves a list of access item for the identity filtered by the access item type
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-access-items)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -492,19 +546,25 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
# List Access Items by Identity
try {
Get-V2024IdentityAccessItems -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024IdentityAccessItems -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024IdentityAccessItems -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Type $Type -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset
# Get-V2024IdentityAccessItems -Id $Id -XSailPointExperimental $XSailPointExperimental -Type $Type -Limit $Limit -Count $Count -Offset $Offset
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessItems"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-identity-snapshot-access-items
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of 'idn:identity-history:read'
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-snapshot-access-items)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -540,19 +600,25 @@ $Type = "account" # String | The access item type (optional)
# Gets the list of identity access items at a given date filterd by item type
try {
Get-V2024IdentitySnapshotAccessItems -V2024Id $Id -V2024Date $Date -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024IdentitySnapshotAccessItems -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024IdentitySnapshotAccessItems -V2024Id $Id -V2024Date $Date -V2024XSailPointExperimental $XSailPointExperimental -V2024Type $Type
# Get-V2024IdentitySnapshotAccessItems -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental -Type $Type
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshotAccessItems"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-identity-snapshots
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This method retrieves all the snapshots for the identity Requires authorization scope of 'idn:identity-history:read'
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-snapshots)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -594,10 +660,10 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Lists all the snapshots for the identity
try {
Get-V2024IdentitySnapshots -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024IdentitySnapshots -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Start $Start -V2024Interval $Interval -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count
# Get-V2024IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental -Start $Start -Interval $Interval -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshots"
Write-Host $_.ErrorDetails

77
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityProfilesApi.md
View File

@@ -39,9 +39,12 @@ Method | HTTP request | Description
[**Sync-V2024IdentityProfile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile
[**Update-V2024IdentityProfile**](#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/v2024/create-identity-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -120,16 +123,17 @@ $IdentityProfile = @"{
try {
$Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile
New-V2024IdentityProfile -V2024IdentityProfile $Result
New-V2024IdentityProfile -V2024IdentityProfile $Result
# Below is a request that includes all optional parameters
# New-V2024IdentityProfile -V2024IdentityProfile $IdentityProfile
# New-V2024IdentityProfile -V2024IdentityProfile $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityProfile"
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/v2024/delete-identity-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -168,16 +174,17 @@ $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity
# Delete an Identity Profile
try {
Remove-V2024IdentityProfile -V2024IdentityProfileId $IdentityProfileId
Remove-V2024IdentityProfile -IdentityProfileId $IdentityProfileId
# Below is a request that includes all optional parameters
# Remove-V2024IdentityProfile -V2024IdentityProfileId $IdentityProfileId
# Remove-V2024IdentityProfile -IdentityProfileId $IdentityProfileId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityProfile"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/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-V2024IdentityProfiles -V2024RequestBody $Result
Remove-V2024IdentityProfiles -RequestBody $Result
# Below is a request that includes all optional parameters
# Remove-V2024IdentityProfiles -V2024RequestBody $RequestBody
# Remove-V2024IdentityProfiles -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityProfiles"
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/v2024/export-identity-profiles)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -267,19 +279,22 @@ $Sorters = "id,name" # String | Sort results using the standard syntax described
# Export Identity Profiles
try {
Export-V2024IdentityProfiles
Export-V2024IdentityProfiles
# Below is a request that includes all optional parameters
# Export-V2024IdentityProfiles -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Export-V2024IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024IdentityProfiles"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-default-identity-attribute-config
This returns the default identity attribute config.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-default-identity-attribute-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -310,19 +325,22 @@ $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Ident
# Get default Identity Attribute Config
try {
Get-V2024DefaultIdentityAttributeConfig -V2024IdentityProfileId $IdentityProfileId
Get-V2024DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId
# Below is a request that includes all optional parameters
# Get-V2024DefaultIdentityAttributeConfig -V2024IdentityProfileId $IdentityProfileId
# Get-V2024DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultIdentityAttributeConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-profile
This returns a single Identity Profile based on ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -353,19 +371,22 @@ $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Ident
# Get single Identity Profile
try {
Get-V2024IdentityProfile -V2024IdentityProfileId $IdentityProfileId
Get-V2024IdentityProfile -IdentityProfileId $IdentityProfileId
# Below is a request that includes all optional parameters
# Get-V2024IdentityProfile -V2024IdentityProfileId $IdentityProfileId
# Get-V2024IdentityProfile -IdentityProfileId $IdentityProfileId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityProfile"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## import-identity-profiles
This imports previously exported identity profiles.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/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-V2024IdentityProfiles -V2024IdentityProfileExportedObject $Result
Import-V2024IdentityProfiles -V2024IdentityProfileExportedObject $Result
# Below is a request that includes all optional parameters
# Import-V2024IdentityProfiles -V2024IdentityProfileExportedObject $IdentityProfileExportedObject
# Import-V2024IdentityProfiles -V2024IdentityProfileExportedObject $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024IdentityProfiles"
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/v2024/list-identity-profiles)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -508,20 +532,23 @@ $Sorters = "id,name" # String | Sort results using the standard syntax described
# Identity Profiles List
try {
Get-V2024IdentityProfiles
Get-V2024IdentityProfiles
# Below is a request that includes all optional parameters
# Get-V2024IdentityProfiles -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityProfiles"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/show-identity-preview)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -578,16 +605,17 @@ $IdentityPreviewRequest = @"{
try {
$Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest
Show-V2024IdentityPreview -V2024IdentityPreviewRequest $Result
Show-V2024IdentityPreview -V2024IdentityPreviewRequest $Result
# Below is a request that includes all optional parameters
# Show-V2024IdentityPreview -V2024IdentityPreviewRequest $IdentityPreviewRequest
# Show-V2024IdentityPreview -V2024IdentityPreviewRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2024IdentityPreview"
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/v2024/sync-identity-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -625,16 +655,17 @@ $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity
# Process identities under profile
try {
Sync-V2024IdentityProfile -V2024IdentityProfileId $IdentityProfileId
Sync-V2024IdentityProfile -IdentityProfileId $IdentityProfileId
# Below is a request that includes all optional parameters
# Sync-V2024IdentityProfile -V2024IdentityProfileId $IdentityProfileId
# Sync-V2024IdentityProfile -IdentityProfileId $IdentityProfileId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2024IdentityProfile"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/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-V2024IdentityProfile -V2024IdentityProfileId $IdentityProfileId -V2024JsonPatchOperation $Result
Update-V2024IdentityProfile -IdentityProfileId $IdentityProfileId -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024IdentityProfile -V2024IdentityProfileId $IdentityProfileId -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024IdentityProfile -IdentityProfileId $IdentityProfileId -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024IdentityProfile"
Write-Host $_.ErrorDetails

42
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024LifecycleStatesApi.md
View File

@@ -62,9 +62,12 @@ Method | HTTP request | Description
[**Set-V2024LifecycleState**](#set-lifecycle-state) | **POST** `/identities/{identity-id}/set-lifecycle-state` | Set Lifecycle State
[**Update-V2024LifecycleStates**](#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/v2024/create-lifecycle-state)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -121,19 +124,22 @@ $LifecycleState = @"{
try {
$Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState
New-V2024LifecycleState -V2024IdentityProfileId $IdentityProfileId -V2024LifecycleState $Result
New-V2024LifecycleState -IdentityProfileId $IdentityProfileId -V2024LifecycleState $Result
# Below is a request that includes all optional parameters
# New-V2024LifecycleState -V2024IdentityProfileId $IdentityProfileId -V2024LifecycleState $LifecycleState
# New-V2024LifecycleState -IdentityProfileId $IdentityProfileId -V2024LifecycleState $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024LifecycleState"
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/v2024/delete-lifecycle-state)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -166,19 +172,22 @@ $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle stat
# Delete Lifecycle State
try {
Remove-V2024LifecycleState -V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId
Remove-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
# Below is a request that includes all optional parameters
# Remove-V2024LifecycleState -V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId
# Remove-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024LifecycleState"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-lifecycle-state)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -211,19 +220,22 @@ $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle stat
# Get Lifecycle State
try {
Get-V2024LifecycleState -V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId
Get-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
# Below is a request that includes all optional parameters
# Get-V2024LifecycleState -V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId
# Get-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024LifecycleState"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-lifecycle-states)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -261,19 +273,22 @@ $Sorters = "created,modified" # String | Sort results using the standard syntax
# Lists LifecycleStates
try {
Get-V2024LifecycleStates -V2024IdentityProfileId $IdentityProfileId
Get-V2024LifecycleStates -IdentityProfileId $IdentityProfileId
# Below is a request that includes all optional parameters
# Get-V2024LifecycleStates -V2024IdentityProfileId $IdentityProfileId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters
# Get-V2024LifecycleStates -IdentityProfileId $IdentityProfileId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024LifecycleStates"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/set-lifecycle-state)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -307,19 +322,22 @@ $SetLifecycleStateRequest = @""@
try {
$Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest
Set-V2024LifecycleState -V2024IdentityId $IdentityId -V2024SetLifecycleStateRequest $Result
Set-V2024LifecycleState -IdentityId $IdentityId -V2024SetLifecycleStateRequest $Result
# Below is a request that includes all optional parameters
# Set-V2024LifecycleState -V2024IdentityId $IdentityId -V2024SetLifecycleStateRequest $SetLifecycleStateRequest
# Set-V2024LifecycleState -IdentityId $IdentityId -V2024SetLifecycleStateRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024LifecycleState"
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/v2024/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-V2024LifecycleStates -V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId -V2024JsonPatchOperation $Result
Update-V2024LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024LifecycleStates -V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024LifecycleStates"
Write-Host $_.ErrorDetails

45
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MFAConfigurationApi.md
View File

@@ -25,9 +25,12 @@ Method | HTTP request | Description
[**Set-V2024MFAOktaConfig**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set Okta MFA configuration
[**Test-V2024MFAConfig**](#test-mfa-config) | **GET** `/mfa/{method}/test` | MFA method's test configuration
## get-mfa-duo-config
This API returns the configuration of an Duo MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-mfa-duo-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -55,7 +58,7 @@ Code | Description | Data Type
# Configuration of Duo MFA method
try {
Get-V2024MFADuoConfig
Get-V2024MFADuoConfig
# Below is a request that includes all optional parameters
# Get-V2024MFADuoConfig
@@ -65,9 +68,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/v2024/get-mfa-kba-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -97,19 +103,22 @@ $AllLanguages = $false # Boolean | Indicator whether the question text should be
# Configuration of KBA MFA method
try {
Get-V2024MFAKbaConfig
Get-V2024MFAKbaConfig
# Below is a request that includes all optional parameters
# Get-V2024MFAKbaConfig -V2024AllLanguages $AllLanguages
# Get-V2024MFAKbaConfig -AllLanguages $AllLanguages
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAKbaConfig"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-mfa-okta-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -137,7 +146,7 @@ Code | Description | Data Type
# Configuration of Okta MFA method
try {
Get-V2024MFAOktaConfig
Get-V2024MFAOktaConfig
# Below is a request that includes all optional parameters
# Get-V2024MFAOktaConfig
@@ -147,9 +156,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/v2024/set-mfa-duo-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -190,19 +202,22 @@ $MfaDuoConfig = @"{
try {
$Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig
Set-V2024MFADuoConfig -V2024MfaDuoConfig $Result
Set-V2024MFADuoConfig -V2024MfaDuoConfig $Result
# Below is a request that includes all optional parameters
# Set-V2024MFADuoConfig -V2024MfaDuoConfig $MfaDuoConfig
# Set-V2024MFADuoConfig -V2024MfaDuoConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFADuoConfig"
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/v2024/set-mfakba-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -237,19 +252,22 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem
Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $Result
Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $Result
# Below is a request that includes all optional parameters
# Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $KbaAnswerRequestItem
# Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAKBAConfig"
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/v2024/set-mfa-okta-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -286,19 +304,22 @@ $MfaOktaConfig = @"{
try {
$Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig
Set-V2024MFAOktaConfig -V2024MfaOktaConfig $Result
Set-V2024MFAOktaConfig -V2024MfaOktaConfig $Result
# Below is a request that includes all optional parameters
# Set-V2024MFAOktaConfig -V2024MfaOktaConfig $MfaOktaConfig
# Set-V2024MFAOktaConfig -V2024MfaOktaConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAOktaConfig"
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/v2024/test-mfa-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -328,10 +349,10 @@ $Method = "okta-verify" # String | The name of the MFA method. The currently sup
# MFA method's test configuration
try {
Test-V2024MFAConfig -V2024Method $Method
Test-V2024MFAConfig -Method $Method
# Below is a request that includes all optional parameters
# Test-V2024MFAConfig -V2024Method $Method
# Test-V2024MFAConfig -Method $Method
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024MFAConfig"
Write-Host $_.ErrorDetails

42
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClientsApi.md
View File

@@ -26,10 +26,13 @@ Method | HTTP request | Description
[**Get-V2024ManagedClients**](#get-managed-clients) | **GET** `/managed-clients` | Get Managed Clients
[**Update-V2024ManagedClient**](#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/v2024/create-managed-client)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -65,19 +68,22 @@ $ManagedClientRequest = @"{
try {
$Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest
New-V2024ManagedClient -V2024ManagedClientRequest $Result
New-V2024ManagedClient -V2024ManagedClientRequest $Result
# Below is a request that includes all optional parameters
# New-V2024ManagedClient -V2024ManagedClientRequest $ManagedClientRequest
# New-V2024ManagedClient -V2024ManagedClientRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedClient"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-managed-client
Delete an existing managed client.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-managed-client)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -107,19 +113,22 @@ $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID.
# Delete Managed Client
try {
Remove-V2024ManagedClient -V2024Id $Id
Remove-V2024ManagedClient -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024ManagedClient -V2024Id $Id
# Remove-V2024ManagedClient -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedClient"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-managed-client
Get managed client by ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-client)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -150,19 +159,22 @@ $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID.
# Get Managed Client
try {
Get-V2024ManagedClient -V2024Id $Id
Get-V2024ManagedClient -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024ManagedClient -V2024Id $Id
# Get-V2024ManagedClient -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClient"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-managed-client-status
Get a managed client's status, using its ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-client-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -195,19 +207,22 @@ $Type = "CCG" # ManagedClientType | Managed client type to get status for.
# Get Managed Client Status
try {
Get-V2024ManagedClientStatus -V2024Id $Id -V2024Type $Type
Get-V2024ManagedClientStatus -Id $Id -Type $Type
# Below is a request that includes all optional parameters
# Get-V2024ManagedClientStatus -V2024Id $Id -V2024Type $Type
# Get-V2024ManagedClientStatus -Id $Id -Type $Type
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClientStatus"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-managed-clients
List managed clients.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-clients)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -243,19 +258,22 @@ $Filters = 'name eq "client name"' # String | Filter results using the standard
# Get Managed Clients
try {
Get-V2024ManagedClients
Get-V2024ManagedClients
# Below is a request that includes all optional parameters
# Get-V2024ManagedClients -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters
# Get-V2024ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClients"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-managed-client
Update an existing managed client.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/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-V2024ManagedClient -V2024Id $Id -V2024JsonPatchOperation $Result
Update-V2024ManagedClient -Id $Id -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024ManagedClient -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024ManagedClient -Id $Id -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClient"
Write-Host $_.ErrorDetails

49
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClustersApi.md
View File

@@ -27,10 +27,13 @@ Method | HTTP request | Description
[**Send-V2024ClientLogConfiguration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update Managed Cluster Log Configuration
[**Update-V2024ManagedCluster**](#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/v2024/create-managed-cluster)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -69,19 +72,22 @@ $ManagedClusterRequest = @"{
try {
$Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest
New-V2024ManagedCluster -V2024ManagedClusterRequest $Result
New-V2024ManagedCluster -V2024ManagedClusterRequest $Result
# Below is a request that includes all optional parameters
# New-V2024ManagedCluster -V2024ManagedClusterRequest $ManagedClusterRequest
# New-V2024ManagedCluster -V2024ManagedClusterRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedCluster"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-managed-cluster
Delete an existing managed cluster.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-managed-cluster)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -113,19 +119,22 @@ $RemoveClients = $false # Boolean | Flag to determine the need to delete a clust
# Delete Managed Cluster
try {
Remove-V2024ManagedCluster -V2024Id $Id
Remove-V2024ManagedCluster -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024ManagedCluster -V2024Id $Id -V2024RemoveClients $RemoveClients
# Remove-V2024ManagedCluster -Id $Id -RemoveClients $RemoveClients
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedCluster"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-client-log-configuration
Get a managed cluster's log configuration.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-client-log-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -157,19 +166,22 @@ $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to
# Get Managed Cluster Log Configuration
try {
Get-V2024ClientLogConfiguration -V2024Id $Id
Get-V2024ClientLogConfiguration -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024ClientLogConfiguration -V2024Id $Id
# Get-V2024ClientLogConfiguration -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ClientLogConfiguration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-managed-cluster
Get a managed cluster by ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-cluster)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -200,19 +212,22 @@ $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID.
# Get Managed Cluster
try {
Get-V2024ManagedCluster -V2024Id $Id
Get-V2024ManagedCluster -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024ManagedCluster -V2024Id $Id
# Get-V2024ManagedCluster -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedCluster"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-managed-clusters
List current organization's managed clusters, based on request context.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-clusters)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -248,19 +263,22 @@ $Filters = 'operational eq "operation"' # String | Filter results using the stan
# Get Managed Clusters
try {
Get-V2024ManagedClusters
Get-V2024ManagedClusters
# Below is a request that includes all optional parameters
# Get-V2024ManagedClusters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters
# Get-V2024ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusters"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/put-client-log-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -294,19 +312,22 @@ $PutClientLogConfigurationRequest = @""@
try {
$Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest
Send-V2024ClientLogConfiguration -V2024Id $Id -V2024PutClientLogConfigurationRequest $Result
Send-V2024ClientLogConfiguration -Id $Id -V2024PutClientLogConfigurationRequest $Result
# Below is a request that includes all optional parameters
# Send-V2024ClientLogConfiguration -V2024Id $Id -V2024PutClientLogConfigurationRequest $PutClientLogConfigurationRequest
# Send-V2024ClientLogConfiguration -Id $Id -V2024PutClientLogConfigurationRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ClientLogConfiguration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-managed-cluster
Update an existing managed cluster.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/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-V2024ManagedCluster -V2024Id $Id -V2024JsonPatchOperation $Result
Update-V2024ManagedCluster -Id $Id -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024ManagedCluster -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024ManagedCluster -Id $Id -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedCluster"
Write-Host $_.ErrorDetails

224
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NonEmployeeLifecycleManagementApi.md
View File

@@ -81,9 +81,12 @@ Method | HTTP request | Description
[**Deny-V2024NonEmployeeRequest**](#reject-non-employee-request) | **POST** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request
[**Update-V2024NonEmployeeRecord**](#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/v2024/approve-non-employee-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -118,20 +121,23 @@ $NonEmployeeApprovalDecision = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision
Approve-V2024NonEmployeeRequest -V2024Id $Id -V2024NonEmployeeApprovalDecision $Result
Approve-V2024NonEmployeeRequest -Id $Id -V2024NonEmployeeApprovalDecision $Result
# Below is a request that includes all optional parameters
# Approve-V2024NonEmployeeRequest -V2024Id $Id -V2024NonEmployeeApprovalDecision $NonEmployeeApprovalDecision
# Approve-V2024NonEmployeeRequest -Id $Id -V2024NonEmployeeApprovalDecision $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024NonEmployeeRequest"
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/v2024/create-non-employee-record)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -175,19 +181,22 @@ $NonEmployeeRequestBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody
New-V2024NonEmployeeRecord -V2024NonEmployeeRequestBody $Result
New-V2024NonEmployeeRecord -V2024NonEmployeeRequestBody $Result
# Below is a request that includes all optional parameters
# New-V2024NonEmployeeRecord -V2024NonEmployeeRequestBody $NonEmployeeRequestBody
# New-V2024NonEmployeeRecord -V2024NonEmployeeRequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRecord"
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/v2024/create-non-employee-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -231,19 +240,22 @@ $NonEmployeeRequestBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody
New-V2024NonEmployeeRequest -V2024NonEmployeeRequestBody $Result
New-V2024NonEmployeeRequest -V2024NonEmployeeRequestBody $Result
# Below is a request that includes all optional parameters
# New-V2024NonEmployeeRequest -V2024NonEmployeeRequestBody $NonEmployeeRequestBody
# New-V2024NonEmployeeRequest -V2024NonEmployeeRequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRequest"
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/v2024/create-non-employee-source)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -299,20 +311,23 @@ $NonEmployeeSourceRequestBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody
New-V2024NonEmployeeSource -V2024NonEmployeeSourceRequestBody $Result
New-V2024NonEmployeeSource -V2024NonEmployeeSourceRequestBody $Result
# Below is a request that includes all optional parameters
# New-V2024NonEmployeeSource -V2024NonEmployeeSourceRequestBody $NonEmployeeSourceRequestBody
# New-V2024NonEmployeeSource -V2024NonEmployeeSourceRequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeSource"
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/v2024/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-V2024NonEmployeeSourceSchemaAttributes -V2024SourceId $SourceId -V2024NonEmployeeSchemaAttributeBody $Result
New-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId -V2024NonEmployeeSchemaAttributeBody $Result
# Below is a request that includes all optional parameters
# New-V2024NonEmployeeSourceSchemaAttributes -V2024SourceId $SourceId -V2024NonEmployeeSchemaAttributeBody $NonEmployeeSchemaAttributeBody
# New-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId -V2024NonEmployeeSchemaAttributeBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeSourceSchemaAttributes"
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/v2024/delete-non-employee-record)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -395,19 +413,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID
# Delete Non-Employee Record
try {
Remove-V2024NonEmployeeRecord -V2024Id $Id
Remove-V2024NonEmployeeRecord -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024NonEmployeeRecord -V2024Id $Id
# Remove-V2024NonEmployeeRecord -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRecord"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/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-V2024NonEmployeeRecordsInBulk -V2024DeleteNonEmployeeRecordsInBulkRequest $Result
Remove-V2024NonEmployeeRecordsInBulk -V2024DeleteNonEmployeeRecordsInBulkRequest $Result
# Below is a request that includes all optional parameters
# Remove-V2024NonEmployeeRecordsInBulk -V2024DeleteNonEmployeeRecordsInBulkRequest $DeleteNonEmployeeRecordsInBulkRequest
# Remove-V2024NonEmployeeRecordsInBulk -V2024DeleteNonEmployeeRecordsInBulkRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRecordsInBulk"
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/v2024/delete-non-employee-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -482,21 +506,24 @@ $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id
# Delete Non-Employee Request
try {
Remove-V2024NonEmployeeRequest -V2024Id $Id
Remove-V2024NonEmployeeRequest -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024NonEmployeeRequest -V2024Id $Id
# Remove-V2024NonEmployeeRequest -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRequest"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/delete-non-employee-schema-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -528,19 +555,22 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
# Delete a Schema Attribute for Non-Employee Source
try {
Remove-V2024NonEmployeeSchemaAttribute -V2024AttributeId $AttributeId -V2024SourceId $SourceId
Remove-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
# Below is a request that includes all optional parameters
# Remove-V2024NonEmployeeSchemaAttribute -V2024AttributeId $AttributeId -V2024SourceId $SourceId
# Remove-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeSchemaAttribute"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/delete-non-employee-source)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -570,19 +600,22 @@ $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id
# Delete Non-Employee Source
try {
Remove-V2024NonEmployeeSource -V2024SourceId $SourceId
Remove-V2024NonEmployeeSource -SourceId $SourceId
# Below is a request that includes all optional parameters
# Remove-V2024NonEmployeeSource -V2024SourceId $SourceId
# Remove-V2024NonEmployeeSource -SourceId $SourceId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeSource"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/delete-non-employee-source-schema-attributes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -612,19 +645,22 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
# Delete all custom schema attributes for Non-Employee Source
try {
Remove-V2024NonEmployeeSourceSchemaAttributes -V2024SourceId $SourceId
Remove-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId
# Below is a request that includes all optional parameters
# Remove-V2024NonEmployeeSourceSchemaAttributes -V2024SourceId $SourceId
# Remove-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeSourceSchemaAttributes"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/export-non-employee-records)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -655,19 +691,22 @@ $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID)
# Exports Non-Employee Records to CSV
try {
Export-V2024NonEmployeeRecords -V2024Id $Id
Export-V2024NonEmployeeRecords -Id $Id
# Below is a request that includes all optional parameters
# Export-V2024NonEmployeeRecords -V2024Id $Id
# Export-V2024NonEmployeeRecords -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024NonEmployeeRecords"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/export-non-employee-source-schema-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -698,22 +737,25 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID)
# Exports Source Schema Template
try {
Export-V2024NonEmployeeSourceSchemaTemplate -V2024Id $Id
Export-V2024NonEmployeeSourceSchemaTemplate -Id $Id
# Below is a request that includes all optional parameters
# Export-V2024NonEmployeeSourceSchemaTemplate -V2024Id $Id
# Export-V2024NonEmployeeSourceSchemaTemplate -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024NonEmployeeSourceSchemaTemplate"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-non-employee-approval)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -745,16 +787,17 @@ $IncludeDetail = $true # Boolean | The object nonEmployeeRequest will not be inc
# Get a non-employee approval item detail
try {
Get-V2024NonEmployeeApproval -V2024Id $Id
Get-V2024NonEmployeeApproval -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024NonEmployeeApproval -V2024Id $Id -V2024IncludeDetail $IncludeDetail
# Get-V2024NonEmployeeApproval -Id $Id -IncludeDetail $IncludeDetail
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeApproval"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-non-employee-approval-summary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -791,21 +836,24 @@ $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID
# Get Summary of Non-Employee Approval Requests
try {
Get-V2024NonEmployeeApprovalSummary -V2024RequestedFor $RequestedFor
Get-V2024NonEmployeeApprovalSummary -RequestedFor $RequestedFor
# Below is a request that includes all optional parameters
# Get-V2024NonEmployeeApprovalSummary -V2024RequestedFor $RequestedFor
# Get-V2024NonEmployeeApprovalSummary -RequestedFor $RequestedFor
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeApprovalSummary"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-non-employee-bulk-upload-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -835,20 +883,23 @@ $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source ID (UUID)
# Obtain the status of bulk upload on the source
try {
Get-V2024NonEmployeeBulkUploadStatus -V2024Id $Id
Get-V2024NonEmployeeBulkUploadStatus -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024NonEmployeeBulkUploadStatus -V2024Id $Id
# Get-V2024NonEmployeeBulkUploadStatus -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeBulkUploadStatus"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-non-employee-record)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -878,16 +929,17 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID
# Get a Non-Employee Record
try {
Get-V2024NonEmployeeRecord -V2024Id $Id
Get-V2024NonEmployeeRecord -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024NonEmployeeRecord -V2024Id $Id
# Get-V2024NonEmployeeRecord -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRecord"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-non-employee-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -925,16 +979,17 @@ $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id
# Get a Non-Employee Request
try {
Get-V2024NonEmployeeRequest -V2024Id $Id
Get-V2024NonEmployeeRequest -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024NonEmployeeRequest -V2024Id $Id
# Get-V2024NonEmployeeRequest -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRequest"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-non-employee-request-summary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -971,19 +1028,22 @@ $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID
# Get Summary of Non-Employee Requests
try {
Get-V2024NonEmployeeRequestSummary -V2024RequestedFor $RequestedFor
Get-V2024NonEmployeeRequestSummary -RequestedFor $RequestedFor
# Below is a request that includes all optional parameters
# Get-V2024NonEmployeeRequestSummary -V2024RequestedFor $RequestedFor
# Get-V2024NonEmployeeRequestSummary -RequestedFor $RequestedFor
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRequestSummary"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-non-employee-schema-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1015,16 +1075,17 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
# Get Schema Attribute Non-Employee Source
try {
Get-V2024NonEmployeeSchemaAttribute -V2024AttributeId $AttributeId -V2024SourceId $SourceId
Get-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-V2024NonEmployeeSchemaAttribute -V2024AttributeId $AttributeId -V2024SourceId $SourceId
# Get-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSchemaAttribute"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-non-employee-source)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1061,20 +1124,23 @@ $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id
# Get a Non-Employee Source
try {
Get-V2024NonEmployeeSource -V2024SourceId $SourceId
Get-V2024NonEmployeeSource -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-V2024NonEmployeeSource -V2024SourceId $SourceId
# Get-V2024NonEmployeeSource -SourceId $SourceId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSource"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-non-employee-source-schema-attributes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1105,19 +1171,22 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
# List Schema Attributes Non-Employee Source
try {
Get-V2024NonEmployeeSourceSchemaAttributes -V2024SourceId $SourceId
Get-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-V2024NonEmployeeSourceSchemaAttributes -V2024SourceId $SourceId
# Get-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSourceSchemaAttributes"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/import-non-employee-records-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1150,16 +1219,17 @@ $Data = # System.IO.FileInfo |
# Imports, or Updates, Non-Employee Records
try {
Import-V2024NonEmployeeRecordsInBulk -V2024Id $Id -V2024Data $Data
Import-V2024NonEmployeeRecordsInBulk -Id $Id -Data $Data
# Below is a request that includes all optional parameters
# Import-V2024NonEmployeeRecordsInBulk -V2024Id $Id -V2024Data $Data
# Import-V2024NonEmployeeRecordsInBulk -Id $Id -Data $Data
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024NonEmployeeRecordsInBulk"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/list-non-employee-approvals)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1206,21 +1278,24 @@ $Sorters = "created" # String | Sort results using the standard syntax described
# Get List of Non-Employee Approval Requests
try {
Get-V2024NonEmployeeApprovals
Get-V2024NonEmployeeApprovals
# Below is a request that includes all optional parameters
# Get-V2024NonEmployeeApprovals -V2024RequestedFor $RequestedFor -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024NonEmployeeApprovals -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeApprovals"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/list-non-employee-records)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1258,16 +1333,17 @@ $Filters = 'sourceId eq "2c91808568c529c60168cca6f90c1313"' # String | Filter re
# List Non-Employee Records
try {
Get-V2024NonEmployeeRecords
Get-V2024NonEmployeeRecords
# Below is a request that includes all optional parameters
# Get-V2024NonEmployeeRecords -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters
# Get-V2024NonEmployeeRecords -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRecords"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/list-non-employee-requests)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1314,16 +1392,17 @@ $Filters = 'sourceId eq "2c91808568c529c60168cca6f90c1313"' # String | Filter re
# List Non-Employee Requests
try {
Get-V2024NonEmployeeRequests -V2024RequestedFor $RequestedFor
Get-V2024NonEmployeeRequests -RequestedFor $RequestedFor
# Below is a request that includes all optional parameters
# Get-V2024NonEmployeeRequests -V2024RequestedFor $RequestedFor -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters
# Get-V2024NonEmployeeRequests -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRequests"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/list-non-employee-sources)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1370,16 +1451,17 @@ $Sorters = "name,created" # String | Sort results using the standard syntax desc
# List Non-Employee Sources
try {
Get-V2024NonEmployeeSources -V2024RequestedFor $RequestedFor
Get-V2024NonEmployeeSources -RequestedFor $RequestedFor
# Below is a request that includes all optional parameters
# Get-V2024NonEmployeeSources -V2024RequestedFor $RequestedFor -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024NonEmployeeCount $NonEmployeeCount -V2024Sorters $Sorters
# Get-V2024NonEmployeeSources -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSources"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/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-V2024NonEmployeeRecord -V2024Id $Id -V2024JsonPatchOperation $Result
Update-V2024NonEmployeeRecord -Id $Id -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024NonEmployeeRecord -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024NonEmployeeRecord -Id $Id -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeRecord"
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/v2024/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-V2024NonEmployeeSchemaAttribute -V2024AttributeId $AttributeId -V2024SourceId $SourceId -V2024JsonPatchOperation $Result
Update-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024NonEmployeeSchemaAttribute -V2024AttributeId $AttributeId -V2024SourceId $SourceId -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeSchemaAttribute"
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/v2024/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-V2024NonEmployeeSource -V2024SourceId $SourceId -V2024JsonPatchOperation $Result
Update-V2024NonEmployeeSource -SourceId $SourceId -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024NonEmployeeSource -V2024SourceId $SourceId -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024NonEmployeeSource -SourceId $SourceId -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeSource"
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/v2024/reject-non-employee-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1577,16 +1670,17 @@ $NonEmployeeRejectApprovalDecision = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision
Deny-V2024NonEmployeeRequest -V2024Id $Id -V2024NonEmployeeRejectApprovalDecision $Result
Deny-V2024NonEmployeeRequest -Id $Id -V2024NonEmployeeRejectApprovalDecision $Result
# Below is a request that includes all optional parameters
# Deny-V2024NonEmployeeRequest -V2024Id $Id -V2024NonEmployeeRejectApprovalDecision $NonEmployeeRejectApprovalDecision
# Deny-V2024NonEmployeeRequest -Id $Id -V2024NonEmployeeRejectApprovalDecision $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024NonEmployeeRequest"
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/v2024/update-non-employee-record)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1640,10 +1736,10 @@ $NonEmployeeRequestBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody
Update-V2024NonEmployeeRecord -V2024Id $Id -V2024NonEmployeeRequestBody $Result
Update-V2024NonEmployeeRecord -Id $Id -V2024NonEmployeeRequestBody $Result
# Below is a request that includes all optional parameters
# Update-V2024NonEmployeeRecord -V2024Id $Id -V2024NonEmployeeRequestBody $NonEmployeeRequestBody
# Update-V2024NonEmployeeRecord -Id $Id -V2024NonEmployeeRequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeRecord"
Write-Host $_.ErrorDetails

150
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NotificationsApi.md
View File

@@ -33,9 +33,15 @@ Method | HTTP request | Description
[**Send-V2024MailFromAttributes**](#put-mail-from-attributes) | **PUT** `/mail-from-attributes` | Change MAIL FROM domain
[**Send-V2024TestNotification**](#send-test-notification) | **POST** `/send-test-notification` | Send Test Notification
## create-domain-dkim
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Create a domain to be verified via DKIM (DomainKeys Identified Mail)
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-domain-dkim)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -71,21 +77,27 @@ $DomainAddress = @"{
try {
$Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress
New-V2024DomainDkim -V2024XSailPointExperimental $XSailPointExperimental -V2024DomainAddress $Result
New-V2024DomainDkim -XSailPointExperimental $XSailPointExperimental -V2024DomainAddress $Result
# Below is a request that includes all optional parameters
# New-V2024DomainDkim -V2024XSailPointExperimental $XSailPointExperimental -V2024DomainAddress $DomainAddress
# New-V2024DomainDkim -XSailPointExperimental $XSailPointExperimental -V2024DomainAddress $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DomainDkim"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-notification-template
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This creates a template for your site.
You can also use this endpoint to update a template. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-notification-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -135,19 +147,25 @@ $TemplateDto = @"{
try {
$Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto
New-V2024NotificationTemplate -V2024XSailPointExperimental $XSailPointExperimental -V2024TemplateDto $Result
New-V2024NotificationTemplate -XSailPointExperimental $XSailPointExperimental -V2024TemplateDto $Result
# Below is a request that includes all optional parameters
# New-V2024NotificationTemplate -V2024XSailPointExperimental $XSailPointExperimental -V2024TemplateDto $TemplateDto
# New-V2024NotificationTemplate -XSailPointExperimental $XSailPointExperimental -V2024TemplateDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NotificationTemplate"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-verified-from-address
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Create a new sender email address and initiate verification process.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-verified-from-address)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -185,19 +203,25 @@ $EmailStatusDto = @"{
try {
$Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto
New-V2024VerifiedFromAddress -V2024XSailPointExperimental $XSailPointExperimental -V2024EmailStatusDto $Result
New-V2024VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -V2024EmailStatusDto $Result
# Below is a request that includes all optional parameters
# New-V2024VerifiedFromAddress -V2024XSailPointExperimental $XSailPointExperimental -V2024EmailStatusDto $EmailStatusDto
# New-V2024VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -V2024EmailStatusDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024VerifiedFromAddress"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-notification-templates-in-bulk
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This lets you bulk delete templates that you previously created for your site. Since this is a beta feature, please contact support to enable usage.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-notification-templates-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -235,19 +259,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto
Remove-V2024NotificationTemplatesInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024TemplateBulkDeleteDto $Result
Remove-V2024NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -V2024TemplateBulkDeleteDto $Result
# Below is a request that includes all optional parameters
# Remove-V2024NotificationTemplatesInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024TemplateBulkDeleteDto $TemplateBulkDeleteDto
# Remove-V2024NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -V2024TemplateBulkDeleteDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NotificationTemplatesInBulk"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-verified-from-address
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Delete a verified sender email address
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-verified-from-address)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -280,19 +310,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Delete Verified From Address
try {
Remove-V2024VerifiedFromAddress -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Remove-V2024VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024VerifiedFromAddress -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Remove-V2024VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024VerifiedFromAddress"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-dkim-attributes
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants' AWS SES identities. Limits retrieval to 100 identities per call.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-dkim-attributes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -322,19 +358,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get DKIM Attributes
try {
Get-V2024DkimAttributes -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024DkimAttributes -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024DkimAttributes -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024DkimAttributes -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DkimAttributes"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-mail-from-attributes
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Retrieve MAIL FROM attributes for a given AWS SES identity.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-mail-from-attributes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -366,19 +408,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get MAIL FROM Attributes
try {
Get-V2024MailFromAttributes -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024MailFromAttributes -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MailFromAttributes"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-notification-template
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This gets a template that you have modified for your site by Id.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-notification-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -410,20 +458,26 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get Notification Template By Id
try {
Get-V2024NotificationTemplate -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024NotificationTemplate -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplate"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-notifications-template-context
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called "Global Context" (a.k.a. notification template context). It defines a set of attributes
that will be available per tenant (organization).
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-notifications-template-context)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -453,19 +507,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get Notification Template Context
try {
Get-V2024NotificationsTemplateContext -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024NotificationsTemplateContext -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationsTemplateContext"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-from-addresses
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Retrieve a list of sender email addresses and their verification statuses
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-from-addresses)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -504,19 +564,25 @@ $Sorters = "email" # String | Sort results using the standard syntax described i
# List From Addresses
try {
Get-V2024FromAddresses -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024FromAddresses -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024FromAddresses -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024FromAddresses -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FromAddresses"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-notification-preferences
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Returns a list of notification preferences for tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-notification-preferences)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -547,19 +613,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# List Notification Preferences for tenant.
try {
Get-V2024NotificationPreferences -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024NotificationPreferences -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024NotificationPreferences -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024NotificationPreferences -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationPreferences"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-notification-template-defaults
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This lists the default templates used for notifications, such as emails from IdentityNow.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-notification-template-defaults)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -595,19 +667,25 @@ $Filters = 'key eq "cloud_manual_work_item_summary"' # String | Filter results u
# List Notification Template Defaults
try {
Get-V2024NotificationTemplateDefaults -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024NotificationTemplateDefaults -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters
# Get-V2024NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplateDefaults"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-notification-templates
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This lists the templates that you have modified for your site.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-notification-templates)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -643,19 +721,25 @@ $Filters = 'medium eq "EMAIL"' # String | Filter results using the standard synt
# List Notification Templates
try {
Get-V2024NotificationTemplates -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024NotificationTemplates -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024NotificationTemplates -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters
# Get-V2024NotificationTemplates -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplates"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-mail-from-attributes
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller's DNS
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-mail-from-attributes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -691,19 +775,25 @@ $MailFromAttributesDto = @"{
try {
$Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto
Send-V2024MailFromAttributes -V2024XSailPointExperimental $XSailPointExperimental -V2024MailFromAttributesDto $Result
Send-V2024MailFromAttributes -XSailPointExperimental $XSailPointExperimental -V2024MailFromAttributesDto $Result
# Below is a request that includes all optional parameters
# Send-V2024MailFromAttributes -V2024XSailPointExperimental $XSailPointExperimental -V2024MailFromAttributesDto $MailFromAttributesDto
# Send-V2024MailFromAttributes -XSailPointExperimental $XSailPointExperimental -V2024MailFromAttributesDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024MailFromAttributes"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## send-test-notification
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Send a Test Notification
[API Spec](https://developer.sailpoint.com/docs/api/v2024/send-test-notification)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -741,10 +831,10 @@ $SendTestNotificationRequestDto = @"{
try {
$Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto
Send-V2024TestNotification -V2024XSailPointExperimental $XSailPointExperimental -V2024SendTestNotificationRequestDto $Result
Send-V2024TestNotification -XSailPointExperimental $XSailPointExperimental -V2024SendTestNotificationRequestDto $Result
# Below is a request that includes all optional parameters
# Send-V2024TestNotification -V2024XSailPointExperimental $XSailPointExperimental -V2024SendTestNotificationRequestDto $SendTestNotificationRequestDto
# Send-V2024TestNotification -XSailPointExperimental $XSailPointExperimental -V2024SendTestNotificationRequestDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TestNotification"
Write-Host $_.ErrorDetails

35
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024OAuthClientsApi.md
View File

@@ -26,9 +26,12 @@ Method | HTTP request | Description
[**Get-V2024OauthClients**](#list-oauth-clients) | **GET** `/oauth-clients` | List OAuth Clients
[**Update-V2024OauthClient**](#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/v2024/create-oauth-client)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -75,19 +78,22 @@ $CreateOAuthClientRequest = @"{
try {
$Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest
New-V2024OauthClient -V2024CreateOAuthClientRequest $Result
New-V2024OauthClient -V2024CreateOAuthClientRequest $Result
# Below is a request that includes all optional parameters
# New-V2024OauthClient -V2024CreateOAuthClientRequest $CreateOAuthClientRequest
# New-V2024OauthClient -V2024CreateOAuthClientRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024OauthClient"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-oauth-client
This deletes an OAuth client.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-oauth-client)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -118,19 +124,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id
# Delete OAuth Client
try {
Remove-V2024OauthClient -V2024Id $Id
Remove-V2024OauthClient -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024OauthClient -V2024Id $Id
# Remove-V2024OauthClient -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024OauthClient"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-oauth-client
This gets details of an OAuth client.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-oauth-client)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -161,19 +170,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id
# Get OAuth Client
try {
Get-V2024OauthClient -V2024Id $Id
Get-V2024OauthClient -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024OauthClient -V2024Id $Id
# Get-V2024OauthClient -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OauthClient"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-oauth-clients
This gets a list of OAuth clients.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-oauth-clients)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -203,19 +215,22 @@ $Filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # String | Filter results usin
# List OAuth Clients
try {
Get-V2024OauthClients
Get-V2024OauthClients
# Below is a request that includes all optional parameters
# Get-V2024OauthClients -V2024Filters $Filters
# Get-V2024OauthClients -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OauthClients"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/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-V2024OauthClient -V2024Id $Id -V2024JsonPatchOperation $Result
Update-V2024OauthClient -Id $Id -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024OauthClient -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024OauthClient -Id $Id -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024OauthClient"
Write-Host $_.ErrorDetails

30
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024OrgConfigApi.md
View File

@@ -23,9 +23,15 @@ Method | HTTP request | Description
[**Get-V2024ValidTimeZones**](#get-valid-time-zones) | **GET** `/org-config/valid-time-zones` | Get Valid Time Zones
[**Update-V2024OrgConfig**](#patch-org-config) | **PATCH** `/org-config` | Patch Org Config
## get-org-config
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Get the current organization's configuration settings, only external accessible properties.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-org-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -56,19 +62,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get Org Config Settings
try {
Get-V2024OrgConfig -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024OrgConfig -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OrgConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-valid-time-zones
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
List the valid time zones that can be set in organization configurations.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-valid-time-zones)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -104,19 +116,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Get Valid Time Zones
try {
Get-V2024ValidTimeZones -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024ValidTimeZones -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024ValidTimeZones -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count
# Get-V2024ValidTimeZones -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ValidTimeZones"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-org-config
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Patch the current organization's configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization's time zone.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-org-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -155,10 +173,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024OrgConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
Update-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024OrgConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024OrgConfig"
Write-Host $_.ErrorDetails

19
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordConfigurationApi.md
View File

@@ -27,11 +27,14 @@ Method | HTTP request | Description
[**Get-V2024PasswordOrgConfig**](#get-password-org-config) | **GET** `/password-org-config` | Get Password Org Config
[**Send-V2024PasswordOrgConfig**](#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/v2024/create-password-org-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -67,19 +70,22 @@ $PasswordOrgConfig = @"{
try {
$Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig
New-V2024PasswordOrgConfig -V2024PasswordOrgConfig $Result
New-V2024PasswordOrgConfig -V2024PasswordOrgConfig $Result
# Below is a request that includes all optional parameters
# New-V2024PasswordOrgConfig -V2024PasswordOrgConfig $PasswordOrgConfig
# New-V2024PasswordOrgConfig -V2024PasswordOrgConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordOrgConfig"
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/v2024/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-V2024PasswordOrgConfig
Get-V2024PasswordOrgConfig
# Below is a request that includes all optional parameters
# Get-V2024PasswordOrgConfig
@@ -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/v2024/put-password-org-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -157,10 +166,10 @@ $PasswordOrgConfig = @"{
try {
$Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig
Send-V2024PasswordOrgConfig -V2024PasswordOrgConfig $Result
Send-V2024PasswordOrgConfig -V2024PasswordOrgConfig $Result
# Below is a request that includes all optional parameters
# Send-V2024PasswordOrgConfig -V2024PasswordOrgConfig $PasswordOrgConfig
# Send-V2024PasswordOrgConfig -V2024PasswordOrgConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PasswordOrgConfig"
Write-Host $_.ErrorDetails

12
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordDictionaryApi.md
View File

@@ -67,6 +67,7 @@ Method | HTTP request | Description
[**Get-V2024PasswordDictionary**](#get-password-dictionary) | **GET** `/password-dictionary` | Get Password Dictionary
[**Send-V2024PasswordDictionary**](#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/v2024/get-password-dictionary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -126,7 +129,7 @@ Code | Description | Data Type
# Get Password Dictionary
try {
Get-V2024PasswordDictionary
Get-V2024PasswordDictionary
# Below is a request that includes all optional parameters
# Get-V2024PasswordDictionary
@@ -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/v2024/put-password-dictionary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -198,10 +204,10 @@ $File = # System.IO.FileInfo | (optional)
# Update Password Dictionary
try {
Send-V2024PasswordDictionary
Send-V2024PasswordDictionary
# Below is a request that includes all optional parameters
# Send-V2024PasswordDictionary -V2024File $File
# Send-V2024PasswordDictionary -File $File
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PasswordDictionary"
Write-Host $_.ErrorDetails

31
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordManagementApi.md
View File

@@ -46,9 +46,15 @@ Method | HTTP request | Description
[**Search-V2024PasswordInfo**](#query-password-info) | **POST** `/query-password-info` | Query Password Info
[**Set-V2024Password**](#set-password) | **POST** `/set-password` | Set Identity&#39;s Password
## create-digit-token
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API is used to generate a digit token for password management. Requires authorization scope of "idn:password-digit-token:create".
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-digit-token)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -85,19 +91,22 @@ $PasswordDigitTokenReset = @"{
try {
$Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset
New-V2024DigitToken -V2024XSailPointExperimental $XSailPointExperimental -V2024PasswordDigitTokenReset $Result
New-V2024DigitToken -XSailPointExperimental $XSailPointExperimental -V2024PasswordDigitTokenReset $Result
# Below is a request that includes all optional parameters
# New-V2024DigitToken -V2024XSailPointExperimental $XSailPointExperimental -V2024PasswordDigitTokenReset $PasswordDigitTokenReset
# New-V2024DigitToken -XSailPointExperimental $XSailPointExperimental -V2024PasswordDigitTokenReset $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DigitToken"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-password-change-status
This API returns the status of a password change request.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-password-change-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -128,20 +137,23 @@ $Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID
# Get Password Change Request Status
try {
Get-V2024PasswordChangeStatus -V2024Id $Id
Get-V2024PasswordChangeStatus -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024PasswordChangeStatus -V2024Id $Id
# Get-V2024PasswordChangeStatus -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordChangeStatus"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## query-password-info
This API is used to query password related information.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/query-password-info)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -175,16 +187,17 @@ $PasswordInfoQueryDTO = @"{
try {
$Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO
Search-V2024PasswordInfo -V2024PasswordInfoQueryDTO $Result
Search-V2024PasswordInfo -V2024PasswordInfoQueryDTO $Result
# Below is a request that includes all optional parameters
# Search-V2024PasswordInfo -V2024PasswordInfoQueryDTO $PasswordInfoQueryDTO
# Search-V2024PasswordInfo -V2024PasswordInfoQueryDTO $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024PasswordInfo"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-password
This API is used to set a password for an identity.
@@ -207,6 +220,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/v2024/set-password)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -243,10 +258,10 @@ $PasswordChangeRequest = @"{
try {
$Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest
Set-V2024Password -V2024PasswordChangeRequest $Result
Set-V2024Password -V2024PasswordChangeRequest $Result
# Below is a request that includes all optional parameters
# Set-V2024Password -V2024PasswordChangeRequest $PasswordChangeRequest
# Set-V2024Password -V2024PasswordChangeRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024Password"
Write-Host $_.ErrorDetails

35
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordPoliciesApi.md
View File

@@ -31,9 +31,12 @@ Method | HTTP request | Description
[**Get-V2024PasswordPolicies**](#list-password-policies) | **GET** `/password-policies` | List Password Policies
[**Set-V2024PasswordPolicy**](#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/v2024/create-password-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -97,19 +100,22 @@ $PasswordPolicyV3Dto = @"{
try {
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
New-V2024PasswordPolicy -V2024PasswordPolicyV3Dto $Result
New-V2024PasswordPolicy -V2024PasswordPolicyV3Dto $Result
# Below is a request that includes all optional parameters
# New-V2024PasswordPolicy -V2024PasswordPolicyV3Dto $PasswordPolicyV3Dto
# New-V2024PasswordPolicy -V2024PasswordPolicyV3Dto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordPolicy"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-password-policy
This API deletes the specified password policy.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-password-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -140,19 +146,22 @@ $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to
# Delete Password Policy by ID
try {
Remove-V2024PasswordPolicy -V2024Id $Id
Remove-V2024PasswordPolicy -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024PasswordPolicy -V2024Id $Id
# Remove-V2024PasswordPolicy -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024PasswordPolicy"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-password-policy-by-id)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -183,20 +192,23 @@ $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to
# Get Password Policy by ID
try {
Get-V2024PasswordPolicyById -V2024Id $Id
Get-V2024PasswordPolicyById -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024PasswordPolicyById -V2024Id $Id
# Get-V2024PasswordPolicyById -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordPolicyById"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/list-password-policies)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -230,19 +242,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# List Password Policies
try {
Get-V2024PasswordPolicies
Get-V2024PasswordPolicies
# Below is a request that includes all optional parameters
# Get-V2024PasswordPolicies -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count
# Get-V2024PasswordPolicies -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordPolicies"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-password-policy
This API updates the specified password policy.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-password-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -308,10 +323,10 @@ $PasswordPolicyV3Dto = @"{
try {
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
Set-V2024PasswordPolicy -V2024Id $Id -V2024PasswordPolicyV3Dto $Result
Set-V2024PasswordPolicy -Id $Id -V2024PasswordPolicyV3Dto $Result
# Below is a request that includes all optional parameters
# Set-V2024PasswordPolicy -V2024Id $Id -V2024PasswordPolicyV3Dto $PasswordPolicyV3Dto
# Set-V2024PasswordPolicy -Id $Id -V2024PasswordPolicyV3Dto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024PasswordPolicy"
Write-Host $_.ErrorDetails

35
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordSyncGroupsApi.md
View File

@@ -55,9 +55,12 @@ Method | HTTP request | Description
[**Get-V2024PasswordSyncGroups**](#get-password-sync-groups) | **GET** `/password-sync-groups` | Get Password Sync Group List
[**Update-V2024PasswordSyncGroup**](#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/v2024/create-password-sync-group)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -95,19 +98,22 @@ $PasswordSyncGroup = @"{
try {
$Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup
New-V2024PasswordSyncGroup -V2024PasswordSyncGroup $Result
New-V2024PasswordSyncGroup -V2024PasswordSyncGroup $Result
# Below is a request that includes all optional parameters
# New-V2024PasswordSyncGroup -V2024PasswordSyncGroup $PasswordSyncGroup
# New-V2024PasswordSyncGroup -V2024PasswordSyncGroup $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordSyncGroup"
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/v2024/delete-password-sync-group)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -137,19 +143,22 @@ $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync
# Delete Password Sync Group by ID
try {
Remove-V2024PasswordSyncGroup -V2024Id $Id
Remove-V2024PasswordSyncGroup -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024PasswordSyncGroup -V2024Id $Id
# Remove-V2024PasswordSyncGroup -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024PasswordSyncGroup"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-password-sync-group)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -180,19 +189,22 @@ $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync
# Get Password Sync Group by ID
try {
Get-V2024PasswordSyncGroup -V2024Id $Id
Get-V2024PasswordSyncGroup -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024PasswordSyncGroup -V2024Id $Id
# Get-V2024PasswordSyncGroup -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordSyncGroup"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-password-sync-groups
This API returns a list of password sync groups.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-password-sync-groups)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -226,19 +238,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Get Password Sync Group List
try {
Get-V2024PasswordSyncGroups
Get-V2024PasswordSyncGroups
# Below is a request that includes all optional parameters
# Get-V2024PasswordSyncGroups -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count
# Get-V2024PasswordSyncGroups -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordSyncGroups"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-password-sync-group
This API updates the specified password sync group.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-password-sync-group)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -279,10 +294,10 @@ $PasswordSyncGroup = @"{
try {
$Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup
Update-V2024PasswordSyncGroup -V2024Id $Id -V2024PasswordSyncGroup $Result
Update-V2024PasswordSyncGroup -Id $Id -V2024PasswordSyncGroup $Result
# Below is a request that includes all optional parameters
# Update-V2024PasswordSyncGroup -V2024Id $Id -V2024PasswordSyncGroup $PasswordSyncGroup
# Update-V2024PasswordSyncGroup -Id $Id -V2024PasswordSyncGroup $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PasswordSyncGroup"
Write-Host $_.ErrorDetails

28
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PersonalAccessTokensApi.md
View File

@@ -33,9 +33,12 @@ Method | HTTP request | Description
[**Get-V2024PersonalAccessTokens**](#list-personal-access-tokens) | **GET** `/personal-access-tokens` | List Personal Access Tokens
[**Update-V2024PersonalAccessToken**](#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/v2024/create-personal-access-token)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -70,19 +73,22 @@ $CreatePersonalAccessTokenRequest = @"{
try {
$Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest
New-V2024PersonalAccessToken -V2024CreatePersonalAccessTokenRequest $Result
New-V2024PersonalAccessToken -V2024CreatePersonalAccessTokenRequest $Result
# Below is a request that includes all optional parameters
# New-V2024PersonalAccessToken -V2024CreatePersonalAccessTokenRequest $CreatePersonalAccessTokenRequest
# New-V2024PersonalAccessToken -V2024CreatePersonalAccessTokenRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PersonalAccessToken"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-personal-access-token
This deletes a personal access token.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-personal-access-token)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -113,19 +119,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id
# Delete Personal Access Token
try {
Remove-V2024PersonalAccessToken -V2024Id $Id
Remove-V2024PersonalAccessToken -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024PersonalAccessToken -V2024Id $Id
# Remove-V2024PersonalAccessToken -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024PersonalAccessToken"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/list-personal-access-tokens)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -157,20 +166,23 @@ $Filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # String | Filter results usin
# List Personal Access Tokens
try {
Get-V2024PersonalAccessTokens
Get-V2024PersonalAccessTokens
# Below is a request that includes all optional parameters
# Get-V2024PersonalAccessTokens -V2024OwnerId $OwnerId -V2024Filters $Filters
# Get-V2024PersonalAccessTokens -OwnerId $OwnerId -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PersonalAccessTokens"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/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-V2024PersonalAccessToken -V2024Id $Id -V2024JsonPatchOperation $Result
Update-V2024PersonalAccessToken -Id $Id -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024PersonalAccessToken -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024PersonalAccessToken -Id $Id -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PersonalAccessToken"
Write-Host $_.ErrorDetails

7
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PublicIdentitiesApi.md
View File

@@ -22,9 +22,12 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024PublicIdentities**](#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/v2024/get-public-identities)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -64,10 +67,10 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
# Get list of public identities
try {
Get-V2024PublicIdentities
Get-V2024PublicIdentities
# Below is a request that includes all optional parameters
# Get-V2024PublicIdentities -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024AddCoreFilters $AddCoreFilters -V2024Sorters $Sorters
# Get-V2024PublicIdentities -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -AddCoreFilters $AddCoreFilters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PublicIdentities"
Write-Host $_.ErrorDetails

12
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PublicIdentitiesConfigApi.md
View File

@@ -30,9 +30,12 @@ Method | HTTP request | Description
[**Get-V2024PublicIdentityConfig**](#get-public-identity-config) | **GET** `/public-identities-config` | Get the Public Identities Configuration
[**Update-V2024PublicIdentityConfig**](#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/v2024/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-V2024PublicIdentityConfig
Get-V2024PublicIdentityConfig
# Below is a request that includes all optional parameters
# Get-V2024PublicIdentityConfig
@@ -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/v2024/update-public-identity-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -117,10 +123,10 @@ $PublicIdentityConfig = @"{
try {
$Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig
Update-V2024PublicIdentityConfig -V2024PublicIdentityConfig $Result
Update-V2024PublicIdentityConfig -V2024PublicIdentityConfig $Result
# Below is a request that includes all optional parameters
# Update-V2024PublicIdentityConfig -V2024PublicIdentityConfig $PublicIdentityConfig
# Update-V2024PublicIdentityConfig -V2024PublicIdentityConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PublicIdentityConfig"
Write-Host $_.ErrorDetails

28
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ReportsDataExtractionApi.md
View File

@@ -25,9 +25,12 @@ Method | HTTP request | Description
[**Get-V2024ReportResult**](#get-report-result) | **GET** `/reports/{taskResultId}/result` | Get Report Result
[**Start-V2024Report**](#start-report) | **POST** `/reports/run` | Run Report
## cancel-report
Cancels a running report.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/cancel-report)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -57,19 +60,22 @@ $Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to
# Cancel Report
try {
Suspend-V2024Report -V2024Id $Id
Suspend-V2024Report -Id $Id
# Below is a request that includes all optional parameters
# Suspend-V2024Report -V2024Id $Id
# Suspend-V2024Report -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024Report"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-report
Gets a report in file format.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-report)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -106,19 +112,22 @@ $Auditable = $true # Boolean | Enables auditing for current report download. Wil
# Get Report File
try {
Get-V2024Report -V2024TaskResultId $TaskResultId -V2024FileFormat $FileFormat
Get-V2024Report -TaskResultId $TaskResultId -FileFormat $FileFormat
# Below is a request that includes all optional parameters
# Get-V2024Report -V2024TaskResultId $TaskResultId -V2024FileFormat $FileFormat -V2024Name $Name -V2024Auditable $Auditable
# Get-V2024Report -TaskResultId $TaskResultId -FileFormat $FileFormat -Name $Name -Auditable $Auditable
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Report"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-report-result)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -150,19 +159,22 @@ $Completed = $true # Boolean | state of task result to apply ordering when resul
# Get Report Result
try {
Get-V2024ReportResult -V2024TaskResultId $TaskResultId
Get-V2024ReportResult -TaskResultId $TaskResultId
# Below is a request that includes all optional parameters
# Get-V2024ReportResult -V2024TaskResultId $TaskResultId -V2024Completed $Completed
# Get-V2024ReportResult -TaskResultId $TaskResultId -Completed $Completed
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReportResult"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/start-report)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -199,10 +211,10 @@ $ReportDetails = @"{
try {
$Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails
Start-V2024Report -V2024ReportDetails $Result
Start-V2024Report -V2024ReportDetails $Result
# Below is a request that includes all optional parameters
# Start-V2024Report -V2024ReportDetails $ReportDetails
# Start-V2024Report -V2024ReportDetails $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024Report"
Write-Host $_.ErrorDetails

7
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RequestableObjectsApi.md
View File

@@ -22,10 +22,13 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024RequestableObjects**](#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/v2024/list-requestable-objects)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -75,10 +78,10 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
# Requestable Objects List
try {
Get-V2024RequestableObjects
Get-V2024RequestableObjects
# Below is a request that includes all optional parameters
# Get-V2024RequestableObjects -V2024IdentityId $IdentityId -V2024Types $Types -V2024Term $Term -V2024Statuses $Statuses -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024RequestableObjects -IdentityId $IdentityId -Types $Types -Term $Term -Statuses $Statuses -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RequestableObjects"
Write-Host $_.ErrorDetails

96
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RoleInsightsApi.md
View File

@@ -27,9 +27,18 @@ Method | HTTP request | Description
[**Get-V2024RoleInsightsRequests**](#get-role-insights-requests) | **GET** `/role-insights/requests/{id}` | Returns metadata from prior request.
[**Get-V2024RoleInsightsSummary**](#get-role-insights-summary) | **GET** `/role-insights/summary` | Get role insights summary information
## create-role-insight-requests
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-role-insight-requests)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -59,19 +68,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Generate insights for roles
try {
New-V2024RoleInsightRequests -V2024XSailPointExperimental $XSailPointExperimental
New-V2024RoleInsightRequests -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# New-V2024RoleInsightRequests -V2024XSailPointExperimental $XSailPointExperimental
# New-V2024RoleInsightRequests -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024RoleInsightRequests"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## download-role-insights-entitlements-changes
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This endpoint returns the entitlement insights for a role.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/download-role-insights-entitlements-changes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -106,19 +121,25 @@ $Filters = 'name sw "r"' # String | Filter results using the standard syntax des
# Download entitlement insights for a role
try {
Invoke-V2024DownloadRoleInsightsEntitlementsChanges -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental
Invoke-V2024DownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Invoke-V2024DownloadRoleInsightsEntitlementsChanges -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters
# Invoke-V2024DownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024DownloadRoleInsightsEntitlementsChanges"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-entitlement-changes-identities
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlement-changes-identities)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -163,19 +184,25 @@ $Filters = 'name sw "Jan"' # String | Filter results using the standard syntax d
# Get identities for a suggested entitlement (for a role)
try {
Get-V2024EntitlementChangesIdentities -V2024InsightId $InsightId -V2024EntitlementId $EntitlementId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024EntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024EntitlementChangesIdentities -V2024InsightId $InsightId -V2024EntitlementId $EntitlementId -V2024XSailPointExperimental $XSailPointExperimental -V2024HasEntitlement $HasEntitlement -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters
# Get-V2024EntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -XSailPointExperimental $XSailPointExperimental -HasEntitlement $HasEntitlement -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementChangesIdentities"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insight
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This endpoint gets role insights information for a role.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insight)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -206,19 +233,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get a single role insight
try {
Get-V2024RoleInsight -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024RoleInsight -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleInsight -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024RoleInsight -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsight"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insights
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This method returns detailed role insights for each role.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insights)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -257,19 +290,25 @@ $Filters = 'name sw "John"' # String | Filter results using the standard syntax
# Get role insights
try {
Get-V2024RoleInsights -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024RoleInsights -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleInsights -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters
# Get-V2024RoleInsights -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsights"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insights-current-entitlements
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This endpoint gets the entitlements for a role. The term "current" is to distinguish from the entitlement(s) an insight might recommend adding.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insights-current-entitlements)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -302,19 +341,25 @@ $Filters = 'name sw "r"' # String | Filter results using the standard syntax des
# Get current entitlement for a role
try {
Get-V2024RoleInsightsCurrentEntitlements -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024RoleInsightsCurrentEntitlements -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleInsightsCurrentEntitlements -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters
# Get-V2024RoleInsightsCurrentEntitlements -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsCurrentEntitlements"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insights-entitlements-changes
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This endpoint returns entitlement insights for a role.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insights-entitlements-changes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -349,19 +394,28 @@ $Filters = 'name sw "Admin"' # String | Filter results using the standard syntax
# Get entitlement insights for a role
try {
Get-V2024RoleInsightsEntitlementsChanges -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024RoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleInsightsEntitlementsChanges -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters
# Get-V2024RoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsEntitlementsChanges"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insights-requests
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This endpoint returns details of a prior role insights request.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insights-requests)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -393,19 +447,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Returns metadata from prior request.
try {
Get-V2024RoleInsightsRequests -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024RoleInsightsRequests -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleInsightsRequests -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024RoleInsightsRequests -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsRequests"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insights-summary
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This method returns high level summary information for role insights for a customer.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insights-summary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -434,10 +494,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get role insights summary information
try {
Get-V2024RoleInsightsSummary -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024RoleInsightsSummary -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleInsightsSummary -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024RoleInsightsSummary -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsSummary"
Write-Host $_.ErrorDetails

113
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RolesApi.md
View File

@@ -71,12 +71,15 @@ Method | HTTP request | Description
[**Update-V2024RolesMetadataByIds**](#update-roles-metadata-by-ids) | **POST** `/roles/access-model-metadata/bulk-update/ids` | Bulk-Update Roles&#39; Metadata by ID
[**Update-V2024RolesMetadataByQuery**](#update-roles-metadata-by-query) | **POST** `/roles/access-model-metadata/bulk-update/query` | Bulk-Update Roles&#39; Metadata by Query
## 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/v2024/create-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -264,22 +267,25 @@ $Role = @"{
try {
$Result = ConvertFrom-JsonToRole -Json $Role
New-V2024Role -V2024Role $Result
New-V2024Role -V2024Role $Result
# Below is a request that includes all optional parameters
# New-V2024Role -V2024Role $Role
# New-V2024Role -V2024Role $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Role"
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/v2024/delete-bulk-roles)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -312,19 +318,22 @@ $RoleBulkDeleteRequest = @"{
try {
$Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest
Remove-V2024BulkRoles -V2024RoleBulkDeleteRequest $Result
Remove-V2024BulkRoles -V2024RoleBulkDeleteRequest $Result
# Below is a request that includes all optional parameters
# Remove-V2024BulkRoles -V2024RoleBulkDeleteRequest $RoleBulkDeleteRequest
# Remove-V2024BulkRoles -V2024RoleBulkDeleteRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024BulkRoles"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-metadata-from-role-by-key-and-value
This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-metadata-from-role-by-key-and-value)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -358,21 +367,24 @@ $AttributeValue = "public" # String | Technical name of the Attribute Value.
# Remove a Metadata From Role.
try {
Remove-V2024MetadataFromRoleByKeyAndValue -V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue
Remove-V2024MetadataFromRoleByKeyAndValue -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue
# Below is a request that includes all optional parameters
# Remove-V2024MetadataFromRoleByKeyAndValue -V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue
# Remove-V2024MetadataFromRoleByKeyAndValue -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MetadataFromRoleByKeyAndValue"
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/v2024/delete-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -402,19 +414,22 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role
# Delete a Role
try {
Remove-V2024Role -V2024Id $Id
Remove-V2024Role -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024Role -V2024Id $Id
# Remove-V2024Role -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Role"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-bulk-update-status
This API returns a list of all unfinished bulk update process status of the tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-bulk-update-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -442,7 +457,7 @@ Code | Description | Data Type
# Get Bulk-Update Statuses
try {
Get-V2024BulkUpdateStatus
Get-V2024BulkUpdateStatus
# Below is a request that includes all optional parameters
# Get-V2024BulkUpdateStatus
@@ -452,11 +467,14 @@ try {
}
```
[[Back to top]](#)
## get-bulk-update-status-by-id
This API initial a request for one bulk update's status by bulk update Id returns the status of the bulk update process.
A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-bulk-update-status-by-id)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -486,20 +504,23 @@ $Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of the bulk update ta
# Get Bulk-Update Status by ID
try {
Get-V2024BulkUpdateStatusById -V2024Id $Id
Get-V2024BulkUpdateStatusById -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024BulkUpdateStatusById -V2024Id $Id
# Get-V2024BulkUpdateStatusById -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024BulkUpdateStatusById"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -529,19 +550,22 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role
# Get a Role
try {
Get-V2024Role -V2024Id $Id
Get-V2024Role -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024Role -V2024Id $Id
# Get-V2024Role -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Role"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-assigned-identities
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-assigned-identities)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -581,19 +605,25 @@ $Sorters = "aliasName,name" # String | Sort results using the standard syntax de
# List Identities assigned a Role
try {
Get-V2024RoleAssignedIdentities -V2024Id $Id
Get-V2024RoleAssignedIdentities -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024RoleAssignedIdentities -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024RoleAssignedIdentities -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignedIdentities"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-entitlements
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API lists the Entitlements associated with a given role.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-entitlements)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -635,19 +665,22 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de
# List role's Entitlements
try {
Get-V2024RoleEntitlements -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024RoleEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleEntitlements -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024RoleEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleEntitlements"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-roles
This API returns a list of Roles.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-roles)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -691,16 +724,17 @@ $IncludeUnsegmented = $false # Boolean | Whether or not the response list should
# List Roles
try {
Get-V2024Roles
Get-V2024Roles
# Below is a request that includes all optional parameters
# Get-V2024Roles -V2024ForSubadmin $ForSubadmin -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters -V2024ForSegmentIds $ForSegmentIds -V2024IncludeUnsegmented $IncludeUnsegmented
# Get-V2024Roles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Roles"
Write-Host $_.ErrorDetails
}
```
[[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:
@@ -723,6 +757,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/v2024/patch-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -760,20 +796,23 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024Role -V2024Id $Id -V2024JsonPatchOperation $Result
Update-V2024Role -Id $Id -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024Role -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024Role -Id $Id -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Role"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## search-roles-by-filter
This API returns a list of Role that filter by metadata and filter, it support filter by both path parameter and attribute key and values.
A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, HELPDESK, CERT_ADMIN, REPORT_ADMIN or SOURCE_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-roles-by-filter)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -823,19 +862,22 @@ $RoleListFilterDTO = @"{
# Filter Roles by Metadata
try {
Search-V2024RolesByFilter
Search-V2024RolesByFilter
# Below is a request that includes all optional parameters
# Search-V2024RolesByFilter -V2024ForSubadmin $ForSubadmin -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024ForSegmentIds $ForSegmentIds -V2024IncludeUnsegmented $IncludeUnsegmented -V2024RoleListFilterDTO $RoleListFilterDTO
# Search-V2024RolesByFilter -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -V2024RoleListFilterDTO $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024RolesByFilter"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-attribute-key-and-value-to-role
This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-attribute-key-and-value-to-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -869,22 +911,25 @@ $AttributeValue = "public" # String | Technical name of the Attribute Value.
# Add a Metadata to Role.
try {
Update-V2024AttributeKeyAndValueToRole -V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue
Update-V2024AttributeKeyAndValueToRole -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue
# Below is a request that includes all optional parameters
# Update-V2024AttributeKeyAndValueToRole -V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue
# Update-V2024AttributeKeyAndValueToRole -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AttributeKeyAndValueToRole"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-roles-metadata-by-filter
This API initiates a bulk update of metadata for one or more Roles by filter.
A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API.
The maximum metadata value count for a single role is 25.
Custom metadata update, including add, replace need suit licensed.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-roles-metadata-by-filter)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -923,22 +968,25 @@ $RoleMetadataBulkUpdateByFilterRequest = @"{
try {
$Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByFilterRequest -Json $RoleMetadataBulkUpdateByFilterRequest
Update-V2024RolesMetadataByFilter -V2024RoleMetadataBulkUpdateByFilterRequest $Result
Update-V2024RolesMetadataByFilter -V2024RoleMetadataBulkUpdateByFilterRequest $Result
# Below is a request that includes all optional parameters
# Update-V2024RolesMetadataByFilter -V2024RoleMetadataBulkUpdateByFilterRequest $RoleMetadataBulkUpdateByFilterRequest
# Update-V2024RolesMetadataByFilter -V2024RoleMetadataBulkUpdateByFilterRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByFilter"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-roles-metadata-by-ids
This API initiates a bulk update of metadata for one or more Roles by a list of Role Ids.
A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API.
The maximum role count in a single update request is 3000. The maximum metadata value count for a single role is 25.
Custom metadata update, including add, replace need suit licensed.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-roles-metadata-by-ids)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -977,22 +1025,25 @@ $RoleMetadataBulkUpdateByIdRequest = @"{
try {
$Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByIdRequest -Json $RoleMetadataBulkUpdateByIdRequest
Update-V2024RolesMetadataByIds -V2024RoleMetadataBulkUpdateByIdRequest $Result
Update-V2024RolesMetadataByIds -V2024RoleMetadataBulkUpdateByIdRequest $Result
# Below is a request that includes all optional parameters
# Update-V2024RolesMetadataByIds -V2024RoleMetadataBulkUpdateByIdRequest $RoleMetadataBulkUpdateByIdRequest
# Update-V2024RolesMetadataByIds -V2024RoleMetadataBulkUpdateByIdRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByIds"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-roles-metadata-by-query
This API initiates a bulk update of metadata for one or more Roles by query.
A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API.
The maximum metadata value count for a single role is 25.
Custom metadata update, including add, replace need suit licensed.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-roles-metadata-by-query)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1046,10 +1097,10 @@ $RoleMetadataBulkUpdateByQueryRequest = @"{
try {
$Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByQueryRequest -Json $RoleMetadataBulkUpdateByQueryRequest
Update-V2024RolesMetadataByQuery -V2024RoleMetadataBulkUpdateByQueryRequest $Result
Update-V2024RolesMetadataByQuery -V2024RoleMetadataBulkUpdateByQueryRequest $Result
# Below is a request that includes all optional parameters
# Update-V2024RolesMetadataByQuery -V2024RoleMetadataBulkUpdateByQueryRequest $RoleMetadataBulkUpdateByQueryRequest
# Update-V2024RolesMetadataByQuery -V2024RoleMetadataBulkUpdateByQueryRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByQuery"
Write-Host $_.ErrorDetails

70
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SIMIntegrationsApi.md
View File

@@ -32,9 +32,15 @@ Method | HTTP request | Description
[**Update-V2024SIMAttributes**](#patch-sim-attributes) | **PATCH** `/sim-integrations/{id}` | Patch a SIM attribute.
[**Send-V2024SIMIntegration**](#put-sim-integration) | **PUT** `/sim-integrations/{id}` | Update an existing SIM integration
## create-sim-integration
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Create a new SIM Integrations.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-sim-integration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -85,19 +91,25 @@ $SimIntegrationDetails = @"{
try {
$Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails
New-V2024SIMIntegration -V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result
New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result
# Below is a request that includes all optional parameters
# New-V2024SIMIntegration -V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $SimIntegrationDetails
# New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SIMIntegration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-sim-integration
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Get the details of a SIM integration.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-sim-integration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -130,19 +142,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Delete a SIM integration
try {
Remove-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SIMIntegration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sim-integration
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Get the details of a SIM integration.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sim-integration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -175,19 +193,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get a SIM integration details.
try {
Get-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sim-integrations
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
List the existing SIM integrations.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sim-integrations)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -218,19 +242,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# List the existing SIM integrations.
try {
Get-V2024SIMIntegrations -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SIMIntegrations -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegrations"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-before-provisioning-rule
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Patch a SIM beforeProvisioningRule attribute given a JsonPatch object.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-before-provisioning-rule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -266,19 +296,25 @@ $JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\"
try {
$Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch
Update-V2024BeforeProvisioningRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result
Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result
# Below is a request that includes all optional parameters
# Update-V2024BeforeProvisioningRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $JsonPatch
# Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024BeforeProvisioningRule"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-sim-attributes
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Patch a SIM attribute given a JsonPatch object.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-sim-attributes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -314,19 +350,25 @@ $JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\"
try {
$Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch
Update-V2024SIMAttributes -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result
Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result
# Below is a request that includes all optional parameters
# Update-V2024SIMAttributes -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $JsonPatch
# Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SIMAttributes"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-sim-integration
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Update an existing SIM integration.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-sim-integration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -379,10 +421,10 @@ $SimIntegrationDetails = @"{
try {
$Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails
Send-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result
Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result
# Below is a request that includes all optional parameters
# Send-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $SimIntegrationDetails
# Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SIMIntegration"
Write-Host $_.ErrorDetails

117
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SODPoliciesApi.md
View File

@@ -61,10 +61,13 @@ Method | HTTP request | Description
[**Start-V2024SodAllPoliciesForOrg**](#start-sod-all-policies-for-org) | **POST** `/sod-violation-report/run` | Runs all policies for org
[**Start-V2024SodPolicy**](#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/v2024/create-sod-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -150,20 +153,23 @@ $SodPolicy = @"{
try {
$Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy
New-V2024SodPolicy -V2024SodPolicy $Result
New-V2024SodPolicy -V2024SodPolicy $Result
# Below is a request that includes all optional parameters
# New-V2024SodPolicy -V2024SodPolicy $SodPolicy
# New-V2024SodPolicy -V2024SodPolicy $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SodPolicy"
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/v2024/delete-sod-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -196,19 +202,22 @@ $Logical = $true # Boolean | Indicates whether this is a soft delete (logical tr
# Delete SOD policy by ID
try {
Remove-V2024SodPolicy -V2024Id $Id
Remove-V2024SodPolicy -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024SodPolicy -V2024Id $Id -V2024Logical $Logical
# Remove-V2024SodPolicy -Id $Id -Logical $Logical
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicy"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/delete-sod-policy-schedule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -239,19 +248,22 @@ $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy
# Delete SOD policy schedule
try {
Remove-V2024SodPolicySchedule -V2024Id $Id
Remove-V2024SodPolicySchedule -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024SodPolicySchedule -V2024Id $Id
# Remove-V2024SodPolicySchedule -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicySchedule"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-custom-violation-report)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -284,19 +296,22 @@ $FileName = "custom-name" # String | Custom Name for the file.
# Download custom violation report
try {
Get-V2024CustomViolationReport -V2024ReportResultId $ReportResultId -V2024FileName $FileName
Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName
# Below is a request that includes all optional parameters
# Get-V2024CustomViolationReport -V2024ReportResultId $ReportResultId -V2024FileName $FileName
# Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomViolationReport"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-default-violation-report)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -327,19 +342,22 @@ $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the re
# Download violation report
try {
Get-V2024DefaultViolationReport -V2024ReportResultId $ReportResultId
Get-V2024DefaultViolationReport -ReportResultId $ReportResultId
# Below is a request that includes all optional parameters
# Get-V2024DefaultViolationReport -V2024ReportResultId $ReportResultId
# Get-V2024DefaultViolationReport -ReportResultId $ReportResultId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultViolationReport"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/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-V2024SodAllReportRunStatus
Get-V2024SodAllReportRunStatus
# Below is a request that includes all optional parameters
# Get-V2024SodAllReportRunStatus
@@ -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/v2024/get-sod-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -411,19 +432,22 @@ $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy
# Get SOD policy by ID
try {
Get-V2024SodPolicy -V2024Id $Id
Get-V2024SodPolicy -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024SodPolicy -V2024Id $Id
# Get-V2024SodPolicy -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicy"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sod-policy-schedule
This endpoint gets a specified SOD policy's schedule.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sod-policy-schedule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -453,19 +477,22 @@ $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy
# Get SOD policy schedule
try {
Get-V2024SodPolicySchedule -V2024Id $Id
Get-V2024SodPolicySchedule -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024SodPolicySchedule -V2024Id $Id
# Get-V2024SodPolicySchedule -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicySchedule"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-sod-violation-report-run-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -496,19 +523,22 @@ $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of th
# Get violation report run status
try {
Get-V2024SodViolationReportRunStatus -V2024ReportResultId $ReportResultId
Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId
# Below is a request that includes all optional parameters
# Get-V2024SodViolationReportRunStatus -V2024ReportResultId $ReportResultId
# Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportRunStatus"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-sod-violation-report-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -539,20 +569,23 @@ $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation
# Get SOD violation report status
try {
Get-V2024SodViolationReportStatus -V2024Id $Id
Get-V2024SodViolationReportStatus -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024SodViolationReportStatus -V2024Id $Id
# Get-V2024SodViolationReportStatus -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportStatus"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/list-sod-policies)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -590,21 +623,24 @@ $Sorters = "id,name" # String | Sort results using the standard syntax described
# List SOD policies
try {
Get-V2024SodPolicies
Get-V2024SodPolicies
# Below is a request that includes all optional parameters
# Get-V2024SodPolicies -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicies"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/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-V2024SodPolicy -V2024Id $Id -V2024JsonPatchOperation $Result
Update-V2024SodPolicy -Id $Id -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024SodPolicy -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024SodPolicy -Id $Id -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SodPolicy"
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/v2024/put-policy-schedule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -773,20 +812,23 @@ $SodPolicySchedule = @"{
try {
$Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule
Send-V2024PolicySchedule -V2024Id $Id -V2024SodPolicySchedule $Result
Send-V2024PolicySchedule -Id $Id -V2024SodPolicySchedule $Result
# Below is a request that includes all optional parameters
# Send-V2024PolicySchedule -V2024Id $Id -V2024SodPolicySchedule $SodPolicySchedule
# Send-V2024PolicySchedule -Id $Id -V2024SodPolicySchedule $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PolicySchedule"
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/v2024/put-sod-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -875,19 +917,22 @@ $SodPolicy = @"{
try {
$Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy
Send-V2024SodPolicy -V2024Id $Id -V2024SodPolicy $Result
Send-V2024SodPolicy -Id $Id -V2024SodPolicy $Result
# Below is a request that includes all optional parameters
# Send-V2024SodPolicy -V2024Id $Id -V2024SodPolicy $SodPolicy
# Send-V2024SodPolicy -Id $Id -V2024SodPolicy $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SodPolicy"
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/v2024/start-evaluate-sod-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -917,19 +962,22 @@ $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run
# Evaluate one policy by ID
try {
Start-V2024EvaluateSodPolicy -V2024Id $Id
Start-V2024EvaluateSodPolicy -Id $Id
# Below is a request that includes all optional parameters
# Start-V2024EvaluateSodPolicy -V2024Id $Id
# Start-V2024EvaluateSodPolicy -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024EvaluateSodPolicy"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/start-sod-all-policies-for-org)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -961,19 +1009,22 @@ $MultiPolicyRequest = @"{
# Runs all policies for org
try {
Start-V2024SodAllPoliciesForOrg
Start-V2024SodAllPoliciesForOrg
# Below is a request that includes all optional parameters
# Start-V2024SodAllPoliciesForOrg -V2024MultiPolicyRequest $MultiPolicyRequest
# Start-V2024SodAllPoliciesForOrg -V2024MultiPolicyRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodAllPoliciesForOrg"
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/v2024/start-sod-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1004,10 +1055,10 @@ $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run
# Runs SOD policy violation report
try {
Start-V2024SodPolicy -V2024Id $Id
Start-V2024SodPolicy -Id $Id
# Below is a request that includes all optional parameters
# Start-V2024SodPolicy -V2024Id $Id
# Start-V2024SodPolicy -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodPolicy"
Write-Host $_.ErrorDetails

14
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SODViolationsApi.md
View File

@@ -38,9 +38,12 @@ Method | HTTP request | Description
[**Start-V2024PredictSodViolations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict SOD violations for identity.
[**Start-V2024ViolationCheck**](#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/v2024/start-predict-sod-violations)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -83,19 +86,22 @@ $IdentityWithNewAccess = @"{
try {
$Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess
Start-V2024PredictSodViolations -V2024IdentityWithNewAccess $Result
Start-V2024PredictSodViolations -V2024IdentityWithNewAccess $Result
# Below is a request that includes all optional parameters
# Start-V2024PredictSodViolations -V2024IdentityWithNewAccess $IdentityWithNewAccess
# Start-V2024PredictSodViolations -V2024IdentityWithNewAccess $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024PredictSodViolations"
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/v2024/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-V2024ViolationCheck -V2024IdentityWithNewAccess1 $Result
Start-V2024ViolationCheck -V2024IdentityWithNewAccess1 $Result
# Below is a request that includes all optional parameters
# Start-V2024ViolationCheck -V2024IdentityWithNewAccess1 $IdentityWithNewAccess1
# Start-V2024ViolationCheck -V2024IdentityWithNewAccess1 $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024ViolationCheck"
Write-Host $_.ErrorDetails

70
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SPConfigApi.md
View File

@@ -25,10 +25,16 @@ Method | HTTP request | Description
[**Import-V2024SpConfig**](#import-sp-config) | **POST** `/sp-config/import` | Initiates configuration objects import job
[**Get-V2024SpConfigObjects**](#list-sp-config-objects) | **GET** `/sp-config/config-objects` | Get config object details
## export-sp-config
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This post will export objects from the tenant to a JSON configuration file.
For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-sp-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -64,21 +70,27 @@ $ExportPayload = @"{
try {
$Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload
Export-V2024SpConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024ExportPayload $Result
Export-V2024SpConfig -XSailPointExperimental $XSailPointExperimental -V2024ExportPayload $Result
# Below is a request that includes all optional parameters
# Export-V2024SpConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024ExportPayload $ExportPayload
# Export-V2024SpConfig -XSailPointExperimental $XSailPointExperimental -V2024ExportPayload $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024SpConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sp-config-export
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file.
The request will need one of the following security scopes:
- sp:config:read - sp:config:manage
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sp-config-export)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -111,21 +123,27 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Download export job result.
try {
Get-V2024SpConfigExport -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024SpConfigExport -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SpConfigExport -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024SpConfigExport -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExport"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sp-config-export-status
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This gets the status of the export job identified by the `id` parameter.
The request will need one of the following security scopes:
- sp:config:read - sp:config:manage
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sp-config-export-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -158,21 +176,27 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get export job status
try {
Get-V2024SpConfigExportStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024SpConfigExportStatus -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SpConfigExportStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024SpConfigExportStatus -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExportStatus"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sp-config-import
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import.
The request will need the following security scope:
- sp:config:manage
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sp-config-import)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -205,23 +229,29 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Download import job result
try {
Get-V2024SpConfigImport -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024SpConfigImport -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SpConfigImport -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024SpConfigImport -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImport"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sp-config-import-status
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
'This gets the status of the import job identified by the `id` parameter.
For more information about the object types that currently support import functionality,
refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).'
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sp-config-import-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -254,17 +284,21 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get import job status
try {
Get-V2024SpConfigImportStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024SpConfigImportStatus -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SpConfigImportStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024SpConfigImportStatus -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImportStatus"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## import-sp-config
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
"This post will import objects from a JSON configuration file into\
\ a tenant. By default, every import will first export all existing objects supported\
\ by sp-config as a backup before the import is attempted. The backup is provided\
@@ -279,6 +313,8 @@ try {
\ Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects)."
[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-sp-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -315,19 +351,25 @@ $Options = @""@
# Initiates configuration objects import job
try {
Import-V2024SpConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024Data $Data
Import-V2024SpConfig -XSailPointExperimental $XSailPointExperimental -Data $Data
# Below is a request that includes all optional parameters
# Import-V2024SpConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024Data $Data -V2024Preview $Preview -V2024Options $Options
# Import-V2024SpConfig -XSailPointExperimental $XSailPointExperimental -Data $Data -Preview $Preview -V2024Options $Options
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024SpConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-sp-config-objects
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This gets the list of object configurations which are known to the tenant export/import service. Object configurations that contain "importUrl" and "exportUrl" are available for export/import.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-sp-config-objects)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -358,10 +400,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get config object details
try {
Get-V2024SpConfigObjects -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024SpConfigObjects -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SpConfigObjects -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024SpConfigObjects -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigObjects"
Write-Host $_.ErrorDetails

42
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SavedSearchApi.md
View File

@@ -34,10 +34,13 @@ Method | HTTP request | Description
[**Get-V2024SavedSearches**](#list-saved-searches) | **GET** `/saved-searches` | A list of Saved Searches
[**Send-V2024SavedSearch**](#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/v2024/create-saved-search)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -68,20 +71,23 @@ $CreateSavedSearchRequest = @""@
try {
$Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest
New-V2024SavedSearch -V2024CreateSavedSearchRequest $Result
New-V2024SavedSearch -V2024CreateSavedSearchRequest $Result
# Below is a request that includes all optional parameters
# New-V2024SavedSearch -V2024CreateSavedSearchRequest $CreateSavedSearchRequest
# New-V2024SavedSearch -V2024CreateSavedSearchRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SavedSearch"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-saved-search
Deletes the specified saved search.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-saved-search)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -112,20 +118,23 @@ $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document
# Delete document by ID
try {
Remove-V2024SavedSearch -V2024Id $Id
Remove-V2024SavedSearch -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024SavedSearch -V2024Id $Id
# Remove-V2024SavedSearch -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SavedSearch"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## execute-saved-search
Executes the specified saved search.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/execute-saved-search)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -169,20 +178,23 @@ $SearchArguments = @"{
try {
$Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments
Invoke-V2024ExecuteSavedSearch -V2024Id $Id -V2024SearchArguments $Result
Invoke-V2024ExecuteSavedSearch -Id $Id -V2024SearchArguments $Result
# Below is a request that includes all optional parameters
# Invoke-V2024ExecuteSavedSearch -V2024Id $Id -V2024SearchArguments $SearchArguments
# Invoke-V2024ExecuteSavedSearch -Id $Id -V2024SearchArguments $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ExecuteSavedSearch"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-saved-search
Returns the specified saved search.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-saved-search)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -213,20 +225,23 @@ $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document
# Return saved search by ID
try {
Get-V2024SavedSearch -V2024Id $Id
Get-V2024SavedSearch -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024SavedSearch -V2024Id $Id
# Get-V2024SavedSearch -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedSearch"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-saved-searches
Returns a list of saved searches.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-saved-searches)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -262,22 +277,25 @@ $Filters = 'owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"' # String | Filte
# A list of Saved Searches
try {
Get-V2024SavedSearches
Get-V2024SavedSearches
# Below is a request that includes all optional parameters
# Get-V2024SavedSearches -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters
# Get-V2024SavedSearches -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedSearches"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/put-saved-search)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -354,10 +372,10 @@ $SavedSearch = @"{
try {
$Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch
Send-V2024SavedSearch -V2024Id $Id -V2024SavedSearch $Result
Send-V2024SavedSearch -Id $Id -V2024SavedSearch $Result
# Below is a request that includes all optional parameters
# Send-V2024SavedSearch -V2024Id $Id -V2024SavedSearch $SavedSearch
# Send-V2024SavedSearch -Id $Id -V2024SavedSearch $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SavedSearch"
Write-Host $_.ErrorDetails

42
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ScheduledSearchApi.md
View File

@@ -50,10 +50,13 @@ Method | HTTP request | Description
[**Invoke-V2024UnsubscribeScheduledSearch**](#unsubscribe-scheduled-search) | **POST** `/scheduled-searches/{id}/unsubscribe` | Unsubscribe a recipient from Scheduled Search
[**Update-V2024ScheduledSearch**](#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/v2024/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-V2024ScheduledSearch -V2024CreateScheduledSearchRequest $Result
New-V2024ScheduledSearch -V2024CreateScheduledSearchRequest $Result
# Below is a request that includes all optional parameters
# New-V2024ScheduledSearch -V2024CreateScheduledSearchRequest $CreateScheduledSearchRequest
# New-V2024ScheduledSearch -V2024CreateScheduledSearchRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ScheduledSearch"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-scheduled-search
Deletes the specified scheduled search.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-scheduled-search)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -129,19 +135,22 @@ $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document
# Delete a Scheduled Search
try {
Remove-V2024ScheduledSearch -V2024Id $Id
Remove-V2024ScheduledSearch -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024ScheduledSearch -V2024Id $Id
# Remove-V2024ScheduledSearch -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ScheduledSearch"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-scheduled-search
Returns the specified scheduled search.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-scheduled-search)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -172,20 +181,23 @@ $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document
# Get a Scheduled Search
try {
Get-V2024ScheduledSearch -V2024Id $Id
Get-V2024ScheduledSearch -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024ScheduledSearch -V2024Id $Id
# Get-V2024ScheduledSearch -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledSearch"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-scheduled-search
Returns a list of scheduled searches.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-scheduled-search)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -222,20 +234,23 @@ $Filters = 'savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"' # String |
# List scheduled searches
try {
Get-V2024ScheduledSearch
Get-V2024ScheduledSearch
# Below is a request that includes all optional parameters
# Get-V2024ScheduledSearch -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters
# Get-V2024ScheduledSearch -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledSearch"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## unsubscribe-scheduled-search
Unsubscribes a recipient from the specified scheduled search.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/unsubscribe-scheduled-search)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -269,20 +284,23 @@ $TypedReference = @"{
try {
$Result = ConvertFrom-JsonToTypedReference -Json $TypedReference
Invoke-V2024UnsubscribeScheduledSearch -V2024Id $Id -V2024TypedReference $Result
Invoke-V2024UnsubscribeScheduledSearch -Id $Id -V2024TypedReference $Result
# Below is a request that includes all optional parameters
# Invoke-V2024UnsubscribeScheduledSearch -V2024Id $Id -V2024TypedReference $TypedReference
# Invoke-V2024UnsubscribeScheduledSearch -Id $Id -V2024TypedReference $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024UnsubscribeScheduledSearch"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-scheduled-search
Updates an existing scheduled search.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-scheduled-search)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -406,10 +424,10 @@ $ScheduledSearch = @"{
try {
$Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch
Update-V2024ScheduledSearch -V2024Id $Id -V2024ScheduledSearch $Result
Update-V2024ScheduledSearch -Id $Id -V2024ScheduledSearch $Result
# Below is a request that includes all optional parameters
# Update-V2024ScheduledSearch -V2024Id $Id -V2024ScheduledSearch $ScheduledSearch
# Update-V2024ScheduledSearch -Id $Id -V2024ScheduledSearch $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ScheduledSearch"
Write-Host $_.ErrorDetails

36
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SearchApi.md
View File

@@ -45,9 +45,12 @@ Method | HTTP request | Description
[**Search-V2024Get**](#search-get) | **GET** `/search/{index}/{id}` | Get a Document by ID
[**Search-V2024Post**](#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/v2024/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-V2024Aggregate -V2024Search $Result
Search-V2024Aggregate -V2024Search $Result
# Below is a request that includes all optional parameters
# Search-V2024Aggregate -V2024Search $Search -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count
# Search-V2024Aggregate -V2024Search $Result -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Aggregate"
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/v2024/search-count)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -359,19 +365,22 @@ $Search = @"{
try {
$Result = ConvertFrom-JsonToSearch -Json $Search
Search-V2024Count -V2024Search $Result
Search-V2024Count -V2024Search $Result
# Below is a request that includes all optional parameters
# Search-V2024Count -V2024Search $Search
# Search-V2024Count -V2024Search $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Count"
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/v2024/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,19 +413,22 @@ $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document
# Get a Document by ID
try {
Search-V2024Get -V2024Index $Index -V2024Id $Id
Search-V2024Get -Index $Index -Id $Id
# Below is a request that includes all optional parameters
# Search-V2024Get -V2024Index $Index -V2024Id $Id
# Search-V2024Get -Index $Index -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Get"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/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-V2024Post -V2024Search $Result
Search-V2024Post -V2024Search $Result
# Below is a request that includes all optional parameters
# Search-V2024Post -V2024Search $Search -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count
# Search-V2024Post -V2024Search $Result -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Post"
Write-Host $_.ErrorDetails

33
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SearchAttributeConfigurationApi.md
View File

@@ -41,9 +41,12 @@ Method | HTTP request | Description
[**Get-V2024SingleSearchAttributeConfig**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute
[**Update-V2024SearchAttributeConfig**](#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/v2024/create-search-attribute-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -82,19 +85,22 @@ $SearchAttributeConfig = @"{
try {
$Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig
New-V2024SearchAttributeConfig -V2024SearchAttributeConfig $Result
New-V2024SearchAttributeConfig -V2024SearchAttributeConfig $Result
# Below is a request that includes all optional parameters
# New-V2024SearchAttributeConfig -V2024SearchAttributeConfig $SearchAttributeConfig
# New-V2024SearchAttributeConfig -V2024SearchAttributeConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SearchAttributeConfig"
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/v2024/delete-search-attribute-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -125,19 +131,22 @@ $Name = "newMailAttribute" # String | Name of the extended search attribute conf
# Delete Extended Search Attribute
try {
Remove-V2024SearchAttributeConfig -V2024Name $Name
Remove-V2024SearchAttributeConfig -Name $Name
# Below is a request that includes all optional parameters
# Remove-V2024SearchAttributeConfig -V2024Name $Name
# Remove-V2024SearchAttributeConfig -Name $Name
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SearchAttributeConfig"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/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-V2024SearchAttributeConfig
Get-V2024SearchAttributeConfig
# Below is a request that includes all optional parameters
# Get-V2024SearchAttributeConfig
@@ -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/v2024/get-single-search-attribute-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -209,21 +221,24 @@ $Name = "newMailAttribute" # String | Name of the extended search attribute conf
# Get Extended Search Attribute
try {
Get-V2024SingleSearchAttributeConfig -V2024Name $Name
Get-V2024SingleSearchAttributeConfig -Name $Name
# Below is a request that includes all optional parameters
# Get-V2024SingleSearchAttributeConfig -V2024Name $Name
# Get-V2024SingleSearchAttributeConfig -Name $Name
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SingleSearchAttributeConfig"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/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-V2024SearchAttributeConfig -V2024Name $Name -V2024JsonPatchOperation $Result
Update-V2024SearchAttributeConfig -Name $Name -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024SearchAttributeConfig -V2024Name $Name -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024SearchAttributeConfig -Name $Name -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SearchAttributeConfig"
Write-Host $_.ErrorDetails

35
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SegmentsApi.md
View File

@@ -40,10 +40,13 @@ Method | HTTP request | Description
[**Get-V2024Segments**](#list-segments) | **GET** `/segments` | List Segments
[**Update-V2024Segment**](#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/v2024/create-segment)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -97,20 +100,23 @@ $Segment = @"{
try {
$Result = ConvertFrom-JsonToSegment -Json $Segment
New-V2024Segment -V2024Segment $Result
New-V2024Segment -V2024Segment $Result
# Below is a request that includes all optional parameters
# New-V2024Segment -V2024Segment $Segment
# New-V2024Segment -V2024Segment $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Segment"
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/v2024/delete-segment)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -141,19 +147,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete.
# Delete Segment by ID
try {
Remove-V2024Segment -V2024Id $Id
Remove-V2024Segment -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024Segment -V2024Id $Id
# Remove-V2024Segment -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Segment"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-segment
This API returns the segment specified by the given ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-segment)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -184,19 +193,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve.
# Get Segment by ID
try {
Get-V2024Segment -V2024Id $Id
Get-V2024Segment -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024Segment -V2024Id $Id
# Get-V2024Segment -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Segment"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-segments
This API returns a list of all segments.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-segments)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -230,20 +242,23 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# List Segments
try {
Get-V2024Segments
Get-V2024Segments
# Below is a request that includes all optional parameters
# Get-V2024Segments -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count
# Get-V2024Segments -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Segments"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/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-V2024Segment -V2024Id $Id -V2024RequestBody $Result
Update-V2024Segment -Id $Id -RequestBody $Result
# Below is a request that includes all optional parameters
# Update-V2024Segment -V2024Id $Id -V2024RequestBody $RequestBody
# Update-V2024Segment -Id $Id -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Segment"
Write-Host $_.ErrorDetails

66
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ServiceDeskIntegrationApi.md
View File

@@ -52,9 +52,12 @@ Method | HTTP request | Description
[**Send-V2024ServiceDeskIntegration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a Service Desk integration
[**Update-V2024StatusCheckDetails**](#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/v2024/create-service-desk-integration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -119,19 +122,22 @@ $ServiceDeskIntegrationDto = @"{
try {
$Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto
New-V2024ServiceDeskIntegration -V2024ServiceDeskIntegrationDto $Result
New-V2024ServiceDeskIntegration -V2024ServiceDeskIntegrationDto $Result
# Below is a request that includes all optional parameters
# New-V2024ServiceDeskIntegration -V2024ServiceDeskIntegrationDto $ServiceDeskIntegrationDto
# New-V2024ServiceDeskIntegration -V2024ServiceDeskIntegrationDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ServiceDeskIntegration"
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/v2024/delete-service-desk-integration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -162,19 +168,22 @@ $Id = "anId" # String | ID of Service Desk integration to delete
# Delete a Service Desk integration
try {
Remove-V2024ServiceDeskIntegration -V2024Id $Id
Remove-V2024ServiceDeskIntegration -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024ServiceDeskIntegration -V2024Id $Id
# Remove-V2024ServiceDeskIntegration -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ServiceDeskIntegration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-service-desk-integration
Get an existing Service Desk integration by ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-service-desk-integration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -205,19 +214,22 @@ $Id = "anId" # String | ID of the Service Desk integration to get
# Get a Service Desk integration
try {
Get-V2024ServiceDeskIntegration -V2024Id $Id
Get-V2024ServiceDeskIntegration -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024ServiceDeskIntegration -V2024Id $Id
# Get-V2024ServiceDeskIntegration -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegration"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-service-desk-integration-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -248,19 +260,22 @@ $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk
# Service Desk integration template by scriptName
try {
Get-V2024ServiceDeskIntegrationTemplate -V2024ScriptName $ScriptName
Get-V2024ServiceDeskIntegrationTemplate -ScriptName $ScriptName
# Below is a request that includes all optional parameters
# Get-V2024ServiceDeskIntegrationTemplate -V2024ScriptName $ScriptName
# Get-V2024ServiceDeskIntegrationTemplate -ScriptName $ScriptName
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrationTemplate"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/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-V2024ServiceDeskIntegrationTypes
Get-V2024ServiceDeskIntegrationTypes
# Below is a request that includes all optional parameters
# Get-V2024ServiceDeskIntegrationTypes
@@ -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/v2024/get-service-desk-integrations)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -340,19 +358,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# List existing Service Desk integrations
try {
Get-V2024ServiceDeskIntegrations
Get-V2024ServiceDeskIntegrations
# Below is a request that includes all optional parameters
# Get-V2024ServiceDeskIntegrations -V2024Offset $Offset -V2024Limit $Limit -V2024Sorters $Sorters -V2024Filters $Filters -V2024Count $Count
# Get-V2024ServiceDeskIntegrations -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrations"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-status-check-details
Get the time check configuration of queued SDIM tickets.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/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-V2024StatusCheckDetails
Get-V2024StatusCheckDetails
# Below is a request that includes all optional parameters
# Get-V2024StatusCheckDetails
@@ -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/v2024/patch-service-desk-integration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -427,19 +451,22 @@ $PatchServiceDeskIntegrationRequest = @""@
try {
$Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest
Update-V2024ServiceDeskIntegration -V2024Id $Id -V2024PatchServiceDeskIntegrationRequest $Result
Update-V2024ServiceDeskIntegration -Id $Id -V2024PatchServiceDeskIntegrationRequest $Result
# Below is a request that includes all optional parameters
# Update-V2024ServiceDeskIntegration -V2024Id $Id -V2024PatchServiceDeskIntegrationRequest $PatchServiceDeskIntegrationRequest
# Update-V2024ServiceDeskIntegration -Id $Id -V2024PatchServiceDeskIntegrationRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ServiceDeskIntegration"
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/v2024/put-service-desk-integration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -506,19 +533,22 @@ $ServiceDeskIntegrationDto = @"{
try {
$Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto
Send-V2024ServiceDeskIntegration -V2024Id $Id -V2024ServiceDeskIntegrationDto $Result
Send-V2024ServiceDeskIntegration -Id $Id -V2024ServiceDeskIntegrationDto $Result
# Below is a request that includes all optional parameters
# Send-V2024ServiceDeskIntegration -V2024Id $Id -V2024ServiceDeskIntegrationDto $ServiceDeskIntegrationDto
# Send-V2024ServiceDeskIntegration -Id $Id -V2024ServiceDeskIntegrationDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ServiceDeskIntegration"
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/v2024/update-status-check-details)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -553,10 +583,10 @@ $QueuedCheckConfigDetails = @"{
try {
$Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails
Update-V2024StatusCheckDetails -V2024QueuedCheckConfigDetails $Result
Update-V2024StatusCheckDetails -V2024QueuedCheckConfigDetails $Result
# Below is a request that includes all optional parameters
# Update-V2024StatusCheckDetails -V2024QueuedCheckConfigDetails $QueuedCheckConfigDetails
# Update-V2024StatusCheckDetails -V2024QueuedCheckConfigDetails $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024StatusCheckDetails"
Write-Host $_.ErrorDetails

14
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SourceUsagesApi.md
View File

@@ -23,9 +23,12 @@ Method | HTTP request | Description
[**Get-V2024StatusBySourceId**](#get-status-by-source-id) | **GET** `/source-usages/{sourceId}/status` | Finds status of source usage
[**Get-V2024UsagesBySourceId**](#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/v2024/get-status-by-source-id)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -55,19 +58,22 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source
# Finds status of source usage
try {
Get-V2024StatusBySourceId -V2024SourceId $SourceId
Get-V2024StatusBySourceId -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-V2024StatusBySourceId -V2024SourceId $SourceId
# Get-V2024StatusBySourceId -SourceId $SourceId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusBySourceId"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-usages-by-source-id)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -105,10 +111,10 @@ $Sorters = "-date" # String | Sort results using the standard syntax described i
# Returns source usage insights
try {
Get-V2024UsagesBySourceId -V2024SourceId $SourceId
Get-V2024UsagesBySourceId -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-V2024UsagesBySourceId -V2024SourceId $SourceId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters
# Get-V2024UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesBySourceId"
Write-Host $_.ErrorDetails

391
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SourcesApi.md
View File

File diff suppressed because it is too large Load Diff

70
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SuggestedEntitlementDescriptionApi.md
View File

@@ -28,13 +28,19 @@ Method | HTTP request | Description
[**Submit-V2024SedAssignment**](#submit-sed-assignment) | **POST** `/suggested-entitlement-description-assignments` | Submit Sed Assignment Request
[**Submit-V2024SedBatchRequest**](#submit-sed-batch-request) | **POST** `/suggested-entitlement-description-batches` | Submit Sed Batch Request
## get-sed-batch-stats
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
'Submit Sed Batch Stats Request.
Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats
of the batchId.'
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sed-batch-stats)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -67,20 +73,26 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Submit Sed Batch Stats Request
try {
Get-V2024SedBatchStats -V2024BatchId $BatchId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024SedBatchStats -BatchId $BatchId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SedBatchStats -V2024BatchId $BatchId -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024SedBatchStats -BatchId $BatchId -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatchStats"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sed-batches
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
List Sed Batches.
API responses with Sed Batch Status
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sed-batches)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -111,17 +123,21 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# List Sed Batch Request
try {
Get-V2024SedBatches -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024SedBatches -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SedBatches -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024SedBatches -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatches"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-seds
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
List of Suggested Entitlement Descriptions (SED)
SED field descriptions:
@@ -138,6 +154,8 @@ SED field descriptions:
**fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-seds)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -182,19 +200,25 @@ $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are
# List Suggested Entitlement Descriptions
try {
Get-V2024Seds -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024Seds -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024Seds -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Filters $Filters -V2024Sorters $Sorters -V2024Count $Count -V2024CountOnly $CountOnly -V2024RequestedByAnyone $RequestedByAnyone -V2024ShowPendingStatusOnly $ShowPendingStatusOnly
# Get-V2024Seds -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Filters $Filters -Sorters $Sorters -Count $Count -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $ShowPendingStatusOnly
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Seds"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-sed
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Patch Suggested Entitlement Description
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-sed)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -235,20 +259,26 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToSedPatch -Json $SedPatch
Update-V2024Sed -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SedPatch $Result
Update-V2024Sed -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SedPatch $Result
# Below is a request that includes all optional parameters
# Update-V2024Sed -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SedPatch $SedPatch
# Update-V2024Sed -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SedPatch $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Sed"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## submit-sed-approval
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Submit Bulk Approval Request for SED.
Request body takes list of SED Ids. API responses with list of SED Approval Status
[API Spec](https://developer.sailpoint.com/docs/api/v2024/submit-sed-approval)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -285,20 +315,26 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToSedApproval -Json $SedApproval
Submit-V2024SedApproval -V2024XSailPointExperimental $XSailPointExperimental -V2024SedApproval $Result
Submit-V2024SedApproval -XSailPointExperimental $XSailPointExperimental -V2024SedApproval $Result
# Below is a request that includes all optional parameters
# Submit-V2024SedApproval -V2024XSailPointExperimental $XSailPointExperimental -V2024SedApproval $SedApproval
# Submit-V2024SedApproval -XSailPointExperimental $XSailPointExperimental -V2024SedApproval $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedApproval"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## submit-sed-assignment
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Submit Assignment Request.
Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together
[API Spec](https://developer.sailpoint.com/docs/api/v2024/submit-sed-assignment)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -338,20 +374,26 @@ $SedAssignment = @"{
try {
$Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment
Submit-V2024SedAssignment -V2024XSailPointExperimental $XSailPointExperimental -V2024SedAssignment $Result
Submit-V2024SedAssignment -XSailPointExperimental $XSailPointExperimental -V2024SedAssignment $Result
# Below is a request that includes all optional parameters
# Submit-V2024SedAssignment -V2024XSailPointExperimental $XSailPointExperimental -V2024SedAssignment $SedAssignment
# Submit-V2024SedAssignment -XSailPointExperimental $XSailPointExperimental -V2024SedAssignment $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedAssignment"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## submit-sed-batch-request
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Submit Sed Batch Request.
Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together
[API Spec](https://developer.sailpoint.com/docs/api/v2024/submit-sed-batch-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -387,10 +429,10 @@ $SedBatchRequest = @"{
# Submit Sed Batch Request
try {
Submit-V2024SedBatchRequest -V2024XSailPointExperimental $XSailPointExperimental
Submit-V2024SedBatchRequest -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Submit-V2024SedBatchRequest -V2024XSailPointExperimental $XSailPointExperimental -V2024SedBatchRequest $SedBatchRequest
# Submit-V2024SedBatchRequest -XSailPointExperimental $XSailPointExperimental -V2024SedBatchRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedBatchRequest"
Write-Host $_.ErrorDetails

56
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TaggedObjectsApi.md
View File

@@ -79,9 +79,12 @@ Method | HTTP request | Description
[**Set-V2024TagToObject**](#set-tag-to-object) | **POST** `/tagged-objects` | Add Tag to Object
[**Set-V2024TagsToManyObjects**](#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/v2024/delete-tagged-object)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -113,19 +116,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to dele
# Delete Object Tags
try {
Remove-V2024TaggedObject -V2024Type $Type -V2024Id $Id
Remove-V2024TaggedObject -Type $Type -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024TaggedObject -V2024Type $Type -V2024Id $Id
# Remove-V2024TaggedObject -Type $Type -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024TaggedObject"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-tags-to-many-object
This API removes tags from multiple objects.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/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-V2024TagsToManyObject -V2024BulkRemoveTaggedObject $Result
Remove-V2024TagsToManyObject -V2024BulkRemoveTaggedObject $Result
# Below is a request that includes all optional parameters
# Remove-V2024TagsToManyObject -V2024BulkRemoveTaggedObject $BulkRemoveTaggedObject
# Remove-V2024TagsToManyObject -V2024BulkRemoveTaggedObject $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024TagsToManyObject"
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/v2024/get-tagged-object)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -211,21 +220,24 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object referen
# Get Tagged Object
try {
Get-V2024TaggedObject -V2024Type $Type -V2024Id $Id
Get-V2024TaggedObject -Type $Type -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024TaggedObject -V2024Type $Type -V2024Id $Id
# Get-V2024TaggedObject -Type $Type -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObject"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/list-tagged-objects)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -261,21 +273,24 @@ $Filters = 'tagName eq "BU_FINANCE"' # String | Filter results using the standar
# List Tagged Objects
try {
Get-V2024TaggedObjects
Get-V2024TaggedObjects
# Below is a request that includes all optional parameters
# Get-V2024TaggedObjects -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters
# Get-V2024TaggedObjects -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObjects"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/list-tagged-objects-by-type)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -313,19 +328,22 @@ $Filters = 'objectRef.id eq "2c91808568c529c60168cca6f90c1313"' # String | Filte
# List Tagged Objects by Type
try {
Get-V2024TaggedObjectsByType -V2024Type $Type
Get-V2024TaggedObjectsByType -Type $Type
# Below is a request that includes all optional parameters
# Get-V2024TaggedObjectsByType -V2024Type $Type -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters
# Get-V2024TaggedObjectsByType -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObjectsByType"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-tagged-object
This updates a tagged object for the specified type.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-tagged-object)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -367,21 +385,24 @@ $TaggedObject = @"{
try {
$Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject
Send-V2024TaggedObject -V2024Type $Type -V2024Id $Id -V2024TaggedObject $Result
Send-V2024TaggedObject -Type $Type -Id $Id -V2024TaggedObject $Result
# Below is a request that includes all optional parameters
# Send-V2024TaggedObject -V2024Type $Type -V2024Id $Id -V2024TaggedObject $TaggedObject
# Send-V2024TaggedObject -Type $Type -Id $Id -V2024TaggedObject $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TaggedObject"
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/v2024/set-tag-to-object)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -419,19 +440,22 @@ $TaggedObject = @"{
try {
$Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject
Set-V2024TagToObject -V2024TaggedObject $Result
Set-V2024TagToObject -V2024TaggedObject $Result
# Below is a request that includes all optional parameters
# Set-V2024TagToObject -V2024TaggedObject $TaggedObject
# Set-V2024TagToObject -V2024TaggedObject $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TagToObject"
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/v2024/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-V2024TagsToManyObjects -V2024BulkAddTaggedObject $Result
Set-V2024TagsToManyObjects -V2024BulkAddTaggedObject $Result
# Below is a request that includes all optional parameters
# Set-V2024TagsToManyObjects -V2024BulkAddTaggedObject $BulkAddTaggedObject
# Set-V2024TagsToManyObjects -V2024BulkAddTaggedObject $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TagsToManyObjects"
Write-Host $_.ErrorDetails

50
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TaskManagementApi.md
View File

@@ -23,9 +23,15 @@ Method | HTTP request | Description
[**Get-V2024TaskStatusList**](#get-task-status-list) | **GET** `/task-status` | Retrieve Task Status List
[**Update-V2024TaskStatus**](#update-task-status) | **PATCH** `/task-status/{id}` | Update Task Status by ID
## get-pending-task-headers
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Responds with headers only for list of task statuses for pending tasks.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-pending-task-headers)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -62,19 +68,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Retrieve Pending Task List Headers
try {
Get-V2024PendingTaskHeaders -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024PendingTaskHeaders -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count
# Get-V2024PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingTaskHeaders"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-pending-tasks
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-pending-tasks)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -111,19 +123,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Retrieve Pending Task Status List
try {
Get-V2024PendingTasks -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024PendingTasks -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024PendingTasks -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count
# Get-V2024PendingTasks -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingTasks"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-task-status
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-task-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -156,20 +174,26 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get Task Status by ID
try {
Get-V2024TaskStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024TaskStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaskStatus"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-task-status-list
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/v2024/get-pending-tasks) endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-task-status-list)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -210,19 +234,25 @@ $Sorters = "-created" # String | Sort results using the standard syntax describe
# Retrieve Task Status List
try {
Get-V2024TaskStatusList -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024TaskStatusList -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024TaskStatusList -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024TaskStatusList -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaskStatusList"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-task-status
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-task-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -263,10 +293,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024TaskStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
Update-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024TaskStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024TaskStatus"
Write-Host $_.ErrorDetails

10
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TenantApi.md
View File

@@ -19,9 +19,15 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024Tenant**](#get-tenant) | **GET** `/tenant` | Get Tenant Information.
## get-tenant
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This rest endpoint can be used to retrieve tenant details.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-tenant)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -52,10 +58,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get Tenant Information.
try {
Get-V2024Tenant -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024Tenant -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024Tenant -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024Tenant -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Tenant"
Write-Host $_.ErrorDetails

35
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TransformsApi.md
View File

@@ -29,9 +29,12 @@ Method | HTTP request | Description
[**Get-V2024Transforms**](#list-transforms) | **GET** `/transforms` | List transforms
[**Update-V2024Transform**](#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/v2024/create-transform)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -83,19 +86,22 @@ $Transform = @"{
try {
$Result = ConvertFrom-JsonToTransform -Json $Transform
New-V2024Transform -V2024Transform $Result
New-V2024Transform -V2024Transform $Result
# Below is a request that includes all optional parameters
# New-V2024Transform -V2024Transform $Transform
# New-V2024Transform -V2024Transform $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Transform"
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/v2024/delete-transform)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -126,19 +132,22 @@ $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete
# Delete a transform
try {
Remove-V2024Transform -V2024Id $Id
Remove-V2024Transform -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024Transform -V2024Id $Id
# Remove-V2024Transform -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Transform"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-transform
This API returns the transform specified by the given ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-transform)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -169,19 +178,22 @@ $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retriev
# Transform by ID
try {
Get-V2024Transform -V2024Id $Id
Get-V2024Transform -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024Transform -V2024Id $Id
# Get-V2024Transform -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Transform"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-transforms
Gets a list of all saved transform objects.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-transforms)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -220,19 +232,22 @@ $Filters = 'name eq "Uppercase"' # String | Filter results using the standard sy
# List transforms
try {
Get-V2024Transforms
Get-V2024Transforms
# Below is a request that includes all optional parameters
# Get-V2024Transforms -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Name $Name -V2024Filters $Filters
# Get-V2024Transforms -Offset $Offset -Limit $Limit -Count $Count -Name $Name -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Transforms"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/update-transform)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -285,10 +300,10 @@ $Transform = @"{
# Update a transform
try {
Update-V2024Transform -V2024Id $Id
Update-V2024Transform -Id $Id
# Below is a request that includes all optional parameters
# Update-V2024Transform -V2024Id $Id -V2024Transform $Transform
# Update-V2024Transform -Id $Id -V2024Transform $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Transform"
Write-Host $_.ErrorDetails

100
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TriggersApi.md
View File

@@ -69,9 +69,15 @@ Method | HTTP request | Description
[**Test-V2024SubscriptionFilter**](#test-subscription-filter) | **POST** `/trigger-subscriptions/validate-filter` | Validate a Subscription Filter
[**Update-V2024Subscription**](#update-subscription) | **PUT** `/trigger-subscriptions/{id}` | Update a Subscription
## complete-trigger-invocation
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Completes an invocation to a REQUEST_RESPONSE type trigger.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/complete-trigger-invocation)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -112,21 +118,27 @@ $CompleteInvocation = @"{
try {
$Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation
Complete-V2024TriggerInvocation -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024CompleteInvocation $Result
Complete-V2024TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024CompleteInvocation $Result
# Below is a request that includes all optional parameters
# Complete-V2024TriggerInvocation -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024CompleteInvocation $CompleteInvocation
# Complete-V2024TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024CompleteInvocation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024TriggerInvocation"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-subscription
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required:
* HTTP subscriptions require httpConfig
* EventBridge subscriptions require eventBridgeConfig
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-subscription)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -183,19 +195,25 @@ $SubscriptionPostRequest = @"{
try {
$Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest
New-V2024Subscription -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPostRequest $Result
New-V2024Subscription -XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPostRequest $Result
# Below is a request that includes all optional parameters
# New-V2024Subscription -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPostRequest $SubscriptionPostRequest
# New-V2024Subscription -XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPostRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Subscription"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-subscription
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Deletes an existing subscription to a trigger.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-subscription)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -228,19 +246,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Delete a Subscription
try {
Remove-V2024Subscription -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Remove-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024Subscription -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Remove-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Subscription"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-subscriptions
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Gets a list of all trigger subscriptions.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-subscriptions)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -280,21 +304,27 @@ $Sorters = "triggerName" # String | Sort results using the standard syntax descr
# List Subscriptions
try {
Get-V2024Subscriptions -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024Subscriptions -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024Subscriptions -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024Subscriptions -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Subscriptions"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-trigger-invocation-status
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Gets a list of latest invocation statuses.
Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours.
This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-trigger-invocation-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -334,19 +364,25 @@ $Sorters = "created" # String | Sort results using the standard syntax described
# List Latest Invocation Statuses
try {
Get-V2024TriggerInvocationStatus -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024TriggerInvocationStatus -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024TriggerInvocationStatus -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024TriggerInvocationStatus -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TriggerInvocationStatus"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-triggers
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Gets a list of triggers that are available in the tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-triggers)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -386,21 +422,27 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
# List Triggers
try {
Get-V2024Triggers -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024Triggers -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024Triggers -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024Triggers -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Triggers"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-subscription
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable:
**name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig**
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-subscription)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -437,19 +479,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner
Update-V2024Subscription -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPatchRequestInner $Result
Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPatchRequestInner $Result
# Below is a request that includes all optional parameters
# Update-V2024Subscription -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPatchRequestInner $SubscriptionPatchRequestInner
# Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPatchRequestInner $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Subscription"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-test-trigger-invocation
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-test-trigger-invocation)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -492,20 +540,26 @@ $TestInvocation = @"{
try {
$Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation
Start-V2024TestTriggerInvocation -V2024XSailPointExperimental $XSailPointExperimental -V2024TestInvocation $Result
Start-V2024TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -V2024TestInvocation $Result
# Below is a request that includes all optional parameters
# Start-V2024TestTriggerInvocation -V2024XSailPointExperimental $XSailPointExperimental -V2024TestInvocation $TestInvocation
# Start-V2024TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -V2024TestInvocation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024TestTriggerInvocation"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## test-subscription-filter
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Validates a JSONPath filter expression against a provided mock input.
Request requires a security scope of:
[API Spec](https://developer.sailpoint.com/docs/api/v2024/test-subscription-filter)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -543,17 +597,21 @@ $ValidateFilterInputDto = @"{
try {
$Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto
Test-V2024SubscriptionFilter -V2024XSailPointExperimental $XSailPointExperimental -V2024ValidateFilterInputDto $Result
Test-V2024SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -V2024ValidateFilterInputDto $Result
# Below is a request that includes all optional parameters
# Test-V2024SubscriptionFilter -V2024XSailPointExperimental $XSailPointExperimental -V2024ValidateFilterInputDto $ValidateFilterInputDto
# Test-V2024SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -V2024ValidateFilterInputDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SubscriptionFilter"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-subscription
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing
Subscription is completely replaced. The following fields are immutable:
@@ -565,6 +623,8 @@ This API updates a trigger subscription in IdentityNow, using a full object repr
Attempts to modify these fields result in 400.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-subscription)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -623,10 +683,10 @@ $SubscriptionPutRequest = @"{
try {
$Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest
Update-V2024Subscription -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPutRequest $Result
Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPutRequest $Result
# Below is a request that includes all optional parameters
# Update-V2024Subscription -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPutRequest $SubscriptionPutRequest
# Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPutRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Subscription"
Write-Host $_.ErrorDetails

20
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024UIMetadataApi.md
View File

@@ -21,9 +21,15 @@ Method | HTTP request | Description
[**Get-V2024TenantUiMetadata**](#get-tenant-ui-metadata) | **GET** `/ui-metadata/tenant` | Get a tenant UI metadata
[**Set-V2024TenantUiMetadata**](#set-tenant-ui-metadata) | **PUT** `/ui-metadata/tenant` | Update tenant UI metadata
## get-tenant-ui-metadata
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API endpoint retrieves UI metadata configured for your tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-tenant-ui-metadata)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -54,19 +60,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get a tenant UI metadata
try {
Get-V2024TenantUiMetadata -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024TenantUiMetadata -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TenantUiMetadata"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-tenant-ui-metadata
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-tenant-ui-metadata)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -104,10 +116,10 @@ $TenantUiMetadataItemUpdateRequest = @"{
try {
$Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest
Set-V2024TenantUiMetadata -V2024XSailPointExperimental $XSailPointExperimental -V2024TenantUiMetadataItemUpdateRequest $Result
Set-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -V2024TenantUiMetadataItemUpdateRequest $Result
# Below is a request that includes all optional parameters
# Set-V2024TenantUiMetadata -V2024XSailPointExperimental $XSailPointExperimental -V2024TenantUiMetadataItemUpdateRequest $TenantUiMetadataItemUpdateRequest
# Set-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -V2024TenantUiMetadataItemUpdateRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TenantUiMetadata"
Write-Host $_.ErrorDetails

19
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024VendorConnectorMappingsApi.md
View File

@@ -25,10 +25,13 @@ Method | HTTP request | Description
[**Remove-V2024VendorConnectorMapping**](#delete-vendor-connector-mapping) | **DELETE** `/vendor-connector-mappings` | Delete Vendor Connector Mapping
[**Get-V2024VendorConnectorMappings**](#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/v2024/create-vendor-connector-mapping)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -82,20 +85,23 @@ $VendorConnectorMapping = @"{
try {
$Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping
New-V2024VendorConnectorMapping -V2024VendorConnectorMapping $Result
New-V2024VendorConnectorMapping -V2024VendorConnectorMapping $Result
# Below is a request that includes all optional parameters
# New-V2024VendorConnectorMapping -V2024VendorConnectorMapping $VendorConnectorMapping
# New-V2024VendorConnectorMapping -V2024VendorConnectorMapping $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024VendorConnectorMapping"
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/v2024/delete-vendor-connector-mapping)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -149,20 +155,23 @@ $VendorConnectorMapping = @"{
try {
$Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping
Remove-V2024VendorConnectorMapping -V2024VendorConnectorMapping $Result
Remove-V2024VendorConnectorMapping -V2024VendorConnectorMapping $Result
# Below is a request that includes all optional parameters
# Remove-V2024VendorConnectorMapping -V2024VendorConnectorMapping $VendorConnectorMapping
# Remove-V2024VendorConnectorMapping -V2024VendorConnectorMapping $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024VendorConnectorMapping"
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/v2024/get-vendor-connector-mappings)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -191,7 +200,7 @@ Code | Description | Data Type
# List Vendor Connector Mappings
try {
Get-V2024VendorConnectorMappings
Get-V2024VendorConnectorMappings
# Below is a request that includes all optional parameters
# Get-V2024VendorConnectorMappings

91
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkItemsApi.md
View File

@@ -45,9 +45,12 @@ Method | HTTP request | Description
[**Send-V2024WorkItemForward**](#send-work-item-forward) | **POST** `/work-items/{id}/forward` | Forward a Work Item
[**Submit-V2024AccountSelection**](#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/v2024/approve-approval-item)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -80,19 +83,22 @@ $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the ap
# Approve an Approval Item
try {
Approve-V2024ApprovalItem -V2024Id $Id -V2024ApprovalItemId $ApprovalItemId
Approve-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId
# Below is a request that includes all optional parameters
# Approve-V2024ApprovalItem -V2024Id $Id -V2024ApprovalItemId $ApprovalItemId
# Approve-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024ApprovalItem"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/approve-approval-items-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -123,19 +129,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
# Bulk approve Approval Items
try {
Approve-V2024ApprovalItemsInBulk -V2024Id $Id
Approve-V2024ApprovalItemsInBulk -Id $Id
# Below is a request that includes all optional parameters
# Approve-V2024ApprovalItemsInBulk -V2024Id $Id
# Approve-V2024ApprovalItemsInBulk -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024ApprovalItemsInBulk"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/complete-work-item)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -166,19 +175,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
# Complete a Work Item
try {
Complete-V2024WorkItem -V2024Id $Id
Complete-V2024WorkItem -Id $Id
# Below is a request that includes all optional parameters
# Complete-V2024WorkItem -V2024Id $Id
# Complete-V2024WorkItem -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024WorkItem"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-completed-work-items)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -214,19 +226,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Completed Work Items
try {
Get-V2024CompletedWorkItems
Get-V2024CompletedWorkItems
# Below is a request that includes all optional parameters
# Get-V2024CompletedWorkItems -V2024OwnerId $OwnerId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count
# Get-V2024CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompletedWorkItems"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-count-completed-work-items)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -256,19 +271,22 @@ $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item own
# Count Completed Work Items
try {
Get-V2024CountCompletedWorkItems
Get-V2024CountCompletedWorkItems
# Below is a request that includes all optional parameters
# Get-V2024CountCompletedWorkItems -V2024OwnerId $OwnerId
# Get-V2024CountCompletedWorkItems -OwnerId $OwnerId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountCompletedWorkItems"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-count-work-items)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -298,19 +316,22 @@ $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item own
# Count Work Items
try {
Get-V2024CountWorkItems
Get-V2024CountWorkItems
# Below is a request that includes all optional parameters
# Get-V2024CountWorkItems -V2024OwnerId $OwnerId
# Get-V2024CountWorkItems -OwnerId $OwnerId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountWorkItems"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-work-item)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -340,19 +361,22 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item.
# Get a Work Item
try {
Get-V2024WorkItem -V2024Id $Id
Get-V2024WorkItem -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024WorkItem -V2024Id $Id
# Get-V2024WorkItem -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItem"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-work-items-summary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -382,19 +406,22 @@ $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item own
# Work Items Summary
try {
Get-V2024WorkItemsSummary
Get-V2024WorkItemsSummary
# Below is a request that includes all optional parameters
# Get-V2024WorkItemsSummary -V2024OwnerId $OwnerId
# Get-V2024WorkItemsSummary -OwnerId $OwnerId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItemsSummary"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/list-work-items)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -430,19 +457,22 @@ $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item own
# List Work Items
try {
Get-V2024WorkItems
Get-V2024WorkItems
# Below is a request that includes all optional parameters
# Get-V2024WorkItems -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024OwnerId $OwnerId
# Get-V2024WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItems"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/reject-approval-item)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -475,19 +505,22 @@ $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the ap
# Reject an Approval Item
try {
Deny-V2024ApprovalItem -V2024Id $Id -V2024ApprovalItemId $ApprovalItemId
Deny-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId
# Below is a request that includes all optional parameters
# Deny-V2024ApprovalItem -V2024Id $Id -V2024ApprovalItemId $ApprovalItemId
# Deny-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItem"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/reject-approval-items-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -518,19 +551,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
# Bulk reject Approval Items
try {
Deny-V2024ApprovalItemsInBulk -V2024Id $Id
Deny-V2024ApprovalItemsInBulk -Id $Id
# Below is a request that includes all optional parameters
# Deny-V2024ApprovalItemsInBulk -V2024Id $Id
# Deny-V2024ApprovalItemsInBulk -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItemsInBulk"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/send-work-item-forward)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -567,19 +603,22 @@ $WorkItemForward = @"{
try {
$Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward
Send-V2024WorkItemForward -V2024Id $Id -V2024WorkItemForward $Result
Send-V2024WorkItemForward -Id $Id -V2024WorkItemForward $Result
# Below is a request that includes all optional parameters
# Send-V2024WorkItemForward -V2024Id $Id -V2024WorkItemForward $WorkItemForward
# Send-V2024WorkItemForward -Id $Id -V2024WorkItemForward $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024WorkItemForward"
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/v2024/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-V2024AccountSelection -V2024Id $Id -V2024RequestBody $Result
Submit-V2024AccountSelection -Id $Id -RequestBody $Result
# Below is a request that includes all optional parameters
# Submit-V2024AccountSelection -V2024Id $Id -V2024RequestBody $RequestBody
# Submit-V2024AccountSelection -Id $Id -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024AccountSelection"
Write-Host $_.ErrorDetails

90
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkReassignmentApi.md
View File

@@ -37,9 +37,15 @@ Method | HTTP request | Description
[**Send-V2024ReassignmentConfig**](#put-reassignment-config) | **PUT** `/reassignment-configurations/{identityId}` | Update Reassignment Configuration
[**Send-V2024TenantConfiguration**](#put-tenant-configuration) | **PUT** `/reassignment-configurations/tenant-config` | Update Tenant-wide Reassignment Configuration settings
## create-reassignment-configuration
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Creates a new Reassignment Configuration for the specified identity.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-reassignment-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -78,19 +84,25 @@ $ConfigurationItemRequest = @"{
try {
$Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest
New-V2024ReassignmentConfiguration -V2024XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result
New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result
# Below is a request that includes all optional parameters
# New-V2024ReassignmentConfiguration -V2024XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $ConfigurationItemRequest
# New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ReassignmentConfiguration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-reassignment-configuration
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Deletes a single reassignment configuration for the specified identity
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-reassignment-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -124,19 +136,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Delete Reassignment Configuration
try {
Remove-V2024ReassignmentConfiguration -V2024IdentityId $IdentityId -V2024ConfigType $ConfigType -V2024XSailPointExperimental $XSailPointExperimental
Remove-V2024ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024ReassignmentConfiguration -V2024IdentityId $IdentityId -V2024ConfigType $ConfigType -V2024XSailPointExperimental $XSailPointExperimental
# Remove-V2024ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ReassignmentConfiguration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-evaluate-reassignment-configuration
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-evaluate-reassignment-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -174,19 +192,25 @@ $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ # String[] | Exclusion filters th
# Evaluate Reassignment Configuration
try {
Get-V2024EvaluateReassignmentConfiguration -V2024IdentityId $IdentityId -V2024ConfigType $ConfigType -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024EvaluateReassignmentConfiguration -V2024IdentityId $IdentityId -V2024ConfigType $ConfigType -V2024XSailPointExperimental $XSailPointExperimental -V2024ExclusionFilters $ExclusionFilters
# Get-V2024EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental -ExclusionFilters $ExclusionFilters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EvaluateReassignmentConfiguration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-reassignment-config-types
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Gets a collection of types which are available in the Reassignment Configuration UI.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-reassignment-config-types)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -216,19 +240,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# List Reassignment Config Types
try {
Get-V2024ReassignmentConfigTypes -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024ReassignmentConfigTypes -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfigTypes"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-reassignment-configuration
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Gets the Reassignment Configuration for an identity.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-reassignment-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -261,19 +291,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get Reassignment Configuration
try {
Get-V2024ReassignmentConfiguration -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024ReassignmentConfiguration -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfiguration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-tenant-config-configuration
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Gets the global Reassignment Configuration settings for the requestor's tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-tenant-config-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -304,19 +340,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get Tenant-wide Reassignment Configuration settings
try {
Get-V2024TenantConfigConfiguration -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024TenantConfigConfiguration -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TenantConfigConfiguration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-reassignment-configurations
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Gets all Reassignment configuration for the current org.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-reassignment-configurations)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -347,19 +389,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# List Reassignment Configurations
try {
Get-V2024ReassignmentConfigurations -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024ReassignmentConfigurations -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfigurations"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-reassignment-config
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Replaces existing Reassignment configuration for an identity with the newly provided configuration.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-reassignment-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -400,19 +448,25 @@ $ConfigurationItemRequest = @"{
try {
$Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest
Send-V2024ReassignmentConfig -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result
Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result
# Below is a request that includes all optional parameters
# Send-V2024ReassignmentConfig -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $ConfigurationItemRequest
# Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ReassignmentConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-tenant-configuration
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-tenant-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -449,10 +503,10 @@ $TenantConfigurationRequest = @"{
try {
$Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest
Send-V2024TenantConfiguration -V2024XSailPointExperimental $XSailPointExperimental -V2024TenantConfigurationRequest $Result
Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -V2024TenantConfigurationRequest $Result
# Below is a request that includes all optional parameters
# Send-V2024TenantConfiguration -V2024XSailPointExperimental $XSailPointExperimental -V2024TenantConfigurationRequest $TenantConfigurationRequest
# Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -V2024TenantConfigurationRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TenantConfiguration"
Write-Host $_.ErrorDetails

122
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkflowsApi.md
View File

@@ -37,9 +37,12 @@ Method | HTTP request | Description
[**Test-V2024ExternalExecuteWorkflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger
[**Test-V2024Workflow**](#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/v2024/cancel-workflow-execution)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -70,19 +73,22 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution I
# Cancel Workflow Execution by ID
try {
Suspend-V2024WorkflowExecution -V2024Id $Id
Suspend-V2024WorkflowExecution -Id $Id
# Below is a request that includes all optional parameters
# Suspend-V2024WorkflowExecution -V2024Id $Id
# Suspend-V2024WorkflowExecution -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024WorkflowExecution"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/create-external-execute-workflow)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -114,19 +120,22 @@ $CreateExternalExecuteWorkflowRequest = @""@
# Execute Workflow via External Trigger
try {
New-V2024ExternalExecuteWorkflow -V2024Id $Id
New-V2024ExternalExecuteWorkflow -Id $Id
# Below is a request that includes all optional parameters
# New-V2024ExternalExecuteWorkflow -V2024Id $Id -V2024CreateExternalExecuteWorkflowRequest $CreateExternalExecuteWorkflowRequest
# New-V2024ExternalExecuteWorkflow -Id $Id -V2024CreateExternalExecuteWorkflowRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ExternalExecuteWorkflow"
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/v2024/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-V2024Workflow -V2024CreateWorkflowRequest $Result
New-V2024Workflow -V2024CreateWorkflowRequest $Result
# Below is a request that includes all optional parameters
# New-V2024Workflow -V2024CreateWorkflowRequest $CreateWorkflowRequest
# New-V2024Workflow -V2024CreateWorkflowRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workflow"
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/v2024/create-workflow-external-trigger)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -199,19 +211,22 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
# Generate External Trigger OAuth Client
try {
New-V2024WorkflowExternalTrigger -V2024Id $Id
New-V2024WorkflowExternalTrigger -Id $Id
# Below is a request that includes all optional parameters
# New-V2024WorkflowExternalTrigger -V2024Id $Id
# New-V2024WorkflowExternalTrigger -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024WorkflowExternalTrigger"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/delete-workflow)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -241,19 +256,22 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow
# Delete Workflow By Id
try {
Remove-V2024Workflow -V2024Id $Id
Remove-V2024Workflow -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024Workflow -V2024Id $Id
# Remove-V2024Workflow -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workflow"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-workflow
Get a single workflow by id.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-workflow)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -283,19 +301,22 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
# Get Workflow By Id
try {
Get-V2024Workflow -V2024Id $Id
Get-V2024Workflow -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024Workflow -V2024Id $Id
# Get-V2024Workflow -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflow"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-workflow-execution)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -326,19 +347,22 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID.
# Get Workflow Execution
try {
Get-V2024WorkflowExecution -V2024Id $Id
Get-V2024WorkflowExecution -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024WorkflowExecution -V2024Id $Id
# Get-V2024WorkflowExecution -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecution"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-workflow-execution-history)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -369,16 +393,17 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execu
# Get Workflow Execution History
try {
Get-V2024WorkflowExecutionHistory -V2024Id $Id
Get-V2024WorkflowExecutionHistory -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024WorkflowExecutionHistory -V2024Id $Id
# Get-V2024WorkflowExecutionHistory -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutionHistory"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/get-workflow-executions)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -430,19 +457,22 @@ $Filters = 'status eq "Failed"' # String | Filter results using the standard syn
# List Workflow Executions
try {
Get-V2024WorkflowExecutions -V2024Id $Id
Get-V2024WorkflowExecutions -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024WorkflowExecutions -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters
# Get-V2024WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutions"
Write-Host $_.ErrorDetails
}
```
[[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/v2024/list-complete-workflow-library)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -474,19 +504,22 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
# List Complete Workflow Library
try {
Get-V2024CompleteWorkflowLibrary
Get-V2024CompleteWorkflowLibrary
# Below is a request that includes all optional parameters
# Get-V2024CompleteWorkflowLibrary -V2024Limit $Limit -V2024Offset $Offset
# Get-V2024CompleteWorkflowLibrary -Limit $Limit -Offset $Offset
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompleteWorkflowLibrary"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-workflow-library-actions
This lists the workflow actions available to you.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workflow-library-actions)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -520,19 +553,22 @@ $Filters = 'id eq "sp:create-campaign"' # String | Filter results using the stan
# List Workflow Library Actions
try {
Get-V2024WorkflowLibraryActions
Get-V2024WorkflowLibraryActions
# Below is a request that includes all optional parameters
# Get-V2024WorkflowLibraryActions -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters
# Get-V2024WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryActions"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-workflow-library-operators
This lists the workflow operators available to you
[API Spec](https://developer.sailpoint.com/docs/api/v2024/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-V2024WorkflowLibraryOperators
Get-V2024WorkflowLibraryOperators
# Below is a request that includes all optional parameters
# Get-V2024WorkflowLibraryOperators
@@ -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/v2024/list-workflow-library-triggers)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -606,19 +645,22 @@ $Filters = 'id eq "idn:identity-attributes-changed"' # String | Filter results u
# List Workflow Library Triggers
try {
Get-V2024WorkflowLibraryTriggers
Get-V2024WorkflowLibraryTriggers
# Below is a request that includes all optional parameters
# Get-V2024WorkflowLibraryTriggers -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters
# Get-V2024WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryTriggers"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-workflows
List all workflows in the tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workflows)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -646,7 +688,7 @@ Code | Description | Data Type
# List Workflows
try {
Get-V2024Workflows
Get-V2024Workflows
# Below is a request that includes all optional parameters
# Get-V2024Workflows
@@ -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/v2024/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-V2024Workflow -V2024Id $Id -V2024JsonPatchOperation $Result
Update-V2024Workflow -Id $Id -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024Workflow -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024Workflow -Id $Id -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workflow"
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/v2024/put-workflow)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -779,19 +827,22 @@ $WorkflowBody = @"{
try {
$Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody
Send-V2024Workflow -V2024Id $Id -V2024WorkflowBody $Result
Send-V2024Workflow -Id $Id -V2024WorkflowBody $Result
# Below is a request that includes all optional parameters
# Send-V2024Workflow -V2024Id $Id -V2024WorkflowBody $WorkflowBody
# Send-V2024Workflow -Id $Id -V2024WorkflowBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Workflow"
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/v2024/test-external-execute-workflow)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -823,21 +874,24 @@ $TestExternalExecuteWorkflowRequest = @""@
# Test Workflow via External Trigger
try {
Test-V2024ExternalExecuteWorkflow -V2024Id $Id
Test-V2024ExternalExecuteWorkflow -Id $Id
# Below is a request that includes all optional parameters
# Test-V2024ExternalExecuteWorkflow -V2024Id $Id -V2024TestExternalExecuteWorkflowRequest $TestExternalExecuteWorkflowRequest
# Test-V2024ExternalExecuteWorkflow -Id $Id -V2024TestExternalExecuteWorkflowRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ExternalExecuteWorkflow"
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/v2024/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-V2024Workflow -V2024Id $Id -V2024TestWorkflowRequest $Result
Test-V2024Workflow -Id $Id -V2024TestWorkflowRequest $Result
# Below is a request that includes all optional parameters
# Test-V2024Workflow -V2024Id $Id -V2024TestWorkflowRequest $TestWorkflowRequest
# Test-V2024Workflow -Id $Id -V2024TestWorkflowRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024Workflow"
Write-Host $_.ErrorDetails

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

@@ -11,7 +11,6 @@ tags: ['SDK', 'Software Development Kit', 'v2024', '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.

2
docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md
View File

@@ -23,7 +23,7 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$AccountUsage = Initialize-PSSailpoint.V2024AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
$AccountUsage = Initialize-PSSailpoint.V2024AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 `
-Count 10
```

2
docs/tools/sdk/powershell/Reference/V2024/Models/AggregationResult.md
View File

@@ -17,7 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'AggregationResult', 'V2024Aggregation
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Aggregations** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The document containing the results of the aggregation. This document is controlled by Elasticsearch and depends on the type of aggregation query that is run. See Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) documentation for information. | [optional]
**Hits** | [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The results of the aggregation search query. | [optional]
**Hits** | [**[]SearchDocument**](search-document) | The results of the aggregation search query. | [optional]
## Examples

2
docs/tools/sdk/powershell/Reference/V2024/Models/CreateSavedSearchRequest.md
View File

@@ -20,7 +20,7 @@ Name | Type | Description | Notes
**Description** | **String** | The description of the saved search. | [optional]
**Created** | **System.DateTime** | A date-time in ISO-8601 format | [optional]
**Modified** | **System.DateTime** | A date-time in ISO-8601 format | [optional]
**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required]
**Indices** | [**[]Index**](Indices) | The names of the Elasticsearch indices in which to search. | [required]
**Columns** | [**map[string]Column[]**](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_arrays?view=powershell-7.4) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional]
**Query** | **String** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [required]
**Fields** | **[]String** | The fields to be searched against in a multi-field query. | [optional]

4
docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md
View File

@@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V2024NonEmployee
-ApprovalStatus null `
-Comment approved `
-CompletionDate 2020-03-24T11:11:41.139-05:00 `
-StartDate Tue Mar 24 00:00:00 UTC 2020 `
-EndDate Thu Mar 25 00:00:00 UTC 2021 `
-StartDate Mon Mar 23 20:00:00 EDT 2020 `
-EndDate Wed Mar 24 20:00:00 EDT 2021 `
-Modified 2020-03-24T11:11:41.139-05:00 `
-Created 2020-03-24T11:11:41.139-05:00
```

2
docs/tools/sdk/powershell/Reference/V2024/Models/PendingApproval.md
View File

@@ -17,6 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'PendingApproval', 'V2024PendingApprov
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | The approval id. | [optional]
**AccessRequestId** | **String** | This is the access request id. | [optional]
**Name** | **String** | The name of the approval. | [optional]
**Created** | **System.DateTime** | When the approval was created. | [optional]
**Modified** | **System.DateTime** | When the approval was modified last time. | [optional]
@@ -41,6 +42,7 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$PendingApproval = Initialize-PSSailpoint.V2024PendingApproval -Id id12345 `
-AccessRequestId 2b838de9db9babcfe646d4f274ad4238 `
-Name aName `
-Created 2017-07-11T18:45:37.098Z `
-Modified 2018-07-25T20:22:28.104Z `

2
docs/tools/sdk/powershell/Reference/V2024/Models/ReportDetailsArguments.md
View File

@@ -21,7 +21,7 @@ Name | Type | Description | Notes
**CorrelatedOnly** | **Boolean** | Flag to specify if only correlated identities are included in report. | [required][default to $false]
**AuthoritativeSource** | **String** | Source ID. | [required]
**SelectedFormats** | **[]String** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional]
**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional]
**Indices** | [**[]Index**](Indices) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional]
**Query** | **String** | The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | [required]
**Columns** | **String** | Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. | [optional]
**Sort** | **[]String** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional]

2
docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearch.md
View File

@@ -20,7 +20,7 @@ Name | Type | Description | Notes
**Description** | **String** | The description of the saved search. | [optional]
**Created** | **System.DateTime** | A date-time in ISO-8601 format | [optional]
**Modified** | **System.DateTime** | A date-time in ISO-8601 format | [optional]
**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required]
**Indices** | [**[]Index**](Indices) | The names of the Elasticsearch indices in which to search. | [required]
**Columns** | [**map[string]Column[]**](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_arrays?view=powershell-7.4) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional]
**Query** | **String** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [required]
**Fields** | **[]String** | The fields to be searched against in a multi-field query. | [optional]

2
docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearchDetail.md
View File

@@ -18,7 +18,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Created** | **System.DateTime** | A date-time in ISO-8601 format | [optional]
**Modified** | **System.DateTime** | A date-time in ISO-8601 format | [optional]
**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required]
**Indices** | [**[]Index**](Indices) | The names of the Elasticsearch indices in which to search. | [required]
**Columns** | [**map[string]Column[]**](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_arrays?view=powershell-7.4) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional]
**Query** | **String** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [required]
**Fields** | **[]String** | The fields to be searched against in a multi-field query. | [optional]

2
docs/tools/sdk/powershell/Reference/V2024/Models/Search.md
View File

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'Search', 'V2024Search']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional]
**Indices** | [**[]Index**](Indices) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional]
**QueryType** | [**QueryType**](query-type) | | [optional]
**QueryVersion** | **String** | | [optional]
**Query** | [**Query**](query) | | [optional]

169
docs/tools/sdk/powershell/Reference/V2024/Models/SearchDocument.md Normal file
View File

@@ -0,0 +1,169 @@
---
id: v2024-search-document
title: SearchDocument
pagination_label: SearchDocument
sidebar_label: SearchDocument
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SearchDocument', 'V2024SearchDocument']
slug: /tools/sdk/powershell/v2024/models/search-document
tags: ['SDK', 'Software Development Kit', 'SearchDocument', 'V2024SearchDocument']
---
# SearchDocument
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | The unique ID of the referenced object. | [required]
**Name** | **String** | The human readable name of the referenced object. | [required]
**Description** | **String** | Access item's description. | [optional]
**Created** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**Modified** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
**Synced** | **System.DateTime** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional]
**Enabled** | **Boolean** | Indicates whether the access item is currently enabled. | [optional] [default to $false]
**Requestable** | **Boolean** | Indicates whether the access item can be requested. | [optional] [default to $true]
**RequestCommentsRequired** | **Boolean** | Indicates whether comments are required for requests to access the item. | [optional] [default to $false]
**Owner** | [**BaseAccessAllOfOwner**](base-access-all-of-owner) | | [optional]
**Type** | [**DocumentType**](document-type) | | [required]
**Source** | [**IdentityDocumentAllOfSource**](identity-document-all-of-source) | | [optional]
**Entitlements** | [**[]BaseEntitlement**](base-entitlement) | Entitlements included with the role. | [optional]
**EntitlementCount** | **Int32** | Number of entitlements included with the role. | [optional]
**Tags** | **[]String** | Tags that have been applied to the object. | [optional]
**Action** | **String** | Name of the event as it's displayed in audit reports. | [optional]
**Stage** | **String** | Activity's current stage. | [optional]
**Origin** | **String** | Activity's origin. | [optional]
**Status** | **String** | Identity's status in SailPoint. | [optional]
**Requester** | [**AccountSource**](account-source) | | [optional]
**Recipient** | [**AccountSource**](account-source) | | [optional]
**TrackingNumber** | **String** | ID of the group of events. | [optional]
**Errors** | **[]String** | Errors provided by the source while completing account actions. | [optional]
**Warnings** | **[]String** | Warnings provided by the source while completing account actions. | [optional]
**Approvals** | [**[]Approval1**](approval1) | Approvals performed on an item during activity. | [optional]
**OriginalRequests** | [**[]OriginalRequest**](original-request) | Original actions that triggered all individual source actions related to the account action. | [optional]
**ExpansionItems** | [**[]ExpansionItem**](expansion-item) | Controls that translated the attribute requests into actual provisioning actions on the source. | [optional]
**AccountRequests** | [**[]AccountRequest**](account-request) | Account data for each individual source action triggered by the original requests. | [optional]
**Sources** | **String** | Sources involved in the account activity. | [optional]
**DisplayName** | **String** | Identity's display name. | [optional]
**Segments** | [**[]BaseSegment**](base-segment) | Segments with the role. | [optional]
**SegmentCount** | **Int32** | Number of segments with the role. | [optional]
**CloudGoverned** | **Boolean** | Indicates whether the entitlement is cloud governed. | [optional] [default to $false]
**Privileged** | **Boolean** | Indicates whether the entitlement is privileged. | [optional] [default to $false]
**IdentityCount** | **Int32** | Number of identities who have access to the entitlement. | [optional]
**Type** | **String** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional]
**Actor** | **String** | Name of the actor that generated the event. | [optional]
**Target** | **String** | Name of the target, or recipient, of the event. | [optional]
**Stack** | **String** | The event's stack. | [optional]
**IpAddress** | **String** | Target system's IP address. | [optional]
**Details** | **String** | ID of event's details. | [optional]
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Map or dictionary of key/value pairs. | [optional]
**Objects** | **[]String** | Objects the event is happening to. | [optional]
**Operation** | **String** | Operation, or action, performed during the event. | [optional]
**TechnicalName** | **String** | Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. | [optional]
**FirstName** | **String** | Identity's first name. | [optional]
**LastName** | **String** | Identity's last name. | [optional]
**Email** | **String** | Identity's primary email address. | [optional]
**Phone** | **String** | Identity's phone number. | [optional]
**Inactive** | **Boolean** | Indicates whether the identity is inactive. | [optional] [default to $false]
**Protected** | **Boolean** | Indicates whether the identity is protected. | [optional] [default to $false]
**EmployeeNumber** | **String** | Identity's employee number. | [optional]
**Manager** | [**IdentityDocumentAllOfManager**](identity-document-all-of-manager) | | [optional]
**IsManager** | **Boolean** | Indicates whether the identity is a manager of other identities. | [optional]
**IdentityProfile** | [**IdentityDocumentAllOfIdentityProfile**](identity-document-all-of-identity-profile) | | [optional]
**ProcessingState** | **String** | Identity's processing state. | [optional]
**ProcessingDetails** | [**ProcessingDetails**](processing-details) | | [optional]
**Accounts** | [**[]BaseAccount**](base-account) | List of accounts associated with the identity. | [optional]
**AccountCount** | **Int32** | Number of accounts associated with the identity. | [optional]
**Apps** | [**[]App**](app) | List of applications the identity has access to. | [optional]
**AppCount** | **Int32** | Number of applications the identity has access to. | [optional]
**Access** | [**[]IdentityAccess**](identity-access) | List of access items assigned to the identity. | [optional]
**AccessCount** | **Int32** | Number of access items assigned to the identity. | [optional]
**RoleCount** | **Int32** | Number of roles assigned to the identity. | [optional]
**AccessProfileCount** | **Int32** | Number of access profiles included with the role. | [optional]
**Owns** | [**[]Owns**](owns) | Access items the identity owns. | [optional]
**OwnsCount** | **Int32** | Number of access items the identity owns. | [optional]
**AccessProfiles** | [**[]BaseAccessProfile**](base-access-profile) | Access profiles included with the role. | [optional]
## Examples
- Prepare the resource
```powershell
$SearchDocument = Initialize-PSSailpoint.V2024SearchDocument -Id 2c91808568c529c60168cca6f90c1313 `
-Name John Doe `
-Description The admin role `
-Created 2018-06-25T20:22:28.104Z `
-Modified 2018-06-25T20:22:28.104Z `
-Synced 2018-06-25T20:22:33.104Z `
-Enabled true `
-Requestable true `
-RequestCommentsRequired false `
-Owner null `
-Type null `
-Source null `
-Entitlements null `
-EntitlementCount 3 `
-Tags [TAG_1, TAG_2] `
-Action update `
-Stage Completed `
-Origin null `
-Status UNREGISTERED `
-Requester null `
-Recipient null `
-TrackingNumber 63f891e0735f4cc8bf1968144a1e7440 `
-Errors null `
-Warnings null `
-Approvals null `
-OriginalRequests null `
-ExpansionItems null `
-AccountRequests null `
-Sources smartsheet-test, airtable-v4, IdentityNow `
-DisplayName Carol.Adams `
-Segments null `
-SegmentCount 1 `
-CloudGoverned false `
-Privileged false `
-IdentityCount 3 `
-Type SYSTEM_CONFIG `
-Actor System `
-Target Carol.Adams `
-Stack tpe `
-IpAddress 52.52.97.85 `
-Details 73b65dfbed1842548c207432a18c84b0 `
-Attributes {country&#x3D;US, firstname&#x3D;Carol, cloudStatus&#x3D;UNREGISTERED} `
-Objects null `
-Operation REQUEST `
-TechnicalName AUTHENTICATION_REQUEST_PASSED `
-FirstName Carol `
-LastName Adams `
-Email Carol.Adams@sailpointdemo.com `
-Phone +1 440-527-3672 `
-Inactive false `
-Protected false `
-EmployeeNumber 1a2a3d4e `
-Manager null `
-IsManager false `
-IdentityProfile null `
-ProcessingState null `
-ProcessingDetails null `
-Accounts null `
-AccountCount 3 `
-Apps null `
-AppCount 2 `
-Access null `
-AccessCount 5 `
-RoleCount 1 `
-AccessProfileCount 1 `
-Owns null `
-OwnsCount 5 `
-AccessProfiles null
```
- Convert the resource to JSON
```powershell
$SearchDocument | ConvertTo-JSON
```
[[Back to top]](#)

2
docs/tools/sdk/powershell/Reference/V2024/Models/SearchExportReportArguments.md
View File

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'SearchExportReportArguments', 'V2024S
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional]
**Indices** | [**[]Index**](Indices) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional]
**Query** | **String** | The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | [required]
**Columns** | **String** | Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. | [optional]
**Sort** | **[]String** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional]

2
docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md
View File

@@ -23,7 +23,7 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$SourceUsage = Initialize-PSSailpoint.V2024SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
$SourceUsage = Initialize-PSSailpoint.V2024SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 `
-Count 10.45
```

5
docs/tools/sdk/powershell/Reference/V2024/Models/index.md
View File

@@ -10,10 +10,9 @@ slug: /tools/sdk/powershell/v2024/models
tags: ['SDK', 'Software Development Kit', 'v2024', 'models']
---
The PowerShell SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API.
The PowerShell SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API.
## Key Features
- Attributes: Describe each attribute, including its name, data type, and whether it's required.
- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits.
- Example: Provides a sample of how the API uses the model.
- Example: Provides a sample of how the API uses the model.