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

28
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessModelMetadataApi.md
View File

@@ -32,9 +32,12 @@ Method | HTTP request | Description
[**Get-BetaAccessModelMetadataAttribute**](#list-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes` | List Access Model Metadata Attributes
[**Get-BetaAccessModelMetadataAttributeValue**](#list-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values` | List Access Model Metadata Values
## get-access-model-metadata-attribute
Get single Access Model Metadata Attribute
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-model-metadata-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -64,19 +67,22 @@ $Key = "iscPrivacy" # String | Technical name of the Attribute.
# Get Access Model Metadata Attribute
try {
Get-BetaAccessModelMetadataAttribute -BetaKey $Key
Get-BetaAccessModelMetadataAttribute -Key $Key
# Below is a request that includes all optional parameters
# Get-BetaAccessModelMetadataAttribute -BetaKey $Key
# Get-BetaAccessModelMetadataAttribute -Key $Key
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttribute"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-access-model-metadata-attribute-value
Get single Access Model Metadata Attribute Value
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-model-metadata-attribute-value)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -108,19 +114,22 @@ $Value = "public" # String | Technical name of the Attribute value.
# Get Access Model Metadata Value
try {
Get-BetaAccessModelMetadataAttributeValue -BetaKey $Key -BetaValue $Value
Get-BetaAccessModelMetadataAttributeValue -Key $Key -Value $Value
# Below is a request that includes all optional parameters
# Get-BetaAccessModelMetadataAttributeValue -BetaKey $Key -BetaValue $Value
# Get-BetaAccessModelMetadataAttributeValue -Key $Key -Value $Value
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttributeValue"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-access-model-metadata-attribute
Get a list of Access Model Metadata Attributes
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-access-model-metadata-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -150,19 +159,22 @@ $Filters = 'name eq "Privacy"' # String | Filter results using the standard synt
# List Access Model Metadata Attributes
try {
Get-BetaAccessModelMetadataAttribute
Get-BetaAccessModelMetadataAttribute
# Below is a request that includes all optional parameters
# Get-BetaAccessModelMetadataAttribute -BetaFilters $Filters
# Get-BetaAccessModelMetadataAttribute -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttribute"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-access-model-metadata-attribute-value
Get a list of Access Model Metadata Attribute Values
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-access-model-metadata-attribute-value)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -192,10 +204,10 @@ $Key = "iscPrivacy" # String | Technical name of the Attribute.
# List Access Model Metadata Values
try {
Get-BetaAccessModelMetadataAttributeValue -BetaKey $Key
Get-BetaAccessModelMetadataAttributeValue -Key $Key
# Below is a request that includes all optional parameters
# Get-BetaAccessModelMetadataAttributeValue -BetaKey $Key
# Get-BetaAccessModelMetadataAttributeValue -Key $Key
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttributeValue"
Write-Host $_.ErrorDetails

56
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md
View File

@@ -60,11 +60,14 @@ Method | HTTP request | Description
[**Update-BetaAccessProfile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified Access Profile
[**Update-BetaAccessProfilesInBulk**](#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 token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a token 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 will be limited to 2000 characters.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-access-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -179,16 +182,17 @@ $AccessProfile = @"{
try {
$Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile
New-BetaAccessProfile -BetaAccessProfile $Result
New-BetaAccessProfile -BetaAccessProfile $Result
# Below is a request that includes all optional parameters
# New-BetaAccessProfile -BetaAccessProfile $AccessProfile
# New-BetaAccessProfile -BetaAccessProfile $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessProfile"
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 token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In addition, a SOURCE_SUBADMIN token must be able to administer the Source associated with the Access Profile.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-access-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -225,22 +231,25 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to
# Delete the specified Access Profile
try {
Remove-BetaAccessProfile -BetaId $Id
Remove-BetaAccessProfile -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaAccessProfile -BetaId $Id
# Remove-BetaAccessProfile -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfile"
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.
This endpoint can only bulk delete up to a limit of 50 access profiles per request.
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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-access-profiles-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -275,19 +284,22 @@ $AccessProfileBulkDeleteRequest = @"{
try {
$Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest
Remove-BetaAccessProfilesInBulk -BetaAccessProfileBulkDeleteRequest $Result
Remove-BetaAccessProfilesInBulk -BetaAccessProfileBulkDeleteRequest $Result
# Below is a request that includes all optional parameters
# Remove-BetaAccessProfilesInBulk -BetaAccessProfileBulkDeleteRequest $AccessProfileBulkDeleteRequest
# Remove-BetaAccessProfilesInBulk -BetaAccessProfileBulkDeleteRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfilesInBulk"
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/beta/get-access-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -317,20 +329,23 @@ $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile
# Get an Access Profile
try {
Get-BetaAccessProfile -BetaId $Id
Get-BetaAccessProfile -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaAccessProfile -BetaId $Id
# Get-BetaAccessProfile -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfile"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-access-profile-entitlements
Use this API to get a list of an access profile's entitlements.
A user with SOURCE_SUBADMIN authority must have access to the source associated with the specified access profile.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-profile-entitlements)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -370,20 +385,23 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de
# List Access Profile's Entitlements
try {
Get-BetaAccessProfileEntitlements -BetaId $Id
Get-BetaAccessProfileEntitlements -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaAccessProfileEntitlements -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters
# Get-BetaAccessProfileEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfileEntitlements"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-access-profiles
Use this API to get a list of access profiles.
A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-access-profiles)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -427,16 +445,17 @@ $IncludeUnsegmented = $false # Boolean | Indicates whether the response list sho
# List Access Profiles
try {
Get-BetaAccessProfiles
Get-BetaAccessProfiles
# Below is a request that includes all optional parameters
# Get-BetaAccessProfiles -BetaForSubadmin $ForSubadmin -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -BetaForSegmentIds $ForSegmentIds -BetaIncludeUnsegmented $IncludeUnsegmented
# Get-BetaAccessProfiles -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-BetaAccessProfiles"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-access-profile
This API updates an existing Access Profile. The following fields are patchable:
**name**, **description**, **enabled**, **owner**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria**
@@ -445,6 +464,8 @@ A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is requi
> 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/beta/patch-access-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -482,16 +503,17 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-BetaAccessProfile -BetaId $Id -BetaJsonPatchOperation $Result
Update-BetaAccessProfile -Id $Id -BetaJsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-BetaAccessProfile -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation
# Update-BetaAccessProfile -Id $Id -BetaJsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccessProfile"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-access-profiles-in-bulk
This API initiates a bulk update of field requestable for one or more Access Profiles.
@@ -501,6 +523,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 user 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/beta/update-access-profiles-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -533,10 +557,10 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner
Update-BetaAccessProfilesInBulk -BetaAccessProfileBulkUpdateRequestInner $Result
Update-BetaAccessProfilesInBulk -BetaAccessProfileBulkUpdateRequestInner $Result
# Below is a request that includes all optional parameters
# Update-BetaAccessProfilesInBulk -BetaAccessProfileBulkUpdateRequestInner $AccessProfileBulkUpdateRequestInner
# Update-BetaAccessProfilesInBulk -BetaAccessProfileBulkUpdateRequestInner $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccessProfilesInBulk"
Write-Host $_.ErrorDetails

42
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestApprovalsApi.md
View File

@@ -41,9 +41,12 @@ Method | HTTP request | Description
[**Get-BetaPendingApprovals**](#list-pending-approvals) | **GET** `/access-request-approvals/pending` | Pending Access Request Approvals List
[**Deny-BetaAccessRequest**](#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/beta/approve-access-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -85,19 +88,22 @@ $CommentDto = @"{
try {
$Result = ConvertFrom-JsonToCommentDto -Json $CommentDto
Approve-BetaAccessRequest -BetaApprovalId $ApprovalId -BetaCommentDto $Result
Approve-BetaAccessRequest -ApprovalId $ApprovalId -BetaCommentDto $Result
# Below is a request that includes all optional parameters
# Approve-BetaAccessRequest -BetaApprovalId $ApprovalId -BetaCommentDto $CommentDto
# Approve-BetaAccessRequest -ApprovalId $ApprovalId -BetaCommentDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaAccessRequest"
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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/forward-access-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -134,19 +140,22 @@ $ForwardApprovalDto = @"{
try {
$Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto
Invoke-BetaForwardAccessRequest -BetaApprovalId $ApprovalId -BetaForwardApprovalDto $Result
Invoke-BetaForwardAccessRequest -ApprovalId $ApprovalId -BetaForwardApprovalDto $Result
# Below is a request that includes all optional parameters
# Invoke-BetaForwardAccessRequest -BetaApprovalId $ApprovalId -BetaForwardApprovalDto $ForwardApprovalDto
# Invoke-BetaForwardAccessRequest -ApprovalId $ApprovalId -BetaForwardApprovalDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardAccessRequest"
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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-approval-summary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -178,19 +187,22 @@ $FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and tim
# Get Access Requests Approvals Number
try {
Get-BetaAccessRequestApprovalSummary
Get-BetaAccessRequestApprovalSummary
# Below is a request that includes all optional parameters
# Get-BetaAccessRequestApprovalSummary -BetaOwnerId $OwnerId -BetaFromDate $FromDate
# Get-BetaAccessRequestApprovalSummary -OwnerId $OwnerId -FromDate $FromDate
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestApprovalSummary"
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/beta/list-completed-approvals)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -229,19 +241,22 @@ $Sorters = "MySorters" # String | Sort results using the standard syntax describ
# Completed Access Request Approvals List
try {
Get-BetaCompletedApprovals
Get-BetaCompletedApprovals
# Below is a request that includes all optional parameters
# Get-BetaCompletedApprovals -BetaOwnerId $OwnerId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters
# Get-BetaCompletedApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedApprovals"
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/beta/list-pending-approvals)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -280,19 +295,22 @@ $Sorters = "MySorters" # String | Sort results using the standard syntax describ
# Pending Access Request Approvals List
try {
Get-BetaPendingApprovals
Get-BetaPendingApprovals
# Below is a request that includes all optional parameters
# Get-BetaPendingApprovals -BetaOwnerId $OwnerId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters
# Get-BetaPendingApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingApprovals"
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/beta/reject-access-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -334,10 +352,10 @@ $CommentDto = @"{
try {
$Result = ConvertFrom-JsonToCommentDto -Json $CommentDto
Deny-BetaAccessRequest -BetaApprovalId $ApprovalId -BetaCommentDto $Result
Deny-BetaAccessRequest -ApprovalId $ApprovalId -BetaCommentDto $Result
# Below is a request that includes all optional parameters
# Deny-BetaAccessRequest -BetaApprovalId $ApprovalId -BetaCommentDto $CommentDto
# Deny-BetaAccessRequest -ApprovalId $ApprovalId -BetaCommentDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaAccessRequest"
Write-Host $_.ErrorDetails

7
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestIdentityMetricsApi.md
View File

@@ -23,9 +23,12 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaAccessRequestIdentityMetrics**](#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
Use this API to return information access metrics.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-identity-metrics)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -59,10 +62,10 @@ $Type = "ENTITLEMENT" # String | Requested access item's type.
# Return access request identity metrics
try {
Get-BetaAccessRequestIdentityMetrics -BetaIdentityId $IdentityId -BetaRequestedObjectId $RequestedObjectId -BetaType $Type
Get-BetaAccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type
# Below is a request that includes all optional parameters
# Get-BetaAccessRequestIdentityMetrics -BetaIdentityId $IdentityId -BetaRequestedObjectId $RequestedObjectId -BetaType $Type
# Get-BetaAccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestIdentityMetrics"
Write-Host $_.ErrorDetails

40
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md
View File

@@ -39,10 +39,13 @@ Method | HTTP request | Description
[**Get-BetaAccessRequestStatus**](#list-access-request-status) | **GET** `/access-request-status` | Access Request Status
[**Set-BetaAccessRequestConfig**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration
## cancel-access-request
This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step.
In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it.
[API Spec](https://developer.sailpoint.com/docs/api/beta/cancel-access-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -77,16 +80,17 @@ $CancelAccessRequest = @"{
try {
$Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest
Suspend-BetaAccessRequest -BetaCancelAccessRequest $Result
Suspend-BetaAccessRequest -BetaCancelAccessRequest $Result
# Below is a request that includes all optional parameters
# Suspend-BetaAccessRequest -BetaCancelAccessRequest $CancelAccessRequest
# Suspend-BetaAccessRequest -BetaCancelAccessRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaAccessRequest"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## close-access-request
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/).
@@ -101,6 +105,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/beta/close-access-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -136,16 +142,17 @@ $CloseAccessRequest = @"{
try {
$Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest
Close-BetaAccessRequest -BetaCloseAccessRequest $Result
Close-BetaAccessRequest -BetaCloseAccessRequest $Result
# Below is a request that includes all optional parameters
# Close-BetaAccessRequest -BetaCloseAccessRequest $CloseAccessRequest
# Close-BetaAccessRequest -BetaCloseAccessRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-BetaAccessRequest"
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.
@@ -179,6 +186,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/beta/create-access-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -262,19 +271,22 @@ $AccessRequest = @"{
try {
$Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest
New-BetaAccessRequest -BetaAccessRequest $Result
New-BetaAccessRequest -BetaAccessRequest $Result
# Below is a request that includes all optional parameters
# New-BetaAccessRequest -BetaAccessRequest $AccessRequest
# New-BetaAccessRequest -BetaAccessRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessRequest"
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/beta/get-access-request-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -302,7 +314,7 @@ Code | Description | Data Type
# Get Access Request Configuration
try {
Get-BetaAccessRequestConfig
Get-BetaAccessRequestConfig
# Below is a request that includes all optional parameters
# Get-BetaAccessRequestConfig
@@ -312,11 +324,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/beta/list-access-request-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -364,19 +379,22 @@ $RequestState = "request-state=EXECUTING" # String | Filter the results by the s
# Access Request Status
try {
Get-BetaAccessRequestStatus
Get-BetaAccessRequestStatus
# Below is a request that includes all optional parameters
# Get-BetaAccessRequestStatus -BetaRequestedFor $RequestedFor -BetaRequestedBy $RequestedBy -BetaRegardingIdentity $RegardingIdentity -BetaAssignedTo $AssignedTo -BetaCount $Count -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters -BetaSorters $Sorters -BetaRequestState $RequestState
# Get-BetaAccessRequestStatus -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-BetaAccessRequestStatus"
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/beta/set-access-request-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -432,10 +450,10 @@ $AccessRequestConfig = @"{
try {
$Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig
Set-BetaAccessRequestConfig -BetaAccessRequestConfig $Result
Set-BetaAccessRequestConfig -BetaAccessRequestConfig $Result
# Below is a request that includes all optional parameters
# Set-BetaAccessRequestConfig -BetaAccessRequestConfig $AccessRequestConfig
# Set-BetaAccessRequestConfig -BetaAccessRequestConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaAccessRequestConfig"
Write-Host $_.ErrorDetails

14
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountActivitiesApi.md
View File

@@ -53,9 +53,12 @@ Method | HTTP request | Description
[**Get-BetaAccountActivity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get Account Activity
[**Get-BetaAccountActivities**](#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/beta/get-account-activity)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -86,19 +89,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id
# Get Account Activity
try {
Get-BetaAccountActivity -BetaId $Id
Get-BetaAccountActivity -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaAccountActivity -BetaId $Id
# Get-BetaAccountActivity -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountActivity"
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/beta/list-account-activities)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -144,10 +150,10 @@ $Sorters = "MySorters" # String | Sort results using the standard syntax describ
# List Account Activities
try {
Get-BetaAccountActivities
Get-BetaAccountActivities
# Below is a request that includes all optional parameters
# Get-BetaAccountActivities -BetaRequestedFor $RequestedFor -BetaRequestedBy $RequestedBy -BetaRegardingIdentity $RegardingIdentity -BetaType $Type -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters
# Get-BetaAccountActivities -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountActivities"
Write-Host $_.ErrorDetails

7
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountAggregationsApi.md
View File

@@ -29,6 +29,7 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaAccountAggregationStatus**](#get-account-aggregation-status) | **GET** `/account-aggregations/{id}/status` | In-progress Account Aggregation status
## get-account-aggregation-status
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.
@@ -40,6 +41,8 @@ Since this endpoint reports on the status of an *in-progress* account aggregatio
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN or DASHBOARD authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-account-aggregation-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -69,10 +72,10 @@ $Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id
# In-progress Account Aggregation status
try {
Get-BetaAccountAggregationStatus -BetaId $Id
Get-BetaAccountAggregationStatus -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaAccountAggregationStatus -BetaId $Id
# Get-BetaAccountAggregationStatus -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountAggregationStatus"
Write-Host $_.ErrorDetails

7
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountUsagesApi.md
View File

@@ -22,9 +22,12 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaUsagesByAccountId**](#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/beta/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-BetaUsagesByAccountId -BetaAccountId $AccountId
Get-BetaUsagesByAccountId -AccountId $AccountId
# Below is a request that includes all optional parameters
# Get-BetaUsagesByAccountId -BetaAccountId $AccountId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters
# Get-BetaUsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesByAccountId"
Write-Host $_.ErrorDetails

112
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountsApi.md
View File

@@ -61,6 +61,7 @@ Method | HTTP request | Description
[**Unlock-BetaAccount**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock Account
[**Update-BetaAccount**](#update-account) | **PATCH** `/accounts/{id}` | Update Account
## create-account
Submits 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/beta/create-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -114,16 +117,17 @@ $AccountAttributesCreate = @"{
try {
$Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate
New-BetaAccount -BetaAccountAttributesCreate $Result
New-BetaAccount -BetaAccountAttributesCreate $Result
# Below is a request that includes all optional parameters
# New-BetaAccount -BetaAccountAttributesCreate $AccountAttributesCreate
# New-BetaAccount -BetaAccountAttributesCreate $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccount"
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.
@@ -131,6 +135,8 @@ This endpoint only deletes the account from IdentityNow, not the source itself,
A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
>**NOTE:** You can only delete accounts from sources of the "DelimitedFile" type.**
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -161,16 +167,17 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
# Delete Account
try {
Remove-BetaAccount -BetaId $Id
Remove-BetaAccount -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaAccount -BetaId $Id
# Remove-BetaAccount -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccount"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-account-async
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.
@@ -180,6 +187,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/beta/delete-account-async)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -209,20 +218,23 @@ $Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id
# Remove Account
try {
Remove-BetaAccountAsync -BetaId $Id
Remove-BetaAccountAsync -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaAccountAsync -BetaId $Id
# Remove-BetaAccountAsync -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccountAsync"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## disable-account
This API submits a task to disable the account and returns the task ID.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/disable-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -259,19 +271,22 @@ $AccountToggleRequest = @"{
try {
$Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest
Disable-BetaAccount -BetaId $Id -BetaAccountToggleRequest $Result
Disable-BetaAccount -Id $Id -BetaAccountToggleRequest $Result
# Below is a request that includes all optional parameters
# Disable-BetaAccount -BetaId $Id -BetaAccountToggleRequest $AccountToggleRequest
# Disable-BetaAccount -Id $Id -BetaAccountToggleRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccount"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## disable-account-for-identity
This API submits a task to disable IDN account for a single identity.
[API Spec](https://developer.sailpoint.com/docs/api/beta/disable-account-for-identity)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -302,19 +317,22 @@ $Id = "2c91808384203c2d018437e631158309" # String | The identity id.
# Disable IDN Account for Identity
try {
Disable-BetaAccountForIdentity -BetaId $Id
Disable-BetaAccountForIdentity -Id $Id
# Below is a request that includes all optional parameters
# Disable-BetaAccountForIdentity -BetaId $Id
# Disable-BetaAccountForIdentity -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccountForIdentity"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## disable-accounts-for-identities
This API submits tasks to disable IDN account for each identity provided in the request body.
[API Spec](https://developer.sailpoint.com/docs/api/beta/disable-accounts-for-identities)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -347,20 +365,23 @@ $IdentitiesAccountsBulkRequest = @"{
try {
$Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest
Disable-BetaAccountsForIdentities -BetaIdentitiesAccountsBulkRequest $Result
Disable-BetaAccountsForIdentities -BetaIdentitiesAccountsBulkRequest $Result
# Below is a request that includes all optional parameters
# Disable-BetaAccountsForIdentities -BetaIdentitiesAccountsBulkRequest $IdentitiesAccountsBulkRequest
# Disable-BetaAccountsForIdentities -BetaIdentitiesAccountsBulkRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccountsForIdentities"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## enable-account
This API submits a task to enable account and returns the task ID.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/enable-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -397,19 +418,22 @@ $AccountToggleRequest = @"{
try {
$Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest
Enable-BetaAccount -BetaId $Id -BetaAccountToggleRequest $Result
Enable-BetaAccount -Id $Id -BetaAccountToggleRequest $Result
# Below is a request that includes all optional parameters
# Enable-BetaAccount -BetaId $Id -BetaAccountToggleRequest $AccountToggleRequest
# Enable-BetaAccount -Id $Id -BetaAccountToggleRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccount"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## enable-account-for-identity
This API submits a task to enable IDN account for a single identity.
[API Spec](https://developer.sailpoint.com/docs/api/beta/enable-account-for-identity)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -440,19 +464,22 @@ $Id = "2c91808384203c2d018437e631158309" # String | The identity id.
# Enable IDN Account for Identity
try {
Enable-BetaAccountForIdentity -BetaId $Id
Enable-BetaAccountForIdentity -Id $Id
# Below is a request that includes all optional parameters
# Enable-BetaAccountForIdentity -BetaId $Id
# Enable-BetaAccountForIdentity -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccountForIdentity"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## enable-accounts-for-identities
This API submits tasks to enable IDN account for each identity provided in the request body.
[API Spec](https://developer.sailpoint.com/docs/api/beta/enable-accounts-for-identities)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -485,20 +512,23 @@ $IdentitiesAccountsBulkRequest = @"{
try {
$Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest
Enable-BetaAccountsForIdentities -BetaIdentitiesAccountsBulkRequest $Result
Enable-BetaAccountsForIdentities -BetaIdentitiesAccountsBulkRequest $Result
# Below is a request that includes all optional parameters
# Enable-BetaAccountsForIdentities -BetaIdentitiesAccountsBulkRequest $IdentitiesAccountsBulkRequest
# Enable-BetaAccountsForIdentities -BetaIdentitiesAccountsBulkRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccountsForIdentities"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-account
Use this API to return the details for a single account by its ID.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -529,20 +559,23 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
# Account Details
try {
Get-BetaAccount -BetaId $Id
Get-BetaAccount -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaAccount -BetaId $Id
# Get-BetaAccount -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccount"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-account-entitlements
This API returns entitlements of the account.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-account-entitlements)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -579,19 +612,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Account Entitlements
try {
Get-BetaAccountEntitlements -BetaId $Id
Get-BetaAccountEntitlements -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaAccountEntitlements -BetaId $Id -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count
# Get-BetaAccountEntitlements -Id $Id -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountEntitlements"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-accounts
List accounts.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-accounts)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -631,16 +667,17 @@ $Sorters = "id,name" # String | Sort results using the standard syntax described
# Accounts List
try {
Get-BetaAccounts
Get-BetaAccounts
# Below is a request that includes all optional parameters
# Get-BetaAccounts -BetaDetailLevel $DetailLevel -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters
# Get-BetaAccounts -DetailLevel $DetailLevel -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccounts"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-account
Use this API to update an account with a PUT request.
@@ -651,6 +688,8 @@ A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required t
>**Note: You can only use this PUT endpoint to update accounts from flat file sources.**
[API Spec](https://developer.sailpoint.com/docs/api/beta/put-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -692,20 +731,23 @@ $AccountAttributes = @"{
try {
$Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes
Send-BetaAccount -BetaId $Id -BetaAccountAttributes $Result
Send-BetaAccount -Id $Id -BetaAccountAttributes $Result
# Below is a request that includes all optional parameters
# Send-BetaAccount -BetaId $Id -BetaAccountAttributes $AccountAttributes
# Send-BetaAccount -Id $Id -BetaAccountAttributes $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaAccount"
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.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/submit-reload-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -736,21 +778,24 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id
# Reload Account
try {
Submit-BetaReloadAccount -BetaId $Id
Submit-BetaReloadAccount -Id $Id
# Below is a request that includes all optional parameters
# Submit-BetaReloadAccount -BetaId $Id
# Submit-BetaReloadAccount -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaReloadAccount"
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.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/unlock-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -788,16 +833,17 @@ $AccountUnlockRequest = @"{
try {
$Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest
Unlock-BetaAccount -BetaId $Id -BetaAccountUnlockRequest $Result
Unlock-BetaAccount -Id $Id -BetaAccountUnlockRequest $Result
# Below is a request that includes all optional parameters
# Unlock-BetaAccount -BetaId $Id -BetaAccountUnlockRequest $AccountUnlockRequest
# Unlock-BetaAccount -Id $Id -BetaAccountUnlockRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-BetaAccount"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-account
Use this API to update account details.
A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
@@ -812,6 +858,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/beta/update-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -847,10 +895,10 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of account update operat
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Update-BetaAccount -BetaId $Id -BetaRequestBody $Result
Update-BetaAccount -Id $Id -RequestBody $Result
# Below is a request that includes all optional parameters
# Update-BetaAccount -BetaId $Id -BetaRequestBody $RequestBody
# Update-BetaAccount -Id $Id -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccount"
Write-Host $_.ErrorDetails

33
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaApplicationDiscoveryApi.md
View File

@@ -25,10 +25,13 @@ Method | HTTP request | Description
[**Update-BetaDiscoveredApplicationByID**](#patch-discovered-application-by-id) | **PATCH** `/discovered-applications/{id}` | Patch Discovered Application by ID
[**Send-BetaManualDiscoverApplicationsCsvTemplate**](#send-manual-discover-applications-csv-template) | **POST** `/manual-discover-applications` | Upload CSV to Discover Applications
## get-discovered-application-by-id
Get the discovered application, along with with its associated sources, based on the provided ID.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-discovered-application-by-id)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -58,20 +61,23 @@ $Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's
# Get Discovered Application by ID
try {
Get-BetaDiscoveredApplicationByID -BetaId $Id
Get-BetaDiscoveredApplicationByID -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaDiscoveredApplicationByID -BetaId $Id
# Get-BetaDiscoveredApplicationByID -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDiscoveredApplicationByID"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## 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/beta/get-discovered-applications)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -109,22 +115,25 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
# Retrieve discovered applications for tenant
try {
Get-BetaDiscoveredApplications
Get-BetaDiscoveredApplications
# Below is a request that includes all optional parameters
# Get-BetaDiscoveredApplications -BetaLimit $Limit -BetaOffset $Offset -BetaDetail $Detail -BetaFilter $Filter -BetaSorters $Sorters
# Get-BetaDiscoveredApplications -Limit $Limit -Offset $Offset -Detail $Detail -Filter $Filter -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDiscoveredApplications"
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/beta/get-manual-discover-applications-csv-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -152,7 +161,7 @@ Code | Description | Data Type
# Download CSV Template for Discovery
try {
Get-BetaManualDiscoverApplicationsCsvTemplate
Get-BetaManualDiscoverApplicationsCsvTemplate
# Below is a request that includes all optional parameters
# Get-BetaManualDiscoverApplicationsCsvTemplate
@@ -162,10 +171,13 @@ try {
}
```
[[Back to top]](#)
## patch-discovered-application-by-id
Update an existing discovered application by using a limited version of the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
You can patch these fields: - **associatedSources** - **dismissed**
[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-discovered-application-by-id)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -202,20 +214,23 @@ $Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's
# Patch Discovered Application by ID
try {
Update-BetaDiscoveredApplicationByID -BetaId $Id
Update-BetaDiscoveredApplicationByID -Id $Id
# Below is a request that includes all optional parameters
# Update-BetaDiscoveredApplicationByID -BetaId $Id -BetaJsonPatchOperations $JsonPatchOperations
# Update-BetaDiscoveredApplicationByID -Id $Id -BetaJsonPatchOperations $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaDiscoveredApplicationByID"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## send-manual-discover-applications-csv-template
Upload 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/beta/send-manual-discover-applications-csv-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -245,10 +260,10 @@ $File = # System.IO.FileInfo | The CSV file to upload containing `application_n
# Upload CSV to Discover Applications
try {
Send-BetaManualDiscoverApplicationsCsvTemplate -BetaFile $File
Send-BetaManualDiscoverApplicationsCsvTemplate -File $File
# Below is a request that includes all optional parameters
# Send-BetaManualDiscoverApplicationsCsvTemplate -BetaFile $File
# Send-BetaManualDiscoverApplicationsCsvTemplate -File $File
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaManualDiscoverApplicationsCsvTemplate"
Write-Host $_.ErrorDetails

14
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaApprovalsApi.md
View File

@@ -23,9 +23,12 @@ Method | HTTP request | Description
[**Get-BetaApproval**](#get-approval) | **GET** `/generic-approvals/{id}` | Get Approval
[**Get-BetaApprovals**](#get-approvals) | **GET** `/generic-approvals` | Get Approvals
## get-approval
Get a single approval for a given approval ID. This endpoint is for generic approvals, unlike the access-request-approval endpoint, and doesn't include access-request-approvals.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-approval)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -55,20 +58,23 @@ $Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | ID of the approval that
# Get Approval
try {
Get-BetaApproval -BetaId $Id
Get-BetaApproval -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaApproval -BetaId $Id
# Get-BetaApproval -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaApproval"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-approvals
Get a list of approvals, which can be filtered by requester ID, status, or reference type. You can use the "Mine" query parameter to return all approvals for the current approver. This endpoint is for generic approvals, unlike 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/beta/get-approvals)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -102,10 +108,10 @@ $Filters = 'filters=status eq PENDING' # String | Filter results using the stand
# Get Approvals
try {
Get-BetaApprovals
Get-BetaApprovals
# Below is a request that includes all optional parameters
# Get-BetaApprovals -BetaMine $Mine -BetaRequesterId $RequesterId -BetaFilters $Filters
# Get-BetaApprovals -Mine $Mine -RequesterId $RequesterId -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaApprovals"
Write-Host $_.ErrorDetails

98
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAppsApi.md
View File

@@ -34,9 +34,12 @@ Method | HTTP request | Description
[**Update-BetaUserApp**](#patch-user-app) | **PATCH** `/user-apps/{id}` | Patch user app by ID
[**Update-BetaSourceAppsInBulk**](#update-source-apps-in-bulk) | **POST** `/source-apps/bulk-update` | Bulk update source apps
## create-source-app
This endpoint creates a source app using the given source app payload
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-source-app)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -76,19 +79,22 @@ $SourceAppCreateDto = @"{
try {
$Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto
New-BetaSourceApp -BetaSourceAppCreateDto $Result
New-BetaSourceApp -BetaSourceAppCreateDto $Result
# Below is a request that includes all optional parameters
# New-BetaSourceApp -BetaSourceAppCreateDto $SourceAppCreateDto
# New-BetaSourceApp -BetaSourceAppCreateDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourceApp"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-access-profiles-from-source-app-by-bulk
This API returns the final list of access profiles for the specified source app after removing
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-access-profiles-from-source-app-by-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -125,19 +131,22 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Remove-BetaAccessProfilesFromSourceAppByBulk -BetaId $Id -BetaRequestBody $Result
Remove-BetaAccessProfilesFromSourceAppByBulk -Id $Id -RequestBody $Result
# Below is a request that includes all optional parameters
# Remove-BetaAccessProfilesFromSourceAppByBulk -BetaId $Id -BetaRequestBody $RequestBody -BetaLimit $Limit
# Remove-BetaAccessProfilesFromSourceAppByBulk -Id $Id -RequestBody $Result -Limit $Limit
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfilesFromSourceAppByBulk"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-source-app
Use this API to delete a specific source app
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-source-app)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -167,19 +176,22 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID.
# Delete source app by ID
try {
Remove-BetaSourceApp -BetaId $Id
Remove-BetaSourceApp -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaSourceApp -BetaId $Id
# Remove-BetaSourceApp -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSourceApp"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-source-app
This API returns a source app by its ID.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-source-app)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -210,19 +222,22 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app
# Get source app by ID
try {
Get-BetaSourceApp -BetaId $Id
Get-BetaSourceApp -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaSourceApp -BetaId $Id
# Get-BetaSourceApp -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceApp"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-access-profiles-for-source-app
This API returns the list of access profiles for the specified source app
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-access-profiles-for-source-app)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -258,21 +273,24 @@ $Filters = 'name eq "developer access profile"' # String | Filter results using
# List access profiles for the specified source app
try {
Get-BetaAccessProfilesForSourceApp -BetaId $Id
Get-BetaAccessProfilesForSourceApp -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaAccessProfilesForSourceApp -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters
# Get-BetaAccessProfilesForSourceApp -Id $Id -Limit $Limit -Offset $Offset -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfilesForSourceApp"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-all-source-app
This API returns the list of all source apps for the org.
A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-all-source-app)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -310,20 +328,23 @@ $Filters = 'enabled eq true' # String | Filter results using the standard syntax
# List all source apps
try {
Get-BetaAllSourceApp
Get-BetaAllSourceApp
# Below is a request that includes all optional parameters
# Get-BetaAllSourceApp -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset -BetaSorters $Sorters -BetaFilters $Filters
# Get-BetaAllSourceApp -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllSourceApp"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-all-user-apps
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/beta/list-all-user-apps)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -359,19 +380,22 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
# List all user apps
try {
Get-BetaAllUserApps -BetaFilters $Filters
Get-BetaAllUserApps -Filters $Filters
# Below is a request that includes all optional parameters
# Get-BetaAllUserApps -BetaFilters $Filters -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset
# Get-BetaAllUserApps -Filters $Filters -Limit $Limit -Count $Count -Offset $Offset
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllUserApps"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-assigned-source-app
This API returns the list of source apps assigned for logged in user.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-assigned-source-app)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -409,19 +433,22 @@ $Filters = 'name eq "source app name"' # String | Filter results using the stand
# List assigned source apps
try {
Get-BetaAssignedSourceApp
Get-BetaAssignedSourceApp
# Below is a request that includes all optional parameters
# Get-BetaAssignedSourceApp -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset -BetaSorters $Sorters -BetaFilters $Filters
# Get-BetaAssignedSourceApp -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAssignedSourceApp"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-available-accounts-for-user-app
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/beta/list-available-accounts-for-user-app)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -457,19 +484,22 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
# List available accounts for user app
try {
Get-BetaAvailableAccountsForUserApp -BetaId $Id
Get-BetaAvailableAccountsForUserApp -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaAvailableAccountsForUserApp -BetaId $Id -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset
# Get-BetaAvailableAccountsForUserApp -Id $Id -Limit $Limit -Count $Count -Offset $Offset
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAvailableAccountsForUserApp"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-available-source-apps
This API returns the list of source apps available for access request.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-available-source-apps)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -507,19 +537,22 @@ $Filters = 'name eq "source app name"' # String | Filter results using the stand
# List available source apps
try {
Get-BetaAvailableSourceApps
Get-BetaAvailableSourceApps
# Below is a request that includes all optional parameters
# Get-BetaAvailableSourceApps -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset -BetaSorters $Sorters -BetaFilters $Filters
# Get-BetaAvailableSourceApps -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAvailableSourceApps"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-owned-user-apps
This API returns the list of user apps assigned to logged in user
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-owned-user-apps)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -555,21 +588,24 @@ $Filters = 'name eq "user app name"' # String | Filter results using the standar
# List owned user apps
try {
Get-BetaOwnedUserApps
Get-BetaOwnedUserApps
# Below is a request that includes all optional parameters
# Get-BetaOwnedUserApps -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset -BetaFilters $Filters
# Get-BetaOwnedUserApps -Limit $Limit -Count $Count -Offset $Offset -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOwnedUserApps"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-source-app
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/beta/patch-source-app)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -607,20 +643,23 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app to patc
# Patch source app by ID
try {
Update-BetaSourceApp -BetaId $Id
Update-BetaSourceApp -Id $Id
# Below is a request that includes all optional parameters
# Update-BetaSourceApp -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation
# Update-BetaSourceApp -Id $Id -BetaJsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceApp"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-user-app
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/beta/patch-user-app)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -658,21 +697,24 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app to patch
# Patch user app by ID
try {
Update-BetaUserApp -BetaId $Id
Update-BetaUserApp -Id $Id
# Below is a request that includes all optional parameters
# Update-BetaUserApp -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation
# Update-BetaUserApp -Id $Id -BetaJsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaUserApp"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-source-apps-in-bulk
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/beta/update-source-apps-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -714,10 +756,10 @@ $SourceAppBulkUpdateRequest = @"{
# Bulk update source apps
try {
Update-BetaSourceAppsInBulk
Update-BetaSourceAppsInBulk
# Below is a request that includes all optional parameters
# Update-BetaSourceAppsInBulk -BetaSourceAppBulkUpdateRequest $SourceAppBulkUpdateRequest
# Update-BetaSourceAppsInBulk -BetaSourceAppBulkUpdateRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceAppsInBulk"
Write-Host $_.ErrorDetails

19
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAuthProfileApi.md
View File

@@ -27,9 +27,12 @@ Method | HTTP request | Description
[**Get-BetaProfileConfigList**](#get-profile-config-list) | **GET** `/auth-profiles` | Get list of Auth Profiles.
[**Update-BetaProfileConfig**](#patch-profile-config) | **PATCH** `/auth-profiles/{id}` | Patch a specified Auth Profile
## get-profile-config
This API returns auth profile information.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-profile-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -60,19 +63,22 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to ge
# Get Auth Profile.
try {
Get-BetaProfileConfig -BetaId $Id
Get-BetaProfileConfig -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaProfileConfig -BetaId $Id
# Get-BetaProfileConfig -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProfileConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-profile-config-list
This API returns a list of auth profiles.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-profile-config-list)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -100,7 +106,7 @@ Code | Description | Data Type
# Get list of Auth Profiles.
try {
Get-BetaProfileConfigList
Get-BetaProfileConfigList
# Below is a request that includes all optional parameters
# Get-BetaProfileConfigList
@@ -110,10 +116,13 @@ try {
}
```
[[Back to top]](#)
## patch-profile-config
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/beta/patch-profile-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -151,10 +160,10 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to pa
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-BetaProfileConfig -BetaId $Id -BetaJsonPatchOperation $Result
Update-BetaProfileConfig -Id $Id -BetaJsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-BetaProfileConfig -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation
# Update-BetaProfileConfig -Id $Id -BetaJsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProfileConfig"
Write-Host $_.ErrorDetails

218
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCertificationCampaignsApi.md
View File

@@ -105,7 +105,11 @@ Method | HTTP request | Description
[**Start-BetaGenerateCampaignTemplate**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a Campaign from Template
[**Update-BetaCampaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a Campaign
## complete-campaign
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
:::caution
This endpoint will run successfully for any campaigns that are **past due**.
@@ -120,6 +124,8 @@ can complete a certification even if all items have not been completed. Though t
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/complete-campaign)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -154,22 +160,28 @@ $CompleteCampaignOptions = @"{
# Complete a Campaign
try {
Complete-BetaCampaign -BetaId $Id
Complete-BetaCampaign -Id $Id
# Below is a request that includes all optional parameters
# Complete-BetaCampaign -BetaId $Id -BetaCompleteCampaignOptions $CompleteCampaignOptions
# Complete-BetaCampaign -Id $Id -BetaCompleteCampaignOptions $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaCampaign"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-campaign
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Use this API to create a certification campaign with the information provided in the request body. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-campaign)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -308,22 +320,28 @@ $Campaign = @"{
try {
$Result = ConvertFrom-JsonToCampaign -Json $Campaign
New-BetaCampaign -BetaCampaign $Result
New-BetaCampaign -BetaCampaign $Result
# Below is a request that includes all optional parameters
# New-BetaCampaign -BetaCampaign $Campaign
# New-BetaCampaign -BetaCampaign $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCampaign"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-campaign-template
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Use this API to create a campaign template based on campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign-template).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-campaign-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -477,22 +495,28 @@ $CampaignTemplate = @"{
try {
$Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate
New-BetaCampaignTemplate -BetaCampaignTemplate $Result
New-BetaCampaignTemplate -BetaCampaignTemplate $Result
# Below is a request that includes all optional parameters
# New-BetaCampaignTemplate -BetaCampaignTemplate $CampaignTemplate
# New-BetaCampaignTemplate -BetaCampaignTemplate $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCampaignTemplate"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-campaign-template
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Use this API to delete a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-campaign-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -523,22 +547,28 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template
# Delete a Campaign Template
try {
Remove-BetaCampaignTemplate -BetaId $Id
Remove-BetaCampaignTemplate -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaCampaignTemplate -BetaId $Id
# Remove-BetaCampaignTemplate -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaignTemplate"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-campaign-template-schedule
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template-schedule).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-campaign-template-schedule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -569,22 +599,28 @@ $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template
# Delete Campaign Template Schedule
try {
Remove-BetaCampaignTemplateSchedule -BetaId $Id
Remove-BetaCampaignTemplateSchedule -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaCampaignTemplateSchedule -BetaId $Id
# Remove-BetaCampaignTemplateSchedule -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaignTemplateSchedule"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-campaigns
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaigns).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-campaigns)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -618,22 +654,28 @@ $DeleteCampaignsRequest = @"{
try {
$Result = ConvertFrom-JsonToDeleteCampaignsRequest -Json $DeleteCampaignsRequest
Remove-BetaCampaigns -BetaDeleteCampaignsRequest $Result
Remove-BetaCampaigns -BetaDeleteCampaignsRequest $Result
# Below is a request that includes all optional parameters
# Remove-BetaCampaigns -BetaDeleteCampaignsRequest $DeleteCampaignsRequest
# Remove-BetaCampaigns -BetaDeleteCampaignsRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaigns"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-active-campaigns
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Use this API to get a list of campaigns. The API can provide increased level of detail for each campaign for the correct provided query. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-active-campaigns).
A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-active-campaigns)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -673,22 +715,28 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
# List Campaigns
try {
Get-BetaActiveCampaigns
Get-BetaActiveCampaigns
# Below is a request that includes all optional parameters
# Get-BetaActiveCampaigns -BetaDetail $Detail -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters
# Get-BetaActiveCampaigns -Detail $Detail -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaActiveCampaigns"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-campaign
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Use this API to get information for an existing certification campaign by the campaign's ID. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-campaign)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -719,22 +767,28 @@ $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be ret
# Get Campaign
try {
Get-BetaCampaign -BetaId $Id
Get-BetaCampaign -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaCampaign -BetaId $Id
# Get-BetaCampaign -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaign"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-campaign-reports
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Use this API to fetch all reports for a certification campaign by campaign ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports).
A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-campaign-reports)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -765,22 +819,28 @@ $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose rep
# Get Campaign Reports
try {
Get-BetaCampaignReports -BetaId $Id
Get-BetaCampaignReports -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaCampaignReports -BetaId $Id
# Get-BetaCampaignReports -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignReports"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-campaign-reports-config
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports-config).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-campaign-reports-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -808,7 +868,7 @@ Code | Description | Data Type
# Get Campaign Reports Configuration
try {
Get-BetaCampaignReportsConfig
Get-BetaCampaignReportsConfig
# Below is a request that includes all optional parameters
# Get-BetaCampaignReportsConfig
@@ -818,12 +878,18 @@ try {
}
```
[[Back to top]](#)
## get-campaign-template
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Use this API to fetch a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-campaign-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -854,22 +920,28 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template'
# Get a Campaign Template
try {
Get-BetaCampaignTemplate -BetaId $Id
Get-BetaCampaignTemplate -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaCampaignTemplate -BetaId $Id
# Get-BetaCampaignTemplate -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplate"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-campaign-template-schedule
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template-schedule).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-campaign-template-schedule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -900,17 +972,21 @@ $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template
# Get Campaign Template Schedule
try {
Get-BetaCampaignTemplateSchedule -BetaId $Id
Get-BetaCampaignTemplateSchedule -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaCampaignTemplateSchedule -BetaId $Id
# Get-BetaCampaignTemplateSchedule -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplateSchedule"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-campaign-templates
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/list-campaign-templates).
The endpoint returns all campaign templates matching the query parameters.
@@ -918,6 +994,8 @@ The endpoint returns all campaign templates matching the query parameters.
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-campaign-templates)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -955,22 +1033,28 @@ $Filters = 'name eq "manager template"' # String | Filter results using the stan
# List Campaign Templates
try {
Get-BetaCampaignTemplates
Get-BetaCampaignTemplates
# Below is a request that includes all optional parameters
# Get-BetaCampaignTemplates -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters
# Get-BetaCampaignTemplates -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplates"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## move
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
This API reassigns the specified certifications from one identity to another. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/move).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/move)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1011,22 +1095,28 @@ $AdminReviewReassign = @"{
try {
$Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign
Move-Beta -BetaId $Id -BetaAdminReviewReassign $Result
Move-Beta -Id $Id -BetaAdminReviewReassign $Result
# Below is a request that includes all optional parameters
# Move-Beta -BetaId $Id -BetaAdminReviewReassign $AdminReviewReassign
# Move-Beta -Id $Id -BetaAdminReviewReassign $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-Beta"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-campaign-template
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/patch-campaign-template).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-campaign-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1065,22 +1155,28 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-BetaCampaignTemplate -BetaId $Id -BetaJsonPatchOperation $Result
Update-BetaCampaignTemplate -Id $Id -BetaJsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-BetaCampaignTemplate -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation
# Update-BetaCampaignTemplate -Id $Id -BetaJsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCampaignTemplate"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-campaign-reports-config
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Use this API to overwrite the configuration for campaign reports. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-reports-config).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/set-campaign-reports-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1113,23 +1209,29 @@ $CampaignReportsConfig = @"{
try {
$Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig
Set-BetaCampaignReportsConfig -BetaCampaignReportsConfig $Result
Set-BetaCampaignReportsConfig -BetaCampaignReportsConfig $Result
# Below is a request that includes all optional parameters
# Set-BetaCampaignReportsConfig -BetaCampaignReportsConfig $CampaignReportsConfig
# Set-BetaCampaignReportsConfig -BetaCampaignReportsConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaCampaignReportsConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-campaign-template-schedule
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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.
Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-template-schedule).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/set-campaign-template-schedule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1181,22 +1283,28 @@ $Schedule = @"{
# Set Campaign Template Schedule
try {
Set-BetaCampaignTemplateSchedule -BetaId $Id
Set-BetaCampaignTemplateSchedule -Id $Id
# Below is a request that includes all optional parameters
# Set-BetaCampaignTemplateSchedule -BetaId $Id -BetaSchedule $Schedule
# Set-BetaCampaignTemplateSchedule -Id $Id -BetaSchedule $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaCampaignTemplateSchedule"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-campaign
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/start-campaign)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1231,22 +1339,28 @@ $ActivateCampaignOptions = @"{
# Activate a Campaign
try {
Start-BetaCampaign -BetaId $Id
Start-BetaCampaign -Id $Id
# Below is a request that includes all optional parameters
# Start-BetaCampaign -BetaId $Id -BetaActivateCampaignOptions $ActivateCampaignOptions
# Start-BetaCampaign -Id $Id -BetaActivateCampaignOptions $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaign"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-campaign-remediation-scan
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Use this API to run a remediation scan task for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-remediation-scan).
A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/start-campaign-remediation-scan)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1277,22 +1391,28 @@ $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remed
# Run Campaign Remediation Scan
try {
Start-BetaCampaignRemediationScan -BetaId $Id
Start-BetaCampaignRemediationScan -Id $Id
# Below is a request that includes all optional parameters
# Start-BetaCampaignRemediationScan -BetaId $Id
# Start-BetaCampaignRemediationScan -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaignRemediationScan"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-campaign-report
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Use this API to run a report for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-report).
A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/start-campaign-report)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1325,17 +1445,21 @@ $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of report to run.
# Run Campaign Report
try {
Start-BetaCampaignReport -BetaId $Id -BetaType $Type
Start-BetaCampaignReport -Id $Id -Type $Type
# Below is a request that includes all optional parameters
# Start-BetaCampaignReport -BetaId $Id -BetaType $Type
# Start-BetaCampaignReport -Id $Id -Type $Type
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaignReport"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-generate-campaign-template
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Use this API to generate a new certification campaign from a campaign template.
The campaign object contained in the template has special formatting applied to its name and description
@@ -1353,6 +1477,8 @@ Though this Beta endpoint has been deprecated, you can find its V3 equivalent [h
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/start-generate-campaign-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1382,22 +1508,28 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template
# Generate a Campaign from Template
try {
Start-BetaGenerateCampaignTemplate -BetaId $Id
Start-BetaGenerateCampaignTemplate -Id $Id
# Below is a request that includes all optional parameters
# Start-BetaGenerateCampaignTemplate -BetaId $Id
# Start-BetaGenerateCampaignTemplate -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaGenerateCampaignTemplate"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-campaign
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/update-campaign).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/update-campaign)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1433,10 +1565,10 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of campaign update opera
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Update-BetaCampaign -BetaId $Id -BetaRequestBody $Result
Update-BetaCampaign -Id $Id -RequestBody $Result
# Below is a request that includes all optional parameters
# Update-BetaCampaign -BetaId $Id -BetaRequestBody $RequestBody
# Update-BetaCampaign -Id $Id -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCampaign"
Write-Host $_.ErrorDetails

44
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCertificationsApi.md
View File

@@ -38,9 +38,15 @@ Method | HTTP request | Description
[**Get-BetaCertificationReviewers**](#list-certification-reviewers) | **GET** `/certifications/{id}/reviewers` | List of Reviewers for certification
[**Submit-BetaReassignCertsAsync**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously
## get-identity-certification-item-permissions
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
This API returns the permissions associated with an entitlement certification item based on the certification item's ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-certification-item-permissions)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -81,19 +87,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Permissions for Entitlement Certification Item
try {
Get-BetaIdentityCertificationItemPermissions -BetaCertificationId $CertificationId -BetaItemId $ItemId
Get-BetaIdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId
# Below is a request that includes all optional parameters
# Get-BetaIdentityCertificationItemPermissions -BetaCertificationId $CertificationId -BetaItemId $ItemId -BetaFilters $Filters -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count
# Get-BetaIdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationItemPermissions"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-certification-pending-tasks
This API returns the status of all pending (`QUEUED` or `IN_PROGRESS`) tasks for an identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-certification-pending-tasks)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -124,19 +133,22 @@ $Id = "MyId" # String | The identity campaign certification ID
# Pending Certification Tasks
try {
Get-BetaIdentityCertificationPendingTasks -BetaId $Id
Get-BetaIdentityCertificationPendingTasks -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaIdentityCertificationPendingTasks -BetaId $Id
# Get-BetaIdentityCertificationPendingTasks -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationPendingTasks"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-certification-task-status
This API returns the status of a certification task. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-certification-task-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -169,19 +181,25 @@ $TaskId = "MyTaskId" # String | The certification task ID
# Certification Task Status
try {
Get-BetaIdentityCertificationTaskStatus -BetaId $Id -BetaTaskId $TaskId
Get-BetaIdentityCertificationTaskStatus -Id $Id -TaskId $TaskId
# Below is a request that includes all optional parameters
# Get-BetaIdentityCertificationTaskStatus -BetaId $Id -BetaTaskId $TaskId
# Get-BetaIdentityCertificationTaskStatus -Id $Id -TaskId $TaskId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationTaskStatus"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-certification-reviewers
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
This API returns a list of reviewers for the certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-certification-reviewers)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -222,19 +240,25 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
# List of Reviewers for certification
try {
Get-BetaCertificationReviewers -BetaId $Id
Get-BetaCertificationReviewers -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaCertificationReviewers -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters
# Get-BetaCertificationReviewers -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCertificationReviewers"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## submit-reassign-certs-async
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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 reassignment is complete. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/submit-reassign-certs-async)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -278,10 +302,10 @@ $ReviewReassign = @"{
try {
$Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign
Submit-BetaReassignCertsAsync -BetaId $Id -BetaReviewReassign $Result
Submit-BetaReassignCertsAsync -Id $Id -BetaReviewReassign $Result
# Below is a request that includes all optional parameters
# Submit-BetaReassignCertsAsync -BetaId $Id -BetaReviewReassign $ReviewReassign
# Submit-BetaReassignCertsAsync -Id $Id -BetaReviewReassign $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaReassignCertsAsync"
Write-Host $_.ErrorDetails

40
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaConnectorRuleManagementApi.md
View File

@@ -30,10 +30,13 @@ Method | HTTP request | Description
[**Update-BetaConnectorRule**](#update-connector-rule) | **PUT** `/connector-rules/{id}` | Update a Connector Rule
[**Confirm-BetaConnectorRule**](#validate-connector-rule) | **POST** `/connector-rules/validate` | Validate Connector Rule
## create-connector-rule
Creates a new connector rule.
A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-connector-rule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -89,20 +92,23 @@ $ConnectorRuleCreateRequest = @"{
try {
$Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest
New-BetaConnectorRule -BetaConnectorRuleCreateRequest $Result
New-BetaConnectorRule -BetaConnectorRuleCreateRequest $Result
# Below is a request that includes all optional parameters
# New-BetaConnectorRule -BetaConnectorRuleCreateRequest $ConnectorRuleCreateRequest
# New-BetaConnectorRule -BetaConnectorRuleCreateRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaConnectorRule"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-connector-rule
Deletes the connector rule specified by the given ID.
A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-connector-rule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -133,20 +139,23 @@ $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to
# Delete a Connector-Rule
try {
Remove-BetaConnectorRule -BetaId $Id
Remove-BetaConnectorRule -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaConnectorRule -BetaId $Id
# Remove-BetaConnectorRule -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaConnectorRule"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-connector-rule
Returns the connector rule specified by ID.
A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-connector-rule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -177,20 +186,23 @@ $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to
# Connector-Rule by ID
try {
Get-BetaConnectorRule -BetaId $Id
Get-BetaConnectorRule -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaConnectorRule -BetaId $Id
# Get-BetaConnectorRule -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorRule"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-connector-rule-list
Returns the list of connector rules.
A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-connector-rule-list)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -218,7 +230,7 @@ Code | Description | Data Type
# List Connector Rules
try {
Get-BetaConnectorRuleList
Get-BetaConnectorRuleList
# Below is a request that includes all optional parameters
# Get-BetaConnectorRuleList
@@ -228,10 +240,13 @@ try {
}
```
[[Back to top]](#)
## update-connector-rule
Updates an existing connector rule with the one provided in the request body. Note that the fields 'id', 'name', and 'type' are immutable.
A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/update-connector-rule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -290,20 +305,23 @@ $ConnectorRuleUpdateRequest = @"{
# Update a Connector Rule
try {
Update-BetaConnectorRule -BetaId $Id
Update-BetaConnectorRule -Id $Id
# Below is a request that includes all optional parameters
# Update-BetaConnectorRule -BetaId $Id -BetaConnectorRuleUpdateRequest $ConnectorRuleUpdateRequest
# Update-BetaConnectorRule -Id $Id -BetaConnectorRuleUpdateRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaConnectorRule"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## validate-connector-rule
Returns a list of issues within the code to fix, if any.
A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/validate-connector-rule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -337,10 +355,10 @@ $SourceCode = @"{
try {
$Result = ConvertFrom-JsonToSourceCode -Json $SourceCode
Confirm-BetaConnectorRule -BetaSourceCode $Result
Confirm-BetaConnectorRule -BetaSourceCode $Result
# Below is a request that includes all optional parameters
# Confirm-BetaConnectorRule -BetaSourceCode $SourceCode
# Confirm-BetaConnectorRule -BetaSourceCode $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Confirm-BetaConnectorRule"
Write-Host $_.ErrorDetails

7
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaConnectorsApi.md
View File

@@ -33,9 +33,12 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaConnectorList**](#get-connector-list) | **GET** `/connectors` | Get Connector List
## get-connector-list
Fetches list of connectors that have 'RELEASED' status using filtering and pagination.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-connector-list)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -74,10 +77,10 @@ $Locale = "de" # String | The locale to apply to the config. If no viable locale
# Get Connector List
try {
Get-BetaConnectorList
Get-BetaConnectorList
# Below is a request that includes all optional parameters
# Get-BetaConnectorList -BetaFilters $Filters -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaLocale $Locale
# Get-BetaConnectorList -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count -Locale $Locale
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorList"
Write-Host $_.ErrorDetails

129
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCustomFormsApi.md
View File

@@ -45,9 +45,12 @@ Method | HTTP request | Description
[**Search-BetaPreDefinedSelectOptions**](#search-pre-defined-select-options) | **GET** `/form-definitions/predefined-select-options` | List predefined select options.
[**Show-BetaPreviewDataSource**](#show-preview-data-source) | **POST** `/form-definitions/{formDefinitionID}/data-source` | Preview form definition data source.
## create-form-definition
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-form-definition)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -187,19 +190,22 @@ $CreateFormDefinitionRequest = @"{
# Creates a form definition.
try {
New-BetaFormDefinition
New-BetaFormDefinition
# Below is a request that includes all optional parameters
# New-BetaFormDefinition -BetaCreateFormDefinitionRequest $CreateFormDefinitionRequest
# New-BetaFormDefinition -BetaCreateFormDefinitionRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinition"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-form-definition-by-template
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-form-definition-by-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -339,19 +345,22 @@ $CreateFormDefinitionRequest = @"{
# Create a form definition by template.
try {
New-BetaFormDefinitionByTemplate
New-BetaFormDefinitionByTemplate
# Below is a request that includes all optional parameters
# New-BetaFormDefinitionByTemplate -BetaCreateFormDefinitionRequest $CreateFormDefinitionRequest
# New-BetaFormDefinitionByTemplate -BetaCreateFormDefinitionRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionByTemplate"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-form-definition-dynamic-schema
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-form-definition-dynamic-schema)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -390,19 +399,22 @@ $Body = @"{
# Generate JSON Schema dynamically.
try {
New-BetaFormDefinitionDynamicSchema
New-BetaFormDefinitionDynamicSchema
# Below is a request that includes all optional parameters
# New-BetaFormDefinitionDynamicSchema -BetaBody $Body
# New-BetaFormDefinitionDynamicSchema -BetaBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionDynamicSchema"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-form-definition-file-request
Parameter `{formDefinitionID}` should match a form definition ID.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-form-definition-file-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -438,19 +450,22 @@ $File = # System.IO.FileInfo | File specifying the multipart
# Upload new form definition file.
try {
New-BetaFormDefinitionFileRequest -BetaFormDefinitionID $FormDefinitionID -BetaFile $File
New-BetaFormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File
# Below is a request that includes all optional parameters
# New-BetaFormDefinitionFileRequest -BetaFormDefinitionID $FormDefinitionID -BetaFile $File
# New-BetaFormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionFileRequest"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-form-instance
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-form-instance)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -500,19 +515,22 @@ $Body = @"{
# Creates a form instance.
try {
New-BetaFormInstance
New-BetaFormInstance
# Below is a request that includes all optional parameters
# New-BetaFormInstance -BetaBody $Body
# New-BetaFormInstance -BetaBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormInstance"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-form-definition
Parameter `{formDefinitionID}` should match a form definition ID.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-form-definition)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -543,19 +561,22 @@ $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form defin
# Deletes a form definition.
try {
Remove-BetaFormDefinition -BetaFormDefinitionID $FormDefinitionID
Remove-BetaFormDefinition -FormDefinitionID $FormDefinitionID
# Below is a request that includes all optional parameters
# Remove-BetaFormDefinition -BetaFormDefinitionID $FormDefinitionID
# Remove-BetaFormDefinition -FormDefinitionID $FormDefinitionID
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaFormDefinition"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## export-form-definitions-by-tenant
No parameters required.
[API Spec](https://developer.sailpoint.com/docs/api/beta/export-form-definitions-by-tenant)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -591,19 +612,22 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
# List form definitions by tenant.
try {
Export-BetaFormDefinitionsByTenant
Export-BetaFormDefinitionsByTenant
# Below is a request that includes all optional parameters
# Export-BetaFormDefinitionsByTenant -BetaOffset $Offset -BetaLimit $Limit -BetaFilters $Filters -BetaSorters $Sorters
# Export-BetaFormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaFormDefinitionsByTenant"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-file-from-s3
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-file-from-s3)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -637,19 +661,22 @@ $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying
# Download definition file by fileId.
try {
Get-BetaFileFromS3 -BetaFormDefinitionID $FormDefinitionID -BetaFileID $FileID
Get-BetaFileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID
# Below is a request that includes all optional parameters
# Get-BetaFileFromS3 -BetaFormDefinitionID $FormDefinitionID -BetaFileID $FileID
# Get-BetaFileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFileFromS3"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-form-definition-by-key
Parameter `{formDefinitionID}` should match a form definition ID.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-form-definition-by-key)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -680,19 +707,22 @@ $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form defin
# Return a form definition.
try {
Get-BetaFormDefinitionByKey -BetaFormDefinitionID $FormDefinitionID
Get-BetaFormDefinitionByKey -FormDefinitionID $FormDefinitionID
# Below is a request that includes all optional parameters
# Get-BetaFormDefinitionByKey -BetaFormDefinitionID $FormDefinitionID
# Get-BetaFormDefinitionByKey -FormDefinitionID $FormDefinitionID
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormDefinitionByKey"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-form-instance-by-key
Parameter `{formInstanceID}` should match a form instance ID.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-form-instance-by-key)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -723,19 +753,22 @@ $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instanc
# Returns a form instance.
try {
Get-BetaFormInstanceByKey -BetaFormInstanceID $FormInstanceID
Get-BetaFormInstanceByKey -FormInstanceID $FormInstanceID
# Below is a request that includes all optional parameters
# Get-BetaFormInstanceByKey -BetaFormInstanceID $FormInstanceID
# Get-BetaFormInstanceByKey -FormInstanceID $FormInstanceID
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormInstanceByKey"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-form-instance-file
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-form-instance-file)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -769,19 +802,22 @@ $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying
# Download instance file by fileId.
try {
Get-BetaFormInstanceFile -BetaFormInstanceID $FormInstanceID -BetaFileID $FileID
Get-BetaFormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID
# Below is a request that includes all optional parameters
# Get-BetaFormInstanceFile -BetaFormInstanceID $FormInstanceID -BetaFileID $FileID
# Get-BetaFormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormInstanceFile"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## import-form-definitions
[API Spec](https://developer.sailpoint.com/docs/api/beta/import-form-definitions)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -818,19 +854,22 @@ Code | Description | Data Type
# Import form definitions from export.
try {
Import-BetaFormDefinitions
Import-BetaFormDefinitions
# Below is a request that includes all optional parameters
# Import-BetaFormDefinitions -BetaBody $Body
# Import-BetaFormDefinitions -BetaBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaFormDefinitions"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-form-definition
Parameter `{formDefinitionID}` should match a form definition ID.
[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-form-definition)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -865,19 +904,22 @@ $Body = @{ key_example = } # Map[] | Body is the request payload to patch a for
# Patch a form definition.
try {
Update-BetaFormDefinition -BetaFormDefinitionID $FormDefinitionID
Update-BetaFormDefinition -FormDefinitionID $FormDefinitionID
# Below is a request that includes all optional parameters
# Update-BetaFormDefinition -BetaFormDefinitionID $FormDefinitionID -BetaBody $Body
# Update-BetaFormDefinition -FormDefinitionID $FormDefinitionID -Body $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaFormDefinition"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-form-instance
Parameter `{formInstanceID}` should match a form instance ID.
[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-form-instance)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -913,19 +955,22 @@ $Body = @{ key_example = } # Map[] | Body is the request payload to patch a for
# Patch a form instance.
try {
Update-BetaFormInstance -BetaFormInstanceID $FormInstanceID
Update-BetaFormInstance -FormInstanceID $FormInstanceID
# Below is a request that includes all optional parameters
# Update-BetaFormInstance -BetaFormInstanceID $FormInstanceID -BetaBody $Body
# Update-BetaFormInstance -FormInstanceID $FormInstanceID -Body $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaFormInstance"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## search-form-definitions-by-tenant
No parameters required.
[API Spec](https://developer.sailpoint.com/docs/api/beta/search-form-definitions-by-tenant)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -961,20 +1006,23 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
# Export form definitions by tenant.
try {
Search-BetaFormDefinitionsByTenant
Search-BetaFormDefinitionsByTenant
# Below is a request that includes all optional parameters
# Search-BetaFormDefinitionsByTenant -BetaOffset $Offset -BetaLimit $Limit -BetaFilters $Filters -BetaSorters $Sorters
# Search-BetaFormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormDefinitionsByTenant"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## search-form-element-data-by-element-id
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/beta/search-form-element-data-by-element-id)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1013,19 +1061,22 @@ $Query = "support" # String | String that is passed to the underlying API to fil
# Retrieves dynamic data by element.
try {
Search-BetaFormElementDataByElementID -BetaFormInstanceID $FormInstanceID -BetaFormElementID $FormElementID
Search-BetaFormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID
# Below is a request that includes all optional parameters
# Search-BetaFormElementDataByElementID -BetaFormInstanceID $FormInstanceID -BetaFormElementID $FormElementID -BetaLimit $Limit -BetaFilters $Filters -BetaQuery $Query
# Search-BetaFormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -Limit $Limit -Filters $Filters -Query $Query
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormElementDataByElementID"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## search-form-instances-by-tenant
No parameters required.
[API Spec](https://developer.sailpoint.com/docs/api/beta/search-form-instances-by-tenant)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1053,7 +1104,7 @@ Code | Description | Data Type
# List form instances by tenant.
try {
Search-BetaFormInstancesByTenant
Search-BetaFormInstancesByTenant
# Below is a request that includes all optional parameters
# Search-BetaFormInstancesByTenant
@@ -1063,9 +1114,12 @@ try {
}
```
[[Back to top]](#)
## search-pre-defined-select-options
No parameters required.
[API Spec](https://developer.sailpoint.com/docs/api/beta/search-pre-defined-select-options)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1093,7 +1147,7 @@ Code | Description | Data Type
# List predefined select options.
try {
Search-BetaPreDefinedSelectOptions
Search-BetaPreDefinedSelectOptions
# Below is a request that includes all optional parameters
# Search-BetaPreDefinedSelectOptions
@@ -1103,9 +1157,12 @@ try {
}
```
[[Back to top]](#)
## show-preview-data-source
[API Spec](https://developer.sailpoint.com/docs/api/beta/show-preview-data-source)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1154,10 +1211,10 @@ $FormElementPreviewRequest = @"{
# Preview form definition data source.
try {
Show-BetaPreviewDataSource -BetaFormDefinitionID $FormDefinitionID
Show-BetaPreviewDataSource -FormDefinitionID $FormDefinitionID
# Below is a request that includes all optional parameters
# Show-BetaPreviewDataSource -BetaFormDefinitionID $FormDefinitionID -BetaLimit $Limit -BetaFilters $Filters -BetaQuery $Query -BetaFormElementPreviewRequest $FormElementPreviewRequest
# Show-BetaPreviewDataSource -FormDefinitionID $FormDefinitionID -Limit $Limit -Filters $Filters -Query $Query -BetaFormElementPreviewRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-BetaPreviewDataSource"
Write-Host $_.ErrorDetails

21
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCustomPasswordInstructionsApi.md
View File

@@ -32,9 +32,12 @@ Method | HTTP request | Description
[**Remove-BetaCustomPasswordInstructions**](#delete-custom-password-instructions) | **DELETE** `/custom-password-instructions/{pageId}` | Delete Custom Password Instructions by page ID
[**Get-BetaCustomPasswordInstructions**](#get-custom-password-instructions) | **GET** `/custom-password-instructions/{pageId}` | Get Custom Password Instructions by Page ID
## create-custom-password-instructions
This API creates the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-custom-password-instructions)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -67,19 +70,22 @@ $CustomPasswordInstruction = @"{
try {
$Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction
New-BetaCustomPasswordInstructions -BetaCustomPasswordInstruction $Result
New-BetaCustomPasswordInstructions -BetaCustomPasswordInstruction $Result
# Below is a request that includes all optional parameters
# New-BetaCustomPasswordInstructions -BetaCustomPasswordInstruction $CustomPasswordInstruction
# New-BetaCustomPasswordInstructions -BetaCustomPasswordInstruction $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCustomPasswordInstructions"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-custom-password-instructions
This API delete the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-custom-password-instructions)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -110,19 +116,22 @@ $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47
# Delete Custom Password Instructions by page ID
try {
Remove-BetaCustomPasswordInstructions -BetaPageId $PageId
Remove-BetaCustomPasswordInstructions -PageId $PageId
# Below is a request that includes all optional parameters
# Remove-BetaCustomPasswordInstructions -BetaPageId $PageId -BetaLocale $Locale
# Remove-BetaCustomPasswordInstructions -PageId $PageId -Locale $Locale
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCustomPasswordInstructions"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-custom-password-instructions
This API returns the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-custom-password-instructions)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -153,10 +162,10 @@ $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47
# Get Custom Password Instructions by Page ID
try {
Get-BetaCustomPasswordInstructions -BetaPageId $PageId
Get-BetaCustomPasswordInstructions -PageId $PageId
# Below is a request that includes all optional parameters
# Get-BetaCustomPasswordInstructions -BetaPageId $PageId -BetaLocale $Locale
# Get-BetaCustomPasswordInstructions -PageId $PageId -Locale $Locale
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCustomPasswordInstructions"
Write-Host $_.ErrorDetails

87
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaEntitlementsApi.md
View File

@@ -79,9 +79,12 @@ Method | HTTP request | Description
[**Reset-BetaSourceEntitlements**](#reset-source-entitlements) | **POST** `/entitlements/reset/sources/{sourceId}` | Reset Source Entitlements
[**Update-BetaEntitlementsInBulk**](#update-entitlements-in-bulk) | **POST** `/entitlements/bulk-update` | Bulk update an entitlement list
## create-access-model-metadata-for-entitlement
Add single Access Model Metadata to an entitlement.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-access-model-metadata-for-entitlement)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -115,19 +118,22 @@ $AttributeValue = "public" # String | Technical name of the Attribute Value.
# Add metadata to an entitlement.
try {
New-BetaAccessModelMetadataForEntitlement -BetaId $Id -BetaAttributeKey $AttributeKey -BetaAttributeValue $AttributeValue
New-BetaAccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue
# Below is a request that includes all optional parameters
# New-BetaAccessModelMetadataForEntitlement -BetaId $Id -BetaAttributeKey $AttributeKey -BetaAttributeValue $AttributeValue
# New-BetaAccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessModelMetadataForEntitlement"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-access-model-metadata-from-entitlement
Remove single Access Model Metadata from an entitlement.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-access-model-metadata-from-entitlement)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -161,19 +167,22 @@ $AttributeValue = "public" # String | Technical name of the Attribute Value.
# Remove metadata from an entitlement.
try {
Remove-BetaAccessModelMetadataFromEntitlement -BetaId $Id -BetaAttributeKey $AttributeKey -BetaAttributeValue $AttributeValue
Remove-BetaAccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue
# Below is a request that includes all optional parameters
# Remove-BetaAccessModelMetadataFromEntitlement -BetaId $Id -BetaAttributeKey $AttributeKey -BetaAttributeValue $AttributeValue
# Remove-BetaAccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessModelMetadataFromEntitlement"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-entitlement
This API returns an entitlement by its ID.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-entitlement)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -204,19 +213,22 @@ $Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID
# Get an entitlement
try {
Get-BetaEntitlement -BetaId $Id
Get-BetaEntitlement -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaEntitlement -BetaId $Id
# Get-BetaEntitlement -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlement"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-entitlement-request-config
This API returns the entitlement request config for a specified entitlement.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-entitlement-request-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -247,23 +259,29 @@ $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id
# Get Entitlement Request Config
try {
Get-BetaEntitlementRequestConfig -BetaId $Id
Get-BetaEntitlementRequestConfig -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaEntitlementRequestConfig -BetaId $Id
# Get-BetaEntitlementRequestConfig -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementRequestConfig"
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.
:::
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/beta/import-entitlements-by-source)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -295,19 +313,22 @@ $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlemen
# Aggregate Entitlements
try {
Import-BetaEntitlementsBySource -BetaId $Id
Import-BetaEntitlementsBySource -Id $Id
# Below is a request that includes all optional parameters
# Import-BetaEntitlementsBySource -BetaId $Id -BetaCsvFile $CsvFile
# Import-BetaEntitlementsBySource -Id $Id -CsvFile $CsvFile
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaEntitlementsBySource"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-entitlement-children
This API returns a list of all child entitlements of a given entitlement.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-entitlement-children)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -348,19 +369,22 @@ $Filters = 'attribute eq "memberOf"' # String | Filter results using the standar
# List of entitlements children
try {
Get-BetaEntitlementChildren -BetaId $Id
Get-BetaEntitlementChildren -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaEntitlementChildren -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters
# Get-BetaEntitlementChildren -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementChildren"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-entitlement-parents
This API returns a list of all parent entitlements of a given entitlement.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-entitlement-parents)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -401,16 +425,17 @@ $Filters = 'attribute eq "memberOf"' # String | Filter results using the standar
# List of entitlements parents
try {
Get-BetaEntitlementParents -BetaId $Id
Get-BetaEntitlementParents -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaEntitlementParents -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters
# Get-BetaEntitlementParents -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementParents"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-entitlements
This API returns a list of entitlements.
@@ -418,6 +443,8 @@ This API can be used in one of the two following ways: either getting entitlemen
Any authenticated token can call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-entitlements)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -463,16 +490,17 @@ $Filters = 'attribute eq "memberOf"' # String | Filter results using the standar
# Gets a list of entitlements.
try {
Get-BetaEntitlements
Get-BetaEntitlements
# Below is a request that includes all optional parameters
# Get-BetaEntitlements -BetaAccountId $AccountId -BetaSegmentedForIdentity $SegmentedForIdentity -BetaForSegmentIds $ForSegmentIds -BetaIncludeUnsegmented $IncludeUnsegmented -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters
# Get-BetaEntitlements -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-BetaEntitlements"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-entitlement
This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
@@ -482,6 +510,8 @@ When you're patching owner, only owner type and owner id must be provided. Owner
A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-entitlement)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -519,19 +549,22 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to pat
# Patch an entitlement
try {
Update-BetaEntitlement -BetaId $Id
Update-BetaEntitlement -Id $Id
# Below is a request that includes all optional parameters
# Update-BetaEntitlement -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation
# Update-BetaEntitlement -Id $Id -BetaJsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlement"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-entitlement-request-config
This API replaces the entitlement request config for a specified entitlement.
[API Spec](https://developer.sailpoint.com/docs/api/beta/put-entitlement-request-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -577,20 +610,23 @@ $EntitlementRequestConfig = @"{
try {
$Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig
Send-BetaEntitlementRequestConfig -BetaId $Id -BetaEntitlementRequestConfig $Result
Send-BetaEntitlementRequestConfig -Id $Id -BetaEntitlementRequestConfig $Result
# Below is a request that includes all optional parameters
# Send-BetaEntitlementRequestConfig -BetaId $Id -BetaEntitlementRequestConfig $EntitlementRequestConfig
# Send-BetaEntitlementRequestConfig -Id $Id -BetaEntitlementRequestConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaEntitlementRequestConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## reset-source-entitlements
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 [Import Accounts](https://developer.sailpoint.com/docs/api/beta/import-accounts/) with `disableOptimization` = `true`.
[API Spec](https://developer.sailpoint.com/docs/api/beta/reset-source-entitlements)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -620,16 +656,17 @@ $SourceId = "2c91808a7813090a017814121919ecca" # String | ID of source for the e
# Reset Source Entitlements
try {
Reset-BetaSourceEntitlements -BetaSourceId $SourceId
Reset-BetaSourceEntitlements -SourceId $SourceId
# Below is a request that includes all optional parameters
# Reset-BetaSourceEntitlements -BetaSourceId $SourceId
# Reset-BetaSourceEntitlements -SourceId $SourceId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-BetaSourceEntitlements"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-entitlements-in-bulk
This API applies an update to every entitlement of the list.
@@ -646,6 +683,8 @@ Patch](https://tools.ietf.org/html/rfc6902) standard. allowed operations :
A token with ORG_ADMIN or API authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/update-entitlements-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -687,10 +726,10 @@ $EntitlementBulkUpdateRequest = @"{
try {
$Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest
Update-BetaEntitlementsInBulk -BetaEntitlementBulkUpdateRequest $Result
Update-BetaEntitlementsInBulk -BetaEntitlementBulkUpdateRequest $Result
# Below is a request that includes all optional parameters
# Update-BetaEntitlementsInBulk -BetaEntitlementBulkUpdateRequest $EntitlementBulkUpdateRequest
# Update-BetaEntitlementsInBulk -BetaEntitlementBulkUpdateRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlementsInBulk"
Write-Host $_.ErrorDetails

70
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaGovernanceGroupsApi.md
View File

@@ -33,9 +33,12 @@ Method | HTTP request | Description
[**Update-BetaWorkgroup**](#patch-workgroup) | **PATCH** `/workgroups/{id}` | Patch a Governance Group
[**Update-BetaWorkgroupMembers**](#update-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-add` | Add members to Governance Group
## create-workgroup
This API creates a new Governance Group.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-workgroup)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -81,19 +84,22 @@ $WorkgroupDto = @"{
try {
$Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto
New-BetaWorkgroup -BetaWorkgroupDto $Result
New-BetaWorkgroup -BetaWorkgroupDto $Result
# Below is a request that includes all optional parameters
# New-BetaWorkgroup -BetaWorkgroupDto $WorkgroupDto
# New-BetaWorkgroup -BetaWorkgroupDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkgroup"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-workgroup
This API deletes a Governance Group by its ID.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-workgroup)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -123,16 +129,17 @@ $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group
# Delete a Governance Group
try {
Remove-BetaWorkgroup -BetaId $Id
Remove-BetaWorkgroup -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaWorkgroup -BetaId $Id
# Remove-BetaWorkgroup -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroup"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-workgroup-members
This API removes one or more members from a Governance Group. A token with API, ORG_ADMIN authority is required to call this API.
@@ -140,6 +147,8 @@ This API removes one or more members from a Governance Group. A token with API
> **name**
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-workgroup-members)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -173,16 +182,17 @@ $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governanc
try {
$Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner
Remove-BetaWorkgroupMembers -BetaWorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $Result
Remove-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $Result
# Below is a request that includes all optional parameters
# Remove-BetaWorkgroupMembers -BetaWorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $BulkWorkgroupMembersRequestInner
# Remove-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroupMembers"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-workgroups-in-bulk
This API initiates a bulk deletion of one or more Governance Groups.
@@ -197,6 +207,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/beta/delete-workgroups-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -229,19 +241,22 @@ $WorkgroupBulkDeleteRequest = @"{
try {
$Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest
Remove-BetaWorkgroupsInBulk -BetaWorkgroupBulkDeleteRequest $Result
Remove-BetaWorkgroupsInBulk -BetaWorkgroupBulkDeleteRequest $Result
# Below is a request that includes all optional parameters
# Remove-BetaWorkgroupsInBulk -BetaWorkgroupBulkDeleteRequest $WorkgroupBulkDeleteRequest
# Remove-BetaWorkgroupsInBulk -BetaWorkgroupBulkDeleteRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroupsInBulk"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-workgroup
This API returns a Governance Groups by its ID.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-workgroup)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -271,19 +286,22 @@ $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group
# Get Governance Group by Id
try {
Get-BetaWorkgroup -BetaId $Id
Get-BetaWorkgroup -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaWorkgroup -BetaId $Id
# Get-BetaWorkgroup -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroup"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-connections
This API returns list of connections associated with a Governance Group.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-connections)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -321,19 +339,22 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de
# List connections for Governance Group
try {
Get-BetaConnections -BetaWorkgroupId $WorkgroupId
Get-BetaConnections -WorkgroupId $WorkgroupId
# Below is a request that includes all optional parameters
# Get-BetaConnections -BetaWorkgroupId $WorkgroupId -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters
# Get-BetaConnections -WorkgroupId $WorkgroupId -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnections"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-workgroup-members
This API returns list of members associated with a Governance Group.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-workgroup-members)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -371,19 +392,22 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de
# List Governance Group Members
try {
Get-BetaWorkgroupMembers -BetaWorkgroupId $WorkgroupId
Get-BetaWorkgroupMembers -WorkgroupId $WorkgroupId
# Below is a request that includes all optional parameters
# Get-BetaWorkgroupMembers -BetaWorkgroupId $WorkgroupId -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters
# Get-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroupMembers"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-workgroups
This API returns list of Governance Groups
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-workgroups)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -421,16 +445,17 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de
# List Governance Groups
try {
Get-BetaWorkgroups
Get-BetaWorkgroups
# Below is a request that includes all optional parameters
# Get-BetaWorkgroups -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters
# Get-BetaWorkgroups -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroups"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-workgroup
This API updates an existing governance group by ID.
The following fields and objects are patchable:
@@ -440,6 +465,8 @@ The following fields and objects are patchable:
A token with API or ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-workgroup)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -476,16 +503,17 @@ $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group
# Patch a Governance Group
try {
Update-BetaWorkgroup -BetaId $Id
Update-BetaWorkgroup -Id $Id
# Below is a request that includes all optional parameters
# Update-BetaWorkgroup -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation
# Update-BetaWorkgroup -Id $Id -BetaJsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkgroup"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-workgroup-members
This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API.
@@ -493,6 +521,8 @@ This API adds one or more members to a Governance Group. A token with API, ORG_
> **name**
[API Spec](https://developer.sailpoint.com/docs/api/beta/update-workgroup-members)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -526,10 +556,10 @@ $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governanc
try {
$Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner
Update-BetaWorkgroupMembers -BetaWorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $Result
Update-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $Result
# Below is a request that includes all optional parameters
# Update-BetaWorkgroupMembers -BetaWorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $BulkWorkgroupMembersRequestInner
# Update-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkgroupMembers"
Write-Host $_.ErrorDetails

56
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIAccessRequestRecommendationsApi.md
View File

@@ -26,9 +26,12 @@ Method | HTTP request | Description
[**Get-BetaAccessRequestRecommendationsRequestedItems**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List of Requested Access Request Recommendations
[**Get-BetaAccessRequestRecommendationsViewedItems**](#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
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/beta/add-access-request-recommendations-ignored-item)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -65,19 +68,22 @@ $AccessRequestRecommendationActionItemDto = @"{
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
Add-BetaAccessRequestRecommendationsIgnoredItem -BetaAccessRequestRecommendationActionItemDto $Result
Add-BetaAccessRequestRecommendationsIgnoredItem -BetaAccessRequestRecommendationActionItemDto $Result
# Below is a request that includes all optional parameters
# Add-BetaAccessRequestRecommendationsIgnoredItem -BetaAccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto
# Add-BetaAccessRequestRecommendationsIgnoredItem -BetaAccessRequestRecommendationActionItemDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsIgnoredItem"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## add-access-request-recommendations-requested-item
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/beta/add-access-request-recommendations-requested-item)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -114,19 +120,22 @@ $AccessRequestRecommendationActionItemDto = @"{
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
Add-BetaAccessRequestRecommendationsRequestedItem -BetaAccessRequestRecommendationActionItemDto $Result
Add-BetaAccessRequestRecommendationsRequestedItem -BetaAccessRequestRecommendationActionItemDto $Result
# Below is a request that includes all optional parameters
# Add-BetaAccessRequestRecommendationsRequestedItem -BetaAccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto
# Add-BetaAccessRequestRecommendationsRequestedItem -BetaAccessRequestRecommendationActionItemDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsRequestedItem"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## add-access-request-recommendations-viewed-item
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/beta/add-access-request-recommendations-viewed-item)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -163,19 +172,22 @@ $AccessRequestRecommendationActionItemDto = @"{
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
Add-BetaAccessRequestRecommendationsViewedItem -BetaAccessRequestRecommendationActionItemDto $Result
Add-BetaAccessRequestRecommendationsViewedItem -BetaAccessRequestRecommendationActionItemDto $Result
# Below is a request that includes all optional parameters
# Add-BetaAccessRequestRecommendationsViewedItem -BetaAccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto
# Add-BetaAccessRequestRecommendationsViewedItem -BetaAccessRequestRecommendationActionItemDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsViewedItem"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## add-access-request-recommendations-viewed-items
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/beta/add-access-request-recommendations-viewed-items)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -213,19 +225,22 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
Add-BetaAccessRequestRecommendationsViewedItems -BetaAccessRequestRecommendationActionItemDto $Result
Add-BetaAccessRequestRecommendationsViewedItems -BetaAccessRequestRecommendationActionItemDto $Result
# Below is a request that includes all optional parameters
# Add-BetaAccessRequestRecommendationsViewedItems -BetaAccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto
# Add-BetaAccessRequestRecommendationsViewedItems -BetaAccessRequestRecommendationActionItemDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsViewedItems"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-access-request-recommendations
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/beta/get-access-request-recommendations)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -267,19 +282,22 @@ $Sorters = "MySorters" # String | Sort results using the standard syntax describ
# Identity Access Request Recommendations
try {
Get-BetaAccessRequestRecommendations
Get-BetaAccessRequestRecommendations
# Below is a request that includes all optional parameters
# Get-BetaAccessRequestRecommendations -BetaIdentityId $IdentityId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaIncludeTranslationMessages $IncludeTranslationMessages -BetaFilters $Filters -BetaSorters $Sorters
# Get-BetaAccessRequestRecommendations -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-BetaAccessRequestRecommendations"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-access-request-recommendations-ignored-items
This API returns the list of ignored access request recommendations.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-recommendations-ignored-items)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -317,19 +335,22 @@ $Sorters = "access.id" # String | Sort results using the standard syntax describ
# List of Ignored Access Request Recommendations
try {
Get-BetaAccessRequestRecommendationsIgnoredItems
Get-BetaAccessRequestRecommendationsIgnoredItems
# Below is a request that includes all optional parameters
# Get-BetaAccessRequestRecommendationsIgnoredItems -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters
# Get-BetaAccessRequestRecommendationsIgnoredItems -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsIgnoredItems"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-access-request-recommendations-requested-items
This API returns a list of requested access request recommendations.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-recommendations-requested-items)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -367,19 +388,22 @@ $Sorters = "MySorters" # String | Sort results using the standard syntax describ
# List of Requested Access Request Recommendations
try {
Get-BetaAccessRequestRecommendationsRequestedItems
Get-BetaAccessRequestRecommendationsRequestedItems
# Below is a request that includes all optional parameters
# Get-BetaAccessRequestRecommendationsRequestedItems -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters
# Get-BetaAccessRequestRecommendationsRequestedItems -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsRequestedItems"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-access-request-recommendations-viewed-items
This API returns the list of viewed access request recommendations.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-recommendations-viewed-items)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -417,10 +441,10 @@ $Sorters = "MySorters" # String | Sort results using the standard syntax describ
# List of Viewed Access Request Recommendations
try {
Get-BetaAccessRequestRecommendationsViewedItems
Get-BetaAccessRequestRecommendationsViewedItems
# Below is a request that includes all optional parameters
# Get-BetaAccessRequestRecommendationsViewedItems -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters
# Get-BetaAccessRequestRecommendationsViewedItems -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsViewedItems"
Write-Host $_.ErrorDetails

21
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAICommonAccessApi.md
View File

@@ -21,9 +21,12 @@ Method | HTTP request | Description
[**Get-BetaCommonAccess**](#get-common-access) | **GET** `/common-access` | Get a paginated list of common access
[**Update-BetaCommonAccessStatusInBulk**](#update-common-access-status-in-bulk) | **POST** `/common-access/update-status` | Bulk update common access status
## create-common-access
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/beta/create-common-access)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -64,19 +67,22 @@ $CommonAccessItemRequest = @"{
try {
$Result = ConvertFrom-JsonToCommonAccessItemRequest -Json $CommonAccessItemRequest
New-BetaCommonAccess -BetaCommonAccessItemRequest $Result
New-BetaCommonAccess -BetaCommonAccessItemRequest $Result
# Below is a request that includes all optional parameters
# New-BetaCommonAccess -BetaCommonAccessItemRequest $CommonAccessItemRequest
# New-BetaCommonAccess -BetaCommonAccessItemRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCommonAccess"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-common-access
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/beta/get-common-access)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -113,19 +119,22 @@ $Sorters = "access.name" # String | Sort results using the standard syntax descr
# Get a paginated list of common access
try {
Get-BetaCommonAccess
Get-BetaCommonAccess
# Below is a request that includes all optional parameters
# Get-BetaCommonAccess -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters
# Get-BetaCommonAccess -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCommonAccess"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-common-access-status-in-bulk
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/beta/update-common-access-status-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -160,10 +169,10 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToCommonAccessIDStatus -Json $CommonAccessIDStatus
Update-BetaCommonAccessStatusInBulk -BetaCommonAccessIDStatus $Result
Update-BetaCommonAccessStatusInBulk -BetaCommonAccessIDStatus $Result
# Below is a request that includes all optional parameters
# Update-BetaCommonAccessStatusInBulk -BetaCommonAccessIDStatus $CommonAccessIDStatus
# Update-BetaCommonAccessStatusInBulk -BetaCommonAccessIDStatus $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCommonAccessStatusInBulk"
Write-Host $_.ErrorDetails

7
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIMessageCatalogsApi.md
View File

@@ -19,9 +19,12 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaMessageCatalogs**](#get-message-catalogs) | **GET** `/translation-catalogs/{catalog-id}` | Get Message catalogs
## get-message-catalogs
The getMessageCatalogs API returns message catalog based on the language headers in the requested object.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-message-catalogs)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -51,10 +54,10 @@ $CatalogId = "recommender" # String | The ID of the message catalog.
# Get Message catalogs
try {
Get-BetaMessageCatalogs -BetaCatalogId $CatalogId
Get-BetaMessageCatalogs -CatalogId $CatalogId
# Below is a request that includes all optional parameters
# Get-BetaMessageCatalogs -BetaCatalogId $CatalogId
# Get-BetaMessageCatalogs -CatalogId $CatalogId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMessageCatalogs"
Write-Host $_.ErrorDetails

63
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIOutliersApi.md
View File

@@ -27,12 +27,15 @@ Method | HTTP request | Description
[**Get-BetaOutliersContributingFeatureAccessItems**](#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-BetaUnIgnoreIdentityOutliers**](#un-ignore-identity-outliers) | **POST** `/outliers/unignore` | IAI Identity Outliers Unignore
## export-outliers-zip
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/beta/export-outliers-zip)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -62,19 +65,22 @@ $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to fi
# IAI Identity Outliers Export
try {
Export-BetaOutliersZip
Export-BetaOutliersZip
# Below is a request that includes all optional parameters
# Export-BetaOutliersZip -BetaType $Type
# Export-BetaOutliersZip -Type $Type
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaOutliersZip"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-outlier-snapshots
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/beta/get-identity-outlier-snapshots)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -113,19 +119,22 @@ $Sorters = "snapshotDate" # String | Sort results using the standard syntax desc
# IAI Identity Outliers Summary
try {
Get-BetaIdentityOutlierSnapshots
Get-BetaIdentityOutlierSnapshots
# Below is a request that includes all optional parameters
# Get-BetaIdentityOutlierSnapshots -BetaLimit $Limit -BetaOffset $Offset -BetaType $Type -BetaFilters $Filters -BetaSorters $Sorters
# Get-BetaIdentityOutlierSnapshots -Limit $Limit -Offset $Offset -Type $Type -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOutlierSnapshots"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-outliers
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/beta/get-identity-outliers)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -165,19 +174,22 @@ $Sorters = "attributes.displayName,firstDetectionDate,-score" # String | Sort re
# IAI Get Identity Outliers
try {
Get-BetaIdentityOutliers
Get-BetaIdentityOutliers
# Below is a request that includes all optional parameters
# Get-BetaIdentityOutliers -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaType $Type -BetaFilters $Filters -BetaSorters $Sorters
# Get-BetaIdentityOutliers -Limit $Limit -Offset $Offset -Count $Count -Type $Type -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOutliers"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-latest-identity-outlier-snapshots
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/beta/get-latest-identity-outlier-snapshots)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -208,22 +220,25 @@ $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to fi
# IAI Identity Outliers Latest Summary
try {
Get-BetaLatestIdentityOutlierSnapshots
Get-BetaLatestIdentityOutlierSnapshots
# Below is a request that includes all optional parameters
# Get-BetaLatestIdentityOutlierSnapshots -BetaType $Type
# Get-BetaLatestIdentityOutlierSnapshots -Type $Type
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLatestIdentityOutlierSnapshots"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-outlier-contributing-feature-summary
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/beta/get-outlier-contributing-feature-summary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -254,22 +269,25 @@ $OutlierFeatureId = "04654b66-7561-4090-94f9-abee0722a1af" # String | Contributi
# Get identity outlier contibuting feature summary
try {
Get-BetaOutlierContributingFeatureSummary -BetaOutlierFeatureId $OutlierFeatureId
Get-BetaOutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId
# Below is a request that includes all optional parameters
# Get-BetaOutlierContributingFeatureSummary -BetaOutlierFeatureId $OutlierFeatureId
# Get-BetaOutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOutlierContributingFeatureSummary"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-peer-group-outliers-contributing-features
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/beta/get-peer-group-outliers-contributing-features)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -310,19 +328,22 @@ $Sorters = "importance" # String | Sort results using the standard syntax descri
# Get identity outlier's contibuting features
try {
Get-BetaPeerGroupOutliersContributingFeatures -BetaOutlierId $OutlierId
Get-BetaPeerGroupOutliersContributingFeatures -OutlierId $OutlierId
# Below is a request that includes all optional parameters
# Get-BetaPeerGroupOutliersContributingFeatures -BetaOutlierId $OutlierId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaIncludeTranslationMessages $IncludeTranslationMessages -BetaSorters $Sorters
# Get-BetaPeerGroupOutliersContributingFeatures -OutlierId $OutlierId -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPeerGroupOutliersContributingFeatures"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## ignore-identity-outliers
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/beta/ignore-identity-outliers)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -355,22 +376,25 @@ $RequestBody = "MyRequestBody" # String[] |
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Invoke-BetaIgnoreIdentityOutliers -BetaRequestBody $Result
Invoke-BetaIgnoreIdentityOutliers -RequestBody $Result
# Below is a request that includes all optional parameters
# Invoke-BetaIgnoreIdentityOutliers -BetaRequestBody $RequestBody
# Invoke-BetaIgnoreIdentityOutliers -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaIgnoreIdentityOutliers"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-outliers-contributing-feature-access-items
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/beta/list-outliers-contributing-feature-access-items)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -413,19 +437,22 @@ $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-BetaOutliersContributingFeatureAccessItems -BetaOutlierId $OutlierId -BetaContributingFeatureName $ContributingFeatureName
Get-BetaOutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName
# Below is a request that includes all optional parameters
# Get-BetaOutliersContributingFeatureAccessItems -BetaOutlierId $OutlierId -BetaContributingFeatureName $ContributingFeatureName -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaAccessType $AccessType -BetaSorters $Sorters
# Get-BetaOutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName -Limit $Limit -Offset $Offset -Count $Count -AccessType $AccessType -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOutliersContributingFeatureAccessItems"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## un-ignore-identity-outliers
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/beta/un-ignore-identity-outliers)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -458,10 +485,10 @@ $RequestBody = "MyRequestBody" # String[] |
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Invoke-BetaUnIgnoreIdentityOutliers -BetaRequestBody $Result
Invoke-BetaUnIgnoreIdentityOutliers -RequestBody $Result
# Below is a request that includes all optional parameters
# Invoke-BetaUnIgnoreIdentityOutliers -BetaRequestBody $RequestBody
# Invoke-BetaUnIgnoreIdentityOutliers -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaUnIgnoreIdentityOutliers"
Write-Host $_.ErrorDetails

10
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIPeerGroupStrategiesApi.md
View File

@@ -19,9 +19,15 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaPeerGroupOutliers**](#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.
:::
-- 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/beta/get-peer-group-outliers)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -57,10 +63,10 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Identity Outliers List
try {
Get-BetaPeerGroupOutliers -BetaStrategy $Strategy
Get-BetaPeerGroupOutliers -Strategy $Strategy
# Below is a request that includes all optional parameters
# Get-BetaPeerGroupOutliers -BetaStrategy $Strategy -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count
# Get-BetaPeerGroupOutliers -Strategy $Strategy -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPeerGroupOutliers"
Write-Host $_.ErrorDetails

19
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIRecommendationsApi.md
View File

@@ -21,9 +21,12 @@ Method | HTTP request | Description
[**Get-BetaRecommendationsConfig**](#get-recommendations-config) | **GET** `/recommendations/config` | Get certification recommendation config values
[**Update-BetaRecommendationsConfig**](#update-recommendations-config) | **PUT** `/recommendations/config` | Update certification recommendation config values
## get-recommendations
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/beta/get-recommendations)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -72,19 +75,22 @@ $RecommendationRequestDto = @"{
try {
$Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto
Get-BetaRecommendations -BetaRecommendationRequestDto $Result
Get-BetaRecommendations -BetaRecommendationRequestDto $Result
# Below is a request that includes all optional parameters
# Get-BetaRecommendations -BetaRecommendationRequestDto $RecommendationRequestDto
# Get-BetaRecommendations -BetaRecommendationRequestDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRecommendations"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-recommendations-config
Retrieves configuration attributes used by certification recommendations.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-recommendations-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -111,7 +117,7 @@ Code | Description | Data Type
# Get certification recommendation config values
try {
Get-BetaRecommendationsConfig
Get-BetaRecommendationsConfig
# Below is a request that includes all optional parameters
# Get-BetaRecommendationsConfig
@@ -121,9 +127,12 @@ try {
}
```
[[Back to top]](#)
## update-recommendations-config
Updates configuration attributes used by certification recommendations.
[API Spec](https://developer.sailpoint.com/docs/api/beta/update-recommendations-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -158,10 +167,10 @@ $RecommendationConfigDto = @"{
try {
$Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto
Update-BetaRecommendationsConfig -BetaRecommendationConfigDto $Result
Update-BetaRecommendationsConfig -BetaRecommendationConfigDto $Result
# Below is a request that includes all optional parameters
# Update-BetaRecommendationsConfig -BetaRecommendationConfigDto $RecommendationConfigDto
# Update-BetaRecommendationsConfig -BetaRecommendationConfigDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRecommendationsConfig"
Write-Host $_.ErrorDetails

175
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIRoleMiningApi.md
View File

@@ -43,9 +43,12 @@ Method | HTTP request | Description
[**Update-BetaRoleMiningSession**](#patch-role-mining-session) | **PATCH** `/role-mining-sessions/{sessionId}` | Patch a role mining session
[**Update-BetaEntitlementsPotentialRole**](#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
This method starts a job to provision a potential role
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-potential-role-provision-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -89,19 +92,22 @@ $RoleMiningPotentialRoleProvisionRequest = @"{
# Create request to provision a potential role into an actual role.
try {
New-BetaPotentialRoleProvisionRequest -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
New-BetaPotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId
# Below is a request that includes all optional parameters
# New-BetaPotentialRoleProvisionRequest -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaMinEntitlementPopularity $MinEntitlementPopularity -BetaIncludeCommonAccess $IncludeCommonAccess -BetaRoleMiningPotentialRoleProvisionRequest $RoleMiningPotentialRoleProvisionRequest
# New-BetaPotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -MinEntitlementPopularity $MinEntitlementPopularity -IncludeCommonAccess $IncludeCommonAccess -BetaRoleMiningPotentialRoleProvisionRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPotentialRoleProvisionRequest"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-role-mining-sessions
This submits a create role mining session request to the role mining application.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-role-mining-sessions)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -163,19 +169,22 @@ $RoleMiningSessionDto = @"{
try {
$Result = ConvertFrom-JsonToRoleMiningSessionDto -Json $RoleMiningSessionDto
New-BetaRoleMiningSessions -BetaRoleMiningSessionDto $Result
New-BetaRoleMiningSessions -BetaRoleMiningSessionDto $Result
# Below is a request that includes all optional parameters
# New-BetaRoleMiningSessions -BetaRoleMiningSessionDto $RoleMiningSessionDto
# New-BetaRoleMiningSessions -BetaRoleMiningSessionDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRoleMiningSessions"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## download-role-mining-potential-role-zip
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/beta/download-role-mining-potential-role-zip)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -208,19 +217,22 @@ $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previo
# Export (download) details for a potential role in a role mining session
try {
Invoke-BetaDownloadRoleMiningPotentialRoleZip -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaExportId $ExportId
Invoke-BetaDownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId
# Below is a request that includes all optional parameters
# Invoke-BetaDownloadRoleMiningPotentialRoleZip -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaExportId $ExportId
# Invoke-BetaDownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaDownloadRoleMiningPotentialRoleZip"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## export-role-mining-potential-role
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/beta/export-role-mining-potential-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -251,19 +263,22 @@ $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential
# Export (download) details for a potential role in a role mining session
try {
Export-BetaRoleMiningPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
Export-BetaRoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId
# Below is a request that includes all optional parameters
# Export-BetaRoleMiningPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
# Export-BetaRoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRole"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## export-role-mining-potential-role-async
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/beta/export-role-mining-potential-role-async)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -299,19 +314,22 @@ $RoleMiningPotentialRoleExportRequest = @"{
# Asynchronously export details for a potential role in a role mining session and upload to S3
try {
Export-BetaRoleMiningPotentialRoleAsync -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
Export-BetaRoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId
# Below is a request that includes all optional parameters
# Export-BetaRoleMiningPotentialRoleAsync -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleExportRequest $RoleMiningPotentialRoleExportRequest
# Export-BetaRoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleExportRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRoleAsync"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## export-role-mining-potential-role-status
This endpoint retrieves information about the current status of a potential role export.
[API Spec](https://developer.sailpoint.com/docs/api/beta/export-role-mining-potential-role-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -344,19 +362,22 @@ $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previo
# Retrieve status of a potential role export job
try {
Export-BetaRoleMiningPotentialRoleStatus -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaExportId $ExportId
Export-BetaRoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId
# Below is a request that includes all optional parameters
# Export-BetaRoleMiningPotentialRoleStatus -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaExportId $ExportId
# Export-BetaRoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRoleStatus"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-all-potential-role-summaries
Returns all potential role summaries that match the query parameters
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-all-potential-role-summaries)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -394,19 +415,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Retrieves all potential role summaries
try {
Get-BetaAllPotentialRoleSummaries
Get-BetaAllPotentialRoleSummaries
# Below is a request that includes all optional parameters
# Get-BetaAllPotentialRoleSummaries -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count
# Get-BetaAllPotentialRoleSummaries -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllPotentialRoleSummaries"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-entitlement-distribution-potential-role
This method returns entitlement popularity distribution for a potential role in a role mining session.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-entitlement-distribution-potential-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -439,19 +463,22 @@ $IncludeCommonAccess = $true # Boolean | Boolean determining whether common acce
# Retrieves entitlement popularity distribution for a potential role in a role mining session
try {
Get-BetaEntitlementDistributionPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
Get-BetaEntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId
# Below is a request that includes all optional parameters
# Get-BetaEntitlementDistributionPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaIncludeCommonAccess $IncludeCommonAccess
# Get-BetaEntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -IncludeCommonAccess $IncludeCommonAccess
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementDistributionPotentialRole"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-entitlements-potential-role
This method returns entitlements for a potential role in a role mining session.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-entitlements-potential-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -495,19 +522,22 @@ $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-BetaEntitlementsPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
Get-BetaEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId
# Below is a request that includes all optional parameters
# Get-BetaEntitlementsPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaIncludeCommonAccess $IncludeCommonAccess -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count
# Get-BetaEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -IncludeCommonAccess $IncludeCommonAccess -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementsPotentialRole"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-excluded-entitlements-potential-role
This method returns excluded entitlements for a potential role in a role mining session.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-excluded-entitlements-potential-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -548,19 +578,22 @@ $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-BetaExcludedEntitlementsPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
Get-BetaExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId
# Below is a request that includes all optional parameters
# Get-BetaExcludedEntitlementsPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count
# Get-BetaExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaExcludedEntitlementsPotentialRole"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identities-potential-role
This method returns identities for a potential role in a role mining session.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identities-potential-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -601,19 +634,22 @@ $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-BetaIdentitiesPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
Get-BetaIdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId
# Below is a request that includes all optional parameters
# Get-BetaIdentitiesPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count
# Get-BetaIdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitiesPotentialRole"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-potential-role
This method returns a specific potential role for a role mining session.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-potential-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -645,19 +681,22 @@ $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential
# Retrieve potential role in session
try {
Get-BetaPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
Get-BetaPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId
# Below is a request that includes all optional parameters
# Get-BetaPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
# Get-BetaPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRole"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-potential-role-applications
This method returns the applications of a potential role for a role mining session.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-potential-role-applications)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -697,19 +736,22 @@ $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-BetaPotentialRoleApplications -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
Get-BetaPotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId
# Below is a request that includes all optional parameters
# Get-BetaPotentialRoleApplications -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count
# Get-BetaPotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleApplications"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-potential-role-entitlements
This method returns the entitlements of a potential role for a role mining session.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-potential-role-entitlements)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -749,19 +791,22 @@ $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-BetaPotentialRoleEntitlements -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
Get-BetaPotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId
# Below is a request that includes all optional parameters
# Get-BetaPotentialRoleEntitlements -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count
# Get-BetaPotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleEntitlements"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-potential-role-source-identity-usage
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/beta/get-potential-role-source-identity-usage)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -801,19 +846,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Retrieves potential role source usage
try {
Get-BetaPotentialRoleSourceIdentityUsage -BetaPotentialRoleId $PotentialRoleId -BetaSourceId $SourceId
Get-BetaPotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-BetaPotentialRoleSourceIdentityUsage -BetaPotentialRoleId $PotentialRoleId -BetaSourceId $SourceId -BetaSorters $Sorters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count
# Get-BetaPotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleSourceIdentityUsage"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-potential-role-summaries
This method returns the potential role summaries for a role mining session.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-potential-role-summaries)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -853,19 +901,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Retrieve session's potential role summaries
try {
Get-BetaPotentialRoleSummaries -BetaSessionId $SessionId
Get-BetaPotentialRoleSummaries -SessionId $SessionId
# Below is a request that includes all optional parameters
# Get-BetaPotentialRoleSummaries -BetaSessionId $SessionId -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count
# Get-BetaPotentialRoleSummaries -SessionId $SessionId -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleSummaries"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-mining-potential-role
This method returns a specific potential role.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-mining-potential-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -895,19 +946,22 @@ $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential
# Retrieves a specific potential role
try {
Get-BetaRoleMiningPotentialRole -BetaPotentialRoleId $PotentialRoleId
Get-BetaRoleMiningPotentialRole -PotentialRoleId $PotentialRoleId
# Below is a request that includes all optional parameters
# Get-BetaRoleMiningPotentialRole -BetaPotentialRoleId $PotentialRoleId
# Get-BetaRoleMiningPotentialRole -PotentialRoleId $PotentialRoleId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningPotentialRole"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-mining-session
The method retrieves a role mining session.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-mining-session)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -938,19 +992,22 @@ $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining s
# Get a role mining session
try {
Get-BetaRoleMiningSession -BetaSessionId $SessionId
Get-BetaRoleMiningSession -SessionId $SessionId
# Below is a request that includes all optional parameters
# Get-BetaRoleMiningSession -BetaSessionId $SessionId
# Get-BetaRoleMiningSession -SessionId $SessionId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSession"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-mining-session-status
This method returns a role mining session status for a customer.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-mining-session-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -979,19 +1036,22 @@ $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining s
# Get role mining session status state
try {
Get-BetaRoleMiningSessionStatus -BetaSessionId $SessionId
Get-BetaRoleMiningSessionStatus -SessionId $SessionId
# Below is a request that includes all optional parameters
# Get-BetaRoleMiningSessionStatus -BetaSessionId $SessionId
# Get-BetaRoleMiningSessionStatus -SessionId $SessionId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSessionStatus"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-mining-sessions
Returns all role mining sessions that match the query parameters
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-mining-sessions)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1029,19 +1089,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Retrieves all role mining sessions
try {
Get-BetaRoleMiningSessions
Get-BetaRoleMiningSessions
# Below is a request that includes all optional parameters
# Get-BetaRoleMiningSessions -BetaFilters $Filters -BetaSorters $Sorters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count
# Get-BetaRoleMiningSessions -Filters $Filters -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSessions"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-saved-potential-roles
This method returns all saved potential roles (draft roles).
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-saved-potential-roles)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1077,16 +1140,17 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Retrieves all saved potential roles
try {
Get-BetaSavedPotentialRoles
Get-BetaSavedPotentialRoles
# Below is a request that includes all optional parameters
# Get-BetaSavedPotentialRoles -BetaSorters $Sorters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count
# Get-BetaSavedPotentialRoles -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSavedPotentialRoles"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-potential-role
This method updates an existing potential role using the role mining session id and the potential role summary id.
@@ -1102,6 +1166,8 @@ The following fields can be modified:
>**NOTE: All other fields cannot be modified.**
[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-potential-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1138,16 +1204,17 @@ $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potenti
try {
$Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner
Update-BetaPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $Result
Update-BetaPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $Result
# Below is a request that includes all optional parameters
# Update-BetaPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $PatchPotentialRoleRequestInner
# Update-BetaPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPotentialRole"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-role-mining-potential-role
This method updates an existing potential role.
@@ -1163,6 +1230,8 @@ The following fields can be modified:
>**NOTE: All other fields cannot be modified.**
[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-role-mining-potential-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1197,19 +1266,22 @@ $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potenti
try {
$Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner
Update-BetaRoleMiningPotentialRole -BetaPotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $Result
Update-BetaRoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $Result
# Below is a request that includes all optional parameters
# Update-BetaRoleMiningPotentialRole -BetaPotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $PatchPotentialRoleRequestInner
# Update-BetaRoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRoleMiningPotentialRole"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-role-mining-session
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/beta/patch-role-mining-session)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1248,19 +1320,22 @@ $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining s
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-BetaRoleMiningSession -BetaSessionId $SessionId -BetaJsonPatchOperation $Result
Update-BetaRoleMiningSession -SessionId $SessionId -BetaJsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-BetaRoleMiningSession -BetaSessionId $SessionId -BetaJsonPatchOperation $JsonPatchOperation
# Update-BetaRoleMiningSession -SessionId $SessionId -BetaJsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRoleMiningSession"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-entitlements-potential-role
This endpoint adds or removes entitlements from an exclusion list for a potential role.
[API Spec](https://developer.sailpoint.com/docs/api/beta/update-entitlements-potential-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1297,10 +1372,10 @@ $RoleMiningPotentialRoleEditEntitlements = @"{
try {
$Result = ConvertFrom-JsonToRoleMiningPotentialRoleEditEntitlements -Json $RoleMiningPotentialRoleEditEntitlements
Update-BetaEntitlementsPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleEditEntitlements $Result
Update-BetaEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleEditEntitlements $Result
# Below is a request that includes all optional parameters
# Update-BetaEntitlementsPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleEditEntitlements $RoleMiningPotentialRoleEditEntitlements
# Update-BetaEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleEditEntitlements $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlementsPotentialRole"
Write-Host $_.ErrorDetails

14
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIconsApi.md
View File

@@ -22,9 +22,12 @@ Method | HTTP request | Description
[**Remove-BetaIcon**](#delete-icon) | **DELETE** `/icons/{objectType}/{objectId}` | Delete an icon
[**Set-BetaIcon**](#set-icon) | **PUT** `/icons/{objectType}/{objectId}` | Update an icon
## delete-icon
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/beta/delete-icon)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -57,19 +60,22 @@ $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id.
# Delete an icon
try {
Remove-BetaIcon -BetaObjectType $ObjectType -BetaObjectId $ObjectId
Remove-BetaIcon -ObjectType $ObjectType -ObjectId $ObjectId
# Below is a request that includes all optional parameters
# Remove-BetaIcon -BetaObjectType $ObjectType -BetaObjectId $ObjectId
# Remove-BetaIcon -ObjectType $ObjectType -ObjectId $ObjectId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIcon"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-icon
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/beta/set-icon)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -104,10 +110,10 @@ $Image = # System.IO.FileInfo | file with icon. Allowed mime-types ['image/png'
# Update an icon
try {
Set-BetaIcon -BetaObjectType $ObjectType -BetaObjectId $ObjectId -BetaImage $Image
Set-BetaIcon -ObjectType $ObjectType -ObjectId $ObjectId -Image $Image
# Below is a request that includes all optional parameters
# Set-BetaIcon -BetaObjectType $ObjectType -BetaObjectId $ObjectId -BetaImage $Image
# Set-BetaIcon -ObjectType $ObjectType -ObjectId $ObjectId -Image $Image
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaIcon"
Write-Host $_.ErrorDetails

77
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentitiesApi.md
View File

@@ -44,9 +44,12 @@ Method | HTTP request | Description
[**Start-BetaIdentityProcessing**](#start-identity-processing) | **POST** `/identities/process` | Process a list of identityIds
[**Sync-BetahronizeAttributesForIdentity**](#synchronize-attributes-for-identity) | **POST** `/identities/{identityId}/synchronize-attributes` | Attribute synchronization for single identity.
## delete-identity
The API returns successful response if the requested identity was deleted.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -77,19 +80,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id
# Delete identity
try {
Remove-BetaIdentity -BetaId $Id
Remove-BetaIdentity -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaIdentity -BetaId $Id
# Remove-BetaIdentity -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentity"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity
This API returns a single identity using the Identity ID.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -120,21 +126,24 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id
# Identity Details
try {
Get-BetaIdentity -BetaId $Id
Get-BetaIdentity -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaIdentity -BetaId $Id
# Get-BetaIdentity -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentity"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-ownership-details
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/beta/get-identity-ownership-details)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -165,19 +174,22 @@ $IdentityId = "ff8081814d2a8036014d701f3fbf53fa" # String | Identity ID.
# Get ownership details
try {
Get-BetaIdentityOwnershipDetails -BetaIdentityId $IdentityId
Get-BetaIdentityOwnershipDetails -IdentityId $IdentityId
# Below is a request that includes all optional parameters
# Get-BetaIdentityOwnershipDetails -BetaIdentityId $IdentityId
# Get-BetaIdentityOwnershipDetails -IdentityId $IdentityId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOwnershipDetails"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-assignment
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-assignment)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -210,19 +222,22 @@ $AssignmentId = "1cbb0705b38c4226b1334eadd8874086" # String | Assignment Id
# Role assignment details
try {
Get-BetaRoleAssignment -BetaIdentityId $IdentityId -BetaAssignmentId $AssignmentId
Get-BetaRoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId
# Below is a request that includes all optional parameters
# Get-BetaRoleAssignment -BetaIdentityId $IdentityId -BetaAssignmentId $AssignmentId
# Get-BetaRoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignment"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-assignments
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/beta/get-role-assignments)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -257,19 +272,22 @@ $RoleName = "Engineer" # String | Role name to filter the role assignments with
# List role assignments
try {
Get-BetaRoleAssignments -BetaIdentityId $IdentityId
Get-BetaRoleAssignments -IdentityId $IdentityId
# Below is a request that includes all optional parameters
# Get-BetaRoleAssignments -BetaIdentityId $IdentityId -BetaRoleId $RoleId -BetaRoleName $RoleName
# Get-BetaRoleAssignments -IdentityId $IdentityId -RoleId $RoleId -RoleName $RoleName
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignments"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-identities
This API returns a list of identities.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identities)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -309,19 +327,22 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
# List Identities
try {
Get-BetaIdentities
Get-BetaIdentities
# Below is a request that includes all optional parameters
# Get-BetaIdentities -BetaFilters $Filters -BetaSorters $Sorters -BetaDefaultFilter $DefaultFilter -BetaCount $Count -BetaLimit $Limit -BetaOffset $Offset
# Get-BetaIdentities -Filters $Filters -Sorters $Sorters -DefaultFilter $DefaultFilter -Count $Count -Limit $Limit -Offset $Offset
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentities"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## reset-identity
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/beta/reset-identity)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -352,20 +373,23 @@ $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id
# Reset an identity
try {
Reset-BetaIdentity -BetaIdentityId $IdentityId
Reset-BetaIdentity -IdentityId $IdentityId
# Below is a request that includes all optional parameters
# Reset-BetaIdentity -BetaIdentityId $IdentityId
# Reset-BetaIdentity -IdentityId $IdentityId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-BetaIdentity"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## send-identity-verification-account-token
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/beta/send-identity-verification-account-token)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -402,16 +426,17 @@ $SendAccountVerificationRequest = @"{
try {
$Result = ConvertFrom-JsonToSendAccountVerificationRequest -Json $SendAccountVerificationRequest
Send-BetaIdentityVerificationAccountToken -BetaId $Id -BetaSendAccountVerificationRequest $Result
Send-BetaIdentityVerificationAccountToken -Id $Id -BetaSendAccountVerificationRequest $Result
# Below is a request that includes all optional parameters
# Send-BetaIdentityVerificationAccountToken -BetaId $Id -BetaSendAccountVerificationRequest $SendAccountVerificationRequest
# Send-BetaIdentityVerificationAccountToken -Id $Id -BetaSendAccountVerificationRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaIdentityVerificationAccountToken"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-identities-invite
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.
@@ -420,6 +445,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/beta/start-identities-invite)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -454,16 +481,17 @@ $InviteIdentitiesRequest = @"{
try {
$Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest
Start-BetaIdentitiesInvite -BetaInviteIdentitiesRequest $Result
Start-BetaIdentitiesInvite -BetaInviteIdentitiesRequest $Result
# Below is a request that includes all optional parameters
# Start-BetaIdentitiesInvite -BetaInviteIdentitiesRequest $InviteIdentitiesRequest
# Start-BetaIdentitiesInvite -BetaInviteIdentitiesRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaIdentitiesInvite"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-identity-processing
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.
@@ -477,6 +505,8 @@ This endpoint will perform the following tasks:
A token with ORG_ADMIN or HELPDESK authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/start-identity-processing)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -510,19 +540,22 @@ $ProcessIdentitiesRequest = @"{
try {
$Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest
Start-BetaIdentityProcessing -BetaProcessIdentitiesRequest $Result
Start-BetaIdentityProcessing -BetaProcessIdentitiesRequest $Result
# Below is a request that includes all optional parameters
# Start-BetaIdentityProcessing -BetaProcessIdentitiesRequest $ProcessIdentitiesRequest
# Start-BetaIdentityProcessing -BetaProcessIdentitiesRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaIdentityProcessing"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## synchronize-attributes-for-identity
This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. A token with ORG_ADMIN or API authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/synchronize-attributes-for-identity)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -553,10 +586,10 @@ $IdentityId = "MyIdentityId" # String | The Identity id
# Attribute synchronization for single identity.
try {
Sync-BetahronizeAttributesForIdentity -BetaIdentityId $IdentityId
Sync-BetahronizeAttributesForIdentity -IdentityId $IdentityId
# Below is a request that includes all optional parameters
# Sync-BetahronizeAttributesForIdentity -BetaIdentityId $IdentityId
# Sync-BetahronizeAttributesForIdentity -IdentityId $IdentityId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetahronizeAttributesForIdentity"
Write-Host $_.ErrorDetails

42
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityAttributesApi.md
View File

@@ -24,9 +24,12 @@ Method | HTTP request | Description
[**Get-BetaIdentityAttributes**](#list-identity-attributes) | **GET** `/identity-attributes` | List Identity Attributes
[**Send-BetaIdentityAttribute**](#put-identity-attribute) | **PUT** `/identity-attributes/{name}` | Update Identity Attribute
## create-identity-attribute
Use this API to create a new identity attribute. A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-identity-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -79,19 +82,22 @@ $IdentityAttribute = @"{
try {
$Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute
New-BetaIdentityAttribute -BetaIdentityAttribute $Result
New-BetaIdentityAttribute -BetaIdentityAttribute $Result
# Below is a request that includes all optional parameters
# New-BetaIdentityAttribute -BetaIdentityAttribute $IdentityAttribute
# New-BetaIdentityAttribute -BetaIdentityAttribute $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaIdentityAttribute"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-identity-attribute
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. A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -122,19 +128,22 @@ $Name = "displayName" # String | The attribute's technical name.
# Delete Identity Attribute
try {
Remove-BetaIdentityAttribute -BetaName $Name
Remove-BetaIdentityAttribute -Name $Name
# Below is a request that includes all optional parameters
# Remove-BetaIdentityAttribute -BetaName $Name
# Remove-BetaIdentityAttribute -Name $Name
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityAttribute"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-identity-attributes-in-bulk
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. A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity-attributes-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -168,19 +177,22 @@ $IdentityAttributeNames = @"{
try {
$Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames
Remove-BetaIdentityAttributesInBulk -BetaIdentityAttributeNames $Result
Remove-BetaIdentityAttributesInBulk -BetaIdentityAttributeNames $Result
# Below is a request that includes all optional parameters
# Remove-BetaIdentityAttributesInBulk -BetaIdentityAttributeNames $IdentityAttributeNames
# Remove-BetaIdentityAttributesInBulk -BetaIdentityAttributeNames $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityAttributesInBulk"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-attribute
This gets an identity attribute for a given technical name.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -211,19 +223,22 @@ $Name = "displayName" # String | The attribute's technical name.
# Get Identity Attribute
try {
Get-BetaIdentityAttribute -BetaName $Name
Get-BetaIdentityAttribute -Name $Name
# Below is a request that includes all optional parameters
# Get-BetaIdentityAttribute -BetaName $Name
# Get-BetaIdentityAttribute -Name $Name
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAttribute"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-identity-attributes
Use this API to get a collection of identity attributes.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-attributes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -259,19 +274,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# List Identity Attributes
try {
Get-BetaIdentityAttributes
Get-BetaIdentityAttributes
# Below is a request that includes all optional parameters
# Get-BetaIdentityAttributes -BetaIncludeSystem $IncludeSystem -BetaIncludeSilent $IncludeSilent -BetaSearchableOnly $SearchableOnly -BetaCount $Count
# Get-BetaIdentityAttributes -IncludeSystem $IncludeSystem -IncludeSilent $IncludeSilent -SearchableOnly $SearchableOnly -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAttributes"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-identity-attribute
This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/put-identity-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -326,10 +344,10 @@ $IdentityAttribute = @"{
try {
$Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute
Send-BetaIdentityAttribute -BetaName $Name -BetaIdentityAttribute $Result
Send-BetaIdentityAttribute -Name $Name -BetaIdentityAttribute $Result
# Below is a request that includes all optional parameters
# Send-BetaIdentityAttribute -BetaName $Name -BetaIdentityAttribute $IdentityAttribute
# Send-BetaIdentityAttribute -Name $Name -BetaIdentityAttribute $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaIdentityAttribute"
Write-Host $_.ErrorDetails

77
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityHistoryApi.md
View File

@@ -29,9 +29,12 @@ Method | HTTP request | Description
[**Get-BetaIdentitySnapshotAccessItems**](#list-identity-snapshot-access-items) | **GET** `/historical-identities/{id}/snapshots/{date}/access-items` | Get Identity Access Items Snapshot
[**Get-BetaIdentitySnapshots**](#list-identity-snapshots) | **GET** `/historical-identities/{id}/snapshots` | Lists all the snapshots for the identity
## compare-identity-snapshots
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/beta/compare-identity-snapshots)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -75,19 +78,22 @@ $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-BetaIdentitySnapshots -BetaId $Id
Compare-BetaIdentitySnapshots -Id $Id
# Below is a request that includes all optional parameters
# Compare-BetaIdentitySnapshots -BetaId $Id -BetaSnapshot1 $Snapshot1 -BetaSnapshot2 $Snapshot2 -BetaAccessItemTypes $AccessItemTypes -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count
# Compare-BetaIdentitySnapshots -Id $Id -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-BetaIdentitySnapshots"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## compare-identity-snapshots-access-type
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/beta/compare-identity-snapshots-access-type)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -131,19 +137,22 @@ $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-BetaIdentitySnapshotsAccessType -BetaId $Id -BetaAccessType $AccessType
Compare-BetaIdentitySnapshotsAccessType -Id $Id -AccessType $AccessType
# Below is a request that includes all optional parameters
# Compare-BetaIdentitySnapshotsAccessType -BetaId $Id -BetaAccessType $AccessType -BetaAccessAssociated $AccessAssociated -BetaSnapshot1 $Snapshot1 -BetaSnapshot2 $Snapshot2 -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count
# Compare-BetaIdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -AccessAssociated $AccessAssociated -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-BetaIdentitySnapshotsAccessType"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-historical-identity
This method retrieves a specified identity Requires authorization scope of 'idn:identity-history:read'
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-historical-identity)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -173,19 +182,22 @@ $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id
# Get latest snapshot of identity
try {
Get-BetaHistoricalIdentity -BetaId $Id
Get-BetaHistoricalIdentity -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaHistoricalIdentity -BetaId $Id
# Get-BetaHistoricalIdentity -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentity"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-historical-identity-events
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/beta/get-historical-identity-events)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -232,19 +244,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Lists all events for the given identity
try {
Get-BetaHistoricalIdentityEvents -BetaId $Id
Get-BetaHistoricalIdentityEvents -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaHistoricalIdentityEvents -BetaId $Id -BetaFrom $From -BetaEventTypes $EventTypes -BetaAccessItemTypes $AccessItemTypes -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count
# Get-BetaHistoricalIdentityEvents -Id $Id -From $From -EventTypes $EventTypes -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentityEvents"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-snapshot
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/beta/get-identity-snapshot)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -276,19 +291,22 @@ $Date = "2007-03-01T13:00:00Z" # String | The specified date
# Gets an identity snapshot at a given date
try {
Get-BetaIdentitySnapshot -BetaId $Id -BetaDate $Date
Get-BetaIdentitySnapshot -Id $Id -Date $Date
# Below is a request that includes all optional parameters
# Get-BetaIdentitySnapshot -BetaId $Id -BetaDate $Date
# Get-BetaIdentitySnapshot -Id $Id -Date $Date
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshot"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-snapshot-summary
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/beta/get-identity-snapshot-summary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -330,19 +348,22 @@ $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-BetaIdentitySnapshotSummary -BetaId $Id
Get-BetaIdentitySnapshotSummary -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaIdentitySnapshotSummary -BetaId $Id -BetaBefore $Before -BetaInterval $Interval -BetaTimeZone $TimeZone -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count
# Get-BetaIdentitySnapshotSummary -Id $Id -Before $Before -Interval $Interval -TimeZone $TimeZone -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshotSummary"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-start-date
This method retrieves start date of the identity Requires authorization scope of 'idn:identity-history:read'
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-start-date)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -372,19 +393,22 @@ $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id
# Gets the start date of the identity
try {
Get-BetaIdentityStartDate -BetaId $Id
Get-BetaIdentityStartDate -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaIdentityStartDate -BetaId $Id
# Get-BetaIdentityStartDate -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityStartDate"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-historical-identities
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/beta/list-historical-identities)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -422,19 +446,22 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
# Lists all the identities
try {
Get-BetaHistoricalIdentities
Get-BetaHistoricalIdentities
# Below is a request that includes all optional parameters
# Get-BetaHistoricalIdentities -BetaStartsWithQuery $StartsWithQuery -BetaIsDeleted $IsDeleted -BetaIsActive $IsActive -BetaLimit $Limit -BetaOffset $Offset
# Get-BetaHistoricalIdentities -StartsWithQuery $StartsWithQuery -IsDeleted $IsDeleted -IsActive $IsActive -Limit $Limit -Offset $Offset
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentities"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-identity-access-items
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/beta/list-identity-access-items)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -479,19 +506,22 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
# List Access Items by Identity
try {
Get-BetaIdentityAccessItems -BetaId $Id
Get-BetaIdentityAccessItems -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaIdentityAccessItems -BetaId $Id -BetaType $Type -BetaFilters $Filters -BetaSorters $Sorters -BetaQuery $Query -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset
# Get-BetaIdentityAccessItems -Id $Id -Type $Type -Filters $Filters -Sorters $Sorters -Query $Query -Limit $Limit -Count $Count -Offset $Offset
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAccessItems"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-identity-snapshot-access-items
Use this API to get a list of identity access items at a specified date, filtered by item type.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-snapshot-access-items)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -526,19 +556,22 @@ $Type = "role" # String | Access item type. (optional)
# Get Identity Access Items Snapshot
try {
Get-BetaIdentitySnapshotAccessItems -BetaId $Id -BetaDate $Date
Get-BetaIdentitySnapshotAccessItems -Id $Id -Date $Date
# Below is a request that includes all optional parameters
# Get-BetaIdentitySnapshotAccessItems -BetaId $Id -BetaDate $Date -BetaType $Type
# Get-BetaIdentitySnapshotAccessItems -Id $Id -Date $Date -Type $Type
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshotAccessItems"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-identity-snapshots
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/beta/list-identity-snapshots)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -578,10 +611,10 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Lists all the snapshots for the identity
try {
Get-BetaIdentitySnapshots -BetaId $Id
Get-BetaIdentitySnapshots -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaIdentitySnapshots -BetaId $Id -BetaStart $Start -BetaInterval $Interval -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count
# Get-BetaIdentitySnapshots -Id $Id -Start $Start -Interval $Interval -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshots"
Write-Host $_.ErrorDetails

77
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityProfilesApi.md
View File

@@ -40,11 +40,14 @@ Method | HTTP request | Description
[**Sync-BetaIdentityProfile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile
[**Update-BetaIdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update the Identity Profile
## create-identity-profile
This creates an Identity Profile.
A token with ORG_ADMIN authority is required to call this API to create an Identity Profile.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-identity-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -123,16 +126,17 @@ $IdentityProfile = @"{
try {
$Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile
New-BetaIdentityProfile -BetaIdentityProfile $Result
New-BetaIdentityProfile -BetaIdentityProfile $Result
# Below is a request that includes all optional parameters
# New-BetaIdentityProfile -BetaIdentityProfile $IdentityProfile
# New-BetaIdentityProfile -BetaIdentityProfile $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaIdentityProfile"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-identity-profile
This deletes an Identity Profile based on ID.
@@ -142,6 +146,8 @@ A token with ORG_ADMIN authority is required to call this API.
The following rights are required to access this endpoint: idn:identity-profile:delete
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -172,16 +178,17 @@ $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity
# Delete an Identity Profile
try {
Remove-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId
Remove-BetaIdentityProfile -IdentityProfileId $IdentityProfileId
# Below is a request that includes all optional parameters
# Remove-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId
# Remove-BetaIdentityProfile -IdentityProfileId $IdentityProfileId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityProfile"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-identity-profiles
This deletes multiple Identity Profiles via a list of supplied IDs.
@@ -191,6 +198,8 @@ A token with ORG_ADMIN authority is required to call this API.
The following rights are required to access this endpoint: idn:identity-profile:delete
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity-profiles)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -223,19 +232,22 @@ $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Remove-BetaIdentityProfiles -BetaRequestBody $Result
Remove-BetaIdentityProfiles -RequestBody $Result
# Below is a request that includes all optional parameters
# Remove-BetaIdentityProfiles -BetaRequestBody $RequestBody
# Remove-BetaIdentityProfiles -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityProfiles"
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/beta/export-identity-profiles)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -274,20 +286,23 @@ $Sorters = "name,-priority" # String | Sort results using the standard syntax de
# Export Identity Profiles
try {
Export-BetaIdentityProfiles
Export-BetaIdentityProfiles
# Below is a request that includes all optional parameters
# Export-BetaIdentityProfiles -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters
# Export-BetaIdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaIdentityProfiles"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-default-identity-attribute-config
This returns the default identity attribute config
A token with ORG_ADMIN authority is required to call this API to get the default identity attribute config.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-default-identity-attribute-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -318,21 +333,24 @@ $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity
# Default identity attribute config
try {
Get-BetaDefaultIdentityAttributeConfig -BetaIdentityProfileId $IdentityProfileId
Get-BetaDefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId
# Below is a request that includes all optional parameters
# Get-BetaDefaultIdentityAttributeConfig -BetaIdentityProfileId $IdentityProfileId
# Get-BetaDefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDefaultIdentityAttributeConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-profile
This returns a single Identity Profile based on ID.
A token with ORG_ADMIN or API authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -363,19 +381,22 @@ $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity
# Gets a single Identity Profile
try {
Get-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId
Get-BetaIdentityProfile -IdentityProfileId $IdentityProfileId
# Below is a request that includes all optional parameters
# Get-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId
# Get-BetaIdentityProfile -IdentityProfileId $IdentityProfileId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityProfile"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## import-identity-profiles
This imports previously exported identity profiles.
[API Spec](https://developer.sailpoint.com/docs/api/beta/import-identity-profiles)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -468,20 +489,23 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject
Import-BetaIdentityProfiles -BetaIdentityProfileExportedObject $Result
Import-BetaIdentityProfiles -BetaIdentityProfileExportedObject $Result
# Below is a request that includes all optional parameters
# Import-BetaIdentityProfiles -BetaIdentityProfileExportedObject $IdentityProfileExportedObject
# Import-BetaIdentityProfiles -BetaIdentityProfileExportedObject $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaIdentityProfiles"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-identity-profiles
This returns a list of Identity Profiles based on the specified query parameters.
A token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-profiles)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -519,21 +543,24 @@ $Sorters = "name,-priority" # String | Sort results using the standard syntax de
# Identity Profiles List
try {
Get-BetaIdentityProfiles
Get-BetaIdentityProfiles
# Below is a request that includes all optional parameters
# Get-BetaIdentityProfiles -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters
# Get-BetaIdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityProfiles"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## show-generate-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.
A token with ORG_ADMIN authority is required to call this API to generate an identity preview.
[API Spec](https://developer.sailpoint.com/docs/api/beta/show-generate-identity-preview)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -590,16 +617,17 @@ $IdentityPreviewRequest = @"{
try {
$Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest
Show-BetaGenerateIdentityPreview -BetaIdentityPreviewRequest $Result
Show-BetaGenerateIdentityPreview -BetaIdentityPreviewRequest $Result
# Below is a request that includes all optional parameters
# Show-BetaGenerateIdentityPreview -BetaIdentityPreviewRequest $IdentityPreviewRequest
# Show-BetaGenerateIdentityPreview -BetaIdentityPreviewRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-BetaGenerateIdentityPreview"
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.
@@ -608,6 +636,8 @@ This operation will perform the following activities on all identities under the
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.
A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/sync-identity-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -638,16 +668,17 @@ $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity
# Process identities under profile
try {
Sync-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId
Sync-BetaIdentityProfile -IdentityProfileId $IdentityProfileId
# Below is a request that includes all optional parameters
# Sync-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId
# Sync-BetaIdentityProfile -IdentityProfileId $IdentityProfileId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetaIdentityProfile"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-identity-profile
This updates the specified Identity Profile.
@@ -662,6 +693,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/beta/update-identity-profile)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -700,10 +733,10 @@ $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId -BetaJsonPatchOperation $Result
Update-BetaIdentityProfile -IdentityProfileId $IdentityProfileId -BetaJsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId -BetaJsonPatchOperation $JsonPatchOperation
# Update-BetaIdentityProfile -IdentityProfileId $IdentityProfileId -BetaJsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaIdentityProfile"
Write-Host $_.ErrorDetails

42
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaLaunchersApi.md
View File

@@ -27,9 +27,12 @@ Method | HTTP request | Description
[**Send-BetaLauncher**](#put-launcher) | **PUT** `/launchers/{launcherID}` | Replace Launcher
[**Start-BetaLauncher**](#start-launcher) | **POST** `/beta/launchers/{launcherID}/launch` | Launch a Launcher
## create-launcher
Create a Launcher with given information
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-launcher)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -71,19 +74,22 @@ $LauncherRequest = @"{
try {
$Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest
New-BetaLauncher -BetaLauncherRequest $Result
New-BetaLauncher -BetaLauncherRequest $Result
# Below is a request that includes all optional parameters
# New-BetaLauncher -BetaLauncherRequest $LauncherRequest
# New-BetaLauncher -BetaLauncherRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaLauncher"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-launcher
Delete the given Launcher ID
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-launcher)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -114,19 +120,22 @@ $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launch
# Delete Launcher
try {
Remove-BetaLauncher -BetaLauncherID $LauncherID
Remove-BetaLauncher -LauncherID $LauncherID
# Below is a request that includes all optional parameters
# Remove-BetaLauncher -BetaLauncherID $LauncherID
# Remove-BetaLauncher -LauncherID $LauncherID
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaLauncher"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-launcher
Get details for the given Launcher ID
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-launcher)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -157,19 +166,22 @@ $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launch
# Get Launcher by ID
try {
Get-BetaLauncher -BetaLauncherID $LauncherID
Get-BetaLauncher -LauncherID $LauncherID
# Below is a request that includes all optional parameters
# Get-BetaLauncher -BetaLauncherID $LauncherID
# Get-BetaLauncher -LauncherID $LauncherID
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLauncher"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-launchers
Return a list of Launchers for the authenticated tenant
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-launchers)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -204,19 +216,22 @@ $Limit = 42 # Int32 | Number of Launchers to return (optional) (default to 10)
# List all Launchers for tenant
try {
Get-BetaLaunchers
Get-BetaLaunchers
# Below is a request that includes all optional parameters
# Get-BetaLaunchers -BetaFilters $Filters -BetaNext $Next -BetaLimit $Limit
# Get-BetaLaunchers -Filters $Filters -Next $Next -Limit $Limit
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLaunchers"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-launcher
Replace the given Launcher ID with given payload
[API Spec](https://developer.sailpoint.com/docs/api/beta/put-launcher)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -260,19 +275,22 @@ $LauncherRequest = @"{
try {
$Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest
Send-BetaLauncher -BetaLauncherID $LauncherID -BetaLauncherRequest $Result
Send-BetaLauncher -LauncherID $LauncherID -BetaLauncherRequest $Result
# Below is a request that includes all optional parameters
# Send-BetaLauncher -BetaLauncherID $LauncherID -BetaLauncherRequest $LauncherRequest
# Send-BetaLauncher -LauncherID $LauncherID -BetaLauncherRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaLauncher"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-launcher
Launch the given Launcher ID
[API Spec](https://developer.sailpoint.com/docs/api/beta/start-launcher)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -303,10 +321,10 @@ $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launch
# Launch a Launcher
try {
Start-BetaLauncher -BetaLauncherID $LauncherID
Start-BetaLauncher -LauncherID $LauncherID
# Below is a request that includes all optional parameters
# Start-BetaLauncher -BetaLauncherID $LauncherID
# Start-BetaLauncher -LauncherID $LauncherID
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaLauncher"
Write-Host $_.ErrorDetails

14
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaLifecycleStatesApi.md
View File

@@ -56,12 +56,15 @@ Method | HTTP request | Description
[**Get-BetaLifecycleStates**](#get-lifecycle-states) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get Lifecycle State
[**Update-BetaLifecycleStates**](#update-lifecycle-states) | **PATCH** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State
## get-lifecycle-states
Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID.
A token with ORG_ADMIN or API authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-lifecycle-states)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -93,22 +96,25 @@ $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle Stat
# Get Lifecycle State
try {
Get-BetaLifecycleStates -BetaIdentityProfileId $IdentityProfileId -BetaLifecycleStateId $LifecycleStateId
Get-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
# Below is a request that includes all optional parameters
# Get-BetaLifecycleStates -BetaIdentityProfileId $IdentityProfileId -BetaLifecycleStateId $LifecycleStateId
# Get-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLifecycleStates"
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.
A token with ORG_ADMIN or API authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/update-lifecycle-states)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -148,10 +154,10 @@ $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle Stat
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-BetaLifecycleStates -BetaIdentityProfileId $IdentityProfileId -BetaLifecycleStateId $LifecycleStateId -BetaJsonPatchOperation $Result
Update-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -BetaJsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-BetaLifecycleStates -BetaIdentityProfileId $IdentityProfileId -BetaLifecycleStateId $LifecycleStateId -BetaJsonPatchOperation $JsonPatchOperation
# Update-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -BetaJsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaLifecycleStates"
Write-Host $_.ErrorDetails

52
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMFAConfigurationApi.md
View File

@@ -26,9 +26,12 @@ Method | HTTP request | Description
[**Set-BetaMFAOktaConfig**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set Okta MFA configuration
[**Test-BetaMFAConfig**](#test-mfa-config) | **GET** `/mfa/{method}/test` | MFA method's test configuration
## delete-mfa-config
This API removes the configuration for the specified MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-mfa-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -58,19 +61,22 @@ $Method = "okta-verify" # String | The name of the MFA method. The currently sup
# Delete MFA method configuration
try {
Remove-BetaMFAConfig -BetaMethod $Method
Remove-BetaMFAConfig -Method $Method
# Below is a request that includes all optional parameters
# Remove-BetaMFAConfig -BetaMethod $Method
# Remove-BetaMFAConfig -Method $Method
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaMFAConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-mfa-duo-config
This API returns the configuration of an Duo MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-mfa-duo-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -98,7 +104,7 @@ Code | Description | Data Type
# Configuration of Duo MFA method
try {
Get-BetaMFADuoConfig
Get-BetaMFADuoConfig
# Below is a request that includes all optional parameters
# Get-BetaMFADuoConfig
@@ -108,9 +114,12 @@ try {
}
```
[[Back to top]](#)
## get-mfa-kba-config
This API returns the KBA configuration for MFA.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-mfa-kba-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -140,19 +149,22 @@ $AllLanguages = $false # Boolean | Indicator whether the question text should be
# Configuration of KBA MFA method
try {
Get-BetaMFAKbaConfig
Get-BetaMFAKbaConfig
# Below is a request that includes all optional parameters
# Get-BetaMFAKbaConfig -BetaAllLanguages $AllLanguages
# Get-BetaMFAKbaConfig -AllLanguages $AllLanguages
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFAKbaConfig"
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/beta/get-mfa-okta-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -180,7 +192,7 @@ Code | Description | Data Type
# Configuration of Okta MFA method
try {
Get-BetaMFAOktaConfig
Get-BetaMFAOktaConfig
# Below is a request that includes all optional parameters
# Get-BetaMFAOktaConfig
@@ -190,9 +202,12 @@ try {
}
```
[[Back to top]](#)
## set-mfa-duo-config
This API sets the configuration of an Duo MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/beta/set-mfa-duo-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -233,19 +248,22 @@ $MfaDuoConfig = @"{
try {
$Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig
Set-BetaMFADuoConfig -BetaMfaDuoConfig $Result
Set-BetaMFADuoConfig -BetaMfaDuoConfig $Result
# Below is a request that includes all optional parameters
# Set-BetaMFADuoConfig -BetaMfaDuoConfig $MfaDuoConfig
# Set-BetaMFADuoConfig -BetaMfaDuoConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFADuoConfig"
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/beta/set-mfakba-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -280,19 +298,22 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem
Set-BetaMFAKBAConfig -BetaKbaAnswerRequestItem $Result
Set-BetaMFAKBAConfig -BetaKbaAnswerRequestItem $Result
# Below is a request that includes all optional parameters
# Set-BetaMFAKBAConfig -BetaKbaAnswerRequestItem $KbaAnswerRequestItem
# Set-BetaMFAKBAConfig -BetaKbaAnswerRequestItem $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFAKBAConfig"
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/beta/set-mfa-okta-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -329,19 +350,22 @@ $MfaOktaConfig = @"{
try {
$Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig
Set-BetaMFAOktaConfig -BetaMfaOktaConfig $Result
Set-BetaMFAOktaConfig -BetaMfaOktaConfig $Result
# Below is a request that includes all optional parameters
# Set-BetaMFAOktaConfig -BetaMfaOktaConfig $MfaOktaConfig
# Set-BetaMFAOktaConfig -BetaMfaOktaConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFAOktaConfig"
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/beta/test-mfa-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -371,10 +395,10 @@ $Method = "okta-verify" # String | The name of the MFA method. The currently sup
# MFA method's test configuration
try {
Test-BetaMFAConfig -BetaMethod $Method
Test-BetaMFAConfig -Method $Method
# Below is a request that includes all optional parameters
# Test-BetaMFAConfig -BetaMethod $Method
# Test-BetaMFAConfig -Method $Method
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaMFAConfig"
Write-Host $_.ErrorDetails

42
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMFAControllerApi.md
View File

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

20
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaManagedClientsApi.md
View File

@@ -22,9 +22,15 @@ Method | HTTP request | Description
[**Get-BetaManagedClientStatus**](#get-managed-client-status) | **GET** `/managed-clients/{id}/status` | Specified Managed Client Status.
[**Update-BetaManagedClientStatus**](#update-managed-client-status) | **POST** `/managed-clients/{id}/status` | Handle status request from client
## get-managed-client-status
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Retrieve Managed Client Status by ID.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-managed-client-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -57,19 +63,25 @@ $Type = "CCG" # ManagedClientType | Type of the Managed Client Status to get
# Specified Managed Client Status.
try {
Get-BetaManagedClientStatus -BetaId $Id -BetaType $Type
Get-BetaManagedClientStatus -Id $Id -Type $Type
# Below is a request that includes all optional parameters
# Get-BetaManagedClientStatus -BetaId $Id -BetaType $Type
# Get-BetaManagedClientStatus -Id $Id -Type $Type
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClientStatus"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-managed-client-status
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Update a status detail passed in from the client
[API Spec](https://developer.sailpoint.com/docs/api/beta/update-managed-client-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -128,10 +140,10 @@ $ManagedClientStatus = @"{
try {
$Result = ConvertFrom-JsonToManagedClientStatus -Json $ManagedClientStatus
Update-BetaManagedClientStatus -BetaId $Id -BetaManagedClientStatus $Result
Update-BetaManagedClientStatus -Id $Id -BetaManagedClientStatus $Result
# Below is a request that includes all optional parameters
# Update-BetaManagedClientStatus -BetaId $Id -BetaManagedClientStatus $ManagedClientStatus
# Update-BetaManagedClientStatus -Id $Id -BetaManagedClientStatus $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaManagedClientStatus"
Write-Host $_.ErrorDetails

40
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaManagedClustersApi.md
View File

@@ -24,9 +24,15 @@ Method | HTTP request | Description
[**Get-BetaManagedClusters**](#get-managed-clusters) | **GET** `/managed-clusters` | Retrieve all Managed Clusters.
[**Send-BetaClientLogConfiguration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update managed cluster's log configuration
## get-client-log-configuration
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Get managed cluster's log configuration.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-client-log-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -57,19 +63,25 @@ $Id = "aClusterId" # String | ID of ManagedCluster to get log configuration for
# Get managed cluster's log configuration
try {
Get-BetaClientLogConfiguration -BetaId $Id
Get-BetaClientLogConfiguration -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaClientLogConfiguration -BetaId $Id
# Get-BetaClientLogConfiguration -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaClientLogConfiguration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-managed-cluster
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Retrieve a ManagedCluster by ID.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-managed-cluster)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -100,19 +112,25 @@ $Id = "aClusterId" # String | ID of the ManagedCluster to get
# Get a specified ManagedCluster.
try {
Get-BetaManagedCluster -BetaId $Id
Get-BetaManagedCluster -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaManagedCluster -BetaId $Id
# Get-BetaManagedCluster -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedCluster"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-managed-clusters
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Retrieve all Managed Clusters for the current Org, based on request context.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-managed-clusters)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -148,19 +166,25 @@ $Filters = 'operational eq operation' # String | Filter results using the standa
# Retrieve all Managed Clusters.
try {
Get-BetaManagedClusters
Get-BetaManagedClusters
# Below is a request that includes all optional parameters
# Get-BetaManagedClusters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaFilters $Filters
# Get-BetaManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClusters"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-client-log-configuration
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Update managed cluster's log configuration
[API Spec](https://developer.sailpoint.com/docs/api/beta/put-client-log-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -199,10 +223,10 @@ $ClientLogConfiguration = @"{
# Update managed cluster's log configuration
try {
Send-BetaClientLogConfiguration -BetaId $Id -BetaClientLogConfiguration $Result
Send-BetaClientLogConfiguration -Id $Id -BetaClientLogConfiguration $Result
# Below is a request that includes all optional parameters
# Send-BetaClientLogConfiguration -BetaId $Id -BetaClientLogConfiguration $ClientLogConfiguration
# Send-BetaClientLogConfiguration -Id $Id -BetaClientLogConfiguration $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaClientLogConfiguration"
Write-Host $_.ErrorDetails

89
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMultiHostIntegrationApi.md
View File

@@ -34,11 +34,14 @@ Method | HTTP request | Description
[**Test-BetaSourceConnectionMultihost**](#test-source-connection-multihost) | **GET** `/multihosts/{multihostId}/sources/{sourceId}/testConnection` | Test Configuration For Multi-Host Integration's Single Source
[**Update-BetaMultiHostSources**](#update-multi-host-sources) | **PATCH** `/multihosts/{multihostId}` | Update Multi-Host Integration
## create-multi-host-integration
This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources.
A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-multi-host-integration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -95,21 +98,24 @@ $MultiHostIntegrationsCreate = @"{
try {
$Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate
New-BetaMultiHostIntegration -BetaMultiHostIntegrationsCreate $Result
New-BetaMultiHostIntegration -BetaMultiHostIntegrationsCreate $Result
# Below is a request that includes all optional parameters
# New-BetaMultiHostIntegration -BetaMultiHostIntegrationsCreate $MultiHostIntegrationsCreate
# New-BetaMultiHostIntegration -BetaMultiHostIntegrationsCreate $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaMultiHostIntegration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-sources-within-multi-host
This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources.
A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-sources-within-multi-host)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -155,21 +161,24 @@ $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Hos
try {
$Result = ConvertFrom-JsonToMultiHostIntegrationsCreateSources -Json $MultiHostIntegrationsCreateSources
New-BetaSourcesWithinMultiHost -BetaMultihostId $MultihostId -BetaMultiHostIntegrationsCreateSources $Result
New-BetaSourcesWithinMultiHost -MultihostId $MultihostId -BetaMultiHostIntegrationsCreateSources $Result
# Below is a request that includes all optional parameters
# New-BetaSourcesWithinMultiHost -BetaMultihostId $MultihostId -BetaMultiHostIntegrationsCreateSources $MultiHostIntegrationsCreateSources
# New-BetaSourcesWithinMultiHost -MultihostId $MultihostId -BetaMultiHostIntegrationsCreateSources $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourcesWithinMultiHost"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-multi-host
Delete an existing Multi-Host Integration by ID.
A token with Org Admin or Multi Host Admin authority is required to access this endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-multi-host)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -200,21 +209,24 @@ $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of Multi-Host In
# Delete Multi-Host Integration
try {
Remove-BetaMultiHost -BetaMultihostId $MultihostId
Remove-BetaMultiHost -MultihostId $MultihostId
# Below is a request that includes all optional parameters
# Remove-BetaMultiHost -BetaMultihostId $MultihostId
# Remove-BetaMultiHost -MultihostId $MultihostId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaMultiHost"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-acct-aggregation-groups
This API will return array of account aggregation groups within provided Multi-Host Integration ID.
A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-acct-aggregation-groups)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -245,21 +257,24 @@ $MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to upd
# Get Account Aggregation Groups Within Multi-Host Integration ID
try {
Get-BetaAcctAggregationGroups -BetaMultihostId $MultihostId
Get-BetaAcctAggregationGroups -MultihostId $MultihostId
# Below is a request that includes all optional parameters
# Get-BetaAcctAggregationGroups -BetaMultihostId $MultihostId
# Get-BetaAcctAggregationGroups -MultihostId $MultihostId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAcctAggregationGroups"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-entitlement-aggregation-groups
This API will return array of aggregation groups within provided Multi-Host Integration ID.
A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-entitlement-aggregation-groups)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -290,21 +305,24 @@ $MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to upd
# Get Entitlement Aggregation Groups Within Multi-Host Integration ID
try {
Get-BetaEntitlementAggregationGroups -BetaMultiHostId $MultiHostId
Get-BetaEntitlementAggregationGroups -MultiHostId $MultiHostId
# Below is a request that includes all optional parameters
# Get-BetaEntitlementAggregationGroups -BetaMultiHostId $MultiHostId
# Get-BetaEntitlementAggregationGroups -MultiHostId $MultiHostId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementAggregationGroups"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-multi-host-integrations
Get an existing Multi-Host Integration.
A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-multi-host-integrations)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -335,21 +353,24 @@ $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Hos
# Get Multi-Host Integration By ID
try {
Get-BetaMultiHostIntegrations -BetaMultihostId $MultihostId
Get-BetaMultiHostIntegrations -MultihostId $MultihostId
# Below is a request that includes all optional parameters
# Get-BetaMultiHostIntegrations -BetaMultihostId $MultihostId
# Get-BetaMultiHostIntegrations -MultihostId $MultihostId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostIntegrations"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-multi-host-integrations-list
Get a list of Multi-Host Integrations.
A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-multi-host-integrations-list)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -390,21 +411,24 @@ $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filter
# List All Existing Multi-Host Integrations
try {
Get-BetaMultiHostIntegrationsList
Get-BetaMultiHostIntegrationsList
# Below is a request that includes all optional parameters
# Get-BetaMultiHostIntegrationsList -BetaOffset $Offset -BetaLimit $Limit -BetaSorters $Sorters -BetaFilters $Filters -BetaCount $Count -BetaForSubadmin $ForSubadmin
# Get-BetaMultiHostIntegrationsList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count -ForSubadmin $ForSubadmin
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostIntegrationsList"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-multi-host-source-creation-errors
Get a list of sources creation errors within Multi-Host Integration ID.
A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-multi-host-source-creation-errors)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -435,21 +459,24 @@ $MultiHostId = "004091cb79b04636b88662afa50a4440" # String | ID of the Multi-Hos
# List Multi-Host Source Creation Errors
try {
Get-BetaMultiHostSourceCreationErrors -BetaMultiHostId $MultiHostId
Get-BetaMultiHostSourceCreationErrors -MultiHostId $MultiHostId
# Below is a request that includes all optional parameters
# Get-BetaMultiHostSourceCreationErrors -BetaMultiHostId $MultiHostId
# Get-BetaMultiHostSourceCreationErrors -MultiHostId $MultiHostId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostSourceCreationErrors"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-multihost-integration-types
This API endpoint returns the current list of supported Multi-Host Integration types.
A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-multihost-integration-types)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -478,7 +505,7 @@ Code | Description | Data Type
# List Multi-Host Integration Types
try {
Get-BetaMultihostIntegrationTypes
Get-BetaMultihostIntegrationTypes
# Below is a request that includes all optional parameters
# Get-BetaMultihostIntegrationTypes
@@ -488,11 +515,14 @@ try {
}
```
[[Back to top]](#)
## get-sources-within-multi-host
Get a list of sources within Multi-Host Integration ID.
A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sources-within-multi-host)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -533,21 +563,24 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# List Sources Within Multi-Host Integration
try {
Get-BetaSourcesWithinMultiHost -BetaMultihostId $MultihostId
Get-BetaSourcesWithinMultiHost -MultihostId $MultihostId
# Below is a request that includes all optional parameters
# Get-BetaSourcesWithinMultiHost -BetaMultihostId $MultihostId -BetaOffset $Offset -BetaLimit $Limit -BetaSorters $Sorters -BetaFilters $Filters -BetaCount $Count
# Get-BetaSourcesWithinMultiHost -MultihostId $MultihostId -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourcesWithinMultiHost"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## test-connection-multi-host-sources
This endpoint performs a more detailed validation of the Multi-Host Integration's configuration.
A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/beta/test-connection-multi-host-sources)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -578,21 +611,24 @@ $MultihostId = "2c91808568c529c60168cca6f90c1324" # String | ID of the Multi-Hos
# Test Configuration For Multi-Host Integration
try {
Test-BetaConnectionMultiHostSources -BetaMultihostId $MultihostId
Test-BetaConnectionMultiHostSources -MultihostId $MultihostId
# Below is a request that includes all optional parameters
# Test-BetaConnectionMultiHostSources -BetaMultihostId $MultihostId
# Test-BetaConnectionMultiHostSources -MultihostId $MultihostId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaConnectionMultiHostSources"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## test-source-connection-multihost
This endpoint performs a more detailed validation of the source's configuration.
A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/beta/test-source-connection-multihost)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -625,21 +661,24 @@ $SourceId = "2c91808568c529f60168cca6f90c1324" # String | ID of the source withi
# Test Configuration For Multi-Host Integration's Single Source
try {
Test-BetaSourceConnectionMultihost -BetaMultihostId $MultihostId -BetaSourceId $SourceId
Test-BetaSourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId
# Below is a request that includes all optional parameters
# Test-BetaSourceConnectionMultihost -BetaMultihostId $MultihostId -BetaSourceId $SourceId
# Test-BetaSourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConnectionMultihost"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-multi-host-sources
Update existing sources within Multi-Host Integration.
A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/beta/update-multi-host-sources)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -674,10 +713,10 @@ $MultihostId = "anId" # String | ID of the Multi-Host Integration to update.
try {
$Result = ConvertFrom-JsonToUpdateMultiHostSourcesRequestInner -Json $UpdateMultiHostSourcesRequestInner
Update-BetaMultiHostSources -BetaMultihostId $MultihostId -BetaUpdateMultiHostSourcesRequestInner $Result
Update-BetaMultiHostSources -MultihostId $MultihostId -BetaUpdateMultiHostSourcesRequestInner $Result
# Below is a request that includes all optional parameters
# Update-BetaMultiHostSources -BetaMultihostId $MultihostId -BetaUpdateMultiHostSourcesRequestInner $UpdateMultiHostSourcesRequestInner
# Update-BetaMultiHostSources -MultihostId $MultihostId -BetaUpdateMultiHostSourcesRequestInner $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaMultiHostSources"
Write-Host $_.ErrorDetails

224
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNonEmployeeLifecycleManagementApi.md
View File

@@ -81,9 +81,12 @@ Method | HTTP request | Description
[**Deny-BetaNonEmployeeRequest**](#reject-non-employee-request) | **POST** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request
[**Update-BetaNonEmployeeRecord**](#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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/approve-non-employee-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -118,21 +121,24 @@ $NonEmployeeApprovalDecision = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision
Approve-BetaNonEmployeeRequest -BetaId $Id -BetaNonEmployeeApprovalDecision $Result
Approve-BetaNonEmployeeRequest -Id $Id -BetaNonEmployeeApprovalDecision $Result
# Below is a request that includes all optional parameters
# Approve-BetaNonEmployeeRequest -BetaId $Id -BetaNonEmployeeApprovalDecision $NonEmployeeApprovalDecision
# Approve-BetaNonEmployeeRequest -Id $Id -BetaNonEmployeeApprovalDecision $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaNonEmployeeRequest"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-non-employee-record
This request will create a non-employee record.
Request will require the following security scope:
'idn:nesr:create'
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-non-employee-record)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -176,19 +182,22 @@ $NonEmployeeRequestBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody
New-BetaNonEmployeeRecord -BetaNonEmployeeRequestBody $Result
New-BetaNonEmployeeRecord -BetaNonEmployeeRequestBody $Result
# Below is a request that includes all optional parameters
# New-BetaNonEmployeeRecord -BetaNonEmployeeRequestBody $NonEmployeeRequestBody
# New-BetaNonEmployeeRecord -BetaNonEmployeeRequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeRecord"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-non-employee-request
This request will create a non-employee request and notify the approver
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-non-employee-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -232,21 +241,24 @@ $NonEmployeeRequestBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody
New-BetaNonEmployeeRequest -BetaNonEmployeeRequestBody $Result
New-BetaNonEmployeeRequest -BetaNonEmployeeRequestBody $Result
# Below is a request that includes all optional parameters
# New-BetaNonEmployeeRequest -BetaNonEmployeeRequestBody $NonEmployeeRequestBody
# New-BetaNonEmployeeRequest -BetaNonEmployeeRequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeRequest"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-non-employee-source
This request will create a non-employee source.
Request will require the following security scope:
'idn:nesr:create'
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-non-employee-source)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -302,19 +314,22 @@ $NonEmployeeSourceRequestBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody
New-BetaNonEmployeeSource -BetaNonEmployeeSourceRequestBody $Result
New-BetaNonEmployeeSource -BetaNonEmployeeSourceRequestBody $Result
# Below is a request that includes all optional parameters
# New-BetaNonEmployeeSource -BetaNonEmployeeSourceRequestBody $NonEmployeeSourceRequestBody
# New-BetaNonEmployeeSource -BetaNonEmployeeSourceRequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeSource"
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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-non-employee-source-schema-attributes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -354,19 +369,22 @@ $NonEmployeeSchemaAttributeBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody
New-BetaNonEmployeeSourceSchemaAttributes -BetaSourceId $SourceId -BetaNonEmployeeSchemaAttributeBody $Result
New-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId -BetaNonEmployeeSchemaAttributeBody $Result
# Below is a request that includes all optional parameters
# New-BetaNonEmployeeSourceSchemaAttributes -BetaSourceId $SourceId -BetaNonEmployeeSchemaAttributeBody $NonEmployeeSchemaAttributeBody
# New-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId -BetaNonEmployeeSchemaAttributeBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeSourceSchemaAttributes"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-non-employee-record
This request will delete a non-employee record.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-record)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -396,21 +414,24 @@ $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee record id (UUID
# Delete Non-Employee Record
try {
Remove-BetaNonEmployeeRecord -BetaId $Id
Remove-BetaNonEmployeeRecord -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaNonEmployeeRecord -BetaId $Id
# Remove-BetaNonEmployeeRecord -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRecord"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-non-employee-record-in-bulk
This request will delete multiple non-employee records based on the non-employee ids provided.
Request will require the following scope:
'idn:nesr:delete'
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-record-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -441,19 +462,22 @@ $DeleteNonEmployeeRecordInBulkRequest = @""@
try {
$Result = ConvertFrom-JsonToDeleteNonEmployeeRecordInBulkRequest -Json $DeleteNonEmployeeRecordInBulkRequest
Remove-BetaNonEmployeeRecordInBulk -BetaDeleteNonEmployeeRecordInBulkRequest $Result
Remove-BetaNonEmployeeRecordInBulk -BetaDeleteNonEmployeeRecordInBulkRequest $Result
# Below is a request that includes all optional parameters
# Remove-BetaNonEmployeeRecordInBulk -BetaDeleteNonEmployeeRecordInBulkRequest $DeleteNonEmployeeRecordInBulkRequest
# Remove-BetaNonEmployeeRecordInBulk -BetaDeleteNonEmployeeRecordInBulkRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRecordInBulk"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-non-employee-request
This request will delete a non-employee request.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -484,20 +508,23 @@ $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee request id in t
# Delete Non-Employee Request
try {
Remove-BetaNonEmployeeRequest -BetaId $Id
Remove-BetaNonEmployeeRequest -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaNonEmployeeRequest -BetaId $Id
# Remove-BetaNonEmployeeRequest -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRequest"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-non-employee-schema-attribute
This end-point deletes a specific schema attribute for a non-employee source.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-schema-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -529,19 +556,22 @@ $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id
# Delete Non-Employee Source's Schema Attribute
try {
Remove-BetaNonEmployeeSchemaAttribute -BetaAttributeId $AttributeId -BetaSourceId $SourceId
Remove-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
# Below is a request that includes all optional parameters
# Remove-BetaNonEmployeeSchemaAttribute -BetaAttributeId $AttributeId -BetaSourceId $SourceId
# Remove-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSchemaAttribute"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-non-employee-source
This request will delete a non-employee source.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-source)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -571,19 +601,22 @@ $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | Source Id
# Delete Non-Employee Source
try {
Remove-BetaNonEmployeeSource -BetaSourceId $SourceId
Remove-BetaNonEmployeeSource -SourceId $SourceId
# Below is a request that includes all optional parameters
# Remove-BetaNonEmployeeSource -BetaSourceId $SourceId
# Remove-BetaNonEmployeeSource -SourceId $SourceId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSource"
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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-source-schema-attributes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -613,19 +646,22 @@ $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id
# Delete all custom schema attributes
try {
Remove-BetaNonEmployeeSourceSchemaAttributes -BetaSourceId $SourceId
Remove-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId
# Below is a request that includes all optional parameters
# Remove-BetaNonEmployeeSourceSchemaAttributes -BetaSourceId $SourceId
# Remove-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSourceSchemaAttributes"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## export-non-employee-records
This requests a CSV download for all non-employees from a provided source.
[API Spec](https://developer.sailpoint.com/docs/api/beta/export-non-employee-records)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -656,21 +692,24 @@ $Id = "2c918085842e69ae018432d22ccb212f" # String | Source Id (UUID)
# Exports Non-Employee Records to CSV
try {
Export-BetaNonEmployeeRecords -BetaId $Id
Export-BetaNonEmployeeRecords -Id $Id
# Below is a request that includes all optional parameters
# Export-BetaNonEmployeeRecords -BetaId $Id
# Export-BetaNonEmployeeRecords -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaNonEmployeeRecords"
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.
Request will require the following security scope:
idn:nesr:read'
[API Spec](https://developer.sailpoint.com/docs/api/beta/export-non-employee-source-schema-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -701,19 +740,22 @@ $Id = "2c918085842e69ae018432d22ccb212f" # String | Source Id (UUID)
# Exports Source Schema Template
try {
Export-BetaNonEmployeeSourceSchemaTemplate -BetaId $Id
Export-BetaNonEmployeeSourceSchemaTemplate -Id $Id
# Below is a request that includes all optional parameters
# Export-BetaNonEmployeeSourceSchemaTemplate -BetaId $Id
# Export-BetaNonEmployeeSourceSchemaTemplate -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaNonEmployeeSourceSchemaTemplate"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-non-employee-approval
Approves a non-employee approval request and notifies the next approver.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-approval)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -745,19 +787,22 @@ $IncludeDetail = "include-detail=false" # String | The object nonEmployeeRequest
# Get a non-employee approval item detail
try {
Get-BetaNonEmployeeApproval -BetaId $Id
Get-BetaNonEmployeeApproval -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaNonEmployeeApproval -BetaId $Id -BetaIncludeDetail $IncludeDetail
# Get-BetaNonEmployeeApproval -Id $Id -IncludeDetail $IncludeDetail
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApproval"
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 current user is the Org Admin, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id. 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/beta/get-non-employee-approval-summary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -787,20 +832,23 @@ $RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity (
# Get Summary of Non-Employee Approval Requests
try {
Get-BetaNonEmployeeApprovalSummary -BetaRequestedFor $RequestedFor
Get-BetaNonEmployeeApprovalSummary -RequestedFor $RequestedFor
# Below is a request that includes all optional parameters
# Get-BetaNonEmployeeApprovalSummary -BetaRequestedFor $RequestedFor
# Get-BetaNonEmployeeApprovalSummary -RequestedFor $RequestedFor
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApprovalSummary"
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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-bulk-upload-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -830,19 +878,22 @@ $Id = "2c918085842e69ae018432d22ccb212f" # String | Source ID (UUID)
# Bulk upload status on source
try {
Get-BetaNonEmployeeBulkUploadStatus -BetaId $Id
Get-BetaNonEmployeeBulkUploadStatus -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaNonEmployeeBulkUploadStatus -BetaId $Id
# Get-BetaNonEmployeeBulkUploadStatus -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeBulkUploadStatus"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-non-employee-record
This gets a non-employee record.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-record)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -872,19 +923,22 @@ $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee record id (UUID
# Get a Non-Employee Record
try {
Get-BetaNonEmployeeRecord -BetaId $Id
Get-BetaNonEmployeeRecord -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaNonEmployeeRecord -BetaId $Id
# Get-BetaNonEmployeeRecord -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRecord"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-non-employee-request
This gets a non-employee request.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -915,19 +969,22 @@ $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee request id (UUI
# Get a Non-Employee Request
try {
Get-BetaNonEmployeeRequest -BetaId $Id
Get-BetaNonEmployeeRequest -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaNonEmployeeRequest -BetaId $Id
# Get-BetaNonEmployeeRequest -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequest"
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 current user is the Org Admin, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id. 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/beta/get-non-employee-request-summary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -957,19 +1014,22 @@ $RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity (
# Get Summary of Non-Employee Requests
try {
Get-BetaNonEmployeeRequestSummary -BetaRequestedFor $RequestedFor
Get-BetaNonEmployeeRequestSummary -RequestedFor $RequestedFor
# Below is a request that includes all optional parameters
# Get-BetaNonEmployeeRequestSummary -BetaRequestedFor $RequestedFor
# Get-BetaNonEmployeeRequestSummary -RequestedFor $RequestedFor
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequestSummary"
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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-schema-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1001,19 +1061,22 @@ $SourceId = "2c918085842e69ae018432d22ccb212f" # String | The Source id
# Get Schema Attribute Non-Employee Source
try {
Get-BetaNonEmployeeSchemaAttribute -BetaAttributeId $AttributeId -BetaSourceId $SourceId
Get-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-BetaNonEmployeeSchemaAttribute -BetaAttributeId $AttributeId -BetaSourceId $SourceId
# Get-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSchemaAttribute"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-non-employee-source
This gets a non-employee source.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-source)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1043,19 +1106,22 @@ $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id
# Get a Non-Employee Source
try {
Get-BetaNonEmployeeSource -BetaSourceId $SourceId
Get-BetaNonEmployeeSource -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-BetaNonEmployeeSource -BetaSourceId $SourceId
# Get-BetaNonEmployeeSource -SourceId $SourceId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSource"
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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-source-schema-attributes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1086,21 +1152,24 @@ $SourceId = "2c918085842e69ae018432d22ccb212f" # String | The Source id
# List Schema Attributes Non-Employee Source
try {
Get-BetaNonEmployeeSourceSchemaAttributes -BetaSourceId $SourceId
Get-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-BetaNonEmployeeSourceSchemaAttributes -BetaSourceId $SourceId
# Get-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSourceSchemaAttributes"
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.
Request will need the following security scope:
'idn:nesr:create'
[API Spec](https://developer.sailpoint.com/docs/api/beta/import-non-employee-records-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1133,19 +1202,22 @@ $Data = # System.IO.FileInfo |
# Imports, or Updates, Non-Employee Records
try {
Import-BetaNonEmployeeRecordsInBulk -BetaId $Id -BetaData $Data
Import-BetaNonEmployeeRecordsInBulk -Id $Id -Data $Data
# Below is a request that includes all optional parameters
# Import-BetaNonEmployeeRecordsInBulk -BetaId $Id -BetaData $Data
# Import-BetaNonEmployeeRecordsInBulk -Id $Id -Data $Data
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaNonEmployeeRecordsInBulk"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-non-employee-approval
This gets a list of non-employee approval requests.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-non-employee-approval)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1185,19 +1257,22 @@ $Sorters = "created" # String | Sort results using the standard syntax described
# Get List of Non-Employee Approval Requests
try {
Get-BetaNonEmployeeApproval
Get-BetaNonEmployeeApproval
# Below is a request that includes all optional parameters
# Get-BetaNonEmployeeApproval -BetaRequestedFor $RequestedFor -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters
# Get-BetaNonEmployeeApproval -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApproval"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-non-employee-records
This gets a list of non-employee records.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-non-employee-records)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1235,19 +1310,22 @@ $Filters = 'sourceId eq "2c91808568c529c60168cca6f90c1313"' # String | Filter re
# List Non-Employee Records
try {
Get-BetaNonEmployeeRecords
Get-BetaNonEmployeeRecords
# Below is a request that includes all optional parameters
# Get-BetaNonEmployeeRecords -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters
# Get-BetaNonEmployeeRecords -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRecords"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-non-employee-requests
This gets a list of non-employee requests.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-non-employee-requests)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1287,19 +1365,22 @@ $Filters = 'sourceId eq "2c91808568c529c60168cca6f90c1313"' # String | Filter re
# List Non-Employee Requests
try {
Get-BetaNonEmployeeRequests -BetaRequestedFor $RequestedFor
Get-BetaNonEmployeeRequests -RequestedFor $RequestedFor
# Below is a request that includes all optional parameters
# Get-BetaNonEmployeeRequests -BetaRequestedFor $RequestedFor -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters
# Get-BetaNonEmployeeRequests -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequests"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-non-employee-sources
This gets a list of non-employee sources.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-non-employee-sources)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1339,19 +1420,22 @@ $Sorters = "name,created" # String | Sort results using the standard syntax desc
# List Non-Employee Sources
try {
Get-BetaNonEmployeeSources -BetaRequestedFor $RequestedFor -BetaNonEmployeeCount $NonEmployeeCount
Get-BetaNonEmployeeSources -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount
# Below is a request that includes all optional parameters
# Get-BetaNonEmployeeSources -BetaRequestedFor $RequestedFor -BetaNonEmployeeCount $NonEmployeeCount -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters
# Get-BetaNonEmployeeSources -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSources"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-non-employee-record
This request will patch a non-employee record.
[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-non-employee-record)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1390,20 +1474,23 @@ $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-employee record id (UUID
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-BetaNonEmployeeRecord -BetaId $Id -BetaJsonPatchOperation $Result
Update-BetaNonEmployeeRecord -Id $Id -BetaJsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-BetaNonEmployeeRecord -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation
# Update-BetaNonEmployeeRecord -Id $Id -BetaJsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeRecord"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-non-employee-schema-attribute
This end-point patches a specific schema attribute for a non-employee SourceId.
[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-non-employee-schema-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1444,19 +1531,22 @@ $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-BetaNonEmployeeSchemaAttribute -BetaAttributeId $AttributeId -BetaSourceId $SourceId -BetaJsonPatchOperation $Result
Update-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -BetaJsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-BetaNonEmployeeSchemaAttribute -BetaAttributeId $AttributeId -BetaSourceId $SourceId -BetaJsonPatchOperation $JsonPatchOperation
# Update-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -BetaJsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeSchemaAttribute"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-non-employee-source
patch a non-employee source. (Partial Update) Patchable field: **name, description, approvers, accountManagers**
[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-non-employee-source)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1494,19 +1584,22 @@ $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | Source Id
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-BetaNonEmployeeSource -BetaSourceId $SourceId -BetaJsonPatchOperation $Result
Update-BetaNonEmployeeSource -SourceId $SourceId -BetaJsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-BetaNonEmployeeSource -BetaSourceId $SourceId -BetaJsonPatchOperation $JsonPatchOperation
# Update-BetaNonEmployeeSource -SourceId $SourceId -BetaJsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeSource"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## reject-non-employee-request
This endpoint will reject an approval item request and notify user.
[API Spec](https://developer.sailpoint.com/docs/api/beta/reject-non-employee-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1541,19 +1634,22 @@ $NonEmployeeRejectApprovalDecision = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision
Deny-BetaNonEmployeeRequest -BetaId $Id -BetaNonEmployeeRejectApprovalDecision $Result
Deny-BetaNonEmployeeRequest -Id $Id -BetaNonEmployeeRejectApprovalDecision $Result
# Below is a request that includes all optional parameters
# Deny-BetaNonEmployeeRequest -BetaId $Id -BetaNonEmployeeRejectApprovalDecision $NonEmployeeRejectApprovalDecision
# Deny-BetaNonEmployeeRequest -Id $Id -BetaNonEmployeeRejectApprovalDecision $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaNonEmployeeRequest"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-non-employee-record
This request will update a non-employee record.
[API Spec](https://developer.sailpoint.com/docs/api/beta/update-non-employee-record)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1600,10 +1696,10 @@ $NonEmployeeRequestBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody
Update-BetaNonEmployeeRecord -BetaId $Id -BetaNonEmployeeRequestBody $Result
Update-BetaNonEmployeeRecord -Id $Id -BetaNonEmployeeRequestBody $Result
# Below is a request that includes all optional parameters
# Update-BetaNonEmployeeRecord -BetaId $Id -BetaNonEmployeeRequestBody $NonEmployeeRequestBody
# Update-BetaNonEmployeeRecord -Id $Id -BetaNonEmployeeRequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeRecord"
Write-Host $_.ErrorDetails

101
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNotificationsApi.md
View File

@@ -33,9 +33,12 @@ Method | HTTP request | Description
[**Send-BetaMailFromAttributes**](#put-mail-from-attributes) | **PUT** `/mail-from-attributes` | Change MAIL FROM domain
[**Send-BetaTestNotification**](#send-test-notification) | **POST** `/send-test-notification` | Send Test Notification
## create-domain-dkim
Create a domain to be verified via DKIM (DomainKeys Identified Mail)
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-domain-dkim)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -69,21 +72,24 @@ $DomainAddress = @"{
try {
$Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress
New-BetaDomainDkim -BetaDomainAddress $Result
New-BetaDomainDkim -BetaDomainAddress $Result
# Below is a request that includes all optional parameters
# New-BetaDomainDkim -BetaDomainAddress $DomainAddress
# New-BetaDomainDkim -BetaDomainAddress $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaDomainDkim"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-notification-template
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/beta/create-notification-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -131,19 +137,22 @@ $TemplateDto = @"{
try {
$Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto
New-BetaNotificationTemplate -BetaTemplateDto $Result
New-BetaNotificationTemplate -BetaTemplateDto $Result
# Below is a request that includes all optional parameters
# New-BetaNotificationTemplate -BetaTemplateDto $TemplateDto
# New-BetaNotificationTemplate -BetaTemplateDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNotificationTemplate"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-verified-from-address
Create a new sender email address and initiate verification process.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-verified-from-address)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -179,19 +188,22 @@ $EmailStatusDto = @"{
try {
$Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto
New-BetaVerifiedFromAddress -BetaEmailStatusDto $Result
New-BetaVerifiedFromAddress -BetaEmailStatusDto $Result
# Below is a request that includes all optional parameters
# New-BetaVerifiedFromAddress -BetaEmailStatusDto $EmailStatusDto
# New-BetaVerifiedFromAddress -BetaEmailStatusDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaVerifiedFromAddress"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-notification-templates-in-bulk
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/beta/delete-notification-templates-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -227,19 +239,22 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto
Remove-BetaNotificationTemplatesInBulk -BetaTemplateBulkDeleteDto $Result
Remove-BetaNotificationTemplatesInBulk -BetaTemplateBulkDeleteDto $Result
# Below is a request that includes all optional parameters
# Remove-BetaNotificationTemplatesInBulk -BetaTemplateBulkDeleteDto $TemplateBulkDeleteDto
# Remove-BetaNotificationTemplatesInBulk -BetaTemplateBulkDeleteDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNotificationTemplatesInBulk"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-verified-from-address
Delete a verified sender email address
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-verified-from-address)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -270,19 +285,22 @@ $Id = "MyId" # String |
# Delete Verified From Address
try {
Remove-BetaVerifiedFromAddress -BetaId $Id
Remove-BetaVerifiedFromAddress -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaVerifiedFromAddress -BetaId $Id
# Remove-BetaVerifiedFromAddress -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaVerifiedFromAddress"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-dkim-attributes
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/beta/get-dkim-attributes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -310,7 +328,7 @@ Code | Description | Data Type
# Get DKIM Attributes
try {
Get-BetaDkimAttributes
Get-BetaDkimAttributes
# Below is a request that includes all optional parameters
# Get-BetaDkimAttributes
@@ -320,9 +338,12 @@ try {
}
```
[[Back to top]](#)
## get-mail-from-attributes
Retrieve MAIL FROM attributes for a given AWS SES identity.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-mail-from-attributes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -352,19 +373,22 @@ $IdentityId = "bobsmith@sailpoint.com" # String | Returns the MX and TXT record
# Get MAIL FROM Attributes
try {
Get-BetaMailFromAttributes -BetaIdentityId $IdentityId
Get-BetaMailFromAttributes -IdentityId $IdentityId
# Below is a request that includes all optional parameters
# Get-BetaMailFromAttributes -BetaIdentityId $IdentityId
# Get-BetaMailFromAttributes -IdentityId $IdentityId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMailFromAttributes"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-notification-template
This gets a template that you have modified for your site by Id.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-notification-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -394,20 +418,23 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification T
# Get Notification Template By Id
try {
Get-BetaNotificationTemplate -BetaId $Id
Get-BetaNotificationTemplate -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaNotificationTemplate -BetaId $Id
# Get-BetaNotificationTemplate -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplate"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-notifications-template-context
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/beta/get-notifications-template-context)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -435,7 +462,7 @@ Code | Description | Data Type
# Get Notification Template Context
try {
Get-BetaNotificationsTemplateContext
Get-BetaNotificationsTemplateContext
# Below is a request that includes all optional parameters
# Get-BetaNotificationsTemplateContext
@@ -445,9 +472,12 @@ try {
}
```
[[Back to top]](#)
## list-from-addresses
Retrieve a list of sender email addresses and their verification statuses
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-from-addresses)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -484,19 +514,22 @@ $Sorters = "email" # String | Sort results using the standard syntax described i
# List From Addresses
try {
Get-BetaFromAddresses
Get-BetaFromAddresses
# Below is a request that includes all optional parameters
# Get-BetaFromAddresses -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters
# Get-BetaFromAddresses -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFromAddresses"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-notification-preferences
Returns a list of notification preferences for tenant.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-notification-preferences)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -527,19 +560,22 @@ $Key = "cloud_manual_work_item_summary" # String | The notification key.
# List Notification Preferences for tenant.
try {
Get-BetaNotificationPreferences -BetaKey $Key
Get-BetaNotificationPreferences -Key $Key
# Below is a request that includes all optional parameters
# Get-BetaNotificationPreferences -BetaKey $Key
# Get-BetaNotificationPreferences -Key $Key
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationPreferences"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-notification-template-defaults
This lists the default templates used for notifications, such as emails from IdentityNow.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-notification-template-defaults)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -573,19 +609,22 @@ $Filters = 'key eq "cloud_manual_work_item_summary"' # String | Filter results u
# List Notification Template Defaults
try {
Get-BetaNotificationTemplateDefaults
Get-BetaNotificationTemplateDefaults
# Below is a request that includes all optional parameters
# Get-BetaNotificationTemplateDefaults -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters
# Get-BetaNotificationTemplateDefaults -Limit $Limit -Offset $Offset -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplateDefaults"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-notification-templates
This lists the templates that you have modified for your site.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-notification-templates)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -619,19 +658,22 @@ $Filters = 'medium eq "EMAIL"' # String | Filter results using the standard synt
# List Notification Templates
try {
Get-BetaNotificationTemplates
Get-BetaNotificationTemplates
# Below is a request that includes all optional parameters
# Get-BetaNotificationTemplates -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters
# Get-BetaNotificationTemplates -Limit $Limit -Offset $Offset -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplates"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-mail-from-attributes
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/beta/put-mail-from-attributes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -665,19 +707,22 @@ $MailFromAttributesDto = @"{
try {
$Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto
Send-BetaMailFromAttributes -BetaMailFromAttributesDto $Result
Send-BetaMailFromAttributes -BetaMailFromAttributesDto $Result
# Below is a request that includes all optional parameters
# Send-BetaMailFromAttributes -BetaMailFromAttributesDto $MailFromAttributesDto
# Send-BetaMailFromAttributes -BetaMailFromAttributesDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaMailFromAttributes"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## send-test-notification
Send a Test Notification
[API Spec](https://developer.sailpoint.com/docs/api/beta/send-test-notification)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -713,10 +758,10 @@ $SendTestNotificationRequestDto = @"{
try {
$Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto
Send-BetaTestNotification -BetaSendTestNotificationRequestDto $Result
Send-BetaTestNotification -BetaSendTestNotificationRequestDto $Result
# Below is a request that includes all optional parameters
# Send-BetaTestNotification -BetaSendTestNotificationRequestDto $SendTestNotificationRequestDto
# Send-BetaTestNotification -BetaSendTestNotificationRequestDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTestNotification"
Write-Host $_.ErrorDetails

35
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaOAuthClientsApi.md
View File

@@ -26,9 +26,12 @@ Method | HTTP request | Description
[**Get-BetaOauthClients**](#list-oauth-clients) | **GET** `/oauth-clients` | List OAuth Clients
[**Update-BetaOauthClient**](#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/beta/create-oauth-client)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -75,19 +78,22 @@ $CreateOAuthClientRequest = @"{
try {
$Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest
New-BetaOauthClient -BetaCreateOAuthClientRequest $Result
New-BetaOauthClient -BetaCreateOAuthClientRequest $Result
# Below is a request that includes all optional parameters
# New-BetaOauthClient -BetaCreateOAuthClientRequest $CreateOAuthClientRequest
# New-BetaOauthClient -BetaCreateOAuthClientRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaOauthClient"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-oauth-client
This deletes an OAuth client.
[API Spec](https://developer.sailpoint.com/docs/api/beta/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-BetaOauthClient -BetaId $Id
Remove-BetaOauthClient -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaOauthClient -BetaId $Id
# Remove-BetaOauthClient -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaOauthClient"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-oauth-client
This gets details of an OAuth client.
[API Spec](https://developer.sailpoint.com/docs/api/beta/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-BetaOauthClient -BetaId $Id
Get-BetaOauthClient -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaOauthClient -BetaId $Id
# Get-BetaOauthClient -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOauthClient"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-oauth-clients
This gets a list of OAuth clients.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-oauth-clients)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -203,21 +215,24 @@ $Filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # String | Filter results usin
# List OAuth Clients
try {
Get-BetaOauthClients
Get-BetaOauthClients
# Below is a request that includes all optional parameters
# Get-BetaOauthClients -BetaFilters $Filters
# Get-BetaOauthClients -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOauthClients"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-oauth-client
This performs a targeted update to the field(s) of an OAuth client.
Request will require a security scope of
- sp:oauth-client:manage
[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-oauth-client)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -256,10 +271,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-BetaOauthClient -BetaId $Id -BetaJsonPatchOperation $Result
Update-BetaOauthClient -Id $Id -BetaJsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-BetaOauthClient -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation
# Update-BetaOauthClient -Id $Id -BetaJsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaOauthClient"
Write-Host $_.ErrorDetails

17
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaOrgConfigApi.md
View File

@@ -23,9 +23,12 @@ Method | HTTP request | Description
[**Get-BetaValidTimeZones**](#get-valid-time-zones) | **GET** `/org-config/valid-time-zones` | Get list of time zones
[**Update-BetaOrgConfig**](#patch-org-config) | **PATCH** `/org-config` | Patch an Org configuration property
## get-org-config
Get org configuration with only external (org admin) accessible properties for the current org.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-org-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -54,7 +57,7 @@ Code | Description | Data Type
# Get Org configuration settings
try {
Get-BetaOrgConfig
Get-BetaOrgConfig
# Below is a request that includes all optional parameters
# Get-BetaOrgConfig
@@ -64,9 +67,12 @@ try {
}
```
[[Back to top]](#)
## get-valid-time-zones
Get a list of valid time zones that can be set in org configurations.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-valid-time-zones)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -94,7 +100,7 @@ Code | Description | Data Type
# Get list of time zones
try {
Get-BetaValidTimeZones
Get-BetaValidTimeZones
# Below is a request that includes all optional parameters
# Get-BetaValidTimeZones
@@ -104,9 +110,12 @@ try {
}
```
[[Back to top]](#)
## patch-org-config
Patch configuration of the current org using http://jsonpatch.com/ syntax. Commonly used for changing the time zone of an org.
[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-org-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -143,10 +152,10 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-BetaOrgConfig -BetaJsonPatchOperation $Result
Update-BetaOrgConfig -BetaJsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-BetaOrgConfig -BetaJsonPatchOperation $JsonPatchOperation
# Update-BetaOrgConfig -BetaJsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaOrgConfig"
Write-Host $_.ErrorDetails

19
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordConfigurationApi.md
View File

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

12
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordDictionaryApi.md
View File

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

28
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordManagementApi.md
View File

@@ -46,9 +46,12 @@ Method | HTTP request | Description
[**Search-BetaPasswordInfo**](#query-password-info) | **POST** `/query-password-info` | Query Password Info
[**Set-BetaIdentityPassword**](#set-identity-password) | **POST** `/set-password` | Set Identity's Password
## create-digit-token
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/beta/create-digit-token)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -83,19 +86,22 @@ $PasswordDigitTokenReset = @"{
try {
$Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset
New-BetaDigitToken -BetaPasswordDigitTokenReset $Result
New-BetaDigitToken -BetaPasswordDigitTokenReset $Result
# Below is a request that includes all optional parameters
# New-BetaDigitToken -BetaPasswordDigitTokenReset $PasswordDigitTokenReset
# New-BetaDigitToken -BetaPasswordDigitTokenReset $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaDigitToken"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-password-change-status
This API returns the status of a password change request. A token with identity owner or trusted API client application authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-password-change-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -125,16 +131,17 @@ $Id = "MyId" # String |
# Get Password Change Request Status
try {
Get-BetaIdentityPasswordChangeStatus -BetaId $Id
Get-BetaIdentityPasswordChangeStatus -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaIdentityPasswordChangeStatus -BetaId $Id
# Get-BetaIdentityPasswordChangeStatus -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityPasswordChangeStatus"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## query-password-info
This API is used to query password related information.
@@ -146,6 +153,8 @@ grant type will **NOT** work on this endpoint, and a `403 Forbidden` response
will be returned.
[API Spec](https://developer.sailpoint.com/docs/api/beta/query-password-info)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -179,16 +188,17 @@ $PasswordInfoQueryDTO = @"{
try {
$Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO
Search-BetaPasswordInfo -BetaPasswordInfoQueryDTO $Result
Search-BetaPasswordInfo -BetaPasswordInfoQueryDTO $Result
# Below is a request that includes all optional parameters
# Search-BetaPasswordInfo -BetaPasswordInfoQueryDTO $PasswordInfoQueryDTO
# Search-BetaPasswordInfo -BetaPasswordInfoQueryDTO $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaPasswordInfo"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-identity-password
This API is used to set a password for an identity.
@@ -235,6 +245,8 @@ In this example, `toEncrypt` refers to the plain text password you are setting a
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/beta/set-identity-password)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -271,10 +283,10 @@ $PasswordChangeRequest = @"{
try {
$Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest
Set-BetaIdentityPassword -BetaPasswordChangeRequest $Result
Set-BetaIdentityPassword -BetaPasswordChangeRequest $Result
# Below is a request that includes all optional parameters
# Set-BetaIdentityPassword -BetaPasswordChangeRequest $PasswordChangeRequest
# Set-BetaIdentityPassword -BetaPasswordChangeRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaIdentityPassword"
Write-Host $_.ErrorDetails

35
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordPoliciesApi.md
View File

@@ -32,9 +32,12 @@ Method | HTTP request | Description
[**Get-BetaPasswordPolicies**](#list-password-policies) | **GET** `/password-policies` | List Password Policies
[**Set-BetaPasswordPolicy**](#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/beta/create-password-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -98,19 +101,22 @@ $PasswordPolicyV3Dto = @"{
try {
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
New-BetaPasswordPolicy -BetaPasswordPolicyV3Dto $Result
New-BetaPasswordPolicy -BetaPasswordPolicyV3Dto $Result
# Below is a request that includes all optional parameters
# New-BetaPasswordPolicy -BetaPasswordPolicyV3Dto $PasswordPolicyV3Dto
# New-BetaPasswordPolicy -BetaPasswordPolicyV3Dto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordPolicy"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-password-policy
This API deletes the specified password policy.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-password-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -141,19 +147,22 @@ $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to
# Delete Password Policy by ID
try {
Remove-BetaPasswordPolicy -BetaId $Id
Remove-BetaPasswordPolicy -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaPasswordPolicy -BetaId $Id
# Remove-BetaPasswordPolicy -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPasswordPolicy"
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/beta/get-password-policy-by-id)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -184,20 +193,23 @@ $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to
# Get Password Policy by ID
try {
Get-BetaPasswordPolicyById -BetaId $Id
Get-BetaPasswordPolicyById -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaPasswordPolicyById -BetaId $Id
# Get-BetaPasswordPolicyById -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordPolicyById"
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/beta/list-password-policies)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -231,19 +243,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# List Password Policies
try {
Get-BetaPasswordPolicies
Get-BetaPasswordPolicies
# Below is a request that includes all optional parameters
# Get-BetaPasswordPolicies -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count
# Get-BetaPasswordPolicies -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordPolicies"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-password-policy
This API updates the specified password policy.
[API Spec](https://developer.sailpoint.com/docs/api/beta/set-password-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -309,10 +324,10 @@ $PasswordPolicyV3Dto = @"{
try {
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
Set-BetaPasswordPolicy -BetaId $Id -BetaPasswordPolicyV3Dto $Result
Set-BetaPasswordPolicy -Id $Id -BetaPasswordPolicyV3Dto $Result
# Below is a request that includes all optional parameters
# Set-BetaPasswordPolicy -BetaId $Id -BetaPasswordPolicyV3Dto $PasswordPolicyV3Dto
# Set-BetaPasswordPolicy -Id $Id -BetaPasswordPolicyV3Dto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaPasswordPolicy"
Write-Host $_.ErrorDetails

35
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordSyncGroupsApi.md
View File

@@ -55,9 +55,12 @@ Method | HTTP request | Description
[**Get-BetaPasswordSyncGroups**](#get-password-sync-groups) | **GET** `/password-sync-groups` | Get Password Sync Group List
[**Update-BetaPasswordSyncGroup**](#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/beta/create-password-sync-group)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -95,19 +98,22 @@ $PasswordSyncGroup = @"{
try {
$Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup
New-BetaPasswordSyncGroup -BetaPasswordSyncGroup $Result
New-BetaPasswordSyncGroup -BetaPasswordSyncGroup $Result
# Below is a request that includes all optional parameters
# New-BetaPasswordSyncGroup -BetaPasswordSyncGroup $PasswordSyncGroup
# New-BetaPasswordSyncGroup -BetaPasswordSyncGroup $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordSyncGroup"
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/beta/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-BetaPasswordSyncGroup -BetaId $Id
Remove-BetaPasswordSyncGroup -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaPasswordSyncGroup -BetaId $Id
# Remove-BetaPasswordSyncGroup -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPasswordSyncGroup"
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/beta/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-BetaPasswordSyncGroup -BetaId $Id
Get-BetaPasswordSyncGroup -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaPasswordSyncGroup -BetaId $Id
# Get-BetaPasswordSyncGroup -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordSyncGroup"
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/beta/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-BetaPasswordSyncGroups
Get-BetaPasswordSyncGroups
# Below is a request that includes all optional parameters
# Get-BetaPasswordSyncGroups -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count
# Get-BetaPasswordSyncGroups -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordSyncGroups"
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/beta/update-password-sync-group)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -279,10 +294,10 @@ $PasswordSyncGroup = @"{
try {
$Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup
Update-BetaPasswordSyncGroup -BetaId $Id -BetaPasswordSyncGroup $Result
Update-BetaPasswordSyncGroup -Id $Id -BetaPasswordSyncGroup $Result
# Below is a request that includes all optional parameters
# Update-BetaPasswordSyncGroup -BetaId $Id -BetaPasswordSyncGroup $PasswordSyncGroup
# Update-BetaPasswordSyncGroup -Id $Id -BetaPasswordSyncGroup $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPasswordSyncGroup"
Write-Host $_.ErrorDetails

28
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPersonalAccessTokensApi.md
View File

@@ -33,9 +33,12 @@ Method | HTTP request | Description
[**Get-BetaPersonalAccessTokens**](#list-personal-access-tokens) | **GET** `/personal-access-tokens` | List Personal Access Tokens
[**Update-BetaPersonalAccessToken**](#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/beta/create-personal-access-token)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -70,19 +73,22 @@ $CreatePersonalAccessTokenRequest = @"{
try {
$Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest
New-BetaPersonalAccessToken -BetaCreatePersonalAccessTokenRequest $Result
New-BetaPersonalAccessToken -BetaCreatePersonalAccessTokenRequest $Result
# Below is a request that includes all optional parameters
# New-BetaPersonalAccessToken -BetaCreatePersonalAccessTokenRequest $CreatePersonalAccessTokenRequest
# New-BetaPersonalAccessToken -BetaCreatePersonalAccessTokenRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPersonalAccessToken"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-personal-access-token
This deletes a personal access token.
[API Spec](https://developer.sailpoint.com/docs/api/beta/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-BetaPersonalAccessToken -BetaId $Id
Remove-BetaPersonalAccessToken -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaPersonalAccessToken -BetaId $Id
# Remove-BetaPersonalAccessToken -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPersonalAccessToken"
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/beta/list-personal-access-tokens)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -157,19 +166,22 @@ $Filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # String | Filter results usin
# List Personal Access Tokens
try {
Get-BetaPersonalAccessTokens
Get-BetaPersonalAccessTokens
# Below is a request that includes all optional parameters
# Get-BetaPersonalAccessTokens -BetaOwnerId $OwnerId -BetaFilters $Filters
# Get-BetaPersonalAccessTokens -OwnerId $OwnerId -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPersonalAccessTokens"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-personal-access-token
This performs a targeted update to the field(s) of a Personal Access Token.
[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-personal-access-token)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -208,10 +220,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-BetaPersonalAccessToken -BetaId $Id -BetaJsonPatchOperation $Result
Update-BetaPersonalAccessToken -Id $Id -BetaJsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-BetaPersonalAccessToken -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation
# Update-BetaPersonalAccessToken -Id $Id -BetaJsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPersonalAccessToken"
Write-Host $_.ErrorDetails

12
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPublicIdentitiesConfigApi.md
View File

@@ -30,9 +30,12 @@ Method | HTTP request | Description
[**Get-BetaPublicIdentityConfig**](#get-public-identity-config) | **GET** `/public-identities-config` | Get Public Identity Config
[**Update-BetaPublicIdentityConfig**](#update-public-identity-config) | **PUT** `/public-identities-config` | Update Public Identity Config
## get-public-identity-config
This gets details of public identity config.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-public-identity-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -60,7 +63,7 @@ Code | Description | Data Type
# Get Public Identity Config
try {
Get-BetaPublicIdentityConfig
Get-BetaPublicIdentityConfig
# Below is a request that includes all optional parameters
# Get-BetaPublicIdentityConfig
@@ -70,9 +73,12 @@ try {
}
```
[[Back to top]](#)
## update-public-identity-config
This updates the details of public identity config.
[API Spec](https://developer.sailpoint.com/docs/api/beta/update-public-identity-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -117,10 +123,10 @@ $PublicIdentityConfig = @"{
try {
$Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig
Update-BetaPublicIdentityConfig -BetaPublicIdentityConfig $Result
Update-BetaPublicIdentityConfig -BetaPublicIdentityConfig $Result
# Below is a request that includes all optional parameters
# Update-BetaPublicIdentityConfig -BetaPublicIdentityConfig $PublicIdentityConfig
# Update-BetaPublicIdentityConfig -BetaPublicIdentityConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPublicIdentityConfig"
Write-Host $_.ErrorDetails

7
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRequestableObjectsApi.md
View File

@@ -22,10 +22,13 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaRequestableObjects**](#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/beta/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-BetaRequestableObjects
Get-BetaRequestableObjects
# Below is a request that includes all optional parameters
# Get-BetaRequestableObjects -BetaIdentityId $IdentityId -BetaTypes $Types -BetaTerm $Term -BetaStatuses $Statuses -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters
# Get-BetaRequestableObjects -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-BetaRequestableObjects"
Write-Host $_.ErrorDetails

65
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRoleInsightsApi.md
View File

@@ -27,9 +27,15 @@ Method | HTTP request | Description
[**Get-BetaRoleInsightsRequests**](#get-role-insights-requests) | **GET** `/role-insights/requests/{id}` | Returns metadata from prior request.
[**Get-BetaRoleInsightsSummary**](#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.
:::
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/beta/create-role-insight-requests)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -57,7 +63,7 @@ Code | Description | Data Type
# Generate insights for roles
try {
New-BetaRoleInsightRequests
New-BetaRoleInsightRequests
# Below is a request that includes all optional parameters
# New-BetaRoleInsightRequests
@@ -67,9 +73,12 @@ try {
}
```
[[Back to top]](#)
## download-role-insights-entitlements-changes
This endpoint returns the entitlement insights for a role.
[API Spec](https://developer.sailpoint.com/docs/api/beta/download-role-insights-entitlements-changes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -102,19 +111,22 @@ $Filters = 'name sw "r"' # String | Filter results using the standard syntax des
# Download entitlement insights for a role
try {
Invoke-BetaDownloadRoleInsightsEntitlementsChanges -BetaInsightId $InsightId
Invoke-BetaDownloadRoleInsightsEntitlementsChanges -InsightId $InsightId
# Below is a request that includes all optional parameters
# Invoke-BetaDownloadRoleInsightsEntitlementsChanges -BetaInsightId $InsightId -BetaSorters $Sorters -BetaFilters $Filters
# Invoke-BetaDownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaDownloadRoleInsightsEntitlementsChanges"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-entitlement-changes-identities
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/beta/get-entitlement-changes-identities)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -157,19 +169,22 @@ $Filters = 'name sw "Jan"' # String | Filter results using the standard syntax d
# Get identities for a suggested entitlement (for a role)
try {
Get-BetaEntitlementChangesIdentities -BetaInsightId $InsightId -BetaEntitlementId $EntitlementId
Get-BetaEntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId
# Below is a request that includes all optional parameters
# Get-BetaEntitlementChangesIdentities -BetaInsightId $InsightId -BetaEntitlementId $EntitlementId -BetaHasEntitlement $HasEntitlement -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters
# Get-BetaEntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -HasEntitlement $HasEntitlement -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementChangesIdentities"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insight
This endpoint gets role insights information for a role.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-insight)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -198,19 +213,22 @@ $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight
# Get a single role insight
try {
Get-BetaRoleInsight -BetaInsightId $InsightId
Get-BetaRoleInsight -InsightId $InsightId
# Below is a request that includes all optional parameters
# Get-BetaRoleInsight -BetaInsightId $InsightId
# Get-BetaRoleInsight -InsightId $InsightId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsight"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insights
This method returns detailed role insights for each role.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-insights)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -247,19 +265,22 @@ $Filters = 'name sw "John"' # String | Filter results using the standard syntax
# Get role insights
try {
Get-BetaRoleInsights
Get-BetaRoleInsights
# Below is a request that includes all optional parameters
# Get-BetaRoleInsights -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters
# Get-BetaRoleInsights -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsights"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insights-current-entitlements
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/beta/get-role-insights-current-entitlements)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -290,19 +311,22 @@ $Filters = 'name sw "r"' # String | Filter results using the standard syntax des
# Get current entitlement for a role
try {
Get-BetaRoleInsightsCurrentEntitlements -BetaInsightId $InsightId
Get-BetaRoleInsightsCurrentEntitlements -InsightId $InsightId
# Below is a request that includes all optional parameters
# Get-BetaRoleInsightsCurrentEntitlements -BetaInsightId $InsightId -BetaFilters $Filters
# Get-BetaRoleInsightsCurrentEntitlements -InsightId $InsightId -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsCurrentEntitlements"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insights-entitlements-changes
This endpoint returns entitlement insights for a role.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-insights-entitlements-changes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -335,19 +359,25 @@ $Filters = 'name sw "Admin"' # String | Filter results using the standard syntax
# Get entitlement insights for a role
try {
Get-BetaRoleInsightsEntitlementsChanges -BetaInsightId $InsightId
Get-BetaRoleInsightsEntitlementsChanges -InsightId $InsightId
# Below is a request that includes all optional parameters
# Get-BetaRoleInsightsEntitlementsChanges -BetaInsightId $InsightId -BetaSorters $Sorters -BetaFilters $Filters
# Get-BetaRoleInsightsEntitlementsChanges -InsightId $InsightId -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsEntitlementsChanges"
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.
:::
This endpoint returns details of a prior role insights request.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-insights-requests)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -377,19 +407,22 @@ $Id = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insights reques
# Returns metadata from prior request.
try {
Get-BetaRoleInsightsRequests -BetaId $Id
Get-BetaRoleInsightsRequests -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaRoleInsightsRequests -BetaId $Id
# Get-BetaRoleInsightsRequests -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsRequests"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insights-summary
This method returns high level summary information for role insights for a customer.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-insights-summary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -416,7 +449,7 @@ Code | Description | Data Type
# Get role insights summary information
try {
Get-BetaRoleInsightsSummary
Get-BetaRoleInsightsSummary
# Below is a request that includes all optional parameters
# Get-BetaRoleInsightsSummary

56
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRolesApi.md
View File

@@ -63,6 +63,7 @@ Method | HTTP request | Description
[**Get-BetaRoles**](#list-roles) | **GET** `/roles` | List Roles
[**Update-BetaRole**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified Role
## create-role
This API creates a role.
@@ -72,6 +73,8 @@ In addition, a ROLE_SUBADMIN may not create a role including an access profile i
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/beta/create-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -259,22 +262,25 @@ $Role = @"{
try {
$Result = ConvertFrom-JsonToRole -Json $Role
New-BetaRole -BetaRole $Result
New-BetaRole -BetaRole $Result
# Below is a request that includes all optional parameters
# New-BetaRole -BetaRole $Role
# New-BetaRole -BetaRole $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRole"
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 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 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/beta/delete-bulk-roles)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -307,21 +313,24 @@ $RoleBulkDeleteRequest = @"{
try {
$Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest
Remove-BetaBulkRoles -BetaRoleBulkDeleteRequest $Result
Remove-BetaBulkRoles -BetaRoleBulkDeleteRequest $Result
# Below is a request that includes all optional parameters
# Remove-BetaBulkRoles -BetaRoleBulkDeleteRequest $RoleBulkDeleteRequest
# Remove-BetaBulkRoles -BetaRoleBulkDeleteRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaBulkRoles"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-role
This API deletes a Role 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 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/beta/delete-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -351,20 +360,23 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role
# Delete a Role
try {
Remove-BetaRole -BetaId $Id
Remove-BetaRole -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaRole -BetaId $Id
# Remove-BetaRole -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaRole"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role
This API returns a Role 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 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/beta/get-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -394,19 +406,22 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role
# Get a Role
try {
Get-BetaRole -BetaId $Id
Get-BetaRole -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaRole -BetaId $Id
# Get-BetaRole -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRole"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-assigned-identities
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-assigned-identities)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -446,21 +461,24 @@ $Sorters = "aliasName,name" # String | Sort results using the standard syntax de
# Identities assigned a Role
try {
Get-BetaRoleAssignedIdentities -BetaId $Id
Get-BetaRoleAssignedIdentities -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaRoleAssignedIdentities -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters
# Get-BetaRoleAssignedIdentities -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignedIdentities"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-entitlements
This API lists the Entitlements associated with a given 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/beta/get-role-entitlements)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -500,21 +518,24 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de
# List role's Entitlements
try {
Get-BetaRoleEntitlements -BetaId $Id
Get-BetaRoleEntitlements -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaRoleEntitlements -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters
# Get-BetaRoleEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleEntitlements"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-roles
This API returns a list of Roles.
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/beta/list-roles)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -558,16 +579,17 @@ $IncludeUnsegmented = $false # Boolean | Whether or not the response list should
# List Roles
try {
Get-BetaRoles
Get-BetaRoles
# Below is a request that includes all optional parameters
# Get-BetaRoles -BetaForSubadmin $ForSubadmin -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -BetaForSegmentIds $ForSegmentIds -BetaIncludeUnsegmented $IncludeUnsegmented
# Get-BetaRoles -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-BetaRoles"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-role
This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
@@ -591,6 +613,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/beta/patch-role)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -628,10 +652,10 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-BetaRole -BetaId $Id -BetaJsonPatchOperation $Result
Update-BetaRole -Id $Id -BetaJsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-BetaRole -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation
# Update-BetaRole -Id $Id -BetaJsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRole"
Write-Host $_.ErrorDetails

47
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSIMIntegrationsApi.md
View File

@@ -32,9 +32,12 @@ Method | HTTP request | Description
[**Update-BetaSIMAttributes**](#patch-sim-attributes) | **PATCH** `/sim-integrations/{id}` | Patch a SIM attribute.
[**Send-BetaSIMIntegration**](#put-sim-integration) | **PUT** `/sim-integrations/{id}` | Update an existing SIM integration
## create-sim-integration
Create a new SIM Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-sim-integration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -83,19 +86,22 @@ $SimIntegrationDetails = @"{
try {
$Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails
New-BetaSIMIntegration -BetaSimIntegrationDetails $Result
New-BetaSIMIntegration -BetaSimIntegrationDetails $Result
# Below is a request that includes all optional parameters
# New-BetaSIMIntegration -BetaSimIntegrationDetails $SimIntegrationDetails
# New-BetaSIMIntegration -BetaSimIntegrationDetails $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSIMIntegration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-sim-integration
Get the details of a SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-sim-integration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -126,19 +132,22 @@ $Id = "12345" # String | The id of the integration to delete.
# Delete a SIM integration
try {
Remove-BetaSIMIntegration -BetaId $Id
Remove-BetaSIMIntegration -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaSIMIntegration -BetaId $Id
# Remove-BetaSIMIntegration -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSIMIntegration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sim-integration
Get the details of a SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sim-integration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -169,19 +178,22 @@ $Id = "12345" # String | The id of the integration.
# Get a SIM integration details.
try {
Get-BetaSIMIntegration -BetaId $Id
Get-BetaSIMIntegration -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaSIMIntegration -BetaId $Id
# Get-BetaSIMIntegration -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sim-integrations
List the existing SIM integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sim-integrations)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -210,7 +222,7 @@ Code | Description | Data Type
# List the existing SIM integrations.
try {
Get-BetaSIMIntegrations
Get-BetaSIMIntegrations
# Below is a request that includes all optional parameters
# Get-BetaSIMIntegrations
@@ -220,9 +232,12 @@ try {
}
```
[[Back to top]](#)
## patch-before-provisioning-rule
Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-before-provisioning-rule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -256,19 +271,22 @@ $JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\"
try {
$Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch
Update-BetaBeforeProvisioningRule -BetaId $Id -BetaJsonPatch $Result
Update-BetaBeforeProvisioningRule -Id $Id -BetaJsonPatch $Result
# Below is a request that includes all optional parameters
# Update-BetaBeforeProvisioningRule -BetaId $Id -BetaJsonPatch $JsonPatch
# Update-BetaBeforeProvisioningRule -Id $Id -BetaJsonPatch $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaBeforeProvisioningRule"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-sim-attributes
Patch a SIM attribute given a JsonPatch object. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-sim-attributes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -302,19 +320,22 @@ $JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\"
try {
$Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch
Update-BetaSIMAttributes -BetaId $Id -BetaJsonPatch $Result
Update-BetaSIMAttributes -Id $Id -BetaJsonPatch $Result
# Below is a request that includes all optional parameters
# Update-BetaSIMAttributes -BetaId $Id -BetaJsonPatch $JsonPatch
# Update-BetaSIMAttributes -Id $Id -BetaJsonPatch $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSIMAttributes"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-sim-integration
Update an existing SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/beta/put-sim-integration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -365,10 +386,10 @@ $SimIntegrationDetails = @"{
try {
$Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails
Send-BetaSIMIntegration -BetaId $Id -BetaSimIntegrationDetails $Result
Send-BetaSIMIntegration -Id $Id -BetaSimIntegrationDetails $Result
# Below is a request that includes all optional parameters
# Send-BetaSIMIntegration -BetaId $Id -BetaSimIntegrationDetails $SimIntegrationDetails
# Send-BetaSIMIntegration -Id $Id -BetaSimIntegrationDetails $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSIMIntegration"
Write-Host $_.ErrorDetails

158
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODPoliciesApi.md
View File

@@ -60,10 +60,16 @@ Method | HTTP request | Description
[**Start-BetaSodAllPoliciesForOrg**](#start-sod-all-policies-for-org) | **POST** `/sod-violation-report/run` | Runs all policies for org
[**Start-BetaSodPolicy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report
## create-sod-policy
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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/beta/create-sod-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -149,20 +155,26 @@ $SodPolicy = @"{
try {
$Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy
New-BetaSodPolicy -BetaSodPolicy $Result
New-BetaSodPolicy -BetaSodPolicy $Result
# Below is a request that includes all optional parameters
# New-BetaSodPolicy -BetaSodPolicy $SodPolicy
# New-BetaSodPolicy -BetaSodPolicy $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSodPolicy"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-sod-policy
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
This deletes a specified SOD policy.
Requires role of ORG_ADMIN.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-sod-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -195,20 +207,26 @@ $Logical = $true # Boolean | Indicates whether this is a soft delete (logical tr
# Delete SOD policy by ID
try {
Remove-BetaSodPolicy -BetaId $Id
Remove-BetaSodPolicy -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaSodPolicy -BetaId $Id -BetaLogical $Logical
# Remove-BetaSodPolicy -Id $Id -Logical $Logical
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicy"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-sod-policy-schedule
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
This deletes schedule for a specified SOD policy.
Requires role of ORG_ADMIN.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-sod-policy-schedule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -239,20 +257,26 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy the
# Delete SOD policy schedule
try {
Remove-BetaSodPolicySchedule -BetaId $Id
Remove-BetaSodPolicySchedule -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaSodPolicySchedule -BetaId $Id
# Remove-BetaSodPolicySchedule -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicySchedule"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-custom-violation-report
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
This allows to download a specified named violation report for a given report reference.
Requires role of ORG_ADMIN.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-custom-violation-report)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -285,20 +309,26 @@ $FileName = "custom-name" # String | Custom Name for the file.
# Download custom violation report
try {
Get-BetaCustomViolationReport -BetaReportResultId $ReportResultId -BetaFileName $FileName
Get-BetaCustomViolationReport -ReportResultId $ReportResultId -FileName $FileName
# Below is a request that includes all optional parameters
# Get-BetaCustomViolationReport -BetaReportResultId $ReportResultId -BetaFileName $FileName
# Get-BetaCustomViolationReport -ReportResultId $ReportResultId -FileName $FileName
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCustomViolationReport"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-default-violation-report
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
This allows to download a violation report for a given report reference.
Requires role of ORG_ADMIN.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-default-violation-report)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -329,20 +359,26 @@ $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the re
# Download violation report
try {
Get-BetaDefaultViolationReport -BetaReportResultId $ReportResultId
Get-BetaDefaultViolationReport -ReportResultId $ReportResultId
# Below is a request that includes all optional parameters
# Get-BetaDefaultViolationReport -BetaReportResultId $ReportResultId
# Get-BetaDefaultViolationReport -ReportResultId $ReportResultId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDefaultViolationReport"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sod-all-report-run-status
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
This endpoint gets the status for a violation report for all policy run.
Requires role of ORG_ADMIN.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sod-all-report-run-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -370,7 +406,7 @@ Code | Description | Data Type
# Get multi-report run task status
try {
Get-BetaSodAllReportRunStatus
Get-BetaSodAllReportRunStatus
# Below is a request that includes all optional parameters
# Get-BetaSodAllReportRunStatus
@@ -380,10 +416,16 @@ try {
}
```
[[Back to top]](#)
## get-sod-policy
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
This gets specified SOD policy.
Requires role of ORG_ADMIN.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sod-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -414,20 +456,26 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object referen
# Get SOD policy by ID
try {
Get-BetaSodPolicy -BetaId $Id
Get-BetaSodPolicy -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaSodPolicy -BetaId $Id
# Get-BetaSodPolicy -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicy"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sod-policy-schedule
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
This endpoint gets a specified SOD policy's schedule.
Requires the role of ORG_ADMIN.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sod-policy-schedule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -457,20 +505,26 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object referen
# Get SOD policy schedule
try {
Get-BetaSodPolicySchedule -BetaId $Id
Get-BetaSodPolicySchedule -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaSodPolicySchedule -BetaId $Id
# Get-BetaSodPolicySchedule -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicySchedule"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sod-violation-report-run-status
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
This gets the status for a violation report run task that has already been invoked.
Requires role of ORG_ADMIN.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sod-violation-report-run-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -501,20 +555,26 @@ $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of th
# Get violation report run status
try {
Get-BetaSodViolationReportRunStatus -BetaReportResultId $ReportResultId
Get-BetaSodViolationReportRunStatus -ReportResultId $ReportResultId
# Below is a request that includes all optional parameters
# Get-BetaSodViolationReportRunStatus -BetaReportResultId $ReportResultId
# Get-BetaSodViolationReportRunStatus -ReportResultId $ReportResultId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportRunStatus"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sod-violation-report-status
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
This gets the status for a violation report run task that has already been invoked.
Requires role of ORG_ADMIN.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sod-violation-report-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -545,20 +605,26 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object referen
# Get SOD violation report status
try {
Get-BetaSodViolationReportStatus -BetaId $Id
Get-BetaSodViolationReportStatus -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaSodViolationReportStatus -BetaId $Id
# Get-BetaSodViolationReportStatus -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportStatus"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-sod-policies
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
This gets list of all SOD policies.
Requires role of ORG_ADMIN
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-sod-policies)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -596,21 +662,27 @@ $Sorters = "id,name" # String | Sort results using the standard syntax described
# List SOD policies
try {
Get-BetaSodPolicies
Get-BetaSodPolicies
# Below is a request that includes all optional parameters
# Get-BetaSodPolicies -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters
# Get-BetaSodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicies"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-sod-policy
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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/beta/patch-sod-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -646,20 +718,26 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of SOD Policy update ope
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Update-BetaSodPolicy -BetaId $Id -BetaRequestBody $Result
Update-BetaSodPolicy -Id $Id -RequestBody $Result
# Below is a request that includes all optional parameters
# Update-BetaSodPolicy -BetaId $Id -BetaRequestBody $RequestBody
# Update-BetaSodPolicy -Id $Id -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSodPolicy"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-policy-schedule
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
This updates schedule for a specified SOD policy.
Requires role of ORG_ADMIN.
[API Spec](https://developer.sailpoint.com/docs/api/beta/put-policy-schedule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -777,20 +855,26 @@ $SodPolicySchedule = @"{
try {
$Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule
Send-BetaPolicySchedule -BetaId $Id -BetaSodPolicySchedule $Result
Send-BetaPolicySchedule -Id $Id -BetaSodPolicySchedule $Result
# Below is a request that includes all optional parameters
# Send-BetaPolicySchedule -BetaId $Id -BetaSodPolicySchedule $SodPolicySchedule
# Send-BetaPolicySchedule -Id $Id -BetaSodPolicySchedule $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPolicySchedule"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-sod-policy
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
This updates a specified SOD policy.
Requires role of ORG_ADMIN.
[API Spec](https://developer.sailpoint.com/docs/api/beta/put-sod-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -879,20 +963,26 @@ $SodPolicy = @"{
try {
$Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy
Send-BetaSodPolicy -BetaId $Id -BetaSodPolicy $Result
Send-BetaSodPolicy -Id $Id -BetaSodPolicy $Result
# Below is a request that includes all optional parameters
# Send-BetaSodPolicy -BetaId $Id -BetaSodPolicy $SodPolicy
# Send-BetaSodPolicy -Id $Id -BetaSodPolicy $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSodPolicy"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-sod-all-policies-for-org
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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.
Requires role of ORG_ADMIN.
[API Spec](https://developer.sailpoint.com/docs/api/beta/start-sod-all-policies-for-org)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -924,20 +1014,26 @@ $MultiPolicyRequest = @"{
# Runs all policies for org
try {
Start-BetaSodAllPoliciesForOrg
Start-BetaSodAllPoliciesForOrg
# Below is a request that includes all optional parameters
# Start-BetaSodAllPoliciesForOrg -BetaMultiPolicyRequest $MultiPolicyRequest
# Start-BetaSodAllPoliciesForOrg -BetaMultiPolicyRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodAllPoliciesForOrg"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-sod-policy
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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.
Requires role of ORG_ADMIN.
[API Spec](https://developer.sailpoint.com/docs/api/beta/start-sod-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -968,10 +1064,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The SOD policy ID to run.
# Runs SOD policy violation report
try {
Start-BetaSodPolicy -BetaId $Id
Start-BetaSodPolicy -Id $Id
# Below is a request that includes all optional parameters
# Start-BetaSodPolicy -BetaId $Id
# Start-BetaSodPolicy -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodPolicy"
Write-Host $_.ErrorDetails

10
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODViolationsApi.md
View File

@@ -37,11 +37,17 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Start-BetaPredictSodViolations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict SOD violations for identity.
## start-predict-sod-violations
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
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.
A token with ORG_ADMIN or API authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/start-predict-sod-violations)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -84,10 +90,10 @@ $IdentityWithNewAccess = @"{
try {
$Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess
Start-BetaPredictSodViolations -BetaIdentityWithNewAccess $Result
Start-BetaPredictSodViolations -BetaIdentityWithNewAccess $Result
# Below is a request that includes all optional parameters
# Start-BetaPredictSodViolations -BetaIdentityWithNewAccess $IdentityWithNewAccess
# Start-BetaPredictSodViolations -BetaIdentityWithNewAccess $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaPredictSodViolations"
Write-Host $_.ErrorDetails

47
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSPConfigApi.md
View File

@@ -25,10 +25,13 @@ Method | HTTP request | Description
[**Import-BetaSpConfig**](#import-sp-config) | **POST** `/sp-config/import` | Initiates configuration objects import job
[**Get-BetaSpConfigObjects**](#list-sp-config-objects) | **GET** `/sp-config/config-objects` | Get config object details
## export-sp-config
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/beta/export-sp-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -62,21 +65,24 @@ $ExportPayload = @"{
try {
$Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload
Export-BetaSpConfig -BetaExportPayload $Result
Export-BetaSpConfig -BetaExportPayload $Result
# Below is a request that includes all optional parameters
# Export-BetaSpConfig -BetaExportPayload $ExportPayload
# Export-BetaSpConfig -BetaExportPayload $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaSpConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sp-config-export
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/beta/get-sp-config-export)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -107,21 +113,24 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job who
# Download export job result.
try {
Get-BetaSpConfigExport -BetaId $Id
Get-BetaSpConfigExport -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaSpConfigExport -BetaId $Id
# Get-BetaSpConfigExport -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExport"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sp-config-export-status
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/beta/get-sp-config-export-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -152,21 +161,24 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job who
# Get export job status
try {
Get-BetaSpConfigExportStatus -BetaId $Id
Get-BetaSpConfigExportStatus -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaSpConfigExportStatus -BetaId $Id
# Get-BetaSpConfigExportStatus -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExportStatus"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sp-config-import
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/beta/get-sp-config-import)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -197,20 +209,23 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job who
# Download import job result
try {
Get-BetaSpConfigImport -BetaId $Id
Get-BetaSpConfigImport -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaSpConfigImport -BetaId $Id
# Get-BetaSpConfigImport -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImport"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sp-config-import-status
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/beta/get-sp-config-import-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -241,16 +256,17 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job who
# Get import job status
try {
Get-BetaSpConfigImportStatus -BetaId $Id
Get-BetaSpConfigImportStatus -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaSpConfigImportStatus -BetaId $Id
# Get-BetaSpConfigImportStatus -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImportStatus"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## import-sp-config
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.
@@ -264,6 +280,8 @@ You cannot currently import from the Non-Employee Lifecycle Management (NELM) so
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/beta/import-sp-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -298,19 +316,22 @@ $Options = @""@
# Initiates configuration objects import job
try {
Import-BetaSpConfig -BetaData $Data
Import-BetaSpConfig -Data $Data
# Below is a request that includes all optional parameters
# Import-BetaSpConfig -BetaData $Data -BetaPreview $Preview -BetaOptions $Options
# Import-BetaSpConfig -Data $Data -Preview $Preview -BetaOptions $Options
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSpConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-sp-config-objects
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/beta/list-sp-config-objects)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -339,7 +360,7 @@ Code | Description | Data Type
# Get config object details
try {
Get-BetaSpConfigObjects
Get-BetaSpConfigObjects
# Below is a request that includes all optional parameters
# Get-BetaSpConfigObjects

33
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSearchAttributeConfigurationApi.md
View File

@@ -41,10 +41,13 @@ Method | HTTP request | Description
[**Get-BetaSingleSearchAttributeConfig**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute
[**Update-BetaSearchAttributeConfig**](#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.
A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-search-attribute-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -83,19 +86,22 @@ $SearchAttributeConfig = @"{
try {
$Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig
New-BetaSearchAttributeConfig -BetaSearchAttributeConfig $Result
New-BetaSearchAttributeConfig -BetaSearchAttributeConfig $Result
# Below is a request that includes all optional parameters
# New-BetaSearchAttributeConfig -BetaSearchAttributeConfig $SearchAttributeConfig
# New-BetaSearchAttributeConfig -BetaSearchAttributeConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSearchAttributeConfig"
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/beta/delete-search-attribute-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -125,20 +131,23 @@ $Name = "newMailAttribute" # String | Name of the extended search attribute conf
# Delete Extended Search Attribute
try {
Remove-BetaSearchAttributeConfig -BetaName $Name
Remove-BetaSearchAttributeConfig -Name $Name
# Below is a request that includes all optional parameters
# Remove-BetaSearchAttributeConfig -BetaName $Name
# Remove-BetaSearchAttributeConfig -Name $Name
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSearchAttributeConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-search-attribute-config
Get a list of attribute/application associates currently configured in Identity Security Cloud (ISC).
A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/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-BetaSearchAttributeConfig
Get-BetaSearchAttributeConfig
# Below is a request that includes all optional parameters
# Get-BetaSearchAttributeConfig
@@ -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/beta/get-single-search-attribute-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -208,21 +220,24 @@ $Name = "newMailAttribute" # String | Name of the extended search attribute conf
# Get Extended Search Attribute
try {
Get-BetaSingleSearchAttributeConfig -BetaName $Name
Get-BetaSingleSearchAttributeConfig -Name $Name
# Below is a request that includes all optional parameters
# Get-BetaSingleSearchAttributeConfig -BetaName $Name
# Get-BetaSingleSearchAttributeConfig -Name $Name
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSingleSearchAttributeConfig"
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/beta/patch-search-attribute-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -261,10 +276,10 @@ $Name = "promotedMailAttribute" # String | Name of the extended search attribute
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-BetaSearchAttributeConfig -BetaName $Name -BetaJsonPatchOperation $Result
Update-BetaSearchAttributeConfig -Name $Name -BetaJsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-BetaSearchAttributeConfig -BetaName $Name -BetaJsonPatchOperation $JsonPatchOperation
# Update-BetaSearchAttributeConfig -Name $Name -BetaJsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSearchAttributeConfig"
Write-Host $_.ErrorDetails

35
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSegmentsApi.md
View File

@@ -40,11 +40,14 @@ Method | HTTP request | Description
[**Get-BetaSegments**](#list-segments) | **GET** `/segments` | List Segments
[**Update-BetaSegment**](#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.
A token with ORG_ADMIN or API authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-segment)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -98,21 +101,24 @@ $Segment = @"{
try {
$Result = ConvertFrom-JsonToSegment -Json $Segment
New-BetaSegment -BetaSegment $Result
New-BetaSegment -BetaSegment $Result
# Below is a request that includes all optional parameters
# New-BetaSegment -BetaSegment $Segment
# New-BetaSegment -BetaSegment $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSegment"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-segment
This API deletes the segment specified by the given ID.
>**Note:** Segment deletion may take some time to go into effect.
A token with ORG_ADMIN or API authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-segment)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -143,20 +149,23 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete.
# Delete Segment by ID
try {
Remove-BetaSegment -BetaId $Id
Remove-BetaSegment -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaSegment -BetaId $Id
# Remove-BetaSegment -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSegment"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-segment
This API returns the segment specified by the given ID.
A token with ORG_ADMIN or API authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-segment)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -187,20 +196,23 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve.
# Get Segment by ID
try {
Get-BetaSegment -BetaId $Id
Get-BetaSegment -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaSegment -BetaId $Id
# Get-BetaSegment -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegment"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-segments
This API returns a list of all segments.
A token with ORG_ADMIN or API authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-segments)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -234,21 +246,24 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# List Segments
try {
Get-BetaSegments
Get-BetaSegments
# Below is a request that includes all optional parameters
# Get-BetaSegments -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count
# Get-BetaSegments -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegments"
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.
A token with ORG_ADMIN or API authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-segment)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -284,10 +299,10 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operat
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Update-BetaSegment -BetaId $Id -BetaRequestBody $Result
Update-BetaSegment -Id $Id -RequestBody $Result
# Below is a request that includes all optional parameters
# Update-BetaSegment -BetaId $Id -BetaRequestBody $RequestBody
# Update-BetaSegment -Id $Id -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSegment"
Write-Host $_.ErrorDetails

66
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaServiceDeskIntegrationApi.md
View File

@@ -52,9 +52,12 @@ Method | HTTP request | Description
[**Send-BetaServiceDeskIntegration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a Service Desk integration
[**Update-BetaStatusCheckDetails**](#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/beta/create-service-desk-integration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -116,19 +119,22 @@ $ServiceDeskIntegrationDto = @"{
try {
$Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto
New-BetaServiceDeskIntegration -BetaServiceDeskIntegrationDto $Result
New-BetaServiceDeskIntegration -BetaServiceDeskIntegrationDto $Result
# Below is a request that includes all optional parameters
# New-BetaServiceDeskIntegration -BetaServiceDeskIntegrationDto $ServiceDeskIntegrationDto
# New-BetaServiceDeskIntegration -BetaServiceDeskIntegrationDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaServiceDeskIntegration"
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/beta/delete-service-desk-integration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -159,19 +165,22 @@ $Id = "anId" # String | ID of Service Desk integration to delete
# Delete a Service Desk integration
try {
Remove-BetaServiceDeskIntegration -BetaId $Id
Remove-BetaServiceDeskIntegration -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaServiceDeskIntegration -BetaId $Id
# Remove-BetaServiceDeskIntegration -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaServiceDeskIntegration"
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/beta/get-service-desk-integration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -202,19 +211,22 @@ $Id = "anId" # String | ID of the Service Desk integration to get
# Get a Service Desk integration
try {
Get-BetaServiceDeskIntegration -BetaId $Id
Get-BetaServiceDeskIntegration -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaServiceDeskIntegration -BetaId $Id
# Get-BetaServiceDeskIntegration -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-service-desk-integration-list
Get a list of Service Desk integration objects.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-service-desk-integration-list)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -253,19 +265,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# List existing Service Desk integrations
try {
Get-BetaServiceDeskIntegrationList
Get-BetaServiceDeskIntegrationList
# Below is a request that includes all optional parameters
# Get-BetaServiceDeskIntegrationList -BetaOffset $Offset -BetaLimit $Limit -BetaSorters $Sorters -BetaFilters $Filters -BetaCount $Count
# Get-BetaServiceDeskIntegrationList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationList"
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/beta/get-service-desk-integration-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -296,19 +311,22 @@ $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk
# Service Desk integration template by scriptName
try {
Get-BetaServiceDeskIntegrationTemplate -BetaScriptName $ScriptName
Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName
# Below is a request that includes all optional parameters
# Get-BetaServiceDeskIntegrationTemplate -BetaScriptName $ScriptName
# Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTemplate"
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/beta/get-service-desk-integration-types)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -337,7 +355,7 @@ Code | Description | Data Type
# List Service Desk integration types
try {
Get-BetaServiceDeskIntegrationTypes
Get-BetaServiceDeskIntegrationTypes
# Below is a request that includes all optional parameters
# Get-BetaServiceDeskIntegrationTypes
@@ -347,9 +365,12 @@ try {
}
```
[[Back to top]](#)
## get-status-check-details
Get the time check configuration of queued SDIM tickets.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-status-check-details)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -378,7 +399,7 @@ Code | Description | Data Type
# Get the time check configuration
try {
Get-BetaStatusCheckDetails
Get-BetaStatusCheckDetails
# Below is a request that includes all optional parameters
# Get-BetaStatusCheckDetails
@@ -388,9 +409,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/beta/patch-service-desk-integration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -424,19 +448,22 @@ $PatchServiceDeskIntegrationRequest = @""@
try {
$Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest
Update-BetaServiceDeskIntegration -BetaId $Id -BetaPatchServiceDeskIntegrationRequest $Result
Update-BetaServiceDeskIntegration -Id $Id -BetaPatchServiceDeskIntegrationRequest $Result
# Below is a request that includes all optional parameters
# Update-BetaServiceDeskIntegration -BetaId $Id -BetaPatchServiceDeskIntegrationRequest $PatchServiceDeskIntegrationRequest
# Update-BetaServiceDeskIntegration -Id $Id -BetaPatchServiceDeskIntegrationRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration"
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/beta/put-service-desk-integration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -500,19 +527,22 @@ $ServiceDeskIntegrationDto = @"{
try {
$Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto
Send-BetaServiceDeskIntegration -BetaId $Id -BetaServiceDeskIntegrationDto $Result
Send-BetaServiceDeskIntegration -Id $Id -BetaServiceDeskIntegrationDto $Result
# Below is a request that includes all optional parameters
# Send-BetaServiceDeskIntegration -BetaId $Id -BetaServiceDeskIntegrationDto $ServiceDeskIntegrationDto
# Send-BetaServiceDeskIntegration -Id $Id -BetaServiceDeskIntegrationDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaServiceDeskIntegration"
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/beta/update-status-check-details)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -547,10 +577,10 @@ $QueuedCheckConfigDetails = @"{
try {
$Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails
Update-BetaStatusCheckDetails -BetaQueuedCheckConfigDetails $Result
Update-BetaStatusCheckDetails -BetaQueuedCheckConfigDetails $Result
# Below is a request that includes all optional parameters
# Update-BetaStatusCheckDetails -BetaQueuedCheckConfigDetails $QueuedCheckConfigDetails
# Update-BetaStatusCheckDetails -BetaQueuedCheckConfigDetails $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaStatusCheckDetails"
Write-Host $_.ErrorDetails

14
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSourceUsagesApi.md
View File

@@ -23,9 +23,12 @@ Method | HTTP request | Description
[**Get-BetaStatusBySourceId**](#get-status-by-source-id) | **GET** `/source-usages/{sourceId}/status` | Finds status of source usage
[**Get-BetaUsagesBySourceId**](#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/beta/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-BetaStatusBySourceId -BetaSourceId $SourceId
Get-BetaStatusBySourceId -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-BetaStatusBySourceId -BetaSourceId $SourceId
# Get-BetaStatusBySourceId -SourceId $SourceId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusBySourceId"
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/beta/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-BetaUsagesBySourceId -BetaSourceId $SourceId
Get-BetaUsagesBySourceId -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-BetaUsagesBySourceId -BetaSourceId $SourceId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters
# Get-BetaUsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesBySourceId"
Write-Host $_.ErrorDetails

301
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSourcesApi.md
View File

File diff suppressed because it is too large Load Diff

47
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSuggestedEntitlementDescriptionApi.md
View File

@@ -28,6 +28,7 @@ Method | HTTP request | Description
[**Submit-BetaSedAssignment**](#submit-sed-assignment) | **POST** `/suggested-entitlement-description-assignments` | Submit Sed Assignment Request
[**Submit-BetaSedBatchRequest**](#submit-sed-batch-request) | **POST** `/suggested-entitlement-description-batches` | Submit Sed Batch Request
## get-sed-batch-stats
Submit Sed Batch Stats Request.
@@ -35,6 +36,8 @@ 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/beta/get-sed-batch-stats)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -65,20 +68,23 @@ $BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id
# Submit Sed Batch Stats Request
try {
Get-BetaSedBatchStats -BetaBatchId $BatchId
Get-BetaSedBatchStats -BatchId $BatchId
# Below is a request that includes all optional parameters
# Get-BetaSedBatchStats -BetaBatchId $BatchId
# Get-BetaSedBatchStats -BatchId $BatchId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSedBatchStats"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sed-batches
List Sed Batches.
API responses with Sed Batch Status
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sed-batches)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -107,7 +113,7 @@ Code | Description | Data Type
# List Sed Batch Request
try {
Get-BetaSedBatches
Get-BetaSedBatches
# Below is a request that includes all optional parameters
# Get-BetaSedBatches
@@ -117,6 +123,7 @@ try {
}
```
[[Back to top]](#)
## list-seds
List of Suggested Entitlement Descriptions (SED)
@@ -134,6 +141,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/beta/list-seds)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -176,19 +185,22 @@ $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are
# List Suggested Entitlement Descriptions
try {
Get-BetaSeds
Get-BetaSeds
# Below is a request that includes all optional parameters
# Get-BetaSeds -BetaLimit $Limit -BetaFilters $Filters -BetaSorters $Sorters -BetaCount $Count -BetaCountOnly $CountOnly -BetaRequestedByAnyone $RequestedByAnyone -BetaShowPendingStatusOnly $ShowPendingStatusOnly
# Get-BetaSeds -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-BetaSeds"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-sed
Patch Suggested Entitlement Description
[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-sed)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -227,20 +239,23 @@ $Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id
try {
$Result = ConvertFrom-JsonToSedPatch -Json $SedPatch
Update-BetaSed -BetaId $Id -BetaSedPatch $Result
Update-BetaSed -Id $Id -BetaSedPatch $Result
# Below is a request that includes all optional parameters
# Update-BetaSed -BetaId $Id -BetaSedPatch $SedPatch
# Update-BetaSed -Id $Id -BetaSedPatch $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSed"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## submit-sed-approval
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/beta/submit-sed-approval)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -275,20 +290,23 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToSedApproval -Json $SedApproval
Submit-BetaSedApproval -BetaSedApproval $Result
Submit-BetaSedApproval -BetaSedApproval $Result
# Below is a request that includes all optional parameters
# Submit-BetaSedApproval -BetaSedApproval $SedApproval
# Submit-BetaSedApproval -BetaSedApproval $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedApproval"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## submit-sed-assignment
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/beta/submit-sed-assignment)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -326,16 +344,17 @@ $SedAssignment = @"{
try {
$Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment
Submit-BetaSedAssignment -BetaSedAssignment $Result
Submit-BetaSedAssignment -BetaSedAssignment $Result
# Below is a request that includes all optional parameters
# Submit-BetaSedAssignment -BetaSedAssignment $SedAssignment
# Submit-BetaSedAssignment -BetaSedAssignment $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedAssignment"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## submit-sed-batch-request
Submit Sed Batch Request.
Request body has one of the following:
@@ -343,6 +362,8 @@ Request body has one of the following:
- 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/beta/submit-sed-batch-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -376,10 +397,10 @@ $SedBatchRequest = @"{
# Submit Sed Batch Request
try {
Submit-BetaSedBatchRequest
Submit-BetaSedBatchRequest
# Below is a request that includes all optional parameters
# Submit-BetaSedBatchRequest -BetaSedBatchRequest $SedBatchRequest
# Submit-BetaSedBatchRequest -BetaSedBatchRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedBatchRequest"
Write-Host $_.ErrorDetails

56
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTaggedObjectsApi.md
View File

@@ -79,9 +79,12 @@ Method | HTTP request | Description
[**Set-BetaTagToObject**](#set-tag-to-object) | **POST** `/tagged-objects` | Add Tag to Object
[**Set-BetaTagsToManyObjects**](#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/beta/delete-tagged-object)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -113,21 +116,24 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to dele
# Delete Object Tags
try {
Remove-BetaTaggedObject -BetaType $Type -BetaId $Id
Remove-BetaTaggedObject -Type $Type -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaTaggedObject -BetaType $Type -BetaId $Id
# Remove-BetaTaggedObject -Type $Type -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTaggedObject"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-tags-to-many-object
This API removes tags from multiple objects.
A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-tags-to-many-object)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -170,19 +176,22 @@ $BulkTaggedObject = @"{
try {
$Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject
Remove-BetaTagsToManyObject -BetaBulkTaggedObject $Result
Remove-BetaTagsToManyObject -BetaBulkTaggedObject $Result
# Below is a request that includes all optional parameters
# Remove-BetaTagsToManyObject -BetaBulkTaggedObject $BulkTaggedObject
# Remove-BetaTagsToManyObject -BetaBulkTaggedObject $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTagsToManyObject"
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/beta/get-tagged-object)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -214,21 +223,24 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object referen
# Get Tagged Object
try {
Get-BetaTaggedObject -BetaType $Type -BetaId $Id
Get-BetaTaggedObject -Type $Type -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaTaggedObject -BetaType $Type -BetaId $Id
# Get-BetaTaggedObject -Type $Type -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObject"
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/beta/list-tagged-objects)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -264,21 +276,24 @@ $Filters = 'tagName eq "BU_FINANCE"' # String | Filter results using the standar
# List Tagged Objects
try {
Get-BetaTaggedObjects
Get-BetaTaggedObjects
# Below is a request that includes all optional parameters
# Get-BetaTaggedObjects -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters
# Get-BetaTaggedObjects -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObjects"
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/beta/list-tagged-objects-by-type)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -316,19 +331,22 @@ $Filters = 'objectRef.id eq "2c91808568c529c60168cca6f90c1313"' # String | Filte
# List Tagged Objects by Type
try {
Get-BetaTaggedObjectsByType -BetaType $Type
Get-BetaTaggedObjectsByType -Type $Type
# Below is a request that includes all optional parameters
# Get-BetaTaggedObjectsByType -BetaType $Type -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters
# Get-BetaTaggedObjectsByType -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObjectsByType"
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/beta/put-tagged-object)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -370,21 +388,24 @@ $TaggedObject = @"{
try {
$Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject
Send-BetaTaggedObject -BetaType $Type -BetaId $Id -BetaTaggedObject $Result
Send-BetaTaggedObject -Type $Type -Id $Id -BetaTaggedObject $Result
# Below is a request that includes all optional parameters
# Send-BetaTaggedObject -BetaType $Type -BetaId $Id -BetaTaggedObject $TaggedObject
# Send-BetaTaggedObject -Type $Type -Id $Id -BetaTaggedObject $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTaggedObject"
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/beta/set-tag-to-object)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -422,21 +443,24 @@ $TaggedObject = @"{
try {
$Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject
Set-BetaTagToObject -BetaTaggedObject $Result
Set-BetaTagToObject -BetaTaggedObject $Result
# Below is a request that includes all optional parameters
# Set-BetaTagToObject -BetaTaggedObject $TaggedObject
# Set-BetaTagToObject -BetaTaggedObject $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTagToObject"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-tags-to-many-objects
This API adds tags to multiple objects.
A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/set-tags-to-many-objects)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -479,10 +503,10 @@ $BulkTaggedObject = @"{
try {
$Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject
Set-BetaTagsToManyObjects -BetaBulkTaggedObject $Result
Set-BetaTagsToManyObjects -BetaBulkTaggedObject $Result
# Below is a request that includes all optional parameters
# Set-BetaTagsToManyObjects -BetaBulkTaggedObject $BulkTaggedObject
# Set-BetaTagsToManyObjects -BetaBulkTaggedObject $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTagsToManyObjects"
Write-Host $_.ErrorDetails

28
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTagsApi.md
View File

@@ -22,11 +22,14 @@ Method | HTTP request | Description
[**Get-BetaTagById**](#get-tag-by-id) | **GET** `/tags/{id}` | Get Tag By Id
[**Get-BetaTags**](#list-tags) | **GET** `/tags` | List Tags
## create-tag
This API creates new tag.
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-tag)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -71,21 +74,24 @@ $Tag = @"{
try {
$Result = ConvertFrom-JsonToTag -Json $Tag
New-BetaTag -BetaTag $Result
New-BetaTag -BetaTag $Result
# Below is a request that includes all optional parameters
# New-BetaTag -BetaTag $Tag
# New-BetaTag -BetaTag $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaTag"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-tag-by-id
This API deletes a tag by specified id.
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-tag-by-id)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -116,21 +122,24 @@ $Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object ref
# Delete Tag
try {
Remove-BetaTagById -BetaId $Id
Remove-BetaTagById -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaTagById -BetaId $Id
# Remove-BetaTagById -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTagById"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-tag-by-id
Returns a tag by its id.
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-tag-by-id)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -161,21 +170,24 @@ $Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object ref
# Get Tag By Id
try {
Get-BetaTagById -BetaId $Id
Get-BetaTagById -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaTagById -BetaId $Id
# Get-BetaTagById -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTagById"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-tags
This API returns a list of tags.
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-tags)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -213,10 +225,10 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de
# List Tags
try {
Get-BetaTags
Get-BetaTags
# Below is a request that includes all optional parameters
# Get-BetaTags -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters
# Get-BetaTags -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTags"
Write-Host $_.ErrorDetails

35
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTaskManagementApi.md
View File

@@ -23,9 +23,12 @@ Method | HTTP request | Description
[**Get-BetaTaskStatusList**](#get-task-status-list) | **GET** `/task-status` | Retrieve Task Status List
[**Update-BetaTaskStatus**](#update-task-status) | **PATCH** `/task-status/{id}` | Update Task Status by ID
## get-pending-task-headers
Responds with headers only for list of task statuses for pending tasks.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-pending-task-headers)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -60,19 +63,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Retrieve Pending Task List Headers
try {
Get-BetaPendingTaskHeaders
Get-BetaPendingTaskHeaders
# Below is a request that includes all optional parameters
# Get-BetaPendingTaskHeaders -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count
# Get-BetaPendingTaskHeaders -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingTaskHeaders"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-pending-tasks
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/beta/get-pending-tasks)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -107,19 +113,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Retrieve Pending Task Status List
try {
Get-BetaPendingTasks
Get-BetaPendingTasks
# Below is a request that includes all optional parameters
# Get-BetaPendingTasks -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count
# Get-BetaPendingTasks -Offset $Offset -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingTasks"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-task-status
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/beta/get-task-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -150,20 +159,23 @@ $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID.
# Get Task Status by ID
try {
Get-BetaTaskStatus -BetaId $Id
Get-BetaTaskStatus -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaTaskStatus -BetaId $Id
# Get-BetaTaskStatus -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaskStatus"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-task-status-list
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/beta/get-pending-tasks) endpoint.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-task-status-list)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -202,19 +214,22 @@ $Sorters = "-created" # String | Sort results using the standard syntax describe
# Retrieve Task Status List
try {
Get-BetaTaskStatusList
Get-BetaTaskStatusList
# Below is a request that includes all optional parameters
# Get-BetaTaskStatusList -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters
# Get-BetaTaskStatusList -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaskStatusList"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-task-status
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/beta/update-task-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -253,10 +268,10 @@ $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID.
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-BetaTaskStatus -BetaId $Id -BetaJsonPatchOperation $Result
Update-BetaTaskStatus -Id $Id -BetaJsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-BetaTaskStatus -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation
# Update-BetaTaskStatus -Id $Id -BetaJsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaTaskStatus"
Write-Host $_.ErrorDetails

5
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTenantApi.md
View File

@@ -19,9 +19,12 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaTenant**](#get-tenant) | **GET** `/tenant` | Get Tenant Information.
## get-tenant
This rest endpoint can be used to retrieve tenant details.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-tenant)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -50,7 +53,7 @@ Code | Description | Data Type
# Get Tenant Information.
try {
Get-BetaTenant
Get-BetaTenant
# Below is a request that includes all optional parameters
# Get-BetaTenant

35
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTransformsApi.md
View File

@@ -23,9 +23,12 @@ Method | HTTP request | Description
[**Get-BetaTransforms**](#list-transforms) | **GET** `/transforms` | List transforms
[**Update-BetaTransform**](#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. A token with transform write authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-transform)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -77,20 +80,23 @@ $Transform = @"{
try {
$Result = ConvertFrom-JsonToTransform -Json $Transform
New-BetaTransform -BetaTransform $Result
New-BetaTransform -BetaTransform $Result
# Below is a request that includes all optional parameters
# New-BetaTransform -BetaTransform $Transform
# New-BetaTransform -BetaTransform $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaTransform"
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.
A token with transform delete authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-transform)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -121,20 +127,23 @@ $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete
# Delete a transform
try {
Remove-BetaTransform -BetaId $Id
Remove-BetaTransform -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaTransform -BetaId $Id
# Remove-BetaTransform -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTransform"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-transform
This API returns the transform specified by the given ID.
A token with transform read authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-transform)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -165,20 +174,23 @@ $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retriev
# Transform by ID
try {
Get-BetaTransform -BetaId $Id
Get-BetaTransform -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaTransform -BetaId $Id
# Get-BetaTransform -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTransform"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-transforms
Gets a list of all saved transform objects.
A token with transforms-list read authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-transforms)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -217,20 +229,23 @@ $Filters = 'name eq "Uppercase"' # String | Filter results using the standard sy
# List transforms
try {
Get-BetaTransforms
Get-BetaTransforms
# Below is a request that includes all optional parameters
# Get-BetaTransforms -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaName $Name -BetaFilters $Filters
# Get-BetaTransforms -Offset $Offset -Limit $Limit -Count $Count -Name $Name -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTransforms"
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.
A token with transform write authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/update-transform)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -283,10 +298,10 @@ $Transform = @"{
# Update a transform
try {
Update-BetaTransform -BetaId $Id
Update-BetaTransform -Id $Id
# Below is a request that includes all optional parameters
# Update-BetaTransform -BetaId $Id -BetaTransform $Transform
# Update-BetaTransform -Id $Id -BetaTransform $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaTransform"
Write-Host $_.ErrorDetails

70
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTriggersApi.md
View File

@@ -69,9 +69,12 @@ Method | HTTP request | Description
[**Test-BetaSubscriptionFilter**](#test-subscription-filter) | **POST** `/trigger-subscriptions/validate-filter` | Validate a Subscription Filter
[**Update-BetaSubscription**](#update-subscription) | **PUT** `/trigger-subscriptions/{id}` | Update a Subscription
## complete-trigger-invocation
Completes an invocation to a REQUEST_RESPONSE type trigger.
[API Spec](https://developer.sailpoint.com/docs/api/beta/complete-trigger-invocation)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -110,21 +113,24 @@ $CompleteInvocation = @"{
try {
$Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation
Complete-BetaTriggerInvocation -BetaId $Id -BetaCompleteInvocation $Result
Complete-BetaTriggerInvocation -Id $Id -BetaCompleteInvocation $Result
# Below is a request that includes all optional parameters
# Complete-BetaTriggerInvocation -BetaId $Id -BetaCompleteInvocation $CompleteInvocation
# Complete-BetaTriggerInvocation -Id $Id -BetaCompleteInvocation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaTriggerInvocation"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-subscription
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/beta/create-subscription)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -179,19 +185,22 @@ $SubscriptionPostRequest = @"{
try {
$Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest
New-BetaSubscription -BetaSubscriptionPostRequest $Result
New-BetaSubscription -BetaSubscriptionPostRequest $Result
# Below is a request that includes all optional parameters
# New-BetaSubscription -BetaSubscriptionPostRequest $SubscriptionPostRequest
# New-BetaSubscription -BetaSubscriptionPostRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSubscription"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-subscription
Deletes an existing subscription to a trigger.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-subscription)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -222,19 +231,22 @@ $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID
# Delete a Subscription
try {
Remove-BetaSubscription -BetaId $Id
Remove-BetaSubscription -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaSubscription -BetaId $Id
# Remove-BetaSubscription -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSubscription"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-subscriptions
Gets a list of all trigger subscriptions.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-subscriptions)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -272,21 +284,24 @@ $Sorters = "triggerName" # String | Sort results using the standard syntax descr
# List Subscriptions
try {
Get-BetaSubscriptions
Get-BetaSubscriptions
# Below is a request that includes all optional parameters
# Get-BetaSubscriptions -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters
# Get-BetaSubscriptions -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSubscriptions"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-trigger-invocation-status
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/beta/list-trigger-invocation-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -324,19 +339,22 @@ $Sorters = "created" # String | Sort results using the standard syntax described
# List Latest Invocation Statuses
try {
Get-BetaTriggerInvocationStatus
Get-BetaTriggerInvocationStatus
# Below is a request that includes all optional parameters
# Get-BetaTriggerInvocationStatus -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters
# Get-BetaTriggerInvocationStatus -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTriggerInvocationStatus"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-triggers
Gets a list of triggers that are available in the tenant.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-triggers)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -374,21 +392,24 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
# List Triggers
try {
Get-BetaTriggers
Get-BetaTriggers
# Below is a request that includes all optional parameters
# Get-BetaTriggers -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters
# Get-BetaTriggers -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTriggers"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-subscription
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/beta/patch-subscription)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -423,19 +444,22 @@ $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | ID of the Subscription t
try {
$Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner
Update-BetaSubscription -BetaId $Id -BetaSubscriptionPatchRequestInner $Result
Update-BetaSubscription -Id $Id -BetaSubscriptionPatchRequestInner $Result
# Below is a request that includes all optional parameters
# Update-BetaSubscription -BetaId $Id -BetaSubscriptionPatchRequestInner $SubscriptionPatchRequestInner
# Update-BetaSubscription -Id $Id -BetaSubscriptionPatchRequestInner $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSubscription"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-test-trigger-invocation
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/beta/start-test-trigger-invocation)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -476,20 +500,23 @@ $TestInvocation = @"{
try {
$Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation
Start-BetaTestTriggerInvocation -BetaTestInvocation $Result
Start-BetaTestTriggerInvocation -BetaTestInvocation $Result
# Below is a request that includes all optional parameters
# Start-BetaTestTriggerInvocation -BetaTestInvocation $TestInvocation
# Start-BetaTestTriggerInvocation -BetaTestInvocation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaTestTriggerInvocation"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## test-subscription-filter
Validates a JSONPath filter expression against a provided mock input.
Request requires a security scope of:
[API Spec](https://developer.sailpoint.com/docs/api/beta/test-subscription-filter)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -525,16 +552,17 @@ $ValidateFilterInputDto = @"{
try {
$Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto
Test-BetaSubscriptionFilter -BetaValidateFilterInputDto $Result
Test-BetaSubscriptionFilter -BetaValidateFilterInputDto $Result
# Below is a request that includes all optional parameters
# Test-BetaSubscriptionFilter -BetaValidateFilterInputDto $ValidateFilterInputDto
# Test-BetaSubscriptionFilter -BetaValidateFilterInputDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSubscriptionFilter"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-subscription
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:
@@ -547,6 +575,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/beta/update-subscription)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -603,10 +633,10 @@ $SubscriptionPutRequest = @"{
try {
$Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest
Update-BetaSubscription -BetaId $Id -BetaSubscriptionPutRequest $Result
Update-BetaSubscription -Id $Id -BetaSubscriptionPutRequest $Result
# Below is a request that includes all optional parameters
# Update-BetaSubscription -BetaId $Id -BetaSubscriptionPutRequest $SubscriptionPutRequest
# Update-BetaSubscription -Id $Id -BetaSubscriptionPutRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSubscription"
Write-Host $_.ErrorDetails

12
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaUIMetadataApi.md
View File

@@ -21,10 +21,13 @@ Method | HTTP request | Description
[**Get-BetaTenantUiMetadata**](#get-tenant-ui-metadata) | **GET** `/ui-metadata/tenant` | Get a tenant UI metadata
[**Set-BetaTenantUiMetadata**](#set-tenant-ui-metadata) | **PUT** `/ui-metadata/tenant` | Update tenant UI metadata
## get-tenant-ui-metadata
This API endpoint retrieves UI metadata configured for your tenant.
A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-tenant-ui-metadata)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -53,7 +56,7 @@ Code | Description | Data Type
# Get a tenant UI metadata
try {
Get-BetaTenantUiMetadata
Get-BetaTenantUiMetadata
# Below is a request that includes all optional parameters
# Get-BetaTenantUiMetadata
@@ -63,10 +66,13 @@ try {
}
```
[[Back to top]](#)
## set-tenant-ui-metadata
This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI.
A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/set-tenant-ui-metadata)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -102,10 +108,10 @@ $TenantUiMetadataItemUpdateRequest = @"{
try {
$Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest
Set-BetaTenantUiMetadata -BetaTenantUiMetadataItemUpdateRequest $Result
Set-BetaTenantUiMetadata -BetaTenantUiMetadataItemUpdateRequest $Result
# Below is a request that includes all optional parameters
# Set-BetaTenantUiMetadata -BetaTenantUiMetadataItemUpdateRequest $TenantUiMetadataItemUpdateRequest
# Set-BetaTenantUiMetadata -BetaTenantUiMetadataItemUpdateRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTenantUiMetadata"
Write-Host $_.ErrorDetails

19
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaVendorConnectorMappingsApi.md
View File

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

91
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkItemsApi.md
View File

@@ -45,9 +45,12 @@ Method | HTTP request | Description
[**Deny-BetaApprovalItemsInBulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items
[**Submit-BetaAccountSelection**](#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/beta/approve-approval-item)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -77,19 +80,22 @@ $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the ap
# Approve an Approval Item
try {
Approve-BetaApprovalItem -BetaId $Id -BetaApprovalItemId $ApprovalItemId
Approve-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId
# Below is a request that includes all optional parameters
# Approve-BetaApprovalItem -BetaId $Id -BetaApprovalItemId $ApprovalItemId
# Approve-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItem"
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/beta/approve-approval-items-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -117,19 +123,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
# Bulk approve Approval Items
try {
Approve-BetaApprovalItemsInBulk -BetaId $Id
Approve-BetaApprovalItemsInBulk -Id $Id
# Below is a request that includes all optional parameters
# Approve-BetaApprovalItemsInBulk -BetaId $Id
# Approve-BetaApprovalItemsInBulk -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItemsInBulk"
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/beta/complete-work-item)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -157,19 +166,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
# Complete a Work Item
try {
Complete-BetaWorkItem -BetaId $Id
Complete-BetaWorkItem -Id $Id
# Below is a request that includes all optional parameters
# Complete-BetaWorkItem -BetaId $Id
# Complete-BetaWorkItem -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaWorkItem"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## forward-work-item
This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request.
[API Spec](https://developer.sailpoint.com/docs/api/beta/forward-work-item)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -206,19 +218,22 @@ $WorkItemForward = @"{
try {
$Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward
Invoke-BetaForwardWorkItem -BetaId $Id -BetaWorkItemForward $Result
Invoke-BetaForwardWorkItem -Id $Id -BetaWorkItemForward $Result
# Below is a request that includes all optional parameters
# Invoke-BetaForwardWorkItem -BetaId $Id -BetaWorkItemForward $WorkItemForward
# Invoke-BetaForwardWorkItem -Id $Id -BetaWorkItemForward $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardWorkItem"
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/beta/get-completed-work-items)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -252,19 +267,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Completed Work Items
try {
Get-BetaCompletedWorkItems
Get-BetaCompletedWorkItems
# Below is a request that includes all optional parameters
# Get-BetaCompletedWorkItems -BetaOwnerId $OwnerId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count
# Get-BetaCompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedWorkItems"
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/beta/get-count-completed-work-items)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -292,19 +310,22 @@ $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional)
# Count Completed Work Items
try {
Get-BetaCountCompletedWorkItems
Get-BetaCountCompletedWorkItems
# Below is a request that includes all optional parameters
# Get-BetaCountCompletedWorkItems -BetaOwnerId $OwnerId
# Get-BetaCountCompletedWorkItems -OwnerId $OwnerId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountCompletedWorkItems"
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/beta/get-count-work-items)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -332,19 +353,22 @@ $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional)
# Count Work Items
try {
Get-BetaCountWorkItems
Get-BetaCountWorkItems
# Below is a request that includes all optional parameters
# Get-BetaCountWorkItems -BetaOwnerId $OwnerId
# Get-BetaCountWorkItems -OwnerId $OwnerId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountWorkItems"
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/beta/get-work-item)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -374,19 +398,22 @@ $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional)
# Get a Work Item
try {
Get-BetaWorkItem -BetaId $Id
Get-BetaWorkItem -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaWorkItem -BetaId $Id -BetaOwnerId $OwnerId
# Get-BetaWorkItem -Id $Id -OwnerId $OwnerId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItem"
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/beta/get-work-items-summary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -414,19 +441,22 @@ $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional)
# Work Items Summary
try {
Get-BetaWorkItemsSummary
Get-BetaWorkItemsSummary
# Below is a request that includes all optional parameters
# Get-BetaWorkItemsSummary -BetaOwnerId $OwnerId
# Get-BetaWorkItemsSummary -OwnerId $OwnerId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItemsSummary"
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/beta/list-work-items)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -460,19 +490,22 @@ $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional)
# List Work Items
try {
Get-BetaWorkItems
Get-BetaWorkItems
# Below is a request that includes all optional parameters
# Get-BetaWorkItems -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaOwnerId $OwnerId
# Get-BetaWorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItems"
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/beta/reject-approval-item)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -502,19 +535,22 @@ $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the ap
# Reject an Approval Item
try {
Deny-BetaApprovalItem -BetaId $Id -BetaApprovalItemId $ApprovalItemId
Deny-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId
# Below is a request that includes all optional parameters
# Deny-BetaApprovalItem -BetaId $Id -BetaApprovalItemId $ApprovalItemId
# Deny-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItem"
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/beta/reject-approval-items-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -542,19 +578,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
# Bulk reject Approval Items
try {
Deny-BetaApprovalItemsInBulk -BetaId $Id
Deny-BetaApprovalItemsInBulk -Id $Id
# Below is a request that includes all optional parameters
# Deny-BetaApprovalItemsInBulk -BetaId $Id
# Deny-BetaApprovalItemsInBulk -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItemsInBulk"
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/beta/submit-account-selection)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -585,10 +624,10 @@ $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Sele
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Submit-BetaAccountSelection -BetaId $Id -BetaRequestBody $Result
Submit-BetaAccountSelection -Id $Id -RequestBody $Result
# Below is a request that includes all optional parameters
# Submit-BetaAccountSelection -BetaId $Id -BetaRequestBody $RequestBody
# Submit-BetaAccountSelection -Id $Id -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaAccountSelection"
Write-Host $_.ErrorDetails

57
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkReassignmentApi.md
View File

@@ -37,9 +37,12 @@ Method | HTTP request | Description
[**Send-BetaReassignmentConfig**](#put-reassignment-config) | **PUT** `/reassignment-configurations/{identityId}` | Update Reassignment Configuration
[**Send-BetaTenantConfiguration**](#put-tenant-configuration) | **PUT** `/reassignment-configurations/tenant-config` | Update Tenant-wide Reassignment Configuration settings
## create-reassignment-configuration
Creates a new Reassignment Configuration for the specified identity.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-reassignment-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -76,19 +79,22 @@ $ConfigurationItemRequest = @"{
try {
$Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest
New-BetaReassignmentConfiguration -BetaConfigurationItemRequest $Result
New-BetaReassignmentConfiguration -BetaConfigurationItemRequest $Result
# Below is a request that includes all optional parameters
# New-BetaReassignmentConfiguration -BetaConfigurationItemRequest $ConfigurationItemRequest
# New-BetaReassignmentConfiguration -BetaConfigurationItemRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaReassignmentConfiguration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-reassignment-configuration
Deletes a single reassignment configuration for the specified identity
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-reassignment-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -120,19 +126,22 @@ $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum |
# Delete Reassignment Configuration
try {
Remove-BetaReassignmentConfiguration -BetaIdentityId $IdentityId -BetaConfigType $ConfigType
Remove-BetaReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType
# Below is a request that includes all optional parameters
# Remove-BetaReassignmentConfiguration -BetaIdentityId $IdentityId -BetaConfigType $ConfigType
# Remove-BetaReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaReassignmentConfiguration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-evaluate-reassignment-configuration
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/beta/get-evaluate-reassignment-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -168,19 +177,22 @@ $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ # String[] | Exclusion filters th
# Evaluate Reassignment Configuration
try {
Get-BetaEvaluateReassignmentConfiguration -BetaIdentityId $IdentityId -BetaConfigType $ConfigType
Get-BetaEvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType
# Below is a request that includes all optional parameters
# Get-BetaEvaluateReassignmentConfiguration -BetaIdentityId $IdentityId -BetaConfigType $ConfigType -BetaExclusionFilters $ExclusionFilters
# Get-BetaEvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -ExclusionFilters $ExclusionFilters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEvaluateReassignmentConfiguration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-reassignment-config-types
Gets a collection of types which are available in the Reassignment Configuration UI.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-reassignment-config-types)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -208,7 +220,7 @@ Code | Description | Data Type
# List Reassignment Config Types
try {
Get-BetaReassignmentConfigTypes
Get-BetaReassignmentConfigTypes
# Below is a request that includes all optional parameters
# Get-BetaReassignmentConfigTypes
@@ -218,9 +230,12 @@ try {
}
```
[[Back to top]](#)
## get-reassignment-configuration
Gets the Reassignment Configuration for an identity.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-reassignment-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -251,19 +266,22 @@ $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id
# Get Reassignment Configuration
try {
Get-BetaReassignmentConfiguration -BetaIdentityId $IdentityId
Get-BetaReassignmentConfiguration -IdentityId $IdentityId
# Below is a request that includes all optional parameters
# Get-BetaReassignmentConfiguration -BetaIdentityId $IdentityId
# Get-BetaReassignmentConfiguration -IdentityId $IdentityId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfiguration"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-tenant-config-configuration
Gets the global Reassignment Configuration settings for the requestor's tenant.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-tenant-config-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -292,7 +310,7 @@ Code | Description | Data Type
# Get Tenant-wide Reassignment Configuration settings
try {
Get-BetaTenantConfigConfiguration
Get-BetaTenantConfigConfiguration
# Below is a request that includes all optional parameters
# Get-BetaTenantConfigConfiguration
@@ -302,9 +320,12 @@ try {
}
```
[[Back to top]](#)
## list-reassignment-configurations
Gets all Reassignment configuration for the current org.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-reassignment-configurations)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -333,7 +354,7 @@ Code | Description | Data Type
# List Reassignment Configurations
try {
Get-BetaReassignmentConfigurations
Get-BetaReassignmentConfigurations
# Below is a request that includes all optional parameters
# Get-BetaReassignmentConfigurations
@@ -343,9 +364,12 @@ try {
}
```
[[Back to top]](#)
## put-reassignment-config
Replaces existing Reassignment configuration for an identity with the newly provided configuration.
[API Spec](https://developer.sailpoint.com/docs/api/beta/put-reassignment-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -384,19 +408,22 @@ $ConfigurationItemRequest = @"{
try {
$Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest
Send-BetaReassignmentConfig -BetaIdentityId $IdentityId -BetaConfigurationItemRequest $Result
Send-BetaReassignmentConfig -IdentityId $IdentityId -BetaConfigurationItemRequest $Result
# Below is a request that includes all optional parameters
# Send-BetaReassignmentConfig -BetaIdentityId $IdentityId -BetaConfigurationItemRequest $ConfigurationItemRequest
# Send-BetaReassignmentConfig -IdentityId $IdentityId -BetaConfigurationItemRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaReassignmentConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-tenant-configuration
Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings.
[API Spec](https://developer.sailpoint.com/docs/api/beta/put-tenant-configuration)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -431,10 +458,10 @@ $TenantConfigurationRequest = @"{
try {
$Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest
Send-BetaTenantConfiguration -BetaTenantConfigurationRequest $Result
Send-BetaTenantConfiguration -BetaTenantConfigurationRequest $Result
# Below is a request that includes all optional parameters
# Send-BetaTenantConfiguration -BetaTenantConfigurationRequest $TenantConfigurationRequest
# Send-BetaTenantConfiguration -BetaTenantConfigurationRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTenantConfiguration"
Write-Host $_.ErrorDetails

122
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkflowsApi.md
View File

@@ -37,9 +37,12 @@ Method | HTTP request | Description
[**Test-BetaWorkflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test Workflow By Id
[**Update-BetaWorkflow**](#update-workflow) | **PUT** `/workflows/{id}` | Update Workflow
## cancel-workflow-execution
Use this API to cancel a running workflow execution.
[API Spec](https://developer.sailpoint.com/docs/api/beta/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-BetaWorkflowExecution -BetaId $Id
Suspend-BetaWorkflowExecution -Id $Id
# Below is a request that includes all optional parameters
# Suspend-BetaWorkflowExecution -BetaId $Id
# Suspend-BetaWorkflowExecution -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaWorkflowExecution"
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/beta/create-workflow)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -113,19 +119,22 @@ $CreateWorkflowRequest = @"{name=Send Email, owner={type=IDENTITY, id=2c91808568
try {
$Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest
New-BetaWorkflow -BetaCreateWorkflowRequest $Result
New-BetaWorkflow -BetaCreateWorkflowRequest $Result
# Below is a request that includes all optional parameters
# New-BetaWorkflow -BetaCreateWorkflowRequest $CreateWorkflowRequest
# New-BetaWorkflow -BetaCreateWorkflowRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkflow"
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/beta/delete-workflow)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -155,19 +164,22 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow
# Delete Workflow By Id
try {
Remove-BetaWorkflow -BetaId $Id
Remove-BetaWorkflow -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaWorkflow -BetaId $Id
# Remove-BetaWorkflow -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkflow"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-workflow
Get a single workflow by id.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-workflow)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -197,19 +209,22 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
# Get Workflow By Id
try {
Get-BetaWorkflow -BetaId $Id
Get-BetaWorkflow -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaWorkflow -BetaId $Id
# Get-BetaWorkflow -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflow"
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/beta/get-workflow-execution)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -240,19 +255,22 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID.
# Get Workflow Execution
try {
Get-BetaWorkflowExecution -BetaId $Id
Get-BetaWorkflowExecution -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaWorkflowExecution -BetaId $Id
# Get-BetaWorkflowExecution -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecution"
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/beta/get-workflow-execution-history)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -283,16 +301,17 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execu
# Get Workflow Execution History
try {
Get-BetaWorkflowExecutionHistory -BetaId $Id
Get-BetaWorkflowExecutionHistory -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaWorkflowExecutionHistory -BetaId $Id
# Get-BetaWorkflowExecutionHistory -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutionHistory"
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.
@@ -306,6 +325,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/beta/get-workflow-executions)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -344,19 +365,22 @@ $Filters = 'status eq "Failed"' # String | Filter results using the standard syn
# List Workflow Executions
try {
Get-BetaWorkflowExecutions -BetaId $Id
Get-BetaWorkflowExecutions -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaWorkflowExecutions -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters
# Get-BetaWorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions"
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/beta/list-complete-workflow-library)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -388,19 +412,22 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
# List Complete Workflow Library
try {
Get-BetaCompleteWorkflowLibrary
Get-BetaCompleteWorkflowLibrary
# Below is a request that includes all optional parameters
# Get-BetaCompleteWorkflowLibrary -BetaLimit $Limit -BetaOffset $Offset
# Get-BetaCompleteWorkflowLibrary -Limit $Limit -Offset $Offset
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompleteWorkflowLibrary"
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/beta/list-workflow-library-actions)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -434,19 +461,22 @@ $Filters = 'id eq "sp:create-campaign"' # String | Filter results using the stan
# List Workflow Library Actions
try {
Get-BetaWorkflowLibraryActions
Get-BetaWorkflowLibraryActions
# Below is a request that includes all optional parameters
# Get-BetaWorkflowLibraryActions -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters
# Get-BetaWorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryActions"
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/beta/list-workflow-library-operators)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -474,7 +504,7 @@ Code | Description | Data Type
# List Workflow Library Operators
try {
Get-BetaWorkflowLibraryOperators
Get-BetaWorkflowLibraryOperators
# Below is a request that includes all optional parameters
# Get-BetaWorkflowLibraryOperators
@@ -484,9 +514,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/beta/list-workflow-library-triggers)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -520,19 +553,22 @@ $Filters = 'id eq "idn:identity-attributes-changed"' # String | Filter results u
# List Workflow Library Triggers
try {
Get-BetaWorkflowLibraryTriggers
Get-BetaWorkflowLibraryTriggers
# Below is a request that includes all optional parameters
# Get-BetaWorkflowLibraryTriggers -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters
# Get-BetaWorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryTriggers"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-workflows
List all workflows in the tenant.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-workflows)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -560,7 +596,7 @@ Code | Description | Data Type
# List Workflows
try {
Get-BetaWorkflows
Get-BetaWorkflows
# Below is a request that includes all optional parameters
# Get-BetaWorkflows
@@ -570,9 +606,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/beta/patch-workflow)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -610,19 +649,22 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-BetaWorkflow -BetaId $Id -BetaJsonPatchOperation $Result
Update-BetaWorkflow -Id $Id -BetaJsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-BetaWorkflow -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation
# Update-BetaWorkflow -Id $Id -BetaJsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## post-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/beta/post-external-execute-workflow)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -654,19 +696,22 @@ $PostExternalExecuteWorkflowRequest = @""@
# Execute Workflow via External Trigger
try {
Submit-BetaExternalExecuteWorkflow -BetaId $Id
Submit-BetaExternalExecuteWorkflow -Id $Id
# Below is a request that includes all optional parameters
# Submit-BetaExternalExecuteWorkflow -BetaId $Id -BetaPostExternalExecuteWorkflowRequest $PostExternalExecuteWorkflowRequest
# Submit-BetaExternalExecuteWorkflow -Id $Id -BetaPostExternalExecuteWorkflowRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaExternalExecuteWorkflow"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## post-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/beta/post-workflow-external-trigger)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -696,19 +741,22 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
# Generate External Trigger OAuth Client
try {
Submit-BetaWorkflowExternalTrigger -BetaId $Id
Submit-BetaWorkflowExternalTrigger -Id $Id
# Below is a request that includes all optional parameters
# Submit-BetaWorkflowExternalTrigger -BetaId $Id
# Submit-BetaWorkflowExternalTrigger -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaWorkflowExternalTrigger"
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/beta/test-external-execute-workflow)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -740,21 +788,24 @@ $TestExternalExecuteWorkflowRequest = @""@
# Test Workflow via External Trigger
try {
Test-BetaExternalExecuteWorkflow -BetaId $Id
Test-BetaExternalExecuteWorkflow -Id $Id
# Below is a request that includes all optional parameters
# Test-BetaExternalExecuteWorkflow -BetaId $Id -BetaTestExternalExecuteWorkflowRequest $TestExternalExecuteWorkflowRequest
# Test-BetaExternalExecuteWorkflow -Id $Id -BetaTestExternalExecuteWorkflowRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaExternalExecuteWorkflow"
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/beta/test-workflow)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -787,19 +838,22 @@ $TestWorkflowRequest = @"{input={identity={id=ee769173319b41d19ccec6cea52f237b,
try {
$Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest
Test-BetaWorkflow -BetaId $Id -BetaTestWorkflowRequest $Result
Test-BetaWorkflow -Id $Id -BetaTestWorkflowRequest $Result
# Below is a request that includes all optional parameters
# Test-BetaWorkflow -BetaId $Id -BetaTestWorkflowRequest $TestWorkflowRequest
# Test-BetaWorkflow -Id $Id -BetaTestWorkflowRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-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/beta/update-workflow)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -869,10 +923,10 @@ $WorkflowBody = @"{
try {
$Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody
Update-BetaWorkflow -BetaId $Id -BetaWorkflowBody $Result
Update-BetaWorkflow -Id $Id -BetaWorkflowBody $Result
# Below is a request that includes all optional parameters
# Update-BetaWorkflow -BetaId $Id -BetaWorkflowBody $WorkflowBody
# Update-BetaWorkflow -Id $Id -BetaWorkflowBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow"
Write-Host $_.ErrorDetails

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

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