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

Update to powershell SDK docs: 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

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

@@ -1,3 +1,4 @@
---
id: beta-access-model-metadata
title: AccessModelMetadata
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/access-model-metadata
tags: ['SDK', 'Software Development Kit', 'AccessModelMetadata', 'BetaAccessModelMetadata']
---
# AccessModelMetadata
Use this API to create and manage metadata attributes for your Access Model.
Access Model Metadata allows you to add contextual information to your ISC Access Model items using pre-defined metadata for risk, regulations, privacy levels, etc., or by creating your own metadata attributes to reflect the unique needs of your organization. This release of the API includes support for entitlement metadata. Support for role and access profile metadata will be introduced in a subsequent release.
@@ -33,9 +33,7 @@ Method | HTTP request | Description
[**Get-BetaAccessModelMetadataAttribute**](#list-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes` | List Access Model Metadata Attributes
[**Get-BetaAccessModelMetadataAttributeValue**](#list-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values` | List Access Model Metadata Values
## get-access-model-metadata-attribute
Get single Access Model Metadata Attribute
### Parameters
@@ -44,7 +42,6 @@ Param Type | Name | Data Type | Required | Description
Path | Key | **String** | True | Technical name of the Attribute.
### Return type
[**AttributeDTO**](../models/attribute-dto)
### Responses
@@ -58,14 +55,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
$Key = "iscPrivacy" # String | Technical name of the Attribute.
# Get Access Model Metadata Attribute
try {
Get-BetaAccessModelMetadataAttribute-BetaKey $Key
@@ -76,11 +74,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-access-model-metadata-attribute-value
Get single Access Model Metadata Attribute Value
### Parameters
@@ -90,7 +85,6 @@ Path | Key | **String** | True | Technical name of the Attribute.
Path | Value | **String** | True | Technical name of the Attribute value.
### Return type
[**AttributeValueDTO**](../models/attribute-value-dto)
### Responses
@@ -104,7 +98,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
@@ -112,7 +105,9 @@ Code | Description | Data Type
```powershell
$Key = "iscPrivacy" # String | Technical name of the Attribute.
$Value = "public" # String | Technical name of the Attribute value.
# Get Access Model Metadata Value
try {
Get-BetaAccessModelMetadataAttributeValue-BetaKey $Key -BetaValue $Value
@@ -123,11 +118,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-access-model-metadata-attribute
Get a list of Access Model Metadata Attributes
### Parameters
@@ -136,7 +128,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* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and*
### Return type
[**AttributeDTO[]**](../models/attribute-dto)
### 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
$Filters = 'name eq "Privacy"' # 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* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional)
# List Access Model Metadata Attributes
try {
Get-BetaAccessModelMetadataAttribute
@@ -168,11 +160,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-access-model-metadata-attribute-value
Get a list of Access Model Metadata Attribute Values
### Parameters
@@ -181,7 +170,6 @@ Param Type | Name | Data Type | Required | Description
Path | Key | **String** | True | Technical name of the Attribute.
### Return type
[**AttributeValueDTO[]**](../models/attribute-value-dto)
### Responses
@@ -195,14 +183,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
$Key = "iscPrivacy" # String | Technical name of the Attribute.
# List Access Model Metadata Values
try {
Get-BetaAccessModelMetadataAttributeValue-BetaKey $Key
@@ -213,7 +202,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-access-profiles
title: AccessProfiles
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/access-profiles
tags: ['SDK', 'Software Development Kit', 'AccessProfiles', 'BetaAccessProfiles']
---
# 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.
@@ -61,9 +61,7 @@ Method | HTTP request | Description
[**Update-BetaAccessProfile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified Access Profile
[**Update-BetaAccessProfilesInBulk**](#update-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-update-requestable` | Update Access Profile(s) requestable field.
## create-access-profile
Use this API to create an access profile.
A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a token with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source.
The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters.
@@ -74,7 +72,6 @@ Param Type | Name | Data Type | Required | Description
Body | AccessProfile | [**AccessProfile**](../models/access-profile) | True |
### Return type
[**AccessProfile**](../models/access-profile)
### 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
@@ -179,7 +175,9 @@ $AccessProfile = @"{
"id" : "2c91808a7190d06e01719938fcd20792",
"requestable" : true
}"@
# Create Access Profile
try {
$Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile
New-BetaAccessProfile-BetaAccessProfile $Result
@@ -191,11 +189,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.
@@ -208,7 +203,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
@@ -222,14 +216,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-BetaAccessProfile-BetaId $Id
@@ -240,11 +235,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-BetaAccessProfilesInBulk-BetaAccessProfileBulkDeleteRequest $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-BetaAccessProfile-BetaId $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 user with SOURCE_SUBADMIN authority must have access to the source associated with the specified access profile.
@@ -357,7 +343,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
@@ -371,7 +356,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
@@ -383,7 +367,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-BetaAccessProfileEntitlements-BetaId $Id
@@ -394,11 +380,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-access-profiles
Use this API to get a list of access profiles.
A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
@@ -415,7 +398,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
@@ -429,7 +411,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
@@ -443,7 +424,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-BetaAccessProfiles
@@ -454,11 +437,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-access-profile
This API updates an existing Access Profile. The following fields are patchable:
**name**, **description**, **enabled**, **owner**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria**
A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer.
@@ -473,7 +453,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
@@ -487,21 +466,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-BetaAccessProfile-BetaId $Id -BetaJsonPatchOperation $Result
@@ -513,11 +492,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-access-profiles-in-bulk
This API initiates a bulk update of field requestable for one or more Access Profiles.
> If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated**
@@ -532,7 +508,6 @@ Param Type | Name | Data Type | Required | Description
Body | AccessProfileBulkUpdateRequestInner | [**[]AccessProfileBulkUpdateRequestInner**](../models/access-profile-bulk-update-request-inner) | True |
### Return type
[**AccessProfileUpdateItem[]**](../models/access-profile-update-item)
### Responses
@@ -547,16 +522,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
# AccessProfileBulkUpdateRequestInner[] |
$AccessProfileBulkUpdateRequestInner = @"[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]"@
$AccessProfileBulkUpdateRequestInner = @"[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]"@ # AccessProfileBulkUpdateRequestInner[] |
# Update Access Profile(s) requestable field.
try {
$Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner
Update-BetaAccessProfilesInBulk-BetaAccessProfileBulkUpdateRequestInner $Result
@@ -568,7 +543,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-access-request-approvals
title: AccessRequestApprovals
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/access-request-approvals
tags: ['SDK', 'Software Development Kit', 'AccessRequestApprovals', 'BetaAccessRequestApprovals']
---
# 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-BetaPendingApprovals**](#list-pending-approvals) | **GET** `/access-request-approvals/pending` | Pending Access Request Approvals List
[**Deny-BetaAccessRequest**](#reject-access-request) | **POST** `/access-request-approvals/{approvalId}/reject` | Reject Access Request Approval
## approve-access-request
Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.
### Parameters
@@ -54,7 +52,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
@@ -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 = @"{
"created" : "2017-07-11T18:45:37.098Z",
"comment" : "This is a comment."
}"@
# Approve Access Request Approval
try {
$Result = ConvertFrom-JsonToCommentDto -Json $CommentDto
Approve-BetaAccessRequest-BetaApprovalId $ApprovalId -BetaCommentDto $Result
@@ -97,11 +95,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.
### Parameters
@@ -111,7 +106,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
@@ -126,7 +120,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
@@ -137,7 +130,9 @@ $ForwardApprovalDto = @"{
"newOwnerId" : "newOwnerId",
"comment" : "comment"
}"@
# Forward Access Request Approval
try {
$Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto
Invoke-BetaForwardAccessRequest-BetaApprovalId $ApprovalId -BetaForwardApprovalDto $Result
@@ -149,11 +144,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.
### Parameters
@@ -163,7 +155,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
@@ -177,7 +168,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
@@ -185,7 +175,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-BetaAccessRequestApprovalSummary
@@ -196,11 +188,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
@@ -214,7 +203,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 = 'MyFilters' # 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 = "MySorters" # 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-BetaCompletedApprovals
@@ -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
@@ -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**: Not defined
- **Accept**: application/json
@@ -293,7 +277,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 = 'MyFilters' # 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 = "MySorters" # 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-BetaPendingApprovals
@@ -304,11 +290,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
@@ -318,7 +301,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
@@ -333,7 +315,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
@@ -349,7 +330,9 @@ $CommentDto = @"{
"created" : "2017-07-11T18:45:37.098Z",
"comment" : "This is a comment."
}"@
# Reject Access Request Approval
try {
$Result = ConvertFrom-JsonToCommentDto -Json $CommentDto
Deny-BetaAccessRequest-BetaApprovalId $ApprovalId -BetaCommentDto $Result
@@ -361,7 +344,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-access-request-identity-metrics
title: AccessRequestIdentityMetrics
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/access-request-identity-metrics
tags: ['SDK', 'Software Development Kit', 'AccessRequestIdentityMetrics', 'BetaAccessRequestIdentityMetrics']
---
# AccessRequestIdentityMetrics
Use this API to implement access request identity metrics functionality.
With this functionality in place, access request reviewers can see relevant details about the requested access item and associated source activity.
@@ -24,9 +24,7 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaAccessRequestIdentityMetrics**](#get-access-request-identity-metrics) | **GET** `/access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type}` | Return access request identity metrics
## get-access-request-identity-metrics
Use this API to return information access metrics.
### Parameters
@@ -37,7 +35,6 @@ Path | RequestedObjectId | **String** | True | Requested access item's ID.
Path | Type | **String** | True | Requested access item's type.
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -51,7 +48,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
@@ -60,7 +56,9 @@ Code | Description | Data Type
$IdentityId = "7025c863-c270-4ba6-beea-edf3cb091573" # String | Manager's identity ID.
$RequestedObjectId = "2db501be-f0fb-4cc5-a695-334133c52891" # String | Requested access item's ID.
$Type = "ENTITLEMENT" # String | Requested access item's type.
# Return access request identity metrics
try {
Get-BetaAccessRequestIdentityMetrics-BetaIdentityId $IdentityId -BetaRequestedObjectId $RequestedObjectId -BetaType $Type
@@ -71,7 +69,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-access-requests
title: AccessRequests
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/access-requests
tags: ['SDK', 'Software Development Kit', 'AccessRequests', 'BetaAccessRequests']
---
# 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.
@@ -40,9 +40,7 @@ Method | HTTP request | Description
[**Get-BetaAccessRequestStatus**](#list-access-request-status) | **GET** `/access-request-status` | Access Request Status
[**Set-BetaAccessRequestConfig**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration
## cancel-access-request
This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step.
In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it.
@@ -52,7 +50,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
@@ -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
@@ -77,7 +73,9 @@ $CancelAccessRequest = @"{
"accountActivityId" : "2c9180835d2e5168015d32f890ca1581",
"comment" : "I requested this role by mistake."
}"@
# Cancel Access Request
try {
$Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest
Suspend-BetaAccessRequest-BetaCancelAccessRequest $Result
@@ -89,11 +87,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## close-access-request
This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request's lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/).
To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND "Access Request". Use the Column Chooser to select 'Tracking Number', and use the 'Download' button to export a CSV containing the tracking numbers.
@@ -113,7 +108,6 @@ Param Type | Name | Data Type | Required | Description
Body | CloseAccessRequest | [**CloseAccessRequest**](../models/close-access-request) | True |
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -127,7 +121,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
@@ -139,7 +132,9 @@ $CloseAccessRequest = @"{
"completionStatus" : "Failure",
"message" : "The IdentityNow Administrator manually closed this request."
}"@
# Close Access Request
try {
$Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest
Close-BetaAccessRequest-BetaCloseAccessRequest $Result
@@ -151,11 +146,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
@@ -194,7 +186,6 @@ Param Type | Name | Data Type | Required | Description
Body | AccessRequest | [**AccessRequest**](../models/access-request) | True |
### Return type
[**AccessRequestResponse**](../models/access-request-response)
### Responses
@@ -208,7 +199,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
@@ -268,7 +258,9 @@ $AccessRequest = @"{
"type" : "ACCESS_PROFILE"
} ]
}"@
# Submit Access Request
try {
$Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest
New-BetaAccessRequest-BetaAccessRequest $Result
@@ -280,11 +272,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-access-request-config
This endpoint returns the current access-request configuration.
### Parameters
@@ -292,7 +281,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**AccessRequestConfig**](../models/access-request-config)
### Responses
@@ -306,13 +294,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-BetaAccessRequestConfig
@@ -323,11 +312,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.
@@ -347,7 +333,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
@@ -361,7 +346,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
@@ -377,7 +361,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-BetaAccessRequestStatus
@@ -388,11 +374,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-access-request-config
This endpoint replaces the current access-request configuration.
### Parameters
@@ -401,7 +384,6 @@ Param Type | Name | Data Type | Required | Description
Body | AccessRequestConfig | [**AccessRequestConfig**](../models/access-request-config) | True |
### Return type
[**AccessRequestConfig**](../models/access-request-config)
### Responses
@@ -415,7 +397,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
@@ -447,7 +428,9 @@ $AccessRequestConfig = @"{
"reauthorizationEnabled" : true,
"approvalsMustBeExternal" : true
}"@
# Update Access Request Configuration
try {
$Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig
Set-BetaAccessRequestConfig-BetaAccessRequestConfig $Result
@@ -459,7 +442,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-account-activities
title: AccountActivities
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/account-activities
tags: ['SDK', 'Software Development Kit', 'AccountActivities', 'BetaAccountActivities']
---
# 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-BetaAccountActivity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get Account Activity
[**Get-BetaAccountActivities**](#list-account-activities) | **GET** `/account-activities` | List Account Activities
## get-account-activity
This gets a single account activity by its id.
### Parameters
@@ -65,7 +63,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The account activity id
### Return type
[**CancelableAccountActivity**](../models/cancelable-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 Account Activity
try {
Get-BetaAccountActivity-BetaId $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
@@ -119,7 +114,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
[**CancelableAccountActivity[]**](../models/cancelable-account-activity)
### Responses
@@ -133,7 +127,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
@@ -148,7 +141,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 = 'MyFilters' # 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, gt, 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 = "MySorters" # 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-BetaAccountActivities
@@ -159,7 +154,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-account-aggregations
title: AccountAggregations
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/account-aggregations
tags: ['SDK', 'Software Development Kit', 'AccountAggregations', 'BetaAccountAggregations']
---
# AccountAggregations
Use this API to implement account aggregation progress tracking functionality.
With this functionality in place, administrators can view in-progress account aggregations, their statuses, and their relevant details.
@@ -30,9 +30,7 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaAccountAggregationStatus**](#get-account-aggregation-status) | **GET** `/account-aggregations/{id}/status` | In-progress Account Aggregation status
## get-account-aggregation-status
This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far.
Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not.
@@ -49,7 +47,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The account aggregation id
### Return type
[**AccountAggregationStatus**](../models/account-aggregation-status)
### Responses
@@ -63,14 +60,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 = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id
# In-progress Account Aggregation status
try {
Get-BetaAccountAggregationStatus-BetaId $Id
@@ -81,7 +79,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-account-usages
title: AccountUsages
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/account-usages
tags: ['SDK', 'Software Development Kit', 'AccountUsages', 'BetaAccountUsages']
---
# 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-BetaUsagesByAccountId**](#get-usages-by-account-id) | **GET** `/account-usages/{accountId}/summaries` | Returns account usage insights
## get-usages-by-account-id
This API returns a summary of account usage insights for past 12 months.
### 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-BetaUsagesByAccountId-BetaAccountId $AccountId
@@ -74,7 +72,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-accounts
title: Accounts
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/accounts
tags: ['SDK', 'Software Development Kit', 'Accounts', 'BetaAccounts']
---
# 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.
@@ -62,9 +62,7 @@ Method | HTTP request | Description
[**Unlock-BetaAccount**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock Account
[**Update-BetaAccount**](#update-account) | **PATCH** `/accounts/{id}` | Update Account
## create-account
Submits an account creation task - the API then returns the task ID.
The `sourceId` where this account will be created must be included in the `attributes` object.
@@ -84,7 +82,6 @@ Param Type | Name | Data Type | Required | Description
Body | AccountAttributesCreate | [**AccountAttributesCreate**](../models/account-attributes-create) | True |
### Return type
[**AccountsAsyncResult**](../models/accounts-async-result)
### Responses
@@ -98,7 +95,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
@@ -114,7 +110,9 @@ $AccountAttributesCreate = @"{
"mail" : "john.doe@sailpoint.com"
}
}"@
# Create Account
try {
$Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate
New-BetaAccount-BetaAccountAttributesCreate $Result
@@ -126,11 +124,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.
@@ -143,7 +138,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Account ID.
### Return type
[**AccountsAsyncResult**](../models/accounts-async-result)
### Responses
@@ -158,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 | Account ID.
# Delete Account
try {
Remove-BetaAccount-BetaId $Id
@@ -176,11 +171,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-account-async
Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation.
This endpoint is good for:
@@ -195,7 +187,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The account id
### Return type
[**TaskResultDto**](../models/task-result-dto)
### Responses
@@ -209,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
$Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id
# Remove Account
try {
Remove-BetaAccountAsync-BetaId $Id
@@ -227,11 +219,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## disable-account
This API submits a task to disable the account and returns the task ID.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
@@ -242,7 +231,6 @@ Path | Id | **String** | True | The account id
Body | AccountToggleRequest | [**AccountToggleRequest**](../models/account-toggle-request) | True |
### Return type
[**AccountsAsyncResult**](../models/accounts-async-result)
### Responses
@@ -257,7 +245,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
@@ -268,7 +255,9 @@ $AccountToggleRequest = @"{
"forceProvisioning" : false,
"externalVerificationId" : "3f9180835d2e5168015d32f890ca1581"
}"@
# Disable Account
try {
$Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest
Disable-BetaAccount-BetaId $Id -BetaAccountToggleRequest $Result
@@ -280,11 +269,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## disable-account-for-identity
This API submits a task to disable IDN account for a single identity.
### Parameters
@@ -293,7 +279,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The identity id.
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -308,14 +293,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 = "2c91808384203c2d018437e631158309" # String | The identity id.
# Disable IDN Account for Identity
try {
Disable-BetaAccountForIdentity-BetaId $Id
@@ -326,11 +312,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## disable-accounts-for-identities
This API submits tasks to disable IDN account for each identity provided in the request body.
### Parameters
@@ -339,7 +322,6 @@ Param Type | Name | Data Type | Required | Description
Body | IdentitiesAccountsBulkRequest | [**IdentitiesAccountsBulkRequest**](../models/identities-accounts-bulk-request) | True |
### Return type
[**BulkIdentitiesAccountsResponse[]**](../models/bulk-identities-accounts-response)
### Responses
@@ -353,7 +335,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 +343,9 @@ Code | Description | Data Type
$IdentitiesAccountsBulkRequest = @"{
"identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
}"@
# Disable IDN Accounts for Identities
try {
$Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest
Disable-BetaAccountsForIdentities-BetaIdentitiesAccountsBulkRequest $Result
@@ -374,11 +357,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## enable-account
This API submits a task to enable account and returns the task ID.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
@@ -389,7 +369,6 @@ Path | Id | **String** | True | The account id
Body | AccountToggleRequest | [**AccountToggleRequest**](../models/account-toggle-request) | True |
### Return type
[**AccountsAsyncResult**](../models/accounts-async-result)
### 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**: application/json
- **Accept**: application/json
@@ -415,7 +393,9 @@ $AccountToggleRequest = @"{
"forceProvisioning" : false,
"externalVerificationId" : "3f9180835d2e5168015d32f890ca1581"
}"@
# Enable Account
try {
$Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest
Enable-BetaAccount-BetaId $Id -BetaAccountToggleRequest $Result
@@ -427,11 +407,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## enable-account-for-identity
This API submits a task to enable IDN account for a single identity.
### Parameters
@@ -440,7 +417,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The identity id.
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -455,14 +431,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 = "2c91808384203c2d018437e631158309" # String | The identity id.
# Enable IDN Account for Identity
try {
Enable-BetaAccountForIdentity-BetaId $Id
@@ -473,11 +450,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## enable-accounts-for-identities
This API submits tasks to enable IDN account for each identity provided in the request body.
### Parameters
@@ -486,7 +460,6 @@ Param Type | Name | Data Type | Required | Description
Body | IdentitiesAccountsBulkRequest | [**IdentitiesAccountsBulkRequest**](../models/identities-accounts-bulk-request) | True |
### Return type
[**BulkIdentitiesAccountsResponse[]**](../models/bulk-identities-accounts-response)
### Responses
@@ -500,7 +473,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
@@ -509,7 +481,9 @@ Code | Description | Data Type
$IdentitiesAccountsBulkRequest = @"{
"identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
}"@
# Enable IDN Accounts for Identities
try {
$Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest
Enable-BetaAccountsForIdentities-BetaIdentitiesAccountsBulkRequest $Result
@@ -521,11 +495,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-account
Use this API to return the details for a single account by its ID.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
@@ -535,7 +506,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Account ID.
### Return type
[**Account**](../models/account)
### Responses
@@ -550,14 +520,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-BetaAccount-BetaId $Id
@@ -568,11 +539,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-account-entitlements
This API returns entitlements of the account.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
@@ -585,7 +553,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
[**Entitlement[]**](../models/entitlement)
### Responses
@@ -600,7 +567,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
@@ -610,7 +576,9 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id
$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)
# Account Entitlements
try {
Get-BetaAccountEntitlements-BetaId $Id
@@ -621,11 +589,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-accounts
List accounts.
### Parameters
@@ -639,7 +604,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
@@ -653,7 +617,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
@@ -665,7 +628,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 = '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-BetaAccounts
@@ -676,11 +641,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.
@@ -697,7 +659,6 @@ Path | Id | **String** | True | Account ID.
Body | AccountAttributes | [**AccountAttributes**](../models/account-attributes) | True |
### Return type
[**AccountsAsyncResult**](../models/accounts-async-result)
### Responses
@@ -712,7 +673,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
@@ -728,7 +688,9 @@ $AccountAttributes = @"{
"mail" : "john.doe@sailpoint.com"
}
}"@
# Update Account
try {
$Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes
Send-BetaAccount-BetaId $Id -BetaAccountAttributes $Result
@@ -740,11 +702,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.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
@@ -754,7 +713,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The account id
### Return type
[**AccountsAsyncResult**](../models/accounts-async-result)
### Responses
@@ -769,14 +727,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-BetaReloadAccount-BetaId $Id
@@ -787,11 +746,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.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
@@ -803,7 +759,6 @@ Path | Id | **String** | True | The account ID.
Body | AccountUnlockRequest | [**AccountUnlockRequest**](../models/account-unlock-request) | True |
### Return type
[**AccountsAsyncResult**](../models/accounts-async-result)
### Responses
@@ -818,7 +773,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
@@ -830,7 +784,9 @@ $AccountUnlockRequest = @"{
"externalVerificationId" : "3f9180835d2e5168015d32f890ca1581",
"unlockIDNAccount" : false
}"@
# Unlock Account
try {
$Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest
Unlock-BetaAccount-BetaId $Id -BetaAccountUnlockRequest $Result
@@ -842,11 +798,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-account
Use this API to update account details.
A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
@@ -867,7 +820,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
@@ -882,7 +834,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
@@ -890,9 +841,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 = @"{Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}}"@
$RequestBody = @"{Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}}"@ # 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-BetaAccount-BetaId $Id -BetaRequestBody $Result
@@ -904,7 +857,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-application-discovery
title: ApplicationDiscovery
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/application-discovery
tags: ['SDK', 'Software Development Kit', 'ApplicationDiscovery', 'BetaApplicationDiscovery']
---
# 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.
@@ -26,9 +26,7 @@ Method | HTTP request | Description
[**Update-BetaDiscoveredApplicationByID**](#patch-discovered-application-by-id) | **PATCH** `/discovered-applications/{id}` | Patch Discovered Application by ID
[**Send-BetaManualDiscoverApplicationsCsvTemplate**](#send-manual-discover-applications-csv-template) | **POST** `/manual-discover-applications` | Upload CSV to Discover Applications
## get-discovered-application-by-id
Get the discovered application, along with with its associated sources, based on the provided ID.
@@ -38,7 +36,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Discovered application's ID.
### Return type
(empty response body)
### 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 = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's ID.
# Get Discovered Application by ID
try {
Get-BetaDiscoveredApplicationByID-BetaId $Id
@@ -70,11 +68,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-discovered-applications
Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors.
@@ -88,7 +83,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
@@ -102,7 +96,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
@@ -113,7 +106,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)
# Retrieve discovered applications for tenant
try {
Get-BetaDiscoveredApplications
@@ -124,11 +119,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.
@@ -139,7 +131,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**ManualDiscoverApplicationsTemplate**](../models/manual-discover-applications-template)
### Responses
@@ -153,13 +144,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-BetaManualDiscoverApplicationsCsvTemplate
@@ -170,11 +162,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-discovered-application-by-id
Update an existing discovered application by using a limited version of the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
You can patch these fields: - **associatedSources** - **dismissed**
@@ -185,7 +174,6 @@ Path | Id | **String** | True | Discovered application's ID.
Body | JsonPatchOperations | [**[]JsonPatchOperations**](../models/json-patch-operations) | (optional) |
### Return type
(empty response body)
### Responses
@@ -199,21 +187,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 = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's ID.
# JsonPatchOperations[] | (optional)
$JsonPatchOperations = @"{
"op" : "replace",
"path" : "/dismissed",
"value" : true
}"@
}"@ # JsonPatchOperations[] | (optional)
# Patch Discovered Application by ID
try {
Update-BetaDiscoveredApplicationByID-BetaId $Id
@@ -224,11 +212,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## send-manual-discover-applications-csv-template
Upload a CSV file with application data for manual correlation to specific ISC connectors.
If a suitable ISC connector is unavailable, the system will recommend generic connectors instead.
@@ -238,7 +223,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
@@ -252,14 +236,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-BetaManualDiscoverApplicationsCsvTemplate-BetaFile $File
@@ -270,7 +255,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-approvals
title: Approvals
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/approvals
tags: ['SDK', 'Software Development Kit', 'Approvals', 'BetaApprovals']
---
# Approvals
Use this API to implement approval functionality. With this functionality in place, you can get generic approvals and modify them.
@@ -24,9 +24,7 @@ Method | HTTP request | Description
[**Get-BetaApproval**](#get-approval) | **GET** `/generic-approvals/{id}` | Get Approval
[**Get-BetaApprovals**](#get-approvals) | **GET** `/generic-approvals` | Get Approvals
## get-approval
Get a single approval for a given approval ID. This endpoint is for generic approvals, unlike the access-request-approval endpoint, and doesn't include access-request-approvals.
### Parameters
@@ -35,7 +33,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the approval that to be returned.
### Return type
[**Approval**](../models/approval)
### 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
$Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | ID of the approval that to be returned.
# Get Approval
try {
Get-BetaApproval-BetaId $Id
@@ -67,11 +65,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-approvals
Get a list of approvals, which can be filtered by requester ID, status, or reference type. You can use the "Mine" query parameter to return all approvals for the current approver. This endpoint is for generic approvals, unlike the access-request-approval endpoint, and does not include access-request-approvals.
Absence of all query parameters will will default to mine=true.
@@ -83,7 +78,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* **referenceType**: *eq*
### Return type
[**Approval[]**](../models/approval)
### Responses
@@ -97,7 +91,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
@@ -106,7 +99,9 @@ Code | Description | Data Type
$Mine = $true # Boolean | Returns the list of approvals for the current caller. (optional)
$RequesterId = "17e633e7d57e481569df76323169deb6a" # String | Returns the list of approvals for a given requester ID. (optional)
$Filters = 'filters=status eq PENDING' # 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* **referenceType**: *eq* (optional)
# Get Approvals
try {
Get-BetaApprovals
@@ -117,7 +112,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-apps
title: Apps
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/apps
tags: ['SDK', 'Software Development Kit', 'Apps', 'BetaApps']
---
# Apps
Use this API to implement source application functionality.
With this functionality in place, you can create, customize, and manage applications within sources.
@@ -35,9 +35,7 @@ Method | HTTP request | Description
[**Update-BetaUserApp**](#patch-user-app) | **PATCH** `/user-apps/{id}` | Patch user app by ID
[**Update-BetaSourceAppsInBulk**](#update-source-apps-in-bulk) | **POST** `/source-apps/bulk-update` | Bulk update source apps
## create-source-app
This endpoint creates a source app using the given source app payload
### Parameters
@@ -46,7 +44,6 @@ Param Type | Name | Data Type | Required | Description
Body | SourceAppCreateDto | [**SourceAppCreateDto**](../models/source-app-create-dto) | True |
### Return type
[**SourceApp**](../models/source-app)
### Responses
@@ -60,7 +57,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 @@ $SourceAppCreateDto = @"{
},
"matchAllAccounts" : true
}"@
# Create source app
try {
$Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto
New-BetaSourceApp-BetaSourceAppCreateDto $Result
@@ -88,11 +86,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-access-profiles-from-source-app-by-bulk
This API returns the final list of access profiles for the specified source app after removing
### Parameters
@@ -103,7 +98,6 @@ Path | Id | **String** | True | ID of the source app
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
### Return type
[**AccessProfileDetails[]**](../models/access-profile-details)
### Responses
@@ -117,7 +111,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
@@ -125,10 +118,12 @@ Code | Description | Data Type
```powershell
$Id = "2c91808a7813090a017814121e121518" # String | ID of the source app
$RequestBody = "MyRequestBody" # String[] |
$RequestBody = @""@
$RequestBody = @""@ # String[] |
$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)
# Bulk remove access profiles from the specified source app
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Remove-BetaAccessProfilesFromSourceAppByBulk-BetaId $Id -BetaRequestBody $Result
@@ -140,11 +135,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-source-app
Use this API to delete a specific source app
### Parameters
@@ -153,7 +145,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | source app ID.
### Return type
[**SourceApp**](../models/source-app)
### Responses
@@ -167,14 +158,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 app ID.
# Delete source app by ID
try {
Remove-BetaSourceApp-BetaId $Id
@@ -185,11 +177,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-source-app
This API returns a source app by its ID.
### Parameters
@@ -198,7 +187,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the source app
### Return type
[**SourceApp**](../models/source-app)
### Responses
@@ -213,14 +201,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 source app
# Get source app by ID
try {
Get-BetaSourceApp-BetaId $Id
@@ -231,11 +220,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-access-profiles-for-source-app
This API returns the list of access profiles for the specified source app
### Parameters
@@ -247,7 +233,6 @@ Path | Id | **String** | True | ID of the source app
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* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le*
### Return type
[**AccessProfileDetails[]**](../models/access-profile-details)
### Responses
@@ -261,7 +246,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 +255,9 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app
$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 = 'name eq "developer access profile"' # 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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional)
# List access profiles for the specified source app
try {
Get-BetaAccessProfilesForSourceApp-BetaId $Id
@@ -282,11 +268,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-all-source-app
This API returns the list of all source apps for the org.
A token with ORG_ADMIN authority is required to call this API.
@@ -301,7 +284,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* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq*
### Return type
[**SourceApp[]**](../models/source-app)
### Responses
@@ -315,7 +297,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 +307,9 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$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)
$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: **id, name, created, modified, owner.id, accountSource.id** (optional)
$Filters = 'enabled eq true' # 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, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional)
# List all source apps
try {
Get-BetaAllSourceApp
@@ -337,11 +320,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-all-user-apps
This API returns the list of all user apps with specified filters.
This API must be used with **filters** query parameter.
@@ -354,7 +334,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
[**UserApp[]**](../models/user-app)
### Responses
@@ -368,7 +347,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
@@ -378,7 +356,9 @@ $Filters = 'name eq "user app name"' # String | Filter results using the standar
$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)
$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 all user apps
try {
Get-BetaAllUserApps-BetaFilters $Filters
@@ -389,11 +369,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-assigned-source-app
This API returns the list of source apps assigned for logged in user.
### Parameters
@@ -406,7 +383,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* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in*
### Return type
[**SourceApp[]**](../models/source-app)
### Responses
@@ -420,7 +396,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
@@ -431,7 +406,9 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$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)
$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: **id, name, created, modified, accountSource.id** (optional)
$Filters = 'name eq "source app 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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional)
# List assigned source apps
try {
Get-BetaAssignedSourceApp
@@ -442,11 +419,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-available-accounts-for-user-app
This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user.
### Parameters
@@ -458,7 +432,6 @@ Path | Id | **String** | True | ID of the user app
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
[**AppAccountDetails[]**](../models/app-account-details)
### Responses
@@ -472,7 +445,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
@@ -482,7 +454,9 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app
$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)
$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 available accounts for user app
try {
Get-BetaAvailableAccountsForUserApp-BetaId $Id
@@ -493,11 +467,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-available-source-apps
This API returns the list of source apps available for access request.
### Parameters
@@ -510,7 +481,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* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in*
### Return type
[**SourceApp[]**](../models/source-app)
### Responses
@@ -524,7 +494,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
@@ -535,7 +504,9 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$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)
$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: **id, name, created, modified, owner.id, accountSource.id** (optional)
$Filters = 'name eq "source app 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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional)
# List available source apps
try {
Get-BetaAvailableSourceApps
@@ -546,11 +517,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-owned-user-apps
This API returns the list of user apps assigned to logged in user
### Parameters
@@ -562,7 +530,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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq*
### Return type
[**UserApp[]**](../models/user-app)
### Responses
@@ -576,7 +543,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
@@ -586,7 +552,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)
$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 = 'name eq "user app 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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional)
# List owned user apps
try {
Get-BetaOwnedUserApps
@@ -597,11 +565,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-source-app
This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**.
Name, description and owner can't be empty or null.
@@ -613,7 +578,6 @@ Path | Id | **String** | True | ID of the source app to patch
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) |
### Return type
[**SourceAppPatchDto**](../models/source-app-patch-dto)
### Responses
@@ -628,21 +592,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 source app to patch
# JsonPatchOperation[] | (optional)
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] | (optional)
# Patch source app by ID
try {
Update-BetaSourceApp-BetaId $Id
@@ -653,11 +617,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-user-app
This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
The following fields are patchable: **account**
@@ -668,7 +629,6 @@ Path | Id | **String** | True | ID of the user app to patch
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) |
### Return type
[**UserApp**](../models/user-app)
### Responses
@@ -683,21 +643,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 user app to patch
# JsonPatchOperation[] | (optional)
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] | (optional)
# Patch user app by ID
try {
Update-BetaUserApp-BetaId $Id
@@ -708,11 +668,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-source-apps-in-bulk
This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch.
The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**.
Name, description and owner can't be empty or null.
@@ -723,7 +680,6 @@ Param Type | Name | Data Type | Required | Description
Body | SourceAppBulkUpdateRequest | [**SourceAppBulkUpdateRequest**](../models/source-app-bulk-update-request) | (optional) |
### Return type
(empty response body)
### Responses
@@ -738,7 +694,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
@@ -756,7 +711,9 @@ $SourceAppBulkUpdateRequest = @"{
"value" : false
} ]
}"@
# Bulk update source apps
try {
Update-BetaSourceAppsInBulk
@@ -767,7 +724,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-auth-profile
title: AuthProfile
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/auth-profile
tags: ['SDK', 'Software Development Kit', 'AuthProfile', 'BetaAuthProfile']
---
# AuthProfile
Use this API to implement Auth Profile functionality.
With this functionality in place, users can read authentication profiles and make changes to them.
@@ -28,17 +28,15 @@ Method | HTTP request | Description
[**Get-BetaProfileConfigList**](#get-profile-config-list) | **GET** `/auth-profiles` | Get list of Auth Profiles.
[**Update-BetaProfileConfig**](#patch-profile-config) | **PATCH** `/auth-profiles/{id}` | Patch a specified Auth Profile
## get-profile-config
This API returns auth profile information.
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | ID of the Auth Profile to get.
### Return type
[**AuthProfile**](../models/auth-profile)
### Responses
@@ -53,28 +51,27 @@ 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 Auth Profile to get.
# Get Auth Profile.
try {
Get-BetaProfileConfig
Get-BetaProfileConfig-BetaId $Id
# Below is a request that includes all optional parameters
# Get-BetaProfileConfig
# Get-BetaProfileConfig -BetaId $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProfileConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-profile-config-list
This API returns a list of auth profiles.
### Parameters
@@ -82,7 +79,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**AuthProfileSummary[]**](../models/auth-profile-summary)
### Responses
@@ -96,13 +92,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 list of Auth Profiles.
try {
Get-BetaProfileConfigList
@@ -113,11 +110,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-profile-config
This API updates an existing Auth Profile. The following fields are patchable:
**offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type**
@@ -128,7 +122,6 @@ Path | Id | **String** | True | ID of the Auth Profile to patch.
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True |
### Return type
[**AuthProfile**](../models/auth-profile)
### Responses
@@ -142,21 +135,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 Auth Profile to patch.
# JsonPatchOperation[] |
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] |
# Patch a specified Auth Profile
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-BetaProfileConfig-BetaId $Id -BetaJsonPatchOperation $Result
@@ -168,7 +161,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-certification-campaigns
title: CertificationCampaigns
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/certification-campaigns
tags: ['SDK', 'Software Development Kit', 'CertificationCampaigns', 'BetaCertificationCampaigns']
---
# 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-BetaGenerateCampaignTemplate**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a Campaign from Template
[**Update-BetaCampaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a Campaign
## complete-campaign
:::caution
This endpoint will run successfully for any campaigns that are **past due**.
@@ -130,7 +128,6 @@ Path | Id | **String** | True | Campaign ID.
Body | CompleteCampaignOptions | [**CompleteCampaignOptions**](../models/complete-campaign-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
@@ -145,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
@@ -155,7 +151,9 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID.
$CompleteCampaignOptions = @"{
"autoCompleteAction" : "REVOKE"
}"@
# Complete a Campaign
try {
Complete-BetaCampaign-BetaId $Id
@@ -166,11 +164,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. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -182,7 +177,6 @@ Param Type | Name | Data Type | Required | Description
Body | Campaign | [**Campaign**](../models/campaign) | True |
### Return type
[**Campaign**](../models/campaign)
### Responses
@@ -196,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
@@ -311,7 +304,9 @@ $Campaign = @"{
"status" : "ACTIVE",
"correlatedStatus" : "CORRELATED"
}"@
# Create Campaign
try {
$Result = ConvertFrom-JsonToCampaign -Json $Campaign
New-BetaCampaign-BetaCampaign $Result
@@ -323,11 +318,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-campaign-template
Use this API to create a campaign template based on campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign-template).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -339,7 +331,6 @@ Param Type | Name | Data Type | Required | Description
Body | CampaignTemplate | [**CampaignTemplate**](../models/campaign-template) | True |
### Return type
[**CampaignTemplate**](../models/campaign-template)
### Responses
@@ -353,7 +344,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
@@ -483,7 +473,9 @@ $CampaignTemplate = @"{
},
"id" : "2c9079b270a266a60170a277bb960008"
}"@
# Create a Campaign Template
try {
$Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate
New-BetaCampaignTemplate-BetaCampaignTemplate $Result
@@ -495,11 +487,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-campaign-template
Use this API to delete a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -511,7 +500,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
@@ -526,14 +514,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-BetaCampaignTemplate-BetaId $Id
@@ -544,11 +533,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. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template-schedule).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -560,7 +546,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
@@ -575,14 +560,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-BetaCampaignTemplateSchedule-BetaId $Id
@@ -593,11 +579,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. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaigns).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -609,7 +592,6 @@ Param Type | Name | Data Type | Required | Description
Body | DeleteCampaignsRequest | [**DeleteCampaignsRequest**](../models/delete-campaigns-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
@@ -624,7 +606,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
@@ -633,7 +614,9 @@ Code | Description | Data Type
$DeleteCampaignsRequest = @"{
"ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ]
}"@
# Delete Campaigns
try {
$Result = ConvertFrom-JsonToDeleteCampaignsRequest -Json $DeleteCampaignsRequest
Remove-BetaCampaigns-BetaDeleteCampaignsRequest $Result
@@ -645,11 +628,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-active-campaigns
Use this API to get a list of campaigns. The API can provide increased level of detail for each campaign for the correct provided query. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-active-campaigns).
A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
@@ -666,7 +646,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
@@ -680,7 +659,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
@@ -692,7 +670,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-BetaActiveCampaigns
@@ -703,11 +683,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. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -719,7 +696,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the campaign to be retrieved.
### Return type
[**Slimcampaign**](../models/slimcampaign)
### Responses
@@ -734,14 +710,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 to be retrieved.
# Get Campaign
try {
Get-BetaCampaign-BetaId $Id
@@ -752,11 +729,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. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports).
A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
@@ -768,7 +742,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
@@ -783,14 +756,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-BetaCampaignReports-BetaId $Id
@@ -801,11 +775,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. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports-config).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -816,7 +787,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**CampaignReportsConfig**](../models/campaign-reports-config)
### Responses
@@ -830,13 +800,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-BetaCampaignReportsConfig
@@ -847,11 +818,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-campaign-template
Use this API to fetch a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -863,7 +831,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Requested campaign template's ID.
### Return type
[**CampaignTemplate**](../models/campaign-template)
### Responses
@@ -878,14 +845,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-BetaCampaignTemplate-BetaId $Id
@@ -896,11 +864,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. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template-schedule).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -912,7 +877,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
@@ -927,14 +891,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-BetaCampaignTemplateSchedule-BetaId $Id
@@ -945,11 +910,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. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/list-campaign-templates).
The endpoint returns all campaign templates matching the query parameters.
@@ -967,7 +929,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
@@ -981,7 +942,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
@@ -992,7 +952,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-BetaCampaignTemplates
@@ -1003,11 +965,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## move
This API reassigns the specified certifications from one identity to another. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/move).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -1020,7 +979,6 @@ Path | Id | **String** | True | The certification campaign ID
Body | AdminReviewReassign | [**AdminReviewReassign**](../models/admin-review-reassign) | True |
### Return type
[**CertificationTask**](../models/certification-task)
### Responses
@@ -1035,7 +993,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
@@ -1050,7 +1007,9 @@ $AdminReviewReassign = @"{
"type" : "IDENTITY"
}
}"@
# Reassign Certifications
try {
$Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign
Move-Beta-BetaId $Id -BetaAdminReviewReassign $Result
@@ -1062,11 +1021,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. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/patch-campaign-template).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -1079,7 +1035,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
@@ -1094,21 +1049,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-BetaCampaignTemplate-BetaId $Id -BetaJsonPatchOperation $Result
@@ -1120,11 +1075,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-campaign-reports-config
Use this API to overwrite the configuration for campaign reports. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-reports-config).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -1136,7 +1088,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
@@ -1150,7 +1101,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
@@ -1159,7 +1109,9 @@ Code | Description | Data Type
$CampaignReportsConfig = @"{
"identityAttributeColumns" : [ "firstname", "lastname" ]
}"@
# Set Campaign Reports Configuration
try {
$Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig
Set-BetaCampaignReportsConfig-BetaCampaignReportsConfig $Result
@@ -1171,11 +1123,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.
Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-template-schedule).
@@ -1189,7 +1138,6 @@ Path | Id | **String** | True | ID of the campaign template being scheduled.
Body | Schedule | [**Schedule**](../models/schedule) | (optional) |
### Return type
(empty response body)
### Responses
@@ -1204,7 +1152,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
@@ -1231,7 +1178,9 @@ $Schedule = @"{
"expiration" : "2000-01-23T04:56:07.000+00:00",
"type" : "WEEKLY"
}"@
# Set Campaign Template Schedule
try {
Set-BetaCampaignTemplateSchedule-BetaId $Id
@@ -1242,11 +1191,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. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -1259,7 +1205,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
@@ -1274,7 +1219,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
@@ -1284,7 +1228,9 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID.
$ActivateCampaignOptions = @"{
"timeZone" : "-05:00"
}"@
# Activate a Campaign
try {
Start-BetaCampaign-BetaId $Id
@@ -1295,11 +1241,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. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-remediation-scan).
A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
@@ -1311,7 +1254,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
@@ -1326,14 +1268,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-BetaCampaignRemediationScan-BetaId $Id
@@ -1344,11 +1287,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-campaign-report
Use this API to run a report for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-report).
A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
@@ -1361,7 +1301,6 @@ Path | Id | **String** | True | ID of the campaign the report is being run fo
Path | Type | [**ReportType**](../models/report-type) | True | Type of report to run.
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -1376,7 +1315,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
@@ -1384,7 +1322,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 report to run.
# Run Campaign Report
try {
Start-BetaCampaignReport-BetaId $Id -BetaType $Type
@@ -1395,11 +1335,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
@@ -1423,7 +1360,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
@@ -1437,14 +1373,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-BetaGenerateCampaignTemplate-BetaId $Id
@@ -1455,11 +1392,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. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/update-campaign).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -1468,11 +1402,10 @@ A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | ID of the campaign template being modified.
Path | Id | **String** | True | ID of the campaign being modified.
Body | RequestBody | [**[]SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | 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/slimcampaign)
### Responses
@@ -1487,17 +1420,18 @@ 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.
$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign being modified.
$RequestBody = # SystemCollectionsHashtable[] | 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
$RequestBody = @"[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]"@
$RequestBody = @"[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]"@ # SystemCollectionsHashtable[] | 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-JsonToRequestBody -Json $RequestBody
Update-BetaCampaign-BetaId $Id -BetaRequestBody $Result
@@ -1509,7 +1443,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-certifications
title: Certifications
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/certifications
tags: ['SDK', 'Software Development Kit', 'Certifications', 'BetaCertifications']
---
# Certifications
Use this API to implement certification functionality.
This API provides specific functionality that improves an organization's ability to manage its certification process.
@@ -39,9 +39,7 @@ Method | HTTP request | Description
[**Get-BetaCertificationReviewers**](#list-certification-reviewers) | **GET** `/certifications/{id}/reviewers` | List of Reviewers for certification
[**Submit-BetaReassignCertsAsync**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously
## get-identity-certification-item-permissions
This API returns the permissions associated with an entitlement certification item based on the certification item's ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
### Parameters
@@ -55,7 +53,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
@@ -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**: Not defined
- **Accept**: application/json
@@ -82,7 +78,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-BetaIdentityCertificationItemPermissions-BetaCertificationId $CertificationId -BetaItemId $ItemId
@@ -93,11 +91,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-certification-pending-tasks
This API returns the status of all pending (`QUEUED` or `IN_PROGRESS`) tasks for an identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
### Parameters
@@ -106,7 +101,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The identity campaign certification ID
### Return type
[**IdentityCertificationTask[]**](../models/identity-certification-task)
### Responses
@@ -121,14 +115,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 = "MyId" # String | The identity campaign certification ID
# Pending Certification Tasks
try {
Get-BetaIdentityCertificationPendingTasks-BetaId $Id
@@ -139,11 +134,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-certification-task-status
This API returns the status of a certification task. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
### Parameters
@@ -153,7 +145,6 @@ Path | Id | **String** | True | The identity campaign certification ID
Path | TaskId | **String** | True | The certification task ID
### Return type
[**IdentityCertificationTask**](../models/identity-certification-task)
### Responses
@@ -168,7 +159,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
@@ -176,7 +166,9 @@ Code | Description | Data Type
```powershell
$Id = "MyId" # String | The identity campaign certification ID
$TaskId = "MyTaskId" # String | The certification task ID
# Certification Task Status
try {
Get-BetaIdentityCertificationTaskStatus-BetaId $Id -BetaTaskId $TaskId
@@ -187,11 +179,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-certification-reviewers
This API returns a list of reviewers for the certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
### Parameters
@@ -205,7 +194,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
@@ -220,7 +208,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
$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-BetaCertificationReviewers-BetaId $Id
@@ -243,11 +232,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. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
### Parameters
@@ -257,7 +243,6 @@ Path | Id | **String** | True | The identity campaign certification ID
Body | ReviewReassign | [**ReviewReassign**](../models/review-reassign) | True |
### Return type
[**IdentityCertificationTask**](../models/identity-certification-task)
### Responses
@@ -272,7 +257,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
@@ -290,7 +274,9 @@ $ReviewReassign = @"{
"type" : "ITEM"
} ]
}"@
# Reassign Certifications Asynchronously
try {
$Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign
Submit-BetaReassignCertsAsync-BetaId $Id -BetaReviewReassign $Result
@@ -302,7 +288,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-connector-rule-management
title: ConnectorRuleManagement
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/connector-rule-management
tags: ['SDK', 'Software Development Kit', 'ConnectorRuleManagement', 'BetaConnectorRuleManagement']
---
# ConnectorRuleManagement
Use this API to implement connector rule management functionality.
With this functionality in place, administrators can implement connector-executed rules in a programmatic, scalable way.
@@ -31,9 +31,7 @@ Method | HTTP request | Description
[**Update-BetaConnectorRule**](#update-connector-rule) | **PUT** `/connector-rules/{id}` | Update a Connector Rule
[**Confirm-BetaConnectorRule**](#validate-connector-rule) | **POST** `/connector-rules/validate` | Validate Connector Rule
## create-connector-rule
Creates a new connector rule.
A token with ORG_ADMIN authority is required to call this API.
@@ -43,7 +41,6 @@ Param Type | Name | Data Type | Required | Description
Body | ConnectorRuleCreateRequest | [**ConnectorRuleCreateRequest**](../models/connector-rule-create-request) | True | The connector rule to create
### Return type
[**ConnectorRuleResponse**](../models/connector-rule-response)
### 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
@@ -89,7 +85,9 @@ $ConnectorRuleCreateRequest = @"{
"attributes" : { },
"type" : "BuildMap"
}"@
# Create Connector Rule
try {
$Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest
New-BetaConnectorRule-BetaConnectorRuleCreateRequest $Result
@@ -101,11 +99,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-connector-rule
Deletes the connector rule specified by the given ID.
A token with ORG_ADMIN authority is required to call this API.
@@ -115,7 +110,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the connector rule to delete
### Return type
(empty response body)
### Responses
@@ -130,14 +124,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 = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete
# Delete a Connector-Rule
try {
Remove-BetaConnectorRule-BetaId $Id
@@ -148,11 +143,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-connector-rule
Returns the connector rule specified by ID.
A token with ORG_ADMIN authority is required to call this API.
@@ -162,7 +154,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the connector rule to retrieve
### Return type
[**ConnectorRuleResponse**](../models/connector-rule-response)
### Responses
@@ -177,14 +168,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 = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to retrieve
# Connector-Rule by ID
try {
Get-BetaConnectorRule-BetaId $Id
@@ -195,11 +187,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-connector-rule-list
Returns the list of connector rules.
A token with ORG_ADMIN authority is required to call this API.
@@ -208,7 +197,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**ConnectorRuleResponse[]**](../models/connector-rule-response)
### Responses
@@ -222,13 +210,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 Connector Rules
try {
Get-BetaConnectorRuleList
@@ -239,11 +228,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-connector-rule
Updates an existing connector rule with the one provided in the request body. Note that the fields 'id', 'name', and 'type' are immutable.
A token with ORG_ADMIN authority is required to call this API.
@@ -254,7 +240,6 @@ Path | Id | **String** | True | ID of the connector rule to update
Body | ConnectorRuleUpdateRequest | [**ConnectorRuleUpdateRequest**](../models/connector-rule-update-request) | (optional) | The connector rule with updated data
### Return type
[**ConnectorRuleResponse**](../models/connector-rule-response)
### Responses
@@ -269,7 +254,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
@@ -303,7 +287,9 @@ $ConnectorRuleUpdateRequest = @"{
"id" : "8113d48c0b914f17b4c6072d4dcb9dfe",
"type" : "BuildMap"
}"@
# Update a Connector Rule
try {
Update-BetaConnectorRule-BetaId $Id
@@ -314,11 +300,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## validate-connector-rule
Returns a list of issues within the code to fix, if any.
A token with ORG_ADMIN authority is required to call this API.
@@ -328,7 +311,6 @@ Param Type | Name | Data Type | Required | Description
Body | SourceCode | [**SourceCode**](../models/source-code) | True | The code to validate
### Return type
[**ConnectorRuleValidationResponse**](../models/connector-rule-validation-response)
### Responses
@@ -342,7 +324,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
@@ -352,7 +333,9 @@ $SourceCode = @"{
"version" : "1.0",
"script" : "return \"Mr. \" + firstName;"
}"@
# Validate Connector Rule
try {
$Result = ConvertFrom-JsonToSourceCode -Json $SourceCode
Confirm-BetaConnectorRule-BetaSourceCode $Result
@@ -364,7 +347,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-connectors
title: Connectors
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/connectors
tags: ['SDK', 'Software Development Kit', 'Connectors', 'BetaConnectors']
---
# Connectors
Use this API to implement connector functionality.
With this functionality in place, administrators can view available connectors.
@@ -34,9 +34,7 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaConnectorList**](#get-connector-list) | **GET** `/connectors` | Get Connector List
## get-connector-list
Fetches list of connectors that have 'RELEASED' status using filtering and pagination.
### Parameters
@@ -49,7 +47,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
@@ -64,7 +61,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
@@ -75,7 +71,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-BetaConnectorList
@@ -86,7 +84,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-custom-forms
title: CustomForms
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/custom-forms
tags: ['SDK', 'Software Development Kit', 'CustomForms', 'BetaCustomForms']
---
# CustomForms
Use this API to build and manage custom forms.
With this functionality in place, administrators can create and view form definitions and form instances.
@@ -46,18 +46,15 @@ Method | HTTP request | Description
[**Search-BetaPreDefinedSelectOptions**](#search-pre-defined-select-options) | **GET** `/form-definitions/predefined-select-options` | List predefined select options.
[**Show-BetaPreviewDataSource**](#show-preview-data-source) | **POST** `/form-definitions/{formDefinitionID}/data-source` | Preview form definition data source.
## create-form-definition
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Body | CreateFormDefinitionRequest | [**CreateFormDefinitionRequest**](../models/create-form-definition-request) | (optional) | Body is the request payload to create form definition request
### Return type
[**FormDefinitionResponse**](../models/form-definition-response)
### Responses
@@ -71,7 +68,6 @@ Code | Description | Data Type
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -188,7 +184,9 @@ $CreateFormDefinitionRequest = @"{
"key" : "department"
} ]
}"@
# Creates a form definition.
try {
New-BetaFormDefinition
@@ -199,20 +197,16 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-form-definition-by-template
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Body | CreateFormDefinitionRequest | [**CreateFormDefinitionRequest**](../models/create-form-definition-request) | (optional) | Body is the request payload to create form definition request
### Return type
[**FormDefinitionResponse**](../models/form-definition-response)
### Responses
@@ -226,7 +220,6 @@ Code | Description | Data Type
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -343,7 +336,9 @@ $CreateFormDefinitionRequest = @"{
"key" : "department"
} ]
}"@
# Create a form definition by template.
try {
New-BetaFormDefinitionByTemplate
@@ -354,20 +349,16 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-form-definition-dynamic-schema
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Body | Body | [**FormDefinitionDynamicSchemaRequest**](../models/form-definition-dynamic-schema-request) | (optional) | Body is the request payload to create a form definition dynamic schema
### Return type
[**FormDefinitionDynamicSchemaResponse**](../models/form-definition-dynamic-schema-response)
### Responses
@@ -382,7 +373,6 @@ Code | Description | Data Type
500 | An internal server error occurred | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -397,7 +387,9 @@ $Body = @"{
"type" : "action",
"versionNumber" : 1
}"@
# Generate JSON Schema dynamically.
try {
New-BetaFormDefinitionDynamicSchema
@@ -408,11 +400,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-form-definition-file-request
Parameter `{formDefinitionID}` should match a form definition ID.
### Parameters
@@ -422,7 +411,6 @@ Path | FormDefinitionID | **String** | True | FormDefinitionID String specif
| File | **System.IO.FileInfo** | True | File specifying the multipart
### Return type
[**FormDefinitionFileUploadResponse**](../models/form-definition-file-upload-response)
### Responses
@@ -440,7 +428,6 @@ Code | Description | Data Type
503 | An external service is not available | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
@@ -448,7 +435,9 @@ Code | Description | Data Type
```powershell
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID String specifying FormDefinitionID
$File = # System.IO.FileInfo | File specifying the multipart
# Upload new form definition file.
try {
New-BetaFormDefinitionFileRequest-BetaFormDefinitionID $FormDefinitionID -BetaFile $File
@@ -459,20 +448,16 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-form-instance
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Body | Body | [**CreateFormInstanceRequest**](../models/create-form-instance-request) | (optional) | Body is the request payload to create a form instance
### Return type
[**FormInstanceResponse**](../models/form-instance-response)
### Responses
@@ -486,7 +471,6 @@ Code | Description | Data Type
500 | An internal server error occurred | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -513,7 +497,9 @@ $Body = @"{
"state" : "ASSIGNED",
"ttl" : 1571827560
}"@
# Creates a form instance.
try {
New-BetaFormInstance
@@ -524,11 +510,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-form-definition
Parameter `{formDefinitionID}` should match a form definition ID.
### Parameters
@@ -537,7 +520,6 @@ Param Type | Name | Data Type | Required | Description
Path | FormDefinitionID | **String** | True | Form definition ID
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -552,14 +534,15 @@ Code | Description | Data Type
500 | An internal server error occurred | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID
# Deletes a form definition.
try {
Remove-BetaFormDefinition-BetaFormDefinitionID $FormDefinitionID
@@ -570,11 +553,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## export-form-definitions-by-tenant
No parameters required.
### Parameters
@@ -586,7 +566,6 @@ Param Type | Name | Data Type | Required | Description
Query | Sorters | **String** | (optional) (default to "name") | 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, created, modified**
### Return type
[**ExportFormDefinitionsByTenant200ResponseInner[]**](../models/export-form-definitions-by-tenant200-response-inner)
### Responses
@@ -600,7 +579,6 @@ Code | Description | Data Type
500 | An internal server error occurred | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -610,7 +588,9 @@ $Offset = 0 # Int64 | Offset Integer specifying the offset of the first result
$Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250)
$Filters = 'name sw "my form"' # 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, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, 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, created, modified** (optional) (default to "name")
# List form definitions by tenant.
try {
Export-BetaFormDefinitionsByTenant
@@ -621,13 +601,10 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-file-from-s3
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -635,7 +612,6 @@ Path | FormDefinitionID | **String** | True | FormDefinitionID Form definiti
Path | FileID | **String** | True | FileID String specifying the hashed name of the uploaded file we are retrieving.
### Return type
**System.IO.FileInfo**
### Responses
@@ -651,7 +627,6 @@ Code | Description | Data Type
503 | An external service is not available | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, image/jpeg, image/png, application/octet-stream
@@ -659,7 +634,9 @@ Code | Description | Data Type
```powershell
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID Form definition ID
$FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving.
# Download definition file by fileId.
try {
Get-BetaFileFromS3-BetaFormDefinitionID $FormDefinitionID -BetaFileID $FileID
@@ -670,11 +647,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-form-definition-by-key
Parameter `{formDefinitionID}` should match a form definition ID.
### Parameters
@@ -683,7 +657,6 @@ Param Type | Name | Data Type | Required | Description
Path | FormDefinitionID | **String** | True | Form definition ID
### Return type
[**FormDefinitionResponse**](../models/form-definition-response)
### Responses
@@ -698,14 +671,15 @@ Code | Description | Data Type
500 | An internal server error occurred | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID
# Return a form definition.
try {
Get-BetaFormDefinitionByKey-BetaFormDefinitionID $FormDefinitionID
@@ -716,11 +690,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-form-instance-by-key
Parameter `{formInstanceID}` should match a form instance ID.
### Parameters
@@ -729,7 +700,6 @@ Param Type | Name | Data Type | Required | Description
Path | FormInstanceID | **String** | True | Form instance ID
### Return type
[**FormInstanceResponse**](../models/form-instance-response)
### Responses
@@ -744,14 +714,15 @@ Code | Description | Data Type
500 | An internal server error occurred | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID
# Returns a form instance.
try {
Get-BetaFormInstanceByKey-BetaFormInstanceID $FormInstanceID
@@ -762,13 +733,10 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-form-instance-file
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -776,7 +744,6 @@ Path | FormInstanceID | **String** | True | FormInstanceID Form instance ID
Path | FileID | **String** | True | FileID String specifying the hashed name of the uploaded file we are retrieving.
### Return type
**System.IO.FileInfo**
### Responses
@@ -792,7 +759,6 @@ Code | Description | Data Type
503 | An external service is not available | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, image/jpeg, image/png, application/octet-stream
@@ -800,7 +766,9 @@ Code | Description | Data Type
```powershell
$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | FormInstanceID Form instance ID
$FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving.
# Download instance file by fileId.
try {
Get-BetaFormInstanceFile-BetaFormInstanceID $FormInstanceID -BetaFileID $FileID
@@ -811,20 +779,16 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## import-form-definitions
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Body | Body | [**[]ImportFormDefinitionsRequestInner**](../models/import-form-definitions-request-inner) | (optional) | Body is the request payload to import form definitions
### Return type
[**ImportFormDefinitions202Response**](../models/import-form-definitions202-response)
### Responses
@@ -838,16 +802,22 @@ Code | Description | Data Type
500 | An internal server error occurred | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```powershell
# ImportFormDefinitionsRequestInner[] | Body is the request payload to import form definitions (optional)
$Body = @"[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]"@
$Body = @"[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]"@ # ImportFormDefinitionsRequestInner[] | Body is the request payload to import form definitions (optional)
# Import form definitions from export.
try {
Import-BetaFormDefinitions
@@ -858,11 +828,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-form-definition
Parameter `{formDefinitionID}` should match a form definition ID.
### Parameters
@@ -872,7 +839,6 @@ Path | FormDefinitionID | **String** | True | Form definition ID
Body | Body | [**[]System.Collections.Hashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | (optional) | Body is the request payload to patch a form definition, check: https://jsonpatch.com
### Return type
[**FormDefinitionResponse**](../models/form-definition-response)
### Responses
@@ -887,7 +853,6 @@ Code | Description | Data Type
500 | An internal server error occurred | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -895,9 +860,11 @@ Code | Description | Data Type
```powershell
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID
$Body = @{ key_example = } # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional)
$Body = @"[{op=replace, path=/description, value=test-description}]"@
$Body = @"[{op=replace, path=/description, value=test-description}]"@ # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional)
# Patch a form definition.
try {
Update-BetaFormDefinition-BetaFormDefinitionID $FormDefinitionID
@@ -908,11 +875,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-form-instance
Parameter `{formInstanceID}` should match a form instance ID.
### Parameters
@@ -922,7 +886,6 @@ Path | FormInstanceID | **String** | True | Form instance ID
Body | Body | [**[]System.Collections.Hashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | (optional) | Body is the request payload to patch a form instance, check: https://jsonpatch.com
### Return type
[**FormInstanceResponse**](../models/form-instance-response)
### Responses
@@ -938,7 +901,6 @@ Code | Description | Data Type
500 | An internal server error occurred | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -946,9 +908,11 @@ Code | Description | Data Type
```powershell
$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID
$Body = @{ key_example = } # Map[] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional)
$Body = @"[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]"@
$Body = @"[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]"@ # Map[] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional)
# Patch a form instance.
try {
Update-BetaFormInstance-BetaFormInstanceID $FormInstanceID
@@ -959,11 +923,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## search-form-definitions-by-tenant
No parameters required.
### Parameters
@@ -975,7 +936,6 @@ Param Type | Name | Data Type | Required | Description
Query | Sorters | **String** | (optional) (default to "name") | 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, created, modified**
### Return type
[**ListFormDefinitionsByTenantResponse**](../models/list-form-definitions-by-tenant-response)
### Responses
@@ -989,7 +949,6 @@ Code | Description | Data Type
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -999,7 +958,9 @@ $Offset = 250 # Int64 | Offset Integer specifying the offset of the first resul
$Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250)
$Filters = 'name sw "my form"' # 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, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, 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, created, modified** (optional) (default to "name")
# Export form definitions by tenant.
try {
Search-BetaFormDefinitionsByTenant
@@ -1010,11 +971,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## search-form-element-data-by-element-id
Parameter `{formInstanceID}` should match a form instance ID.
Parameter `{formElementID}` should match a form element ID at the data source configuration.
@@ -1028,7 +986,6 @@ Path | FormElementID | **String** | True | Form element ID
Query | Query | **String** | (optional) | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields.
### Return type
[**ListFormElementDataByElementIDResponse**](../models/list-form-element-data-by-element-id-response)
### Responses
@@ -1043,7 +1000,6 @@ Code | Description | Data Type
500 | An internal server error occurred | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -1054,7 +1010,9 @@ $FormElementID = "1" # String | Form element ID
$Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250)
$Filters = 'value eq "ID01"" # 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"')` (optional)
$Query = "support" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional)
# Retrieves dynamic data by element.
try {
Search-BetaFormElementDataByElementID-BetaFormInstanceID $FormInstanceID -BetaFormElementID $FormElementID
@@ -1065,11 +1023,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## search-form-instances-by-tenant
No parameters required.
### Parameters
@@ -1077,7 +1032,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**FormInstanceResponse[]**](../models/form-instance-response)
### Responses
@@ -1091,13 +1045,14 @@ Code | Description | Data Type
500 | An internal server error occurred | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
# List form instances by tenant.
try {
Search-BetaFormInstancesByTenant
@@ -1108,11 +1063,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## search-pre-defined-select-options
No parameters required.
### Parameters
@@ -1120,7 +1072,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**ListPredefinedSelectOptionsResponse**](../models/list-predefined-select-options-response)
### Responses
@@ -1134,13 +1085,14 @@ Code | Description | Data Type
500 | An internal server error occurred | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
# List predefined select options.
try {
Search-BetaPreDefinedSelectOptions
@@ -1151,13 +1103,10 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## show-preview-data-source
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1168,7 +1117,6 @@ Path | FormDefinitionID | **String** | True | Form definition ID
Body | FormElementPreviewRequest | [**FormElementPreviewRequest**](../models/form-element-preview-request) | (optional) | Body is the request payload to create a form definition dynamic schema
### Return type
[**PreviewDataSourceResponse**](../models/preview-data-source-response)
### Responses
@@ -1183,7 +1131,6 @@ Code | Description | Data Type
500 | An internal server error occurred | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -1204,7 +1151,9 @@ $FormElementPreviewRequest = @"{
"dataSourceType" : "STATIC"
}
}"@
# Preview form definition data source.
try {
Show-BetaPreviewDataSource-BetaFormDefinitionID $FormDefinitionID
@@ -1215,7 +1164,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-custom-password-instructions
title: CustomPasswordInstructions
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/custom-password-instructions
tags: ['SDK', 'Software Development Kit', 'CustomPasswordInstructions', 'BetaCustomPasswordInstructions']
---
# CustomPasswordInstructions
Use this API to implement custom password instruction functionality.
With this functionality in place, administrators can create custom password instructions to help users reset their passwords, change them, unlock their accounts, or recover their usernames.
@@ -33,9 +33,7 @@ Method | HTTP request | Description
[**Remove-BetaCustomPasswordInstructions**](#delete-custom-password-instructions) | **DELETE** `/custom-password-instructions/{pageId}` | Delete Custom Password Instructions by page ID
[**Get-BetaCustomPasswordInstructions**](#get-custom-password-instructions) | **GET** `/custom-password-instructions/{pageId}` | Get Custom Password Instructions by Page ID
## create-custom-password-instructions
This API creates the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API.
### Parameters
@@ -44,7 +42,6 @@ Param Type | Name | Data Type | Required | Description
Body | CustomPasswordInstruction | [**CustomPasswordInstruction**](../models/custom-password-instruction) | True |
### Return type
[**CustomPasswordInstruction**](../models/custom-password-instruction)
### 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
@@ -67,7 +63,9 @@ $CustomPasswordInstruction = @"{
"pageId" : "change-password:enter-password",
"locale" : "en"
}"@
# Create Custom Password Instructions
try {
$Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction
New-BetaCustomPasswordInstructions-BetaCustomPasswordInstruction $Result
@@ -79,11 +77,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-custom-password-instructions
This API delete the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API.
### Parameters
@@ -93,7 +88,6 @@ Path | PageId | **String** | True | The page ID of custom password instructio
Query | Locale | **String** | (optional) | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"".
### Return type
(empty response body)
### Responses
@@ -106,7 +100,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 +107,9 @@ Code | Description | Data Type
```powershell
$PageId = "change-password:enter-password" # String | The page ID of custom password instructions to delete.
$Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional)
# Delete Custom Password Instructions by page ID
try {
Remove-BetaCustomPasswordInstructions-BetaPageId $PageId
@@ -125,11 +120,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-custom-password-instructions
This API returns the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API.
### Parameters
@@ -139,7 +131,6 @@ Path | PageId | **String** | True | The page ID of custom password instructio
Query | Locale | **String** | (optional) | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"".
### Return type
[**CustomPasswordInstruction**](../models/custom-password-instruction)
### Responses
@@ -152,7 +143,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
@@ -160,7 +150,9 @@ Code | Description | Data Type
```powershell
$PageId = "change-password:enter-password" # String | The page ID of custom password instructions to query.
$Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional)
# Get Custom Password Instructions by Page ID
try {
Get-BetaCustomPasswordInstructions-BetaPageId $PageId
@@ -171,7 +163,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-entitlements
title: Entitlements
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/entitlements
tags: ['SDK', 'Software Development Kit', 'Entitlements', 'BetaEntitlements']
---
# Entitlements
Use this API to implement and customize entitlement functionality.
With this functionality in place, administrators can view entitlements and configure them for use throughout Identity Security Cloud in certifications, access profiles, and roles.
@@ -80,9 +80,7 @@ Method | HTTP request | Description
[**Reset-BetaSourceEntitlements**](#reset-source-entitlements) | **POST** `/entitlements/reset/sources/{id}` | Reset Source Entitlements
[**Update-BetaEntitlementsInBulk**](#update-entitlements-in-bulk) | **POST** `/entitlements/bulk-update` | Bulk update an entitlement list
## create-access-model-metadata-for-entitlement
Add single Access Model Metadata to an entitlement.
### Parameters
@@ -93,7 +91,6 @@ Path | AttributeKey | **String** | True | Technical name of the Attribute.
Path | AttributeValue | **String** | True | Technical name of the Attribute Value.
### Return type
[**Entitlement**](../models/entitlement)
### Responses
@@ -107,7 +104,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
@@ -116,7 +112,9 @@ Code | Description | Data Type
$Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id.
$AttributeKey = "iscPrivacy" # String | Technical name of the Attribute.
$AttributeValue = "public" # String | Technical name of the Attribute Value.
# Add metadata to an entitlement.
try {
New-BetaAccessModelMetadataForEntitlement-BetaId $Id -BetaAttributeKey $AttributeKey -BetaAttributeValue $AttributeValue
@@ -127,11 +125,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-access-model-metadata-from-entitlement
Remove single Access Model Metadata from an entitlement.
### Parameters
@@ -142,7 +137,6 @@ Path | AttributeKey | **String** | True | Technical name of the Attribute.
Path | AttributeValue | **String** | True | Technical name of the Attribute Value.
### Return type
(empty response body)
### Responses
@@ -156,7 +150,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
@@ -165,7 +158,9 @@ Code | Description | Data Type
$Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id.
$AttributeKey = "iscPrivacy" # String | Technical name of the Attribute.
$AttributeValue = "public" # String | Technical name of the Attribute Value.
# Remove metadata from an entitlement.
try {
Remove-BetaAccessModelMetadataFromEntitlement-BetaId $Id -BetaAttributeKey $AttributeKey -BetaAttributeValue $AttributeValue
@@ -176,11 +171,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-entitlement
This API returns an entitlement by its ID.
### Parameters
@@ -189,7 +181,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The entitlement ID
### Return type
[**Entitlement**](../models/entitlement)
### Responses
@@ -204,14 +195,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 = "2c91808874ff91550175097daaec161c" # String | The entitlement ID
# Get an entitlement
try {
Get-BetaEntitlement-BetaId $Id
@@ -222,11 +214,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-entitlement-request-config
This API returns the entitlement request config for a specified entitlement.
### Parameters
@@ -235,7 +224,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Entitlement Id
### Return type
[**EntitlementRequestConfig**](../models/entitlement-request-config)
### Responses
@@ -250,14 +238,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 = "2c91808874ff91550175097daaec161c" # String | Entitlement Id
# Get Entitlement Request Config
try {
Get-BetaEntitlementRequestConfig-BetaId $Id
@@ -268,11 +257,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## import-entitlements-by-source
Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements).
If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error.
@@ -286,7 +272,6 @@ Path | Id | **String** | True | Source Id
| CsvFile | **System.IO.FileInfo** | (optional) | The CSV file containing the source entitlements to aggregate.
### Return type
[**LoadEntitlementTask**](../models/load-entitlement-task)
### Responses
@@ -300,7 +285,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
@@ -308,7 +292,9 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id
$CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional)
# Aggregate Entitlements
try {
Import-BetaEntitlementsBySource-BetaId $Id
@@ -319,11 +305,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-entitlement-children
This API returns a list of all child entitlements of a given entitlement.
### Parameters
@@ -337,7 +320,6 @@ Path | Id | **String** | True | Entitlement 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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le*
### Return type
[**Entitlement[]**](../models/entitlement)
### Responses
@@ -352,7 +334,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
@@ -364,7 +345,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,-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: **id, name, created, modified, type, attribute, value, source.id** (optional)
$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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional)
# List of entitlements children
try {
Get-BetaEntitlementChildren-BetaId $Id
@@ -375,11 +358,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-entitlement-parents
This API returns a list of all parent entitlements of a given entitlement.
### Parameters
@@ -393,7 +373,6 @@ Path | Id | **String** | True | Entitlement 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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le*
### Return type
[**Entitlement[]**](../models/entitlement)
### Responses
@@ -408,7 +387,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
@@ -420,7 +398,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,-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: **id, name, created, modified, type, attribute, value, source.id** (optional)
$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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional)
# List of entitlements parents
try {
Get-BetaEntitlementParents-BetaId $Id
@@ -431,11 +411,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-entitlements
This API returns a list of entitlements.
This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive).
@@ -456,7 +433,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* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in*
### Return type
[**Entitlement[]**](../models/entitlement)
### Responses
@@ -470,7 +446,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
@@ -485,7 +460,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)
$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: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional)
$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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional)
# Gets a list of entitlements.
try {
Get-BetaEntitlements
@@ -496,11 +473,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-entitlement
This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields**
@@ -516,7 +490,6 @@ Path | Id | **String** | True | ID of the entitlement to patch
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) |
### Return type
[**Entitlement**](../models/entitlement)
### Responses
@@ -531,21 +504,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 entitlement to patch
# JsonPatchOperation[] | (optional)
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] | (optional)
# Patch an entitlement
try {
Update-BetaEntitlement-BetaId $Id
@@ -556,11 +529,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-entitlement-request-config
This API replaces the entitlement request config for a specified entitlement.
### Parameters
@@ -570,7 +540,6 @@ Path | Id | **String** | True | Entitlement ID
Body | EntitlementRequestConfig | [**EntitlementRequestConfig**](../models/entitlement-request-config) | True |
### Return type
[**EntitlementRequestConfig**](../models/entitlement-request-config)
### Responses
@@ -585,7 +554,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
@@ -605,7 +573,9 @@ $EntitlementRequestConfig = @"{
"requestCommentRequired" : true
}
}"@
# Replace Entitlement Request Config
try {
$Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig
Send-BetaEntitlementRequestConfig-BetaId $Id -BetaEntitlementRequestConfig $Result
@@ -617,11 +587,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## reset-source-entitlements
Remove all entitlements from a specific source.
To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Import Accounts](https://developer.sailpoint.com/docs/api/beta/import-accounts/) with `disableOptimization` = `true`.
@@ -631,7 +598,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of source for the entitlement reset
### Return type
[**EntitlementSourceResetBaseReferenceDto**](../models/entitlement-source-reset-base-reference-dto)
### Responses
@@ -645,14 +611,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 source for the entitlement reset
# Reset Source Entitlements
try {
Reset-BetaSourceEntitlements-BetaId $Id
@@ -663,11 +630,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-entitlements-in-bulk
This API applies an update to every entitlement of the list.
@@ -689,7 +653,6 @@ Param Type | Name | Data Type | Required | Description
Body | EntitlementBulkUpdateRequest | [**EntitlementBulkUpdateRequest**](../models/entitlement-bulk-update-request) | True |
### Return type
(empty response body)
### Responses
@@ -703,7 +666,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
@@ -721,7 +683,9 @@ $EntitlementBulkUpdateRequest = @"{
"value" : false
} ]
}"@
# Bulk update an entitlement list
try {
$Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest
Update-BetaEntitlementsInBulk-BetaEntitlementBulkUpdateRequest $Result
@@ -733,7 +697,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-governance-groups
title: GovernanceGroups
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/governance-groups
tags: ['SDK', 'Software Development Kit', 'GovernanceGroups', 'BetaGovernanceGroups']
---
# GovernanceGroups
Use this API to implement and customize Governance Group functionality. With this functionality in place, administrators can create Governance Groups and configure them for use throughout Identity Security Cloud.
@@ -34,9 +34,7 @@ Method | HTTP request | Description
[**Update-BetaWorkgroup**](#patch-workgroup) | **PATCH** `/workgroups/{id}` | Patch a Governance Group
[**Update-BetaWorkgroupMembers**](#update-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-add` | Add members to Governance Group
## create-workgroup
This API creates a new Governance Group.
### Parameters
@@ -45,7 +43,6 @@ Param Type | Name | Data Type | Required | Description
Body | WorkgroupDto | [**WorkgroupDto**](../models/workgroup-dto) | True |
### Return type
[**WorkgroupDto**](../models/workgroup-dto)
### 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
@@ -81,7 +77,9 @@ $WorkgroupDto = @"{
"modified" : "2022-01-06T19:51:13Z",
"id" : "2c91808568c529c60168cca6f90c1313"
}"@
# Create a new Governance Group.
try {
$Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto
New-BetaWorkgroup-BetaWorkgroupDto $Result
@@ -93,11 +91,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-workgroup
This API deletes a Governance Group by its ID.
### Parameters
@@ -106,7 +101,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the Governance Group
### Return type
(empty response body)
### 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 = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group
# Delete a Governance Group
try {
Remove-BetaWorkgroup-BetaId $Id
@@ -138,11 +133,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-workgroup-members
This API removes one or more members from a Governance Group. A token with API, ORG_ADMIN authority is required to call this API.
> **Following field of Identity is an optional field in the request.**
@@ -156,7 +148,6 @@ Path | WorkgroupId | **String** | True | ID of the Governance Group.
Body | BulkWorkgroupMembersRequestInner | [**[]BulkWorkgroupMembersRequestInner**](../models/bulk-workgroup-members-request-inner) | True | List of identities to be removed from a Governance Group members list.
### Return type
[**WorkgroupMemberDeleteItem[]**](../models/workgroup-member-delete-item)
### Responses
@@ -170,17 +161,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
$WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group.
# BulkWorkgroupMembersRequestInner[] | List of identities to be removed from a Governance Group members list.
$BulkWorkgroupMembersRequestInner = @""@
$BulkWorkgroupMembersRequestInner = @""@ # BulkWorkgroupMembersRequestInner[] | List of identities to be removed from a Governance Group members list.
# Remove members from Governance Group
try {
$Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner
Remove-BetaWorkgroupMembers-BetaWorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $Result
@@ -192,12 +183,9 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-workgroups-in-bulk
This API initiates a bulk deletion of one or more Governance Groups.
> If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted.
@@ -216,7 +204,6 @@ Param Type | Name | Data Type | Required | Description
Body | WorkgroupBulkDeleteRequest | [**WorkgroupBulkDeleteRequest**](../models/workgroup-bulk-delete-request) | True |
### Return type
[**WorkgroupDeleteItem[]**](../models/workgroup-delete-item)
### Responses
@@ -230,7 +217,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
@@ -239,7 +225,9 @@ Code | Description | Data Type
$WorkgroupBulkDeleteRequest = @"{
"ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ]
}"@
# Delete Governance Group(s)
try {
$Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest
Remove-BetaWorkgroupsInBulk-BetaWorkgroupBulkDeleteRequest $Result
@@ -251,11 +239,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-workgroup
This API returns a Governance Groups by its ID.
### Parameters
@@ -264,7 +249,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the Governance Group
### Return type
[**WorkgroupDto**](../models/workgroup-dto)
### Responses
@@ -278,14 +262,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 Governance Group
# Get Governance Group by Id
try {
Get-BetaWorkgroup-BetaId $Id
@@ -296,11 +281,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-connections
This API returns list of connections associated with a Governance Group.
### Parameters
@@ -313,7 +295,6 @@ Path | WorkgroupId | **String** | True | ID of the Governance Group.
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, modified**
### Return type
[**WorkgroupConnectionDto[]**](../models/workgroup-connection-dto)
### Responses
@@ -327,7 +308,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
@@ -338,7 +318,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50)
$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,-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)
# List connections for Governance Group
try {
Get-BetaConnections-BetaWorkgroupId $WorkgroupId
@@ -349,11 +331,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-workgroup-members
This API returns list of members associated with a Governance Group.
### Parameters
@@ -366,7 +345,6 @@ Path | WorkgroupId | **String** | True | ID of the Governance Group.
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, modified**
### Return type
[**ListWorkgroupMembers200ResponseInner[]**](../models/list-workgroup-members200-response-inner)
### Responses
@@ -380,7 +358,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
@@ -391,7 +368,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50)
$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,-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)
# List Governance Group Members
try {
Get-BetaWorkgroupMembers-BetaWorkgroupId $WorkgroupId
@@ -402,11 +381,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-workgroups
This API returns list of Governance Groups
### Parameters
@@ -419,7 +395,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, modified, id, description**
### Return type
[**WorkgroupDto[]**](../models/workgroup-dto)
### Responses
@@ -433,7 +408,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 +418,9 @@ $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50.
$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 "Test"' # 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* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (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, created, modified, id, description** (optional)
# List Governance Groups
try {
Get-BetaWorkgroups
@@ -455,11 +431,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-workgroup
This API updates an existing governance group by ID.
The following fields and objects are patchable:
* name
@@ -475,7 +448,6 @@ Path | Id | **String** | True | ID of the Governance Group
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) |
### Return type
[**WorkgroupDto**](../models/workgroup-dto)
### Responses
@@ -489,21 +461,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 = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group
# JsonPatchOperation[] | (optional)
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] | (optional)
# Patch a Governance Group
try {
Update-BetaWorkgroup-BetaId $Id
@@ -514,11 +486,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-workgroup-members
This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API.
> **Following field of Identity is an optional field in the request.**
@@ -532,7 +501,6 @@ Path | WorkgroupId | **String** | True | ID of the Governance Group.
Body | BulkWorkgroupMembersRequestInner | [**[]BulkWorkgroupMembersRequestInner**](../models/bulk-workgroup-members-request-inner) | True | List of identities to be added to a Governance Group members list.
### Return type
[**WorkgroupMemberAddItem[]**](../models/workgroup-member-add-item)
### Responses
@@ -546,17 +514,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
$WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group.
# BulkWorkgroupMembersRequestInner[] | List of identities to be added to a Governance Group members list.
$BulkWorkgroupMembersRequestInner = @""@
$BulkWorkgroupMembersRequestInner = @""@ # BulkWorkgroupMembersRequestInner[] | List of identities to be added to a Governance Group members list.
# Add members to Governance Group
try {
$Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner
Update-BetaWorkgroupMembers-BetaWorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $Result
@@ -568,7 +536,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-iai-access-request-recommendations
title: IAIAccessRequestRecommendations
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/iai-access-request-recommendations
tags: ['SDK', 'Software Development Kit', 'IAIAccessRequestRecommendations', 'BetaIAIAccessRequestRecommendations']
---
# IAIAccessRequestRecommendations
@@ -27,9 +27,7 @@ Method | HTTP request | Description
[**Get-BetaAccessRequestRecommendationsRequestedItems**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List of Requested Access Request Recommendations
[**Get-BetaAccessRequestRecommendationsViewedItems**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List of Viewed Access Request Recommendations
## add-access-request-recommendations-ignored-item
This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations.
### Parameters
@@ -38,7 +36,6 @@ Param Type | Name | Data Type | Required | Description
Body | AccessRequestRecommendationActionItemDto | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | True | The recommended access item to ignore for an identity.
### Return type
[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto)
### 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
@@ -65,7 +61,9 @@ $AccessRequestRecommendationActionItemDto = @"{
},
"identityId" : "2c91808570313110017040b06f344ec9"
}"@
# Notification of Ignored Access Request Recommendations
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
Add-BetaAccessRequestRecommendationsIgnoredItem-BetaAccessRequestRecommendationActionItemDto $Result
@@ -77,11 +75,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## add-access-request-recommendations-requested-item
This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations.
### Parameters
@@ -90,7 +85,6 @@ Param Type | Name | Data Type | Required | Description
Body | AccessRequestRecommendationActionItemDto | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | True | The recommended access item that was requested for an identity.
### Return type
[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto)
### Responses
@@ -104,7 +98,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
@@ -117,7 +110,9 @@ $AccessRequestRecommendationActionItemDto = @"{
},
"identityId" : "2c91808570313110017040b06f344ec9"
}"@
# Notification of Requested Access Request Recommendations
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
Add-BetaAccessRequestRecommendationsRequestedItem-BetaAccessRequestRecommendationActionItemDto $Result
@@ -129,11 +124,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## add-access-request-recommendations-viewed-item
This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations.
### Parameters
@@ -142,7 +134,6 @@ Param Type | Name | Data Type | Required | Description
Body | AccessRequestRecommendationActionItemDto | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | True | The recommended access that was viewed for an identity.
### Return type
[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto)
### 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**: application/json
- **Accept**: application/json
@@ -169,7 +159,9 @@ $AccessRequestRecommendationActionItemDto = @"{
},
"identityId" : "2c91808570313110017040b06f344ec9"
}"@
# Notification of Viewed Access Request Recommendations
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
Add-BetaAccessRequestRecommendationsViewedItem-BetaAccessRequestRecommendationActionItemDto $Result
@@ -181,11 +173,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## add-access-request-recommendations-viewed-items
This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations.
### Parameters
@@ -194,7 +183,6 @@ Param Type | Name | Data Type | Required | Description
Body | AccessRequestRecommendationActionItemDto | [**[]AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | True | The recommended access items that were viewed for an identity.
### Return type
[**AccessRequestRecommendationActionItemResponseDto[]**](../models/access-request-recommendation-action-item-response-dto)
### Responses
@@ -208,22 +196,22 @@ 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
# AccessRequestRecommendationActionItemDto[] | The recommended access items that were viewed for an identity.
$AccessRequestRecommendationActionItemDto = @"{
"access" : {
"id" : "2c9180835d2e5168015d32f890ca1581",
"type" : "ACCESS_PROFILE"
},
"identityId" : "2c91808570313110017040b06f344ec9"
}"@
}"@ # AccessRequestRecommendationActionItemDto[] | The recommended access items that were viewed for an identity.
# Notification of Viewed Access Request Recommendations in Bulk
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
Add-BetaAccessRequestRecommendationsViewedItems-BetaAccessRequestRecommendationActionItemDto $Result
@@ -235,11 +223,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-access-request-recommendations
This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user.
### Parameters
@@ -254,7 +239,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: **access.name, access.type** By default the recommendations are sorted by highest confidence first.
### Return type
[**AccessRequestRecommendationItemDetail[]**](../models/access-request-recommendation-item-detail)
### Responses
@@ -268,7 +252,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
@@ -281,7 +264,9 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$IncludeTranslationMessages = $false # Boolean | If *true* it will populate a list of translation messages in the response. (optional) (default to $false)
$Filters = 'access.name co "admin"' # 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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional)
$Sorters = "MySorters" # 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, access.type** By default the recommendations are sorted by highest confidence first. (optional)
# Identity Access Request Recommendations
try {
Get-BetaAccessRequestRecommendations
@@ -292,11 +277,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-access-request-recommendations-ignored-items
This API returns the list of ignored access request recommendations.
### Parameters
@@ -309,7 +291,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: **access.id, access.type, identityId, timestamp**
### Return type
[**AccessRequestRecommendationActionItemResponseDto[]**](../models/access-request-recommendation-action-item-response-dto)
### Responses
@@ -323,7 +304,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
@@ -334,7 +314,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 = 'identityId eq "2c9180846b0a0583016b299f210c1314"' # 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional)
$Sorters = "access.id" # 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.id, access.type, identityId, timestamp** (optional)
# List of Ignored Access Request Recommendations
try {
Get-BetaAccessRequestRecommendationsIgnoredItems
@@ -345,11 +327,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-access-request-recommendations-requested-items
This API returns a list of requested access request recommendations.
### Parameters
@@ -362,7 +341,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: **access.id, access.type, identityId, timestamp**
### Return type
[**AccessRequestRecommendationActionItemResponseDto[]**](../models/access-request-recommendation-action-item-response-dto)
### Responses
@@ -376,7 +354,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
@@ -387,7 +364,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 "2c9180846b0a0583016b299f210c1314"' # 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional)
$Sorters = "MySorters" # 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.id, access.type, identityId, timestamp** (optional)
# List of Requested Access Request Recommendations
try {
Get-BetaAccessRequestRecommendationsRequestedItems
@@ -398,11 +377,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-access-request-recommendations-viewed-items
This API returns the list of viewed access request recommendations.
### Parameters
@@ -415,7 +391,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: **access.id, access.type, identityId, timestamp**
### Return type
[**AccessRequestRecommendationActionItemResponseDto[]**](../models/access-request-recommendation-action-item-response-dto)
### Responses
@@ -429,7 +404,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
@@ -440,7 +414,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 "2c9180846b0a0583016b299f210c1314"' # 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional)
$Sorters = "MySorters" # 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.id, access.type, identityId, timestamp** (optional)
# List of Viewed Access Request Recommendations
try {
Get-BetaAccessRequestRecommendationsViewedItems
@@ -451,7 +427,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-iai-common-access
title: IAICommonAccess
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/iai-common-access
tags: ['SDK', 'Software Development Kit', 'IAICommonAccess', 'BetaIAICommonAccess']
---
# IAICommonAccess
@@ -22,9 +22,7 @@ Method | HTTP request | Description
[**Get-BetaCommonAccess**](#get-common-access) | **GET** `/common-access` | Get a paginated list of common access
[**Update-BetaCommonAccessStatusInBulk**](#update-common-access-status-in-bulk) | **POST** `/common-access/update-status` | Bulk update common access status
## create-common-access
This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create
### Parameters
@@ -33,7 +31,6 @@ Param Type | Name | Data Type | Required | Description
Body | CommonAccessItemRequest | [**CommonAccessItemRequest**](../models/common-access-item-request) | True |
### Return type
[**CommonAccessItemResponse**](../models/common-access-item-response)
### Responses
@@ -47,7 +44,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
@@ -64,7 +60,9 @@ $CommonAccessItemRequest = @"{
},
"status" : "CONFIRMED"
}"@
# Create common access items
try {
$Result = ConvertFrom-JsonToCommonAccessItemRequest -Json $CommonAccessItemRequest
New-BetaCommonAccess-BetaCommonAccessItemRequest $Result
@@ -76,11 +74,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-common-access
This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read
### Parameters
@@ -93,7 +88,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: **access.name, status** By default the common access items are sorted by name, ascending.
### Return type
[**CommonAccessResponse[]**](../models/common-access-response)
### Responses
@@ -106,7 +100,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 @@ $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)
$Filters = 'access.type eq "ROLE"' # 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, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (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, status** By default the common access items are sorted by name, ascending. (optional)
# Get a paginated list of common access
try {
Get-BetaCommonAccess
@@ -128,11 +123,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-common-access-status-in-bulk
This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update
### Parameters
@@ -141,7 +133,6 @@ Param Type | Name | Data Type | Required | Description
Body | CommonAccessIDStatus | [**[]CommonAccessIDStatus**](../models/common-access-id-status) | True | Confirm or deny in bulk the common access ids that are (or aren't) common access
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -155,19 +146,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
# CommonAccessIDStatus[] | Confirm or deny in bulk the common access ids that are (or aren't) common access
$CommonAccessIDStatus = @"{
"confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
"deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ]
}"@
}"@ # CommonAccessIDStatus[] | Confirm or deny in bulk the common access ids that are (or aren't) common access
# Bulk update common access status
try {
$Result = ConvertFrom-JsonToCommonAccessIDStatus -Json $CommonAccessIDStatus
Update-BetaCommonAccessStatusInBulk-BetaCommonAccessIDStatus $Result
@@ -179,7 +170,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-iai-message-catalogs
title: IAIMessageCatalogs
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/iai-message-catalogs
tags: ['SDK', 'Software Development Kit', 'IAIMessageCatalogs', 'BetaIAIMessageCatalogs']
---
# IAIMessageCatalogs
@@ -20,9 +20,7 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaMessageCatalogs**](#get-message-catalogs) | **GET** `/translation-catalogs/{catalog-id}` | Get Message catalogs
## get-message-catalogs
The getMessageCatalogs API returns message catalog based on the language headers in the requested object.
### Parameters
@@ -31,7 +29,6 @@ Param Type | Name | Data Type | Required | Description
Path | CatalogId | **String** | True | The ID of the message catalog.
### Return type
[**MessageCatalogDto[]**](../models/message-catalog-dto)
### Responses
@@ -45,14 +42,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
$CatalogId = "recommender" # String | The ID of the message catalog.
# Get Message catalogs
try {
Get-BetaMessageCatalogs-BetaCatalogId $CatalogId
@@ -63,7 +61,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-iai-outliers
title: IAIOutliers
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/iai-outliers
tags: ['SDK', 'Software Development Kit', 'IAIOutliers', 'BetaIAIOutliers']
---
# IAIOutliers
@@ -28,9 +28,7 @@ Method | HTTP request | Description
[**Get-BetaOutliersContributingFeatureAccessItems**](#list-outliers-contributing-feature-access-items) | **GET** `/outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items` | Gets a list of access items associated with each identity outlier contributing feature
[**Invoke-BetaUnIgnoreIdentityOutliers**](#un-ignore-identity-outliers) | **POST** `/outliers/unignore` | IAI Identity Outliers Unignore
## export-outliers-zip
This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported.
Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes).
@@ -42,7 +40,6 @@ Param Type | Name | Data Type | Required | Description
Query | Type | **String** | (optional) | Type of the identity outliers snapshot to filter on
### Return type
**System.IO.FileInfo**
### Responses
@@ -56,14 +53,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
$Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional)
# IAI Identity Outliers Export
try {
Export-BetaOutliersZip
@@ -74,11 +72,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-outlier-snapshots
This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier.
### Parameters
@@ -91,7 +86,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: **snapshotDate**
### Return type
[**OutlierSummary[]**](../models/outlier-summary)
### Responses
@@ -106,7 +100,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 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional)
$Filters = 'snapshotDate ge "2022-02-07T20:13:29.356648026Z"' # 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: **snapshotDate**: *ge, le* (optional)
$Sorters = "snapshotDate" # 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: **snapshotDate** (optional)
# IAI Identity Outliers Summary
try {
Get-BetaIdentityOutlierSnapshots
@@ -128,11 +123,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-outliers
This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information.
### Parameters
@@ -146,7 +138,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: **firstDetectionDate, attributes, score**
### Return type
[**Outlier[]**](../models/outlier)
### Responses
@@ -160,7 +151,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
@@ -172,7 +162,9 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional)
$Filters = 'attributes.displayName sw "John" and certStatus eq "false"' # 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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional)
$Sorters = "attributes.displayName,firstDetectionDate,-score" # 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: **firstDetectionDate, attributes, score** (optional)
# IAI Get Identity Outliers
try {
Get-BetaIdentityOutliers
@@ -183,11 +175,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-latest-identity-outlier-snapshots
This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier.
### Parameters
@@ -196,7 +185,6 @@ Param Type | Name | Data Type | Required | Description
Query | Type | **String** | (optional) | Type of the identity outliers snapshot to filter on
### Return type
[**LatestOutlierSummary[]**](../models/latest-outlier-summary)
### Responses
@@ -211,14 +199,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
$Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional)
# IAI Identity Outliers Latest Summary
try {
Get-BetaLatestIdentityOutlierSnapshots
@@ -229,11 +218,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-outlier-contributing-feature-summary
This API returns a summary of a contributing feature for an identity outlier.
The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object.
@@ -245,7 +231,6 @@ Param Type | Name | Data Type | Required | Description
Path | OutlierFeatureId | **String** | True | Contributing feature id
### Return type
[**OutlierFeatureSummary**](../models/outlier-feature-summary)
### Responses
@@ -260,14 +245,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
$OutlierFeatureId = "04654b66-7561-4090-94f9-abee0722a1af" # String | Contributing feature id
# Get identity outlier contibuting feature summary
try {
Get-BetaOutlierContributingFeatureSummary-BetaOutlierFeatureId $OutlierFeatureId
@@ -278,11 +264,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-peer-group-outliers-contributing-features
This API returns a list of contributing feature objects for a single outlier.
The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object.
@@ -299,7 +282,6 @@ Path | OutlierId | **String** | True | The outlier 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: **importance**
### Return type
[**OutlierContributingFeature[]**](../models/outlier-contributing-feature)
### Responses
@@ -314,7 +296,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 +307,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)
$IncludeTranslationMessages = "include-translation-messages=" # String | Whether or not to include translation messages object in returned response (optional)
$Sorters = "importance" # 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: **importance** (optional)
# Get identity outlier's contibuting features
try {
Get-BetaPeerGroupOutliersContributingFeatures-BetaOutlierId $OutlierId
@@ -337,11 +320,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## ignore-identity-outliers
This API receives a list of identity IDs in the request, changes the outliers to be ignored.
### Parameters
@@ -350,7 +330,6 @@ Param Type | Name | Data Type | Required | Description
Body | RequestBody | **[]String** | True |
### Return type
(empty response body)
### Responses
@@ -364,16 +343,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[] |
$RequestBody = @""@
$RequestBody = @""@ # String[] |
# IAI Identity Outliers Ignore
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Invoke-BetaIgnoreIdentityOutliers-BetaRequestBody $Result
@@ -385,11 +365,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-outliers-contributing-feature-access-items
This API returns a list of the enriched access items associated with each feature filtered by the access item type.
The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare.
@@ -407,7 +384,6 @@ Path | ContributingFeatureName | **String** | True | The name of contributing
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: **displayName**
### Return type
[**OutliersContributingFeatureAccessItems[]**](../models/outliers-contributing-feature-access-items)
### Responses
@@ -422,7 +398,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
@@ -435,7 +410,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)
$AccessType = "ENTITLEMENT" # String | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional)
$Sorters = "displayName" # 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: **displayName** (optional)
# Gets a list of access items associated with each identity outlier contributing feature
try {
Get-BetaOutliersContributingFeatureAccessItems-BetaOutlierId $OutlierId -BetaContributingFeatureName $ContributingFeatureName
@@ -446,11 +423,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## un-ignore-identity-outliers
This API receives a list of identity IDs in the request, changes the outliers to be un-ignored.
### Parameters
@@ -459,7 +433,6 @@ Param Type | Name | Data Type | Required | Description
Body | RequestBody | **[]String** | True |
### Return type
(empty response body)
### Responses
@@ -473,16 +446,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[] |
$RequestBody = @""@
$RequestBody = @""@ # String[] |
# IAI Identity Outliers Unignore
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Invoke-BetaUnIgnoreIdentityOutliers-BetaRequestBody $Result
@@ -494,7 +468,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-iai-peer-group-strategies
title: IAIPeerGroupStrategies
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/iai-peer-group-strategies
tags: ['SDK', 'Software Development Kit', 'IAIPeerGroupStrategies', 'BetaIAIPeerGroupStrategies']
---
# IAIPeerGroupStrategies
@@ -20,9 +20,7 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaPeerGroupOutliers**](#get-peer-group-outliers) | **GET** `/peer-group-strategies/{strategy}/identity-outliers` | Identity Outliers List
## get-peer-group-outliers
-- Deprecated : See 'IAI Outliers' This API will be used by Identity Governance systems to identify identities that are not included in an organization's peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned.
### Parameters
@@ -34,7 +32,6 @@ Path | Strategy | **String** | True | The strategy used to create peer groups
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
[**PeerGroupMember[]**](../models/peer-group-member)
### Responses
@@ -48,7 +45,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
@@ -58,7 +54,9 @@ $Strategy = "entitlement" # String | The strategy used to create peer groups. Cu
$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)
# Identity Outliers List
try {
Get-BetaPeerGroupOutliers-BetaStrategy $Strategy
@@ -69,7 +67,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-iai-recommendations
title: IAIRecommendations
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/iai-recommendations
tags: ['SDK', 'Software Development Kit', 'IAIRecommendations', 'BetaIAIRecommendations']
---
# IAIRecommendations
@@ -22,9 +22,7 @@ Method | HTTP request | Description
[**Get-BetaRecommendationsConfig**](#get-recommendations-config) | **GET** `/recommendations/config` | Get certification recommendation config values
[**Update-BetaRecommendationsConfig**](#update-recommendations-config) | **PUT** `/recommendations/config` | Update certification recommendation config values
## get-recommendations
The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations.
### Parameters
@@ -33,7 +31,6 @@ Param Type | Name | Data Type | Required | Description
Body | RecommendationRequestDto | [**RecommendationRequestDto**](../models/recommendation-request-dto) | True |
### Return type
[**RecommendationResponseDto**](../models/recommendation-response-dto)
### Responses
@@ -47,7 +44,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
@@ -72,7 +68,9 @@ $RecommendationRequestDto = @"{
"includeTranslationMessages" : false,
"includeDebugInformation" : true
}"@
# Returns a Recommendation Based on Object
try {
$Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto
Get-BetaRecommendations-BetaRecommendationRequestDto $Result
@@ -84,11 +82,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-recommendations-config
Retrieves configuration attributes used by certification recommendations.
### Parameters
@@ -96,7 +91,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**RecommendationConfigDto**](../models/recommendation-config-dto)
### Responses
@@ -109,13 +103,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 certification recommendation config values
try {
Get-BetaRecommendationsConfig
@@ -126,11 +121,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-recommendations-config
Updates configuration attributes used by certification recommendations.
### Parameters
@@ -139,7 +131,6 @@ Param Type | Name | Data Type | Required | Description
Body | RecommendationConfigDto | [**RecommendationConfigDto**](../models/recommendation-config-dto) | True |
### Return type
[**RecommendationConfigDto**](../models/recommendation-config-dto)
### Responses
@@ -152,7 +143,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
@@ -164,7 +154,9 @@ $RecommendationConfigDto = @"{
"runAutoSelectOnce" : false,
"onlyTuneThreshold" : false
}"@
# Update certification recommendation config values
try {
$Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto
Update-BetaRecommendationsConfig-BetaRecommendationConfigDto $Result
@@ -176,7 +168,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-iai-role-mining
title: IAIRoleMining
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/iai-role-mining
tags: ['SDK', 'Software Development Kit', 'IAIRoleMining', 'BetaIAIRoleMining']
---
# IAIRoleMining
@@ -44,9 +44,7 @@ Method | HTTP request | Description
[**Update-BetaRoleMiningSession**](#patch-role-mining-session) | **PATCH** `/role-mining-sessions/{sessionId}` | Patch a role mining session
[**Update-BetaEntitlementsPotentialRole**](#update-entitlements-potential-role) | **POST** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements` | Edit entitlements for a potential role to exclude some entitlements
## create-potential-role-provision-request
This method starts a job to provision a potential role
### Parameters
@@ -59,7 +57,6 @@ Path | PotentialRoleId | **String** | True | A potential role id in a role mi
Body | RoleMiningPotentialRoleProvisionRequest | [**RoleMiningPotentialRoleProvisionRequest**](../models/role-mining-potential-role-provision-request) | (optional) | Required information to create a new role
### Return type
[**RoleMiningPotentialRoleSummary**](../models/role-mining-potential-role-summary)
### 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**: application/json
- **Accept**: application/json
@@ -90,7 +86,9 @@ $RoleMiningPotentialRoleProvisionRequest = @"{
"roleDescription" : "General access for accounting department",
"directlyAssignedEntitlements" : false
}"@
# Create request to provision a potential role into an actual role.
try {
New-BetaPotentialRoleProvisionRequest-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
@@ -101,11 +99,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-role-mining-sessions
This submits a create role mining session request to the role mining application.
### Parameters
@@ -114,7 +109,6 @@ Param Type | Name | Data Type | Required | Description
Body | RoleMiningSessionDto | [**RoleMiningSessionDto**](../models/role-mining-session-dto) | True | Role mining session parameters
### Return type
[**RoleMiningSessionResponse**](../models/role-mining-session-response)
### Responses
@@ -128,7 +122,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
@@ -166,7 +159,9 @@ $RoleMiningSessionDto = @"{
"identityCount" : 0,
"type" : "SPECIALIZED"
}"@
# Create a role mining session
try {
$Result = ConvertFrom-JsonToRoleMiningSessionDto -Json $RoleMiningSessionDto
New-BetaRoleMiningSessions-BetaRoleMiningSessionDto $Result
@@ -178,11 +173,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## download-role-mining-potential-role-zip
This endpoint downloads a completed export of information for a potential role in a role mining session.
### Parameters
@@ -193,7 +185,6 @@ Path | PotentialRoleId | **String** | True | A potential role id in a role mi
Path | ExportId | **String** | True | The id of a previously run export job for this potential role
### Return type
**System.IO.FileInfo**
### Responses
@@ -206,7 +197,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
@@ -215,7 +205,9 @@ Code | Description | Data Type
$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id
$PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session
$ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role
# Export (download) details for a potential role in a role mining session
try {
Invoke-BetaDownloadRoleMiningPotentialRoleZip-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaExportId $ExportId
@@ -226,11 +218,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## export-role-mining-potential-role
This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role.
### Parameters
@@ -240,7 +229,6 @@ Path | SessionId | **String** | True | The role mining session id
Path | PotentialRoleId | **String** | True | A potential role id in a role mining session
### Return type
**System.IO.FileInfo**
### Responses
@@ -253,7 +241,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
@@ -261,7 +248,9 @@ Code | Description | Data Type
```powershell
$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id
$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session
# Export (download) details for a potential role in a role mining session
try {
Export-BetaRoleMiningPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
@@ -272,11 +261,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## export-role-mining-potential-role-async
This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role.
### Parameters
@@ -287,7 +273,6 @@ Path | PotentialRoleId | **String** | True | A potential role id in a role mi
Body | RoleMiningPotentialRoleExportRequest | [**RoleMiningPotentialRoleExportRequest**](../models/role-mining-potential-role-export-request) | (optional) |
### Return type
[**RoleMiningPotentialRoleExportResponse**](../models/role-mining-potential-role-export-response)
### Responses
@@ -300,7 +285,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
@@ -312,7 +296,9 @@ $RoleMiningPotentialRoleExportRequest = @"{
"minEntitlementPopularity" : 0,
"includeCommonAccess" : true
}"@
# Asynchronously export details for a potential role in a role mining session and upload to S3
try {
Export-BetaRoleMiningPotentialRoleAsync-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
@@ -323,11 +309,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## export-role-mining-potential-role-status
This endpoint retrieves information about the current status of a potential role export.
### Parameters
@@ -338,7 +321,6 @@ Path | PotentialRoleId | **String** | True | A potential role id in a role mi
Path | ExportId | **String** | True | The id of a previously run export job for this potential role
### Return type
[**RoleMiningPotentialRoleExportResponse**](../models/role-mining-potential-role-export-response)
### 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
@@ -360,7 +341,9 @@ Code | Description | Data Type
$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id
$PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session
$ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role
# Retrieve status of a potential role export job
try {
Export-BetaRoleMiningPotentialRoleStatus-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaExportId $ExportId
@@ -371,11 +354,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-all-potential-role-summaries
Returns all potential role summaries that match the query parameters
### Parameters
@@ -388,7 +368,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
[**RoleMiningPotentialRoleSummary[]**](../models/role-mining-potential-role-summary)
### Responses
@@ -402,7 +381,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
@@ -413,7 +391,9 @@ $Filters = '(createdByName co "int") and (createdById sw "2c9180907") and (type
$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)
# Retrieves all potential role summaries
try {
Get-BetaAllPotentialRoleSummaries
@@ -424,11 +404,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-entitlement-distribution-potential-role
This method returns entitlement popularity distribution for a potential role in a role mining session.
### Parameters
@@ -439,7 +416,6 @@ Path | PotentialRoleId | **String** | True | A potential role id in a role mi
Query | IncludeCommonAccess | **Boolean** | (optional) | Boolean determining whether common access entitlements will be included or not
### Return type
**System.Collections.Hashtable**
### Responses
@@ -452,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
@@ -461,7 +436,9 @@ Code | Description | Data Type
$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id
$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session
$IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional)
# Retrieves entitlement popularity distribution for a potential role in a role mining session
try {
Get-BetaEntitlementDistributionPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
@@ -472,11 +449,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-entitlements-potential-role
This method returns entitlements for a potential role in a role mining session.
### Parameters
@@ -492,7 +466,6 @@ Path | PotentialRoleId | **String** | True | A potential role id in a role mi
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
[**RoleMiningEntitlement[]**](../models/role-mining-entitlement)
### Responses
@@ -506,7 +479,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
@@ -520,7 +492,9 @@ $Filters = 'applicationName sw "AD"' # String | Filter results using the standar
$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)
# Retrieves entitlements for a potential role in a role mining session
try {
Get-BetaEntitlementsPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
@@ -531,11 +505,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-excluded-entitlements-potential-role
This method returns excluded entitlements for a potential role in a role mining session.
### Parameters
@@ -550,7 +521,6 @@ Path | PotentialRoleId | **String** | True | A potential role id in a role mi
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
[**RoleMiningEntitlement[]**](../models/role-mining-entitlement)
### Responses
@@ -563,7 +533,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
@@ -576,7 +545,9 @@ $Filters = 'applicationName sw "AD"' # String | Filter results using the standar
$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)
# Retrieves excluded entitlements for a potential role in a role mining session
try {
Get-BetaExcludedEntitlementsPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
@@ -587,11 +558,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identities-potential-role
This method returns identities for a potential role in a role mining session.
### Parameters
@@ -606,7 +574,6 @@ Path | PotentialRoleId | **String** | True | A potential role id in a role mi
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
[**RoleMiningIdentity[]**](../models/role-mining-identity)
### Responses
@@ -619,7 +586,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
@@ -632,7 +598,9 @@ $Filters = 'MyFilters' # String | Filter results using the standard syntax descr
$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)
# Retrieves identities for a potential role in a role mining session
try {
Get-BetaIdentitiesPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
@@ -643,11 +611,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-potential-role
This method returns a specific potential role for a role mining session.
### Parameters
@@ -657,7 +622,6 @@ Path | SessionId | **String** | True | The role mining session id
Path | PotentialRoleId | **String** | True | A potential role id in a role mining session
### Return type
[**RoleMiningPotentialRole**](../models/role-mining-potential-role)
### Responses
@@ -671,7 +635,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 +642,9 @@ Code | Description | Data Type
```powershell
$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id
$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session
# Retrieve potential role in session
try {
Get-BetaPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
@@ -690,11 +655,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-potential-role-applications
This method returns the applications of a potential role for a role mining session.
### Parameters
@@ -708,7 +670,6 @@ Path | PotentialRoleId | **String** | True | A potential role id in a role mi
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
[**RoleMiningPotentialRoleApplication[]**](../models/role-mining-potential-role-application)
### Responses
@@ -722,7 +683,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
@@ -734,7 +694,9 @@ $Filters = 'applicationName sw "test"' # String | Filter results using the stand
$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)
# Retrieves the applications of a potential role for a role mining session
try {
Get-BetaPotentialRoleApplications-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
@@ -745,11 +707,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-potential-role-entitlements
This method returns the entitlements of a potential role for a role mining session.
### Parameters
@@ -763,7 +722,6 @@ Path | PotentialRoleId | **String** | True | A potential role id in a role mi
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
[**RoleMiningPotentialRoleEntitlements[]**](../models/role-mining-potential-role-entitlements)
### Responses
@@ -777,7 +735,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
@@ -789,7 +746,9 @@ $Filters = 'entitlementRef.name sw "test"' # String | Filter results using the s
$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)
# Retrieves the entitlements of a potential role for a role mining session
try {
Get-BetaPotentialRoleEntitlements-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
@@ -800,11 +759,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-potential-role-source-identity-usage
This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role.
### Parameters
@@ -818,7 +774,6 @@ Path | SourceId | **String** | True | A source 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
[**RoleMiningPotentialRoleSourceUsage[]**](../models/role-mining-potential-role-source-usage)
### Responses
@@ -832,7 +787,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
@@ -844,7 +798,9 @@ $Sorters = "-usageCount" # String | Sort results using the standard syntax descr
$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)
# Retrieves potential role source usage
try {
Get-BetaPotentialRoleSourceIdentityUsage-BetaPotentialRoleId $PotentialRoleId -BetaSourceId $SourceId
@@ -855,11 +811,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-potential-role-summaries
This method returns the potential role summaries for a role mining session.
### Parameters
@@ -873,7 +826,6 @@ Path | SessionId | **String** | True | The role mining session 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
[**RoleMiningPotentialRoleSummary[]**](../models/role-mining-potential-role-summary)
### Responses
@@ -887,7 +839,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
@@ -899,7 +850,9 @@ $Filters = '(createdByName co "int")and (createdById sw "2c9180907")and (type eq
$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)
# Retrieve session's potential role summaries
try {
Get-BetaPotentialRoleSummaries-BetaSessionId $SessionId
@@ -910,11 +863,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-mining-potential-role
This method returns a specific potential role.
### Parameters
@@ -923,7 +873,6 @@ Param Type | Name | Data Type | Required | Description
Path | PotentialRoleId | **String** | True | A potential role id
### Return type
[**RoleMiningPotentialRole**](../models/role-mining-potential-role)
### Responses
@@ -937,14 +886,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
$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id
# Retrieves a specific potential role
try {
Get-BetaRoleMiningPotentialRole-BetaPotentialRoleId $PotentialRoleId
@@ -955,11 +905,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-mining-session
The method retrieves a role mining session.
### Parameters
@@ -968,7 +915,6 @@ Param Type | Name | Data Type | Required | Description
Path | SessionId | **String** | True | The role mining session id to be retrieved.
### Return type
[**RoleMiningSessionResponse**](../models/role-mining-session-response)
### Responses
@@ -983,14 +929,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
$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be retrieved.
# Get a role mining session
try {
Get-BetaRoleMiningSession-BetaSessionId $SessionId
@@ -1001,11 +948,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-mining-session-status
This method returns a role mining session status for a customer.
### Parameters
@@ -1014,7 +958,6 @@ Param Type | Name | Data Type | Required | Description
Path | SessionId | **String** | True | The role mining session id
### Return type
[**RoleMiningSessionStatus**](../models/role-mining-session-status)
### Responses
@@ -1027,14 +970,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
$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id
# Get role mining session status state
try {
Get-BetaRoleMiningSessionStatus-BetaSessionId $SessionId
@@ -1045,11 +989,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-mining-sessions
Returns all role mining sessions that match the query parameters
### Parameters
@@ -1062,7 +1003,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
[**RoleMiningSessionResponse[]**](../models/role-mining-session-response)
### Responses
@@ -1076,7 +1016,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
@@ -1087,7 +1026,9 @@ $Sorters = "createdBy,createdDate" # String | Sort results using the standard sy
$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)
# Retrieves all role mining sessions
try {
Get-BetaRoleMiningSessions
@@ -1098,11 +1039,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-saved-potential-roles
This method returns all saved potential roles (draft roles).
### Parameters
@@ -1114,7 +1052,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
[**RoleMiningSessionDraftRoleDto[]**](../models/role-mining-session-draft-role-dto)
### Responses
@@ -1128,7 +1065,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
@@ -1138,7 +1074,9 @@ $Sorters = "modified" # String | Sort results using the standard syntax describe
$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)
# Retrieves all saved potential roles
try {
Get-BetaSavedPotentialRoles
@@ -1149,11 +1087,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-potential-role
This method updates an existing potential role using the role mining session id and the potential role summary id.
The following fields can be modified:
@@ -1176,7 +1111,6 @@ Path | PotentialRoleId | **String** | True | The potential role summary id
Body | PatchPotentialRoleRequestInner | [**[]PatchPotentialRoleRequestInner**](../models/patch-potential-role-request-inner) | True |
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -1191,7 +1125,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
@@ -1199,10 +1132,11 @@ Code | Description | Data Type
```powershell
$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id
$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id
# PatchPotentialRoleRequestInner[] |
$PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@
$PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ # PatchPotentialRoleRequestInner[] |
# Update a potential role in session
try {
$Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner
Update-BetaPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $Result
@@ -1214,11 +1148,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-role-mining-potential-role
This method updates an existing potential role.
The following fields can be modified:
@@ -1240,7 +1171,6 @@ Path | PotentialRoleId | **String** | True | The potential role summary id
Body | PatchPotentialRoleRequestInner | [**[]PatchPotentialRoleRequestInner**](../models/patch-potential-role-request-inner) | True |
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -1255,17 +1185,17 @@ 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
$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id
# PatchPotentialRoleRequestInner[] |
$PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@
$PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ # PatchPotentialRoleRequestInner[] |
# Update a potential role
try {
$Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner
Update-BetaRoleMiningPotentialRole-BetaPotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $Result
@@ -1277,11 +1207,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-role-mining-session
The method updates an existing role mining session using PATCH. Supports op in {"replace"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated.
### Parameters
@@ -1291,7 +1218,6 @@ Path | SessionId | **String** | True | The role mining session id to be patch
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session.
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -1306,21 +1232,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
$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be patched
# JsonPatchOperation[] | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session.
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session.
# Patch a role mining session
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-BetaRoleMiningSession-BetaSessionId $SessionId -BetaJsonPatchOperation $Result
@@ -1332,11 +1258,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-entitlements-potential-role
This endpoint adds or removes entitlements from an exclusion list for a potential role.
### Parameters
@@ -1347,7 +1270,6 @@ Path | PotentialRoleId | **String** | True | A potential role id in a role mi
Body | RoleMiningPotentialRoleEditEntitlements | [**RoleMiningPotentialRoleEditEntitlements**](../models/role-mining-potential-role-edit-entitlements) | True | Role mining session parameters
### Return type
[**RoleMiningPotentialRole**](../models/role-mining-potential-role)
### Responses
@@ -1360,7 +1282,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
@@ -1372,7 +1293,9 @@ $RoleMiningPotentialRoleEditEntitlements = @"{
"ids" : [ "entId1", "entId2" ],
"exclude" : true
}"@
# Edit entitlements for a potential role to exclude some entitlements
try {
$Result = ConvertFrom-JsonToRoleMiningPotentialRoleEditEntitlements -Json $RoleMiningPotentialRoleEditEntitlements
Update-BetaEntitlementsPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleEditEntitlements $Result
@@ -1384,7 +1307,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-icons
title: Icons
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/icons
tags: ['SDK', 'Software Development Kit', 'Icons', 'BetaIcons']
---
# Icons
Use this API to implement functionality related to object icons (application icons for example).
With this functionality in place, administrators can set or remove an icon for specific object type for use throughout Identity Security Cloud.
@@ -23,19 +23,16 @@ Method | HTTP request | Description
[**Remove-BetaIcon**](#delete-icon) | **DELETE** `/icons/{objectType}/{objectId}` | Delete an icon
[**Set-BetaIcon**](#set-icon) | **PUT** `/icons/{objectType}/{objectId}` | Update an icon
## delete-icon
This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API.
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | ObjectType | **String** | True | Object type. Available options ['application']
Path | ObjectType | **String** | True | Object type
Path | ObjectId | **String** | True | Object id.
### Return type
(empty response body)
### Responses
@@ -50,15 +47,16 @@ 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
$ObjectType = "application" # String | Object type. Available options ['application']
$ObjectType = "application" # String | Object type
$ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id.
# Delete an icon
try {
Remove-BetaIcon-BetaObjectType $ObjectType -BetaObjectId $ObjectId
@@ -69,22 +67,18 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-icon
This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API.
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | ObjectType | **String** | True | Object type. Available options ['application']
Path | ObjectType | **String** | True | Object type
Path | ObjectId | **String** | True | Object id.
| Image | **System.IO.FileInfo** | True | file with icon. Allowed mime-types ['image/png', 'image/jpeg']
### Return type
[**SetIcon200Response**](../models/set-icon200-response)
### Responses
@@ -99,16 +93,17 @@ 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
$ObjectType = "application" # String | Object type. Available options ['application']
$ObjectType = "application" # String | Object type
$ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id.
$Image = # System.IO.FileInfo | file with icon. Allowed mime-types ['image/png', 'image/jpeg']
# Update an icon
try {
Set-BetaIcon-BetaObjectType $ObjectType -BetaObjectId $ObjectId -BetaImage $Image
@@ -119,7 +114,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-identities
title: Identities
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/identities
tags: ['SDK', 'Software Development Kit', 'Identities', 'BetaIdentities']
---
# Identities
Use this API to implement identity functionality.
With this functionality in place, administrators can synchronize an identity's attributes with its various source attributes.
@@ -45,9 +45,7 @@ Method | HTTP request | Description
[**Start-BetaIdentityProcessing**](#start-identity-processing) | **POST** `/identities/process` | Process a list of identityIds
[**Sync-BetahronizeAttributesForIdentity**](#synchronize-attributes-for-identity) | **POST** `/identities/{identityId}/synchronize-attributes` | Attribute synchronization for single identity.
## delete-identity
The API returns successful response if the requested identity was deleted.
### Parameters
@@ -56,7 +54,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Identity Id
### Return type
(empty response body)
### Responses
@@ -71,14 +68,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
# Delete identity
try {
Remove-BetaIdentity-BetaId $Id
@@ -89,11 +87,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity
This API returns a single identity using the Identity ID.
### Parameters
@@ -102,7 +97,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Identity Id
### Return type
[**Identity**](../models/identity)
### Responses
@@ -117,14 +111,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
# Identity Details
try {
Get-BetaIdentity-BetaId $Id
@@ -135,11 +130,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-ownership-details
Use this API to return an identity's owned objects that will cause problems for deleting the identity.
Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity.
For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity's owned objects.
@@ -150,7 +142,6 @@ Param Type | Name | Data Type | Required | Description
Path | IdentityId | **String** | True | Identity ID.
### Return type
[**IdentityOwnershipAssociationDetails**](../models/identity-ownership-association-details)
### Responses
@@ -165,14 +156,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
$IdentityId = "ff8081814d2a8036014d701f3fbf53fa" # String | Identity ID.
# Get ownership details
try {
Get-BetaIdentityOwnershipDetails-BetaIdentityId $IdentityId
@@ -183,13 +175,10 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-assignment
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -197,7 +186,6 @@ Path | IdentityId | **String** | True | Identity Id
Path | AssignmentId | **String** | True | Assignment Id
### Return type
[**RoleAssignmentDto**](../models/role-assignment-dto)
### Responses
@@ -212,7 +200,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
@@ -220,7 +207,9 @@ Code | Description | Data Type
```powershell
$IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id
$AssignmentId = "1cbb0705b38c4226b1334eadd8874086" # String | Assignment Id
# Role assignment details
try {
Get-BetaRoleAssignment-BetaIdentityId $IdentityId -BetaAssignmentId $AssignmentId
@@ -231,11 +220,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-assignments
This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id.
### Parameters
@@ -246,7 +232,6 @@ Path | IdentityId | **String** | True | Identity Id to get the role assignmen
Query | RoleName | **String** | (optional) | Role name to filter the role assignments with
### Return type
[**GetRoleAssignments200ResponseInner[]**](../models/get-role-assignments200-response-inner)
### Responses
@@ -261,7 +246,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
@@ -270,7 +254,9 @@ Code | Description | Data Type
$IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id to get the role assignments for
$RoleId = "e7697a1e96d04db1ac7b0f4544915d2c" # String | Role Id to filter the role assignments with (optional)
$RoleName = "Engineer" # String | Role name to filter the role assignments with (optional)
# List role assignments
try {
Get-BetaRoleAssignments-BetaIdentityId $IdentityId
@@ -281,11 +267,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-identities
This API returns a list of identities.
### Parameters
@@ -299,7 +282,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
[**Identity[]**](../models/identity)
### Responses
@@ -313,7 +295,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
@@ -325,7 +306,9 @@ $DefaultFilter = "CORRELATED_ONLY" # String | Adds additional filter to filters
$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)
$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 Identities
try {
Get-BetaIdentities
@@ -336,11 +319,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## reset-identity
Use this endpoint to reset a user's identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have.
### Parameters
@@ -349,7 +329,6 @@ Param Type | Name | Data Type | Required | Description
Path | IdentityId | **String** | True | Identity Id
### Return type
(empty response body)
### Responses
@@ -364,14 +343,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
$IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id
# Reset an identity
try {
Reset-BetaIdentity-BetaIdentityId $IdentityId
@@ -382,11 +362,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## send-identity-verification-account-token
This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours.
@@ -397,7 +374,6 @@ Path | Id | **String** | True | Identity ID
Body | SendAccountVerificationRequest | [**SendAccountVerificationRequest**](../models/send-account-verification-request) | True |
### Return type
(empty response body)
### 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**: application/json
- **Accept**: application/json
@@ -423,7 +398,9 @@ $SendAccountVerificationRequest = @"{
"sourceName" : "Active Directory Source",
"via" : "EMAIL_WORK"
}"@
# Send password reset email
try {
$Result = ConvertFrom-JsonToSendAccountVerificationRequest -Json $SendAccountVerificationRequest
Send-BetaIdentityVerificationAccountToken-BetaId $Id -BetaSendAccountVerificationRequest $Result
@@ -435,11 +412,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-identities-invite
This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options.
This task will send an invitation email only for unregistered identities.
@@ -453,7 +427,6 @@ Param Type | Name | Data Type | Required | Description
Body | InviteIdentitiesRequest | [**InviteIdentitiesRequest**](../models/invite-identities-request) | True |
### Return type
[**TaskStatus**](../models/task-status)
### Responses
@@ -468,7 +441,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
@@ -478,7 +450,9 @@ $InviteIdentitiesRequest = @"{
"ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ],
"uninvited" : false
}"@
# Invite identities to register
try {
$Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest
Start-BetaIdentitiesInvite-BetaInviteIdentitiesRequest $Result
@@ -490,11 +464,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-identity-processing
This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized.
This endpoint will perform the following tasks:
@@ -513,7 +484,6 @@ Param Type | Name | Data Type | Required | Description
Body | ProcessIdentitiesRequest | [**ProcessIdentitiesRequest**](../models/process-identities-request) | True |
### Return type
[**TaskResultResponse**](../models/task-result-response)
### Responses
@@ -528,7 +498,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
@@ -537,7 +506,9 @@ Code | Description | Data Type
$ProcessIdentitiesRequest = @"{
"identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ]
}"@
# Process a list of identityIds
try {
$Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest
Start-BetaIdentityProcessing-BetaProcessIdentitiesRequest $Result
@@ -549,11 +520,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## synchronize-attributes-for-identity
This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. A token with ORG_ADMIN or API authority is required to call this API.
### Parameters
@@ -562,7 +530,6 @@ Param Type | Name | Data Type | Required | Description
Path | IdentityId | **String** | True | The Identity id
### Return type
[**IdentitySyncJob**](../models/identity-sync-job)
### Responses
@@ -577,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
$IdentityId = "MyIdentityId" # String | The Identity id
# Attribute synchronization for single identity.
try {
Sync-BetahronizeAttributesForIdentity-BetaIdentityId $IdentityId
@@ -595,7 +563,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-identity-attributes
title: IdentityAttributes
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/identity-attributes
tags: ['SDK', 'Software Development Kit', 'IdentityAttributes', 'BetaIdentityAttributes']
---
# IdentityAttributes
@@ -25,9 +25,7 @@ Method | HTTP request | Description
[**Get-BetaIdentityAttributes**](#list-identity-attributes) | **GET** `/identity-attributes` | List Identity Attributes
[**Send-BetaIdentityAttribute**](#put-identity-attribute) | **PUT** `/identity-attributes/{name}` | Update Identity Attribute
## create-identity-attribute
Use this API to create a new identity attribute. A token with ORG_ADMIN authority is required to call this API.
### Parameters
@@ -36,7 +34,6 @@ Param Type | Name | Data Type | Required | Description
Body | IdentityAttribute | [**IdentityAttribute**](../models/identity-attribute) | True |
### Return type
[**IdentityAttribute**](../models/identity-attribute)
### Responses
@@ -51,7 +48,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
@@ -79,7 +75,9 @@ $IdentityAttribute = @"{
"searchable" : false,
"multi" : false
}"@
# Create Identity Attribute
try {
$Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute
New-BetaIdentityAttribute-BetaIdentityAttribute $Result
@@ -91,11 +89,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-identity-attribute
This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API.
### Parameters
@@ -104,7 +99,6 @@ Param Type | Name | Data Type | Required | Description
Path | Name | **String** | True | The attribute's technical name.
### Return type
(empty response body)
### Responses
@@ -119,14 +113,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 = "displayName" # String | The attribute's technical name.
# Delete Identity Attribute
try {
Remove-BetaIdentityAttribute-BetaName $Name
@@ -137,11 +132,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-identity-attributes-in-bulk
Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to 'false' before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API.
### Parameters
@@ -150,7 +142,6 @@ Param Type | Name | Data Type | Required | Description
Body | IdentityAttributeNames | [**IdentityAttributeNames**](../models/identity-attribute-names) | True |
### Return type
(empty response body)
### Responses
@@ -165,7 +156,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
@@ -174,7 +164,9 @@ Code | Description | Data Type
$IdentityAttributeNames = @"{
"ids" : [ "name", "displayName" ]
}"@
# Bulk delete Identity Attributes
try {
$Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames
Remove-BetaIdentityAttributesInBulk-BetaIdentityAttributeNames $Result
@@ -186,11 +178,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-attribute
This gets an identity attribute for a given technical name.
### Parameters
@@ -199,7 +188,6 @@ Param Type | Name | Data Type | Required | Description
Path | Name | **String** | True | The attribute's technical name.
### Return type
[**IdentityAttribute**](../models/identity-attribute)
### Responses
@@ -214,14 +202,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 = "displayName" # String | The attribute's technical name.
# Get Identity Attribute
try {
Get-BetaIdentityAttribute-BetaName $Name
@@ -232,11 +221,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-identity-attributes
Use this API to get a collection of identity attributes.
### Parameters
@@ -248,7 +234,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
[**IdentityAttribute[]**](../models/identity-attribute)
### Responses
@@ -262,7 +247,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
@@ -272,7 +256,9 @@ $IncludeSystem = $false # Boolean | Include 'system' attributes in the response.
$IncludeSilent = $false # Boolean | Include 'silent' attributes in the response. (optional) (default to $false)
$SearchableOnly = $false # Boolean | Include only 'searchable' attributes in the response. (optional) (default to $false)
$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 Identity Attributes
try {
Get-BetaIdentityAttributes
@@ -283,11 +269,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-identity-attribute
This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. A token with ORG_ADMIN authority is required to call this API.
### Parameters
@@ -297,7 +280,6 @@ Path | Name | **String** | True | The attribute's technical name.
Body | IdentityAttribute | [**IdentityAttribute**](../models/identity-attribute) | True |
### Return type
[**IdentityAttribute**](../models/identity-attribute)
### Responses
@@ -312,7 +294,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
@@ -341,7 +322,9 @@ $IdentityAttribute = @"{
"searchable" : false,
"multi" : false
}"@
# Update Identity Attribute
try {
$Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute
Send-BetaIdentityAttribute-BetaName $Name -BetaIdentityAttribute $Result
@@ -353,7 +336,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-identity-history
title: IdentityHistory
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/identity-history
tags: ['SDK', 'Software Development Kit', 'IdentityHistory', 'BetaIdentityHistory']
---
# IdentityHistory
@@ -30,9 +30,7 @@ Method | HTTP request | Description
[**Get-BetaIdentitySnapshotAccessItems**](#list-identity-snapshot-access-items) | **GET** `/historical-identities/{id}/snapshots/{date}/access-items` | Get Identity Access Items Snapshot
[**Get-BetaIdentitySnapshots**](#list-identity-snapshots) | **GET** `/historical-identities/{id}/snapshots` | Lists all the snapshots for the identity
## compare-identity-snapshots
This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read'
### Parameters
@@ -47,7 +45,6 @@ Path | Id | **String** | True | The identity 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
[**IdentityCompareResponse[]**](../models/identity-compare-response)
### 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**: Not defined
- **Accept**: application/json
@@ -72,11 +68,13 @@ $Snapshot1 = "2007-03-01T13:00:00Z" # String | The snapshot 1 of identity (optio
$Snapshot2 = "2008-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional)
$AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (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)
# Gets a difference of count for each access item types for the given identity between 2 snapshots
try {
Compare-BetaIdentitySnapshots-BetaId $Id
@@ -87,11 +85,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## compare-identity-snapshots-access-type
This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read'
### Parameters
@@ -107,7 +102,6 @@ Path | AccessType | **String** | True | The specific type which needs to be c
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
[**AccessItemDiff[]**](../models/access-item-diff)
### Responses
@@ -121,21 +115,22 @@ 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 = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id
$AccessType = "role" # String | The specific type which needs to be compared
$AccessType = "accessProfile" # String | The specific type which needs to be compared
$AccessAssociated = $false # Boolean | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional)
$Snapshot1 = "2008-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional)
$Snapshot2 = "2009-03-01T13:00:00Z" # String | The snapshot 2 of identity (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)
# Gets a list of differences of specific accessType for the given identity between 2 snapshots
try {
Compare-BetaIdentitySnapshotsAccessType-BetaId $Id -BetaAccessType $AccessType
@@ -146,11 +141,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-historical-identity
This method retrieves a specified identity Requires authorization scope of 'idn:identity-history:read'
### Parameters
@@ -159,7 +151,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The identity id
### Return type
[**IdentityHistoryResponse**](../models/identity-history-response)
### Responses
@@ -173,14 +164,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 = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id
# Get latest snapshot of identity
try {
Get-BetaHistoricalIdentity-BetaId $Id
@@ -191,11 +183,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-historical-identity-events
This method retrieves all access events for the identity Requires authorization scope of 'idn:identity-history:read'
### Parameters
@@ -210,7 +199,6 @@ Path | Id | **String** | True | The identity 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
[**GetHistoricalIdentityEvents200ResponseInner[]**](../models/get-historical-identity-events200-response-inner)
### Responses
@@ -225,7 +213,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
@@ -235,14 +222,16 @@ $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id
$From = "2024-03-01T13:00:00Z" # String | The optional instant until which access events are returned (optional)
$EventTypes = "MyEventTypes" # String[] | An optional list of event types to return. If null or empty, all events are returned (optional)
$EventTypes = @"[AccessAddedEvent, AccessRemovedEvent]"@
$EventTypes = @"[AccessAddedEvent, AccessRemovedEvent]"@ # String[] | An optional list of event types to return. If null or empty, all events are returned (optional)
$AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional)
$AccessItemTypes = @"[entitlement, account]"@
$AccessItemTypes = @"[entitlement, account]"@ # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (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)
# Lists all events for the given identity
try {
Get-BetaHistoricalIdentityEvents-BetaId $Id
@@ -253,11 +242,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-snapshot
This method retrieves a specified identity snapshot at a given date Requires authorization scope of 'idn:identity-history:read'
### Parameters
@@ -267,7 +253,6 @@ Path | Id | **String** | True | The identity id
Path | Date | **String** | True | The specified date
### Return type
[**IdentityHistoryResponse**](../models/identity-history-response)
### 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**: Not defined
- **Accept**: application/json
@@ -289,7 +273,9 @@ Code | Description | Data Type
```powershell
$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id
$Date = "2007-03-01T13:00:00Z" # String | The specified date
# Gets an identity snapshot at a given date
try {
Get-BetaIdentitySnapshot-BetaId $Id -BetaDate $Date
@@ -300,11 +286,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-snapshot-summary
This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of 'idn:identity-history:read'
### Parameters
@@ -319,7 +302,6 @@ Path | Id | **String** | True | The identity 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
[**MetricResponse[]**](../models/metric-response)
### Responses
@@ -333,7 +315,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
@@ -346,7 +327,9 @@ $TimeZone = "UTC" # String | The time zone. Defaults to UTC if not provided (opt
$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)
# Gets the summary for the event count for a specific identity
try {
Get-BetaIdentitySnapshotSummary-BetaId $Id
@@ -357,11 +340,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-start-date
This method retrieves start date of the identity Requires authorization scope of 'idn:identity-history:read'
### Parameters
@@ -370,7 +350,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The identity id
### Return type
**String**
### Responses
@@ -384,14 +363,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 = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id
# Gets the start date of the identity
try {
Get-BetaIdentityStartDate-BetaId $Id
@@ -402,11 +382,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-historical-identities
This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of 'idn:identity-history:read'
### Parameters
@@ -419,7 +396,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
[**IdentityListItem[]**](../models/identity-list-item)
### Responses
@@ -433,7 +409,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 +419,9 @@ $IsDeleted = $true # Boolean | Indicates if we want to only list down deleted id
$IsActive = $true # Boolean | Indicates if we want to only list active or inactive identities. (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)
# Lists all the identities
try {
Get-BetaHistoricalIdentities
@@ -455,11 +432,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-identity-access-items
This method retrieves a list of access item for the identity filtered by the access item type
### Parameters
@@ -475,7 +449,6 @@ Path | Id | **String** | True | The identity id
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
[**ListIdentityAccessItems200ResponseInner[]**](../models/list-identity-access-items200-response-inner)
### Responses
@@ -490,7 +463,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
@@ -504,7 +476,9 @@ $Query = "Dr. Arden" # String | This param is used to search if certain fields o
$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)
$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 Access Items by Identity
try {
Get-BetaIdentityAccessItems-BetaId $Id
@@ -515,11 +489,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-identity-snapshot-access-items
Use this API to get a list of identity access items at a specified date, filtered by item type.
### Parameters
@@ -530,7 +501,6 @@ Path | Date | **String** | True | Specified date.
Query | Type | **String** | (optional) | Access item type.
### Return type
[**ListIdentityAccessItems200ResponseInner[]**](../models/list-identity-access-items200-response-inner)
### Responses
@@ -545,7 +515,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
@@ -553,8 +522,10 @@ Code | Description | Data Type
```powershell
$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Identity ID.
$Date = "2007-03-01T13:00:00Z" # String | Specified date.
$Type = "account" # String | Access item type. (optional)
$Type = "role" # String | Access item type. (optional)
# Get Identity Access Items Snapshot
try {
Get-BetaIdentitySnapshotAccessItems-BetaId $Id -BetaDate $Date
@@ -565,11 +536,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-identity-snapshots
This method retrieves all the snapshots for the identity Requires authorization scope of 'idn:identity-history:read'
### Parameters
@@ -583,7 +551,6 @@ Path | Id | **String** | True | The identity 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
[**IdentitySnapshotSummaryResponse[]**](../models/identity-snapshot-summary-response)
### Responses
@@ -597,7 +564,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
@@ -609,7 +575,9 @@ $Interval = "day" # String | The interval indicating the range in day or month f
$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)
# Lists all the snapshots for the identity
try {
Get-BetaIdentitySnapshots-BetaId $Id
@@ -620,7 +588,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-identity-profiles
title: IdentityProfiles
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/identity-profiles
tags: ['SDK', 'Software Development Kit', 'IdentityProfiles', 'BetaIdentityProfiles']
---
# IdentityProfiles
Use this API to implement and customize identity profile functionality.
With this functionality in place, administrators can manage identity profiles and configure them for use by identities throughout Identity Security Cloud.
@@ -41,9 +41,7 @@ Method | HTTP request | Description
[**Sync-BetaIdentityProfile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile
[**Update-BetaIdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update the Identity Profile
## create-identity-profile
This creates an Identity Profile.
A token with ORG_ADMIN authority is required to call this API to create an Identity Profile.
@@ -54,7 +52,6 @@ Param Type | Name | Data Type | Required | Description
Body | IdentityProfile | [**IdentityProfile**](../models/identity-profile) | True |
### Return type
[**IdentityProfile**](../models/identity-profile)
### 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
@@ -123,7 +119,9 @@ $IdentityProfile = @"{
"modified" : "2023-01-03T21:16:22.432Z",
"id" : "id12345"
}"@
# Create an Identity Profile
try {
$Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile
New-BetaIdentityProfile-BetaIdentityProfile $Result
@@ -135,11 +133,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.
@@ -154,7 +149,6 @@ Param Type | Name | Data Type | Required | Description
Path | IdentityProfileId | **String** | True | The Identity Profile ID.
### Return type
[**TaskResultSimplified**](../models/task-result-simplified)
### Responses
@@ -169,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
$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID.
# Delete an Identity Profile
try {
Remove-BetaIdentityProfile-BetaIdentityProfileId $IdentityProfileId
@@ -187,11 +182,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.
@@ -206,7 +198,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
@@ -220,16 +211,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-BetaIdentityProfiles-BetaRequestBody $Result
@@ -241,11 +233,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
@@ -258,7 +247,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
@@ -273,7 +261,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
@@ -284,7 +271,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 8c190e6787aa4ed9a90bd9d5344523fb' # 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 = "name,-priority" # 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-BetaIdentityProfiles
@@ -295,11 +284,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-default-identity-attribute-config
This returns the default identity attribute config
A token with ORG_ADMIN authority is required to call this API to get the default identity attribute config.
@@ -309,7 +295,6 @@ Param Type | Name | Data Type | Required | Description
Path | IdentityProfileId | **String** | True | The Identity Profile ID
### Return type
[**IdentityAttributeConfig**](../models/identity-attribute-config)
### Responses
@@ -324,14 +309,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
# Default identity attribute config
try {
Get-BetaDefaultIdentityAttributeConfig-BetaIdentityProfileId $IdentityProfileId
@@ -342,11 +328,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-profile
This returns a single Identity Profile based on ID.
A token with ORG_ADMIN or API authority is required to call this API.
@@ -357,7 +340,6 @@ Param Type | Name | Data Type | Required | Description
Path | IdentityProfileId | **String** | True | The Identity Profile ID
### Return type
[**IdentityProfile**](../models/identity-profile)
### Responses
@@ -372,14 +354,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
# Gets a single Identity Profile
try {
Get-BetaIdentityProfile-BetaIdentityProfileId $IdentityProfileId
@@ -390,11 +373,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## import-identity-profiles
This imports previously exported identity profiles.
### Parameters
@@ -403,7 +383,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
@@ -417,13 +396,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",
@@ -480,9 +462,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-BetaIdentityProfiles-BetaIdentityProfileExportedObject $Result
@@ -494,11 +478,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-identity-profiles
This returns a list of Identity Profiles based on the specified query parameters.
A token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles.
@@ -512,7 +493,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
@@ -526,7 +506,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
@@ -537,7 +516,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 8c190e6787aa4ed9a90bd9d5344523fb' # 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, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional)
$Sorters = "name,-priority" # 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-BetaIdentityProfiles
@@ -548,11 +529,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## show-generate-identity-preview
Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body.
This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body.
A token with ORG_ADMIN authority is required to call this API to generate an identity preview.
@@ -563,7 +541,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
@@ -577,7 +554,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
@@ -610,7 +586,9 @@ $IdentityPreviewRequest = @"{
"enabled" : true
}
}"@
# Generate Identity Profile Preview
try {
$Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest
Show-BetaGenerateIdentityPreview-BetaIdentityPreviewRequest $Result
@@ -622,11 +600,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.
@@ -640,7 +615,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
@@ -655,14 +629,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-BetaIdentityProfile-BetaIdentityProfileId $IdentityProfileId
@@ -673,11 +648,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-identity-profile
This updates the specified Identity Profile.
A token with ORG_ADMIN authority is required to call this API to update the Identity Profile.
@@ -698,7 +670,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
@@ -713,21 +684,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-BetaIdentityProfile-BetaIdentityProfileId $IdentityProfileId -BetaJsonPatchOperation $Result
@@ -739,7 +710,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-launchers
title: Launchers
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/launchers
tags: ['SDK', 'Software Development Kit', 'Launchers', 'BetaLaunchers']
---
# Launchers
Use this API to manage Launchers.
@@ -28,9 +28,7 @@ Method | HTTP request | Description
[**Send-BetaLauncher**](#put-launcher) | **PUT** `/launchers/{launcherID}` | Replace Launcher
[**Start-BetaLauncher**](#start-launcher) | **POST** `/beta/launchers/{launcherID}/launch` | Launch a Launcher
## create-launcher
Create a Launcher with given information
### Parameters
@@ -39,7 +37,6 @@ Param Type | Name | Data Type | Required | Description
Body | LauncherRequest | [**LauncherRequest**](../models/launcher-request) | True | Payload to create a Launcher
### Return type
[**Launcher**](../models/launcher)
### 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
@@ -71,7 +67,9 @@ $LauncherRequest = @"{
"type" : "INTERACTIVE_PROCESS",
"config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}"
}"@
# Create launcher
try {
$Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest
New-BetaLauncher-BetaLauncherRequest $Result
@@ -83,11 +81,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-launcher
Delete the given Launcher ID
### Parameters
@@ -96,7 +91,6 @@ Param Type | Name | Data Type | Required | Description
Path | LauncherID | **String** | True | ID of the Launcher to be deleted
### Return type
(empty response body)
### Responses
@@ -111,14 +105,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
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be deleted
# Delete Launcher
try {
Remove-BetaLauncher-BetaLauncherID $LauncherID
@@ -129,11 +124,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-launcher
Get details for the given Launcher ID
### Parameters
@@ -142,7 +134,6 @@ Param Type | Name | Data Type | Required | Description
Path | LauncherID | **String** | True | ID of the Launcher to be retrieved
### Return type
[**Launcher**](../models/launcher)
### 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
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be retrieved
# Get Launcher by ID
try {
Get-BetaLauncher-BetaLauncherID $LauncherID
@@ -175,11 +167,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-launchers
Return a list of Launchers for the authenticated tenant
### Parameters
@@ -190,7 +179,6 @@ Param Type | Name | Data Type | Required | Description
Query | Limit | **Int32** | (optional) (default to 10) | Number of Launchers to return
### Return type
[**GetLaunchers200Response**](../models/get-launchers200-response)
### Responses
@@ -205,7 +193,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
@@ -214,7 +201,9 @@ Code | Description | Data Type
$Filters = 'disabled eq "true"' # 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: **description**: *sw* **disabled**: *eq* **name**: *sw* (optional)
$Next = "eyJuZXh0IjoxMjN9Cg==" # String | Pagination marker (optional)
$Limit = 42 # Int32 | Number of Launchers to return (optional) (default to 10)
# List all Launchers for tenant
try {
Get-BetaLaunchers
@@ -225,11 +214,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-launcher
Replace the given Launcher ID with given payload
### Parameters
@@ -239,7 +225,6 @@ Path | LauncherID | **String** | True | ID of the Launcher to be replaced
Body | LauncherRequest | [**LauncherRequest**](../models/launcher-request) | True | Payload to replace Launcher
### Return type
[**Launcher**](../models/launcher)
### Responses
@@ -254,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
@@ -272,7 +256,9 @@ $LauncherRequest = @"{
"type" : "INTERACTIVE_PROCESS",
"config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}"
}"@
# Replace Launcher
try {
$Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest
Send-BetaLauncher-BetaLauncherID $LauncherID -BetaLauncherRequest $Result
@@ -284,11 +270,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-launcher
Launch the given Launcher ID
### Parameters
@@ -297,7 +280,6 @@ Param Type | Name | Data Type | Required | Description
Path | LauncherID | **String** | True | ID of the Launcher to be launched
### Return type
[**StartLauncher200Response**](../models/start-launcher200-response)
### Responses
@@ -312,14 +294,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
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be launched
# Launch a Launcher
try {
Start-BetaLauncher-BetaLauncherID $LauncherID
@@ -330,7 +313,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-lifecycle-states
title: LifecycleStates
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/lifecycle-states
tags: ['SDK', 'Software Development Kit', 'LifecycleStates', 'BetaLifecycleStates']
---
# LifecycleStates
Use this API to implement and customize lifecycle state functionality.
With this functionality in place, administrators can view 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.
@@ -57,9 +57,7 @@ Method | HTTP request | Description
[**Get-BetaLifecycleStates**](#get-lifecycle-states) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get Lifecycle State
[**Update-BetaLifecycleStates**](#update-lifecycle-states) | **PATCH** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State
## get-lifecycle-states
Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID.
A token with ORG_ADMIN or API authority is required to call this API.
@@ -72,7 +70,6 @@ Path | IdentityProfileId | **String** | True | Identity Profile ID.
Path | LifecycleStateId | **String** | True | Lifecycle State ID.
### Return type
[**LifecycleState**](../models/lifecycle-state)
### Responses
@@ -86,7 +83,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
@@ -94,7 +90,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-BetaLifecycleStates-BetaIdentityProfileId $IdentityProfileId -BetaLifecycleStateId $LifecycleStateId
@@ -105,11 +103,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.
A token with ORG_ADMIN or API authority is required to call this API.
@@ -123,7 +118,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
@@ -137,7 +131,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
@@ -145,14 +138,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-BetaLifecycleStates-BetaIdentityProfileId $IdentityProfileId -BetaLifecycleStateId $LifecycleStateId -BetaJsonPatchOperation $Result
@@ -164,7 +158,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-mfa-configuration
title: MFAConfiguration
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/mfa-configuration
tags: ['SDK', 'Software Development Kit', 'MFAConfiguration', 'BetaMFAConfiguration']
---
# MFAConfiguration
Configure and test multifactor authentication (MFA) methods
@@ -27,9 +27,7 @@ Method | HTTP request | Description
[**Set-BetaMFAOktaConfig**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set Okta MFA configuration
[**Test-BetaMFAConfig**](#test-mfa-config) | **GET** `/mfa/{method}/test` | MFA method's test configuration
## delete-mfa-config
This API removes the configuration for the specified MFA method.
### 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-BetaMFAConfig-BetaMethod $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-BetaMFADuoConfig
@@ -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-BetaMFAKbaConfig
@@ -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-BetaMFAOktaConfig
@@ -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-BetaMFADuoConfig-BetaMfaDuoConfig $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-BetaMFAKBAConfig-BetaKbaAnswerRequestItem $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-BetaMFAOktaConfig-BetaMfaOktaConfig $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-BetaMFAConfig-BetaMethod $Method
@@ -405,7 +381,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-mfa-controller
title: MFAController
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/mfa-controller
tags: ['SDK', 'Software Development Kit', 'MFAController', 'BetaMFAController']
---
# 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-BetaOktaVerifyRequest**](#send-okta-verify-request) | **POST** `/mfa/okta-verify/verify` | Verifying authentication via Okta method
[**Send-BetaTokenAuthRequest**](#send-token-auth-request) | **POST** `/mfa/token/authenticate` | Authenticate Token provided MFA method
## create-send-token
This API send token request.
### 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-BetaSendToken-BetaSendTokenRequest $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-BetaVerificationStatus-BetaMethod $Method -BetaVerificationPollRequest $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-BetaDuoVerifyRequest-BetaDuoVerificationRequest $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-BetaKbaAnswers-BetaKbaAnswerRequestItem $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-BetaOktaVerifyRequest-BetaOktaVerificationRequest $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-BetaTokenAuthRequest-BetaTokenAuthRequest $Result
@@ -320,7 +302,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-managed-clients
title: ManagedClients
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/managed-clients
tags: ['SDK', 'Software Development Kit', 'ManagedClients', 'BetaManagedClients']
---
# 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.
@@ -23,9 +23,7 @@ Method | HTTP request | Description
[**Get-BetaManagedClientStatus**](#get-managed-client-status) | **GET** `/managed-clients/{id}/status` | Specified Managed Client Status.
[**Update-BetaManagedClientStatus**](#update-managed-client-status) | **POST** `/managed-clients/{id}/status` | Handle status request from client
## get-managed-client-status
Retrieve Managed Client Status by ID.
### Parameters
@@ -35,7 +33,6 @@ Path | Id | **String** | True | ID of the Managed Client Status to get
Query | Type | [**ManagedClientType**](../models/managed-client-type) | True | Type of the Managed Client Status to get
### Return type
[**ManagedClientStatus**](../models/managed-client-status)
### 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**: Not defined
- **Accept**: application/json
@@ -58,7 +54,9 @@ Code | Description | Data Type
```powershell
$Id = "aClientId" # String | ID of the Managed Client Status to get
$Type = "CCG" # ManagedClientType | Type of the Managed Client Status to get
# Specified Managed Client Status.
try {
Get-BetaManagedClientStatus-BetaId $Id -BetaType $Type
@@ -69,11 +67,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-managed-client-status
Update a status detail passed in from the client
### Parameters
@@ -83,7 +78,6 @@ Path | Id | **String** | True | ID of the Managed Client Status to update
Body | ManagedClientStatus | [**ManagedClientStatus**](../models/managed-client-status) | True |
### Return type
[**ManagedClientStatusAggResponse**](../models/managed-client-status-agg-response)
### 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**: application/json
- **Accept**: application/json
@@ -131,7 +124,9 @@ $ManagedClientStatus = @"{
"status" : "NORMAL",
"timestamp" : "2020-01-01T00:00:00Z"
}"@
# Handle status request from client
try {
$Result = ConvertFrom-JsonToManagedClientStatus -Json $ManagedClientStatus
Update-BetaManagedClientStatus-BetaId $Id -BetaManagedClientStatus $Result
@@ -143,7 +138,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-managed-clusters
title: ManagedClusters
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/managed-clusters
tags: ['SDK', 'Software Development Kit', 'ManagedClusters', 'BetaManagedClusters']
---
# 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.
@@ -25,9 +25,7 @@ Method | HTTP request | Description
[**Get-BetaManagedClusters**](#get-managed-clusters) | **GET** `/managed-clusters` | Retrieve all Managed Clusters.
[**Send-BetaClientLogConfiguration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update managed cluster's log configuration
## get-client-log-configuration
Get managed cluster's log configuration.
### Parameters
@@ -36,7 +34,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of ManagedCluster to get log configuration for
### Return type
[**ClientLogConfiguration**](../models/client-log-configuration)
### 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 = "aClusterId" # String | ID of ManagedCluster to get log configuration for
# Get managed cluster's log configuration
try {
Get-BetaClientLogConfiguration-BetaId $Id
@@ -69,11 +67,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-managed-cluster
Retrieve a ManagedCluster by ID.
### Parameters
@@ -82,7 +77,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the ManagedCluster to get
### Return type
[**ManagedCluster**](../models/managed-cluster)
### Responses
@@ -97,14 +91,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 = "aClusterId" # String | ID of the ManagedCluster to get
# Get a specified ManagedCluster.
try {
Get-BetaManagedCluster-BetaId $Id
@@ -115,11 +110,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-managed-clusters
Retrieve all Managed Clusters for the current Org, based on request context.
### Parameters
@@ -131,7 +123,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
@@ -145,7 +136,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
@@ -155,7 +145,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)
# Retrieve all Managed Clusters.
try {
Get-BetaManagedClusters
@@ -166,11 +158,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-client-log-configuration
Update managed cluster's log configuration
### Parameters
@@ -180,7 +169,6 @@ Path | Id | **String** | True | ID of ManagedCluster to update log configurat
Body | ClientLogConfiguration | [**ClientLogConfiguration**](../models/client-log-configuration) | True | ClientLogConfiguration for given ManagedCluster
### Return type
[**ClientLogConfiguration**](../models/client-log-configuration)
### 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
@@ -209,7 +196,9 @@ $ClientLogConfiguration = @"{
"expiration" : "2020-12-15T19:13:36.079Z",
"logLevels" : "INFO"
}"@
# Update managed cluster's log configuration
try {
Send-BetaClientLogConfiguration-BetaId $Id -BetaClientLogConfiguration $Result
@@ -220,7 +209,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-multi-host-integration
title: MultiHostIntegration
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/multi-host-integration
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegration', 'BetaMultiHostIntegration']
---
# MultiHostIntegration
Use this API to build a Multi-Host Integration.
Multi-Host Integration will help customers to configure and manage similar type of target system in Identity Security Cloud.
@@ -35,9 +35,7 @@ Method | HTTP request | Description
[**Test-BetaSourceConnectionMultihost**](#test-source-connection-multihost) | **GET** `/multihosts/{multihost_id}/sources/{sourceId}/testConnection` | Test Configuration For Multi-Host Integration's Single Source
[**Update-BetaMultiHostSources**](#update-multi-host-sources) | **PATCH** `/multihosts/{id}` | Update Multi-Host Integration
## create-multi-host-integration
This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources.
A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
@@ -48,7 +46,6 @@ Param Type | Name | Data Type | Required | Description
Body | MultiHostIntegrationsCreate | [**MultiHostIntegrationsCreate**](../models/multi-host-integrations-create) | True | The specifics of the Multi-Host Integration to create
### Return type
[**MultiHostIntegrations**](../models/multi-host-integrations)
### Responses
@@ -63,7 +60,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 @@ $MultiHostIntegrationsCreate = @"{
"description" : "This is the Multi-Host Integration.",
"modified" : "2024-01-23T18:08:50.897Z"
}"@
# Create Multi-Host Integration
try {
$Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate
New-BetaMultiHostIntegration-BetaMultiHostIntegrationsCreate $Result
@@ -107,11 +105,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-sources-within-multi-host
This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources.
A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
@@ -123,7 +118,6 @@ Path | Id | **String** | True | ID of the Multi-Host Integration.
Body | MultiHostIntegrationsCreateSources | [**[]MultiHostIntegrationsCreateSources**](../models/multi-host-integrations-create-sources) | True | The specifics of the sources to create within Multi-Host Integration.
### Return type
(empty response body)
### Responses
@@ -138,14 +132,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 = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration.
# MultiHostIntegrationsCreateSources[] | The specifics of the sources to create within Multi-Host Integration.
$MultiHostIntegrationsCreateSources = @"{
"connectorAttributes" : {
"authType" : "SQLAuthentication",
@@ -157,9 +149,11 @@ $Id = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integra
},
"name" : "My Source",
"description" : "This is the corporate directory."
}"@
}"@ # MultiHostIntegrationsCreateSources[] | The specifics of the sources to create within Multi-Host Integration.
# Create Sources Within Multi-Host Integration
try {
$Result = ConvertFrom-JsonToMultiHostIntegrationsCreateSources -Json $MultiHostIntegrationsCreateSources
New-BetaSourcesWithinMultiHost-BetaId $Id -BetaMultiHostIntegrationsCreateSources $Result
@@ -171,11 +165,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-multi-host
Delete an existing Multi-Host Integration by ID.
A token with Org Admin or Multi Host Admin authority is required to access this endpoint.
@@ -186,7 +177,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of Multi-Host Integration to delete.
### Return type
(empty response body)
### Responses
@@ -201,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 = "2c91808568c529c60168cca6f90c1326" # String | ID of Multi-Host Integration to delete.
# Delete Multi-Host Integration
try {
Remove-BetaMultiHost-BetaId $Id
@@ -219,11 +210,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-acct-aggregation-groups
This API will return array of account aggregation groups within provided Multi-Host Integration ID.
A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
@@ -234,7 +222,6 @@ Param Type | Name | Data Type | Required | Description
Path | MultiHostId | **String** | True | ID of the Multi-Host Integration to update
### Return type
[**MultiHostIntegrationsAggScheduleUpdate**](../models/multi-host-integrations-agg-schedule-update)
### Responses
@@ -249,14 +236,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
$MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update
# Get Account Aggregation Groups Within Multi-Host Integration ID
try {
Get-BetaAcctAggregationGroups-BetaMultiHostId $MultiHostId
@@ -267,11 +255,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-entitlement-aggregation-groups
This API will return array of aggregation groups within provided Multi-Host Integration ID.
A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
@@ -282,7 +267,6 @@ Param Type | Name | Data Type | Required | Description
Path | MultiHostId | **String** | True | ID of the Multi-Host Integration to update
### Return type
[**MultiHostIntegrationsAggScheduleUpdate**](../models/multi-host-integrations-agg-schedule-update)
### Responses
@@ -297,14 +281,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
$MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update
# Get Entitlement Aggregation Groups Within Multi-Host Integration ID
try {
Get-BetaEntitlementAggregationGroups-BetaMultiHostId $MultiHostId
@@ -315,11 +300,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-multi-host-integrations
Get an existing Multi-Host Integration.
A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint.
@@ -330,7 +312,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the Multi-Host Integration.
### Return type
[**MultiHostIntegrations**](../models/multi-host-integrations)
### Responses
@@ -345,14 +326,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 = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration.
# Get Multi-Host Integration By ID
try {
Get-BetaMultiHostIntegrations-BetaId $Id
@@ -363,11 +345,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-multi-host-integrations-list
Get a list of Multi-Host Integrations.
A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
@@ -383,7 +362,6 @@ Param Type | Name | Data Type | Required | Description
Query | ForSubadmin | **String** | (optional) | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.
### Return type
[**MultiHostIntegrations[]**](../models/multi-host-integrations)
### Responses
@@ -398,7 +376,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
@@ -410,7 +387,9 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
$Filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # 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**: *in* **forSubAdminId**: *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)
$ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional)
# List All Existing Multi-Host Integrations
try {
Get-BetaMultiHostIntegrationsList
@@ -421,11 +400,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-multi-host-source-creation-errors
Get a list of sources creation errors within Multi-Host Integration ID.
A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
@@ -436,7 +412,6 @@ Param Type | Name | Data Type | Required | Description
Path | MultiHostId | **String** | True | ID of the Multi-Host Integration
### Return type
[**SourceCreationErrors[]**](../models/source-creation-errors)
### Responses
@@ -451,14 +426,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
$MultiHostId = "004091cb79b04636b88662afa50a4440" # String | ID of the Multi-Host Integration
# List Multi-Host Source Creation Errors
try {
Get-BetaMultiHostSourceCreationErrors-BetaMultiHostId $MultiHostId
@@ -469,11 +445,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-multihost-integration-types
This API endpoint returns the current list of supported Multi-Host Integration types.
A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
@@ -483,7 +456,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**MultiHostIntegrationTemplateType[]**](../models/multi-host-integration-template-type)
### Responses
@@ -498,13 +470,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 Multi-Host Integration Types
try {
Get-BetaMultihostIntegrationTypes
@@ -515,11 +488,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sources-within-multi-host
Get a list of sources within Multi-Host Integration ID.
A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
@@ -534,7 +504,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
[**MultiHostSources[]**](../models/multi-host-sources)
### Responses
@@ -549,7 +518,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
@@ -560,7 +528,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 = 'id eq 2c91808b6ef1d43e016efba0ce470904' # 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**: *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 Sources Within Multi-Host Integration
try {
Get-BetaSourcesWithinMultiHost
@@ -571,11 +541,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## test-connection-multi-host-sources
This endpoint performs a more detailed validation of the Multi-Host Integration's configuration.
A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
@@ -586,7 +553,6 @@ Param Type | Name | Data Type | Required | Description
Path | MultihostId | **String** | True | ID of the Multi-Host Integration
### Return type
(empty response body)
### Responses
@@ -601,14 +567,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
$MultihostId = "2c91808568c529c60168cca6f90c1324" # String | ID of the Multi-Host Integration
# Test Configuration For Multi-Host Integration
try {
Test-BetaConnectionMultiHostSources-BetaMultihostId $MultihostId
@@ -619,11 +586,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## test-source-connection-multihost
This endpoint performs a more detailed validation of the source's configuration.
A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
@@ -635,7 +599,6 @@ Path | MultihostId | **String** | True | ID of the Multi-Host Integration
Path | SourceId | **String** | True | ID of the source within the Multi-Host Integration
### Return type
[**TestSourceConnectionMultihost200Response**](../models/test-source-connection-multihost200-response)
### Responses
@@ -650,7 +613,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
@@ -658,7 +620,9 @@ Code | Description | Data Type
```powershell
$MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration
$SourceId = "2c91808568c529f60168cca6f90c1324" # String | ID of the source within the Multi-Host Integration
# Test Configuration For Multi-Host Integration's Single Source
try {
Test-BetaSourceConnectionMultihost-BetaMultihostId $MultihostId -BetaSourceId $SourceId
@@ -669,11 +633,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-multi-host-sources
Update existing sources within Multi-Host Integration.
A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
@@ -685,7 +646,6 @@ Path | MultihostId | **String** | True | ID of the Multi-Host Integration to
Body | UpdateMultiHostSourcesRequestInner | [**[]UpdateMultiHostSourcesRequestInner**](../models/update-multi-host-sources-request-inner) | True | This endpoint allows you to update a Multi-Host Integration.
### Return type
(empty response body)
### Responses
@@ -700,17 +660,17 @@ 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
$MultihostId = "anId" # String | ID of the Multi-Host Integration to update.
# UpdateMultiHostSourcesRequestInner[] | This endpoint allows you to update a Multi-Host Integration.
$UpdateMultiHostSourcesRequestInner = @"[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]"@
$UpdateMultiHostSourcesRequestInner = @"[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]"@ # UpdateMultiHostSourcesRequestInner[] | This endpoint allows you to update a Multi-Host Integration.
# Update Multi-Host Integration
try {
$Result = ConvertFrom-JsonToUpdateMultiHostSourcesRequestInner -Json $UpdateMultiHostSourcesRequestInner
Update-BetaMultiHostSources-BetaMultihostId $MultihostId -BetaUpdateMultiHostSourcesRequestInner $Result
@@ -722,7 +682,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

File diff suppressed because it is too large Load Diff

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

@@ -1,3 +1,4 @@
---
id: beta-notifications
title: Notifications
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/notifications
tags: ['SDK', 'Software Development Kit', 'Notifications', 'BetaNotifications']
---
# Notifications
@@ -34,9 +34,7 @@ Method | HTTP request | Description
[**Send-BetaMailFromAttributes**](#put-mail-from-attributes) | **PUT** `/mail-from-attributes` | Change MAIL FROM domain
[**Send-BetaTestNotification**](#send-test-notification) | **POST** `/send-test-notification` | Send Test Notification
## create-domain-dkim
Create a domain to be verified via DKIM (DomainKeys Identified Mail)
### Parameters
@@ -45,7 +43,6 @@ Param Type | Name | Data Type | Required | Description
Body | DomainAddress | [**DomainAddress**](../models/domain-address) | True |
### Return type
[**DomainStatusDto**](../models/domain-status-dto)
### Responses
@@ -60,7 +57,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 @@ Code | Description | Data Type
$DomainAddress = @"{
"domain" : "sailpoint.com"
}"@
# Verify domain address via DKIM
try {
$Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress
New-BetaDomainDkim-BetaDomainAddress $Result
@@ -81,11 +79,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-notification-template
This creates a template for your site.
You can also use this endpoint to update a template. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready.
@@ -96,7 +91,6 @@ Param Type | Name | Data Type | Required | Description
Body | TemplateDto | [**TemplateDto**](../models/template-dto) | True |
### Return type
[**TemplateDto**](../models/template-dto)
### 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
@@ -134,7 +127,9 @@ $TemplateDto = @"{
"id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b",
"key" : "cloud_manual_work_item_summary"
}"@
# Create Notification Template
try {
$Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto
New-BetaNotificationTemplate-BetaTemplateDto $Result
@@ -146,11 +141,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-verified-from-address
Create a new sender email address and initiate verification process.
### Parameters
@@ -159,7 +151,6 @@ Param Type | Name | Data Type | Required | Description
Body | EmailStatusDto | [**EmailStatusDto**](../models/email-status-dto) | True |
### Return type
[**EmailStatusDto**](../models/email-status-dto)
### Responses
@@ -173,7 +164,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
@@ -185,7 +175,9 @@ $EmailStatusDto = @"{
"id" : "id",
"email" : "sender@example.com"
}"@
# Create Verified From Address
try {
$Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto
New-BetaVerifiedFromAddress-BetaEmailStatusDto $Result
@@ -197,11 +189,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-notification-templates-in-bulk
This lets you bulk delete templates that you previously created for your site. Since this is a beta feature, please contact support to enable usage.
### Parameters
@@ -210,7 +199,6 @@ Param Type | Name | Data Type | Required | Description
Body | TemplateBulkDeleteDto | [**[]TemplateBulkDeleteDto**](../models/template-bulk-delete-dto) | True |
### Return type
(empty response body)
### Responses
@@ -224,20 +212,20 @@ 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
# TemplateBulkDeleteDto[] |
$TemplateBulkDeleteDto = @"{
"medium" : "EMAIL",
"locale" : "en",
"key" : "cloud_manual_work_item_summary"
}"@
}"@ # TemplateBulkDeleteDto[] |
# Bulk Delete Notification Templates
try {
$Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto
Remove-BetaNotificationTemplatesInBulk-BetaTemplateBulkDeleteDto $Result
@@ -249,11 +237,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-verified-from-address
Delete a verified sender email address
### Parameters
@@ -262,7 +247,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True |
### Return type
(empty response body)
### Responses
@@ -277,14 +261,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 = "MyId" # String |
# Delete Verified From Address
try {
Remove-BetaVerifiedFromAddress-BetaId $Id
@@ -295,11 +280,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-dkim-attributes
Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants' AWS SES identities. Limits retrieval to 100 identities per call.
### Parameters
@@ -307,7 +289,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**DkimAttributes[]**](../models/dkim-attributes)
### Responses
@@ -321,13 +302,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 DKIM Attributes
try {
Get-BetaDkimAttributes
@@ -338,11 +320,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-mail-from-attributes
Retrieve MAIL FROM attributes for a given AWS SES identity.
### Parameters
@@ -351,7 +330,6 @@ Param Type | Name | Data Type | Required | Description
Query | Id | **String** | True | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status
### Return type
[**MailFromAttributes**](../models/mail-from-attributes)
### Responses
@@ -365,14 +343,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 = "bobsmith@sailpoint.com" # String | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status
# Get MAIL FROM Attributes
try {
Get-BetaMailFromAttributes-BetaId $Id
@@ -383,11 +362,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-notification-template
This gets a template that you have modified for your site by Id.
### Parameters
@@ -396,7 +372,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Id of the Notification Template
### Return type
[**TemplateDto[]**](../models/template-dto)
### Responses
@@ -410,14 +385,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 Notification Template
# Get Notification Template By Id
try {
Get-BetaNotificationTemplate-BetaId $Id
@@ -428,11 +404,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-notifications-template-context
The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called "Global Context" (a.k.a. notification template context). It defines a set of attributes
that will be available per tenant (organization).
@@ -441,7 +414,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**NotificationTemplateContext**](../models/notification-template-context)
### Responses
@@ -455,13 +427,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 Notification Template Context
try {
Get-BetaNotificationsTemplateContext
@@ -472,11 +445,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-from-addresses
Retrieve a list of sender email addresses and their verification statuses
### Parameters
@@ -489,7 +459,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: **email**
### Return type
[**EmailStatusDto[]**](../models/email-status-dto)
### Responses
@@ -502,7 +471,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
@@ -513,7 +481,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 = 'email eq "john.doe@company.com"' # 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: **email**: *eq, ge, le, sw* (optional)
$Sorters = "email" # 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: **email** (optional)
# List From Addresses
try {
Get-BetaFromAddresses
@@ -524,11 +494,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-notification-preferences
Returns a list of notification preferences for tenant.
### Parameters
@@ -536,7 +503,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**PreferencesDto[]**](../models/preferences-dto)
### Responses
@@ -551,13 +517,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 Notification Preferences for tenant.
try {
Get-BetaNotificationPreferences
@@ -568,11 +535,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-notification-template-defaults
This lists the default templates used for notifications, such as emails from IdentityNow.
### Parameters
@@ -583,7 +547,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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw*
### Return type
[**TemplateDtoDefault[]**](../models/template-dto-default)
### Responses
@@ -597,7 +560,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
@@ -606,7 +568,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 = 'key eq "cloud_manual_work_item_summary"' # 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional)
# List Notification Template Defaults
try {
Get-BetaNotificationTemplateDefaults
@@ -617,11 +581,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-notification-templates
This lists the templates that you have modified for your site.
### Parameters
@@ -632,7 +593,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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw*
### Return type
[**TemplateDto[]**](../models/template-dto)
### Responses
@@ -646,7 +606,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
@@ -655,7 +614,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 = 'medium eq "EMAIL"' # 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional)
# List Notification Templates
try {
Get-BetaNotificationTemplates
@@ -666,11 +627,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-mail-from-attributes
Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller's DNS
### Parameters
@@ -679,7 +637,6 @@ Param Type | Name | Data Type | Required | Description
Body | MailFromAttributesDto | [**MailFromAttributesDto**](../models/mail-from-attributes-dto) | True |
### Return type
[**MailFromAttributes**](../models/mail-from-attributes)
### Responses
@@ -693,7 +650,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
@@ -703,7 +659,9 @@ $MailFromAttributesDto = @"{
"identity" : "BobSmith@sailpoint.com",
"mailFromDomain" : "example.sailpoint.com"
}"@
# Change MAIL FROM domain
try {
$Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto
Send-BetaMailFromAttributes-BetaMailFromAttributesDto $Result
@@ -715,11 +673,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## send-test-notification
Send a Test Notification
### Parameters
@@ -728,7 +683,6 @@ Param Type | Name | Data Type | Required | Description
Body | SendTestNotificationRequestDto | [**SendTestNotificationRequestDto**](../models/send-test-notification-request-dto) | True |
### Return type
(empty response body)
### Responses
@@ -743,7 +697,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
@@ -754,7 +707,9 @@ $SendTestNotificationRequestDto = @"{
"medium" : "EMAIL",
"key" : "cloud_manual_work_item_summary"
}"@
# Send Test Notification
try {
$Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto
Send-BetaTestNotification-BetaSendTestNotificationRequestDto $Result
@@ -766,7 +721,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-o-auth-clients
title: OAuthClients
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/o-auth-clients
tags: ['SDK', 'Software Development Kit', 'OAuthClients', 'BetaOAuthClients']
---
# 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-BetaOauthClients**](#list-oauth-clients) | **GET** `/oauth-clients` | List OAuth Clients
[**Update-BetaOauthClient**](#patch-oauth-client) | **PATCH** `/oauth-clients/{id}` | Patch OAuth Client
## create-oauth-client
This creates an OAuth client.
### 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-BetaOauthClient-BetaCreateOAuthClientRequest $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-BetaOauthClient-BetaId $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-BetaOauthClient-BetaId $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-BetaOauthClients
@@ -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.
Request will require a security scope of
- sp:oauth-client:manage
@@ -240,7 +226,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
@@ -255,21 +240,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-BetaOauthClient-BetaId $Id -BetaJsonPatchOperation $Result
@@ -281,7 +266,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-org-config
title: OrgConfig
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/org-config
tags: ['SDK', 'Software Development Kit', 'OrgConfig', 'BetaOrgConfig']
---
# OrgConfig
Use this API to implement organization configuration functionality.
Administrators can use this functionality to manage organization settings, such as time zones.
@@ -24,9 +24,7 @@ Method | HTTP request | Description
[**Get-BetaValidTimeZones**](#get-valid-time-zones) | **GET** `/org-config/valid-time-zones` | Get list of time zones
[**Update-BetaOrgConfig**](#patch-org-config) | **PATCH** `/org-config` | Patch an Org configuration property
## get-org-config
Get org configuration with only external (org admin) accessible properties for the current org.
### Parameters
@@ -34,7 +32,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**OrgConfig**](../models/org-config)
### Responses
@@ -49,13 +46,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 Org configuration settings
try {
Get-BetaOrgConfig
@@ -66,11 +64,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-valid-time-zones
Get a list of valid time zones that can be set in org configurations.
### Parameters
@@ -78,7 +73,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
**String[]**
### Responses
@@ -92,13 +86,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 list of time zones
try {
Get-BetaValidTimeZones
@@ -109,11 +104,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-org-config
Patch configuration of the current org using http://jsonpatch.com/ syntax. Commonly used for changing the time zone of an org.
### Parameters
@@ -122,7 +114,6 @@ Param Type | Name | Data Type | Required | Description
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
### Return type
[**OrgConfig**](../models/org-config)
### Responses
@@ -137,20 +128,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 schema attribute 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 schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
# Patch an Org configuration property
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-BetaOrgConfig-BetaJsonPatchOperation $Result
@@ -162,7 +153,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-password-configuration
title: PasswordConfiguration
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/password-configuration
tags: ['SDK', 'Software Development Kit', 'PasswordConfiguration', 'BetaPasswordConfiguration']
---
# 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-BetaPasswordOrgConfig**](#get-password-org-config) | **GET** `/password-org-config` | Get Password Org Config
[**Send-BetaPasswordOrgConfig**](#put-password-org-config) | **PUT** `/password-org-config` | Update Password Org Config
## create-password-org-config
This API creates the password org config. Unspecified fields will use default value.
To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true".
Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write'
@@ -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-BetaPasswordOrgConfig-BetaPasswordOrgConfig $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-BetaPasswordOrgConfig
@@ -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-BetaPasswordOrgConfig-BetaPasswordOrgConfig $Result
@@ -175,7 +167,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-password-dictionary
title: PasswordDictionary
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/password-dictionary
tags: ['SDK', 'Software Development Kit', 'PasswordDictionary', 'BetaPasswordDictionary']
---
# 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-BetaPasswordDictionary**](#get-password-dictionary) | **GET** `/password-dictionary` | Get Password Dictionary
[**Send-BetaPasswordDictionary**](#put-password-dictionary) | **PUT** `/password-dictionary` | Update Password Dictionary
## get-password-dictionary
This gets password dictionary for the organization.
The password dictionary file can contain lines that are:
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-BetaPasswordDictionary
@@ -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-BetaPasswordDictionary
@@ -213,7 +208,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-password-management
title: PasswordManagement
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/password-management
tags: ['SDK', 'Software Development Kit', 'PasswordManagement', 'BetaPasswordManagement']
---
# PasswordManagement
Use this API to implement password management functionality.
With this functionality in place, users can manage their identity passwords for all their applications.
@@ -47,9 +47,7 @@ Method | HTTP request | Description
[**Search-BetaPasswordInfo**](#query-password-info) | **POST** `/query-password-info` | Query Password Info
[**Set-BetaIdentityPassword**](#set-identity-password) | **POST** `/set-password` | Set Identity's Password
## create-digit-token
This API is used to generate a digit token for password management. Requires authorization scope of "idn:password-digit-token:create".
### Parameters
@@ -58,7 +56,6 @@ Param Type | Name | Data Type | Required | Description
Body | PasswordDigitTokenReset | [**PasswordDigitTokenReset**](../models/password-digit-token-reset) | True |
### Return type
[**PasswordDigitToken**](../models/password-digit-token)
### Responses
@@ -72,7 +69,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 @@ $PasswordDigitTokenReset = @"{
"length" : 8,
"userId" : "Abby.Smith"
}"@
# Generate a digit token
try {
$Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset
New-BetaDigitToken-BetaPasswordDigitTokenReset $Result
@@ -95,11 +93,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-password-change-status
This API returns the status of a password change request. A token with identity owner or trusted API client application authority is required to call this API.
### Parameters
@@ -108,7 +103,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True |
### Return type
[**PasswordStatus**](../models/password-status)
### 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
$Id = "MyId" # String |
# Get Password Change Request Status
try {
Get-BetaIdentityPasswordChangeStatus-BetaId $Id
@@ -140,11 +135,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## query-password-info
This API is used to query password related information.
A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)
@@ -161,7 +153,6 @@ Param Type | Name | Data Type | Required | Description
Body | PasswordInfoQueryDTO | [**PasswordInfoQueryDTO**](../models/password-info-query-dto) | True |
### Return type
[**PasswordInfo**](../models/password-info)
### Responses
@@ -175,7 +166,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
@@ -185,7 +175,9 @@ $PasswordInfoQueryDTO = @"{
"sourceName" : "My-AD",
"userName" : "Abby.Smith"
}"@
# Query Password Info
try {
$Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO
Search-BetaPasswordInfo-BetaPasswordInfoQueryDTO $Result
@@ -197,11 +189,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-identity-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).
@@ -253,7 +242,6 @@ Param Type | Name | Data Type | Required | Description
Body | PasswordChangeRequest | [**PasswordChangeRequest**](../models/password-change-request) | True |
### Return type
[**PasswordChangeResponse**](../models/password-change-response)
### Responses
@@ -267,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
@@ -280,7 +267,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-BetaIdentityPassword-BetaPasswordChangeRequest $Result
@@ -292,7 +281,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-password-policies
title: PasswordPolicies
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/password-policies
tags: ['SDK', 'Software Development Kit', 'PasswordPolicies', 'BetaPasswordPolicies']
---
# PasswordPolicies
Use these APIs to implement password policies functionality.
These APIs allow you to define the policy parameters for choosing passwords.
@@ -33,9 +33,7 @@ Method | HTTP request | Description
[**Get-BetaPasswordPolicies**](#list-password-policies) | **GET** `/password-policies` | List Password Policies
[**Set-BetaPasswordPolicy**](#set-password-policy) | **PUT** `/password-policies/{id}` | Update Password Policy by ID
## create-password-policy
This API creates the specified password policy.
### Parameters
@@ -44,7 +42,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
@@ -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
@@ -98,7 +94,9 @@ $PasswordPolicyV3Dto = @"{
"name" : "PasswordPolicy Example",
"maxLength" : 25
}"@
# Create Password Policy
try {
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
New-BetaPasswordPolicy-BetaPasswordPolicyV3Dto $Result
@@ -110,11 +108,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-password-policy
This API deletes the specified password policy.
### Parameters
@@ -123,7 +118,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
@@ -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 = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete.
# Delete Password Policy by ID
try {
Remove-BetaPasswordPolicy-BetaId $Id
@@ -156,11 +151,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-password-policy-by-id
This API returns the password policy for the specified ID.
### Parameters
@@ -169,7 +161,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
@@ -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 = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve.
# Get Password Policy by ID
try {
Get-BetaPasswordPolicyById-BetaId $Id
@@ -202,11 +194,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-password-policies
This gets list of all Password Policies.
Requires role of ORG_ADMIN
@@ -218,7 +207,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
@@ -232,7 +220,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
@@ -241,7 +228,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-BetaPasswordPolicies
@@ -252,11 +241,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-password-policy
This API updates the specified password policy.
### Parameters
@@ -266,7 +252,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
@@ -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
- **Accept**: application/json
@@ -321,7 +305,9 @@ $PasswordPolicyV3Dto = @"{
"name" : "PasswordPolicy Example",
"maxLength" : 25
}"@
# Update Password Policy by ID
try {
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
Set-BetaPasswordPolicy-BetaId $Id -BetaPasswordPolicyV3Dto $Result
@@ -333,7 +319,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-password-sync-groups
title: PasswordSyncGroups
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/password-sync-groups
tags: ['SDK', 'Software Development Kit', 'PasswordSyncGroups', 'BetaPasswordSyncGroups']
---
# 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-BetaPasswordSyncGroups**](#get-password-sync-groups) | **GET** `/password-sync-groups` | Get Password Sync Group List
[**Update-BetaPasswordSyncGroup**](#update-password-sync-group) | **PUT** `/password-sync-groups/{id}` | Update Password Sync Group by ID
## create-password-sync-group
This API creates a password sync group based on the specifications provided.
### 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-BetaPasswordSyncGroup-BetaPasswordSyncGroup $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-BetaPasswordSyncGroup-BetaId $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-BetaPasswordSyncGroup-BetaId $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-BetaPasswordSyncGroups
@@ -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-BetaPasswordSyncGroup-BetaId $Id -BetaPasswordSyncGroup $Result
@@ -303,7 +289,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-personal-access-tokens
title: PersonalAccessTokens
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/personal-access-tokens
tags: ['SDK', 'Software Development Kit', 'PersonalAccessTokens', 'BetaPersonalAccessTokens']
---
# 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-BetaPersonalAccessTokens**](#list-personal-access-tokens) | **GET** `/personal-access-tokens` | List Personal Access Tokens
[**Update-BetaPersonalAccessToken**](#patch-personal-access-token) | **PATCH** `/personal-access-tokens/{id}` | Patch Personal Access Token
## create-personal-access-token
This creates a personal access token.
### 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-BetaPersonalAccessToken-BetaCreatePersonalAccessTokenRequest $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-BetaPersonalAccessToken-BetaId $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-BetaPersonalAccessTokens
@@ -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.
### Parameters
@@ -189,7 +178,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
@@ -204,21 +192,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-BetaPersonalAccessToken-BetaId $Id -BetaJsonPatchOperation $Result
@@ -230,7 +218,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-public-identities-config
title: PublicIdentitiesConfig
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/public-identities-config
tags: ['SDK', 'Software Development Kit', 'PublicIdentitiesConfig', 'BetaPublicIdentitiesConfig']
---
# 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-BetaPublicIdentityConfig**](#get-public-identity-config) | **GET** `/public-identities-config` | Get Public Identity Config
[**Update-BetaPublicIdentityConfig**](#update-public-identity-config) | **PUT** `/public-identities-config` | Update Public Identity Config
## get-public-identity-config
This gets details of public identity config.
### 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 Public Identity Config
try {
Get-BetaPublicIdentityConfig
@@ -72,11 +70,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-public-identity-config
This updates the details of public identity config.
### 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 Public Identity Config
try {
$Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig
Update-BetaPublicIdentityConfig-BetaPublicIdentityConfig $Result
@@ -132,7 +127,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-requestable-objects
title: RequestableObjects
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/requestable-objects
tags: ['SDK', 'Software Development Kit', 'RequestableObjects', 'BetaRequestableObjects']
---
# 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/beta/access-requests/), along with their statuses.
@@ -23,9 +23,7 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaRequestableObjects**](#list-requestable-objects) | **GET** `/requestable-objects` | Requestable Objects List
## list-requestable-objects
This endpoint returns a list of acccess items that that can be requested through the Access Request endpoints. Access items are marked with AVAILABLE, PENDING or ASSIGNED with respect to the identity provided using *identity-id* query param.
Any authenticated token can call this endpoint to see their requestable access items.
@@ -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-BetaRequestableObjects
@@ -87,7 +85,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-role-insights
title: RoleInsights
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/role-insights
tags: ['SDK', 'Software Development Kit', 'RoleInsights', 'BetaRoleInsights']
---
# RoleInsights
@@ -28,9 +28,7 @@ Method | HTTP request | Description
[**Get-BetaRoleInsightsRequests**](#get-role-insights-requests) | **GET** `/role-insights/requests/{id}` | Returns metadata from prior request.
[**Get-BetaRoleInsightsSummary**](#get-role-insights-summary) | **GET** `/role-insights/summary` | Get role insights summary information
## create-role-insight-requests
Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer.
### Parameters
@@ -38,7 +36,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**RoleInsightsResponse**](../models/role-insights-response)
### Responses
@@ -52,13 +49,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
# Generate insights for roles
try {
New-BetaRoleInsightRequests
@@ -69,11 +67,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## download-role-insights-entitlements-changes
This endpoint returns the entitlement insights for a role.
### Parameters
@@ -84,7 +79,6 @@ Path | InsightId | **String** | True | The role insight 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: **name**: *sw* **description**: *sw*
### Return type
**String**
### Responses
@@ -97,7 +91,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
@@ -106,7 +99,9 @@ Code | Description | Data Type
$InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id
$Sorters = "identitiesWithAccess" # 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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional)
$Filters = 'name sw "r"' # 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**: *sw* **description**: *sw* (optional)
# Download entitlement insights for a role
try {
Invoke-BetaDownloadRoleInsightsEntitlementsChanges-BetaInsightId $InsightId
@@ -117,11 +112,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-entitlement-changes-identities
Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role.
### Parameters
@@ -137,7 +129,6 @@ Path | EntitlementId | **String** | True | The entitlement 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: **name**: *sw*
### Return type
[**RoleInsightsIdentities[]**](../models/role-insights-identities)
### Responses
@@ -150,7 +141,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 @@ $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)
$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 sw "Jan"' # 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**: *sw* (optional)
# Get identities for a suggested entitlement (for a role)
try {
Get-BetaEntitlementChangesIdentities-BetaInsightId $InsightId -BetaEntitlementId $EntitlementId
@@ -175,11 +167,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insight
This endpoint gets role insights information for a role.
### Parameters
@@ -188,7 +177,6 @@ Param Type | Name | Data Type | Required | Description
Path | InsightId | **String** | True | The role insight id
### Return type
[**RoleInsight**](../models/role-insight)
### Responses
@@ -201,14 +189,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
$InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id
# Get a single role insight
try {
Get-BetaRoleInsight-BetaInsightId $InsightId
@@ -219,11 +208,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insights
This method returns detailed role insights for each role.
### Parameters
@@ -236,7 +222,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**: *sw* **ownerName**: *sw* **description**: *sw*
### Return type
[**RoleInsight[]**](../models/role-insight)
### Responses
@@ -249,7 +234,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
@@ -260,7 +244,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)
$Sorters = "numberOfUpdates" # 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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional)
$Filters = 'name sw "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: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional)
# Get role insights
try {
Get-BetaRoleInsights
@@ -271,11 +257,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insights-current-entitlements
This endpoint gets the entitlements for a role. The term "current" is to distinguish from the entitlement(s) an insight might recommend adding.
### Parameters
@@ -285,7 +268,6 @@ Path | InsightId | **String** | True | The role insight 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: **name**: *sw* **description**: *sw*
### Return type
[**RoleInsightsEntitlement[]**](../models/role-insights-entitlement)
### Responses
@@ -298,7 +280,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
@@ -306,7 +287,9 @@ Code | Description | Data Type
```powershell
$InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id
$Filters = 'name sw "r"' # 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**: *sw* **description**: *sw* (optional)
# Get current entitlement for a role
try {
Get-BetaRoleInsightsCurrentEntitlements-BetaInsightId $InsightId
@@ -317,11 +300,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insights-entitlements-changes
This endpoint returns entitlement insights for a role.
### Parameters
@@ -332,7 +312,6 @@ Path | InsightId | **String** | True | The role insight 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: **name**: *sw* **description**: *sw*
### Return type
[**RoleInsightsEntitlementChanges[]**](../models/role-insights-entitlement-changes)
### Responses
@@ -345,7 +324,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
@@ -354,7 +332,9 @@ Code | Description | Data Type
$InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id
$Sorters = "MySorters" # 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: **identitiesWithAccess, name** (optional)
$Filters = 'name sw "Admin"' # 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**: *sw* **description**: *sw* (optional)
# Get entitlement insights for a role
try {
Get-BetaRoleInsightsEntitlementsChanges-BetaInsightId $InsightId
@@ -365,11 +345,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insights-requests
This endpoint returns details of a prior role insights request.
### Parameters
@@ -378,7 +355,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The role insights request id
### Return type
[**RoleInsightsResponse**](../models/role-insights-response)
### Responses
@@ -392,14 +368,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 = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insights request id
# Returns metadata from prior request.
try {
Get-BetaRoleInsightsRequests-BetaId $Id
@@ -410,11 +387,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insights-summary
This method returns high level summary information for role insights for a customer.
### Parameters
@@ -422,7 +396,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**RoleInsightsSummary**](../models/role-insights-summary)
### Responses
@@ -435,13 +408,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 role insights summary information
try {
Get-BetaRoleInsightsSummary
@@ -452,7 +426,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-roles
title: Roles
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/roles
tags: ['SDK', 'Software Development Kit', 'Roles', 'BetaRoles']
---
# 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.
@@ -64,9 +64,7 @@ Method | HTTP request | Description
[**Get-BetaRoles**](#list-roles) | **GET** `/roles` | List Roles
[**Update-BetaRole**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified Role
## create-role
This API creates a role.
You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API.
@@ -81,7 +79,6 @@ Param Type | Name | Data Type | Required | Description
Body | Role | [**Role**](../models/role) | True |
### Return type
[**Role**](../models/role)
### Responses
@@ -95,7 +92,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
@@ -259,7 +255,9 @@ $Role = @"{
"id" : "2c918086749d78830174a1a40e121518",
"requestable" : true
}"@
# Create a Role
try {
$Result = ConvertFrom-JsonToRole -Json $Role
New-BetaRole-BetaRole $Result
@@ -271,11 +269,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.
@@ -287,7 +282,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
@@ -301,7 +295,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
@@ -310,7 +303,9 @@ Code | Description | Data Type
$RoleBulkDeleteRequest = @"{
"roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ]
}"@
# Delete Role(s)
try {
$Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest
Remove-BetaBulkRoles-BetaRoleBulkDeleteRequest $Result
@@ -322,11 +317,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-role
This API deletes a Role by its ID.
A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
@@ -337,7 +329,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the Role
### Return type
(empty response body)
### Responses
@@ -351,14 +342,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-BetaRole-BetaId $Id
@@ -369,11 +361,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role
This API returns a Role by its ID.
A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
@@ -383,7 +372,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the Role
### Return type
[**Role**](../models/role)
### Responses
@@ -397,14 +385,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-BetaRole-BetaId $Id
@@ -415,13 +404,10 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-assigned-identities
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -433,7 +419,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
@@ -447,7 +432,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
@@ -459,7 +443,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)
# Identities assigned a Role
try {
Get-BetaRoleAssignedIdentities-BetaId $Id
@@ -470,11 +456,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-entitlements
This API lists the Entitlements associated with a given role.
A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
@@ -490,7 +473,6 @@ Path | Id | **String** | True | ID of the containing role
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
@@ -504,7 +486,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
@@ -516,7 +497,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* (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 role's Entitlements
try {
Get-BetaRoleEntitlements-BetaId $Id
@@ -527,11 +510,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-roles
This API returns a list of Roles.
A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
@@ -549,7 +529,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
@@ -563,7 +542,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
@@ -577,7 +555,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-BetaRoles
@@ -588,11 +568,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:
@@ -622,7 +599,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
@@ -636,21 +612,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-BetaRole-BetaId $Id -BetaJsonPatchOperation $Result
@@ -662,7 +638,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-sim-integrations
title: SIMIntegrations
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/sim-integrations
tags: ['SDK', 'Software Development Kit', 'SIMIntegrations', 'BetaSIMIntegrations']
---
# SIMIntegrations
Use this API to administer IdentityNow's Service Integration Module, or SIM integration with ServiceNow, so that it converts IdentityNow provisioning actions into tickets in ServiceNow.
@@ -33,9 +33,7 @@ Method | HTTP request | Description
[**Update-BetaSIMAttributes**](#patch-sim-attributes) | **PATCH** `/sim-integrations/{id}` | Patch a SIM attribute.
[**Send-BetaSIMIntegration**](#put-sim-integration) | **PUT** `/sim-integrations/{id}` | Update an existing SIM integration
## create-sim-integration
Create a new SIM Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
### Parameters
@@ -44,7 +42,6 @@ Param Type | Name | Data Type | Required | Description
Body | SimIntegrationDetails | [**SimIntegrationDetails**](../models/sim-integration-details) | True | DTO containing the details of the SIM integration
### Return type
[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto)
### 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
@@ -83,7 +79,9 @@ $SimIntegrationDetails = @"{
"type" : "IDENTITY"
}
}"@
# Create new SIM integration
try {
$Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails
New-BetaSIMIntegration-BetaSimIntegrationDetails $Result
@@ -95,11 +93,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-sim-integration
Get the details of a SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
### Parameters
@@ -108,7 +103,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The id of the integration 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 = "12345" # String | The id of the integration to delete.
# Delete a SIM integration
try {
Remove-BetaSIMIntegration-BetaId $Id
@@ -141,11 +136,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sim-integration
Get the details of a SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
### Parameters
@@ -154,7 +146,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The id of the integration.
### Return type
[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto)
### 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 = "12345" # String | The id of the integration.
# Get a SIM integration details.
try {
Get-BetaSIMIntegration-BetaId $Id
@@ -187,11 +179,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sim-integrations
List the existing SIM integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
### Parameters
@@ -199,7 +188,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto)
### Responses
@@ -214,13 +202,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 the existing SIM integrations.
try {
Get-BetaSIMIntegrations
@@ -231,11 +220,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-before-provisioning-rule
Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
### Parameters
@@ -245,7 +231,6 @@ Path | Id | **String** | True | SIM integration id
Body | JsonPatch | [**JsonPatch**](../models/json-patch) | True | The JsonPatch object that describes the changes of SIM beforeProvisioningRule.
### Return type
[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto)
### Responses
@@ -260,7 +245,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
@@ -268,7 +252,9 @@ Code | Description | Data Type
```powershell
$Id = "12345" # String | SIM integration id
$JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]""@
# Patch a SIM beforeProvisioningRule attribute.
try {
$Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch
Update-BetaBeforeProvisioningRule-BetaId $Id -BetaJsonPatch $Result
@@ -280,11 +266,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-sim-attributes
Patch a SIM attribute given a JsonPatch object. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
### Parameters
@@ -294,7 +277,6 @@ Path | Id | **String** | True | SIM integration id
Body | JsonPatch | [**JsonPatch**](../models/json-patch) | True | The JsonPatch object that describes the changes of SIM
### Return type
[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto)
### Responses
@@ -309,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-patch+json
- **Accept**: application/json
@@ -317,7 +298,9 @@ Code | Description | Data Type
```powershell
$Id = "12345" # String | SIM integration id
$JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]""@
# Patch a SIM attribute.
try {
$Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch
Update-BetaSIMAttributes-BetaId $Id -BetaJsonPatch $Result
@@ -329,11 +312,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-sim-integration
Update an existing SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
### Parameters
@@ -343,7 +323,6 @@ Path | Id | **String** | True | The id of the integration.
Body | SimIntegrationDetails | [**SimIntegrationDetails**](../models/sim-integration-details) | True | The full DTO of the integration containing the updated model
### Return type
[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto)
### Responses
@@ -358,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
@@ -383,7 +361,9 @@ $SimIntegrationDetails = @"{
"type" : "IDENTITY"
}
}"@
# Update an existing SIM integration
try {
$Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails
Send-BetaSIMIntegration-BetaId $Id -BetaSimIntegrationDetails $Result
@@ -395,7 +375,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-sod-policies
title: SODPolicies
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/sod-policies
tags: ['SDK', 'Software Development Kit', 'SODPolicies', 'BetaSODPolicies']
---
# SODPolicies
Use this API to implement and manage "separation of duties" (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.
@@ -61,9 +61,7 @@ Method | HTTP request | Description
[**Start-BetaSodAllPoliciesForOrg**](#start-sod-all-policies-for-org) | **POST** `/sod-violation-report/run` | Runs all policies for org
[**Start-BetaSodPolicy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report
## create-sod-policy
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.
@@ -73,7 +71,6 @@ Param Type | Name | Data Type | Required | Description
Body | SodPolicy | [**SodPolicy**](../models/sod-policy) | True |
### Return type
[**SodPolicy**](../models/sod-policy)
### 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
@@ -149,7 +145,9 @@ $SodPolicy = @"{
"state" : "ENFORCED",
"externalPolicyReference" : "XYZ policy"
}"@
# Create SOD policy
try {
$Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy
New-BetaSodPolicy-BetaSodPolicy $Result
@@ -161,11 +159,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-sod-policy
This deletes a specified SOD policy.
Requires role of ORG_ADMIN.
@@ -176,7 +171,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.
### Return type
(empty response body)
### Responses
@@ -191,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
@@ -199,7 +192,9 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # 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. (optional) (default to $true)
# Delete SOD policy by ID
try {
Remove-BetaSodPolicy-BetaId $Id
@@ -210,11 +205,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-sod-policy-schedule
This deletes schedule for a specified SOD policy.
Requires role of ORG_ADMIN.
@@ -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 = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for.
# Delete SOD policy schedule
try {
Remove-BetaSodPolicySchedule-BetaId $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.
Requires role of ORG_ADMIN.
@@ -272,7 +261,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
@@ -287,7 +275,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
@@ -295,7 +282,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-BetaCustomViolationReport-BetaReportResultId $ReportResultId -BetaFileName $FileName
@@ -306,11 +295,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-default-violation-report
This allows to download a violation report for a given report reference.
Requires role of ORG_ADMIN.
@@ -320,7 +306,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
@@ -335,14 +320,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-BetaDefaultViolationReport-BetaReportResultId $ReportResultId
@@ -353,11 +339,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.
Requires role of ORG_ADMIN.
@@ -366,7 +349,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**ReportResultReference**](../models/report-result-reference)
### Responses
@@ -380,13 +362,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-BetaSodAllReportRunStatus
@@ -397,11 +380,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sod-policy
This gets specified SOD policy.
Requires role of ORG_ADMIN.
@@ -411,7 +391,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The ID of the object reference to retrieve.
### Return type
[**SodPolicy**](../models/sod-policy)
### Responses
@@ -426,14 +405,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 object reference to retrieve.
# Get SOD policy by ID
try {
Get-BetaSodPolicy-BetaId $Id
@@ -444,11 +424,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sod-policy-schedule
This endpoint gets a specified SOD policy's schedule.
Requires the role of ORG_ADMIN.
@@ -458,7 +435,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The ID of the object reference to retrieve.
### Return type
[**SodPolicySchedule**](../models/sod-policy-schedule)
### Responses
@@ -472,14 +448,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 object reference to retrieve.
# Get SOD policy schedule
try {
Get-BetaSodPolicySchedule-BetaId $Id
@@ -490,11 +467,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.
Requires role of ORG_ADMIN.
@@ -504,7 +478,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
@@ -519,14 +492,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-BetaSodViolationReportRunStatus-BetaReportResultId $ReportResultId
@@ -537,11 +511,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.
Requires role of ORG_ADMIN.
@@ -551,7 +522,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The ID of the object reference to retrieve.
### Return type
[**ReportResultReference**](../models/report-result-reference)
### Responses
@@ -566,14 +536,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 object reference to retrieve.
# Get SOD violation report status
try {
Get-BetaSodViolationReportStatus-BetaId $Id
@@ -584,11 +555,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-sod-policies
This gets list of all SOD policies.
Requires role of ORG_ADMIN
@@ -602,7 +570,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
@@ -616,7 +583,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
@@ -627,7 +593,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-BetaSodPolicies
@@ -638,11 +606,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.
@@ -654,7 +619,6 @@ Path | Id | **String** | True | The ID of the SOD policy being modified.
Body | RequestBody | [**[]SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | 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
@@ -669,7 +633,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
@@ -677,9 +640,11 @@ Code | Description | Data Type
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | The ID of the SOD policy being modified.
$RequestBody = # SystemCollectionsHashtable[] | 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
$RequestBody = @"[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]"@
$RequestBody = @"[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]"@ # SystemCollectionsHashtable[] | 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 a SOD policy
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Update-BetaSodPolicy-BetaId $Id -BetaRequestBody $Result
@@ -691,11 +656,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-policy-schedule
This updates schedule for a specified SOD policy.
Requires role of ORG_ADMIN.
@@ -706,7 +668,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
@@ -720,7 +681,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
@@ -813,7 +773,9 @@ $SodPolicySchedule = @"{
"description" : "Schedule for policy xyz",
"emailEmptyResults" : false
}"@
# Update SOD Policy schedule
try {
$Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule
Send-BetaPolicySchedule-BetaId $Id -BetaSodPolicySchedule $Result
@@ -825,11 +787,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-sod-policy
This updates a specified SOD policy.
Requires role of ORG_ADMIN.
@@ -840,7 +799,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
@@ -855,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
@@ -918,7 +875,9 @@ $SodPolicy = @"{
"state" : "ENFORCED",
"externalPolicyReference" : "XYZ policy"
}"@
# Update SOD policy by ID
try {
$Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy
Send-BetaSodPolicy-BetaId $Id -BetaSodPolicy $Result
@@ -930,11 +889,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.
Requires role of ORG_ADMIN.
@@ -944,7 +900,6 @@ Param Type | Name | Data Type | Required | Description
Body | MultiPolicyRequest | [**MultiPolicyRequest**](../models/multi-policy-request) | (optional) |
### Return type
[**ReportResultReference**](../models/report-result-reference)
### Responses
@@ -958,7 +913,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
@@ -967,7 +921,9 @@ Code | Description | Data Type
$MultiPolicyRequest = @"{
"filteredPolicyList" : [ "filteredPolicyList", "filteredPolicyList" ]
}"@
# Runs all policies for org
try {
Start-BetaSodAllPoliciesForOrg
@@ -978,11 +934,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.
Requires role of ORG_ADMIN.
@@ -992,7 +945,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
@@ -1007,14 +959,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 SOD policy ID to run.
# Runs SOD policy violation report
try {
Start-BetaSodPolicy-BetaId $Id
@@ -1025,7 +978,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-sod-violations
title: SODViolations
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/sod-violations
tags: ['SDK', 'Software Development Kit', 'SODViolations', 'BetaSODViolations']
---
# SODViolations
Use this API to check for current "separation of duties" (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.
@@ -38,9 +38,7 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Start-BetaPredictSodViolations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict SOD violations for identity.
## 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.
A token with ORG_ADMIN or API authority is required to call this API.
@@ -51,7 +49,6 @@ Param Type | Name | Data Type | Required | Description
Body | IdentityWithNewAccess | [**IdentityWithNewAccess**](../models/identity-with-new-access) | True |
### Return type
[**ViolationPrediction**](../models/violation-prediction)
### 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
@@ -84,7 +80,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-BetaPredictSodViolations-BetaIdentityWithNewAccess $Result
@@ -96,7 +94,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-sp-config
title: SPConfig
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/sp-config
tags: ['SDK', 'Software Development Kit', 'SPConfig', 'BetaSPConfig']
---
# SPConfig
Import and export configuration for some objects between tenants.
@@ -26,9 +26,7 @@ Method | HTTP request | Description
[**Import-BetaSpConfig**](#import-sp-config) | **POST** `/sp-config/import` | Initiates configuration objects import job
[**Get-BetaSpConfigObjects**](#list-sp-config-objects) | **GET** `/sp-config/config-objects` | Get config object details
## export-sp-config
This post will export objects from the tenant to a JSON configuration file.
For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
@@ -38,7 +36,6 @@ Param Type | Name | Data Type | Required | Description
Body | ExportPayload | [**ExportPayload**](../models/export-payload) | True | Export options control what will be included in the export.
### Return type
[**SpConfigExportJob**](../models/sp-config-export-job)
### 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
@@ -62,7 +58,9 @@ Code | Description | Data Type
$ExportPayload = @"{
"description" : "Export Job 1 Test"
}"@
# Initiates configuration objects export job
try {
$Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload
Export-BetaSpConfig-BetaExportPayload $Result
@@ -74,11 +72,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sp-config-export
This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file.
The request will need one of the following security scopes:
- sp:config:read - sp:config:manage
@@ -89,7 +84,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The ID of the export job whose results will be downloaded.
### Return type
[**SpConfigExportResults**](../models/sp-config-export-results)
### 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 = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded.
# Download export job result.
try {
Get-BetaSpConfigExport-BetaId $Id
@@ -122,11 +117,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sp-config-export-status
This gets the status of the export job identified by the `id` parameter.
The request will need one of the following security scopes:
- sp:config:read - sp:config:manage
@@ -137,7 +129,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The ID of the export job whose status will be returned.
### Return type
[**SpConfigExportJobStatus**](../models/sp-config-export-job-status)
### Responses
@@ -152,14 +143,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 export job whose status will be returned.
# Get export job status
try {
Get-BetaSpConfigExportStatus-BetaId $Id
@@ -170,11 +162,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sp-config-import
This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import.
The request will need the following security scope:
- sp:config:manage
@@ -185,7 +174,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The ID of the import job whose results will be downloaded.
### Return type
[**SpConfigImportResults**](../models/sp-config-import-results)
### Responses
@@ -200,14 +188,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 import job whose results will be downloaded.
# Download import job result
try {
Get-BetaSpConfigImport-BetaId $Id
@@ -218,11 +207,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sp-config-import-status
This gets the status of the import job identified by the `id` parameter.
For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
@@ -232,7 +218,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The ID of the import job whose status will be returned.
### Return type
[**SpConfigImportJobStatus**](../models/sp-config-import-job-status)
### 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 = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned.
# Get import job status
try {
Get-BetaSpConfigImportStatus-BetaId $Id
@@ -265,11 +251,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## import-sp-config
This post will import objects from a JSON configuration file into a tenant.
By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted.
The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed.
@@ -290,7 +273,6 @@ Param Type | Name | Data Type | Required | Description
| Options | [**ImportOptions**](../models/import-options) | (optional) |
### Return type
[**SpConfigJob**](../models/sp-config-job)
### Responses
@@ -305,7 +287,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
@@ -314,7 +295,9 @@ Code | Description | Data Type
$Data = # System.IO.FileInfo | JSON file containing the objects to be imported.
$Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false)
$Options = @""@
# Initiates configuration objects import job
try {
Import-BetaSpConfig-BetaData $Data
@@ -325,11 +308,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-sp-config-objects
This gets the list of object configurations which are known to the tenant export/import service. Object configurations that contain "importUrl" and "exportUrl" are available for export/import.
### Parameters
@@ -337,7 +317,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**SpConfigObject[]**](../models/sp-config-object)
### Responses
@@ -352,13 +331,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 config object details
try {
Get-BetaSpConfigObjects
@@ -369,7 +349,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-search-attribute-configuration
title: SearchAttributeConfiguration
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/search-attribute-configuration
tags: ['SDK', 'Software Development Kit', 'SearchAttributeConfiguration', 'BetaSearchAttributeConfiguration']
---
# 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-BetaSingleSearchAttributeConfig**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute
[**Update-BetaSearchAttributeConfig**](#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute
## create-search-attribute-config
Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create and attribute promotion configuration in the Link ObjectConfig.
A token with ORG_ADMIN authority is required to call this API.
@@ -54,7 +52,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
@@ -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
@@ -83,7 +79,9 @@ $SearchAttributeConfig = @"{
"2c91808b79fd2422017a0b36008f396b" : "employeeNumber"
}
}"@
# Create Extended Search Attributes
try {
$Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig
New-BetaSearchAttributeConfig-BetaSearchAttributeConfig $Result
@@ -95,11 +93,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-search-attribute-config
Delete an extended attribute configuration by name.
### Parameters
@@ -108,7 +103,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-BetaSearchAttributeConfig-BetaName $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).
A token with ORG_ADMIN authority is required to call this API.
@@ -153,7 +145,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-BetaSearchAttributeConfig
@@ -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 get.
### Return type
[**SearchAttributeConfig[]**](../models/search-attribute-config)
### Responses
@@ -211,14 +199,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 get.
# Get Extended Search Attribute
try {
Get-BetaSingleSearchAttributeConfig-BetaName $Name
@@ -229,11 +218,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
@@ -245,7 +231,6 @@ Path | Name | **String** | True | Name of the extended search attribute confi
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True |
### Return type
[**SearchAttributeConfig**](../models/search-attribute-config)
### Responses
@@ -260,21 +245,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 extended 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-BetaSearchAttributeConfig-BetaName $Name -BetaJsonPatchOperation $Result
@@ -286,7 +271,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-segments
title: Segments
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/segments
tags: ['SDK', 'Software Development Kit', 'Segments', 'BetaSegments']
---
# 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-BetaSegments**](#list-segments) | **GET** `/segments` | List Segments
[**Update-BetaSegment**](#patch-segment) | **PATCH** `/segments/{id}` | Update Segment
## create-segment
This API creates a segment.
>**Note:** Segment definitions may take time to propagate to all identities.
A token with ORG_ADMIN or API authority is required to call this API.
@@ -54,7 +52,6 @@ Param Type | Name | Data Type | Required | Description
Body | Segment | [**Segment**](../models/segment) | True |
### Return type
[**Segment**](../models/segment)
### 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
@@ -98,7 +94,9 @@ $Segment = @"{
"active" : true,
"id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"
}"@
# Create Segment
try {
$Result = ConvertFrom-JsonToSegment -Json $Segment
New-BetaSegment-BetaSegment $Result
@@ -110,11 +108,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-segment
This API deletes the segment specified by the given ID.
>**Note:** Segment deletion may take some time to go into effect.
A token with ORG_ADMIN or API authority is required to call this API.
@@ -125,7 +120,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The segment ID to delete.
### Return type
(empty response body)
### Responses
@@ -140,14 +134,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-BetaSegment-BetaId $Id
@@ -158,11 +153,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-segment
This API returns the segment specified by the given ID.
A token with ORG_ADMIN or API authority is required to call this API.
@@ -172,7 +164,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The segment ID to retrieve.
### Return type
[**Segment**](../models/segment)
### Responses
@@ -187,14 +178,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-BetaSegment-BetaId $Id
@@ -205,11 +197,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-segments
This API returns a list of all segments.
A token with ORG_ADMIN or API authority is required to call this API.
@@ -221,7 +210,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
@@ -235,7 +223,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
@@ -244,7 +231,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-BetaSegments
@@ -255,11 +244,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.
A token with ORG_ADMIN or API authority is required to call this API.
@@ -271,7 +257,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
@@ -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**: application/json-patch+json
- **Accept**: application/json
@@ -294,9 +278,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-BetaSegment-BetaId $Id -BetaRequestBody $Result
@@ -308,7 +294,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-service-desk-integration
title: ServiceDeskIntegration
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/service-desk-integration
tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegration', 'BetaServiceDeskIntegration']
---
# 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-BetaServiceDeskIntegration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a Service Desk integration
[**Update-BetaStatusCheckDetails**](#update-status-check-details) | **PUT** `/service-desk-integrations/status-check-configuration` | Update the time check configuration
## create-service-desk-integration
Create a new Service Desk integration.
### 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
@@ -116,7 +112,9 @@ $ServiceDeskIntegrationDto = @"{
"type" : "ServiceNowSDIM",
"beforeProvisioningRule" : ""
}"@
# Create new Service Desk integration
try {
$Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto
New-BetaServiceDeskIntegration-BetaServiceDeskIntegrationDto $Result
@@ -128,11 +126,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-service-desk-integration
Delete an existing Service Desk integration by ID.
### Parameters
@@ -141,7 +136,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
@@ -156,14 +150,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-BetaServiceDeskIntegration-BetaId $Id
@@ -174,11 +169,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-service-desk-integration
Get an existing Service Desk integration by ID.
### Parameters
@@ -187,7 +179,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
@@ -202,14 +193,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-BetaServiceDeskIntegration-BetaId $Id
@@ -220,11 +212,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-service-desk-integration-list
Get a list of Service Desk integration objects.
### Parameters
@@ -237,7 +226,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
@@ -252,7 +240,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
@@ -263,7 +250,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 = 'id eq 2c91808b6ef1d43e016efba0ce470904' # 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-BetaServiceDeskIntegrationList
@@ -274,11 +263,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
@@ -287,7 +273,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
@@ -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
$ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get
# Service Desk integration template by scriptName
try {
Get-BetaServiceDeskIntegrationTemplate-BetaScriptName $ScriptName
@@ -320,11 +306,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
@@ -332,7 +315,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**ServiceDeskIntegrationTemplateType[]**](../models/service-desk-integration-template-type)
### Responses
@@ -347,13 +329,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-BetaServiceDeskIntegrationTypes
@@ -364,11 +347,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-status-check-details
Get the time check configuration of queued SDIM tickets.
### Parameters
@@ -376,7 +356,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**QueuedCheckConfigDetails**](../models/queued-check-config-details)
### Responses
@@ -391,13 +370,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-BetaStatusCheckDetails
@@ -408,11 +388,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
@@ -422,7 +399,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
@@ -437,7 +413,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
@@ -445,7 +420,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-BetaServiceDeskIntegration-BetaId $Id -BetaPatchServiceDeskIntegrationRequest $Result
@@ -457,11 +434,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-service-desk-integration
Update an existing Service Desk integration by ID.
### Parameters
@@ -471,7 +445,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
@@ -486,7 +459,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
@@ -524,7 +496,9 @@ $ServiceDeskIntegrationDto = @"{
"type" : "ServiceNowSDIM",
"beforeProvisioningRule" : ""
}"@
# Update a Service Desk integration
try {
$Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto
Send-BetaServiceDeskIntegration-BetaId $Id -BetaServiceDeskIntegrationDto $Result
@@ -536,11 +510,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-status-check-details
Update the time check configuration of queued SDIM tickets.
### Parameters
@@ -549,7 +520,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
@@ -564,7 +534,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
@@ -574,7 +543,9 @@ $QueuedCheckConfigDetails = @"{
"provisioningStatusCheckIntervalMinutes" : "30",
"provisioningMaxStatusCheckDays" : "2"
}"@
# Update the time check configuration
try {
$Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails
Update-BetaStatusCheckDetails-BetaQueuedCheckConfigDetails $Result
@@ -586,7 +557,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-source-usages
title: SourceUsages
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/source-usages
tags: ['SDK', 'Software Development Kit', 'SourceUsages', 'BetaSourceUsages']
---
# 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' sources are being used.
@@ -24,9 +24,7 @@ Method | HTTP request | Description
[**Get-BetaStatusBySourceId**](#get-status-by-source-id) | **GET** `/source-usages/{sourceId}/status` | Finds status of source usage
[**Get-BetaUsagesBySourceId**](#get-usages-by-source-id) | **GET** `/source-usages/{sourceId}/summaries` | Returns source usage insights
## get-status-by-source-id
This API returns the status of the source usage insights setup by IDN source ID.
### 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-BetaStatusBySourceId-BetaSourceId $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-BetaUsagesBySourceId-BetaSourceId $SourceId
@@ -120,7 +115,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

File diff suppressed because it is too large Load Diff

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

@@ -1,3 +1,4 @@
---
id: beta-suggested-entitlement-description
title: SuggestedEntitlementDescription
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/suggested-entitlement-description
tags: ['SDK', 'Software Development Kit', 'SuggestedEntitlementDescription', 'BetaSuggestedEntitlementDescription']
---
# SuggestedEntitlementDescription
Use this API to implement Suggested Entitlement Description (SED) functionality.
SED functionality leverages the power of LLM to generate suggested entitlement descriptions.
@@ -29,9 +29,7 @@ Method | HTTP request | Description
[**Submit-BetaSedAssignment**](#submit-sed-assignment) | **POST** `/suggested-entitlement-description-assignments` | Submit Sed Assignment Request
[**Submit-BetaSedBatchRequest**](#submit-sed-batch-request) | **POST** `/suggested-entitlement-description-batches` | Submit Sed Batch Request
## get-sed-batch-stats
Submit Sed Batch Stats Request.
Submits batchId in the path param `(e.g. {batchId}/stats)`.
@@ -44,7 +42,6 @@ Param Type | Name | Data Type | Required | Description
Path | BatchId | **String** | True | Batch Id
### Return type
[**SedBatchStats**](../models/sed-batch-stats)
### Responses
@@ -59,14 +56,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
$BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id
# Submit Sed Batch Stats Request
try {
Get-BetaSedBatchStats-BetaBatchId $BatchId
@@ -77,11 +75,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sed-batches
List Sed Batches.
API responses with Sed Batch Status
@@ -90,7 +85,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**SedBatchStatus**](../models/sed-batch-status)
### 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
# List Sed Batch Request
try {
Get-BetaSedBatches
@@ -122,11 +117,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-seds
List of Suggested Entitlement Descriptions (SED)
SED field descriptions:
@@ -155,7 +147,6 @@ Param Type | Name | Data Type | Required | Description
Query | ShowPendingStatusOnly | **Boolean** | (optional) | Will limit records to items that are in ""suggested"" or ""approved"" status
### Return type
[**Sed[]**](../models/sed)
### 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
@@ -183,7 +173,9 @@ $Count = $false # Boolean | If `true` it will populate the `X-Total-Count` respo
$CountOnly = $false # 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. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. (optional)
$RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional)
$ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional)
# List Suggested Entitlement Descriptions
try {
Get-BetaSeds
@@ -194,11 +186,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-sed
Patch Suggested Entitlement Description
### Parameters
@@ -208,7 +197,6 @@ Path | Id | **String** | True | id is sed id
Body | SedPatch | [**[]SedPatch**](../models/sed-patch) | True | Sed Patch Request
### Return type
[**Sed**](../models/sed)
### Responses
@@ -223,21 +211,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 = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id
# SedPatch[] | Sed Patch Request
$SedPatch = @"{
"op" : "replace",
"path" : "status",
"value" : "approved"
}"@
}"@ # SedPatch[] | Sed Patch Request
# Patch Suggested Entitlement Description
try {
$Result = ConvertFrom-JsonToSedPatch -Json $SedPatch
Update-BetaSed-BetaId $Id -BetaSedPatch $Result
@@ -249,11 +237,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## submit-sed-approval
Submit Bulk Approval Request for SED.
Request body takes list of SED Ids. API responses with list of SED Approval Status
@@ -263,7 +248,6 @@ Param Type | Name | Data Type | Required | Description
Body | SedApproval | [**[]SedApproval**](../models/sed-approval) | True | Sed Approval
### Return type
[**SedApprovalStatus[]**](../models/sed-approval-status)
### Responses
@@ -278,18 +262,18 @@ 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
# SedApproval[] | Sed Approval
$SedApproval = @"{
"items" : "016629d1-1d25-463f-97f3-c6686846650"
}"@
}"@ # SedApproval[] | Sed Approval
# Submit Bulk Approval Request
try {
$Result = ConvertFrom-JsonToSedApproval -Json $SedApproval
Submit-BetaSedApproval-BetaSedApproval $Result
@@ -301,11 +285,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## submit-sed-assignment
Submit Assignment Request.
Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together
@@ -315,7 +296,6 @@ Param Type | Name | Data Type | Required | Description
Body | SedAssignment | [**SedAssignment**](../models/sed-assignment) | True | Sed Assignment Request
### Return type
[**SedAssignmentResponse**](../models/sed-assignment-response)
### Responses
@@ -330,7 +310,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
@@ -343,7 +322,9 @@ $SedAssignment = @"{
},
"items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ]
}"@
# Submit Sed Assignment Request
try {
$Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment
Submit-BetaSedAssignment-BetaSedAssignment $Result
@@ -355,11 +336,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## submit-sed-batch-request
Submit Sed Batch Request.
Request body has one of the following:
- a list of entitlement Ids
@@ -372,7 +350,6 @@ Param Type | Name | Data Type | Required | Description
Body | SedBatchRequest | [**SedBatchRequest**](../models/sed-batch-request) | (optional) | Sed Batch Request
### Return type
[**SedBatchResponse**](../models/sed-batch-response)
### Responses
@@ -387,7 +364,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
@@ -397,7 +373,9 @@ $SedBatchRequest = @"{
"entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ],
"seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ]
}"@
# Submit Sed Batch Request
try {
Submit-BetaSedBatchRequest
@@ -408,7 +386,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-tagged-objects
title: TaggedObjects
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/tagged-objects
tags: ['SDK', 'Software Development Kit', 'TaggedObjects', 'BetaTaggedObjects']
---
# 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-BetaTagToObject**](#set-tag-to-object) | **POST** `/tagged-objects` | Add Tag to Object
[**Set-BetaTagsToManyObjects**](#set-tags-to-many-objects) | **POST** `/tagged-objects/bulk-add` | Tag Multiple Objects
## delete-tagged-object
Delete all tags from a tagged object.
### 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-BetaTaggedObject-BetaType $Type -BetaId $Id
@@ -125,11 +123,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-tags-to-many-object
This API removes tags from multiple objects.
A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
@@ -140,7 +135,6 @@ Param Type | Name | Data Type | Required | Description
Body | BulkTaggedObject | [**BulkTaggedObject**](../models/bulk-tagged-object) | True | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
### Return type
(empty response body)
### Responses
@@ -154,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
@@ -173,7 +166,9 @@ $BulkTaggedObject = @"{
"operation" : "MERGE",
"tags" : [ "BU_FINANCE", "PCI" ]
}"@
# Remove Tags from Multiple Objects
try {
$Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject
Remove-BetaTagsToManyObject-BetaBulkTaggedObject $Result
@@ -185,11 +180,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-tagged-object
This gets a tagged object for the specified type.
### Parameters
@@ -199,7 +191,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
@@ -213,7 +204,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
@@ -221,7 +211,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-BetaTaggedObject-BetaType $Type -BetaId $Id
@@ -232,11 +224,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.
@@ -250,7 +239,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
@@ -264,7 +252,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
@@ -274,7 +261,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-BetaTaggedObjects
@@ -285,11 +274,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.
@@ -304,7 +290,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
@@ -318,7 +303,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
@@ -329,7 +313,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-BetaTaggedObjectsByType-BetaType $Type
@@ -340,11 +326,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-tagged-object
This updates a tagged object for the specified type.
### Parameters
@@ -355,7 +338,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
@@ -369,7 +351,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
@@ -385,7 +366,9 @@ $TaggedObject = @"{
},
"tags" : [ "BU_FINANCE", "PCI" ]
}"@
# Update Tagged Object
try {
$Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject
Send-BetaTaggedObject-BetaType $Type -BetaId $Id -BetaTaggedObject $Result
@@ -397,11 +380,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.
@@ -412,7 +392,6 @@ Param Type | Name | Data Type | Required | Description
Body | TaggedObject | [**TaggedObject**](../models/tagged-object) | True |
### Return type
(empty response body)
### Responses
@@ -426,7 +405,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
@@ -440,7 +418,9 @@ $TaggedObject = @"{
},
"tags" : [ "BU_FINANCE", "PCI" ]
}"@
# Add Tag to Object
try {
$Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject
Set-BetaTagToObject-BetaTaggedObject $Result
@@ -452,11 +432,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-tags-to-many-objects
This API adds tags to multiple objects.
A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
@@ -467,7 +444,6 @@ Param Type | Name | Data Type | Required | Description
Body | BulkTaggedObject | [**BulkTaggedObject**](../models/bulk-tagged-object) | True | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
### Return type
[**BulkTaggedObject**](../models/bulk-tagged-object)
### Responses
@@ -481,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
@@ -500,7 +475,9 @@ $BulkTaggedObject = @"{
"operation" : "MERGE",
"tags" : [ "BU_FINANCE", "PCI" ]
}"@
# Tag Multiple Objects
try {
$Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject
Set-BetaTagsToManyObjects-BetaBulkTaggedObject $Result
@@ -512,7 +489,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-tags
title: Tags
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/tags
tags: ['SDK', 'Software Development Kit', 'Tags', 'BetaTags']
---
# Tags
@@ -23,9 +23,7 @@ Method | HTTP request | Description
[**Get-BetaTagById**](#get-tag-by-id) | **GET** `/tags/{id}` | Get Tag By Id
[**Get-BetaTags**](#list-tags) | **GET** `/tags` | List Tags
## create-tag
This API creates new tag.
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
@@ -36,7 +34,6 @@ Param Type | Name | Data Type | Required | Description
Body | Tag | [**Tag**](../models/tag) | True |
### Return type
[**Tag**](../models/tag)
### 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
@@ -71,7 +67,9 @@ $Tag = @"{
"modified" : "2022-07-14T16:31:11Z",
"id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f"
}"@
# Create Tag
try {
$Result = ConvertFrom-JsonToTag -Json $Tag
New-BetaTag-BetaTag $Result
@@ -83,11 +81,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-tag-by-id
This API deletes a tag by specified id.
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
@@ -98,7 +93,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The ID of the object reference to delete.
### Return type
(empty response body)
### Responses
@@ -113,14 +107,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 = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to delete.
# Delete Tag
try {
Remove-BetaTagById-BetaId $Id
@@ -131,11 +126,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-tag-by-id
Returns a tag by its id.
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
@@ -146,7 +138,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The ID of the object reference to retrieve.
### Return type
[**Tag**](../models/tag)
### 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 = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to retrieve.
# Get Tag By Id
try {
Get-BetaTagById-BetaId $Id
@@ -179,11 +171,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-tags
This API returns a list of tags.
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
@@ -198,7 +187,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**
### Return type
[**Tag[]**](../models/tag)
### Responses
@@ -212,7 +200,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
@@ -223,7 +210,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 "27462f54-61c7-4140-b5da-d5dbe27fc6db"' # 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,-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: **id, name, created, modified** (optional)
# List Tags
try {
Get-BetaTags
@@ -234,7 +223,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-task-management
title: TaskManagement
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/task-management
tags: ['SDK', 'Software Development Kit', 'TaskManagement', 'BetaTaskManagement']
---
# TaskManagement
@@ -24,9 +24,7 @@ Method | HTTP request | Description
[**Get-BetaTaskStatusList**](#get-task-status-list) | **GET** `/task-status` | Retrieve Task Status List
[**Update-BetaTaskStatus**](#update-task-status) | **PATCH** `/task-status/{id}` | Update Task Status by ID
## get-pending-task-headers
Responds with headers only for list of task statuses for pending tasks.
### Parameters
@@ -37,7 +35,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
(empty response body)
### 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
@@ -61,7 +57,9 @@ Code | Description | Data Type
$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)
# Retrieve Pending Task List Headers
try {
Get-BetaPendingTaskHeaders
@@ -72,11 +70,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-pending-tasks
Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned.
### Parameters
@@ -87,7 +82,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
[**TaskStatus[]**](../models/task-status)
### Responses
@@ -102,7 +96,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
@@ -111,7 +104,9 @@ Code | Description | Data Type
$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)
# Retrieve Pending Task Status List
try {
Get-BetaPendingTasks
@@ -122,11 +117,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-task-status
Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned.
### Parameters
@@ -135,7 +127,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Task ID.
### Return type
[**TaskStatus**](../models/task-status)
### 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 = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID.
# Get Task Status by ID
try {
Get-BetaTaskStatus-BetaId $Id
@@ -168,11 +160,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-task-status-list
Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/beta/get-pending-tasks) endpoint.
@@ -186,7 +175,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**
### Return type
[**TaskStatus[]**](../models/task-status)
### Responses
@@ -201,7 +189,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
@@ -212,7 +199,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 = 'completionStatus eq "Success"' # 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* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (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** (optional)
# Retrieve Task Status List
try {
Get-BetaTaskStatusList
@@ -223,11 +212,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-task-status
Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes.
### Parameters
@@ -237,7 +223,6 @@ Path | Id | **String** | True | Task ID.
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | The JSONPatch payload used to update the object.
### Return type
[**TaskStatus**](../models/task-status)
### Responses
@@ -252,21 +237,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 = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID.
# JsonPatchOperation[] | The JSONPatch payload used to update the object.
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] | The JSONPatch payload used to update the object.
# Update Task Status by ID
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-BetaTaskStatus-BetaId $Id -BetaJsonPatchOperation $Result
@@ -278,7 +263,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-tenant
title: Tenant
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/tenant
tags: ['SDK', 'Software Development Kit', 'Tenant', 'BetaTenant']
---
# Tenant
API for reading tenant details.
@@ -20,9 +20,7 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaTenant**](#get-tenant) | **GET** `/tenant` | Get Tenant Information.
## get-tenant
This rest endpoint can be used to retrieve tenant details.
### Parameters
@@ -30,7 +28,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**Tenant**](../models/tenant)
### Responses
@@ -45,13 +42,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 Tenant Information.
try {
Get-BetaTenant
@@ -62,7 +60,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-transforms
title: Transforms
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/transforms
tags: ['SDK', 'Software Development Kit', 'Transforms', 'BetaTransforms']
---
# Transforms
Operations for creating, managing, and deleting transforms.
@@ -24,9 +24,7 @@ Method | HTTP request | Description
[**Get-BetaTransforms**](#list-transforms) | **GET** `/transforms` | List transforms
[**Update-BetaTransform**](#update-transform) | **PUT** `/transforms/{id}` | Update a transform
## create-transform
Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. A token with transform write authority is required to call this API.
### Parameters
@@ -35,7 +33,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
@@ -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
@@ -77,7 +73,9 @@ $Transform = @"{
},
"type" : "dateFormat"
}"@
# Create transform
try {
$Result = ConvertFrom-JsonToTransform -Json $Transform
New-BetaTransform-BetaTransform $Result
@@ -89,11 +87,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.
A token with transform delete authority is required to call this API.
@@ -103,7 +98,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the transform to delete
### Return type
(empty response body)
### Responses
@@ -118,14 +112,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-BetaTransform-BetaId $Id
@@ -136,11 +131,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-transform
This API returns the transform specified by the given ID.
A token with transform read authority is required to call this API.
@@ -150,7 +142,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
@@ -165,14 +156,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-BetaTransform-BetaId $Id
@@ -183,11 +175,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-transforms
Gets a list of all saved transform objects.
A token with transforms-list read authority is required to call this API.
@@ -201,7 +190,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
@@ -216,7 +204,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
@@ -227,7 +214,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-BetaTransforms
@@ -238,11 +227,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.
A token with transform write authority is required to call this API.
@@ -253,7 +239,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
@@ -268,7 +253,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
@@ -296,7 +280,9 @@ $Transform = @"{
},
"type" : "dateFormat"
}"@
# Update a transform
try {
Update-BetaTransform-BetaId $Id
@@ -307,7 +293,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-triggers
title: Triggers
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/triggers
tags: ['SDK', 'Software Development Kit', 'Triggers', 'BetaTriggers']
---
# Triggers
Event Triggers provide real-time updates to changes in Identity Security Cloud so you can take action as soon as an event occurs, rather than poll an API endpoint for updates. Identity Security Cloud provides a user interface within the admin console to create and manage trigger subscriptions. These endpoints allow for programatically creating and managing trigger subscriptions.
@@ -70,9 +70,7 @@ Method | HTTP request | Description
[**Test-BetaSubscriptionFilter**](#test-subscription-filter) | **POST** `/trigger-subscriptions/validate-filter` | Validate a Subscription Filter
[**Update-BetaSubscription**](#update-subscription) | **PUT** `/trigger-subscriptions/{id}` | Update a Subscription
## complete-trigger-invocation
Completes an invocation to a REQUEST_RESPONSE type trigger.
### Parameters
@@ -82,7 +80,6 @@ Path | Id | **String** | True | The ID of the invocation to complete.
Body | CompleteInvocation | [**CompleteInvocation**](../models/complete-invocation) | True |
### Return type
(empty response body)
### Responses
@@ -96,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
@@ -110,7 +106,9 @@ $CompleteInvocation = @"{
"secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde",
"error" : "Access request is denied."
}"@
# Complete Trigger Invocation
try {
$Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation
Complete-BetaTriggerInvocation-BetaId $Id -BetaCompleteInvocation $Result
@@ -122,11 +120,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-subscription
This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required:
* HTTP subscriptions require httpConfig
* EventBridge subscriptions require eventBridgeConfig
@@ -137,7 +132,6 @@ Param Type | Name | Data Type | Required | Description
Body | SubscriptionPostRequest | [**SubscriptionPostRequest**](../models/subscription-post-request) | True |
### Return type
[**Subscription**](../models/subscription)
### Responses
@@ -151,7 +145,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
@@ -182,7 +175,9 @@ $SubscriptionPostRequest = @"{
"type" : "HTTP",
"enabled" : true
}"@
# Create a Subscription
try {
$Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest
New-BetaSubscription-BetaSubscriptionPostRequest $Result
@@ -194,11 +189,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-subscription
Deletes an existing subscription to a trigger.
### Parameters
@@ -207,7 +199,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Subscription ID
### Return type
(empty response body)
### Responses
@@ -222,14 +213,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 = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID
# Delete a Subscription
try {
Remove-BetaSubscription-BetaId $Id
@@ -240,11 +232,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-subscriptions
Gets a list of all trigger subscriptions.
### Parameters
@@ -257,7 +246,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: **triggerId, triggerName**
### Return type
[**Subscription[]**](../models/subscription)
### Responses
@@ -271,7 +259,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
@@ -282,7 +269,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 "12cff757-c0c0-413b-8ad7-2a47956d1e89"' # 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* **triggerId**: *eq* **type**: *eq, le* (optional)
$Sorters = "triggerName" # 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: **triggerId, triggerName** (optional)
# List Subscriptions
try {
Get-BetaSubscriptions
@@ -293,11 +282,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-trigger-invocation-status
Gets a list of latest invocation statuses.
Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours.
This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations.
@@ -312,7 +298,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: **triggerId, subscriptionName, created, completed**
### Return type
[**InvocationStatus[]**](../models/invocation-status)
### Responses
@@ -326,7 +311,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
@@ -337,7 +321,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 = 'triggerId eq "idn:access-request-dynamic-approver"' # 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: **triggerId**: *eq* **subscriptionId**: *eq* (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: **triggerId, subscriptionName, created, completed** (optional)
# List Latest Invocation Statuses
try {
Get-BetaTriggerInvocationStatus
@@ -348,11 +334,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-triggers
Gets a list of triggers that are available in the tenant.
### Parameters
@@ -365,7 +348,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**
### Return type
[**Trigger[]**](../models/trigger)
### Responses
@@ -379,7 +361,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
@@ -390,7 +371,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 "idn:access-request-post-approval"' # 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, ge, le* (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: **id, name** (optional)
# List Triggers
try {
Get-BetaTriggers
@@ -401,11 +384,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-subscription
This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable:
**name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig**
@@ -417,7 +397,6 @@ Path | Id | **String** | True | ID of the Subscription to patch
Body | SubscriptionPatchRequestInner | [**[]SubscriptionPatchRequestInner**](../models/subscription-patch-request-inner) | True |
### Return type
[**Subscription**](../models/subscription)
### Responses
@@ -432,17 +411,17 @@ 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 = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | ID of the Subscription to patch
# SubscriptionPatchRequestInner[] |
$SubscriptionPatchRequestInner = @""@
$SubscriptionPatchRequestInner = @""@ # SubscriptionPatchRequestInner[] |
# Patch a Subscription
try {
$Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner
Update-BetaSubscription-BetaId $Id -BetaSubscriptionPatchRequestInner $Result
@@ -454,11 +433,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-test-trigger-invocation
Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent.
### Parameters
@@ -467,7 +443,6 @@ Param Type | Name | Data Type | Required | Description
Body | TestInvocation | [**TestInvocation**](../models/test-invocation) | True |
### Return type
[**Invocation[]**](../models/invocation)
### Responses
@@ -482,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
@@ -498,7 +472,9 @@ $TestInvocation = @"{
"workflowId" : 1234
}
}"@
# Start a Test Invocation
try {
$Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation
Start-BetaTestTriggerInvocation-BetaTestInvocation $Result
@@ -510,11 +486,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## test-subscription-filter
Validates a JSONPath filter expression against a provided mock input.
Request requires a security scope of:
@@ -524,7 +497,6 @@ Param Type | Name | Data Type | Required | Description
Body | ValidateFilterInputDto | [**ValidateFilterInputDto**](../models/validate-filter-input-dto) | True |
### Return type
[**ValidateFilterOutputDto**](../models/validate-filter-output-dto)
### Responses
@@ -538,7 +510,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
@@ -550,7 +521,9 @@ $ValidateFilterInputDto = @"{
"identityId" : "201327fda1c44704ac01181e963d463c"
}
}"@
# Validate a Subscription Filter
try {
$Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto
Test-BetaSubscriptionFilter-BetaValidateFilterInputDto $Result
@@ -562,11 +535,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-subscription
This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing
Subscription is completely replaced. The following fields are immutable:
@@ -585,7 +555,6 @@ Path | Id | **String** | True | Subscription ID
Body | SubscriptionPutRequest | [**SubscriptionPutRequest**](../models/subscription-put-request) | True |
### Return type
[**Subscription**](../models/subscription)
### Responses
@@ -600,7 +569,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
@@ -631,7 +599,9 @@ $SubscriptionPutRequest = @"{
"type" : "HTTP",
"enabled" : true
}"@
# Update a Subscription
try {
$Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest
Update-BetaSubscription-BetaId $Id -BetaSubscriptionPutRequest $Result
@@ -643,7 +613,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-ui-metadata
title: UIMetadata
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/ui-metadata
tags: ['SDK', 'Software Development Kit', 'UIMetadata', 'BetaUIMetadata']
---
# UIMetadata
API for managing UI Metadata. Use this API to manage metadata about your User Interface.
For example you can set the iFrameWhitelist parameter to permit another domain to encapsulate IDN within an iframe or set the usernameEmptyText to change the placeholder text for Username on your tenant's login screen.
@@ -22,9 +22,7 @@ Method | HTTP request | Description
[**Get-BetaTenantUiMetadata**](#get-tenant-ui-metadata) | **GET** `/ui-metadata/tenant` | Get a tenant UI metadata
[**Set-BetaTenantUiMetadata**](#set-tenant-ui-metadata) | **PUT** `/ui-metadata/tenant` | Update tenant UI metadata
## get-tenant-ui-metadata
This API endpoint retrieves UI metadata configured for your tenant.
A token with ORG_ADMIN authority is required to call this API.
@@ -33,7 +31,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**TenantUiMetadataItemResponse**](../models/tenant-ui-metadata-item-response)
### Responses
@@ -48,13 +45,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 a tenant UI metadata
try {
Get-BetaTenantUiMetadata
@@ -65,11 +63,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-tenant-ui-metadata
This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI.
A token with ORG_ADMIN authority is required to call this API.
@@ -79,7 +74,6 @@ Param Type | Name | Data Type | Required | Description
Body | TenantUiMetadataItemUpdateRequest | [**TenantUiMetadataItemUpdateRequest**](../models/tenant-ui-metadata-item-update-request) | True |
### Return type
[**TenantUiMetadataItemResponse**](../models/tenant-ui-metadata-item-response)
### Responses
@@ -94,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
@@ -105,7 +98,9 @@ $TenantUiMetadataItemUpdateRequest = @"{
"usernameLabel" : "Email",
"iframeWhiteList" : "http://example.com http://example2.com"
}"@
# Update tenant UI metadata
try {
$Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest
Set-BetaTenantUiMetadata-BetaTenantUiMetadataItemUpdateRequest $Result
@@ -117,7 +112,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-vendor-connector-mappings
title: VendorConnectorMappings
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/vendor-connector-mappings
tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappings', 'BetaVendorConnectorMappings']
---
# VendorConnectorMappings
Vendors use ISC connectors to connect their source data to ISC, but the data in their source and the data in ISC may be stored in different formats.
Connector mappings allow vendors to match their data on both sides of the connection.
@@ -26,9 +26,7 @@ Method | HTTP request | Description
[**Remove-BetaVendorConnectorMapping**](#delete-vendor-connector-mapping) | **DELETE** `/vendor-connector-mappings` | Delete Vendor Connector Mapping
[**Get-BetaVendorConnectorMappings**](#get-vendor-connector-mappings) | **GET** `/vendor-connector-mappings` | List Vendor Connector Mappings
## create-vendor-connector-mapping
Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths.
@@ -38,7 +36,6 @@ Param Type | Name | Data Type | Required | Description
Body | VendorConnectorMapping | [**VendorConnectorMapping**](../models/vendor-connector-mapping) | True |
### Return type
[**VendorConnectorMapping**](../models/vendor-connector-mapping)
### 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
@@ -82,7 +78,9 @@ $VendorConnectorMapping = @"{
"Time" : "2024-03-14T12:56:19.391294Z"
}
}"@
# Create Vendor Connector Mapping
try {
$Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping
New-BetaVendorConnectorMapping-BetaVendorConnectorMapping $Result
@@ -94,11 +92,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.
@@ -108,7 +103,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
@@ -123,7 +117,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
@@ -152,7 +145,9 @@ $VendorConnectorMapping = @"{
"Time" : "2024-03-14T12:56:19.391294Z"
}
}"@
# Delete Vendor Connector Mapping
try {
$Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping
Remove-BetaVendorConnectorMapping-BetaVendorConnectorMapping $Result
@@ -164,11 +159,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.
@@ -177,7 +169,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**VendorConnectorMapping[]**](../models/vendor-connector-mapping)
### Responses
@@ -192,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
# List Vendor Connector Mappings
try {
Get-BetaVendorConnectorMappings
@@ -209,7 +201,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-work-items
title: WorkItems
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/work-items
tags: ['SDK', 'Software Development Kit', 'WorkItems', 'BetaWorkItems']
---
# 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
[**Deny-BetaApprovalItemsInBulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items
[**Submit-BetaAccountSelection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit Account Selections
## approve-approval-item
This API approves an Approval Item. Either an admin, or the owning/current user must make this request.
### 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
@@ -70,7 +67,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**: Not defined
- **Accept**: application/json
@@ -78,7 +74,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-BetaApprovalItem-BetaId $Id -BetaApprovalItemId $ApprovalItemId
@@ -89,11 +87,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
@@ -102,7 +97,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
@@ -114,14 +108,15 @@ 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**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
# Bulk approve Approval Items
try {
Approve-BetaApprovalItemsInBulk-BetaId $Id
@@ -132,11 +127,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
@@ -145,7 +137,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
@@ -157,14 +148,15 @@ 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**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
# Complete a Work Item
try {
Complete-BetaWorkItem-BetaId $Id
@@ -175,11 +167,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## forward-work-item
This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request.
### Parameters
@@ -189,7 +178,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
@@ -203,7 +191,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
@@ -215,7 +202,9 @@ $WorkItemForward = @"{
"comment" : "I'm going on vacation.",
"sendNotifications" : true
}"@
# Forward a Work Item
try {
$Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward
Invoke-BetaForwardWorkItem-BetaId $Id -BetaWorkItemForward $Result
@@ -227,11 +216,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
@@ -243,7 +229,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
@@ -255,7 +240,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**: Not defined
- **Accept**: application/json
@@ -265,7 +249,9 @@ $OwnerId = "MyOwnerId" # String | The id of the owner of the work item list bein
$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-BetaCompletedWorkItems
@@ -276,11 +262,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
@@ -289,7 +272,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
@@ -301,14 +283,15 @@ 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**: Not defined
- **Accept**: application/json
### Example
```powershell
$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional)
# Count Completed Work Items
try {
Get-BetaCountCompletedWorkItems
@@ -319,11 +302,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
@@ -332,7 +312,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
@@ -344,14 +323,15 @@ 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**: Not defined
- **Accept**: application/json
### Example
```powershell
$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional)
# Count Work Items
try {
Get-BetaCountWorkItems
@@ -362,11 +342,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
@@ -376,7 +353,6 @@ Path | Id | **String** | True | ID of the work item.
Query | OwnerId | **String** | (optional) | ID of the work item owner.
### Return type
[**WorkItems[]**](../models/work-items)
### Responses
@@ -388,7 +364,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**: Not defined
- **Accept**: application/json
@@ -396,7 +371,9 @@ Code | Description | Data Type
```powershell
$Id = "MyId" # String | ID of the work item.
$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional)
# Get a Work Item
try {
Get-BetaWorkItem-BetaId $Id
@@ -407,11 +384,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
@@ -420,7 +394,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
@@ -432,14 +405,15 @@ 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**: Not defined
- **Accept**: application/json
### Example
```powershell
$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional)
# Work Items Summary
try {
Get-BetaWorkItemsSummary
@@ -450,11 +424,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
@@ -466,7 +437,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
@@ -478,7 +448,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**: Not defined
- **Accept**: application/json
@@ -488,7 +457,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 = "MyOwnerId" # String | ID of the work item owner. (optional)
# List Work Items
try {
Get-BetaWorkItems
@@ -499,11 +470,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
@@ -513,7 +481,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
@@ -525,7 +492,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**: Not defined
- **Accept**: application/json
@@ -533,7 +499,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-BetaApprovalItem-BetaId $Id -BetaApprovalItemId $ApprovalItemId
@@ -544,11 +512,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
@@ -557,7 +522,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
@@ -569,14 +533,15 @@ 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**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
# Bulk reject Approval Items
try {
Deny-BetaApprovalItemsInBulk-BetaId $Id
@@ -587,11 +552,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
@@ -601,7 +563,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
@@ -613,7 +574,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
@@ -621,7 +581,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-BetaAccountSelection-BetaId $Id -BetaRequestBody $Result
@@ -633,7 +595,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-work-reassignment
title: WorkReassignment
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/work-reassignment
tags: ['SDK', 'Software Development Kit', 'WorkReassignment', 'BetaWorkReassignment']
---
# WorkReassignment
Use this API to implement work reassignment functionality.
@@ -38,9 +38,7 @@ Method | HTTP request | Description
[**Send-BetaReassignmentConfig**](#put-reassignment-config) | **PUT** `/reassignment-configurations/{identityId}` | Update Reassignment Configuration
[**Send-BetaTenantConfiguration**](#put-tenant-configuration) | **PUT** `/reassignment-configurations/tenant-config` | Update Tenant-wide Reassignment Configuration settings
## create-reassignment-configuration
Creates a new Reassignment Configuration for the specified identity.
### Parameters
@@ -49,7 +47,6 @@ Param Type | Name | Data Type | Required | Description
Body | ConfigurationItemRequest | [**ConfigurationItemRequest**](../models/configuration-item-request) | True |
### Return type
[**ConfigurationItemResponse**](../models/configuration-item-response)
### Responses
@@ -63,7 +60,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 @@ $ConfigurationItemRequest = @"{
"reassignedToId" : "2c91808781a71ddb0181b9090b53504a",
"startDate" : "2022-07-21T11:13:12.345Z"
}"@
# Create a Reassignment Configuration
try {
$Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest
New-BetaReassignmentConfiguration-BetaConfigurationItemRequest $Result
@@ -88,11 +86,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-reassignment-configuration
Deletes a single reassignment configuration for the specified identity
### Parameters
@@ -102,7 +97,6 @@ Path | IdentityId | **String** | True | unique identity id
Path | ConfigType | [**ConfigTypeEnum**](../models/config-type-enum) | True |
### Return type
(empty response body)
### Responses
@@ -116,7 +110,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
@@ -124,7 +117,9 @@ Code | Description | Data Type
```powershell
$IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id
$ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum |
# Delete Reassignment Configuration
try {
Remove-BetaReassignmentConfiguration-BetaIdentityId $IdentityId -BetaConfigType $ConfigType
@@ -135,11 +130,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-evaluate-reassignment-configuration
Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty.
### Parameters
@@ -150,7 +142,6 @@ Path | ConfigType | [**ConfigTypeEnum**](../models/config-type-enum) | True |
Query | ExclusionFilters | **[]String** | (optional) | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments
### Return type
[**EvaluateResponse[]**](../models/evaluate-response)
### Responses
@@ -164,7 +155,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
@@ -174,8 +164,10 @@ $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id
$ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type
$ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional)
$ExclusionFilters = @"SELF_REVIEW_DELEGATION"@
$ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional)
# Evaluate Reassignment Configuration
try {
Get-BetaEvaluateReassignmentConfiguration-BetaIdentityId $IdentityId -BetaConfigType $ConfigType
@@ -186,11 +178,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-reassignment-config-types
Gets a collection of types which are available in the Reassignment Configuration UI.
### Parameters
@@ -198,7 +187,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**ConfigType[]**](../models/config-type)
### Responses
@@ -212,13 +200,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 Reassignment Config Types
try {
Get-BetaReassignmentConfigTypes
@@ -229,11 +218,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-reassignment-configuration
Gets the Reassignment Configuration for an identity.
### Parameters
@@ -242,7 +228,6 @@ Param Type | Name | Data Type | Required | Description
Path | IdentityId | **String** | True | unique identity id
### Return type
[**ConfigurationResponse**](../models/configuration-response)
### Responses
@@ -257,14 +242,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
$IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id
# Get Reassignment Configuration
try {
Get-BetaReassignmentConfiguration-BetaIdentityId $IdentityId
@@ -275,11 +261,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-tenant-config-configuration
Gets the global Reassignment Configuration settings for the requestor's tenant.
### Parameters
@@ -287,7 +270,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**TenantConfigurationResponse**](../models/tenant-configuration-response)
### Responses
@@ -302,13 +284,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 Tenant-wide Reassignment Configuration settings
try {
Get-BetaTenantConfigConfiguration
@@ -319,11 +302,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-reassignment-configurations
Gets all Reassignment configuration for the current org.
### Parameters
@@ -331,7 +311,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**ConfigurationResponse[]**](../models/configuration-response)
### Responses
@@ -346,13 +325,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 Reassignment Configurations
try {
Get-BetaReassignmentConfigurations
@@ -363,11 +343,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-reassignment-config
Replaces existing Reassignment configuration for an identity with the newly provided configuration.
### Parameters
@@ -377,7 +354,6 @@ Path | IdentityId | **String** | True | unique identity id
Body | ConfigurationItemRequest | [**ConfigurationItemRequest**](../models/configuration-item-request) | True |
### Return type
[**ConfigurationItemResponse**](../models/configuration-item-response)
### Responses
@@ -391,7 +367,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
@@ -405,7 +380,9 @@ $ConfigurationItemRequest = @"{
"reassignedToId" : "2c91808781a71ddb0181b9090b53504a",
"startDate" : "2022-07-21T11:13:12.345Z"
}"@
# Update Reassignment Configuration
try {
$Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest
Send-BetaReassignmentConfig-BetaIdentityId $IdentityId -BetaConfigurationItemRequest $Result
@@ -417,11 +394,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-tenant-configuration
Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings.
### Parameters
@@ -430,7 +404,6 @@ Param Type | Name | Data Type | Required | Description
Body | TenantConfigurationRequest | [**TenantConfigurationRequest**](../models/tenant-configuration-request) | True |
### Return type
[**TenantConfigurationResponse**](../models/tenant-configuration-response)
### 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**: application/json
- **Accept**: application/json
@@ -455,7 +427,9 @@ $TenantConfigurationRequest = @"{
"disabled" : true
}
}"@
# Update Tenant-wide Reassignment Configuration settings
try {
$Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest
Send-BetaTenantConfiguration-BetaTenantConfigurationRequest $Result
@@ -467,7 +441,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

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

@@ -1,3 +1,4 @@
---
id: beta-workflows
title: Workflows
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/workflows
tags: ['SDK', 'Software Development Kit', 'Workflows', 'BetaWorkflows']
---
# 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-BetaWorkflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test Workflow By Id
[**Update-BetaWorkflow**](#update-workflow) | **PUT** `/workflows/{id}` | Update Workflow
## cancel-workflow-execution
Use this API to cancel a running workflow execution.
### 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-BetaWorkflowExecution-BetaId $Id
@@ -82,11 +80,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
@@ -95,7 +90,6 @@ Param Type | Name | Data Type | Required | Description
Body | CreateWorkflowRequest | [**CreateWorkflowRequest**](../models/create-workflow-request) | True |
### Return type
[**Workflow**](../models/workflow)
### 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**: 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-BetaWorkflow-BetaCreateWorkflowRequest $Result
@@ -128,11 +123,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-workflow
Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled.
### Parameters
@@ -141,7 +133,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Id of the Workflow
### Return type
(empty response body)
### Responses
@@ -155,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 = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow
# Delete Workflow By Id
try {
Remove-BetaWorkflow-BetaId $Id
@@ -173,11 +165,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-workflow
Get a single workflow by id.
### Parameters
@@ -186,7 +175,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Id of the workflow
### Return type
[**Workflow**](../models/workflow)
### Responses
@@ -200,14 +188,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-BetaWorkflow-BetaId $Id
@@ -218,11 +207,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
@@ -231,7 +217,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
@@ -246,14 +231,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-BetaWorkflowExecution-BetaId $Id
@@ -264,11 +250,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
@@ -277,7 +260,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
@@ -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 execution
# Get Workflow Execution History
try {
Get-BetaWorkflowExecutionHistory-BetaId $Id
@@ -310,11 +293,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.
@@ -337,7 +317,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: **startTime**: *eq, lt, le, gt, ge* **status**: *eq*
### Return type
[**WorkflowExecution[]**](../models/workflow-execution)
### Responses
@@ -352,7 +331,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
@@ -363,7 +341,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: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional)
# List Workflow Executions
try {
Get-BetaWorkflowExecutions-BetaId $Id
@@ -374,11 +354,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-complete-workflow-library
This lists all triggers, actions, and operators in the library
### Parameters
@@ -388,7 +365,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
@@ -402,7 +378,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
@@ -410,7 +385,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-BetaCompleteWorkflowLibrary
@@ -421,11 +398,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-workflow-library-actions
This lists the workflow actions available to you.
### Parameters
@@ -436,7 +410,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
@@ -450,7 +423,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
@@ -459,7 +431,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-BetaWorkflowLibraryActions
@@ -470,11 +444,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-workflow-library-operators
This lists the workflow operators available to you
### Parameters
@@ -482,7 +453,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**WorkflowLibraryOperator[]**](../models/workflow-library-operator)
### Responses
@@ -496,13 +466,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-BetaWorkflowLibraryOperators
@@ -513,11 +484,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-workflow-library-triggers
This lists the workflow triggers 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
[**WorkflowLibraryTrigger[]**](../models/workflow-library-trigger)
### 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 "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-BetaWorkflowLibraryTriggers
@@ -562,11 +530,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-workflows
List all workflows in the tenant.
### Parameters
@@ -574,7 +539,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**Workflow[]**](../models/workflow)
### 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 Workflows
try {
Get-BetaWorkflows
@@ -605,11 +570,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
@@ -619,7 +581,6 @@ Path | Id | **String** | True | Id of the Workflow
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True |
### Return type
[**Workflow**](../models/workflow)
### Responses
@@ -633,21 +594,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-BetaWorkflow-BetaId $Id -BetaJsonPatchOperation $Result
@@ -659,11 +620,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## post-external-execute-workflow
This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the "External Trigger" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body.
### Parameters
@@ -673,7 +631,6 @@ Path | Id | **String** | True | Id of the workflow
Body | PostExternalExecuteWorkflowRequest | [**PostExternalExecuteWorkflowRequest**](../models/post-external-execute-workflow-request) | (optional) |
### Return type
[**PostExternalExecuteWorkflow200Response**](../models/post-external-execute-workflow200-response)
### Responses
@@ -687,7 +644,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
@@ -695,7 +651,9 @@ Code | Description | Data Type
```powershell
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
$PostExternalExecuteWorkflowRequest = @""@
# Execute Workflow via External Trigger
try {
Submit-BetaExternalExecuteWorkflow-BetaId $Id
@@ -706,11 +664,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## post-workflow-external-trigger
Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow.
### Parameters
@@ -719,7 +674,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
@@ -733,14 +687,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 {
Submit-BetaWorkflowExternalTrigger-BetaId $Id
@@ -751,11 +706,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
@@ -765,7 +717,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
@@ -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
@@ -787,7 +737,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-BetaExternalExecuteWorkflow-BetaId $Id
@@ -798,11 +750,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.**
@@ -814,7 +763,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
@@ -828,7 +776,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
@@ -836,7 +783,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-BetaWorkflow-BetaId $Id -BetaTestWorkflowRequest $Result
@@ -848,11 +797,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-workflow
Perform a full update of a workflow. The updated workflow object is returned in the response.
### Parameters
@@ -862,7 +808,6 @@ Path | Id | **String** | True | Id of the Workflow
Body | WorkflowBody | [**WorkflowBody**](../models/workflow-body) | True |
### Return type
[**Workflow**](../models/workflow)
### Responses
@@ -876,7 +821,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
@@ -921,7 +865,9 @@ $WorkflowBody = @"{
},
"enabled" : false
}"@
# Update Workflow
try {
$Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody
Update-BetaWorkflow-BetaId $Id -BetaWorkflowBody $Result
@@ -933,7 +879,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)