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: 13122455471

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-03 20:42:04 +00:00
parent aeda961e54
commit bdb088c15d
207 changed files with 3520 additions and 8694 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,3 +1,4 @@
---
id: access-profiles
title: AccessProfiles
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/access-profiles
tags: ['SDK', 'Software Development Kit', 'AccessProfiles', 'AccessProfiles']
---
# AccessProfiles
Use this API to implement and customize access profile functionality.
With this functionality in place, administrators can create access profiles and configure them for use throughout Identity Security Cloud, enabling users to get the access they need quickly and securely.
@@ -60,9 +60,7 @@ Method | HTTP request | Description
[**Get-AccessProfiles**](#list-access-profiles) | **GET** `/access-profiles` | List Access Profiles
[**Update-AccessProfile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified Access Profile
## create-access-profile
Use this API to create an access profile.
A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source.
The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters.
@@ -73,7 +71,6 @@ Param Type | Name | Data Type | Required | Description
Body | AccessProfile | [**AccessProfile**](../models/access-profile) | True |
### Return type
[**AccessProfile**](../models/access-profile)
### Responses
@@ -87,7 +84,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -178,7 +174,9 @@ $AccessProfile = @"{
"id" : "2c91808a7190d06e01719938fcd20792",
"requestable" : true
}"@
# Create Access Profile
try {
$Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile
New-AccessProfile-AccessProfile $Result
@@ -190,11 +188,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-access-profile
This API deletes an existing Access Profile.
The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned.
@@ -207,7 +202,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the Access Profile to delete
### Return type
(empty response body)
### Responses
@@ -221,14 +215,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete
# Delete the specified Access Profile
try {
Remove-AccessProfile-Id $Id
@@ -239,11 +234,8 @@ try {
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.
@@ -256,7 +248,6 @@ Param Type | Name | Data Type | Required | Description
Body | AccessProfileBulkDeleteRequest | [**AccessProfileBulkDeleteRequest**](../models/access-profile-bulk-delete-request) | True |
### Return type
[**AccessProfileBulkDeleteResponse**](../models/access-profile-bulk-delete-response)
### Responses
@@ -271,7 +262,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -281,7 +271,9 @@ $AccessProfileBulkDeleteRequest = @"{
"accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ],
"bestEffortOnly" : true
}"@
# Delete Access Profile(s)
try {
$Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest
Remove-AccessProfilesInBulk-AccessProfileBulkDeleteRequest $Result
@@ -293,11 +285,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-access-profile
This API returns an Access Profile by its ID.
### Parameters
@@ -306,7 +295,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the Access Profile
### Return type
[**AccessProfile**](../models/access-profile)
### Responses
@@ -320,14 +308,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile
# Get an Access Profile
try {
Get-AccessProfile-Id $Id
@@ -338,11 +327,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-access-profile-entitlements
Use this API to get a list of an access profile's entitlements.
A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile.
>**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank.
@@ -358,7 +344,6 @@ Path | Id | **String** | True | ID of the access profile containing the entit
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified**
### Return type
[**Entitlement[]**](../models/entitlement)
### Responses
@@ -372,7 +357,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -384,7 +368,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'attribute eq "memberOf"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional)
$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional)
# List Access Profile's Entitlements
try {
Get-AccessProfileEntitlements-Id $Id
@@ -395,11 +381,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-access-profiles
Use this API to get a list of access profiles.
>**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank.
@@ -416,7 +399,6 @@ Param Type | Name | Data Type | Required | Description
Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
### Return type
[**AccessProfile[]**](../models/access-profile)
### Responses
@@ -430,7 +412,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -444,7 +425,9 @@ $Filters = 'name eq "SailPoint Support"' # String | Filter results using the sta
$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional)
$ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional)
$IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true)
# List Access Profiles
try {
Get-AccessProfiles
@@ -455,11 +438,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-access-profile
This API updates an existing Access Profile. The following fields are patchable:
**name**
@@ -498,7 +478,6 @@ Path | Id | **String** | True | ID of the Access Profile to patch
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True |
### Return type
[**AccessProfile**](../models/access-profile)
### Responses
@@ -512,21 +491,21 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
### Example
```powershell
$Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to patch
# JsonPatchOperation[] |
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] |
# Patch a specified Access Profile
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-AccessProfile-Id $Id -JsonPatchOperation $Result
@@ -538,7 +517,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: access-request-approvals
title: AccessRequestApprovals
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/access-request-approvals
tags: ['SDK', 'Software Development Kit', 'AccessRequestApprovals', 'AccessRequestApprovals']
---
# AccessRequestApprovals
Use this API to implement and customize access request approval functionality.
With this functionality in place, administrators can delegate qualified users to review users' requests for access or managers' requests to revoke team members' access to applications, entitlements, or roles.
@@ -42,9 +42,7 @@ Method | HTTP request | Description
[**Get-PendingApprovals**](#list-pending-approvals) | **GET** `/access-request-approvals/pending` | Pending Access Request Approvals List
[**Deny-AccessRequest**](#reject-access-request) | **POST** `/access-request-approvals/{approvalId}/reject` | Reject Access Request Approval
## approve-access-request
Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.
### Parameters
@@ -54,7 +52,6 @@ Path | ApprovalId | **String** | True | Approval ID.
Body | CommentDto | [**CommentDto**](../models/comment-dto) | (optional) | Reviewer's comment.
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -69,7 +66,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -85,7 +81,9 @@ $CommentDto = @"{
},
"comment" : "This is a comment."
}"@
# Approve Access Request Approval
try {
Approve-AccessRequest-ApprovalId $ApprovalId
@@ -96,11 +94,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## forward-access-request
Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.
### Parameters
@@ -110,7 +105,6 @@ Path | ApprovalId | **String** | True | Approval ID.
Body | ForwardApprovalDto | [**ForwardApprovalDto**](../models/forward-approval-dto) | True | Information about the forwarded approval.
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -125,7 +119,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -136,7 +129,9 @@ $ForwardApprovalDto = @"{
"newOwnerId" : "2c91808568c529c60168cca6f90c1314",
"comment" : "2c91808568c529c60168cca6f90c1313"
}"@
# Forward Access Request Approval
try {
$Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto
Invoke-ForwardAccessRequest-ApprovalId $ApprovalId -ForwardApprovalDto $Result
@@ -148,11 +143,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-access-request-approval-summary
Use this API to return the number of pending, approved and rejected access requests approvals. See the "owner-id" query parameter for authorization information. info.
### Parameters
@@ -162,7 +154,6 @@ Param Type | Name | Data Type | Required | Description
Query | FromDate | **String** | (optional) | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format.
### Return type
[**ApprovalSummary**](../models/approval-summary)
### Responses
@@ -176,7 +167,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -184,7 +174,9 @@ Code | Description | Data Type
```powershell
$OwnerId = "2c91808568c529c60168cca6f90c1313" # String | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional)
$FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional)
# Get Access Requests Approvals Number
try {
Get-AccessRequestApprovalSummary
@@ -195,11 +187,8 @@ try {
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.
### Parameters
@@ -213,7 +202,6 @@ Param Type | Name | Data Type | Required | Description
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified**
### Return type
[**CompletedApproval[]**](../models/completed-approval)
### Responses
@@ -227,7 +215,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -239,7 +226,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional)
$Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional)
# Completed Access Request Approvals List
try {
Get-CompletedApprovals
@@ -250,11 +239,8 @@ try {
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.
### Parameters
@@ -268,7 +254,6 @@ Param Type | Name | Data Type | Required | Description
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified**
### Return type
[**PendingApproval[]**](../models/pending-approval)
### Responses
@@ -282,7 +267,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -294,7 +278,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (optional)
$Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional)
# Pending Access Request Approvals List
try {
Get-PendingApprovals
@@ -305,11 +291,8 @@ try {
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.
### Parameters
@@ -319,7 +302,6 @@ Path | ApprovalId | **String** | True | Approval ID.
Body | CommentDto | [**CommentDto**](../models/comment-dto) | True | Reviewer's comment.
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -334,7 +316,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -350,7 +331,9 @@ $CommentDto = @"{
},
"comment" : "This is a comment."
}"@
# Reject Access Request Approval
try {
$Result = ConvertFrom-JsonToCommentDto -Json $CommentDto
Deny-AccessRequest-ApprovalId $ApprovalId -CommentDto $Result
@@ -362,7 +345,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: access-requests
title: AccessRequests
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/access-requests
tags: ['SDK', 'Software Development Kit', 'AccessRequests', 'AccessRequests']
---
# AccessRequests
Use this API to implement and customize access request functionality.
With this functionality in place, users can request access to applications, entitlements, or roles, and managers can request that team members' access be revoked.
@@ -39,9 +39,7 @@ Method | HTTP request | Description
[**Get-AccessRequestStatus**](#list-access-request-status) | **GET** `/access-request-status` | Access Request Status
[**Set-AccessRequestConfig**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration
## cancel-access-request
This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step.
In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it.
@@ -51,7 +49,6 @@ Param Type | Name | Data Type | Required | Description
Body | CancelAccessRequest | [**CancelAccessRequest**](../models/cancel-access-request) | True |
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -66,7 +63,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -76,7 +72,9 @@ $CancelAccessRequest = @"{
"accountActivityId" : "2c9180835d2e5168015d32f890ca1581",
"comment" : "I requested this role by mistake."
}"@
# Cancel Access Request
try {
$Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest
Suspend-AccessRequest-CancelAccessRequest $Result
@@ -88,11 +86,8 @@ try {
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.
Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request
@@ -131,7 +126,6 @@ Param Type | Name | Data Type | Required | Description
Body | AccessRequest | [**AccessRequest**](../models/access-request) | True |
### Return type
[**AccessRequestResponse**](../models/access-request-response)
### Responses
@@ -145,7 +139,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -205,7 +198,9 @@ $AccessRequest = @"{
"type" : "ACCESS_PROFILE"
} ]
}"@
# Submit Access Request
try {
$Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest
New-AccessRequest-AccessRequest $Result
@@ -217,11 +212,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-access-request-config
This endpoint returns the current access-request configuration.
### Parameters
@@ -229,7 +221,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**AccessRequestConfig**](../models/access-request-config)
### Responses
@@ -243,13 +234,14 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
# Get Access Request Configuration
try {
Get-AccessRequestConfig
@@ -260,11 +252,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[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.
@@ -284,7 +273,6 @@ Param Type | Name | Data Type | Required | Description
Query | RequestState | **String** | (optional) | Filter the results by the state of the request. The only valid value is *EXECUTING*.
### Return type
[**RequestedItemStatus[]**](../models/requested-item-status)
### Responses
@@ -298,7 +286,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -314,7 +301,9 @@ $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *
$Filters = 'accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional)
$Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional)
$RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional)
# Access Request Status
try {
Get-AccessRequestStatus
@@ -325,11 +314,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-access-request-config
This endpoint replaces the current access-request configuration.
### Parameters
@@ -338,7 +324,6 @@ Param Type | Name | Data Type | Required | Description
Body | AccessRequestConfig | [**AccessRequestConfig**](../models/access-request-config) | True |
### Return type
[**AccessRequestConfig**](../models/access-request-config)
### Responses
@@ -352,7 +337,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -384,7 +368,9 @@ $AccessRequestConfig = @"{
"reauthorizationEnabled" : true,
"approvalsMustBeExternal" : true
}"@
# Update Access Request Configuration
try {
$Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig
Set-AccessRequestConfig-AccessRequestConfig $Result
@@ -396,7 +382,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: account-activities
title: AccountActivities
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/account-activities
tags: ['SDK', 'Software Development Kit', 'AccountActivities', 'AccountActivities']
---
# AccountActivities
Use this API to implement account activity tracking functionality.
With this functionality in place, users can track source account activity in Identity Security Cloud, which greatly improves traceability in the system.
@@ -54,9 +54,7 @@ Method | HTTP request | Description
[**Get-AccountActivity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get an Account Activity
[**Get-AccountActivities**](#list-account-activities) | **GET** `/account-activities` | List Account Activities
## get-account-activity
This gets a single account activity by its id.
### Parameters
@@ -65,7 +63,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The account activity id
### Return type
[**AccountActivity**](../models/account-activity)
### Responses
@@ -80,14 +77,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id
# Get an Account Activity
try {
Get-AccountActivity-Id $Id
@@ -98,11 +96,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-account-activities
This gets a collection of account activities that satisfy the given query parameters.
### Parameters
@@ -118,7 +113,6 @@ Param Type | Name | Data Type | Required | Description
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified**
### Return type
[**AccountActivity[]**](../models/account-activity)
### Responses
@@ -132,7 +126,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -146,7 +139,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'type eq "Identity Refresh"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional)
$Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional)
# List Account Activities
try {
Get-AccountActivities
@@ -157,7 +152,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: account-usages
title: AccountUsages
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/account-usages
tags: ['SDK', 'Software Development Kit', 'AccountUsages', 'AccountUsages']
---
# AccountUsages
Use this API to implement account usage insight functionality.
With this functionality in place, administrators can gather information and insights about how their tenants' source accounts are being used.
@@ -23,9 +23,7 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-UsagesByAccountId**](#get-usages-by-account-id) | **GET** `/account-usages/{accountId}/summaries` | Returns account usage insights
## get-usages-by-account-id
This API returns a summary of account usage insights for past 12 months.
### Parameters
@@ -38,7 +36,6 @@ Path | AccountId | **String** | True | ID of IDN account
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date**
### Return type
[**AccountUsage[]**](../models/account-usage)
### Responses
@@ -52,7 +49,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -63,7 +59,9 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional)
# Returns account usage insights
try {
Get-UsagesByAccountId-AccountId $AccountId
@@ -74,7 +72,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: accounts
title: Accounts
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/accounts
tags: ['SDK', 'Software Development Kit', 'Accounts', 'Accounts']
---
# Accounts
Use this API to implement and customize account functionality.
With this functionality in place, administrators can manage users' access across sources in Identity Security Cloud.
@@ -57,9 +57,7 @@ Method | HTTP request | Description
[**Unlock-Account**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock Account
[**Update-Account**](#update-account) | **PATCH** `/accounts/{id}` | Update Account
## create-account
Submit an account creation task - the API then returns the task ID.
You must include the `sourceId` where the account will be created in the `attributes` object.
@@ -79,7 +77,6 @@ Param Type | Name | Data Type | Required | Description
Body | AccountAttributesCreate | [**AccountAttributesCreate**](../models/account-attributes-create) | True |
### Return type
[**AccountsAsyncResult**](../models/accounts-async-result)
### Responses
@@ -93,7 +90,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -109,7 +105,9 @@ $AccountAttributesCreate = @"{
"mail" : "john.doe@sailpoint.com"
}
}"@
# Create Account
try {
$Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate
New-Account-AccountAttributesCreate $Result
@@ -121,11 +119,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-account
Use this API to delete an account.
This endpoint submits an account delete task and returns the task ID.
This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future.
@@ -137,7 +132,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Account ID.
### Return type
[**AccountsAsyncResult**](../models/accounts-async-result)
### Responses
@@ -152,14 +146,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
# Delete Account
try {
Remove-Account-Id $Id
@@ -170,11 +165,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## disable-account
This API submits a task to disable the account and returns the task ID.
### Parameters
@@ -184,7 +176,6 @@ Path | Id | **String** | True | The account id
Body | AccountToggleRequest | [**AccountToggleRequest**](../models/account-toggle-request) | True |
### Return type
[**AccountsAsyncResult**](../models/accounts-async-result)
### Responses
@@ -199,7 +190,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -210,7 +200,9 @@ $AccountToggleRequest = @"{
"forceProvisioning" : false,
"externalVerificationId" : "3f9180835d2e5168015d32f890ca1581"
}"@
# Disable Account
try {
$Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest
Disable-Account-Id $Id -AccountToggleRequest $Result
@@ -222,11 +214,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## enable-account
This API submits a task to enable account and returns the task ID.
### Parameters
@@ -236,7 +225,6 @@ Path | Id | **String** | True | The account id
Body | AccountToggleRequest | [**AccountToggleRequest**](../models/account-toggle-request) | True |
### Return type
[**AccountsAsyncResult**](../models/accounts-async-result)
### Responses
@@ -251,7 +239,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -262,7 +249,9 @@ $AccountToggleRequest = @"{
"forceProvisioning" : false,
"externalVerificationId" : "3f9180835d2e5168015d32f890ca1581"
}"@
# Enable Account
try {
$Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest
Enable-Account-Id $Id -AccountToggleRequest $Result
@@ -274,11 +263,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-account
Use this API to return the details for a single account by its ID.
### Parameters
@@ -287,7 +273,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Account ID.
### Return type
[**Account**](../models/account)
### Responses
@@ -302,14 +287,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
# Account Details
try {
Get-Account-Id $Id
@@ -320,11 +306,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-account-entitlements
This API returns entitlements of the account.
### Parameters
@@ -336,7 +319,6 @@ Path | Id | **String** | True | The account id
Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
### Return type
[**EntitlementDto[]**](../models/entitlement-dto)
### Responses
@@ -351,7 +333,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -361,7 +342,9 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
# Account Entitlements
try {
Get-AccountEntitlements-Id $Id
@@ -372,11 +355,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-accounts
List accounts.
### Parameters
@@ -390,7 +370,6 @@ Param Type | Name | Data Type | Required | Description
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType**
### Return type
[**Account[]**](../models/account)
### Responses
@@ -404,7 +383,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -416,7 +394,9 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional)
$Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* (optional)
$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional)
# Accounts List
try {
Get-Accounts
@@ -427,11 +407,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-account
Use this API to update an account with a PUT request.
This endpoint submits an account update task and returns the task ID.
@@ -446,7 +423,6 @@ Path | Id | **String** | True | Account ID.
Body | AccountAttributes | [**AccountAttributes**](../models/account-attributes) | True |
### Return type
[**AccountsAsyncResult**](../models/accounts-async-result)
### Responses
@@ -461,7 +437,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -477,7 +452,9 @@ $AccountAttributes = @"{
"mail" : "john.doe@sailpoint.com"
}
}"@
# Update Account
try {
$Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes
Send-Account-Id $Id -AccountAttributes $Result
@@ -489,11 +466,8 @@ try {
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.
### Parameters
@@ -502,7 +476,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The account id
### Return type
[**AccountsAsyncResult**](../models/accounts-async-result)
### Responses
@@ -517,14 +490,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id
# Reload Account
try {
Submit-ReloadAccount-Id $Id
@@ -535,11 +509,8 @@ try {
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.
@@ -550,7 +521,6 @@ Path | Id | **String** | True | The account ID.
Body | AccountUnlockRequest | [**AccountUnlockRequest**](../models/account-unlock-request) | True |
### Return type
[**AccountsAsyncResult**](../models/accounts-async-result)
### Responses
@@ -565,7 +535,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -577,7 +546,9 @@ $AccountUnlockRequest = @"{
"externalVerificationId" : "3f9180835d2e5168015d32f890ca1581",
"unlockIDNAccount" : false
}"@
# Unlock Account
try {
$Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest
Unlock-Account-Id $Id -AccountUnlockRequest $Result
@@ -589,11 +560,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-account
Use this API to update account details.
This API supports updating an account's correlation by modifying the `identityId` and `manuallyCorrelated` fields.
@@ -613,7 +581,6 @@ Path | Id | **String** | True | Account ID.
Body | RequestBody | [**[]SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | True | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -628,7 +595,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
@@ -636,9 +602,11 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
$RequestBody = # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
$RequestBody = @"[{op=remove, path=/identityId}]"@
$RequestBody = @"[{op=remove, path=/identityId}]"@ # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
# Update Account
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Update-Account-Id $Id -RequestBody $Result
@@ -650,7 +618,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: application-discovery
title: ApplicationDiscovery
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/application-discovery
tags: ['SDK', 'Software Development Kit', 'ApplicationDiscovery', 'ApplicationDiscovery']
---
# ApplicationDiscovery
Use this API to implement application discovery functionality.
With this functionality in place, you can discover applications within your Okta connector and receive connector recommendations by manually uploading application names.
@@ -24,9 +24,7 @@ Method | HTTP request | Description
[**Get-ManualDiscoverApplicationsCsvTemplate**](#get-manual-discover-applications-csv-template) | **GET** `/manual-discover-applications-template` | Download CSV Template for Discovery
[**Send-ManualDiscoverApplicationsCsvTemplate**](#send-manual-discover-applications-csv-template) | **POST** `/manual-discover-applications` | Upload CSV to Discover Applications
## get-discovered-applications
Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors.
@@ -40,7 +38,6 @@ Param Type | Name | Data Type | Required | Description
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource**
### Return type
[**GetDiscoveredApplications200ResponseInner[]**](../models/get-discovered-applications200-response-inner)
### Responses
@@ -54,7 +51,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -65,7 +61,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional)
$Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional)
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional)
# Get Discovered Applications for Tenant
try {
Get-DiscoveredApplications
@@ -76,11 +74,8 @@ try {
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.
@@ -91,7 +86,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**ManualDiscoverApplicationsTemplate**](../models/manual-discover-applications-template)
### Responses
@@ -105,13 +99,14 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/csv, application/json
### Example
```powershell
# Download CSV Template for Discovery
try {
Get-ManualDiscoverApplicationsCsvTemplate
@@ -122,11 +117,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## send-manual-discover-applications-csv-template
Uploading a CSV file with application data for manual correlation to specific ISC connectors.
If a suitable ISC connector is unavailable, the system will recommend generic connectors instead.
@@ -136,7 +128,6 @@ Param Type | Name | Data Type | Required | Description
| File | **System.IO.FileInfo** | True | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered.
### Return type
(empty response body)
### Responses
@@ -150,14 +141,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
### Example
```powershell
$File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered.
# Upload CSV to Discover Applications
try {
Send-ManualDiscoverApplicationsCsvTemplate-File $File
@@ -168,7 +160,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: auth-users
title: AuthUsers
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/auth-users
tags: ['SDK', 'Software Development Kit', 'AuthUsers', 'AuthUsers']
---
# AuthUsers
Use this API to implement user authentication system functionality.
With this functionality in place, users can get a user's authentication system details, including their capabilities, and modify those capabilities.
@@ -26,9 +26,7 @@ Method | HTTP request | Description
[**Get-AuthUser**](#get-auth-user) | **GET** `/auth-users/{id}` | Auth User Details
[**Update-AuthUser**](#patch-auth-user) | **PATCH** `/auth-users/{id}` | Auth User Update
## get-auth-user
Return the specified user's authentication system details.
### Parameters
@@ -37,7 +35,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Identity ID
### Return type
[**AuthUser**](../models/auth-user)
### Responses
@@ -52,14 +49,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID
# Auth User Details
try {
Get-AuthUser-Id $Id
@@ -70,11 +68,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-auth-user
Use a PATCH request to update an existing user in the authentication system.
Use this endpoint to modify these fields:
* `capabilities`
@@ -88,7 +83,6 @@ Path | Id | **String** | True | Identity ID
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
### Return type
[**AuthUser**](../models/auth-user)
### Responses
@@ -103,21 +97,21 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID
# JsonPatchOperation[] | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
# Auth User Update
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-AuthUser-Id $Id -JsonPatchOperation $Result
@@ -129,7 +123,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: branding
title: Branding
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/branding
tags: ['SDK', 'Software Development Kit', 'Branding', 'Branding']
---
# Branding
Use this API to implement and customize branding functionality.
With this functionality in place, administrators can get and manage existing branding items, and they can also create new branding items and configure them for use throughout Identity Security Cloud.
@@ -29,9 +29,7 @@ Method | HTTP request | Description
[**Get-BrandingList**](#get-branding-list) | **GET** `/brandings` | List of branding items
[**Set-BrandingItem**](#set-branding-item) | **PUT** `/brandings/{name}` | Update a branding item
## create-branding-item
This API endpoint creates a branding item.
### Parameters
@@ -47,7 +45,6 @@ Param Type | Name | Data Type | Required | Description
| FileStandard | **System.IO.FileInfo** | (optional) | png file with logo
### Return type
[**BrandingItem**](../models/branding-item)
### Responses
@@ -61,7 +58,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
@@ -75,7 +71,9 @@ $NavigationColor = "MyNavigationColor" # String | hex value of color for navigat
$EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional)
$LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional)
$FileStandard = # System.IO.FileInfo | png file with logo (optional)
# Create a branding item
try {
New-BrandingItem-Name $Name -ProductName $ProductName
@@ -86,11 +84,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-branding
This API endpoint delete information for an existing branding item by name.
### Parameters
@@ -99,7 +94,6 @@ Param Type | Name | Data Type | Required | Description
Path | Name | **String** | True | The name of the branding item to be deleted
### Return type
(empty response body)
### Responses
@@ -114,14 +108,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Name = "default" # String | The name of the branding item to be deleted
# Delete a branding item
try {
Remove-Branding-Name $Name
@@ -132,11 +127,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-branding
This API endpoint retrieves information for an existing branding item by name.
### Parameters
@@ -145,7 +137,6 @@ Param Type | Name | Data Type | Required | Description
Path | Name | **String** | True | The name of the branding item to be retrieved
### Return type
[**BrandingItem**](../models/branding-item)
### Responses
@@ -160,14 +151,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Name = "default" # String | The name of the branding item to be retrieved
# Get a branding item
try {
Get-Branding-Name $Name
@@ -178,11 +170,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-branding-list
This API endpoint returns a list of branding items.
### Parameters
@@ -190,7 +179,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**BrandingItem[]**](../models/branding-item)
### Responses
@@ -204,13 +192,14 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
# List of branding items
try {
Get-BrandingList
@@ -221,11 +210,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-branding-item
This API endpoint updates information for an existing branding item.
### Parameters
@@ -242,7 +228,6 @@ Path | Name | **String** | True | The name of the branding item to be retriev
| FileStandard | **System.IO.FileInfo** | (optional) | png file with logo
### Return type
[**BrandingItem**](../models/branding-item)
### Responses
@@ -257,7 +242,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
@@ -272,7 +256,9 @@ $NavigationColor = "MyNavigationColor" # String | hex value of color for navigat
$EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional)
$LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional)
$FileStandard = # System.IO.FileInfo | png file with logo (optional)
# Update a branding item
try {
Set-BrandingItem-Name $Name -Name2 $Name2 -ProductName $ProductName
@@ -283,7 +269,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: certification-campaign-filters
title: CertificationCampaignFilters
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/certification-campaign-filters
tags: ['SDK', 'Software Development Kit', 'CertificationCampaignFilters', 'CertificationCampaignFilters']
---
# CertificationCampaignFilters
Use this API to implement the certification campaign filter functionality. These filters can be used to create a certification campaign that includes a subset of your entitlements or users to certify.
@@ -51,9 +51,7 @@ Method | HTTP request | Description
[**Get-CampaignFilters**](#list-campaign-filters) | **GET** `/campaign-filters` | List Campaign Filters
[**Update-CampaignFilter**](#update-campaign-filter) | **POST** `/campaign-filters/{id}` | Updates a Campaign Filter
## create-campaign-filter
Use this API to create a campaign filter based on filter details and criteria.
### Parameters
@@ -62,7 +60,6 @@ Param Type | Name | Data Type | Required | Description
Body | CampaignFilterDetails | [**CampaignFilterDetails**](../models/campaign-filter-details) | True |
### Return type
[**CampaignFilterDetails**](../models/campaign-filter-details)
### Responses
@@ -76,7 +73,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -100,7 +96,9 @@ $CampaignFilterDetails = @"{
"suppressMatchedItems" : false
} ]
}"@
# Create Campaign Filter
try {
$Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails
New-CampaignFilter-CampaignFilterDetails $Result
@@ -112,11 +110,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-campaign-filters
Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN.
### Parameters
@@ -125,7 +120,6 @@ Param Type | Name | Data Type | Required | Description
Body | RequestBody | **[]String** | True | A json list of IDs of campaign filters to delete.
### Return type
(empty response body)
### Responses
@@ -140,16 +134,17 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```powershell
$RequestBody = "MyRequestBody" # String[] | A json list of IDs of campaign filters to delete.
$RequestBody = @""@
$RequestBody = @""@ # String[] | A json list of IDs of campaign filters to delete.
# Deletes Campaign Filters
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Remove-CampaignFilters-RequestBody $Result
@@ -161,11 +156,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-campaign-filter-by-id
Retrieves information for an existing campaign filter using the filter's ID.
### Parameters
@@ -174,7 +166,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The ID of the campaign filter to be retrieved.
### Return type
[**CampaignFilterDetails**](../models/campaign-filter-details)
### Responses
@@ -189,14 +180,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter to be retrieved.
# Get Campaign Filter by ID
try {
Get-CampaignFilterById-Id $Id
@@ -207,11 +199,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-campaign-filters
Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters.
### Parameters
@@ -222,7 +211,6 @@ Param Type | Name | Data Type | Required | Description
Query | IncludeSystemFilters | **Boolean** | (optional) (default to $true) | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true.
### Return type
[**ListCampaignFilters200Response**](../models/list-campaign-filters200-response)
### Responses
@@ -236,7 +224,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -245,7 +232,9 @@ Code | Description | Data Type
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Start = 0 # Int32 | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$IncludeSystemFilters = $true # Boolean | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to $true)
# List Campaign Filters
try {
Get-CampaignFilters
@@ -256,11 +245,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-campaign-filter
Updates an existing campaign filter using the filter's ID.
### Parameters
@@ -270,7 +256,6 @@ Path | FilterId | **String** | True | The ID of the campaign filter being mod
Body | CampaignFilterDetails | [**CampaignFilterDetails**](../models/campaign-filter-details) | True | A campaign filter details with updated field values.
### Return type
[**CampaignFilterDetails**](../models/campaign-filter-details)
### Responses
@@ -284,7 +269,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -309,7 +293,9 @@ $CampaignFilterDetails = @"{
"suppressMatchedItems" : false
} ]
}"@
# Updates a Campaign Filter
try {
$Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails
Update-CampaignFilter-FilterId $FilterId -CampaignFilterDetails $Result
@@ -321,7 +307,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: certification-campaigns
title: CertificationCampaigns
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/certification-campaigns
tags: ['SDK', 'Software Development Kit', 'CertificationCampaigns', 'CertificationCampaigns']
---
# CertificationCampaigns
Use this API to implement certification campaign functionality.
With this functionality in place, administrators can create, customize, and manage certification campaigns for their organizations' use.
@@ -106,9 +106,7 @@ Method | HTTP request | Description
[**Start-GenerateCampaignTemplate**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a Campaign from Template
[**Update-Campaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a Campaign
## complete-campaign
:::caution
This endpoint will run successfully for any campaigns that are **past due**.
@@ -128,7 +126,6 @@ Path | Id | **String** | True | Campaign ID.
Body | CampaignCompleteOptions | [**CampaignCompleteOptions**](../models/campaign-complete-options) | (optional) | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -143,7 +140,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -153,7 +149,9 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID.
$CampaignCompleteOptions = @"{
"autoCompleteAction" : "REVOKE"
}"@
# Complete a Campaign
try {
Complete-Campaign-Id $Id
@@ -164,11 +162,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-campaign
Use this API to create a certification campaign with the information provided in the request body.
@@ -178,7 +173,6 @@ Param Type | Name | Data Type | Required | Description
Body | Campaign | [**Campaign**](../models/campaign) | True |
### Return type
[**Campaign**](../models/campaign)
### Responses
@@ -192,7 +186,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -307,7 +300,9 @@ $Campaign = @"{
"status" : "ACTIVE",
"correlatedStatus" : "CORRELATED"
}"@
# Create a campaign
try {
$Result = ConvertFrom-JsonToCampaign -Json $Campaign
New-Campaign-Campaign $Result
@@ -319,11 +314,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-campaign-template
Use this API to create a certification campaign template based on campaign.
@@ -333,7 +325,6 @@ Param Type | Name | Data Type | Required | Description
Body | CampaignTemplate | [**CampaignTemplate**](../models/campaign-template) | True |
### Return type
[**CampaignTemplate**](../models/campaign-template)
### Responses
@@ -347,7 +338,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -477,7 +467,9 @@ $CampaignTemplate = @"{
},
"id" : "2c9079b270a266a60170a277bb960008"
}"@
# Create a Campaign Template
try {
$Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate
New-CampaignTemplate-CampaignTemplate $Result
@@ -489,11 +481,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-campaign-template
Use this API to delete a certification campaign template by ID.
@@ -503,7 +492,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the campaign template being deleted.
### Return type
(empty response body)
### Responses
@@ -518,14 +506,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted.
# Delete a Campaign Template
try {
Remove-CampaignTemplate-Id $Id
@@ -536,11 +525,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-campaign-template-schedule
Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set.
@@ -550,7 +536,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the campaign template whose schedule is being deleted.
### Return type
(empty response body)
### Responses
@@ -565,14 +550,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted.
# Delete Campaign Template Schedule
try {
Remove-CampaignTemplateSchedule-Id $Id
@@ -583,11 +569,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-campaigns
Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs.
@@ -597,7 +580,6 @@ Param Type | Name | Data Type | Required | Description
Body | CampaignsDeleteRequest | [**CampaignsDeleteRequest**](../models/campaigns-delete-request) | True | IDs of the campaigns to delete.
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -612,7 +594,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -621,7 +602,9 @@ Code | Description | Data Type
$CampaignsDeleteRequest = @"{
"ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ]
}"@
# Delete Campaigns
try {
$Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest
Remove-Campaigns-CampaignsDeleteRequest $Result
@@ -633,11 +616,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-active-campaigns
Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query.
@@ -652,7 +632,6 @@ Param Type | Name | Data Type | Required | Description
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created**
### Return type
[**GetActiveCampaigns200ResponseInner[]**](../models/get-active-campaigns200-response-inner)
### Responses
@@ -666,7 +645,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -678,7 +656,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'name eq "Manager Campaign"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional)
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional)
# List Campaigns
try {
Get-ActiveCampaigns
@@ -689,11 +669,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-campaign
Use this API to get information for an existing certification campaign by the campaign's ID.
@@ -704,7 +681,6 @@ Path | Id | **String** | True | ID of the campaign to be retrieved.
Query | Detail | **String** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.
### Return type
[**GetActiveCampaigns200ResponseInner**](../models/get-active-campaigns200-response-inner)
### Responses
@@ -719,7 +695,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -727,7 +702,9 @@ Code | Description | Data Type
```powershell
$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved.
$Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional)
# Get Campaign
try {
Get-Campaign-Id $Id
@@ -738,11 +715,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-campaign-reports
Use this API to fetch all reports for a certification campaign by campaign ID.
@@ -752,7 +726,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the campaign whose reports are being fetched.
### Return type
[**CampaignReport[]**](../models/campaign-report)
### Responses
@@ -767,14 +740,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched.
# Get Campaign Reports
try {
Get-CampaignReports-Id $Id
@@ -785,11 +759,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-campaign-reports-config
Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns.
@@ -798,7 +769,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**CampaignReportsConfig**](../models/campaign-reports-config)
### Responses
@@ -812,13 +782,14 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
# Get Campaign Reports Configuration
try {
Get-CampaignReportsConfig
@@ -829,11 +800,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-campaign-template
Use this API to fetch a certification campaign template by ID.
@@ -843,7 +811,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Requested campaign template's ID.
### Return type
[**CampaignTemplate**](../models/campaign-template)
### Responses
@@ -858,14 +825,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID.
# Get a Campaign Template
try {
Get-CampaignTemplate-Id $Id
@@ -876,11 +844,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-campaign-template-schedule
Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set.
@@ -890,7 +855,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the campaign template whose schedule is being fetched.
### Return type
[**Schedule**](../models/schedule)
### Responses
@@ -905,14 +869,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched.
# Get Campaign Template Schedule
try {
Get-CampaignTemplateSchedule-Id $Id
@@ -923,11 +888,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-campaign-templates
Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params.
The API returns all campaign templates matching the query parameters.
@@ -943,7 +905,6 @@ Param Type | Name | Data Type | Required | Description
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw*
### Return type
[**CampaignTemplate[]**](../models/campaign-template)
### Responses
@@ -957,7 +918,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -968,7 +928,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional)
$Filters = 'name eq "manager template"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional)
# List Campaign Templates
try {
Get-CampaignTemplates
@@ -979,11 +941,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## move
This API reassigns the specified certifications from one identity to another.
@@ -994,7 +953,6 @@ Path | Id | **String** | True | The certification campaign ID
Body | AdminReviewReassign | [**AdminReviewReassign**](../models/admin-review-reassign) | True |
### Return type
[**CertificationTask**](../models/certification-task)
### Responses
@@ -1009,7 +967,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -1024,7 +981,9 @@ $AdminReviewReassign = @"{
"type" : "IDENTITY"
}
}"@
# Reassign Certifications
try {
$Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign
Move--Id $Id -AdminReviewReassign $Result
@@ -1036,11 +995,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-campaign-template
Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
@@ -1051,7 +1007,6 @@ Path | Id | **String** | True | ID of the campaign template being modified.
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create)
### Return type
[**CampaignTemplate**](../models/campaign-template)
### Responses
@@ -1066,21 +1021,21 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
### Example
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being modified.
# JsonPatchOperation[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create)
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create)
# Update a Campaign Template
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-CampaignTemplate-Id $Id -JsonPatchOperation $Result
@@ -1092,11 +1047,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-campaign-reports-config
Use this API to overwrite the configuration for campaign reports.
@@ -1106,7 +1058,6 @@ Param Type | Name | Data Type | Required | Description
Body | CampaignReportsConfig | [**CampaignReportsConfig**](../models/campaign-reports-config) | True | Campaign report configuration.
### Return type
[**CampaignReportsConfig**](../models/campaign-reports-config)
### Responses
@@ -1120,7 +1071,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -1129,7 +1079,9 @@ Code | Description | Data Type
$CampaignReportsConfig = @"{
"identityAttributeColumns" : [ "firstname", "lastname" ]
}"@
# Set Campaign Reports Configuration
try {
$Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig
Set-CampaignReportsConfig-CampaignReportsConfig $Result
@@ -1141,11 +1093,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-campaign-template-schedule
Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one.
@@ -1156,7 +1105,6 @@ Path | Id | **String** | True | ID of the campaign template being scheduled.
Body | Schedule | [**Schedule**](../models/schedule) | (optional) |
### Return type
(empty response body)
### Responses
@@ -1171,7 +1119,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -1198,7 +1145,9 @@ $Schedule = @"{
"expiration" : "2000-01-23T04:56:07.000+00:00",
"type" : "WEEKLY"
}"@
# Set Campaign Template Schedule
try {
Set-CampaignTemplateSchedule-Id $Id
@@ -1209,11 +1158,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-campaign
Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged.
@@ -1224,7 +1170,6 @@ Path | Id | **String** | True | Campaign ID.
Body | ActivateCampaignOptions | [**ActivateCampaignOptions**](../models/activate-campaign-options) | (optional) | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format.
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -1239,7 +1184,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -1249,7 +1193,9 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID.
$ActivateCampaignOptions = @"{
"timeZone" : "-05:00"
}"@
# Activate a Campaign
try {
Start-Campaign-Id $Id
@@ -1260,11 +1206,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-campaign-remediation-scan
Use this API to run a remediation scan task for a certification campaign.
@@ -1274,7 +1217,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the campaign the remediation scan is being run for.
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -1289,14 +1231,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for.
# Run Campaign Remediation Scan
try {
Start-CampaignRemediationScan-Id $Id
@@ -1307,11 +1250,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-campaign-report
Use this API to run a report for a certification campaign.
@@ -1322,7 +1262,6 @@ Path | Id | **String** | True | ID of the campaign the report is being run fo
Path | Type | [**ReportType**](../models/report-type) | True | Type of the report to run.
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -1337,7 +1276,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -1345,7 +1283,9 @@ Code | Description | Data Type
```powershell
$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for.
$Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run.
# Run Campaign Report
try {
Start-CampaignReport-Id $Id -Type $Type
@@ -1356,11 +1296,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-generate-campaign-template
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
@@ -1380,7 +1317,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the campaign template to use for generation.
### Return type
[**CampaignReference**](../models/campaign-reference)
### Responses
@@ -1394,14 +1330,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation.
# Generate a Campaign from Template
try {
Start-GenerateCampaignTemplate-Id $Id
@@ -1412,11 +1349,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-campaign
Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
@@ -1427,7 +1361,6 @@ Path | Id | **String** | True | ID of the campaign template being modified.
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline
### Return type
[**SlimCampaign**](../models/slim-campaign)
### Responses
@@ -1442,21 +1375,21 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
### Example
```powershell
$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template being modified.
# JsonPatchOperation[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline
# Update a Campaign
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-Campaign-Id $Id -JsonPatchOperation $Result
@@ -1468,7 +1401,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: certification-summaries
title: CertificationSummaries
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/certification-summaries
tags: ['SDK', 'Software Development Kit', 'CertificationSummaries', 'CertificationSummaries']
---
# CertificationSummaries
Use this API to implement certification summary functionality.
With this functionality in place, administrators and designated certification reviewers can review summaries of identity certification campaigns and draw conclusions about the campaigns' scope, security, and effectiveness.
@@ -37,9 +37,7 @@ Method | HTTP request | Description
[**Get-IdentitySummaries**](#get-identity-summaries) | **GET** `/certifications/{id}/identity-summaries` | Identity Summaries for Campaign Certification
[**Get-IdentitySummary**](#get-identity-summary) | **GET** `/certifications/{id}/identity-summaries/{identitySummaryId}` | Summary for Identity
## get-identity-access-summaries
This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API.
### Parameters
@@ -54,7 +52,6 @@ Path | Type | **String** | True | The type of access review item to retrieve
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name**
### Return type
[**AccessSummary[]**](../models/access-summary)
### Responses
@@ -69,7 +66,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -82,7 +78,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'access.id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional)
$Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional)
# Access Summaries
try {
Get-IdentityAccessSummaries-Id $Id -Type $Type
@@ -93,11 +91,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-decision-summary
This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API.
### Parameters
@@ -107,7 +102,6 @@ Path | Id | **String** | True | The certification ID
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in*
### Return type
[**IdentityCertDecisionSummary**](../models/identity-cert-decision-summary)
### Responses
@@ -122,7 +116,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -130,7 +123,9 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID
$Filters = 'identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional)
# Summary of Certification Decisions
try {
Get-IdentityDecisionSummary-Id $Id
@@ -141,11 +136,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-summaries
This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API.
### Parameters
@@ -159,7 +151,6 @@ Path | Id | **String** | True | The identity campaign certification ID
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name**
### Return type
[**CertificationIdentitySummary[]**](../models/certification-identity-summary)
### Responses
@@ -174,7 +165,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -186,7 +176,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional)
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional)
# Identity Summaries for Campaign Certification
try {
Get-IdentitySummaries-Id $Id
@@ -197,11 +189,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-summary
This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API.
### Parameters
@@ -211,7 +200,6 @@ Path | Id | **String** | True | The identity campaign certification ID
Path | IdentitySummaryId | **String** | True | The identity summary ID
### Return type
[**CertificationIdentitySummary**](../models/certification-identity-summary)
### Responses
@@ -226,7 +214,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -234,7 +221,9 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID
$IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID
# Summary for Identity
try {
Get-IdentitySummary-Id $Id -IdentitySummaryId $IdentitySummaryId
@@ -245,7 +234,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: certifications
title: Certifications
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/certifications
tags: ['SDK', 'Software Development Kit', 'Certifications', 'Certifications']
---
# Certifications
Use this API to implement certification functionality.
With this functionality in place, administrators and designated certification reviewers can review users' access certifications and decide whether to approve access, revoke it, or reassign the review to another reviewer.
@@ -53,9 +53,7 @@ Method | HTTP request | Description
[**Invoke-SignOffIdentityCertification**](#sign-off-identity-certification) | **POST** `/certifications/{id}/sign-off` | Finalize Identity Certification Decisions
[**Submit-ReassignCertsAsync**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously
## get-certification-task
This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API.
### Parameters
@@ -64,7 +62,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The task ID
### Return type
[**CertificationTask**](../models/certification-task)
### Responses
@@ -79,14 +76,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID
# Certification Task by ID
try {
Get-CertificationTask-Id $Id
@@ -97,11 +95,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-certification
This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
### Parameters
@@ -110,7 +105,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The certification id
### Return type
[**IdentityCertificationDto**](../models/identity-certification-dto)
### Responses
@@ -125,14 +119,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id
# Identity Certification by ID
try {
Get-IdentityCertification-Id $Id
@@ -143,11 +138,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-certification-item-permissions
This API returns the permissions associated with an entitlement certification item based on the certification item's ID. Reviewers for this certification can also call this API.
### Parameters
@@ -161,7 +153,6 @@ Path | ItemId | **String** | True | The certification item ID
Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
### Return type
[**PermissionDto[]**](../models/permission-dto)
### Responses
@@ -176,7 +167,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -188,7 +178,9 @@ $Filters = 'target eq "SYS.OBJAUTH2"' # String | Filter results using the standa
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
# Permissions for Entitlement Certification Item
try {
Get-IdentityCertificationItemPermissions-CertificationId $CertificationId -ItemId $ItemId
@@ -199,11 +191,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-pending-certification-tasks
This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned.
### Parameters
@@ -216,7 +205,6 @@ Param Type | Name | Data Type | Required | Description
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in*
### Return type
[**CertificationTask[]**](../models/certification-task)
### Responses
@@ -231,7 +219,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -242,7 +229,9 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'type eq "ADMIN_REASSIGN"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional)
# List of Pending Certification Tasks
try {
Get-PendingCertificationTasks
@@ -253,11 +242,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-certification-reviewers
This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API.
### Parameters
@@ -271,7 +257,6 @@ Path | Id | **String** | True | The certification ID
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email**
### Return type
[**IdentityReferenceWithNameAndEmail[]**](../models/identity-reference-with-name-and-email)
### Responses
@@ -286,7 +271,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -298,7 +282,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'name eq "Bob"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional)
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional)
# List of Reviewers for certification
try {
Get-CertificationReviewers-Id $Id
@@ -309,11 +295,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-identity-access-review-items
This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
### Parameters
@@ -330,7 +313,6 @@ Path | Id | **String** | True | The identity campaign certification ID
Query | Roles | **String** | (optional) | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time.
### Return type
[**AccessReviewItem[]**](../models/access-review-item)
### Responses
@@ -345,7 +327,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -360,7 +341,9 @@ $Sorters = "access.name,-accessProfile.sourceName" # String | Sort results using
$Entitlements = "identityEntitlement" # String | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional)
$AccessProfiles = "accessProfile1" # String | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional)
$Roles = "userRole" # String | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional)
# List of Access Review Items
try {
Get-IdentityAccessReviewItems-Id $Id
@@ -371,11 +354,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-identity-certifications
Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups.
### Parameters
@@ -389,7 +369,6 @@ Param Type | Name | Data Type | Required | Description
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed**
### Return type
[**IdentityCertificationDto[]**](../models/identity-certification-dto)
### Responses
@@ -403,7 +382,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -415,7 +393,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional)
$Sorters = "name,due" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional)
# List Identity Campaign Certifications
try {
Get-IdentityCertifications
@@ -426,11 +406,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## make-identity-decision
The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
### Parameters
@@ -440,7 +417,6 @@ Path | Id | **String** | True | The ID of the identity campaign certification
Body | ReviewDecision | [**[]ReviewDecision**](../models/review-decision) | True | A non-empty array of decisions to be made.
### Return type
[**IdentityCertificationDto**](../models/identity-certification-dto)
### Responses
@@ -455,14 +431,12 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campaign certification on which to make decisions
# ReviewDecision[] | A non-empty array of decisions to be made.
$ReviewDecision = @"{
"comments" : "This user no longer needs access to this source",
"decision" : "APPROVE",
@@ -474,9 +448,11 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campa
},
"id" : "ef38f94347e94562b5bb8424a56397d8",
"bulk" : true
}"@
}"@ # ReviewDecision[] | A non-empty array of decisions to be made.
# Decide on a Certification Item
try {
$Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision
Select-IdentityDecision-Id $Id -ReviewDecision $Result
@@ -488,11 +464,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## reassign-identity-certifications
This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
### Parameters
@@ -502,7 +475,6 @@ Path | Id | **String** | True | The identity campaign certification ID
Body | ReviewReassign | [**ReviewReassign**](../models/review-reassign) | True |
### Return type
[**IdentityCertificationDto**](../models/identity-certification-dto)
### Responses
@@ -517,7 +489,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -535,7 +506,9 @@ $ReviewReassign = @"{
"type" : "ITEM"
} ]
}"@
# Reassign Identities or Items
try {
$Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign
Invoke-ReassignIdentityCertifications-Id $Id -ReviewReassign $Result
@@ -547,11 +520,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## sign-off-identity-certification
This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
### Parameters
@@ -560,7 +530,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The identity campaign certification ID
### Return type
[**IdentityCertificationDto**](../models/identity-certification-dto)
### Responses
@@ -575,14 +544,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID
# Finalize Identity Certification Decisions
try {
Invoke-SignOffIdentityCertification-Id $Id
@@ -593,11 +563,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## submit-reassign-certs-async
This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another
reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the
reassignment is complete.
@@ -612,7 +579,6 @@ Path | Id | **String** | True | The identity campaign certification ID
Body | ReviewReassign | [**ReviewReassign**](../models/review-reassign) | True |
### Return type
[**CertificationTask**](../models/certification-task)
### Responses
@@ -627,7 +593,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -645,7 +610,9 @@ $ReviewReassign = @"{
"type" : "ITEM"
} ]
}"@
# Reassign Certifications Asynchronously
try {
$Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign
Submit-ReassignCertsAsync-Id $Id -ReviewReassign $Result
@@ -657,7 +624,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: configuration-hub
title: ConfigurationHub
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/configuration-hub
tags: ['SDK', 'Software Development Kit', 'ConfigurationHub', 'ConfigurationHub']
---
# ConfigurationHub
Upload configurations and manage object mappings between tenants.
@@ -37,9 +37,7 @@ Method | HTTP request | Description
[**Get-UploadedConfigurations**](#list-uploaded-configurations) | **GET** `/configuration-hub/backups/uploads` | List Uploaded Configurations
[**Update-ObjectMappings**](#update-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-patch` | Bulk updates object mappings
## create-object-mapping
This creates an object mapping between current org and source org.
Source org should be "default" when creating an object mapping that is not to be associated to any particular org.
The request will need the following security scope:
@@ -52,7 +50,6 @@ Path | SourceOrg | **String** | True | The name of the source org.
Body | ObjectMappingRequest | [**ObjectMappingRequest**](../models/object-mapping-request) | True | The object mapping request body.
### Return type
[**ObjectMappingResponse**](../models/object-mapping-response)
### Responses
@@ -67,7 +64,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -81,7 +77,9 @@ $ObjectMappingRequest = @"{
"enabled" : false,
"objectType" : "IDENTITY"
}"@
# Creates an object mapping
try {
$Result = ConvertFrom-JsonToObjectMappingRequest -Json $ObjectMappingRequest
New-ObjectMapping-SourceOrg $SourceOrg -ObjectMappingRequest $Result
@@ -93,11 +91,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-object-mappings
This creates a set of object mappings (Max 25) between current org and source org.
Source org should be "default" when creating object mappings that are not to be associated to any particular org.
The request will need the following security scope:
@@ -110,7 +105,6 @@ Path | SourceOrg | **String** | True | The name of the source org.
Body | ObjectMappingBulkCreateRequest | [**ObjectMappingBulkCreateRequest**](../models/object-mapping-bulk-create-request) | True | The bulk create object mapping request body.
### Return type
[**ObjectMappingBulkCreateResponse**](../models/object-mapping-bulk-create-response)
### Responses
@@ -125,7 +119,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -147,7 +140,9 @@ $ObjectMappingBulkCreateRequest = @"{
"objectType" : "IDENTITY"
} ]
}"@
# Bulk creates object mappings
try {
$Result = ConvertFrom-JsonToObjectMappingBulkCreateRequest -Json $ObjectMappingBulkCreateRequest
New-ObjectMappings-SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result
@@ -159,11 +154,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-uploaded-configuration
This API uploads a JSON configuration file into a tenant.
Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality.
@@ -177,7 +169,6 @@ Param Type | Name | Data Type | Required | Description
| Name | **String** | True | Name that will be assigned to the uploaded configuration file.
### Return type
[**BackupResponse**](../models/backup-response)
### Responses
@@ -191,7 +182,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
@@ -199,7 +189,9 @@ Code | Description | Data Type
```powershell
$Data = # System.IO.FileInfo | JSON file containing the objects to be imported.
$Name = "MyName" # String | Name that will be assigned to the uploaded configuration file.
# Upload a Configuration
try {
New-UploadedConfiguration-Data $Data -Name $Name
@@ -210,11 +202,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-object-mapping
This deletes an existing object mapping.
Source org should be "default" when deleting an object mapping that is not associated to any particular org.
The request will need the following security scope:
@@ -227,7 +216,6 @@ Path | SourceOrg | **String** | True | The name of the source org.
Path | ObjectMappingId | **String** | True | The id of the object mapping to be deleted.
### Return type
(empty response body)
### Responses
@@ -242,7 +230,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -250,7 +237,9 @@ Code | Description | Data Type
```powershell
$SourceOrg = "source-org" # String | The name of the source org.
$ObjectMappingId = "3d6e0144-963f-4bd6-8d8d-d77b4e507ce4" # String | The id of the object mapping to be deleted.
# Deletes an object mapping
try {
Remove-ObjectMapping-SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId
@@ -261,11 +250,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-uploaded-configuration
This API deletes an uploaded configuration based on Id.
On success, this endpoint will return an empty response.
@@ -278,7 +264,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The id of the uploaded configuration.
### Return type
(empty response body)
### Responses
@@ -293,14 +278,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration.
# Delete an Uploaded Configuration
try {
Remove-UploadedConfiguration-Id $Id
@@ -311,11 +297,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-object-mappings
This gets a list of existing object mappings between current org and source org.
Source org should be "default" when getting object mappings that are not associated to any particular org.
The request will need the following security scope:
@@ -327,7 +310,6 @@ Param Type | Name | Data Type | Required | Description
Path | SourceOrg | **String** | True | The name of the source org.
### Return type
[**ObjectMappingResponse[]**](../models/object-mapping-response)
### Responses
@@ -342,14 +324,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$SourceOrg = "source-org" # String | The name of the source org.
# Gets list of object mappings
try {
Get-ObjectMappings-SourceOrg $SourceOrg
@@ -360,11 +343,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-uploaded-configuration
This API gets an existing uploaded configuration for the current tenant.
### Parameters
@@ -373,7 +353,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The id of the uploaded configuration.
### Return type
[**BackupResponse**](../models/backup-response)
### Responses
@@ -388,14 +367,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration.
# Get an Uploaded Configuration
try {
Get-UploadedConfiguration-Id $Id
@@ -406,11 +386,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-uploaded-configurations
This API gets a list of existing uploaded configurations for the current tenant.
### Parameters
@@ -419,7 +396,6 @@ Param Type | Name | Data Type | Required | Description
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq*
### Return type
[**BackupResponse[]**](../models/backup-response)
### Responses
@@ -434,14 +410,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Filters = 'status eq "COMPLETE"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional)
# List Uploaded Configurations
try {
Get-UploadedConfigurations
@@ -452,11 +429,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-object-mappings
This updates a set of object mappings, only enabled and targetValue fields can be updated.
Source org should be "default" when updating object mappings that are not associated to any particular org.
The request will need the following security scope:
@@ -469,7 +443,6 @@ Path | SourceOrg | **String** | True | The name of the source org.
Body | ObjectMappingBulkPatchRequest | [**ObjectMappingBulkPatchRequest**](../models/object-mapping-bulk-patch-request) | True | The object mapping request body.
### Return type
[**ObjectMappingBulkPatchResponse**](../models/object-mapping-bulk-patch-response)
### Responses
@@ -484,7 +457,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -505,7 +477,9 @@ $ObjectMappingBulkPatchRequest = @"{
} ]
}
}"@
# Bulk updates object mappings
try {
$Result = ConvertFrom-JsonToObjectMappingBulkPatchRequest -Json $ObjectMappingBulkPatchRequest
Update-ObjectMappings-SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result
@@ -517,7 +491,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: connectors
title: Connectors
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/connectors
tags: ['SDK', 'Software Development Kit', 'Connectors', 'Connectors']
---
# Connectors
Use this API to implement connector functionality.
With this functionality in place, administrators can view available connectors.
@@ -44,9 +44,7 @@ Method | HTTP request | Description
[**Send-ConnectorTranslations**](#put-connector-translations) | **PUT** `/connectors/{scriptName}/translations/{locale}` | Update Connector Translations
[**Update-Connector**](#update-connector) | **PATCH** `/connectors/{scriptName}` | Update Connector by Script Name
## create-custom-connector
Create custom connector.
### Parameters
@@ -55,7 +53,6 @@ Param Type | Name | Data Type | Required | Description
Body | V3CreateConnectorDto | [**V3CreateConnectorDto**](../models/v3-create-connector-dto) | True |
### Return type
[**V3ConnectorDto**](../models/v3-connector-dto)
### Responses
@@ -70,7 +67,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -83,7 +79,9 @@ $V3CreateConnectorDto = @"{
"type" : "custom connector type",
"status" : "RELEASED"
}"@
# Create Custom Connector
try {
$Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto
New-CustomConnector-V3CreateConnectorDto $Result
@@ -95,11 +93,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-custom-connector
Delete a custom connector that using its script name.
### Parameters
@@ -108,7 +103,6 @@ Param Type | Name | Data Type | Required | Description
Path | ScriptName | **String** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
### Return type
(empty response body)
### Responses
@@ -123,14 +117,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
# Delete Connector by Script Name
try {
Remove-CustomConnector-ScriptName $ScriptName
@@ -141,11 +136,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-connector
Fetches a connector that using its script name.
### Parameters
@@ -155,7 +147,6 @@ Path | ScriptName | **String** | True | The scriptName value of the connector
Query | Locale | **String** | (optional) | The locale to apply to the config. If no viable locale is given, it will default to ""en""
### Return type
[**ConnectorDetail**](../models/connector-detail)
### Responses
@@ -170,7 +161,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -178,7 +168,9 @@ Code | Description | Data Type
```powershell
$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional)
# Get Connector by Script Name
try {
Get-Connector-ScriptName $ScriptName
@@ -189,11 +181,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-connector-list
Fetches list of connectors that have 'RELEASED' status using filtering and pagination.
### Parameters
@@ -206,7 +195,6 @@ Param Type | Name | Data Type | Required | Description
Query | Locale | **String** | (optional) | The locale to apply to the config. If no viable locale is given, it will default to ""en""
### Return type
[**V3ConnectorDto[]**](../models/v3-connector-dto)
### Responses
@@ -221,7 +209,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -232,7 +219,9 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional)
# Get Connector List
try {
Get-ConnectorList
@@ -243,11 +232,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-connector-source-config
Fetches a connector's source config using its script name.
### Parameters
@@ -256,7 +242,6 @@ Param Type | Name | Data Type | Required | Description
Path | ScriptName | **String** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
### Return type
**String**
### Responses
@@ -271,14 +256,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json
### Example
```powershell
$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
# Get Connector Source Configuration
try {
Get-ConnectorSourceConfig-ScriptName $ScriptName
@@ -289,11 +275,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-connector-source-template
Fetches a connector's source template using its script name.
### Parameters
@@ -302,7 +285,6 @@ Param Type | Name | Data Type | Required | Description
Path | ScriptName | **String** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
### Return type
**String**
### Responses
@@ -317,14 +299,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json
### Example
```powershell
$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
# Get Connector Source Template
try {
Get-ConnectorSourceTemplate-ScriptName $ScriptName
@@ -335,11 +318,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-connector-translations
Fetches a connector's translations using its script name.
### Parameters
@@ -349,7 +329,6 @@ Path | ScriptName | **String** | True | The scriptName value of the connector
Path | Locale | **String** | True | The locale to apply to the config. If no viable locale is given, it will default to ""en""
### Return type
**String**
### Responses
@@ -364,7 +343,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain, application/json
@@ -372,7 +350,9 @@ Code | Description | Data Type
```powershell
$ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en""
# Get Connector Translations
try {
Get-ConnectorTranslations-ScriptName $ScriptName -Locale $Locale
@@ -383,11 +363,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-connector-source-config
Update a connector's source config using its script name.
### Parameters
@@ -397,7 +374,6 @@ Path | ScriptName | **String** | True | The scriptName value of the connector
| File | **System.IO.FileInfo** | True | connector source config xml file
### Return type
[**UpdateDetail**](../models/update-detail)
### Responses
@@ -412,7 +388,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
@@ -420,7 +395,9 @@ Code | Description | Data Type
```powershell
$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
$File = # System.IO.FileInfo | connector source config xml file
# Update Connector Source Configuration
try {
Send-ConnectorSourceConfig-ScriptName $ScriptName -File $File
@@ -431,11 +408,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-connector-source-template
Update a connector's source template using its script name.
### Parameters
@@ -445,7 +419,6 @@ Path | ScriptName | **String** | True | The scriptName value of the connector
| File | **System.IO.FileInfo** | True | connector source template xml file
### Return type
[**UpdateDetail**](../models/update-detail)
### Responses
@@ -460,7 +433,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
@@ -468,7 +440,9 @@ Code | Description | Data Type
```powershell
$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
$File = # System.IO.FileInfo | connector source template xml file
# Update Connector Source Template
try {
Send-ConnectorSourceTemplate-ScriptName $ScriptName -File $File
@@ -479,11 +453,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-connector-translations
Update a connector's translations using its script name.
### Parameters
@@ -493,7 +464,6 @@ Path | ScriptName | **String** | True | The scriptName value of the connector
Path | Locale | **String** | True | The locale to apply to the config. If no viable locale is given, it will default to ""en""
### Return type
[**UpdateDetail**](../models/update-detail)
### Responses
@@ -508,7 +478,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
@@ -516,7 +485,9 @@ Code | Description | Data Type
```powershell
$ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en""
# Update Connector Translations
try {
Send-ConnectorTranslations-ScriptName $ScriptName -Locale $Locale
@@ -527,11 +498,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-connector
This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
The following fields are patchable:
@@ -553,7 +521,6 @@ Path | ScriptName | **String** | True | The scriptName value of the connector
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of connector detail update operations
### Return type
[**ConnectorDetail**](../models/connector-detail)
### Responses
@@ -568,21 +535,21 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
### Example
```powershell
$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
# JsonPatchOperation[] | A list of connector detail update operations
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] | A list of connector detail update operations
# Update Connector by Script Name
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-Connector-ScriptName $ScriptName -JsonPatchOperation $Result
@@ -594,7 +561,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: global-tenant-security-settings
title: GlobalTenantSecuritySettings
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/global-tenant-security-settings
tags: ['SDK', 'Software Development Kit', 'GlobalTenantSecuritySettings', 'GlobalTenantSecuritySettings']
---
# GlobalTenantSecuritySettings
Use this API to implement and customize global tenant security settings.
With this functionality in place, administrators can manage the global security settings that a tenant/org has.
@@ -31,9 +31,7 @@ Method | HTTP request | Description
[**Update-AuthOrgServiceProviderConfig**](#patch-auth-org-service-provider-config) | **PATCH** `/auth-org/service-provider-config` | Update Service Provider Configuration
[**Update-AuthOrgSessionConfig**](#patch-auth-org-session-config) | **PATCH** `/auth-org/session-config` | Update Auth Org Session Configuration
## create-auth-org-network-config
This API returns the details of an org's network auth configuration. Requires security scope of: 'sp:auth-org:manage'
### Parameters
@@ -42,7 +40,6 @@ Param Type | Name | Data Type | Required | Description
Body | NetworkConfiguration | [**NetworkConfiguration**](../models/network-configuration) | True | Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters.
### Return type
[**NetworkConfiguration**](../models/network-configuration)
### Responses
@@ -57,7 +54,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -68,7 +64,9 @@ $NetworkConfiguration = @"{
"whitelisted" : true,
"geolocation" : [ "CA", "FR", "HT" ]
}"@
# Create security network configuration.
try {
$Result = ConvertFrom-JsonToNetworkConfiguration -Json $NetworkConfiguration
New-AuthOrgNetworkConfig-NetworkConfiguration $Result
@@ -80,11 +78,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-auth-org-lockout-config
This API returns the details of an org's lockout auth configuration.
### Parameters
@@ -92,7 +87,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**LockoutConfiguration**](../models/lockout-configuration)
### Responses
@@ -107,13 +101,14 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
# Get Auth Org Lockout Configuration.
try {
Get-AuthOrgLockoutConfig
@@ -124,11 +119,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-auth-org-network-config
This API returns the details of an org's network auth configuration.
### Parameters
@@ -136,7 +128,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**NetworkConfiguration**](../models/network-configuration)
### Responses
@@ -151,13 +142,14 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
# Get security network configuration.
try {
Get-AuthOrgNetworkConfig
@@ -168,11 +160,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-auth-org-service-provider-config
This API returns the details of an org's service provider auth configuration.
### Parameters
@@ -180,7 +169,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**ServiceProviderConfiguration**](../models/service-provider-configuration)
### Responses
@@ -195,13 +183,14 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
# Get Service Provider Configuration.
try {
Get-AuthOrgServiceProviderConfig
@@ -212,11 +201,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-auth-org-session-config
This API returns the details of an org's session auth configuration.
### Parameters
@@ -224,7 +210,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**SessionConfiguration**](../models/session-configuration)
### Responses
@@ -239,13 +224,14 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
# Get Auth Org Session Configuration.
try {
Get-AuthOrgSessionConfig
@@ -256,11 +242,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-auth-org-lockout-config
This API updates an existing lockout configuration for an org using PATCH
@@ -270,7 +253,6 @@ Param Type | Name | Data Type | Required | Description
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60`
### Return type
[**LockoutConfiguration**](../models/lockout-configuration)
### Responses
@@ -285,20 +267,20 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
### Example
```powershell
# JsonPatchOperation[] | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60`
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60`
# Update Auth Org Lockout Configuration
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-AuthOrgLockoutConfig-JsonPatchOperation $Result
@@ -310,11 +292,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-auth-org-network-config
This API updates an existing network configuration for an org using PATCH
Requires security scope of: 'sp:auth-org:manage'
@@ -324,7 +303,6 @@ Param Type | Name | Data Type | Required | Description
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters.
### Return type
[**NetworkConfiguration**](../models/network-configuration)
### Responses
@@ -339,20 +317,20 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
### Example
```powershell
# JsonPatchOperation[] | A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters.
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] | A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters.
# Update security network configuration.
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-AuthOrgNetworkConfig-JsonPatchOperation $Result
@@ -364,11 +342,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-auth-org-service-provider-config
This API updates an existing service provider configuration for an org using PATCH.
### Parameters
@@ -377,7 +352,6 @@ Param Type | Name | Data Type | Required | Description
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email)
### Return type
[**ServiceProviderConfiguration**](../models/service-provider-configuration)
### Responses
@@ -392,20 +366,20 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
### Example
```powershell
# JsonPatchOperation[] | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email)
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email)
# Update Service Provider Configuration
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-AuthOrgServiceProviderConfig-JsonPatchOperation $Result
@@ -417,11 +391,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-auth-org-session-config
This API updates an existing session configuration for an org using PATCH.
### Parameters
@@ -430,7 +401,6 @@ Param Type | Name | Data Type | Required | Description
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.`
### Return type
[**SessionConfiguration**](../models/session-configuration)
### Responses
@@ -445,20 +415,20 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
### Example
```powershell
# JsonPatchOperation[] | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.`
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.`
# Update Auth Org Session Configuration
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-AuthOrgSessionConfig-JsonPatchOperation $Result
@@ -470,7 +440,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: identity-profiles
title: IdentityProfiles
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/identity-profiles
tags: ['SDK', 'Software Development Kit', 'IdentityProfiles', 'IdentityProfiles']
---
# IdentityProfiles
Use this API to implement identity profile functionality.
With this functionality in place, administrators can view identity profiles and their configurations.
@@ -40,9 +40,7 @@ Method | HTTP request | Description
[**Sync-IdentityProfile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile
[**Update-IdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update the Identity Profile
## create-identity-profile
This creates an Identity Profile.
### Parameters
@@ -51,7 +49,6 @@ Param Type | Name | Data Type | Required | Description
Body | IdentityProfile | [**IdentityProfile**](../models/identity-profile) | True |
### Return type
[**IdentityProfile**](../models/identity-profile)
### Responses
@@ -65,7 +62,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -120,7 +116,9 @@ $IdentityProfile = @"{
"modified" : "2015-05-28T14:07:17Z",
"id" : "id12345"
}"@
# Create an Identity Profile
try {
$Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile
New-IdentityProfile-IdentityProfile $Result
@@ -132,11 +130,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-identity-profile
This deletes an Identity Profile based on ID.
On success, this endpoint will return a reference to the bulk delete task result.
@@ -150,7 +145,6 @@ Param Type | Name | Data Type | Required | Description
Path | IdentityProfileId | **String** | True | The Identity Profile ID.
### Return type
[**TaskResultSimplified**](../models/task-result-simplified)
### Responses
@@ -165,14 +159,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID.
# Delete an Identity Profile
try {
Remove-IdentityProfile-IdentityProfileId $IdentityProfileId
@@ -183,11 +178,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-identity-profiles
This deletes multiple Identity Profiles via a list of supplied IDs.
On success, this endpoint will return a reference to the bulk delete task result.
@@ -200,7 +192,6 @@ Param Type | Name | Data Type | Required | Description
Body | RequestBody | **[]String** | True | Identity Profile bulk delete request body.
### Return type
[**TaskResultSimplified**](../models/task-result-simplified)
### Responses
@@ -214,16 +205,17 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```powershell
$RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request body.
$RequestBody = @""@
$RequestBody = @""@ # String[] | Identity Profile bulk delete request body.
# Delete Identity Profiles
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Remove-IdentityProfiles-RequestBody $Result
@@ -235,11 +227,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## export-identity-profiles
This exports existing identity profiles in the format specified by the sp-config service.
### Parameters
@@ -252,7 +241,6 @@ Param Type | Name | Data Type | Required | Description
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority**
### Return type
[**IdentityProfileExportedObject[]**](../models/identity-profile-exported-object)
### Responses
@@ -266,7 +254,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -277,7 +264,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional)
$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional)
# Export Identity Profiles
try {
Export-IdentityProfiles
@@ -288,11 +277,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-default-identity-attribute-config
This returns the default identity attribute config.
### Parameters
@@ -301,7 +287,6 @@ Param Type | Name | Data Type | Required | Description
Path | IdentityProfileId | **String** | True | The Identity Profile ID.
### Return type
[**IdentityAttributeConfig**](../models/identity-attribute-config)
### Responses
@@ -316,14 +301,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID.
# Get default Identity Attribute Config
try {
Get-DefaultIdentityAttributeConfig-IdentityProfileId $IdentityProfileId
@@ -334,11 +320,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-profile
This returns a single Identity Profile based on ID.
### Parameters
@@ -347,7 +330,6 @@ Param Type | Name | Data Type | Required | Description
Path | IdentityProfileId | **String** | True | The Identity Profile ID.
### Return type
[**IdentityProfile**](../models/identity-profile)
### Responses
@@ -362,14 +344,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID.
# Get single Identity Profile
try {
Get-IdentityProfile-IdentityProfileId $IdentityProfileId
@@ -380,11 +363,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## import-identity-profiles
This imports previously exported identity profiles.
### Parameters
@@ -393,7 +373,6 @@ Param Type | Name | Data Type | Required | Description
Body | IdentityProfileExportedObject | [**[]IdentityProfileExportedObject**](../models/identity-profile-exported-object) | True | Previously exported Identity Profiles.
### Return type
[**ObjectImportResult**](../models/object-import-result)
### Responses
@@ -407,13 +386,16 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```powershell
# IdentityProfileExportedObject[] | Previously exported Identity Profiles.
$IdentityProfileExportedObject = @"{
"self" : {
"name" : "HR Active Directory",
@@ -470,9 +452,11 @@ Code | Description | Data Type
"modified" : "2015-05-28T14:07:17Z",
"id" : "id12345"
}
}"@
}"@ # IdentityProfileExportedObject[] | Previously exported Identity Profiles.
# Import Identity Profiles
try {
$Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject
Import-IdentityProfiles-IdentityProfileExportedObject $Result
@@ -484,11 +468,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-identity-profiles
This returns a list of Identity Profiles based on the specified query parameters.
### Parameters
@@ -501,7 +482,6 @@ Param Type | Name | Data Type | Required | Description
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name**
### Return type
[**IdentityProfile[]**](../models/identity-profile)
### Responses
@@ -515,7 +495,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -526,7 +505,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional)
$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional)
# Identity Profiles List
try {
Get-IdentityProfiles
@@ -537,11 +518,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## show-identity-preview
Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body.
This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body.
@@ -551,7 +529,6 @@ Param Type | Name | Data Type | Required | Description
Body | IdentityPreviewRequest | [**IdentityPreviewRequest**](../models/identity-preview-request) | True | Identity Preview request body.
### Return type
[**IdentityPreviewResponse**](../models/identity-preview-response)
### Responses
@@ -565,7 +542,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -598,7 +574,9 @@ $IdentityPreviewRequest = @"{
"enabled" : true
}
}"@
# Generate Identity Profile Preview
try {
$Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest
Show-IdentityPreview-IdentityPreviewRequest $Result
@@ -610,11 +588,8 @@ try {
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.
This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh.
@@ -627,7 +602,6 @@ Param Type | Name | Data Type | Required | Description
Path | IdentityProfileId | **String** | True | The Identity Profile ID to be processed
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -642,14 +616,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID to be processed
# Process identities under profile
try {
Sync-IdentityProfile-IdentityProfileId $IdentityProfileId
@@ -660,11 +635,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-identity-profile
This updates the specified Identity Profile.
@@ -684,7 +656,6 @@ Path | IdentityProfileId | **String** | True | The Identity Profile ID
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
### Return type
[**IdentityProfile**](../models/identity-profile)
### Responses
@@ -699,21 +670,21 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
### Example
```powershell
$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID
# JsonPatchOperation[] | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
# Update the Identity Profile
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-IdentityProfile-IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result
@@ -725,7 +696,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: lifecycle-states
title: LifecycleStates
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/lifecycle-states
tags: ['SDK', 'Software Development Kit', 'LifecycleStates', 'LifecycleStates']
---
# LifecycleStates
Use this API to implement and customize lifecycle state functionality.
With this functionality in place, administrators can create and configure custom lifecycle states for use across their organizations, which is key to controlling which users have access, when they have access, and the access they have.
@@ -63,9 +63,7 @@ Method | HTTP request | Description
[**Set-LifecycleState**](#set-lifecycle-state) | **POST** `/identities/{identity-id}/set-lifecycle-state` | Set Lifecycle State
[**Update-LifecycleStates**](#update-lifecycle-states) | **PATCH** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State
## create-lifecycle-state
Use this endpoint to create a lifecycle state.
### Parameters
@@ -75,7 +73,6 @@ Path | IdentityProfileId | **String** | True | Identity profile ID.
Body | LifecycleState | [**LifecycleState**](../models/lifecycle-state) | True | Lifecycle state to be created.
### Return type
[**LifecycleState**](../models/lifecycle-state)
### Responses
@@ -89,7 +86,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -121,7 +117,9 @@ $LifecycleState = @"{
"identityState" : "identityState",
"enabled" : true
}"@
# Create Lifecycle State
try {
$Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState
New-LifecycleState-IdentityProfileId $IdentityProfileId -LifecycleState $Result
@@ -133,11 +131,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-lifecycle-state
Use this endpoint to delete the lifecycle state by its ID.
### Parameters
@@ -147,7 +142,6 @@ Path | IdentityProfileId | **String** | True | Identity profile ID.
Path | LifecycleStateId | **String** | True | Lifecycle state ID.
### Return type
[**LifecyclestateDeleted**](../models/lifecyclestate-deleted)
### Responses
@@ -162,7 +156,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -170,7 +163,9 @@ Code | Description | Data Type
```powershell
$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID.
$LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID.
# Delete Lifecycle State
try {
Remove-LifecycleState-IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
@@ -181,11 +176,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-lifecycle-state
Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID.
### Parameters
@@ -195,7 +187,6 @@ Path | IdentityProfileId | **String** | True | Identity profile ID.
Path | LifecycleStateId | **String** | True | Lifecycle state ID.
### Return type
[**LifecycleState**](../models/lifecycle-state)
### Responses
@@ -210,7 +201,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -218,7 +208,9 @@ Code | Description | Data Type
```powershell
$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID.
$LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID.
# Get Lifecycle State
try {
Get-LifecycleState-IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
@@ -229,11 +221,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-lifecycle-states
Use this endpoint to list all lifecycle states by their associated identity profiles.
### Parameters
@@ -246,7 +235,6 @@ Path | IdentityProfileId | **String** | True | Identity profile ID.
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified**
### Return type
[**LifecycleState[]**](../models/lifecycle-state)
### Responses
@@ -260,7 +248,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -271,7 +258,9 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Sorters = "created,modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional)
# Lists LifecycleStates
try {
Get-LifecycleStates-IdentityProfileId $IdentityProfileId
@@ -282,11 +271,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-lifecycle-state
Use this API to set/update an identity's lifecycle state to the one provided and update the corresponding identity profile.
### Parameters
@@ -296,7 +282,6 @@ Path | IdentityId | **String** | True | ID of the identity to update.
Body | SetLifecycleStateRequest | [**SetLifecycleStateRequest**](../models/set-lifecycle-state-request) | True |
### Return type
[**SetLifecycleState200Response**](../models/set-lifecycle-state200-response)
### Responses
@@ -311,7 +296,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -319,7 +303,9 @@ Code | Description | Data Type
```powershell
$IdentityId = "2c9180857893f1290178944561990364" # String | ID of the identity to update.
$SetLifecycleStateRequest = @""@
# Set Lifecycle State
try {
$Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest
Set-LifecycleState-IdentityId $IdentityId -SetLifecycleStateRequest $Result
@@ -331,11 +317,8 @@ try {
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.
### Parameters
@@ -346,7 +329,6 @@ Path | LifecycleStateId | **String** | True | Lifecycle state ID.
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption
### Return type
[**LifecycleState**](../models/lifecycle-state)
### Responses
@@ -361,7 +343,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
@@ -369,14 +350,15 @@ Code | Description | Data Type
```powershell
$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID.
$LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID.
# JsonPatchOperation[] | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption
# Update Lifecycle State
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-LifecycleStates-IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result
@@ -388,7 +370,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: mfa-configuration
title: MFAConfiguration
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/mfa-configuration
tags: ['SDK', 'Software Development Kit', 'MFAConfiguration', 'MFAConfiguration']
---
# MFAConfiguration
Configure and test multifactor authentication (MFA) methods
@@ -27,9 +27,7 @@ Method | HTTP request | Description
[**Set-MFAOktaConfig**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set Okta MFA configuration
[**Test-MFAConfig**](#test-mfa-config) | **GET** `/mfa/{method}/test` | MFA method&#39;s test configuration
## delete-mfa-config
This API removes the configuration for the specified MFA method.
### Parameters
@@ -38,7 +36,6 @@ Param Type | Name | Data Type | Required | Description
Path | Method | **String** | True | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'.
### Return type
[**MfaOktaConfig**](../models/mfa-okta-config)
### Responses
@@ -52,14 +49,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'.
# Delete MFA method configuration
try {
Remove-MFAConfig-Method $Method
@@ -70,11 +68,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-mfa-duo-config
This API returns the configuration of an Duo MFA method.
### Parameters
@@ -82,7 +77,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**MfaDuoConfig**](../models/mfa-duo-config)
### Responses
@@ -96,13 +90,14 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
# Configuration of Duo MFA method
try {
Get-MFADuoConfig
@@ -113,11 +108,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-mfa-kba-config
This API returns the KBA configuration for MFA.
### Parameters
@@ -126,7 +118,6 @@ Param Type | Name | Data Type | Required | Description
Query | AllLanguages | **Boolean** | (optional) | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false
### Return type
[**KbaQuestion[]**](../models/kba-question)
### Responses
@@ -140,14 +131,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional)
# Configuration of KBA MFA method
try {
Get-MFAKbaConfig
@@ -158,11 +150,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-mfa-okta-config
This API returns the configuration of an Okta MFA method.
### Parameters
@@ -170,7 +159,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**MfaOktaConfig**](../models/mfa-okta-config)
### Responses
@@ -184,13 +172,14 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
# Configuration of Okta MFA method
try {
Get-MFAOktaConfig
@@ -201,11 +190,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-mfa-duo-config
This API sets the configuration of an Duo MFA method.
### Parameters
@@ -214,7 +200,6 @@ Param Type | Name | Data Type | Required | Description
Body | MfaDuoConfig | [**MfaDuoConfig**](../models/mfa-duo-config) | True |
### Return type
[**MfaDuoConfig**](../models/mfa-duo-config)
### Responses
@@ -228,7 +213,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -245,7 +229,9 @@ $MfaDuoConfig = @"{
"enabled" : true,
"identityAttribute" : "email"
}"@
# Set Duo MFA configuration
try {
$Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig
Set-MFADuoConfig-MfaDuoConfig $Result
@@ -257,11 +243,8 @@ try {
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.
### Parameters
@@ -270,7 +253,6 @@ Param Type | Name | Data Type | Required | Description
Body | KbaAnswerRequestItem | [**[]KbaAnswerRequestItem**](../models/kba-answer-request-item) | True |
### Return type
[**KbaAnswerResponseItem[]**](../models/kba-answer-response-item)
### Responses
@@ -284,19 +266,19 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```powershell
# KbaAnswerRequestItem[] |
$KbaAnswerRequestItem = @"{
"answer" : "Your answer",
"id" : "c54fee53-2d63-4fc5-9259-3e93b9994135"
}"@
}"@ # KbaAnswerRequestItem[] |
# Set MFA KBA configuration
try {
$Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem
Set-MFAKBAConfig-KbaAnswerRequestItem $Result
@@ -308,11 +290,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-mfa-okta-config
This API sets the configuration of an Okta MFA method.
### Parameters
@@ -321,7 +300,6 @@ Param Type | Name | Data Type | Required | Description
Body | MfaOktaConfig | [**MfaOktaConfig**](../models/mfa-okta-config) | True |
### Return type
[**MfaOktaConfig**](../models/mfa-okta-config)
### Responses
@@ -335,7 +313,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -348,7 +325,9 @@ $MfaOktaConfig = @"{
"enabled" : true,
"identityAttribute" : "email"
}"@
# Set Okta MFA configuration
try {
$Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig
Set-MFAOktaConfig-MfaOktaConfig $Result
@@ -360,11 +339,8 @@ try {
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.
### Parameters
@@ -373,7 +349,6 @@ Param Type | Name | Data Type | Required | Description
Path | Method | **String** | True | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'.
### Return type
[**MfaConfigTestResponse**](../models/mfa-config-test-response)
### Responses
@@ -387,14 +362,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'.
# MFA method's test configuration
try {
Test-MFAConfig-Method $Method
@@ -405,7 +381,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: mfa-controller
title: MFAController
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/mfa-controller
tags: ['SDK', 'Software Development Kit', 'MFAController', 'MFAController']
---
# MFAController
This API used for multifactor authentication functionality belong to gov-multi-auth service. This controller allow you to verify authentication by specified method
@@ -25,9 +25,7 @@ Method | HTTP request | Description
[**Send-OktaVerifyRequest**](#send-okta-verify-request) | **POST** `/mfa/okta-verify/verify` | Verifying authentication via Okta method
[**Send-TokenAuthRequest**](#send-token-auth-request) | **POST** `/mfa/token/authenticate` | Authenticate Token provided MFA method
## create-send-token
This API send token request.
### Parameters
@@ -36,7 +34,6 @@ Param Type | Name | Data Type | Required | Description
Body | SendTokenRequest | [**SendTokenRequest**](../models/send-token-request) | True |
### Return type
[**SendTokenResponse**](../models/send-token-response)
### Responses
@@ -50,7 +47,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -60,7 +56,9 @@ $SendTokenRequest = @"{
"userAlias" : "will.albin",
"deliveryType" : "EMAIL_WORK"
}"@
# Create and send user token
try {
$Result = ConvertFrom-JsonToSendTokenRequest -Json $SendTokenRequest
New-SendToken-SendTokenRequest $Result
@@ -72,11 +70,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## ping-verification-status
This API poll the VerificationPollRequest for the specified MFA method.
### Parameters
@@ -86,7 +81,6 @@ Path | Method | **String** | True | The name of the MFA method. The currently
Body | VerificationPollRequest | [**VerificationPollRequest**](../models/verification-poll-request) | True |
### Return type
[**VerificationResponse**](../models/verification-response)
### Responses
@@ -100,7 +94,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -110,7 +103,9 @@ $Method = "okta-verify" # String | The name of the MFA method. The currently sup
$VerificationPollRequest = @"{
"requestId" : "089899f13a8f4da7824996191587bab9"
}"@
# Polling MFA method by VerificationPollRequest
try {
$Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest
Ping-VerificationStatus-Method $Method -VerificationPollRequest $Result
@@ -122,11 +117,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## send-duo-verify-request
This API Authenticates the user via Duo-Web MFA method.
### Parameters
@@ -135,7 +127,6 @@ Param Type | Name | Data Type | Required | Description
Body | DuoVerificationRequest | [**DuoVerificationRequest**](../models/duo-verification-request) | True |
### Return type
[**VerificationResponse**](../models/verification-response)
### Responses
@@ -149,7 +140,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -159,7 +149,9 @@ $DuoVerificationRequest = @"{
"signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2",
"userId" : "2c9180947f0ef465017f215cbcfd004b"
}"@
# Verifying authentication via Duo method
try {
$Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest
Send-DuoVerifyRequest-DuoVerificationRequest $Result
@@ -171,11 +163,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## send-kba-answers
This API Authenticate user in KBA MFA method.
### Parameters
@@ -184,7 +173,6 @@ Param Type | Name | Data Type | Required | Description
Body | KbaAnswerRequestItem | [**[]KbaAnswerRequestItem**](../models/kba-answer-request-item) | True |
### Return type
[**KbaAuthResponse**](../models/kba-auth-response)
### Responses
@@ -198,19 +186,19 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```powershell
# KbaAnswerRequestItem[] |
$KbaAnswerRequestItem = @"{
"answer" : "Your answer",
"id" : "c54fee53-2d63-4fc5-9259-3e93b9994135"
}"@
}"@ # KbaAnswerRequestItem[] |
# Authenticate KBA provided MFA method
try {
$Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem
Send-KbaAnswers-KbaAnswerRequestItem $Result
@@ -222,11 +210,8 @@ try {
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.
### Parameters
@@ -235,7 +220,6 @@ Param Type | Name | Data Type | Required | Description
Body | OktaVerificationRequest | [**OktaVerificationRequest**](../models/okta-verification-request) | True |
### Return type
[**VerificationResponse**](../models/verification-response)
### Responses
@@ -249,7 +233,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -258,7 +241,9 @@ Code | Description | Data Type
$OktaVerificationRequest = @"{
"userId" : "example@mail.com"
}"@
# Verifying authentication via Okta method
try {
$Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest
Send-OktaVerifyRequest-OktaVerificationRequest $Result
@@ -270,11 +255,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## send-token-auth-request
This API Authenticate user in Token MFA method.
### Parameters
@@ -283,7 +265,6 @@ Param Type | Name | Data Type | Required | Description
Body | TokenAuthRequest | [**TokenAuthRequest**](../models/token-auth-request) | True |
### Return type
[**TokenAuthResponse**](../models/token-auth-response)
### Responses
@@ -297,7 +278,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -308,7 +288,9 @@ $TokenAuthRequest = @"{
"deliveryType" : "EMAIL_WORK",
"token" : "12345"
}"@
# Authenticate Token provided MFA method
try {
$Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest
Send-TokenAuthRequest-TokenAuthRequest $Result
@@ -320,7 +302,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: managed-clients
title: ManagedClients
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/managed-clients
tags: ['SDK', 'Software Development Kit', 'ManagedClients', 'ManagedClients']
---
# ManagedClients
Use this API to implement managed client functionality.
With this functionality in place, administrators can modify and delete existing managed clients, create new ones, and view and make changes to their log configurations.
@@ -27,9 +27,7 @@ Method | HTTP request | Description
[**Get-ManagedClients**](#get-managed-clients) | **GET** `/managed-clients` | Get Managed Clients
[**Update-ManagedClient**](#update-managed-client) | **PATCH** `/managed-clients/{id}` | Update Managed Client
## create-managed-client
Create a new managed client.
The API returns a result that includes the managed client ID.
@@ -39,7 +37,6 @@ Param Type | Name | Data Type | Required | Description
Body | ManagedClientRequest | [**ManagedClientRequest**](../models/managed-client-request) | True |
### Return type
[**ManagedClient**](../models/managed-client)
### Responses
@@ -53,7 +50,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -65,7 +61,9 @@ $ManagedClientRequest = @"{
"clusterId" : "aClusterId",
"type" : "VA"
}"@
# Create Managed Client
try {
$Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest
New-ManagedClient-ManagedClientRequest $Result
@@ -77,11 +75,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-managed-client
Delete an existing managed client.
### Parameters
@@ -90,7 +85,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Managed client ID.
### Return type
(empty response body)
### Responses
@@ -104,14 +98,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID.
# Delete Managed Client
try {
Remove-ManagedClient-Id $Id
@@ -122,11 +117,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-managed-client
Get managed client by ID.
### Parameters
@@ -135,7 +127,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Managed client ID.
### Return type
[**ManagedClient**](../models/managed-client)
### Responses
@@ -150,14 +141,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID.
# Get Managed Client
try {
Get-ManagedClient-Id $Id
@@ -168,11 +160,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-managed-client-status
Get a managed client's status, using its ID.
### Parameters
@@ -182,7 +171,6 @@ Path | Id | **String** | True | Managed client ID to get status for.
Query | Type | [**ManagedClientType**](../models/managed-client-type) | True | Managed client type to get status for.
### Return type
[**ManagedClientStatus**](../models/managed-client-status)
### Responses
@@ -197,7 +185,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -205,7 +192,9 @@ Code | Description | Data Type
```powershell
$Id = "aClientId" # String | Managed client ID to get status for.
$Type = "CCG" # ManagedClientType | Managed client type to get status for.
# Get Managed Client Status
try {
Get-ManagedClientStatus-Id $Id -Type $Type
@@ -216,11 +205,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-managed-clients
List managed clients.
### Parameters
@@ -232,7 +218,6 @@ Param Type | Name | Data Type | Required | Description
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq*
### Return type
[**ManagedClient[]**](../models/managed-client)
### Responses
@@ -246,7 +231,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -256,7 +240,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'name eq "client name"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional)
# Get Managed Clients
try {
Get-ManagedClients
@@ -267,11 +253,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-managed-client
Update an existing managed client.
### Parameters
@@ -281,7 +264,6 @@ Path | Id | **String** | True | Managed client ID.
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | JSONPatch payload used to update the object.
### Return type
[**ManagedClient**](../models/managed-client)
### Responses
@@ -296,21 +278,21 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
### Example
```powershell
$Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID.
# JsonPatchOperation[] | JSONPatch payload used to update the object.
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] | JSONPatch payload used to update the object.
# Update Managed Client
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-ManagedClient-Id $Id -JsonPatchOperation $Result
@@ -322,7 +304,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: managed-clusters
title: ManagedClusters
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/managed-clusters
tags: ['SDK', 'Software Development Kit', 'ManagedClusters', 'ManagedClusters']
---
# ManagedClusters
Use this API to implement managed cluster functionality.
With this functionality in place, administrators can modify and delete existing managed clients, get their statuses, and create new ones.
@@ -28,9 +28,7 @@ Method | HTTP request | Description
[**Send-ClientLogConfiguration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update Managed Cluster Log Configuration
[**Update-ManagedCluster**](#update-managed-cluster) | **PATCH** `/managed-clusters/{id}` | Update Managed Cluster
## create-managed-cluster
Create a new Managed Cluster.
The API returns a result that includes the managed cluster ID.
@@ -40,7 +38,6 @@ Param Type | Name | Data Type | Required | Description
Body | ManagedClusterRequest | [**ManagedClusterRequest**](../models/managed-cluster-request) | True |
### Return type
[**ManagedCluster**](../models/managed-cluster)
### Responses
@@ -54,7 +51,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -69,7 +65,9 @@ $ManagedClusterRequest = @"{
"description" : "A short description of the managed cluster.",
"type" : "idn"
}"@
# Create Create Managed Cluster
try {
$Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest
New-ManagedCluster-ManagedClusterRequest $Result
@@ -81,11 +79,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-managed-cluster
Delete an existing managed cluster.
### Parameters
@@ -95,7 +90,6 @@ Path | Id | **String** | True | Managed cluster ID.
Query | RemoveClients | **Boolean** | (optional) (default to $false) | Flag to determine the need to delete a cluster with clients.
### Return type
(empty response body)
### Responses
@@ -109,7 +103,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -117,7 +110,9 @@ Code | Description | Data Type
```powershell
$Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID.
$RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false)
# Delete Managed Cluster
try {
Remove-ManagedCluster-Id $Id
@@ -128,11 +123,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-client-log-configuration
Get a managed cluster's log configuration.
### Parameters
@@ -141,7 +133,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of managed cluster to get log configuration for.
### Return type
[**ClientLogConfiguration**](../models/client-log-configuration)
### Responses
@@ -157,14 +148,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for.
# Get Managed Cluster Log Configuration
try {
Get-ClientLogConfiguration-Id $Id
@@ -175,11 +167,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-managed-cluster
Get a managed cluster by ID.
### Parameters
@@ -188,7 +177,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Managed cluster ID.
### Return type
[**ManagedCluster**](../models/managed-cluster)
### Responses
@@ -203,14 +191,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID.
# Get Managed Cluster
try {
Get-ManagedCluster-Id $Id
@@ -221,11 +210,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-managed-clusters
List current organization's managed clusters, based on request context.
### Parameters
@@ -237,7 +223,6 @@ Param Type | Name | Data Type | Required | Description
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq*
### Return type
[**ManagedCluster[]**](../models/managed-cluster)
### Responses
@@ -251,7 +236,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -261,7 +245,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'operational eq "operation"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional)
# Get Managed Clusters
try {
Get-ManagedClusters
@@ -272,11 +258,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-client-log-configuration
Update a managed cluster's log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240.
### Parameters
@@ -286,7 +269,6 @@ Path | Id | **String** | True | ID of the managed cluster to update the log c
Body | PutClientLogConfigurationRequest | [**PutClientLogConfigurationRequest**](../models/put-client-log-configuration-request) | True | Client log configuration for the given managed cluster.
### Return type
[**ClientLogConfiguration**](../models/client-log-configuration)
### Responses
@@ -301,7 +283,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -309,7 +290,9 @@ Code | Description | Data Type
```powershell
$Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for.
$PutClientLogConfigurationRequest = @""@
# Update Managed Cluster Log Configuration
try {
$Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest
Send-ClientLogConfiguration-Id $Id -PutClientLogConfigurationRequest $Result
@@ -321,11 +304,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-managed-cluster
Update an existing managed cluster.
### Parameters
@@ -335,7 +315,6 @@ Path | Id | **String** | True | Managed cluster ID.
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | JSONPatch payload used to update the object.
### Return type
[**ManagedCluster**](../models/managed-cluster)
### Responses
@@ -350,21 +329,21 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
### Example
```powershell
$Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID.
# JsonPatchOperation[] | JSONPatch payload used to update the object.
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] | JSONPatch payload used to update the object.
# Update Managed Cluster
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-ManagedCluster-Id $Id -JsonPatchOperation $Result
@@ -376,7 +355,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

File diff suppressed because it is too large Load Diff

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

@@ -1,3 +1,4 @@
---
id: o-auth-clients
title: OAuthClients
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/o-auth-clients
tags: ['SDK', 'Software Development Kit', 'OAuthClients', 'OAuthClients']
---
# OAuthClients
Use this API to implement OAuth client functionality.
With this functionality in place, users with the appropriate security scopes can create and configure OAuth clients to use as a way to obtain authorization to use the Identity Security Cloud REST API.
@@ -27,9 +27,7 @@ Method | HTTP request | Description
[**Get-OauthClients**](#list-oauth-clients) | **GET** `/oauth-clients` | List OAuth Clients
[**Update-OauthClient**](#patch-oauth-client) | **PATCH** `/oauth-clients/{id}` | Patch OAuth Client
## create-oauth-client
This creates an OAuth client.
### Parameters
@@ -38,7 +36,6 @@ Param Type | Name | Data Type | Required | Description
Body | CreateOAuthClientRequest | [**CreateOAuthClientRequest**](../models/create-o-auth-client-request) | True |
### Return type
[**CreateOAuthClientResponse**](../models/create-o-auth-client-response)
### Responses
@@ -52,7 +49,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -75,7 +71,9 @@ $CreateOAuthClientRequest = @"{
"name" : "Demo API Client",
"claimsSupported" : false
}"@
# Create OAuth Client
try {
$Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest
New-OauthClient-CreateOAuthClientRequest $Result
@@ -87,11 +85,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-oauth-client
This deletes an OAuth client.
### Parameters
@@ -100,7 +95,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The OAuth client id
### Return type
(empty response body)
### Responses
@@ -115,14 +109,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id
# Delete OAuth Client
try {
Remove-OauthClient-Id $Id
@@ -133,11 +128,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-oauth-client
This gets details of an OAuth client.
### Parameters
@@ -146,7 +138,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The OAuth client id
### Return type
[**GetOAuthClientResponse**](../models/get-o-auth-client-response)
### Responses
@@ -161,14 +152,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id
# Get OAuth Client
try {
Get-OauthClient-Id $Id
@@ -179,11 +171,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-oauth-clients
This gets a list of OAuth clients.
### Parameters
@@ -192,7 +181,6 @@ Param Type | Name | Data Type | Required | Description
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull*
### Return type
[**GetOAuthClientResponse[]**](../models/get-o-auth-client-response)
### Responses
@@ -206,14 +194,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional)
# List OAuth Clients
try {
Get-OauthClients
@@ -224,11 +213,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-oauth-client
This performs a targeted update to the field(s) of an OAuth client.
### Parameters
@@ -238,7 +224,6 @@ Path | Id | **String** | True | The OAuth client id
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported
### Return type
[**GetOAuthClientResponse**](../models/get-o-auth-client-response)
### Responses
@@ -253,21 +238,21 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id
# JsonPatchOperation[] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported
# Patch OAuth Client
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-OauthClient-Id $Id -JsonPatchOperation $Result
@@ -279,7 +264,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: password-configuration
title: PasswordConfiguration
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/password-configuration
tags: ['SDK', 'Software Development Kit', 'PasswordConfiguration', 'PasswordConfiguration']
---
# PasswordConfiguration
Use this API to implement organization password configuration functionality.
With this functionality in place, organization administrators can create organization-specific password configurations.
@@ -28,9 +28,7 @@ Method | HTTP request | Description
[**Get-PasswordOrgConfig**](#get-password-org-config) | **GET** `/password-org-config` | Get Password Org Config
[**Send-PasswordOrgConfig**](#put-password-org-config) | **PUT** `/password-org-config` | Update Password Org Config
## create-password-org-config
This API creates the password org config. Unspecified fields will use default value.
To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true".
Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write'
@@ -41,7 +39,6 @@ Param Type | Name | Data Type | Required | Description
Body | PasswordOrgConfig | [**PasswordOrgConfig**](../models/password-org-config) | True |
### Return type
[**PasswordOrgConfig**](../models/password-org-config)
### Responses
@@ -55,7 +52,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -67,7 +63,9 @@ $PasswordOrgConfig = @"{
"digitTokenDurationMinutes" : 10,
"customInstructionsEnabled" : true
}"@
# Create Password Org Config
try {
$Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig
New-PasswordOrgConfig-PasswordOrgConfig $Result
@@ -79,11 +77,8 @@ try {
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'
### Parameters
@@ -91,7 +86,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**PasswordOrgConfig**](../models/password-org-config)
### Responses
@@ -105,13 +99,14 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
# Get Password Org Config
try {
Get-PasswordOrgConfig
@@ -122,11 +117,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[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'
@@ -137,7 +129,6 @@ Param Type | Name | Data Type | Required | Description
Body | PasswordOrgConfig | [**PasswordOrgConfig**](../models/password-org-config) | True |
### Return type
[**PasswordOrgConfig**](../models/password-org-config)
### Responses
@@ -151,7 +142,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -163,7 +153,9 @@ $PasswordOrgConfig = @"{
"digitTokenDurationMinutes" : 10,
"customInstructionsEnabled" : true
}"@
# Update Password Org Config
try {
$Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig
Send-PasswordOrgConfig-PasswordOrgConfig $Result
@@ -175,7 +167,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: password-dictionary
title: PasswordDictionary
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/password-dictionary
tags: ['SDK', 'Software Development Kit', 'PasswordDictionary', 'PasswordDictionary']
---
# PasswordDictionary
Use this API to implement password dictionary functionality.
With this functionality in place, administrators can create password dictionaries to prevent users from using certain words or characters in their passwords.
@@ -68,9 +68,7 @@ Method | HTTP request | Description
[**Get-PasswordDictionary**](#get-password-dictionary) | **GET** `/password-dictionary` | Get Password Dictionary
[**Send-PasswordDictionary**](#put-password-dictionary) | **PUT** `/password-dictionary` | Update Password Dictionary
## get-password-dictionary
This gets password dictionary for the organization.
The password dictionary file can contain lines that are:
1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing
@@ -106,7 +104,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
**String**
### Responses
@@ -121,13 +118,14 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain, application/json
### Example
```powershell
# Get Password Dictionary
try {
Get-PasswordDictionary
@@ -138,11 +136,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-password-dictionary
This updates password dictionary for the organization.
The password dictionary file can contain lines that are:
1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing
@@ -179,7 +174,6 @@ Param Type | Name | Data Type | Required | Description
| File | **System.IO.FileInfo** | (optional) |
### Return type
(empty response body)
### Responses
@@ -195,14 +189,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
### Example
```powershell
$File = # System.IO.FileInfo | (optional)
# Update Password Dictionary
try {
Send-PasswordDictionary
@@ -213,7 +208,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: password-management
title: PasswordManagement
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/password-management
tags: ['SDK', 'Software Development Kit', 'PasswordManagement', 'PasswordManagement']
---
# PasswordManagement
Use this API to implement password management functionality.
With this functionality in place, users can manage their identity passwords for all their applications.
@@ -46,9 +46,7 @@ Method | HTTP request | Description
[**Search-PasswordInfo**](#query-password-info) | **POST** `/query-password-info` | Query Password Info
[**Set-Password**](#set-password) | **POST** `/set-password` | Set Identity&#39;s Password
## get-password-change-status
This API returns the status of a password change request.
### Parameters
@@ -57,7 +55,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Password change request ID
### Return type
[**PasswordStatus**](../models/password-status)
### Responses
@@ -72,14 +69,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID
# Get Password Change Request Status
try {
Get-PasswordChangeStatus-Id $Id
@@ -90,11 +88,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## query-password-info
This API is used to query password related information.
@@ -104,7 +99,6 @@ Param Type | Name | Data Type | Required | Description
Body | PasswordInfoQueryDTO | [**PasswordInfoQueryDTO**](../models/password-info-query-dto) | True |
### Return type
[**PasswordInfo**](../models/password-info)
### Responses
@@ -118,7 +112,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -128,7 +121,9 @@ $PasswordInfoQueryDTO = @"{
"sourceName" : "My-AD",
"userName" : "Abby.Smith"
}"@
# Query Password Info
try {
$Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO
Search-PasswordInfo-PasswordInfoQueryDTO $Result
@@ -140,11 +135,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-password
This API is used to set a password for an identity.
An identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or ["authorization_code" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow).
@@ -172,7 +164,6 @@ Param Type | Name | Data Type | Required | Description
Body | PasswordChangeRequest | [**PasswordChangeRequest**](../models/password-change-request) | True |
### Return type
[**PasswordChangeResponse**](../models/password-change-response)
### Responses
@@ -186,7 +177,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -199,7 +189,9 @@ $PasswordChangeRequest = @"{
"publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2",
"encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A=="
}"@
# Set Identity's Password
try {
$Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest
Set-Password-PasswordChangeRequest $Result
@@ -211,7 +203,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: password-policies
title: PasswordPolicies
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/password-policies
tags: ['SDK', 'Software Development Kit', 'PasswordPolicies', 'PasswordPolicies']
---
# PasswordPolicies
Use these APIs to implement password policies functionality.
These APIs allow you to define the policy parameters for choosing passwords.
@@ -32,9 +32,7 @@ Method | HTTP request | Description
[**Get-PasswordPolicies**](#list-password-policies) | **GET** `/password-policies` | List Password Policies
[**Set-PasswordPolicy**](#set-password-policy) | **PUT** `/password-policies/{id}` | Update Password Policy by ID
## create-password-policy
This API creates the specified password policy.
### Parameters
@@ -43,7 +41,6 @@ Param Type | Name | Data Type | Required | Description
Body | PasswordPolicyV3Dto | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | True |
### Return type
[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto)
### Responses
@@ -58,7 +55,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -97,7 +93,9 @@ $PasswordPolicyV3Dto = @"{
"name" : "PasswordPolicy Example",
"maxLength" : 25
}"@
# Create Password Policy
try {
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
New-PasswordPolicy-PasswordPolicyV3Dto $Result
@@ -109,11 +107,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-password-policy
This API deletes the specified password policy.
### Parameters
@@ -122,7 +117,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The ID of password policy to delete.
### Return type
(empty response body)
### Responses
@@ -137,14 +131,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete.
# Delete Password Policy by ID
try {
Remove-PasswordPolicy-Id $Id
@@ -155,11 +150,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-password-policy-by-id
This API returns the password policy for the specified ID.
### Parameters
@@ -168,7 +160,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The ID of password policy to retrieve.
### Return type
[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto)
### Responses
@@ -183,14 +174,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve.
# Get Password Policy by ID
try {
Get-PasswordPolicyById-Id $Id
@@ -201,11 +193,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-password-policies
This gets list of all Password Policies.
Requires role of ORG_ADMIN
@@ -217,7 +206,6 @@ Param Type | Name | Data Type | Required | Description
Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
### Return type
[**PasswordPolicyV3Dto[]**](../models/password-policy-v3-dto)
### Responses
@@ -231,7 +219,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -240,7 +227,9 @@ Code | Description | Data Type
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
# List Password Policies
try {
Get-PasswordPolicies
@@ -251,11 +240,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-password-policy
This API updates the specified password policy.
### Parameters
@@ -265,7 +251,6 @@ Path | Id | **String** | True | The ID of password policy to update.
Body | PasswordPolicyV3Dto | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | True |
### Return type
[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto)
### Responses
@@ -280,7 +265,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -320,7 +304,9 @@ $PasswordPolicyV3Dto = @"{
"name" : "PasswordPolicy Example",
"maxLength" : 25
}"@
# Update Password Policy by ID
try {
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
Set-PasswordPolicy-Id $Id -PasswordPolicyV3Dto $Result
@@ -332,7 +318,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: password-sync-groups
title: PasswordSyncGroups
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/password-sync-groups
tags: ['SDK', 'Software Development Kit', 'PasswordSyncGroups', 'PasswordSyncGroups']
---
# PasswordSyncGroups
Use this API to implement password sync group functionality.
With this functionality in place, administrators can group sources into password sync groups so that all their applications share the same password.
@@ -56,9 +56,7 @@ Method | HTTP request | Description
[**Get-PasswordSyncGroups**](#get-password-sync-groups) | **GET** `/password-sync-groups` | Get Password Sync Group List
[**Update-PasswordSyncGroup**](#update-password-sync-group) | **PUT** `/password-sync-groups/{id}` | Update Password Sync Group by ID
## create-password-sync-group
This API creates a password sync group based on the specifications provided.
### Parameters
@@ -67,7 +65,6 @@ Param Type | Name | Data Type | Required | Description
Body | PasswordSyncGroup | [**PasswordSyncGroup**](../models/password-sync-group) | True |
### Return type
[**PasswordSyncGroup**](../models/password-sync-group)
### Responses
@@ -81,7 +78,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -95,7 +91,9 @@ $PasswordSyncGroup = @"{
"id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd",
"sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ]
}"@
# Create Password Sync Group
try {
$Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup
New-PasswordSyncGroup-PasswordSyncGroup $Result
@@ -107,11 +105,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-password-sync-group
This API deletes the specified password sync group.
### Parameters
@@ -120,7 +115,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The ID of password sync group to delete.
### Return type
(empty response body)
### Responses
@@ -134,14 +128,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete.
# Delete Password Sync Group by ID
try {
Remove-PasswordSyncGroup-Id $Id
@@ -152,11 +147,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-password-sync-group
This API returns the sync group for the specified ID.
### Parameters
@@ -165,7 +157,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The ID of password sync group to retrieve.
### Return type
[**PasswordSyncGroup**](../models/password-sync-group)
### Responses
@@ -180,14 +171,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve.
# Get Password Sync Group by ID
try {
Get-PasswordSyncGroup-Id $Id
@@ -198,11 +190,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-password-sync-groups
This API returns a list of password sync groups.
### Parameters
@@ -213,7 +202,6 @@ Param Type | Name | Data Type | Required | Description
Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
### Return type
[**PasswordSyncGroup[]**](../models/password-sync-group)
### Responses
@@ -227,7 +215,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -236,7 +223,9 @@ Code | Description | Data Type
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
# Get Password Sync Group List
try {
Get-PasswordSyncGroups
@@ -247,11 +236,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-password-sync-group
This API updates the specified password sync group.
### Parameters
@@ -261,7 +247,6 @@ Path | Id | **String** | True | The ID of password sync group to update.
Body | PasswordSyncGroup | [**PasswordSyncGroup**](../models/password-sync-group) | True |
### Return type
[**PasswordSyncGroup**](../models/password-sync-group)
### Responses
@@ -276,7 +261,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -291,7 +275,9 @@ $PasswordSyncGroup = @"{
"id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd",
"sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ]
}"@
# Update Password Sync Group by ID
try {
$Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup
Update-PasswordSyncGroup-Id $Id -PasswordSyncGroup $Result
@@ -303,7 +289,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: personal-access-tokens
title: PersonalAccessTokens
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/personal-access-tokens
tags: ['SDK', 'Software Development Kit', 'PersonalAccessTokens', 'PersonalAccessTokens']
---
# PersonalAccessTokens
Use this API to implement personal access token (PAT) functionality.
With this functionality in place, users can use PATs as an alternative to passwords for authentication in Identity Security Cloud.
@@ -34,9 +34,7 @@ Method | HTTP request | Description
[**Get-PersonalAccessTokens**](#list-personal-access-tokens) | **GET** `/personal-access-tokens` | List Personal Access Tokens
[**Update-PersonalAccessToken**](#patch-personal-access-token) | **PATCH** `/personal-access-tokens/{id}` | Patch Personal Access Token
## create-personal-access-token
This creates a personal access token.
### Parameters
@@ -45,7 +43,6 @@ Param Type | Name | Data Type | Required | Description
Body | CreatePersonalAccessTokenRequest | [**CreatePersonalAccessTokenRequest**](../models/create-personal-access-token-request) | True | Name and scope of personal access token.
### Return type
[**CreatePersonalAccessTokenResponse**](../models/create-personal-access-token-response)
### Responses
@@ -59,7 +56,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -70,7 +66,9 @@ $CreatePersonalAccessTokenRequest = @"{
"accessTokenValiditySeconds" : 36900,
"name" : "NodeJS Integration"
}"@
# Create Personal Access Token
try {
$Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest
New-PersonalAccessToken-CreatePersonalAccessTokenRequest $Result
@@ -82,11 +80,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-personal-access-token
This deletes a personal access token.
### Parameters
@@ -95,7 +90,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The personal access token id
### Return type
(empty response body)
### Responses
@@ -110,14 +104,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id
# Delete Personal Access Token
try {
Remove-PersonalAccessToken-Id $Id
@@ -128,11 +123,8 @@ try {
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.
### Parameters
@@ -142,7 +134,6 @@ Param Type | Name | Data Type | Required | Description
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull*
### Return type
[**GetPersonalAccessTokenResponse[]**](../models/get-personal-access-token-response)
### Responses
@@ -156,7 +147,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -164,7 +154,9 @@ Code | Description | Data Type
```powershell
$OwnerId = "2c9180867b50d088017b554662fb281e" # String | The identity ID of the owner whose personal access tokens should be listed. If ""me"", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional)
$Filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional)
# List Personal Access Tokens
try {
Get-PersonalAccessTokens
@@ -175,11 +167,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-personal-access-token
This performs a targeted update to the field(s) of a Personal Access Token.
Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens.
@@ -190,7 +179,6 @@ Path | Id | **String** | True | The Personal Access Token id
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope
### Return type
[**GetPersonalAccessTokenResponse**](../models/get-personal-access-token-response)
### Responses
@@ -205,21 +193,21 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id
# JsonPatchOperation[] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope
# Patch Personal Access Token
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-PersonalAccessToken-Id $Id -JsonPatchOperation $Result
@@ -231,7 +219,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: public-identities
title: PublicIdentities
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/public-identities
tags: ['SDK', 'Software Development Kit', 'PublicIdentities', 'PublicIdentities']
---
# PublicIdentities
Use this API in conjunction with [Public Identites Config](https://developer.sailpoint.com/docs/api/v3/public-identities-config/) to enable non-administrators to view identities&#39; publicly visible attributes.
With this functionality in place, non-administrators can view identity attributes other than the default attributes (email, lifecycle state, and manager), depending on which identity attributes their organization administrators have made public.
@@ -23,9 +23,7 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-PublicIdentities**](#get-public-identities) | **GET** `/public-identities` | Get list of public identities
## get-public-identities
Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts.
### Parameters
@@ -39,7 +37,6 @@ Param Type | Name | Data Type | Required | Description
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name**
### Return type
[**PublicIdentity[]**](../models/public-identity)
### Responses
@@ -53,7 +50,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -65,7 +61,9 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'firstname eq "John"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional)
$AddCoreFilters = $false # Boolean | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be ""spadmin"" or ""cloudadmin"". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to $false)
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional)
# Get list of public identities
try {
Get-PublicIdentities
@@ -76,7 +74,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: public-identities-config
title: PublicIdentitiesConfig
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/public-identities-config
tags: ['SDK', 'Software Development Kit', 'PublicIdentitiesConfig', 'PublicIdentitiesConfig']
---
# PublicIdentitiesConfig
Use this API to implement public identity configuration functionality.
With this functionality in place, administrators can make up to 5 identity attributes publicly visible so other non-administrator users can see the relevant information they need to make decisions.
@@ -31,9 +31,7 @@ Method | HTTP request | Description
[**Get-PublicIdentityConfig**](#get-public-identity-config) | **GET** `/public-identities-config` | Get the Public Identities Configuration
[**Update-PublicIdentityConfig**](#update-public-identity-config) | **PUT** `/public-identities-config` | Update the Public Identities Configuration
## get-public-identity-config
Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns.
### Parameters
@@ -41,7 +39,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**PublicIdentityConfig**](../models/public-identity-config)
### Responses
@@ -55,13 +52,14 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
# Get the Public Identities Configuration
try {
Get-PublicIdentityConfig
@@ -72,11 +70,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-public-identity-config
Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns.
### Parameters
@@ -85,7 +80,6 @@ Param Type | Name | Data Type | Required | Description
Body | PublicIdentityConfig | [**PublicIdentityConfig**](../models/public-identity-config) | True |
### Return type
[**PublicIdentityConfig**](../models/public-identity-config)
### Responses
@@ -99,7 +93,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -120,7 +113,9 @@ $PublicIdentityConfig = @"{
"type" : "IDENTITY"
}
}"@
# Update the Public Identities Configuration
try {
$Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig
Update-PublicIdentityConfig-PublicIdentityConfig $Result
@@ -132,7 +127,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: reports-data-extraction
title: ReportsDataExtraction
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/reports-data-extraction
tags: ['SDK', 'Software Development Kit', 'ReportsDataExtraction', 'ReportsDataExtraction']
---
# ReportsDataExtraction
Use this API to implement reports lifecycle managing and monitoring.
With this functionality in place, users can run reports, view their results, and cancel reports in progress.
@@ -26,9 +26,7 @@ Method | HTTP request | Description
[**Get-ReportResult**](#get-report-result) | **GET** `/reports/{taskResultId}/result` | Get Report Result
[**Start-Report**](#start-report) | **POST** `/reports/run` | Run Report
## cancel-report
Cancels a running report.
### Parameters
@@ -37,7 +35,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the running Report to cancel
### Return type
(empty response body)
### Responses
@@ -51,14 +48,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to cancel
# Cancel Report
try {
Suspend-Report-Id $Id
@@ -69,11 +67,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-report
Gets a report in file format.
### Parameters
@@ -85,7 +80,6 @@ Path | TaskResultId | **String** | True | Unique identifier of the task resul
Query | Auditable | **Boolean** | (optional) (default to $false) | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId.
### Return type
**System.IO.FileInfo**
### Responses
@@ -100,7 +94,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/csv, application/pdf, application/json
@@ -110,7 +103,9 @@ $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier
$FileFormat = "csv" # String | Output format of the requested report file
$Name = "Identities Details Report" # String | preferred Report file name, by default will be used report name from task result. (optional)
$Auditable = $true # Boolean | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to $false)
# Get Report File
try {
Get-Report-TaskResultId $TaskResultId -FileFormat $FileFormat
@@ -121,11 +116,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-report-result
Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name.
### Parameters
@@ -135,7 +127,6 @@ Path | TaskResultId | **String** | True | Unique identifier of the task resul
Query | Completed | **Boolean** | (optional) (default to $false) | state of task result to apply ordering when results are fetching from the DB
### Return type
[**ReportResults**](../models/report-results)
### Responses
@@ -149,7 +140,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -157,7 +147,9 @@ Code | Description | Data Type
```powershell
$TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report
$Completed = $true # Boolean | state of task result to apply ordering when results are fetching from the DB (optional) (default to $false)
# Get Report Result
try {
Get-ReportResult-TaskResultId $TaskResultId
@@ -168,11 +160,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-report
Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns.
### Parameters
@@ -181,7 +170,6 @@ Param Type | Name | Data Type | Required | Description
Body | ReportDetails | [**ReportDetails**](../models/report-details) | True |
### Return type
[**TaskResultDetails**](../models/task-result-details)
### Responses
@@ -195,7 +183,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -208,7 +195,9 @@ $ReportDetails = @"{
"sourceName" : "Active Directory"
}
}"@
# Run Report
try {
$Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails
Start-Report-ReportDetails $Result
@@ -220,7 +209,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: requestable-objects
title: RequestableObjects
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/requestable-objects
tags: ['SDK', 'Software Development Kit', 'RequestableObjects', 'RequestableObjects']
---
# RequestableObjects
Use this API to implement requestable object functionality.
With this functionality in place, administrators can determine which access items can be requested with the [Access Request APIs](https://developer.sailpoint.com/docs/api/v3/access-requests/), along with their statuses.
@@ -23,9 +23,7 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-RequestableObjects**](#list-requestable-objects) | **GET** `/requestable-objects` | Requestable Objects List
## list-requestable-objects
This endpoint returns a list of acccess items that that can be requested through the Access Request endpoints. Access items are marked with AVAILABLE, PENDING or ASSIGNED with respect to the identity provided using *identity-id* query param.
Any authenticated token can call this endpoint to see their requestable access items.
@@ -43,7 +41,6 @@ Param Type | Name | Data Type | Required | Description
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name**
### Return type
[**RequestableObject[]**](../models/requestable-object)
### Responses
@@ -57,7 +54,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -66,17 +62,19 @@ Code | Description | Data Type
$IdentityId = "e7eab60924f64aa284175b9fa3309599" # String | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional)
$Types = "ACCESS_PROFILE" # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice. (optional)
$Types = @"ROLE,ACCESS_PROFILE"@
$Types = @"ROLE,ACCESS_PROFILE"@ # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice. (optional)
$Term = "Finance Role" # String | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional)
$Statuses = "AVAILABLE" # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (optional)
$Statuses = @"[ASSIGNED, PENDING]"@
$Statuses = @"[ASSIGNED, PENDING]"@ # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (optional)
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'name sw "bob"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional)
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional)
# Requestable Objects List
try {
Get-RequestableObjects
@@ -87,7 +85,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: roles
title: Roles
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/roles
tags: ['SDK', 'Software Development Kit', 'Roles', 'Roles']
---
# Roles
Use this API to implement and customize role functionality.
With this functionality in place, administrators can create roles and configure them for use throughout Identity Security Cloud.
@@ -63,9 +63,7 @@ Method | HTTP request | Description
[**Get-Roles**](#list-roles) | **GET** `/roles` | List Roles
[**Update-Role**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified Role
## create-role
This API creates a role.
In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves.
@@ -77,7 +75,6 @@ Param Type | Name | Data Type | Required | Description
Body | Role | [**Role**](../models/role) | True |
### Return type
[**Role**](../models/role)
### Responses
@@ -91,7 +88,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -255,7 +251,9 @@ $Role = @"{
"id" : "2c918086749d78830174a1a40e121518",
"requestable" : true
}"@
# Create a Role
try {
$Result = ConvertFrom-JsonToRole -Json $Role
New-Role-Role $Result
@@ -267,11 +265,8 @@ try {
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.
@@ -283,7 +278,6 @@ Param Type | Name | Data Type | Required | Description
Body | RoleBulkDeleteRequest | [**RoleBulkDeleteRequest**](../models/role-bulk-delete-request) | True |
### Return type
[**TaskResultDto**](../models/task-result-dto)
### Responses
@@ -297,7 +291,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -306,7 +299,9 @@ Code | Description | Data Type
$RoleBulkDeleteRequest = @"{
"roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ]
}"@
# Delete Role(s)
try {
$Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest
Remove-BulkRoles-RoleBulkDeleteRequest $Result
@@ -318,11 +313,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-role
This API deletes a Role by its ID.
A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
@@ -333,7 +325,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the Role
### Return type
(empty response body)
### Responses
@@ -347,14 +338,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role
# Delete a Role
try {
Remove-Role-Id $Id
@@ -365,11 +357,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role
This API returns a Role by its ID.
A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
@@ -379,7 +368,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the Role
### Return type
[**Role**](../models/role)
### Responses
@@ -393,14 +381,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role
# Get a Role
try {
Get-Role-Id $Id
@@ -411,13 +400,10 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-assigned-identities
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -429,7 +415,6 @@ Path | Id | **String** | True | ID of the Role for which the assigned Identit
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email**
### Return type
[**RoleIdentity[]**](../models/role-identity)
### Responses
@@ -443,7 +428,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -455,7 +439,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'name sw Joe' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional)
$Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional)
# List Identities assigned a Role
try {
Get-RoleAssignedIdentities-Id $Id
@@ -466,11 +452,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-roles
This API returns a list of Roles.
### Parameters
@@ -486,7 +469,6 @@ Param Type | Name | Data Type | Required | Description
Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
### Return type
[**Role[]**](../models/role)
### Responses
@@ -500,7 +482,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -514,7 +495,9 @@ $Filters = 'requestable eq false' # String | Filter results using the standard s
$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional)
$ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional)
$IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true)
# List Roles
try {
Get-Roles
@@ -525,11 +508,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-role
This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
The following fields are patchable:
* name
@@ -558,7 +538,6 @@ Path | Id | **String** | True | ID of the Role to patch
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True |
### Return type
[**Role**](../models/role)
### Responses
@@ -572,21 +551,21 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
### Example
```powershell
$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch
# JsonPatchOperation[] |
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] |
# Patch a specified Role
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-Role-Id $Id -JsonPatchOperation $Result
@@ -598,7 +577,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: sod-policies
title: SODPolicies
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/sod-policies
tags: ['SDK', 'Software Development Kit', 'SODPolicies', 'SODPolicies']
---
# SODPolicies
Use this API to implement and manage &quot;separation of duties&quot; (SOD) policies.
With SOD policy functionality in place, administrators can organize the access in their tenants to prevent individuals from gaining conflicting or excessive access.
@@ -62,9 +62,7 @@ Method | HTTP request | Description
[**Start-SodAllPoliciesForOrg**](#start-sod-all-policies-for-org) | **POST** `/sod-violation-report/run` | Runs all policies for org
[**Start-SodPolicy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report
## create-sod-policy
This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy.
Requires role of ORG_ADMIN.
@@ -74,7 +72,6 @@ Param Type | Name | Data Type | Required | Description
Body | SodPolicy | [**SodPolicy**](../models/sod-policy) | True |
### Return type
[**SodPolicy**](../models/sod-policy)
### Responses
@@ -88,7 +85,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -150,7 +146,9 @@ $SodPolicy = @"{
"state" : "ENFORCED",
"externalPolicyReference" : "XYZ policy"
}"@
# Create SOD policy
try {
$Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy
New-SodPolicy-SodPolicy $Result
@@ -162,11 +160,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-sod-policy
This deletes a specified SOD policy.
Requires role of ORG_ADMIN.
@@ -177,7 +172,6 @@ Path | Id | **String** | True | The ID of the SOD Policy to delete.
Query | Logical | **Boolean** | (optional) (default to $true) | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call.
### Return type
(empty response body)
### Responses
@@ -192,7 +186,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -200,7 +193,9 @@ Code | Description | Data Type
```powershell
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete.
$Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true)
# Delete SOD policy by ID
try {
Remove-SodPolicy-Id $Id
@@ -211,11 +206,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-sod-policy-schedule
This deletes schedule for a specified SOD policy by ID.
### Parameters
@@ -224,7 +216,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The ID of the SOD policy the schedule must be deleted for.
### Return type
(empty response body)
### Responses
@@ -239,14 +230,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for.
# Delete SOD policy schedule
try {
Remove-SodPolicySchedule-Id $Id
@@ -257,11 +249,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-custom-violation-report
This allows to download a specified named violation report for a given report reference.
### Parameters
@@ -271,7 +260,6 @@ Path | ReportResultId | **String** | True | The ID of the report reference to
Path | FileName | **String** | True | Custom Name for the file.
### Return type
**System.IO.FileInfo**
### Responses
@@ -286,7 +274,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/zip, application/json
@@ -294,7 +281,9 @@ Code | Description | Data Type
```powershell
$ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download.
$FileName = "custom-name" # String | Custom Name for the file.
# Download custom violation report
try {
Get-CustomViolationReport-ReportResultId $ReportResultId -FileName $FileName
@@ -305,11 +294,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-default-violation-report
This allows to download a violation report for a given report reference.
### Parameters
@@ -318,7 +304,6 @@ Param Type | Name | Data Type | Required | Description
Path | ReportResultId | **String** | True | The ID of the report reference to download.
### Return type
**System.IO.FileInfo**
### Responses
@@ -333,14 +318,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/zip, application/json
### Example
```powershell
$ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download.
# Download violation report
try {
Get-DefaultViolationReport-ReportResultId $ReportResultId
@@ -351,11 +337,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sod-all-report-run-status
This endpoint gets the status for a violation report for all policy run.
### Parameters
@@ -363,7 +346,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**ReportResultReference**](../models/report-result-reference)
### Responses
@@ -377,13 +359,14 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
# Get multi-report run task status
try {
Get-SodAllReportRunStatus
@@ -394,11 +377,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sod-policy
This gets specified SOD policy.
Requires role of ORG_ADMIN.
@@ -408,7 +388,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The ID of the SOD Policy to retrieve.
### Return type
[**SodPolicy**](../models/sod-policy)
### Responses
@@ -423,14 +402,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve.
# Get SOD policy by ID
try {
Get-SodPolicy-Id $Id
@@ -441,11 +421,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sod-policy-schedule
This endpoint gets a specified SOD policy's schedule.
### Parameters
@@ -454,7 +431,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The ID of the SOD policy schedule to retrieve.
### Return type
[**SodPolicySchedule**](../models/sod-policy-schedule)
### Responses
@@ -468,14 +444,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve.
# Get SOD policy schedule
try {
Get-SodPolicySchedule-Id $Id
@@ -486,11 +463,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sod-violation-report-run-status
This gets the status for a violation report run task that has already been invoked.
### Parameters
@@ -499,7 +473,6 @@ Param Type | Name | Data Type | Required | Description
Path | ReportResultId | **String** | True | The ID of the report reference to retrieve.
### Return type
[**ReportResultReference**](../models/report-result-reference)
### Responses
@@ -514,14 +487,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve.
# Get violation report run status
try {
Get-SodViolationReportRunStatus-ReportResultId $ReportResultId
@@ -532,11 +506,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sod-violation-report-status
This gets the status for a violation report run task that has already been invoked.
### Parameters
@@ -545,7 +516,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The ID of the violation report to retrieve status for.
### Return type
[**ReportResultReference**](../models/report-result-reference)
### Responses
@@ -560,14 +530,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for.
# Get SOD violation report status
try {
Get-SodViolationReportStatus-Id $Id
@@ -578,11 +549,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-sod-policies
This gets list of all SOD policies.
Requires role of ORG_ADMIN
@@ -596,7 +564,6 @@ Param Type | Name | Data Type | Required | Description
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description**
### Return type
[**SodPolicy[]**](../models/sod-policy)
### Responses
@@ -610,7 +577,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -621,7 +587,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'id eq "bc693f07e7b645539626c25954c58554"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional)
$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional)
# List SOD policies
try {
Get-SodPolicies
@@ -632,11 +600,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-sod-policy
Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
Requires role of ORG_ADMIN.
This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception.
@@ -648,7 +613,6 @@ Path | Id | **String** | True | The ID of the SOD policy being modified.
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria
### Return type
[**SodPolicy**](../models/sod-policy)
### Responses
@@ -663,21 +627,21 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
### Example
```powershell
$Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified.
# JsonPatchOperation[] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria
# Patch SOD policy by ID
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-SodPolicy-Id $Id -JsonPatchOperation $Result
@@ -689,11 +653,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-policy-schedule
This updates schedule for a specified SOD policy.
### Parameters
@@ -703,7 +664,6 @@ Path | Id | **String** | True | The ID of the SOD policy to update its schedu
Body | SodPolicySchedule | [**SodPolicySchedule**](../models/sod-policy-schedule) | True |
### Return type
[**SodPolicySchedule**](../models/sod-policy-schedule)
### Responses
@@ -717,7 +677,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -762,7 +721,9 @@ $SodPolicySchedule = @"{
"description" : "Schedule for policy xyz",
"emailEmptyResults" : false
}"@
# Update SOD Policy schedule
try {
$Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule
Send-PolicySchedule-Id $Id -SodPolicySchedule $Result
@@ -774,11 +735,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-sod-policy
This updates a specified SOD policy.
Requires role of ORG_ADMIN.
@@ -789,7 +747,6 @@ Path | Id | **String** | True | The ID of the SOD policy to update.
Body | SodPolicy | [**SodPolicy**](../models/sod-policy) | True |
### Return type
[**SodPolicy**](../models/sod-policy)
### Responses
@@ -804,7 +761,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -867,7 +823,9 @@ $SodPolicy = @"{
"state" : "ENFORCED",
"externalPolicyReference" : "XYZ policy"
}"@
# Update SOD policy by ID
try {
$Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy
Send-SodPolicy-Id $Id -SodPolicy $Result
@@ -879,11 +837,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-evaluate-sod-policy
Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID.
### Parameters
@@ -892,7 +847,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The SOD policy ID to run.
### Return type
[**ReportResultReference**](../models/report-result-reference)
### Responses
@@ -906,14 +860,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run.
# Evaluate one policy by ID
try {
Start-EvaluateSodPolicy-Id $Id
@@ -924,11 +879,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-sod-all-policies-for-org
Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided.
### Parameters
@@ -937,7 +889,6 @@ Param Type | Name | Data Type | Required | Description
Body | MultiPolicyRequest | [**MultiPolicyRequest**](../models/multi-policy-request) | (optional) |
### Return type
[**ReportResultReference**](../models/report-result-reference)
### Responses
@@ -951,7 +902,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -960,7 +910,9 @@ Code | Description | Data Type
$MultiPolicyRequest = @"{
"filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ]
}"@
# Runs all policies for org
try {
Start-SodAllPoliciesForOrg
@@ -971,11 +923,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-sod-policy
This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message.
### Parameters
@@ -984,7 +933,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The SOD policy ID to run.
### Return type
[**ReportResultReference**](../models/report-result-reference)
### Responses
@@ -999,14 +947,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run.
# Runs SOD policy violation report
try {
Start-SodPolicy-Id $Id
@@ -1017,7 +966,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: sod-violations
title: SODViolations
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/sod-violations
tags: ['SDK', 'Software Development Kit', 'SODViolations', 'SODViolations']
---
# SODViolations
Use this API to check for current &quot;separation of duties&quot; (SOD) policy violations as well as potential future SOD policy violations.
With SOD violation functionality in place, administrators can get information about current SOD policy violations and predict whether an access change will trigger new violations, which helps to prevent them from occurring at all.
@@ -39,9 +39,7 @@ Method | HTTP request | Description
[**Start-PredictSodViolations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict SOD violations for identity.
[**Start-ViolationCheck**](#start-violation-check) | **POST** `/sod-violations/check` | Check SOD violations
## start-predict-sod-violations
This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused.
### Parameters
@@ -50,7 +48,6 @@ Param Type | Name | Data Type | Required | Description
Body | IdentityWithNewAccess | [**IdentityWithNewAccess**](../models/identity-with-new-access) | True |
### Return type
[**ViolationPrediction**](../models/violation-prediction)
### Responses
@@ -65,7 +62,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -83,7 +79,9 @@ $IdentityWithNewAccess = @"{
"name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local"
} ]
}"@
# Predict SOD violations for identity.
try {
$Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess
Start-PredictSodViolations-IdentityWithNewAccess $Result
@@ -95,11 +93,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-violation-check
This API initiates a SOD policy verification asynchronously.
### Parameters
@@ -108,7 +103,6 @@ Param Type | Name | Data Type | Required | Description
Body | IdentityWithNewAccess1 | [**IdentityWithNewAccess1**](../models/identity-with-new-access1) | True |
### Return type
[**SodViolationCheck**](../models/sod-violation-check)
### Responses
@@ -123,14 +117,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```powershell
$IdentityWithNewAccess1 = @"{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}"@
# Check SOD violations
try {
$Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1
Start-ViolationCheck-IdentityWithNewAccess1 $Result
@@ -142,7 +137,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: saved-search
title: SavedSearch
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/saved-search
tags: ['SDK', 'Software Development Kit', 'SavedSearch', 'SavedSearch']
---
# SavedSearch
Use this API to implement saved search functionality.
With saved search functionality in place, users can save search queries and then view those saved searches, as well as rerun them.
@@ -35,9 +35,7 @@ Method | HTTP request | Description
[**Get-SavedSearches**](#list-saved-searches) | **GET** `/saved-searches` | A list of Saved Searches
[**Send-SavedSearch**](#put-saved-search) | **PUT** `/saved-searches/{id}` | Updates an existing saved search
## create-saved-search
Creates a new saved search.
@@ -47,7 +45,6 @@ Param Type | Name | Data Type | Required | Description
Body | CreateSavedSearchRequest | [**CreateSavedSearchRequest**](../models/create-saved-search-request) | True | The saved search to persist.
### Return type
[**SavedSearch**](../models/saved-search)
### Responses
@@ -61,14 +58,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```powershell
$CreateSavedSearchRequest = @""@
# Create a saved search
try {
$Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest
New-SavedSearch-CreateSavedSearchRequest $Result
@@ -80,11 +78,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-saved-search
Deletes the specified saved search.
@@ -94,7 +89,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the requested document.
### Return type
(empty response body)
### Responses
@@ -109,14 +103,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document.
# Delete document by ID
try {
Remove-SavedSearch-Id $Id
@@ -127,11 +122,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## execute-saved-search
Executes the specified saved search.
@@ -142,7 +134,6 @@ Path | Id | **String** | True | ID of the requested document.
Body | SearchArguments | [**SearchArguments**](../models/search-arguments) | True | When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided.
### Return type
(empty response body)
### Responses
@@ -157,7 +148,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -175,7 +165,9 @@ $SearchArguments = @"{
} ],
"scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8"
}"@
# Execute a saved search by ID
try {
$Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments
Invoke-ExecuteSavedSearch-Id $Id -SearchArguments $Result
@@ -187,11 +179,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-saved-search
Returns the specified saved search.
@@ -201,7 +190,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the requested document.
### Return type
[**SavedSearch**](../models/saved-search)
### Responses
@@ -216,14 +204,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document.
# Return saved search by ID
try {
Get-SavedSearch-Id $Id
@@ -234,11 +223,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-saved-searches
Returns a list of saved searches.
@@ -251,7 +237,6 @@ Param Type | Name | Data Type | Required | Description
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq*
### Return type
[**SavedSearch[]**](../models/saved-search)
### Responses
@@ -265,7 +250,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -275,7 +259,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional)
# A list of Saved Searches
try {
Get-SavedSearches
@@ -286,11 +272,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-saved-search
Updates an existing saved search.
>**NOTE: You cannot update the `owner` of the saved search.**
@@ -303,7 +286,6 @@ Path | Id | **String** | True | ID of the requested document.
Body | SavedSearch | [**SavedSearch**](../models/saved-search) | True | The saved search to persist.
### Return type
[**SavedSearch**](../models/saved-search)
### Responses
@@ -317,7 +299,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -369,7 +350,9 @@ $SavedSearch = @"{
"id" : "0de46054-fe90-434a-b84e-c6b3359d0c64",
"fields" : [ "disabled" ]
}"@
# Updates an existing saved search
try {
$Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch
Send-SavedSearch-Id $Id -SavedSearch $Result
@@ -381,7 +364,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: scheduled-search
title: ScheduledSearch
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/scheduled-search
tags: ['SDK', 'Software Development Kit', 'ScheduledSearch', 'ScheduledSearch']
---
# ScheduledSearch
Use this API to implement scheduled search functionality.
With scheduled search functionality in place, users can run saved search queries on their tenants on a schedule, and Identity Security Cloud emails them the search results.
@@ -51,9 +51,7 @@ Method | HTTP request | Description
[**Invoke-UnsubscribeScheduledSearch**](#unsubscribe-scheduled-search) | **POST** `/scheduled-searches/{id}/unsubscribe` | Unsubscribe a recipient from Scheduled Search
[**Update-ScheduledSearch**](#update-scheduled-search) | **PUT** `/scheduled-searches/{id}` | Update an existing Scheduled Search
## create-scheduled-search
Creates a new scheduled search.
@@ -63,7 +61,6 @@ Param Type | Name | Data Type | Required | Description
Body | CreateScheduledSearchRequest | [**CreateScheduledSearchRequest**](../models/create-scheduled-search-request) | True | The scheduled search to persist.
### Return type
[**ScheduledSearch**](../models/scheduled-search)
### Responses
@@ -78,14 +75,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```powershell
$CreateScheduledSearchRequest = @"{savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]}"@
# Create a new scheduled search
try {
$Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest
New-ScheduledSearch-CreateScheduledSearchRequest $Result
@@ -97,11 +95,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-scheduled-search
Deletes the specified scheduled search.
@@ -111,7 +106,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the requested document.
### Return type
(empty response body)
### Responses
@@ -126,14 +120,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document.
# Delete a Scheduled Search
try {
Remove-ScheduledSearch-Id $Id
@@ -144,11 +139,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-scheduled-search
Returns the specified scheduled search.
### Parameters
@@ -157,7 +149,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the requested document.
### Return type
[**ScheduledSearch**](../models/scheduled-search)
### Responses
@@ -172,14 +163,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document.
# Get a Scheduled Search
try {
Get-ScheduledSearch-Id $Id
@@ -190,11 +182,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-scheduled-search
Returns a list of scheduled searches.
@@ -207,7 +196,6 @@ Param Type | Name | Data Type | Required | Description
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq*
### Return type
[**ScheduledSearch[]**](../models/scheduled-search)
### Responses
@@ -222,7 +210,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -232,7 +219,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* (optional)
# List scheduled searches
try {
Get-ScheduledSearch
@@ -243,11 +232,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## unsubscribe-scheduled-search
Unsubscribes a recipient from the specified scheduled search.
@@ -258,7 +244,6 @@ Path | Id | **String** | True | ID of the requested document.
Body | TypedReference | [**TypedReference**](../models/typed-reference) | True | The recipient to be removed from the scheduled search.
### Return type
(empty response body)
### Responses
@@ -270,7 +255,6 @@ Code | Description | Data Type
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -281,7 +265,9 @@ $TypedReference = @"{
"id" : "2c91808568c529c60168cca6f90c1313",
"type" : "IDENTITY"
}"@
# Unsubscribe a recipient from Scheduled Search
try {
$Result = ConvertFrom-JsonToTypedReference -Json $TypedReference
Invoke-UnsubscribeScheduledSearch-Id $Id -TypedReference $Result
@@ -293,11 +279,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-scheduled-search
Updates an existing scheduled search.
@@ -308,7 +291,6 @@ Path | Id | **String** | True | ID of the requested document.
Body | ScheduledSearch | [**ScheduledSearch**](../models/scheduled-search) | True | The scheduled search to persist.
### Return type
[**ScheduledSearch**](../models/scheduled-search)
### Responses
@@ -323,7 +305,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -373,7 +354,9 @@ $ScheduledSearch = @"{
"id" : "0de46054-fe90-434a-b84e-c6b3359d0c64",
"emailEmptyResults" : false
}"@
# Update an existing Scheduled Search
try {
$Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch
Update-ScheduledSearch-Id $Id -ScheduledSearch $Result
@@ -385,7 +368,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: search
title: Search
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/search
tags: ['SDK', 'Software Development Kit', 'Search', 'Search']
---
# Search
Use this API to implement search functionality.
With search functionality in place, users can search their tenants for nearly any information from throughout their organizations.
@@ -46,9 +46,7 @@ Method | HTTP request | Description
[**Search-Get**](#search-get) | **GET** `/search/{index}/{id}` | Get a Document by ID
[**Search-Post**](#search-post) | **POST** `/search` | Perform Search
## search-aggregate
Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging.
### Parameters
@@ -60,7 +58,6 @@ Param Type | Name | Data Type | Required | Description
Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
### Return type
[**AggregationResult**](../models/aggregation-result)
### Responses
@@ -74,7 +71,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/csv
@@ -200,7 +196,9 @@ $Search = @"{
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
# Perform a Search Query Aggregation
try {
$Result = ConvertFrom-JsonToSearch -Json $Search
Search-Aggregate-Search $Result
@@ -212,11 +210,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## search-count
Performs a search with a provided query and returns the count of results in the X-Total-Count header.
### Parameters
@@ -225,7 +220,6 @@ Param Type | Name | Data Type | Required | Description
Body | Search | [**Search**](../models/search) | True |
### Return type
(empty response body)
### Responses
@@ -239,7 +233,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -362,7 +355,9 @@ $Search = @"{
}
}
}"@
# Count Documents Satisfying a Query
try {
$Result = ConvertFrom-JsonToSearch -Json $Search
Search-Count-Search $Result
@@ -374,11 +369,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## search-get
Fetches a single document from the specified index, using the specified document ID.
### Parameters
@@ -388,7 +380,6 @@ Path | Index | **String** | True | The index from which to fetch the specifie
Path | Id | **String** | True | ID of the requested document.
### Return type
[**SearchDocument**](../models/search-document)
### Responses
@@ -403,7 +394,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -411,7 +401,9 @@ Code | Description | Data Type
```powershell
$Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*.
$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document.
# Get a Document by ID
try {
Search-Get-Index $Index -Id $Id
@@ -422,11 +414,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## search-post
Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging.
### Parameters
@@ -438,7 +427,6 @@ Param Type | Name | Data Type | Required | Description
Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
### Return type
[**SearchDocument[]**](../models/search-document)
### Responses
@@ -452,7 +440,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -578,7 +565,9 @@ $Search = @"{
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Limit = 10000 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
# Perform Search
try {
$Result = ConvertFrom-JsonToSearch -Json $Search
Search-Post-Search $Result
@@ -590,7 +579,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: search-attribute-configuration
title: SearchAttributeConfiguration
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/search-attribute-configuration
tags: ['SDK', 'Software Development Kit', 'SearchAttributeConfiguration', 'SearchAttributeConfiguration']
---
# SearchAttributeConfiguration
Use this API to implement search attribute configuration functionality, along with [Search](https://developer.sailpoint.com/docs/api/v3/search).
With this functionality in place, administrators can create custom search attributes that and run extended searches based on those attributes to further narrow down their searches and get the information and insights they want.
@@ -42,9 +42,7 @@ Method | HTTP request | Description
[**Get-SingleSearchAttributeConfig**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute
[**Update-SearchAttributeConfig**](#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute
## create-search-attribute-config
Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create and attribute promotion configuration in the Link ObjectConfig.
### Parameters
@@ -53,7 +51,6 @@ Param Type | Name | Data Type | Required | Description
Body | SearchAttributeConfig | [**SearchAttributeConfig**](../models/search-attribute-config) | True |
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -68,7 +65,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -82,7 +78,9 @@ $SearchAttributeConfig = @"{
"2c91808b79fd2422017a0b36008f396b" : "employeeNumber"
}
}"@
# Create Extended Search Attributes
try {
$Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig
New-SearchAttributeConfig-SearchAttributeConfig $Result
@@ -94,11 +92,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-search-attribute-config
Delete an extended attribute configuration by name.
### Parameters
@@ -107,7 +102,6 @@ Param Type | Name | Data Type | Required | Description
Path | Name | **String** | True | Name of the extended search attribute configuration to delete.
### Return type
(empty response body)
### Responses
@@ -122,14 +116,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete.
# Delete Extended Search Attribute
try {
Remove-SearchAttributeConfig-Name $Name
@@ -140,11 +135,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-search-attribute-config
Get a list of attribute/application associates currently configured in Identity Security Cloud (ISC).
### Parameters
@@ -152,7 +144,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**SearchAttributeConfig[]**](../models/search-attribute-config)
### Responses
@@ -166,13 +157,14 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
# List Extended Search Attributes
try {
Get-SearchAttributeConfig
@@ -183,11 +175,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-single-search-attribute-config
Get an extended attribute configuration by name.
### Parameters
@@ -196,7 +185,6 @@ Param Type | Name | Data Type | Required | Description
Path | Name | **String** | True | Name of the extended search attribute configuration to retrieve.
### Return type
[**SearchAttributeConfig[]**](../models/search-attribute-config)
### Responses
@@ -212,14 +200,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Name = "newMailAttribute" # String | Name of the extended search attribute configuration to retrieve.
# Get Extended Search Attribute
try {
Get-SingleSearchAttributeConfig-Name $Name
@@ -230,11 +219,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-search-attribute-config
Update an existing search attribute configuration.
You can patch these fields:
* name * displayName * applicationAttributes
@@ -246,7 +232,6 @@ Path | Name | **String** | True | Name of the search attribute configuration
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True |
### Return type
[**SearchAttributeConfig**](../models/search-attribute-config)
### Responses
@@ -261,21 +246,21 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
### Example
```powershell
$Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch.
# JsonPatchOperation[] |
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] |
# Update Extended Search Attribute
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-SearchAttributeConfig-Name $Name -JsonPatchOperation $Result
@@ -287,7 +272,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: segments
title: Segments
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/segments
tags: ['SDK', 'Software Development Kit', 'Segments', 'Segments']
---
# Segments
Use this API to implement and customize access request segment functionality.
With this functionality in place, administrators can create and manage access request segments.
@@ -41,9 +41,7 @@ Method | HTTP request | Description
[**Get-Segments**](#list-segments) | **GET** `/segments` | List Segments
[**Update-Segment**](#patch-segment) | **PATCH** `/segments/{id}` | Update Segment
## create-segment
This API creates a segment.
>**Note:** Segment definitions may take time to propagate to all identities.
@@ -53,7 +51,6 @@ Param Type | Name | Data Type | Required | Description
Body | Segment | [**Segment**](../models/segment) | True |
### Return type
[**Segment**](../models/segment)
### Responses
@@ -67,7 +64,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -97,7 +93,9 @@ $Segment = @"{
"active" : true,
"id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"
}"@
# Create Segment
try {
$Result = ConvertFrom-JsonToSegment -Json $Segment
New-Segment-Segment $Result
@@ -109,11 +107,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-segment
This API deletes the segment specified by the given ID.
>**Note:** that segment deletion may take some time to become effective.
@@ -123,7 +118,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The segment ID to delete.
### Return type
(empty response body)
### Responses
@@ -138,14 +132,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete.
# Delete Segment by ID
try {
Remove-Segment-Id $Id
@@ -156,11 +151,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-segment
This API returns the segment specified by the given ID.
### Parameters
@@ -169,7 +161,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The segment ID to retrieve.
### Return type
[**Segment**](../models/segment)
### Responses
@@ -184,14 +175,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve.
# Get Segment by ID
try {
Get-Segment-Id $Id
@@ -202,11 +194,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-segments
This API returns a list of all segments.
### Parameters
@@ -217,7 +206,6 @@ Param Type | Name | Data Type | Required | Description
Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
### Return type
[**Segment[]**](../models/segment)
### Responses
@@ -231,7 +219,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -240,7 +227,9 @@ Code | Description | Data Type
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
# List Segments
try {
Get-Segments
@@ -251,11 +240,8 @@ try {
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.
@@ -266,7 +252,6 @@ Path | Id | **String** | True | The segment ID to modify.
Body | RequestBody | [**[]SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | True | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active
### Return type
[**Segment**](../models/segment)
### Responses
@@ -281,7 +266,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
@@ -289,9 +273,11 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify.
$RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active
$RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@
$RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active
# Update Segment
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Update-Segment-Id $Id -RequestBody $Result
@@ -303,7 +289,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: service-desk-integration
title: ServiceDeskIntegration
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/service-desk-integration
tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegration', 'ServiceDeskIntegration']
---
# ServiceDeskIntegration
Use this API to build an integration between Identity Security Cloud and a service desk ITSM (IT service management) solution.
Once an administrator builds this integration between Identity Security Cloud and a service desk, users can use Identity Security Cloud to raise and track tickets that are synchronized between Identity Security Cloud and the service desk.
@@ -53,9 +53,7 @@ Method | HTTP request | Description
[**Send-ServiceDeskIntegration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a Service Desk integration
[**Update-StatusCheckDetails**](#update-status-check-details) | **PUT** `/service-desk-integrations/status-check-configuration` | Update the time check configuration
## create-service-desk-integration
Create a new Service Desk integration.
### Parameters
@@ -64,7 +62,6 @@ Param Type | Name | Data Type | Required | Description
Body | ServiceDeskIntegrationDto | [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) | True | The specifics of a new integration to create
### Return type
[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto)
### Responses
@@ -79,7 +76,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -119,7 +115,9 @@ $ServiceDeskIntegrationDto = @"{
"id" : "62945a496ef440189b1f03e3623411c8",
"beforeProvisioningRule" : ""
}"@
# Create new Service Desk integration
try {
$Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto
New-ServiceDeskIntegration-ServiceDeskIntegrationDto $Result
@@ -131,11 +129,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-service-desk-integration
Delete an existing Service Desk integration by ID.
### Parameters
@@ -144,7 +139,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of Service Desk integration to delete
### Return type
(empty response body)
### Responses
@@ -159,14 +153,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "anId" # String | ID of Service Desk integration to delete
# Delete a Service Desk integration
try {
Remove-ServiceDeskIntegration-Id $Id
@@ -177,11 +172,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-service-desk-integration
Get an existing Service Desk integration by ID.
### Parameters
@@ -190,7 +182,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the Service Desk integration to get
### Return type
[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto)
### Responses
@@ -205,14 +196,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "anId" # String | ID of the Service Desk integration to get
# Get a Service Desk integration
try {
Get-ServiceDeskIntegration-Id $Id
@@ -223,11 +215,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-service-desk-integration-template
This API endpoint returns an existing Service Desk integration template by scriptName.
### Parameters
@@ -236,7 +225,6 @@ Param Type | Name | Data Type | Required | Description
Path | ScriptName | **String** | True | The scriptName value of the Service Desk integration template to get
### Return type
[**ServiceDeskIntegrationTemplateDto**](../models/service-desk-integration-template-dto)
### Responses
@@ -251,14 +239,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get
# Service Desk integration template by scriptName
try {
Get-ServiceDeskIntegrationTemplate-ScriptName $ScriptName
@@ -269,11 +258,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-service-desk-integration-types
This API endpoint returns the current list of supported Service Desk integration types.
### Parameters
@@ -281,7 +267,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**ServiceDeskIntegrationTemplateType[]**](../models/service-desk-integration-template-type)
### Responses
@@ -296,13 +281,14 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
# List Service Desk integration types
try {
Get-ServiceDeskIntegrationTypes
@@ -313,11 +299,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-service-desk-integrations
Get a list of Service Desk integration objects.
### Parameters
@@ -330,7 +313,6 @@ Param Type | Name | Data Type | Required | Description
Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
### Return type
[**ServiceDeskIntegrationDto[]**](../models/service-desk-integration-dto)
### Responses
@@ -345,7 +327,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -356,7 +337,9 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional)
$Filters = 'name eq "John Doe"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
# List existing Service Desk integrations
try {
Get-ServiceDeskIntegrations
@@ -367,11 +350,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-status-check-details
Get the time check configuration of queued SDIM tickets.
### Parameters
@@ -379,7 +359,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**QueuedCheckConfigDetails**](../models/queued-check-config-details)
### Responses
@@ -394,13 +373,14 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
# Get the time check configuration
try {
Get-StatusCheckDetails
@@ -411,11 +391,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-service-desk-integration
Update an existing Service Desk integration by ID with a PATCH request.
### Parameters
@@ -425,7 +402,6 @@ Path | Id | **String** | True | ID of the Service Desk integration to update
Body | PatchServiceDeskIntegrationRequest | [**PatchServiceDeskIntegrationRequest**](../models/patch-service-desk-integration-request) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed.
### Return type
[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto)
### Responses
@@ -440,7 +416,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
@@ -448,7 +423,9 @@ Code | Description | Data Type
```powershell
$Id = "anId" # String | ID of the Service Desk integration to update
$PatchServiceDeskIntegrationRequest = @""@
# Patch a Service Desk Integration
try {
$Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest
Update-ServiceDeskIntegration-Id $Id -PatchServiceDeskIntegrationRequest $Result
@@ -460,11 +437,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-service-desk-integration
Update an existing Service Desk integration by ID.
### Parameters
@@ -474,7 +448,6 @@ Path | Id | **String** | True | ID of the Service Desk integration to update
Body | ServiceDeskIntegrationDto | [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) | True | The specifics of the integration to update
### Return type
[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto)
### Responses
@@ -489,7 +462,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -530,7 +502,9 @@ $ServiceDeskIntegrationDto = @"{
"id" : "62945a496ef440189b1f03e3623411c8",
"beforeProvisioningRule" : ""
}"@
# Update a Service Desk integration
try {
$Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto
Send-ServiceDeskIntegration-Id $Id -ServiceDeskIntegrationDto $Result
@@ -542,11 +516,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-status-check-details
Update the time check configuration of queued SDIM tickets.
### Parameters
@@ -555,7 +526,6 @@ Param Type | Name | Data Type | Required | Description
Body | QueuedCheckConfigDetails | [**QueuedCheckConfigDetails**](../models/queued-check-config-details) | True | The modified time check configuration
### Return type
[**QueuedCheckConfigDetails**](../models/queued-check-config-details)
### Responses
@@ -570,7 +540,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -580,7 +549,9 @@ $QueuedCheckConfigDetails = @"{
"provisioningStatusCheckIntervalMinutes" : "30",
"provisioningMaxStatusCheckDays" : "2"
}"@
# Update the time check configuration
try {
$Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails
Update-StatusCheckDetails-QueuedCheckConfigDetails $Result
@@ -592,7 +563,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: source-usages
title: SourceUsages
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/source-usages
tags: ['SDK', 'Software Development Kit', 'SourceUsages', 'SourceUsages']
---
# SourceUsages
Use this API to implement source usage insight functionality.
With this functionality in place, administrators can gather information and insights about how their tenants&#39; sources are being used.
@@ -24,9 +24,7 @@ Method | HTTP request | Description
[**Get-StatusBySourceId**](#get-status-by-source-id) | **GET** `/source-usages/{sourceId}/status` | Finds status of source usage
[**Get-UsagesBySourceId**](#get-usages-by-source-id) | **GET** `/source-usages/{sourceId}/summaries` | Returns source usage insights
## get-status-by-source-id
This API returns the status of the source usage insights setup by IDN source ID.
### Parameters
@@ -35,7 +33,6 @@ Param Type | Name | Data Type | Required | Description
Path | SourceId | **String** | True | ID of IDN source
### Return type
[**SourceUsageStatus**](../models/source-usage-status)
### Responses
@@ -49,14 +46,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source
# Finds status of source usage
try {
Get-StatusBySourceId-SourceId $SourceId
@@ -67,11 +65,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-usages-by-source-id
This API returns a summary of source usage insights for past 12 months.
### Parameters
@@ -84,7 +79,6 @@ Path | SourceId | **String** | True | ID of IDN source
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date**
### Return type
[**SourceUsage[]**](../models/source-usage)
### Responses
@@ -98,7 +92,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -109,7 +102,9 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional)
# Returns source usage insights
try {
Get-UsagesBySourceId-SourceId $SourceId
@@ -120,7 +115,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: sources
title: Sources
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/sources
tags: ['SDK', 'Software Development Kit', 'Sources', 'Sources']
---
# Sources
Use this API to implement and customize source functionality.
With source functionality in place, organizations can use Identity Security Cloud to connect their various sources and user data sets and manage access across all those different sources in a secure, scalable way.
@@ -102,9 +102,7 @@ Method | HTTP request | Description
[**Update-Source**](#update-source) | **PATCH** `/sources/{id}` | Update Source (Partial)
[**Update-SourceSchema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial)
## create-provisioning-policy
This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types.
Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.
Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.
@@ -116,7 +114,6 @@ Path | SourceId | **String** | True | The Source id
Body | ProvisioningPolicyDto | [**ProvisioningPolicyDto**](../models/provisioning-policy-dto) | True |
### Return type
[**ProvisioningPolicyDto**](../models/provisioning-policy-dto)
### Responses
@@ -131,7 +128,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -178,7 +174,9 @@ $ProvisioningPolicyDto = @"{
} ],
"usageType" : "CREATE"
}"@
# Create Provisioning Policy
try {
$Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto
New-ProvisioningPolicy-SourceId $SourceId -ProvisioningPolicyDto $Result
@@ -190,11 +188,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-source
This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow.
### Parameters
@@ -204,7 +199,6 @@ Param Type | Name | Data Type | Required | Description
Query | ProvisionAsCsv | **Boolean** | (optional) | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source.
### Return type
[**Source**](../models/source)
### Responses
@@ -218,7 +212,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -308,7 +301,9 @@ $Source = @"{
"since" : "2021-09-28T15:48:29.3801666300Z"
}"@
$ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional)
# Creates a source in IdentityNow.
try {
$Result = ConvertFrom-JsonToSource -Json $Source
New-Source-Source $Result
@@ -320,11 +315,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-source-schema
Use this API to create a new schema on the specified source in Identity Security Cloud (ISC).
@@ -335,7 +327,6 @@ Path | SourceId | **String** | True | Source ID.
Body | Schema | [**Schema**](../models/schema) | True |
### Return type
[**Schema**](../models/schema)
### Responses
@@ -349,7 +340,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -390,7 +380,9 @@ $Schema = @"{
"displayAttribute" : "distinguishedName",
"identityAttribute" : "sAMAccountName"
}"@
# Create Schema on Source
try {
$Result = ConvertFrom-JsonToSchema -Json $Schema
New-SourceSchema-SourceId $SourceId -Schema $Result
@@ -402,11 +394,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-provisioning-policy
Deletes the provisioning policy with the specified usage on an application.
### Parameters
@@ -416,7 +405,6 @@ Path | SourceId | **String** | True | The Source ID.
Path | UsageType | [**UsageType**](../models/usage-type) | True | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
### Return type
(empty response body)
### Responses
@@ -431,7 +419,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -439,7 +426,9 @@ Code | Description | Data Type
```powershell
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID.
$UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
# Delete Provisioning Policy by UsageType
try {
Remove-ProvisioningPolicy-SourceId $SourceId -UsageType $UsageType
@@ -450,11 +439,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-source
Use this API to delete a specific source in Identity Security Cloud (ISC).
The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}`
@@ -464,7 +450,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Source ID.
### Return type
[**DeleteSource202Response**](../models/delete-source202-response)
### Responses
@@ -479,14 +464,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
# Delete Source by ID
try {
Remove-Source-Id $Id
@@ -497,13 +483,10 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-source-schema
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -511,7 +494,6 @@ Path | SourceId | **String** | True | The Source id.
Path | SchemaId | **String** | True | The Schema id.
### Return type
(empty response body)
### Responses
@@ -526,7 +508,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -534,7 +515,9 @@ Code | Description | Data Type
```powershell
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id.
# Delete Source Schema by ID
try {
Remove-SourceSchema-SourceId $SourceId -SchemaId $SchemaId
@@ -545,11 +528,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-accounts-schema
This API downloads the CSV schema that defines the account attributes on a source.
>**NOTE: This API is designated only for Delimited File sources.**
@@ -559,7 +539,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The Source id
### Return type
(empty response body)
### Responses
@@ -574,14 +553,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/csv, application/json
### Example
```powershell
$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id
# Downloads source accounts schema template
try {
Get-AccountsSchema-Id $Id
@@ -592,11 +572,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-entitlements-schema
This API downloads the CSV schema that defines the entitlement attributes on a source.
>**NOTE: This API is designated only for Delimited File sources.**
@@ -608,7 +585,6 @@ Path | Id | **String** | True | The Source id
Query | SchemaName | **String** | (optional) | Name of entitlement schema
### Return type
(empty response body)
### Responses
@@ -623,7 +599,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/csv, application/json
@@ -631,7 +606,9 @@ Code | Description | Data Type
```powershell
$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id
$SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional)
# Downloads source entitlements schema template
try {
Get-EntitlementsSchema-Id $Id
@@ -642,11 +619,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-provisioning-policy
This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow.
### Parameters
@@ -656,7 +630,6 @@ Path | SourceId | **String** | True | The Source ID.
Path | UsageType | [**UsageType**](../models/usage-type) | True | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
### Return type
[**ProvisioningPolicyDto**](../models/provisioning-policy-dto)
### Responses
@@ -671,7 +644,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -679,7 +651,9 @@ Code | Description | Data Type
```powershell
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID.
$UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
# Get Provisioning Policy by UsageType
try {
Get-ProvisioningPolicy-SourceId $SourceId -UsageType $UsageType
@@ -690,11 +664,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-source
Use this API to get a source by a specified ID in Identity Security Cloud (ISC).
### Parameters
@@ -703,7 +674,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Source ID.
### Return type
[**Source**](../models/source)
### Responses
@@ -718,14 +688,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
# Get Source by ID
try {
Get-Source-Id $Id
@@ -736,11 +707,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-source-connections
Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC).
### Parameters
@@ -749,7 +717,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Source ID.
### Return type
[**SourceConnectionsDto**](../models/source-connections-dto)
### Responses
@@ -764,14 +731,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
# Get Source Connections by ID
try {
Get-SourceConnections-Id $Id
@@ -782,11 +750,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-source-health
This endpoint fetches source health by source's id
### Parameters
@@ -795,7 +760,6 @@ Param Type | Name | Data Type | Required | Description
Path | SourceId | **String** | True | The Source id.
### Return type
[**SourceHealthDto**](../models/source-health-dto)
### Responses
@@ -810,14 +774,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
# Fetches source health by id
try {
Get-SourceHealth-SourceId $SourceId
@@ -828,11 +793,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-source-schema
Get the Source Schema by ID in IdentityNow.
@@ -843,7 +805,6 @@ Path | SourceId | **String** | True | The Source id.
Path | SchemaId | **String** | True | The Schema id.
### Return type
[**Schema**](../models/schema)
### Responses
@@ -858,7 +819,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -866,7 +826,9 @@ Code | Description | Data Type
```powershell
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id.
# Get Source Schema by ID
try {
Get-SourceSchema-SourceId $SourceId -SchemaId $SchemaId
@@ -877,11 +839,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-source-schemas
Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC).
### Parameters
@@ -892,7 +851,6 @@ Path | SourceId | **String** | True | Source ID.
Query | IncludeNames | **String** | (optional) | A comma-separated list of schema names to filter result.
### Return type
[**Schema[]**](../models/schema)
### Responses
@@ -907,7 +865,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -916,7 +873,9 @@ Code | Description | Data Type
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
$IncludeTypes = "group" # String | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional)
$IncludeNames = "account" # String | A comma-separated list of schema names to filter result. (optional)
# List Schemas on Source
try {
Get-SourceSchemas-SourceId $SourceId
@@ -927,11 +886,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## import-accounts-schema
This API uploads a source schema template file to configure a source's account attributes.
To retrieve the file to modify and upload, log into Identity Now.
@@ -947,7 +903,6 @@ Path | Id | **String** | True | The Source id
| File | **System.IO.FileInfo** | (optional) |
### Return type
[**Schema**](../models/schema)
### Responses
@@ -961,7 +916,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
@@ -969,7 +923,9 @@ Code | Description | Data Type
```powershell
$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id
$File = # System.IO.FileInfo | (optional)
# Uploads source accounts schema template
try {
Import-AccountsSchema-Id $Id
@@ -980,11 +936,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## import-connector-file
This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events.
### Parameters
@@ -994,7 +947,6 @@ Path | SourceId | **String** | True | The Source id.
| File | **System.IO.FileInfo** | (optional) |
### Return type
[**Source**](../models/source)
### Responses
@@ -1008,7 +960,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
@@ -1016,7 +967,9 @@ Code | Description | Data Type
```powershell
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
$File = # System.IO.FileInfo | (optional)
# Upload connector file to source
try {
Import-ConnectorFile-SourceId $SourceId
@@ -1027,11 +980,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## import-entitlements-schema
This API uploads a source schema template file to configure a source's entitlement attributes.
To retrieve the file to modify and upload, log into Identity Now.
@@ -1048,7 +998,6 @@ Path | Id | **String** | True | The Source id
| File | **System.IO.FileInfo** | (optional) |
### Return type
[**Schema**](../models/schema)
### Responses
@@ -1062,7 +1011,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
@@ -1071,7 +1019,9 @@ Code | Description | Data Type
$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id
$SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional)
$File = # System.IO.FileInfo | (optional)
# Uploads source entitlements schema template
try {
Import-EntitlementsSchema-Id $Id
@@ -1082,11 +1032,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-provisioning-policies
This end-point lists all the ProvisioningPolicies in IdentityNow.
### Parameters
@@ -1095,7 +1042,6 @@ Param Type | Name | Data Type | Required | Description
Path | SourceId | **String** | True | The Source id
### Return type
[**ProvisioningPolicyDto[]**](../models/provisioning-policy-dto)
### Responses
@@ -1110,14 +1056,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id
# Lists ProvisioningPolicies
try {
Get-ProvisioningPolicies-SourceId $SourceId
@@ -1128,11 +1075,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-sources
This end-point lists all the sources in IdentityNow.
### Parameters
@@ -1147,7 +1091,6 @@ Param Type | Name | Data Type | Required | Description
Query | IncludeIDNSource | **Boolean** | (optional) (default to $false) | Include the IdentityNow source in the response.
### Return type
[**Source[]**](../models/source)
### Responses
@@ -1162,7 +1105,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -1175,7 +1117,9 @@ $Filters = 'name eq "Employees"' # String | Filter results using the standard sy
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional)
$ForSubadmin = "name" # String | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional)
$IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the response. (optional) (default to $false)
# Lists all sources in IdentityNow.
try {
Get-Sources
@@ -1186,11 +1130,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-provisioning-policy
This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow.
Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.
Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.
@@ -1203,7 +1144,6 @@ Path | UsageType | [**UsageType**](../models/usage-type) | True | The type of
Body | ProvisioningPolicyDto | [**ProvisioningPolicyDto**](../models/provisioning-policy-dto) | True |
### Return type
[**ProvisioningPolicyDto**](../models/provisioning-policy-dto)
### Responses
@@ -1218,7 +1158,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -1266,7 +1205,9 @@ $ProvisioningPolicyDto = @"{
} ],
"usageType" : "CREATE"
}"@
# Update Provisioning Policy by UsageType
try {
$Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto
Send-ProvisioningPolicy-SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result
@@ -1278,11 +1219,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-source
Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration.
These fields are immutable, so they cannot be changed:
@@ -1304,7 +1242,6 @@ Path | Id | **String** | True | Source ID.
Body | Source | [**Source**](../models/source) | True |
### Return type
[**Source**](../models/source)
### Responses
@@ -1319,7 +1256,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -1409,7 +1345,9 @@ $Source = @"{
"status" : "SOURCE_STATE_HEALTHY",
"since" : "2021-09-28T15:48:29.3801666300Z"
}"@
# Update Source (Full)
try {
$Result = ConvertFrom-JsonToSource -Json $Source
Send-Source-Id $Id -Source $Result
@@ -1421,11 +1359,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-source-schema
This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below.
* id
@@ -1446,7 +1381,6 @@ Path | SchemaId | **String** | True | The Schema id.
Body | Schema | [**Schema**](../models/schema) | True |
### Return type
[**Schema**](../models/schema)
### Responses
@@ -1461,7 +1395,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -1503,7 +1436,9 @@ $Schema = @"{
"displayAttribute" : "distinguishedName",
"identityAttribute" : "sAMAccountName"
}"@
# Update Source Schema (Full)
try {
$Result = ConvertFrom-JsonToSchema -Json $Schema
Send-SourceSchema-SourceId $SourceId -SchemaId $SchemaId -Schema $Result
@@ -1515,11 +1450,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-provisioning-policies-in-bulk
This end-point updates a list of provisioning policies on the specified source in IdentityNow.
### Parameters
@@ -1529,7 +1461,6 @@ Path | SourceId | **String** | True | The Source id.
Body | ProvisioningPolicyDto | [**[]ProvisioningPolicyDto**](../models/provisioning-policy-dto) | True |
### Return type
[**ProvisioningPolicyDto[]**](../models/provisioning-policy-dto)
### Responses
@@ -1544,14 +1475,12 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```powershell
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
# ProvisioningPolicyDto[] |
$ProvisioningPolicyDto = @"{
"name" : "example provisioning policy for inactive identities",
"description" : "this provisioning policy creates access based on an identity going inactive",
@@ -1591,9 +1520,11 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
"type" : "string"
} ],
"usageType" : "CREATE"
}"@
}"@ # ProvisioningPolicyDto[] |
# Bulk Update Provisioning Policies
try {
$Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto
Update-ProvisioningPoliciesInBulk-SourceId $SourceId -ProvisioningPolicyDto $Result
@@ -1605,11 +1536,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-provisioning-policy
This API selectively updates an existing Provisioning Policy using a JSONPatch payload.
Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.
Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.
@@ -1622,7 +1550,6 @@ Path | UsageType | [**UsageType**](../models/usage-type) | True | The type of
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | The JSONPatch payload used to update the schema.
### Return type
[**ProvisioningPolicyDto**](../models/provisioning-policy-dto)
### Responses
@@ -1637,7 +1564,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
@@ -1645,14 +1571,15 @@ Code | Description | Data Type
```powershell
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
$UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
# JsonPatchOperation[] | The JSONPatch payload used to update the schema.
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] | The JSONPatch payload used to update the schema.
# Partial update of Provisioning Policy
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-ProvisioningPolicy-SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result
@@ -1664,11 +1591,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-source
Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the
[JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
@@ -1693,7 +1617,6 @@ Path | Id | **String** | True | Source ID.
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC).
### Return type
[**Source**](../models/source)
### Responses
@@ -1708,21 +1631,21 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
### Example
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
# JsonPatchOperation[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC).
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC).
# Update Source (Partial)
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-Source-Id $Id -JsonPatchOperation $Result
@@ -1734,11 +1657,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-source-schema
Use this API to selectively update an existing Schema using a JSONPatch payload.
The following schema fields are immutable and cannot be updated:
@@ -1778,7 +1698,6 @@ Path | SchemaId | **String** | True | The Schema id.
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | The JSONPatch payload used to update the schema.
### Return type
[**Schema**](../models/schema)
### Responses
@@ -1793,7 +1712,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
@@ -1801,14 +1719,15 @@ Code | Description | Data Type
```powershell
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id.
# JsonPatchOperation[] | The JSONPatch payload used to update the schema.
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] | The JSONPatch payload used to update the schema.
# Update Source Schema (Partial)
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-SourceSchema-SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result
@@ -1820,7 +1739,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: tagged-objects
title: TaggedObjects
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/tagged-objects
tags: ['SDK', 'Software Development Kit', 'TaggedObjects', 'TaggedObjects']
---
# TaggedObjects
Use this API to implement object tagging functionality.
With object tagging functionality in place, any user in an organization can use tags as a way to group objects together and find them more quickly when the user searches Identity Security Cloud.
@@ -80,9 +80,7 @@ Method | HTTP request | Description
[**Set-TagToObject**](#set-tag-to-object) | **POST** `/tagged-objects` | Add Tag to Object
[**Set-TagsToManyObjects**](#set-tags-to-many-objects) | **POST** `/tagged-objects/bulk-add` | Tag Multiple Objects
## delete-tagged-object
Delete all tags from a tagged object.
### Parameters
@@ -92,7 +90,6 @@ Path | Type | **String** | True | The type of object to delete tags from.
Path | Id | **String** | True | The ID of the object to delete tags from.
### Return type
(empty response body)
### Responses
@@ -106,7 +103,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -114,7 +110,9 @@ Code | Description | Data Type
```powershell
$Type = "ACCESS_PROFILE" # String | The type of object to delete tags from.
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to delete tags from.
# Delete Object Tags
try {
Remove-TaggedObject-Type $Type -Id $Id
@@ -125,11 +123,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-tags-to-many-object
This API removes tags from multiple objects.
### Parameters
@@ -138,7 +133,6 @@ Param Type | Name | Data Type | Required | Description
Body | BulkRemoveTaggedObject | [**BulkRemoveTaggedObject**](../models/bulk-remove-tagged-object) | True | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
### Return type
(empty response body)
### Responses
@@ -152,7 +146,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -170,7 +163,9 @@ $BulkRemoveTaggedObject = @"{
} ],
"tags" : [ "BU_FINANCE", "PCI" ]
}"@
# Remove Tags from Multiple Objects
try {
$Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject
Remove-TagsToManyObject-BulkRemoveTaggedObject $Result
@@ -182,11 +177,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-tagged-object
This gets a tagged object for the specified type.
### Parameters
@@ -196,7 +188,6 @@ Path | Type | **String** | True | The type of tagged object to retrieve.
Path | Id | **String** | True | The ID of the object reference to retrieve.
### Return type
[**TaggedObject**](../models/tagged-object)
### Responses
@@ -210,7 +201,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -218,7 +208,9 @@ Code | Description | Data Type
```powershell
$Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve.
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve.
# Get Tagged Object
try {
Get-TaggedObject-Type $Type -Id $Id
@@ -229,11 +221,8 @@ try {
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.
@@ -247,7 +236,6 @@ Param Type | Name | Data Type | Required | Description
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in*
### Return type
[**TaggedObject[]**](../models/tagged-object)
### Responses
@@ -261,7 +249,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -271,7 +258,9 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'tagName eq "BU_FINANCE"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional)
# List Tagged Objects
try {
Get-TaggedObjects
@@ -282,11 +271,8 @@ try {
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.
@@ -301,7 +287,6 @@ Path | Type | **String** | True | The type of tagged object to retrieve.
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq*
### Return type
[**TaggedObject[]**](../models/tagged-object)
### Responses
@@ -315,7 +300,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -326,7 +310,9 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'objectRef.id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional)
# List Tagged Objects by Type
try {
Get-TaggedObjectsByType-Type $Type
@@ -337,11 +323,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-tagged-object
This updates a tagged object for the specified type.
### Parameters
@@ -352,7 +335,6 @@ Path | Id | **String** | True | The ID of the object reference to update.
Body | TaggedObject | [**TaggedObject**](../models/tagged-object) | True |
### Return type
[**TaggedObject**](../models/tagged-object)
### Responses
@@ -366,7 +348,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -382,7 +363,9 @@ $TaggedObject = @"{
},
"tags" : [ "BU_FINANCE", "PCI" ]
}"@
# Update Tagged Object
try {
$Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject
Send-TaggedObject-Type $Type -Id $Id -TaggedObject $Result
@@ -394,11 +377,8 @@ try {
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.
@@ -409,7 +389,6 @@ Param Type | Name | Data Type | Required | Description
Body | TaggedObject | [**TaggedObject**](../models/tagged-object) | True |
### Return type
(empty response body)
### Responses
@@ -423,7 +402,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -437,7 +415,9 @@ $TaggedObject = @"{
},
"tags" : [ "BU_FINANCE", "PCI" ]
}"@
# Add Tag to Object
try {
$Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject
Set-TagToObject-TaggedObject $Result
@@ -449,11 +429,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-tags-to-many-objects
This API adds tags to multiple objects.
### Parameters
@@ -462,7 +439,6 @@ Param Type | Name | Data Type | Required | Description
Body | BulkAddTaggedObject | [**BulkAddTaggedObject**](../models/bulk-add-tagged-object) | True | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
### Return type
[**BulkTaggedObjectResponse[]**](../models/bulk-tagged-object-response)
### Responses
@@ -476,7 +452,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -495,7 +470,9 @@ $BulkAddTaggedObject = @"{
"operation" : "MERGE",
"tags" : [ "BU_FINANCE", "PCI" ]
}"@
# Tag Multiple Objects
try {
$Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject
Set-TagsToManyObjects-BulkAddTaggedObject $Result
@@ -507,7 +484,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: transforms
title: Transforms
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/transforms
tags: ['SDK', 'Software Development Kit', 'Transforms', 'Transforms']
---
# Transforms
The purpose of this API is to expose functionality for the manipulation of Transform objects.
Transforms are a form of configurable objects which define an easy way to manipulate attribute data without having
@@ -30,9 +30,7 @@ Method | HTTP request | Description
[**Get-Transforms**](#list-transforms) | **GET** `/transforms` | List transforms
[**Update-Transform**](#update-transform) | **PUT** `/transforms/{id}` | Update a transform
## create-transform
Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI.
### Parameters
@@ -41,7 +39,6 @@ Param Type | Name | Data Type | Required | Description
Body | Transform | [**Transform**](../models/transform) | True | The transform to be created.
### Return type
[**TransformRead**](../models/transform-read)
### Responses
@@ -56,7 +53,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -83,7 +79,9 @@ $Transform = @"{
},
"type" : "dateFormat"
}"@
# Create transform
try {
$Result = ConvertFrom-JsonToTransform -Json $Transform
New-Transform-Transform $Result
@@ -95,11 +93,8 @@ try {
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.
### Parameters
@@ -108,7 +103,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the transform to delete
### Return type
(empty response body)
### Responses
@@ -123,14 +117,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete
# Delete a transform
try {
Remove-Transform-Id $Id
@@ -141,11 +136,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-transform
This API returns the transform specified by the given ID.
### Parameters
@@ -154,7 +146,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the transform to retrieve
### Return type
[**TransformRead**](../models/transform-read)
### Responses
@@ -169,14 +160,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve
# Transform by ID
try {
Get-Transform-Id $Id
@@ -187,11 +179,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-transforms
Gets a list of all saved transform objects.
### Parameters
@@ -204,7 +193,6 @@ Param Type | Name | Data Type | Required | Description
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw*
### Return type
[**TransformRead[]**](../models/transform-read)
### Responses
@@ -219,7 +207,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -230,7 +217,9 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Name = "ExampleTransformName123" # String | Name of the transform to retrieve from the list. (optional)
$Filters = 'name eq "Uppercase"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* (optional)
# List transforms
try {
Get-Transforms
@@ -241,11 +230,8 @@ try {
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.
### Parameters
@@ -255,7 +241,6 @@ Path | Id | **String** | True | ID of the transform to update
Body | Transform | [**Transform**](../models/transform) | (optional) | The updated transform object. Must include ""name"", ""type"", and ""attributes"" fields, but ""name"" and ""type"" must not be modified.
### Return type
[**TransformRead**](../models/transform-read)
### Responses
@@ -270,7 +255,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -298,7 +282,9 @@ $Transform = @"{
},
"type" : "dateFormat"
}"@
# Update a transform
try {
Update-Transform-Id $Id
@@ -309,7 +295,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: vendor-connector-mappings
title: VendorConnectorMappings
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/vendor-connector-mappings
tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappings', 'VendorConnectorMappings']
---
# VendorConnectorMappings
@@ -22,9 +22,7 @@ Method | HTTP request | Description
[**Remove-VendorConnectorMapping**](#delete-vendor-connector-mapping) | **DELETE** `/vendor-connector-mappings` | Delete Vendor Connector Mapping
[**Get-VendorConnectorMappings**](#get-vendor-connector-mappings) | **GET** `/vendor-connector-mappings` | List Vendor Connector Mappings
## create-vendor-connector-mapping
Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths.
@@ -34,7 +32,6 @@ Param Type | Name | Data Type | Required | Description
Body | VendorConnectorMapping | [**VendorConnectorMapping**](../models/vendor-connector-mapping) | True |
### Return type
[**VendorConnectorMapping**](../models/vendor-connector-mapping)
### Responses
@@ -49,7 +46,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -78,7 +74,9 @@ $VendorConnectorMapping = @"{
"Time" : "2024-03-14T12:56:19.391294Z"
}
}"@
# Create Vendor Connector Mapping
try {
$Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping
New-VendorConnectorMapping-VendorConnectorMapping $Result
@@ -90,11 +88,8 @@ try {
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.
@@ -104,7 +99,6 @@ Param Type | Name | Data Type | Required | Description
Body | VendorConnectorMapping | [**VendorConnectorMapping**](../models/vendor-connector-mapping) | True |
### Return type
[**DeleteVendorConnectorMapping200Response**](../models/delete-vendor-connector-mapping200-response)
### Responses
@@ -119,7 +113,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -148,7 +141,9 @@ $VendorConnectorMapping = @"{
"Time" : "2024-03-14T12:56:19.391294Z"
}
}"@
# Delete Vendor Connector Mapping
try {
$Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping
Remove-VendorConnectorMapping-VendorConnectorMapping $Result
@@ -160,11 +155,8 @@ try {
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.
@@ -173,7 +165,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**VendorConnectorMapping[]**](../models/vendor-connector-mapping)
### Responses
@@ -188,13 +179,14 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
# List Vendor Connector Mappings
try {
Get-VendorConnectorMappings
@@ -205,7 +197,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: work-items
title: WorkItems
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/work-items
tags: ['SDK', 'Software Development Kit', 'WorkItems', 'WorkItems']
---
# WorkItems
Use this API to implement work item functionality.
With this functionality in place, users can manage their work items (tasks).
@@ -46,9 +46,7 @@ Method | HTTP request | Description
[**Send-WorkItemForward**](#send-work-item-forward) | **POST** `/work-items/{id}/forward` | Forward a Work Item
[**Submit-AccountSelection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit Account Selections
## approve-approval-item
This API approves an Approval Item. Either an admin, or the owning/current user must make this request.
### Parameters
@@ -58,7 +56,6 @@ Path | Id | **String** | True | The ID of the work item
Path | ApprovalItemId | **String** | True | The ID of the approval item.
### Return type
[**WorkItems**](../models/work-items)
### Responses
@@ -73,7 +70,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -81,7 +77,9 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item.
# Approve an Approval Item
try {
Approve-ApprovalItem-Id $Id -ApprovalItemId $ApprovalItemId
@@ -92,11 +90,8 @@ try {
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.
### Parameters
@@ -105,7 +100,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The ID of the work item
### Return type
[**WorkItems**](../models/work-items)
### Responses
@@ -120,14 +114,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
# Bulk approve Approval Items
try {
Approve-ApprovalItemsInBulk-Id $Id
@@ -138,11 +133,8 @@ try {
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.
### Parameters
@@ -151,7 +143,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The ID of the work item
### Return type
[**WorkItems**](../models/work-items)
### Responses
@@ -166,14 +157,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
# Complete a Work Item
try {
Complete-WorkItem-Id $Id
@@ -184,11 +176,8 @@ try {
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.
### Parameters
@@ -200,7 +189,6 @@ Param Type | Name | Data Type | Required | Description
Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
### Return type
[**WorkItems[]**](../models/work-items)
### Responses
@@ -214,7 +202,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -224,7 +211,9 @@ $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | The id of the owner of
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
# Completed Work Items
try {
Get-CompletedWorkItems
@@ -235,11 +224,8 @@ try {
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.
### Parameters
@@ -248,7 +234,6 @@ Param Type | Name | Data Type | Required | Description
Query | OwnerId | **String** | (optional) | ID of the work item owner.
### Return type
[**WorkItemsCount**](../models/work-items-count)
### Responses
@@ -262,14 +247,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional)
# Count Completed Work Items
try {
Get-CountCompletedWorkItems
@@ -280,11 +266,8 @@ try {
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.
### Parameters
@@ -293,7 +276,6 @@ Param Type | Name | Data Type | Required | Description
Query | OwnerId | **String** | (optional) | ID of the work item owner.
### Return type
[**WorkItemsCount**](../models/work-items-count)
### Responses
@@ -307,14 +289,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional)
# Count Work Items
try {
Get-CountWorkItems
@@ -325,11 +308,8 @@ try {
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.
### Parameters
@@ -338,7 +318,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the work item.
### Return type
[**WorkItems**](../models/work-items)
### Responses
@@ -352,14 +331,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item.
# Get a Work Item
try {
Get-WorkItem-Id $Id
@@ -370,11 +350,8 @@ try {
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.
### Parameters
@@ -383,7 +360,6 @@ Param Type | Name | Data Type | Required | Description
Query | OwnerId | **String** | (optional) | ID of the work item owner.
### Return type
[**WorkItemsSummary**](../models/work-items-summary)
### Responses
@@ -397,14 +373,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional)
# Work Items Summary
try {
Get-WorkItemsSummary
@@ -415,11 +392,8 @@ try {
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.
### Parameters
@@ -431,7 +405,6 @@ Param Type | Name | Data Type | Required | Description
Query | OwnerId | **String** | (optional) | ID of the work item owner.
### Return type
[**WorkItems[]**](../models/work-items)
### Responses
@@ -445,7 +418,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -455,7 +427,9 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional)
# List Work Items
try {
Get-WorkItems
@@ -466,11 +440,8 @@ try {
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.
### Parameters
@@ -480,7 +451,6 @@ Path | Id | **String** | True | The ID of the work item
Path | ApprovalItemId | **String** | True | The ID of the approval item.
### Return type
[**WorkItems**](../models/work-items)
### Responses
@@ -495,7 +465,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -503,7 +472,9 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item.
# Reject an Approval Item
try {
Deny-ApprovalItem-Id $Id -ApprovalItemId $ApprovalItemId
@@ -514,11 +485,8 @@ try {
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.
### Parameters
@@ -527,7 +495,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The ID of the work item
### Return type
[**WorkItems**](../models/work-items)
### Responses
@@ -542,14 +509,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
# Bulk reject Approval Items
try {
Deny-ApprovalItemsInBulk-Id $Id
@@ -560,11 +528,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## send-work-item-forward
This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. Accessible to work-item Owner, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN.
### Parameters
@@ -574,7 +539,6 @@ Path | Id | **String** | True | The ID of the work item
Body | WorkItemForward | [**WorkItemForward**](../models/work-item-forward) | True |
### Return type
(empty response body)
### Responses
@@ -588,7 +552,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -600,7 +563,9 @@ $WorkItemForward = @"{
"comment" : "I'm going on vacation.",
"sendNotifications" : true
}"@
# Forward a Work Item
try {
$Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward
Send-WorkItemForward-Id $Id -WorkItemForward $Result
@@ -612,11 +577,8 @@ try {
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.
### Parameters
@@ -626,7 +588,6 @@ Path | Id | **String** | True | The ID of the work item
Body | RequestBody | [**map[string]AnyType**](https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4) | True | Account Selection Data map, keyed on fieldName
### Return type
[**WorkItems**](../models/work-items)
### Responses
@@ -641,7 +602,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -649,7 +609,9 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName
# Submit Account Selections
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Submit-AccountSelection-Id $Id -RequestBody $Result
@@ -661,7 +623,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: workflows
title: Workflows
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/workflows
tags: ['SDK', 'Software Development Kit', 'Workflows', 'Workflows']
---
# Workflows
Workflows allow administrators to create custom automation scripts directly within Identity Security Cloud. These automation scripts respond to [event triggers](https://developer.sailpoint.com/docs/extensibility/event-triggers/#how-to-get-started-with-event-triggers) and perform a series of actions to perform tasks that are either too cumbersome or not available in the Identity Security Cloud UI. Workflows can be configured via a graphical user interface within Identity Security Cloud, or by creating and uploading a JSON formatted script to the Workflow service. The Workflows API collection provides the necessary functionality to create, manage, and test your workflows via REST.
@@ -38,9 +38,7 @@ Method | HTTP request | Description
[**Test-ExternalExecuteWorkflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger
[**Test-Workflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test Workflow By Id
## cancel-workflow-execution
Use this API to cancel a running workflow execution.
### Parameters
@@ -49,7 +47,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The workflow execution ID
### Return type
(empty response body)
### Responses
@@ -64,14 +61,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID
# Cancel Workflow Execution by ID
try {
Suspend-WorkflowExecution-Id $Id
@@ -82,11 +80,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-external-execute-workflow
This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the "External Trigger" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body.
### Parameters
@@ -96,7 +91,6 @@ Path | Id | **String** | True | Id of the workflow
Body | CreateExternalExecuteWorkflowRequest | [**CreateExternalExecuteWorkflowRequest**](../models/create-external-execute-workflow-request) | (optional) |
### Return type
[**CreateExternalExecuteWorkflow200Response**](../models/create-external-execute-workflow200-response)
### Responses
@@ -110,7 +104,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -118,7 +111,9 @@ Code | Description | Data Type
```powershell
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
$CreateExternalExecuteWorkflowRequest = @""@
# Execute Workflow via External Trigger
try {
New-ExternalExecuteWorkflow-Id $Id
@@ -129,11 +124,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-workflow
Create a new workflow with the desired trigger and steps specified in the request body.
### Parameters
@@ -142,7 +134,6 @@ Param Type | Name | Data Type | Required | Description
Body | CreateWorkflowRequest | [**CreateWorkflowRequest**](../models/create-workflow-request) | True |
### Return type
[**Workflow**](../models/workflow)
### Responses
@@ -156,14 +147,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```powershell
$CreateWorkflowRequest = @"{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}"@
# Create Workflow
try {
$Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest
New-Workflow-CreateWorkflowRequest $Result
@@ -175,11 +167,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-workflow-external-trigger
Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow.
### Parameters
@@ -188,7 +177,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Id of the workflow
### Return type
[**WorkflowOAuthClient**](../models/workflow-o-auth-client)
### Responses
@@ -202,14 +190,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
# Generate External Trigger OAuth Client
try {
New-WorkflowExternalTrigger-Id $Id
@@ -220,11 +209,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-workflow
Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled.
### Parameters
@@ -233,7 +219,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Id of the Workflow
### Return type
(empty response body)
### Responses
@@ -247,14 +232,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow
# Delete Workflow By Id
try {
Remove-Workflow-Id $Id
@@ -265,11 +251,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-workflow
Get a single workflow by id.
### Parameters
@@ -278,7 +261,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Id of the workflow
### Return type
[**Workflow**](../models/workflow)
### Responses
@@ -292,14 +274,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
# Get Workflow By Id
try {
Get-Workflow-Id $Id
@@ -310,11 +293,8 @@ try {
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.
### Parameters
@@ -323,7 +303,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Workflow execution ID.
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -338,14 +317,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID.
# Get Workflow Execution
try {
Get-WorkflowExecution-Id $Id
@@ -356,11 +336,8 @@ try {
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.
### Parameters
@@ -369,7 +346,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Id of the workflow execution
### Return type
[**WorkflowExecutionEvent[]**](../models/workflow-execution-event)
### Responses
@@ -384,14 +360,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution
# Get Workflow Execution History
try {
Get-WorkflowExecutionHistory-Id $Id
@@ -402,11 +379,8 @@ try {
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.
2. Get your workflow ID from the response.
@@ -429,7 +403,6 @@ Path | Id | **String** | True | Workflow ID.
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq*
### Return type
[**WorkflowExecution[]**](../models/workflow-execution)
### Responses
@@ -444,7 +417,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -455,7 +427,9 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'status eq "Failed"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional)
# List Workflow Executions
try {
Get-WorkflowExecutions-Id $Id
@@ -466,11 +440,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-complete-workflow-library
This lists all triggers, actions, and operators in the library
### Parameters
@@ -480,7 +451,6 @@ Param Type | Name | Data Type | Required | Description
Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
### Return type
[**ListCompleteWorkflowLibrary200ResponseInner[]**](../models/list-complete-workflow-library200-response-inner)
### Responses
@@ -494,7 +464,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -502,7 +471,9 @@ Code | Description | Data Type
```powershell
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
# List Complete Workflow Library
try {
Get-CompleteWorkflowLibrary
@@ -513,11 +484,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-workflow-library-actions
This lists the workflow actions available to you.
### Parameters
@@ -528,7 +496,6 @@ Param Type | Name | Data Type | Required | Description
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq*
### Return type
[**WorkflowLibraryAction[]**](../models/workflow-library-action)
### Responses
@@ -542,7 +509,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -551,7 +517,9 @@ Code | Description | Data Type
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Filters = 'id eq "sp:create-campaign"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional)
# List Workflow Library Actions
try {
Get-WorkflowLibraryActions
@@ -562,11 +530,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-workflow-library-operators
This lists the workflow operators available to you
### Parameters
@@ -574,7 +539,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**WorkflowLibraryOperator[]**](../models/workflow-library-operator)
### Responses
@@ -588,13 +552,14 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
# List Workflow Library Operators
try {
Get-WorkflowLibraryOperators
@@ -605,11 +570,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-workflow-library-triggers
This lists the workflow triggers available to you
### Parameters
@@ -620,7 +582,6 @@ Param Type | Name | Data Type | Required | Description
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq*
### Return type
[**WorkflowLibraryTrigger[]**](../models/workflow-library-trigger)
### Responses
@@ -634,7 +595,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -643,7 +603,9 @@ Code | Description | Data Type
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Filters = 'id eq "idn:identity-attributes-changed"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional)
# List Workflow Library Triggers
try {
Get-WorkflowLibraryTriggers
@@ -654,11 +616,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-workflows
List all workflows in the tenant.
### Parameters
@@ -666,7 +625,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**Workflow[]**](../models/workflow)
### Responses
@@ -680,13 +638,14 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
# List Workflows
try {
Get-Workflows
@@ -697,11 +656,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-workflow
Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
### Parameters
@@ -711,7 +667,6 @@ Path | Id | **String** | True | Id of the Workflow
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True |
### Return type
[**Workflow**](../models/workflow)
### Responses
@@ -725,21 +680,21 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
### Example
```powershell
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow
# JsonPatchOperation[] |
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] |
# Patch Workflow
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-Workflow-Id $Id -JsonPatchOperation $Result
@@ -751,11 +706,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-workflow
Perform a full update of a workflow. The updated workflow object is returned in the response.
### Parameters
@@ -765,7 +717,6 @@ Path | Id | **String** | True | Id of the Workflow
Body | WorkflowBody | [**WorkflowBody**](../models/workflow-body) | True |
### Return type
[**Workflow**](../models/workflow)
### Responses
@@ -779,7 +730,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -825,7 +775,9 @@ $WorkflowBody = @"{
},
"enabled" : false
}"@
# Update Workflow
try {
$Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody
Send-Workflow-Id $Id -WorkflowBody $Result
@@ -837,11 +789,8 @@ try {
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.
### Parameters
@@ -851,7 +800,6 @@ Path | Id | **String** | True | Id of the workflow
Body | TestExternalExecuteWorkflowRequest | [**TestExternalExecuteWorkflowRequest**](../models/test-external-execute-workflow-request) | (optional) |
### Return type
[**TestExternalExecuteWorkflow200Response**](../models/test-external-execute-workflow200-response)
### Responses
@@ -865,7 +813,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -873,7 +820,9 @@ Code | Description | Data Type
```powershell
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
$TestExternalExecuteWorkflowRequest = @""@
# Test Workflow via External Trigger
try {
Test-ExternalExecuteWorkflow-Id $Id
@@ -884,11 +833,8 @@ try {
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.**
@@ -900,7 +846,6 @@ Path | Id | **String** | True | Id of the workflow
Body | TestWorkflowRequest | [**TestWorkflowRequest**](../models/test-workflow-request) | True |
### Return type
[**TestWorkflow200Response**](../models/test-workflow200-response)
### Responses
@@ -914,7 +859,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -922,7 +866,9 @@ Code | Description | Data Type
```powershell
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
$TestWorkflowRequest = @"{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}"@
# Test Workflow By Id
try {
$Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest
Test-Workflow-Id $Id -TestWorkflowRequest $Result
@@ -934,7 +880,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)