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

Update PowerShell SDK docs: 15141274669

Browse Source
This commit is contained in:
developer-relations-sp
2025-05-20 15:12:17 +00:00
parent c4f4d72fc8
commit 8df9b19e41
308 changed files with 6591 additions and 5586 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -27,10 +27,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024AccessModelMetadataAttribute**](#get-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes/{key}` | Get Access Model Metadata Attribute
[**Get-V2024AccessModelMetadataAttributeValue**](#get-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values/{value}` | Get Access Model Metadata Value
[**Get-V2024AccessModelMetadataAttribute**](#list-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes` | List Access Model Metadata Attributes
[**Get-V2024AccessModelMetadataAttributeValue**](#list-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values` | List Access Model Metadata Values
[**Get-V2024AccessModelMetadataAttribute**](#get-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes/{key}` | Get access model metadata attribute
[**Get-V2024AccessModelMetadataAttributeValue**](#get-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values/{value}` | Get access model metadata value
[**Get-V2024AccessModelMetadataAttribute**](#list-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes` | List access model metadata attributes
[**Get-V2024AccessModelMetadataAttributeValue**](#list-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values` | List access model metadata values
## get-access-model-metadata-attribute
@@ -69,7 +69,7 @@ Code | Description | Data Type
$Key = "iscPrivacy" # String | Technical name of the Attribute.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get Access Model Metadata Attribute
# Get access model metadata attribute
try {
Get-V2024AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental
@@ -121,7 +121,7 @@ $Key = "iscPrivacy" # String | Technical name of the Attribute.
$Value = "public" # String | Technical name of the Attribute value.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get Access Model Metadata Value
# Get access model metadata value
try {
Get-V2024AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental
@@ -171,7 +171,7 @@ Code | Description | Data Type
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$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
# List access model metadata attributes
try {
Get-V2024AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental
@@ -221,7 +221,7 @@ Code | Description | Data Type
$Key = "iscPrivacy" # String | Technical name of the Attribute.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# List Access Model Metadata Values
# List access model metadata values
try {
Get-V2024AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental

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

@@ -51,14 +51,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024AccessProfile**](#create-access-profile) | **POST** `/access-profiles` | Create Access Profile
[**Remove-V2024AccessProfile**](#delete-access-profile) | **DELETE** `/access-profiles/{id}` | Delete the specified Access Profile
[**Remove-V2024AccessProfilesInBulk**](#delete-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-delete` | Delete Access Profile(s)
[**Get-V2024AccessProfile**](#get-access-profile) | **GET** `/access-profiles/{id}` | Get an Access Profile
[**Get-V2024AccessProfileEntitlements**](#get-access-profile-entitlements) | **GET** `/access-profiles/{id}/entitlements` | List Access Profile's Entitlements
[**Get-V2024AccessProfiles**](#list-access-profiles) | **GET** `/access-profiles` | List Access Profiles
[**Update-V2024AccessProfile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified Access Profile
[**Update-V2024AccessProfilesInBulk**](#update-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-update-requestable` | Update Access Profile(s) requestable field.
[**New-V2024AccessProfile**](#create-access-profile) | **POST** `/access-profiles` | Create access profile
[**Remove-V2024AccessProfile**](#delete-access-profile) | **DELETE** `/access-profiles/{id}` | Delete the specified access profile
[**Remove-V2024AccessProfilesInBulk**](#delete-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-delete` | Delete access profile(s)
[**Get-V2024AccessProfile**](#get-access-profile) | **GET** `/access-profiles/{id}` | Get an access profile
[**Get-V2024AccessProfileEntitlements**](#get-access-profile-entitlements) | **GET** `/access-profiles/{id}/entitlements` | List access profile's entitlements
[**Get-V2024AccessProfiles**](#list-access-profiles) | **GET** `/access-profiles` | List access profiles
[**Update-V2024AccessProfile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified access profile
[**Update-V2024AccessProfilesInBulk**](#update-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-update-requestable` | Update access profile(s) requestable field.
## create-access-profile
@@ -180,7 +180,7 @@ $AccessProfile = @"{
"requestable" : true
}"@
# Create Access Profile
# Create access profile
try {
$Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile
@@ -230,7 +230,7 @@ Code | Description | Data Type
```powershell
$Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete
# Delete the specified Access Profile
# Delete the specified access profile
try {
Remove-V2024AccessProfile -Id $Id
@@ -283,7 +283,7 @@ $AccessProfileBulkDeleteRequest = @"{
"bestEffortOnly" : true
}"@
# Delete Access Profile(s)
# Delete access profile(s)
try {
$Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest
@@ -329,7 +329,7 @@ Code | Description | Data Type
```powershell
$Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile
# Get an Access Profile
# Get an access profile
try {
Get-V2024AccessProfile -Id $Id
@@ -386,7 +386,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$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
# List access profile's entitlements
try {
Get-V2024AccessProfileEntitlements -Id $Id
@@ -446,7 +446,7 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de
$ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those 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
# List access profiles
try {
Get-V2024AccessProfiles
@@ -527,7 +527,7 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to
}"@ # JsonPatchOperation[] |
# Patch a specified Access Profile
# Patch a specified access profile
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
@@ -586,7 +586,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
$AccessProfileBulkUpdateRequestInner = @"[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]"@ # AccessProfileBulkUpdateRequestInner[] |
# Update Access Profile(s) requestable field.
# Update access profile(s) requestable field.
try {
$Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner

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

@@ -34,13 +34,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Approve-V2024AccessRequest**](#approve-access-request) | **POST** `/access-request-approvals/{approvalId}/approve` | Approve Access Request Approval
[**Invoke-V2024ForwardAccessRequest**](#forward-access-request) | **POST** `/access-request-approvals/{approvalId}/forward` | Forward Access Request Approval
[**Get-V2024AccessRequestApprovalSummary**](#get-access-request-approval-summary) | **GET** `/access-request-approvals/approval-summary` | Get Access Requests Approvals Number
[**Get-V2024AccessRequestApprovers**](#list-access-request-approvers) | **GET** `/access-request-approvals/{accessRequestId}/approvers` | Access Request Approvers
[**Get-V2024CompletedApprovals**](#list-completed-approvals) | **GET** `/access-request-approvals/completed` | Completed Access Request Approvals List
[**Get-V2024PendingApprovals**](#list-pending-approvals) | **GET** `/access-request-approvals/pending` | Pending Access Request Approvals List
[**Deny-V2024AccessRequest**](#reject-access-request) | **POST** `/access-request-approvals/{approvalId}/reject` | Reject Access Request Approval
[**Approve-V2024AccessRequest**](#approve-access-request) | **POST** `/access-request-approvals/{approvalId}/approve` | Approve access request approval
[**Invoke-V2024ForwardAccessRequest**](#forward-access-request) | **POST** `/access-request-approvals/{approvalId}/forward` | Forward access request approval
[**Get-V2024AccessRequestApprovalSummary**](#get-access-request-approval-summary) | **GET** `/access-request-approvals/approval-summary` | Get access requests approvals number
[**Get-V2024AccessRequestApprovers**](#list-access-request-approvers) | **GET** `/access-request-approvals/{accessRequestId}/approvers` | Access request approvers
[**Get-V2024CompletedApprovals**](#list-completed-approvals) | **GET** `/access-request-approvals/completed` | Completed access request approvals list
[**Get-V2024PendingApprovals**](#list-pending-approvals) | **GET** `/access-request-approvals/pending` | Pending access request approvals list
[**Deny-V2024AccessRequest**](#reject-access-request) | **POST** `/access-request-approvals/{approvalId}/reject` | Reject access request approval
## approve-access-request
@@ -85,7 +85,7 @@ $CommentDto = @"{
"comment" : "This is a comment."
}"@
# Approve Access Request Approval
# Approve access request approval
try {
Approve-V2024AccessRequest -ApprovalId $ApprovalId
@@ -136,7 +136,7 @@ $ForwardApprovalDto = @"{
"comment" : "2c91808568c529c60168cca6f90c1313"
}"@
# Forward Access Request Approval
# Forward access request approval
try {
$Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto
@@ -184,7 +184,7 @@ Code | Description | Data Type
$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
# Get access requests approvals number
try {
Get-V2024AccessRequestApprovalSummary
@@ -237,7 +237,7 @@ $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 2
$Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional)
$Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false)
# Access Request Approvers
# Access request approvers
try {
Get-V2024AccessRequestApprovers -AccessRequestId $AccessRequestId
@@ -292,7 +292,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional)
$Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional)
# Completed Access Request Approvals List
# Completed access request approvals list
try {
Get-V2024CompletedApprovals
@@ -347,7 +347,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional)
$Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional)
# Pending Access Request Approvals List
# Pending access request approvals list
try {
Get-V2024PendingApprovals
@@ -403,7 +403,7 @@ $CommentDto = @"{
"comment" : "This is a comment."
}"@
# Reject Access Request Approval
# Reject access request approval
try {
$Result = ConvertFrom-JsonToCommentDto -Json $CommentDto

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

@@ -32,16 +32,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Approve-V2024BulkAccessRequest**](#approve-bulk-access-request) | **POST** `/access-request-approvals/bulk-approve` | Bulk Approve Access Request
[**Suspend-V2024AccessRequest**](#cancel-access-request) | **POST** `/access-requests/cancel` | Cancel Access Request
[**Suspend-V2024AccessRequestInBulk**](#cancel-access-request-in-bulk) | **POST** `/access-requests/bulk-cancel` | Bulk Cancel Access Request
[**Close-V2024AccessRequest**](#close-access-request) | **POST** `/access-requests/close` | Close Access Request
[**New-V2024AccessRequest**](#create-access-request) | **POST** `/access-requests` | Submit Access Request
[**Get-V2024AccessRequestConfig**](#get-access-request-config) | **GET** `/access-request-config` | Get Access Request Configuration
[**Get-V2024AccessRequestStatus**](#list-access-request-status) | **GET** `/access-request-status` | Access Request Status
[**Get-V2024AdministratorsAccessRequestStatus**](#list-administrators-access-request-status) | **GET** `/access-request-administration` | Access Request Status for Administrators
[**Approve-V2024BulkAccessRequest**](#approve-bulk-access-request) | **POST** `/access-request-approvals/bulk-approve` | Bulk approve access request
[**Suspend-V2024AccessRequest**](#cancel-access-request) | **POST** `/access-requests/cancel` | Cancel access request
[**Suspend-V2024AccessRequestInBulk**](#cancel-access-request-in-bulk) | **POST** `/access-requests/bulk-cancel` | Bulk cancel access request
[**Close-V2024AccessRequest**](#close-access-request) | **POST** `/access-requests/close` | Close access request
[**New-V2024AccessRequest**](#create-access-request) | **POST** `/access-requests` | Submit access request
[**Get-V2024AccessRequestConfig**](#get-access-request-config) | **GET** `/access-request-config` | Get access request configuration
[**Get-V2024AccessRequestStatus**](#list-access-request-status) | **GET** `/access-request-status` | Access request status
[**Get-V2024AdministratorsAccessRequestStatus**](#list-administrators-access-request-status) | **GET** `/access-request-administration` | Access request status for administrators
[**Invoke-V2024LoadAccountSelections**](#load-account-selections) | **POST** `/access-requests/accounts-selection` | Get accounts selections for identity
[**Set-V2024AccessRequestConfig**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration
[**Set-V2024AccessRequestConfig**](#set-access-request-config) | **PUT** `/access-request-config` | Update access request configuration
## approve-bulk-access-request
@@ -79,7 +79,7 @@ $BulkApproveAccessRequest = @"{
"approvalIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ]
}"@
# Bulk Approve Access Request
# Bulk approve access request
try {
$Result = ConvertFrom-JsonToBulkApproveAccessRequest -Json $BulkApproveAccessRequest
@@ -130,7 +130,7 @@ $CancelAccessRequest = @"{
"comment" : "I requested this role by mistake."
}"@
# Cancel Access Request
# Cancel access request
try {
$Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest
@@ -181,7 +181,7 @@ $BulkCancelAccessRequest = @"{
"comment" : "I requested this role by mistake."
}"@
# Bulk Cancel Access Request
# Bulk cancel access request
try {
$Result = ConvertFrom-JsonToBulkCancelAccessRequest -Json $BulkCancelAccessRequest
@@ -248,7 +248,7 @@ $CloseAccessRequest = @"{
"message" : "The IdentityNow Administrator manually closed this request."
}"@
# Close Access Request
# Close access request
try {
$Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest
@@ -509,7 +509,7 @@ $AccessRequest = @"{
} ]
}"@
# Submit Access Request
# Submit access request
try {
$Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest
@@ -553,7 +553,7 @@ Code | Description | Data Type
### Example
```powershell
# Get Access Request Configuration
# Get access request configuration
try {
Get-V2024AccessRequestConfig
@@ -618,7 +618,7 @@ $Filters = 'accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"' # Strin
$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
# Access request status
try {
Get-V2024AccessRequestStatus
@@ -682,7 +682,7 @@ $Filters = 'accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"' # Strin
$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, accessRequestId** (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 for Administrators
# Access request status for administrators
try {
Get-V2024AdministratorsAccessRequestStatus
@@ -881,7 +881,7 @@ $AccessRequestConfig = @"{
"approvalsMustBeExternal" : true
}"@
# Update Access Request Configuration
# Update access request configuration
try {
$Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig

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

@@ -50,8 +50,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024AccountActivity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get an Account Activity
[**Get-V2024AccountActivities**](#list-account-activities) | **GET** `/account-activities` | List Account Activities
[**Get-V2024AccountActivity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get an account activity
[**Get-V2024AccountActivities**](#list-account-activities) | **GET** `/account-activities` | List account activities
## get-account-activity
@@ -86,7 +86,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id
# Get an Account Activity
# Get an account activity
try {
Get-V2024AccountActivity -Id $Id
@@ -145,7 +145,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'type eq "Identity Refresh"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional)
$Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional)
# List Account Activities
# List account activities
try {
Get-V2024AccountActivities

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

@@ -27,7 +27,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024AccountAggregationStatus**](#get-account-aggregation-status) | **GET** `/account-aggregations/{id}/status` | In-progress Account Aggregation status
[**Get-V2024AccountAggregationStatus**](#get-account-aggregation-status) | **GET** `/account-aggregations/{id}/status` | In-progress account aggregation status
## get-account-aggregation-status
@@ -73,7 +73,7 @@ Code | Description | Data Type
$Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# In-progress Account Aggregation status
# In-progress account aggregation status
try {
Get-V2024AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental

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

@@ -44,22 +44,22 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024Account**](#create-account) | **POST** `/accounts` | Create Account
[**Remove-V2024Account**](#delete-account) | **DELETE** `/accounts/{id}` | Delete Account
[**Remove-V2024AccountAsync**](#delete-account-async) | **POST** `/accounts/{id}/remove` | Remove Account
[**Disable-V2024Account**](#disable-account) | **POST** `/accounts/{id}/disable` | Disable Account
[**Disable-V2024AccountForIdentity**](#disable-account-for-identity) | **POST** `/identities-accounts/{id}/disable` | Disable IDN Account for Identity
[**Disable-V2024AccountsForIdentities**](#disable-accounts-for-identities) | **POST** `/identities-accounts/disable` | Disable IDN Accounts for Identities
[**Enable-V2024Account**](#enable-account) | **POST** `/accounts/{id}/enable` | Enable Account
[**Enable-V2024AccountForIdentity**](#enable-account-for-identity) | **POST** `/identities-accounts/{id}/enable` | Enable IDN Account for Identity
[**Enable-V2024AccountsForIdentities**](#enable-accounts-for-identities) | **POST** `/identities-accounts/enable` | Enable IDN Accounts for Identities
[**Get-V2024Account**](#get-account) | **GET** `/accounts/{id}` | Account Details
[**Get-V2024AccountEntitlements**](#get-account-entitlements) | **GET** `/accounts/{id}/entitlements` | Account Entitlements
[**Get-V2024Accounts**](#list-accounts) | **GET** `/accounts` | Accounts List
[**Send-V2024Account**](#put-account) | **PUT** `/accounts/{id}` | Update Account
[**Submit-V2024ReloadAccount**](#submit-reload-account) | **POST** `/accounts/{id}/reload` | Reload Account
[**Unlock-V2024Account**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock Account
[**Update-V2024Account**](#update-account) | **PATCH** `/accounts/{id}` | Update Account
[**New-V2024Account**](#create-account) | **POST** `/accounts` | Create account
[**Remove-V2024Account**](#delete-account) | **DELETE** `/accounts/{id}` | Delete account
[**Remove-V2024AccountAsync**](#delete-account-async) | **POST** `/accounts/{id}/remove` | Remove account
[**Disable-V2024Account**](#disable-account) | **POST** `/accounts/{id}/disable` | Disable account
[**Disable-V2024AccountForIdentity**](#disable-account-for-identity) | **POST** `/identities-accounts/{id}/disable` | Disable idn account for identity
[**Disable-V2024AccountsForIdentities**](#disable-accounts-for-identities) | **POST** `/identities-accounts/disable` | Disable idn accounts for identities
[**Enable-V2024Account**](#enable-account) | **POST** `/accounts/{id}/enable` | Enable account
[**Enable-V2024AccountForIdentity**](#enable-account-for-identity) | **POST** `/identities-accounts/{id}/enable` | Enable idn account for identity
[**Enable-V2024AccountsForIdentities**](#enable-accounts-for-identities) | **POST** `/identities-accounts/enable` | Enable idn accounts for identities
[**Get-V2024Account**](#get-account) | **GET** `/accounts/{id}` | Account details
[**Get-V2024AccountEntitlements**](#get-account-entitlements) | **GET** `/accounts/{id}/entitlements` | Account entitlements
[**Get-V2024Accounts**](#list-accounts) | **GET** `/accounts` | Accounts list
[**Send-V2024Account**](#put-account) | **PUT** `/accounts/{id}` | Update account
[**Submit-V2024ReloadAccount**](#submit-reload-account) | **POST** `/accounts/{id}/reload` | Reload account
[**Unlock-V2024Account**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock account
[**Update-V2024Account**](#update-account) | **PATCH** `/accounts/{id}` | Update account
## create-account
@@ -113,7 +113,7 @@ $AccountAttributesCreate = @"{
}
}"@
# Create Account
# Create account
try {
$Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate
@@ -163,7 +163,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
# Delete Account
# Delete account
try {
Remove-V2024Account -Id $Id
@@ -219,7 +219,7 @@ Code | Description | Data Type
$Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Remove Account
# Remove account
try {
Remove-V2024AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -270,7 +270,7 @@ $AccountToggleRequest = @"{
"externalVerificationId" : "3f9180835d2e5168015d32f890ca1581"
}"@
# Disable Account
# Disable account
try {
$Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest
@@ -322,7 +322,7 @@ Code | Description | Data Type
$Id = "2c91808384203c2d018437e631158309" # String | The identity id.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Disable IDN Account for Identity
# Disable idn account for identity
try {
Disable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -374,7 +374,7 @@ $IdentitiesAccountsBulkRequest = @"{
"identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
}"@
# Disable IDN Accounts for Identities
# Disable idn accounts for identities
try {
$Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest
@@ -426,7 +426,7 @@ $AccountToggleRequest = @"{
"externalVerificationId" : "3f9180835d2e5168015d32f890ca1581"
}"@
# Enable Account
# Enable account
try {
$Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest
@@ -478,7 +478,7 @@ Code | Description | Data Type
$Id = "2c91808384203c2d018437e631158309" # String | The identity id.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Enable IDN Account for Identity
# Enable idn account for identity
try {
Enable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -530,7 +530,7 @@ $IdentitiesAccountsBulkRequest = @"{
"identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
}"@
# Enable IDN Accounts for Identities
# Enable idn accounts for identities
try {
$Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest
@@ -577,7 +577,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
# Account Details
# Account details
try {
Get-V2024Account -Id $Id
@@ -629,7 +629,7 @@ $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)
# Account Entitlements
# Account entitlements
try {
Get-V2024AccountEntitlements -Id $Id
@@ -684,7 +684,7 @@ $DetailLevel = "SLIM" # String | This value determines whether the API provides
$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* **hasEntitlements**: *eq* **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* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (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, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional)
# Accounts List
# Accounts list
try {
Get-V2024Accounts
@@ -745,7 +745,7 @@ $AccountAttributes = @"{
}
}"@
# Update Account
# Update account
try {
$Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes
@@ -792,7 +792,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id
# Reload Account
# Reload account
try {
Submit-V2024ReloadAccount -Id $Id
@@ -845,7 +845,7 @@ $AccountUnlockRequest = @"{
"unlockIDNAccount" : false
}"@
# Unlock Account
# Unlock account
try {
$Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest
@@ -906,7 +906,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of account update operat
$RequestBody = @"[{op=remove, path=/identityId}]"@ # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
# Update Account
# Update account
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody

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

@@ -19,9 +19,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024DiscoveredApplications**](#get-discovered-applications) | **GET** `/discovered-applications` | Get Discovered Applications for Tenant
[**Get-V2024ManualDiscoverApplicationsCsvTemplate**](#get-manual-discover-applications-csv-template) | **GET** `/manual-discover-applications-template` | Download CSV Template for Discovery
[**Send-V2024ManualDiscoverApplicationsCsvTemplate**](#send-manual-discover-applications-csv-template) | **POST** `/manual-discover-applications` | Upload CSV to Discover Applications
[**Get-V2024DiscoveredApplications**](#get-discovered-applications) | **GET** `/discovered-applications` | Get discovered applications for tenant
[**Get-V2024ManualDiscoverApplicationsCsvTemplate**](#get-manual-discover-applications-csv-template) | **GET** `/manual-discover-applications-template` | Download csv template for discovery
[**Send-V2024ManualDiscoverApplicationsCsvTemplate**](#send-manual-discover-applications-csv-template) | **POST** `/manual-discover-applications` | Upload csv to discover applications
## get-discovered-applications
@@ -64,7 +64,7 @@ $Detail = "SLIM" # String | Determines whether slim, or increased level of detai
$Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional)
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional)
# Get Discovered Applications for Tenant
# Get discovered applications for tenant
try {
Get-V2024DiscoveredApplications
@@ -110,7 +110,7 @@ Code | Description | Data Type
### Example
```powershell
# Download CSV Template for Discovery
# Download csv template for discovery
try {
Get-V2024ManualDiscoverApplicationsCsvTemplate
@@ -156,7 +156,7 @@ Code | Description | Data Type
```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
# Upload csv to discover applications
try {
Send-V2024ManualDiscoverApplicationsCsvTemplate -File $File

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

@@ -21,7 +21,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024Approval**](#get-approval) | **GET** `/generic-approvals/{id}` | Get an approval
[**Get-V2024Approvals**](#get-approvals) | **GET** `/generic-approvals` | Get Approvals
[**Get-V2024Approvals**](#get-approvals) | **GET** `/generic-approvals` | Get approvals
## get-approval
@@ -115,7 +115,7 @@ $Mine = $true # Boolean | Returns the list of approvals for the current caller (
$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
# Get approvals
try {
Get-V2024Approvals -XSailPointExperimental $XSailPointExperimental

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

@@ -21,8 +21,8 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024SourceApp**](#create-source-app) | **POST** `/source-apps` | Create source app
[**Remove-V2024AccessProfilesFromSourceAppByBulk**](#delete-access-profiles-from-source-app-by-bulk) | **POST** `/source-apps/{id}/access-profiles/bulk-remove` | Bulk remove access profiles from the specified source app
[**Remove-V2024SourceApp**](#delete-source-app) | **DELETE** `/source-apps/{id}` | Delete source app by ID
[**Get-V2024SourceApp**](#get-source-app) | **GET** `/source-apps/{id}` | Get source app by ID
[**Remove-V2024SourceApp**](#delete-source-app) | **DELETE** `/source-apps/{id}` | Delete source app by id
[**Get-V2024SourceApp**](#get-source-app) | **GET** `/source-apps/{id}` | Get source app by id
[**Get-V2024AccessProfilesForSourceApp**](#list-access-profiles-for-source-app) | **GET** `/source-apps/{id}/access-profiles` | List access profiles for the specified source app
[**Get-V2024AllSourceApp**](#list-all-source-app) | **GET** `/source-apps/all` | List all source apps
[**Get-V2024AllUserApps**](#list-all-user-apps) | **GET** `/user-apps/all` | List all user apps
@@ -30,8 +30,8 @@ Method | HTTP request | Description
[**Get-V2024AvailableAccountsForUserApp**](#list-available-accounts-for-user-app) | **GET** `/user-apps/{id}/available-accounts` | List available accounts for user app
[**Get-V2024AvailableSourceApps**](#list-available-source-apps) | **GET** `/source-apps` | List available source apps
[**Get-V2024OwnedUserApps**](#list-owned-user-apps) | **GET** `/user-apps` | List owned user apps
[**Update-V2024SourceApp**](#patch-source-app) | **PATCH** `/source-apps/{id}` | Patch source app by ID
[**Update-V2024UserApp**](#patch-user-app) | **PATCH** `/user-apps/{id}` | Patch user app by ID
[**Update-V2024SourceApp**](#patch-source-app) | **PATCH** `/source-apps/{id}` | Patch source app by id
[**Update-V2024UserApp**](#patch-user-app) | **PATCH** `/user-apps/{id}` | Patch user app by id
[**Update-V2024SourceAppsInBulk**](#update-source-apps-in-bulk) | **POST** `/source-apps/bulk-update` | Bulk update source apps
@@ -188,7 +188,7 @@ Code | Description | Data Type
$Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Delete source app by ID
# Delete source app by id
try {
Remove-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -239,7 +239,7 @@ Code | Description | Data Type
$Id = "2c91808a7813090a017814121e121518" # String | ID of the source app
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get source app by ID
# Get source app by id
try {
Get-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -696,7 +696,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
}"@ # JsonPatchOperation[] | (optional)
# Patch source app by ID
# Patch source app by id
try {
Update-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -755,7 +755,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
}"@ # JsonPatchOperation[] | (optional)
# Patch user app by ID
# Patch user app by id
try {
Update-V2024UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental

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

@@ -23,9 +23,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024ProfileConfig**](#get-profile-config) | **GET** `/auth-profiles/{id}` | Get Auth Profile
[**Get-V2024ProfileConfigList**](#get-profile-config-list) | **GET** `/auth-profiles` | Get list of Auth Profiles
[**Update-V2024ProfileConfig**](#patch-profile-config) | **PATCH** `/auth-profiles/{id}` | Patch a specified Auth Profile
[**Get-V2024ProfileConfig**](#get-profile-config) | **GET** `/auth-profiles/{id}` | Get auth profile
[**Get-V2024ProfileConfigList**](#get-profile-config-list) | **GET** `/auth-profiles` | Get list of auth profiles
[**Update-V2024ProfileConfig**](#patch-profile-config) | **PATCH** `/auth-profiles/{id}` | Patch a specified auth profile
## get-profile-config
@@ -65,7 +65,7 @@ Code | Description | Data Type
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch.
# Get Auth Profile
# Get auth profile
try {
Get-V2024ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id
@@ -113,7 +113,7 @@ Code | Description | Data Type
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get list of Auth Profiles
# Get list of auth profiles
try {
Get-V2024ProfileConfigList -XSailPointExperimental $XSailPointExperimental
@@ -171,7 +171,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
}"@ # JsonPatchOperation[] |
# Patch a specified Auth Profile
# Patch a specified auth profile
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation

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

@@ -22,8 +22,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024AuthUser**](#get-auth-user) | **GET** `/auth-users/{id}` | Auth User Details
[**Update-V2024AuthUser**](#patch-auth-user) | **PATCH** `/auth-users/{id}` | Auth User Update
[**Get-V2024AuthUser**](#get-auth-user) | **GET** `/auth-users/{id}` | Auth user details
[**Update-V2024AuthUser**](#patch-auth-user) | **PATCH** `/auth-users/{id}` | Auth user update
## get-auth-user
@@ -58,7 +58,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID
# Auth User Details
# Auth user details
try {
Get-V2024AuthUser -Id $Id
@@ -115,7 +115,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID
}"@ # JsonPatchOperation[] | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
# Auth User Update
# Auth user update
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation

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

@@ -44,11 +44,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024CampaignFilter**](#create-campaign-filter) | **POST** `/campaign-filters` | Create Campaign Filter
[**Remove-V2024CampaignFilters**](#delete-campaign-filters) | **POST** `/campaign-filters/delete` | Deletes Campaign Filters
[**Get-V2024CampaignFilterById**](#get-campaign-filter-by-id) | **GET** `/campaign-filters/{id}` | Get Campaign Filter by ID
[**Get-V2024CampaignFilters**](#list-campaign-filters) | **GET** `/campaign-filters` | List Campaign Filters
[**Update-V2024CampaignFilter**](#update-campaign-filter) | **POST** `/campaign-filters/{id}` | Updates a Campaign Filter
[**New-V2024CampaignFilter**](#create-campaign-filter) | **POST** `/campaign-filters` | Create campaign filter
[**Remove-V2024CampaignFilters**](#delete-campaign-filters) | **POST** `/campaign-filters/delete` | Deletes campaign filters
[**Get-V2024CampaignFilterById**](#get-campaign-filter-by-id) | **GET** `/campaign-filters/{id}` | Get campaign filter by id
[**Get-V2024CampaignFilters**](#list-campaign-filters) | **GET** `/campaign-filters` | List campaign filters
[**Update-V2024CampaignFilter**](#update-campaign-filter) | **POST** `/campaign-filters/{id}` | Updates a campaign filter
## create-campaign-filter
@@ -99,7 +99,7 @@ $CampaignFilterDetails = @"{
} ]
}"@
# Create Campaign Filter
# Create campaign filter
try {
$Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails
@@ -148,7 +148,7 @@ $RequestBody = "MyRequestBody" # String[] | A json list of IDs of campaign filte
$RequestBody = @""@ # String[] | A json list of IDs of campaign filters to delete.
# Deletes Campaign Filters
# Deletes campaign filters
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
@@ -195,7 +195,7 @@ Code | Description | Data Type
```powershell
$Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter to be retrieved.
# Get Campaign Filter by ID
# Get campaign filter by id
try {
Get-V2024CampaignFilterById -Id $Id
@@ -244,7 +244,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Start = 0 # Int32 | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$IncludeSystemFilters = $true # Boolean | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to $true)
# List Campaign Filters
# List campaign filters
try {
Get-V2024CampaignFilters
@@ -308,7 +308,7 @@ $CampaignFilterDetails = @"{
} ]
}"@
# Updates a Campaign Filter
# Updates a campaign filter
try {
$Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails

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

@@ -82,28 +82,28 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Complete-V2024Campaign**](#complete-campaign) | **POST** `/campaigns/{id}/complete` | Complete a Campaign
[**Complete-V2024Campaign**](#complete-campaign) | **POST** `/campaigns/{id}/complete` | Complete a campaign
[**New-V2024Campaign**](#create-campaign) | **POST** `/campaigns` | Create a campaign
[**New-V2024CampaignTemplate**](#create-campaign-template) | **POST** `/campaign-templates` | Create a Campaign Template
[**Remove-V2024CampaignTemplate**](#delete-campaign-template) | **DELETE** `/campaign-templates/{id}` | Delete a Campaign Template
[**Remove-V2024CampaignTemplateSchedule**](#delete-campaign-template-schedule) | **DELETE** `/campaign-templates/{id}/schedule` | Delete Campaign Template Schedule
[**Remove-V2024Campaigns**](#delete-campaigns) | **POST** `/campaigns/delete` | Delete Campaigns
[**Get-V2024ActiveCampaigns**](#get-active-campaigns) | **GET** `/campaigns` | List Campaigns
[**Get-V2024Campaign**](#get-campaign) | **GET** `/campaigns/{id}` | Get Campaign
[**Get-V2024CampaignReports**](#get-campaign-reports) | **GET** `/campaigns/{id}/reports` | Get Campaign Reports
[**Get-V2024CampaignReportsConfig**](#get-campaign-reports-config) | **GET** `/campaigns/reports-configuration` | Get Campaign Reports Configuration
[**Get-V2024CampaignTemplate**](#get-campaign-template) | **GET** `/campaign-templates/{id}` | Get a Campaign Template
[**Get-V2024CampaignTemplateSchedule**](#get-campaign-template-schedule) | **GET** `/campaign-templates/{id}/schedule` | Get Campaign Template Schedule
[**Get-V2024CampaignTemplates**](#get-campaign-templates) | **GET** `/campaign-templates` | List Campaign Templates
[**Move-V2024**](#move) | **POST** `/campaigns/{id}/reassign` | Reassign Certifications
[**Update-V2024CampaignTemplate**](#patch-campaign-template) | **PATCH** `/campaign-templates/{id}` | Update a Campaign Template
[**Set-V2024CampaignReportsConfig**](#set-campaign-reports-config) | **PUT** `/campaigns/reports-configuration` | Set Campaign Reports Configuration
[**Set-V2024CampaignTemplateSchedule**](#set-campaign-template-schedule) | **PUT** `/campaign-templates/{id}/schedule` | Set Campaign Template Schedule
[**Start-V2024Campaign**](#start-campaign) | **POST** `/campaigns/{id}/activate` | Activate a Campaign
[**Start-V2024CampaignRemediationScan**](#start-campaign-remediation-scan) | **POST** `/campaigns/{id}/run-remediation-scan` | Run Campaign Remediation Scan
[**Start-V2024CampaignReport**](#start-campaign-report) | **POST** `/campaigns/{id}/run-report/{type}` | Run Campaign Report
[**Start-V2024GenerateCampaignTemplate**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a Campaign from Template
[**Update-V2024Campaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a Campaign
[**New-V2024CampaignTemplate**](#create-campaign-template) | **POST** `/campaign-templates` | Create a campaign template
[**Remove-V2024CampaignTemplate**](#delete-campaign-template) | **DELETE** `/campaign-templates/{id}` | Delete a campaign template
[**Remove-V2024CampaignTemplateSchedule**](#delete-campaign-template-schedule) | **DELETE** `/campaign-templates/{id}/schedule` | Delete campaign template schedule
[**Remove-V2024Campaigns**](#delete-campaigns) | **POST** `/campaigns/delete` | Delete campaigns
[**Get-V2024ActiveCampaigns**](#get-active-campaigns) | **GET** `/campaigns` | List campaigns
[**Get-V2024Campaign**](#get-campaign) | **GET** `/campaigns/{id}` | Get campaign
[**Get-V2024CampaignReports**](#get-campaign-reports) | **GET** `/campaigns/{id}/reports` | Get campaign reports
[**Get-V2024CampaignReportsConfig**](#get-campaign-reports-config) | **GET** `/campaigns/reports-configuration` | Get campaign reports configuration
[**Get-V2024CampaignTemplate**](#get-campaign-template) | **GET** `/campaign-templates/{id}` | Get a campaign template
[**Get-V2024CampaignTemplateSchedule**](#get-campaign-template-schedule) | **GET** `/campaign-templates/{id}/schedule` | Get campaign template schedule
[**Get-V2024CampaignTemplates**](#get-campaign-templates) | **GET** `/campaign-templates` | List campaign templates
[**Move-V2024**](#move) | **POST** `/campaigns/{id}/reassign` | Reassign certifications
[**Update-V2024CampaignTemplate**](#patch-campaign-template) | **PATCH** `/campaign-templates/{id}` | Update a campaign template
[**Set-V2024CampaignReportsConfig**](#set-campaign-reports-config) | **PUT** `/campaigns/reports-configuration` | Set campaign reports configuration
[**Set-V2024CampaignTemplateSchedule**](#set-campaign-template-schedule) | **PUT** `/campaign-templates/{id}/schedule` | Set campaign template schedule
[**Start-V2024Campaign**](#start-campaign) | **POST** `/campaigns/{id}/activate` | Activate a campaign
[**Start-V2024CampaignRemediationScan**](#start-campaign-remediation-scan) | **POST** `/campaigns/{id}/run-remediation-scan` | Run campaign remediation scan
[**Start-V2024CampaignReport**](#start-campaign-report) | **POST** `/campaigns/{id}/run-report/{type}` | Run campaign report
[**Start-V2024GenerateCampaignTemplate**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a campaign from template
[**Update-V2024Campaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a campaign
## complete-campaign
@@ -152,7 +152,7 @@ $CampaignCompleteOptions = @"{
"autoCompleteAction" : "REVOKE"
}"@
# Complete a Campaign
# Complete a campaign
try {
Complete-V2024Campaign -Id $Id
@@ -478,7 +478,7 @@ $CampaignTemplate = @"{
"id" : "2c9079b270a266a60170a277bb960008"
}"@
# Create a Campaign Template
# Create a campaign template
try {
$Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate
@@ -526,7 +526,7 @@ Code | Description | Data Type
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted.
# Delete a Campaign Template
# Delete a campaign template
try {
Remove-V2024CampaignTemplate -Id $Id
@@ -573,7 +573,7 @@ Code | Description | Data Type
```powershell
$Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted.
# Delete Campaign Template Schedule
# Delete campaign template schedule
try {
Remove-V2024CampaignTemplateSchedule -Id $Id
@@ -622,7 +622,7 @@ $CampaignsDeleteRequest = @"{
"ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ]
}"@
# Delete Campaigns
# Delete campaigns
try {
$Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest
@@ -679,7 +679,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$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
# List campaigns
try {
Get-V2024ActiveCampaigns
@@ -728,7 +728,7 @@ Code | Description | Data Type
$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved.
$Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional)
# Get Campaign
# Get campaign
try {
Get-V2024Campaign -Id $Id
@@ -775,7 +775,7 @@ Code | Description | Data Type
```powershell
$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched.
# Get Campaign Reports
# Get campaign reports
try {
Get-V2024CampaignReports -Id $Id
@@ -819,7 +819,7 @@ Code | Description | Data Type
### Example
```powershell
# Get Campaign Reports Configuration
# Get campaign reports configuration
try {
Get-V2024CampaignReportsConfig
@@ -866,7 +866,7 @@ Code | Description | Data Type
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID.
# Get a Campaign Template
# Get a campaign template
try {
Get-V2024CampaignTemplate -Id $Id
@@ -913,7 +913,7 @@ Code | Description | Data Type
```powershell
$Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched.
# Get Campaign Template Schedule
# Get campaign template schedule
try {
Get-V2024CampaignTemplateSchedule -Id $Id
@@ -969,7 +969,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$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
# List campaign templates
try {
Get-V2024CampaignTemplates
@@ -1025,7 +1025,7 @@ $AdminReviewReassign = @"{
}
}"@
# Reassign Certifications
# Reassign certifications
try {
$Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign
@@ -1080,7 +1080,7 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template
}"@ # 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
# Update a campaign template
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
@@ -1129,7 +1129,7 @@ $CampaignReportsConfig = @"{
"identityAttributeColumns" : [ "firstname", "lastname" ]
}"@
# Set Campaign Reports Configuration
# Set campaign reports configuration
try {
$Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig
@@ -1198,7 +1198,7 @@ $Schedule = @"{
"type" : "WEEKLY"
}"@
# Set Campaign Template Schedule
# Set campaign template schedule
try {
Set-V2024CampaignTemplateSchedule -Id $Id
@@ -1249,7 +1249,7 @@ $ActivateCampaignOptions = @"{
"timeZone" : "-05:00"
}"@
# Activate a Campaign
# Activate a campaign
try {
Start-V2024Campaign -Id $Id
@@ -1296,7 +1296,7 @@ Code | Description | Data Type
```powershell
$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for.
# Run Campaign Remediation Scan
# Run campaign remediation scan
try {
Start-V2024CampaignRemediationScan -Id $Id
@@ -1345,7 +1345,7 @@ Code | Description | Data Type
$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for.
$Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run.
# Run Campaign Report
# Run campaign report
try {
Start-V2024CampaignReport -Id $Id -Type $Type
@@ -1401,7 +1401,7 @@ Code | Description | Data Type
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation.
# Generate a Campaign from Template
# Generate a campaign from template
try {
Start-V2024GenerateCampaignTemplate -Id $Id
@@ -1455,7 +1455,7 @@ $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template
}"@ # JsonPatchOperation[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline
# Update a Campaign
# Update a campaign
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation

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

@@ -31,10 +31,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024IdentityAccessSummaries**](#get-identity-access-summaries) | **GET** `/certifications/{id}/access-summaries/{type}` | Access Summaries
[**Get-V2024IdentityDecisionSummary**](#get-identity-decision-summary) | **GET** `/certifications/{id}/decision-summary` | Summary of Certification Decisions
[**Get-V2024IdentitySummaries**](#get-identity-summaries) | **GET** `/certifications/{id}/identity-summaries` | Identity Summaries for Campaign Certification
[**Get-V2024IdentitySummary**](#get-identity-summary) | **GET** `/certifications/{id}/identity-summaries/{identitySummaryId}` | Summary for Identity
[**Get-V2024IdentityAccessSummaries**](#get-identity-access-summaries) | **GET** `/certifications/{id}/access-summaries/{type}` | Access summaries
[**Get-V2024IdentityDecisionSummary**](#get-identity-decision-summary) | **GET** `/certifications/{id}/decision-summary` | Summary of certification decisions
[**Get-V2024IdentitySummaries**](#get-identity-summaries) | **GET** `/certifications/{id}/identity-summaries` | Identity summaries for campaign certification
[**Get-V2024IdentitySummary**](#get-identity-summary) | **GET** `/certifications/{id}/identity-summaries/{identitySummaryId}` | Summary for identity
## get-identity-access-summaries
@@ -81,7 +81,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'access.id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional)
$Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional)
# Access Summaries
# Access summaries
try {
Get-V2024IdentityAccessSummaries -Id $Id -Type $Type
@@ -129,7 +129,7 @@ Code | Description | Data Type
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID
$Filters = 'identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional)
# Summary of Certification Decisions
# Summary of certification decisions
try {
Get-V2024IdentityDecisionSummary -Id $Id
@@ -185,7 +185,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional)
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional)
# Identity Summaries for Campaign Certification
# Identity summaries for campaign certification
try {
Get-V2024IdentitySummaries -Id $Id
@@ -233,7 +233,7 @@ Code | Description | Data Type
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID
$IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID
# Summary for Identity
# Summary for identity
try {
Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId

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

@@ -40,17 +40,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024CertificationTask**](#get-certification-task) | **GET** `/certification-tasks/{id}` | Certification Task by ID
[**Get-V2024IdentityCertification**](#get-identity-certification) | **GET** `/certifications/{id}` | Identity Certification by ID
[**Get-V2024IdentityCertificationItemPermissions**](#get-identity-certification-item-permissions) | **GET** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for Entitlement Certification Item
[**Get-V2024PendingCertificationTasks**](#get-pending-certification-tasks) | **GET** `/certification-tasks` | List of Pending Certification Tasks
[**Get-V2024CertificationReviewers**](#list-certification-reviewers) | **GET** `/certifications/{id}/reviewers` | List of Reviewers for certification
[**Get-V2024IdentityAccessReviewItems**](#list-identity-access-review-items) | **GET** `/certifications/{id}/access-review-items` | List of Access Review Items
[**Get-V2024IdentityCertifications**](#list-identity-certifications) | **GET** `/certifications` | List Identity Campaign Certifications
[**Select-V2024IdentityDecision**](#make-identity-decision) | **POST** `/certifications/{id}/decide` | Decide on a Certification Item
[**Invoke-V2024ReassignIdentityCertifications**](#reassign-identity-certifications) | **POST** `/certifications/{id}/reassign` | Reassign Identities or Items
[**Invoke-V2024SignOffIdentityCertification**](#sign-off-identity-certification) | **POST** `/certifications/{id}/sign-off` | Finalize Identity Certification Decisions
[**Submit-V2024ReassignCertsAsync**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously
[**Get-V2024CertificationTask**](#get-certification-task) | **GET** `/certification-tasks/{id}` | Certification task by id
[**Get-V2024IdentityCertification**](#get-identity-certification) | **GET** `/certifications/{id}` | Identity certification by id
[**Get-V2024IdentityCertificationItemPermissions**](#get-identity-certification-item-permissions) | **GET** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for entitlement certification item
[**Get-V2024PendingCertificationTasks**](#get-pending-certification-tasks) | **GET** `/certification-tasks` | List of pending certification tasks
[**Get-V2024CertificationReviewers**](#list-certification-reviewers) | **GET** `/certifications/{id}/reviewers` | List of reviewers for certification
[**Get-V2024IdentityAccessReviewItems**](#list-identity-access-review-items) | **GET** `/certifications/{id}/access-review-items` | List of access review items
[**Get-V2024IdentityCertifications**](#list-identity-certifications) | **GET** `/certifications` | List identity campaign certifications
[**Select-V2024IdentityDecision**](#make-identity-decision) | **POST** `/certifications/{id}/decide` | Decide on a certification item
[**Invoke-V2024ReassignIdentityCertifications**](#reassign-identity-certifications) | **POST** `/certifications/{id}/reassign` | Reassign identities or items
[**Invoke-V2024SignOffIdentityCertification**](#sign-off-identity-certification) | **POST** `/certifications/{id}/sign-off` | Finalize identity certification decisions
[**Submit-V2024ReassignCertsAsync**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign certifications asynchronously
## get-certification-task
@@ -85,7 +85,7 @@ Code | Description | Data Type
```powershell
$Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID
# Certification Task by ID
# Certification task by id
try {
Get-V2024CertificationTask -Id $Id
@@ -131,7 +131,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id
# Identity Certification by ID
# Identity certification by id
try {
Get-V2024IdentityCertification -Id $Id
@@ -187,7 +187,7 @@ $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)
# Permissions for Entitlement Certification Item
# Permissions for entitlement certification item
try {
Get-V2024IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId
@@ -241,7 +241,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'type eq "ADMIN_REASSIGN"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional)
# List of Pending Certification Tasks
# List of pending certification tasks
try {
Get-V2024PendingCertificationTasks
@@ -297,7 +297,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$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
# List of reviewers for certification
try {
Get-V2024CertificationReviewers -Id $Id
@@ -359,7 +359,7 @@ $Entitlements = "identityEntitlement" # String | Filter results to view access r
$AccessProfiles = "accessProfile1" # String | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional)
$Roles = "userRole" # String | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional)
# List of Access Review Items
# List of access review items
try {
Get-V2024IdentityAccessReviewItems -Id $Id
@@ -414,7 +414,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional)
$Sorters = "name,due" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional)
# List Identity Campaign Certifications
# List identity campaign certifications
try {
Get-V2024IdentityCertifications
@@ -474,7 +474,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campa
}"@ # ReviewDecision[] | A non-empty array of decisions to be made.
# Decide on a Certification Item
# Decide on a certification item
try {
$Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision
@@ -533,7 +533,7 @@ $ReviewReassign = @"{
} ]
}"@
# Reassign Identities or Items
# Reassign identities or items
try {
$Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign
@@ -580,7 +580,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID
# Finalize Identity Certification Decisions
# Finalize identity certification decisions
try {
Invoke-V2024SignOffIdentityCertification -Id $Id
@@ -643,7 +643,7 @@ $ReviewReassign = @"{
} ]
}"@
# Reassign Certifications Asynchronously
# Reassign certifications asynchronously
try {
$Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign

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

@@ -28,26 +28,26 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024Deploy**](#create-deploy) | **POST** `/configuration-hub/deploys` | Create a Deploy
[**New-V2024Deploy**](#create-deploy) | **POST** `/configuration-hub/deploys` | Create a deploy
[**New-V2024ObjectMapping**](#create-object-mapping) | **POST** `/configuration-hub/object-mappings/{sourceOrg}` | Creates an object mapping
[**New-V2024ObjectMappings**](#create-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-create` | Bulk creates object mappings
[**New-V2024ScheduledAction**](#create-scheduled-action) | **POST** `/configuration-hub/scheduled-actions` | Create Scheduled Action
[**New-V2024UploadedConfiguration**](#create-uploaded-configuration) | **POST** `/configuration-hub/backups/uploads` | Upload a Configuration
[**Remove-V2024Backup**](#delete-backup) | **DELETE** `/configuration-hub/backups/{id}` | Delete a Backup
[**New-V2024ScheduledAction**](#create-scheduled-action) | **POST** `/configuration-hub/scheduled-actions` | Create scheduled action
[**New-V2024UploadedConfiguration**](#create-uploaded-configuration) | **POST** `/configuration-hub/backups/uploads` | Upload a configuration
[**Remove-V2024Backup**](#delete-backup) | **DELETE** `/configuration-hub/backups/{id}` | Delete a backup
[**Remove-V2024Draft**](#delete-draft) | **DELETE** `/configuration-hub/drafts/{id}` | Delete a draft
[**Remove-V2024ObjectMapping**](#delete-object-mapping) | **DELETE** `/configuration-hub/object-mappings/{sourceOrg}/{objectMappingId}` | Deletes an object mapping
[**Remove-V2024ScheduledAction**](#delete-scheduled-action) | **DELETE** `/configuration-hub/scheduled-actions/{id}` | Delete Scheduled Action
[**Remove-V2024UploadedConfiguration**](#delete-uploaded-configuration) | **DELETE** `/configuration-hub/backups/uploads/{id}` | Delete an Uploaded Configuration
[**Get-V2024Deploy**](#get-deploy) | **GET** `/configuration-hub/deploys/{id}` | Get a Deploy
[**Remove-V2024ScheduledAction**](#delete-scheduled-action) | **DELETE** `/configuration-hub/scheduled-actions/{id}` | Delete scheduled action
[**Remove-V2024UploadedConfiguration**](#delete-uploaded-configuration) | **DELETE** `/configuration-hub/backups/uploads/{id}` | Delete an uploaded configuration
[**Get-V2024Deploy**](#get-deploy) | **GET** `/configuration-hub/deploys/{id}` | Get a deploy
[**Get-V2024ObjectMappings**](#get-object-mappings) | **GET** `/configuration-hub/object-mappings/{sourceOrg}` | Gets list of object mappings
[**Get-V2024UploadedConfiguration**](#get-uploaded-configuration) | **GET** `/configuration-hub/backups/uploads/{id}` | Get an Uploaded Configuration
[**Get-V2024Backups**](#list-backups) | **GET** `/configuration-hub/backups` | List Backups
[**Get-V2024Deploys**](#list-deploys) | **GET** `/configuration-hub/deploys` | List Deploys
[**Get-V2024Drafts**](#list-drafts) | **GET** `/configuration-hub/drafts` | List Drafts
[**Get-V2024ScheduledActions**](#list-scheduled-actions) | **GET** `/configuration-hub/scheduled-actions` | List Scheduled Actions
[**Get-V2024UploadedConfigurations**](#list-uploaded-configurations) | **GET** `/configuration-hub/backups/uploads` | List Uploaded Configurations
[**Get-V2024UploadedConfiguration**](#get-uploaded-configuration) | **GET** `/configuration-hub/backups/uploads/{id}` | Get an uploaded configuration
[**Get-V2024Backups**](#list-backups) | **GET** `/configuration-hub/backups` | List backups
[**Get-V2024Deploys**](#list-deploys) | **GET** `/configuration-hub/deploys` | List deploys
[**Get-V2024Drafts**](#list-drafts) | **GET** `/configuration-hub/drafts` | List drafts
[**Get-V2024ScheduledActions**](#list-scheduled-actions) | **GET** `/configuration-hub/scheduled-actions` | List scheduled actions
[**Get-V2024UploadedConfigurations**](#list-uploaded-configurations) | **GET** `/configuration-hub/backups/uploads` | List uploaded configurations
[**Update-V2024ObjectMappings**](#update-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-patch` | Bulk updates object mappings
[**Update-V2024ScheduledAction**](#update-scheduled-action) | **PATCH** `/configuration-hub/scheduled-actions/{id}` | Update Scheduled Action
[**Update-V2024ScheduledAction**](#update-scheduled-action) | **PATCH** `/configuration-hub/scheduled-actions/{id}` | Update scheduled action
## create-deploy
@@ -83,7 +83,7 @@ $DeployRequest = @"{
"draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b"
}"@
# Create a Deploy
# Create a deploy
try {
$Result = ConvertFrom-JsonToDeployRequest -Json $DeployRequest
@@ -275,7 +275,7 @@ $ScheduledActionPayload = @"{
}
}"@
# Create Scheduled Action
# Create scheduled action
try {
$Result = ConvertFrom-JsonToScheduledActionPayload -Json $ScheduledActionPayload
@@ -327,7 +327,7 @@ Code | Description | Data Type
$Data = # System.IO.FileInfo | JSON file containing the objects to be imported.
$Name = "MyName" # String | Name that will be assigned to the uploaded configuration file.
# Upload a Configuration
# Upload a configuration
try {
New-V2024UploadedConfiguration -Data $Data -Name $Name
@@ -377,7 +377,7 @@ Code | Description | Data Type
```powershell
$Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the backup to delete.
# Delete a Backup
# Delete a backup
try {
Remove-V2024Backup -Id $Id
@@ -524,7 +524,7 @@ Code | Description | Data Type
```powershell
$ScheduledActionId = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the scheduled action.
# Delete Scheduled Action
# Delete scheduled action
try {
Remove-V2024ScheduledAction -ScheduledActionId $ScheduledActionId
@@ -574,7 +574,7 @@ Code | Description | Data Type
```powershell
$Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration.
# Delete an Uploaded Configuration
# Delete an uploaded configuration
try {
Remove-V2024UploadedConfiguration -Id $Id
@@ -620,7 +620,7 @@ Code | Description | Data Type
```powershell
$Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the deploy.
# Get a Deploy
# Get a deploy
try {
Get-V2024Deploy -Id $Id
@@ -715,7 +715,7 @@ Code | Description | Data Type
```powershell
$Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration.
# Get an Uploaded Configuration
# Get an uploaded configuration
try {
Get-V2024UploadedConfiguration -Id $Id
@@ -760,7 +760,7 @@ Code | Description | Data Type
```powershell
$Filters = 'status eq "COMPLETE"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional)
# List Backups
# List backups
try {
Get-V2024Backups
@@ -803,7 +803,7 @@ Code | Description | Data Type
### Example
```powershell
# List Deploys
# List deploys
try {
Get-V2024Deploys
@@ -848,7 +848,7 @@ Code | Description | Data Type
```powershell
$Filters = 'status eq "COMPLETE"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* (optional)
# List Drafts
# List drafts
try {
Get-V2024Drafts
@@ -891,7 +891,7 @@ Code | Description | Data Type
### Example
```powershell
# List Scheduled Actions
# List scheduled actions
try {
Get-V2024ScheduledActions
@@ -937,7 +937,7 @@ Code | Description | Data Type
```powershell
$Filters = 'status eq "COMPLETE"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional)
# List Uploaded Configurations
# List uploaded configurations
try {
Get-V2024UploadedConfigurations
@@ -1060,7 +1060,7 @@ $JsonPatch = @"{
} ]
}"@
# Update Scheduled Action
# Update scheduled action
try {
$Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch

16
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorCustomizersApi.md
View File

@@ -20,12 +20,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024ConnectorCustomizer**](#create-connector-customizer) | **POST** `/connector-customizers` | Create Connector Customizer
[**New-V2024ConnectorCustomizer**](#create-connector-customizer) | **POST** `/connector-customizers` | Create connector customizer
[**New-V2024ConnectorCustomizerVersion**](#create-connector-customizer-version) | **POST** `/connector-customizers/{id}/versions` | Creates a connector customizer version
[**Remove-V2024ConnectorCustomizer**](#delete-connector-customizer) | **DELETE** `/connector-customizers/{id}` | Delete Connector Customizer
[**Remove-V2024ConnectorCustomizer**](#delete-connector-customizer) | **DELETE** `/connector-customizers/{id}` | Delete connector customizer
[**Get-V2024ConnectorCustomizer**](#get-connector-customizer) | **GET** `/connector-customizers/{id}` | Get connector customizer
[**Get-V2024ConnectorCustomizers**](#list-connector-customizers) | **GET** `/connector-customizers` | List All Connector Customizers
[**Send-V2024ConnectorCustomizer**](#put-connector-customizer) | **PUT** `/connector-customizers/{id}` | Update Connector Customizer
[**Get-V2024ConnectorCustomizers**](#list-connector-customizers) | **GET** `/connector-customizers` | List all connector customizers
[**Send-V2024ConnectorCustomizer**](#put-connector-customizer) | **PUT** `/connector-customizers/{id}` | Update connector customizer
## create-connector-customizer
@@ -61,7 +61,7 @@ $ConnectorCustomizerCreateRequest = @"{
"name" : "My Custom Connector"
}"@
# Create Connector Customizer
# Create connector customizer
try {
$Result = ConvertFrom-JsonToConnectorCustomizerCreateRequest -Json $ConnectorCustomizerCreateRequest
@@ -154,7 +154,7 @@ Code | Description | Data Type
```powershell
$Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to delete.
# Delete Connector Customizer
# Delete connector customizer
try {
Remove-V2024ConnectorCustomizer -Id $Id
@@ -247,7 +247,7 @@ 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)
# List All Connector Customizers
# List all connector customizers
try {
Get-V2024ConnectorCustomizers
@@ -297,7 +297,7 @@ $ConnectorCustomizerUpdateRequest = @"{
"name" : "My Custom Connector"
}"@
# Update Connector Customizer
# Update connector customizer
try {
Send-V2024ConnectorCustomizer -Id $Id

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

@@ -24,12 +24,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024ConnectorRule**](#create-connector-rule) | **POST** `/connector-rules` | Create Connector Rule
[**Remove-V2024ConnectorRule**](#delete-connector-rule) | **DELETE** `/connector-rules/{id}` | Delete Connector Rule
[**Get-V2024ConnectorRule**](#get-connector-rule) | **GET** `/connector-rules/{id}` | Get Connector Rule
[**Get-V2024ConnectorRuleList**](#get-connector-rule-list) | **GET** `/connector-rules` | List Connector Rules
[**Send-V2024ConnectorRule**](#put-connector-rule) | **PUT** `/connector-rules/{id}` | Update Connector Rule
[**Test-V2024ConnectorRule**](#test-connector-rule) | **POST** `/connector-rules/validate` | Validate Connector Rule
[**New-V2024ConnectorRule**](#create-connector-rule) | **POST** `/connector-rules` | Create connector rule
[**Remove-V2024ConnectorRule**](#delete-connector-rule) | **DELETE** `/connector-rules/{id}` | Delete connector rule
[**Get-V2024ConnectorRule**](#get-connector-rule) | **GET** `/connector-rules/{id}` | Get connector rule
[**Get-V2024ConnectorRuleList**](#get-connector-rule-list) | **GET** `/connector-rules` | List connector rules
[**Send-V2024ConnectorRule**](#put-connector-rule) | **PUT** `/connector-rules/{id}` | Update connector rule
[**Test-V2024ConnectorRule**](#test-connector-rule) | **POST** `/connector-rules/validate` | Validate connector rule
## create-connector-rule
@@ -88,7 +88,7 @@ $ConnectorRuleCreateRequest = @"{
"type" : "BuildMap"
}"@
# Create Connector Rule
# Create connector rule
try {
$Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest
@@ -135,7 +135,7 @@ Code | Description | Data Type
```powershell
$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete.
# Delete Connector Rule
# Delete connector rule
try {
Remove-V2024ConnectorRule -Id $Id
@@ -181,7 +181,7 @@ Code | Description | Data Type
```powershell
$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to get.
# Get Connector Rule
# Get connector rule
try {
Get-V2024ConnectorRule -Id $Id
@@ -230,7 +230,7 @@ $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50.
$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 Connector Rules
# List connector rules
try {
Get-V2024ConnectorRuleList
@@ -304,7 +304,7 @@ $ConnectorRuleUpdateRequest = @"{
"type" : "BuildMap"
}"@
# Update Connector Rule
# Update connector rule
try {
Send-V2024ConnectorRule -Id $Id
@@ -352,7 +352,7 @@ $SourceCode = @"{
"script" : "return \"Mr. \" + firstName;"
}"@
# Validate Connector Rule
# Validate connector rule
try {
$Result = ConvertFrom-JsonToSourceCode -Json $SourceCode

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

@@ -31,19 +31,19 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024CustomConnector**](#create-custom-connector) | **POST** `/connectors` | Create Custom Connector
[**Remove-V2024CustomConnector**](#delete-custom-connector) | **DELETE** `/connectors/{scriptName}` | Delete Connector by Script Name
[**Get-V2024Connector**](#get-connector) | **GET** `/connectors/{scriptName}` | Get Connector by Script Name
[**Get-V2024ConnectorCorrelationConfig**](#get-connector-correlation-config) | **GET** `/connectors/{scriptName}/correlation-config` | Get Connector Correlation Configuration
[**Get-V2024ConnectorList**](#get-connector-list) | **GET** `/connectors` | Get Connector List
[**Get-V2024ConnectorSourceConfig**](#get-connector-source-config) | **GET** `/connectors/{scriptName}/source-config` | Get Connector Source Configuration
[**Get-V2024ConnectorSourceTemplate**](#get-connector-source-template) | **GET** `/connectors/{scriptName}/source-template` | Get Connector Source Template
[**Get-V2024ConnectorTranslations**](#get-connector-translations) | **GET** `/connectors/{scriptName}/translations/{locale}` | Get Connector Translations
[**Send-V2024ConnectorCorrelationConfig**](#put-connector-correlation-config) | **PUT** `/connectors/{scriptName}/correlation-config` | Update Connector Correlation Configuration
[**Send-V2024ConnectorSourceConfig**](#put-connector-source-config) | **PUT** `/connectors/{scriptName}/source-config` | Update Connector Source Configuration
[**Send-V2024ConnectorSourceTemplate**](#put-connector-source-template) | **PUT** `/connectors/{scriptName}/source-template` | Update Connector Source Template
[**Send-V2024ConnectorTranslations**](#put-connector-translations) | **PUT** `/connectors/{scriptName}/translations/{locale}` | Update Connector Translations
[**Update-V2024Connector**](#update-connector) | **PATCH** `/connectors/{scriptName}` | Update Connector by Script Name
[**New-V2024CustomConnector**](#create-custom-connector) | **POST** `/connectors` | Create custom connector
[**Remove-V2024CustomConnector**](#delete-custom-connector) | **DELETE** `/connectors/{scriptName}` | Delete connector by script name
[**Get-V2024Connector**](#get-connector) | **GET** `/connectors/{scriptName}` | Get connector by script name
[**Get-V2024ConnectorCorrelationConfig**](#get-connector-correlation-config) | **GET** `/connectors/{scriptName}/correlation-config` | Get connector correlation configuration
[**Get-V2024ConnectorList**](#get-connector-list) | **GET** `/connectors` | Get connector list
[**Get-V2024ConnectorSourceConfig**](#get-connector-source-config) | **GET** `/connectors/{scriptName}/source-config` | Get connector source configuration
[**Get-V2024ConnectorSourceTemplate**](#get-connector-source-template) | **GET** `/connectors/{scriptName}/source-template` | Get connector source template
[**Get-V2024ConnectorTranslations**](#get-connector-translations) | **GET** `/connectors/{scriptName}/translations/{locale}` | Get connector translations
[**Send-V2024ConnectorCorrelationConfig**](#put-connector-correlation-config) | **PUT** `/connectors/{scriptName}/correlation-config` | Update connector correlation configuration
[**Send-V2024ConnectorSourceConfig**](#put-connector-source-config) | **PUT** `/connectors/{scriptName}/source-config` | Update connector source configuration
[**Send-V2024ConnectorSourceTemplate**](#put-connector-source-template) | **PUT** `/connectors/{scriptName}/source-template` | Update connector source template
[**Send-V2024ConnectorTranslations**](#put-connector-translations) | **PUT** `/connectors/{scriptName}/translations/{locale}` | Update connector translations
[**Update-V2024Connector**](#update-connector) | **PATCH** `/connectors/{scriptName}` | Update connector by script name
## create-custom-connector
@@ -84,7 +84,7 @@ $V3CreateConnectorDto = @"{
"status" : "RELEASED"
}"@
# Create Custom Connector
# Create custom connector
try {
$Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto
@@ -131,7 +131,7 @@ Code | Description | Data Type
```powershell
$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
# Delete Connector by Script Name
# Delete connector by script name
try {
Remove-V2024CustomConnector -ScriptName $ScriptName
@@ -179,7 +179,7 @@ Code | Description | Data Type
$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional)
# Get Connector by Script Name
# Get connector by script name
try {
Get-V2024Connector -ScriptName $ScriptName
@@ -225,7 +225,7 @@ Code | Description | Data Type
```powershell
$ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
# Get Connector Correlation Configuration
# Get connector correlation configuration
try {
Get-V2024ConnectorCorrelationConfig -ScriptName $ScriptName
@@ -279,7 +279,7 @@ $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)
$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
# Get connector list
try {
Get-V2024ConnectorList
@@ -325,7 +325,7 @@ Code | Description | Data Type
```powershell
$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
# Get Connector Source Configuration
# Get connector source configuration
try {
Get-V2024ConnectorSourceConfig -ScriptName $ScriptName
@@ -371,7 +371,7 @@ Code | Description | Data Type
```powershell
$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
# Get Connector Source Template
# Get connector source template
try {
Get-V2024ConnectorSourceTemplate -ScriptName $ScriptName
@@ -419,7 +419,7 @@ Code | Description | Data Type
$ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en""
# Get Connector Translations
# Get connector translations
try {
Get-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale
@@ -467,7 +467,7 @@ Code | Description | Data Type
$ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
$File = # System.IO.FileInfo | connector correlation config xml file
# Update Connector Correlation Configuration
# Update connector correlation configuration
try {
Send-V2024ConnectorCorrelationConfig -ScriptName $ScriptName -File $File
@@ -515,7 +515,7 @@ Code | Description | Data Type
$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
$File = # System.IO.FileInfo | connector source config xml file
# Update Connector Source Configuration
# Update connector source configuration
try {
Send-V2024ConnectorSourceConfig -ScriptName $ScriptName -File $File
@@ -563,7 +563,7 @@ Code | Description | Data Type
$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
$File = # System.IO.FileInfo | connector source template xml file
# Update Connector Source Template
# Update connector source template
try {
Send-V2024ConnectorSourceTemplate -ScriptName $ScriptName -File $File
@@ -611,7 +611,7 @@ Code | Description | Data Type
$ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en""
# Update Connector Translations
# Update connector translations
try {
Send-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale
@@ -676,7 +676,7 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Sc
}"@ # JsonPatchOperation[] | A list of connector detail update operations
# Update Connector by Script Name
# Update connector by script name
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation

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

@@ -26,15 +26,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024FormDefinition**](#create-form-definition) | **POST** `/form-definitions` | Creates a form definition.
[**New-V2024FormDefinitionDynamicSchema**](#create-form-definition-dynamic-schema) | **POST** `/form-definitions/forms-action-dynamic-schema` | Generate JSON Schema dynamically.
[**New-V2024FormDefinitionDynamicSchema**](#create-form-definition-dynamic-schema) | **POST** `/form-definitions/forms-action-dynamic-schema` | Generate json schema dynamically.
[**New-V2024FormDefinitionFileRequest**](#create-form-definition-file-request) | **POST** `/form-definitions/{formDefinitionID}/upload` | Upload new form definition file.
[**New-V2024FormInstance**](#create-form-instance) | **POST** `/form-instances` | Creates a form instance.
[**Remove-V2024FormDefinition**](#delete-form-definition) | **DELETE** `/form-definitions/{formDefinitionID}` | Deletes a form definition.
[**Export-V2024FormDefinitionsByTenant**](#export-form-definitions-by-tenant) | **GET** `/form-definitions/export` | List form definitions by tenant.
[**Get-V2024FileFromS3**](#get-file-from-s3) | **GET** `/form-definitions/{formDefinitionID}/file/{fileID}` | Download definition file by fileId.
[**Get-V2024FileFromS3**](#get-file-from-s3) | **GET** `/form-definitions/{formDefinitionID}/file/{fileID}` | Download definition file by fileid.
[**Get-V2024FormDefinitionByKey**](#get-form-definition-by-key) | **GET** `/form-definitions/{formDefinitionID}` | Return a form definition.
[**Get-V2024FormInstanceByKey**](#get-form-instance-by-key) | **GET** `/form-instances/{formInstanceID}` | Returns a form instance.
[**Get-V2024FormInstanceFile**](#get-form-instance-file) | **GET** `/form-instances/{formInstanceID}/file/{fileID}` | Download instance file by fileId.
[**Get-V2024FormInstanceFile**](#get-form-instance-file) | **GET** `/form-instances/{formInstanceID}/file/{fileID}` | Download instance file by fileid.
[**Import-V2024FormDefinitions**](#import-form-definitions) | **POST** `/form-definitions/import` | Import form definitions from export.
[**Update-V2024FormDefinition**](#patch-form-definition) | **PATCH** `/form-definitions/{formDefinitionID}` | Patch a form definition.
[**Update-V2024FormInstance**](#patch-form-instance) | **PATCH** `/form-instances/{formInstanceID}` | Patch a form instance.
@@ -240,7 +240,7 @@ $Body = @"{
"versionNumber" : 1
}"@
# Generate JSON Schema dynamically.
# Generate json schema dynamically.
try {
New-V2024FormDefinitionDynamicSchema
@@ -502,7 +502,7 @@ Code | Description | Data Type
$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.
# Download definition file by fileid.
try {
Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID
@@ -643,7 +643,7 @@ Code | Description | Data Type
$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.
# Download instance file by fileid.
try {
Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID

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

@@ -28,9 +28,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024CustomPasswordInstructions**](#create-custom-password-instructions) | **POST** `/custom-password-instructions` | Create Custom Password Instructions
[**Remove-V2024CustomPasswordInstructions**](#delete-custom-password-instructions) | **DELETE** `/custom-password-instructions/{pageId}` | Delete Custom Password Instructions by page ID
[**Get-V2024CustomPasswordInstructions**](#get-custom-password-instructions) | **GET** `/custom-password-instructions/{pageId}` | Get Custom Password Instructions by Page ID
[**New-V2024CustomPasswordInstructions**](#create-custom-password-instructions) | **POST** `/custom-password-instructions` | Create custom password instructions
[**Remove-V2024CustomPasswordInstructions**](#delete-custom-password-instructions) | **DELETE** `/custom-password-instructions/{pageId}` | Delete custom password instructions by page id
[**Get-V2024CustomPasswordInstructions**](#get-custom-password-instructions) | **GET** `/custom-password-instructions/{pageId}` | Get custom password instructions by page id
## create-custom-password-instructions
@@ -71,7 +71,7 @@ $CustomPasswordInstruction = @"{
"locale" : "en"
}"@
# Create Custom Password Instructions
# Create custom password instructions
try {
$Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction
@@ -123,7 +123,7 @@ $PageId = "change-password:enter-password" # String | The page ID of custom pass
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$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
# Delete custom password instructions by page id
try {
Remove-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental
@@ -174,7 +174,7 @@ $PageId = "change-password:enter-password" # String | The page ID of custom pass
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$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
# Get custom password instructions by page id
try {
Get-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental

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

@@ -19,14 +19,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024DataSegment**](#create-data-segment) | **POST** `/data-segments` | Create Segment
[**Remove-V2024DataSegment**](#delete-data-segment) | **DELETE** `/data-segments/{segmentId}` | Delete Segment by ID
[**Get-V2024DataSegment**](#get-data-segment) | **GET** `/data-segments/{segmentId}` | Get Segment by ID
[**Get-V2024DataSegmentIdentityMembership**](#get-data-segment-identity-membership) | **GET** `/data-segments/membership/{identityId}` | Get SegmentMembership by Identity ID
[**Get-V2024DataSegmentationEnabledForUser**](#get-data-segmentation-enabled-for-user) | **GET** `/data-segments/user-enabled/{identityId}` | Is Segmentation enabled by Identity
[**Get-V2024DataSegments**](#list-data-segments) | **GET** `/data-segments` | Get Segments
[**Update-V2024DataSegment**](#patch-data-segment) | **PATCH** `/data-segments/{segmentId}` | Update Segment
[**Publish-V2024DataSegment**](#publish-data-segment) | **POST** `/data-segments/{segmentId}` | Publish segment by ID
[**New-V2024DataSegment**](#create-data-segment) | **POST** `/data-segments` | Create segment
[**Remove-V2024DataSegment**](#delete-data-segment) | **DELETE** `/data-segments/{segmentId}` | Delete segment by id
[**Get-V2024DataSegment**](#get-data-segment) | **GET** `/data-segments/{segmentId}` | Get segment by id
[**Get-V2024DataSegmentIdentityMembership**](#get-data-segment-identity-membership) | **GET** `/data-segments/membership/{identityId}` | Get segmentmembership by identity id
[**Get-V2024DataSegmentationEnabledForUser**](#get-data-segmentation-enabled-for-user) | **GET** `/data-segments/user-enabled/{identityId}` | Is segmentation enabled by identity
[**Get-V2024DataSegments**](#list-data-segments) | **GET** `/data-segments` | Get segments
[**Update-V2024DataSegment**](#patch-data-segment) | **PATCH** `/data-segments/{segmentId}` | Update segment
[**Publish-V2024DataSegment**](#publish-data-segment) | **POST** `/data-segments/{segmentId}` | Publish segment by id
## create-data-segment
@@ -61,7 +61,7 @@ Code | Description | Data Type
```powershell
$DataSegment = @""@
# Create Segment
# Create segment
try {
$Result = ConvertFrom-JsonToDataSegment -Json $DataSegment
@@ -115,7 +115,7 @@ $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to delete
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Published = $false # Boolean | This determines which version of the segment to delete (optional) (default to $false)
# Delete Segment by ID
# Delete segment by id
try {
Remove-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -166,7 +166,7 @@ Code | Description | Data Type
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to retrieve.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get Segment by ID
# Get segment by id
try {
Get-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -217,7 +217,7 @@ Code | Description | Data Type
$IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve the segments they are in.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get SegmentMembership by Identity ID
# Get segmentmembership by identity id
try {
Get-V2024DataSegmentIdentityMembership -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental
@@ -268,7 +268,7 @@ Code | Description | Data Type
$IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve if segmentation is enabled for the identity.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Is Segmentation enabled by Identity
# Is segmentation enabled by identity
try {
Get-V2024DataSegmentationEnabledForUser -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental
@@ -331,7 +331,7 @@ $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 ""' # 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, in, sw* (optional)
# Get Segments
# Get segments
try {
Get-V2024DataSegments -XSailPointExperimental $XSailPointExperimental
@@ -386,7 +386,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operat
$RequestBody = @"[{op=replace, path=/memberFilter, 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 * membership * memberFilter * memberSelection * scopes * enabled
# Update Segment
# Update segment
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
@@ -442,7 +442,7 @@ $RequestBody = "MyRequestBody" # String[] | A list of segment ids that you wish
$PublishAll = $true # Boolean | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to $true)
# Publish segment by ID
# Publish segment by id
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody

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

@@ -18,14 +18,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024Dimension**](#create-dimension) | **POST** `/roles/{roleId}/dimensions` | Create a Dimension
[**Remove-V2024BulkDimensions**](#delete-bulk-dimensions) | **POST** `/roles/{roleId}/dimensions/bulk-delete` | Delete Dimension(s)
[**Remove-V2024Dimension**](#delete-dimension) | **DELETE** `/roles/{roleId}/dimensions/{dimensionId}` | Delete a Dimension
[**Get-V2024Dimension**](#get-dimension) | **GET** `/roles/{roleId}/dimensions/{dimensionId}` | Get a Dimension under Role.
[**Get-V2024DimensionEntitlements**](#get-dimension-entitlements) | **GET** `/roles/{roleId}/dimensions/{dimensionId}/entitlements` | List Dimension's Entitlements
[**Get-V2024DimensionAccessProfiles**](#list-dimension-access-profiles) | **GET** `/roles/{roleId}/dimensions/{dimensionId}/access-profiles` | List Dimension's Access Profiles
[**Get-V2024Dimensions**](#list-dimensions) | **GET** `/roles/{roleId}/dimensions` | List Dimensions
[**Update-V2024Dimension**](#patch-dimension) | **PATCH** `/roles/{roleId}/dimensions/{dimensionId}` | Patch a specified Dimension
[**New-V2024Dimension**](#create-dimension) | **POST** `/roles/{roleId}/dimensions` | Create a dimension
[**Remove-V2024BulkDimensions**](#delete-bulk-dimensions) | **POST** `/roles/{roleId}/dimensions/bulk-delete` | Delete dimension(s)
[**Remove-V2024Dimension**](#delete-dimension) | **DELETE** `/roles/{roleId}/dimensions/{dimensionId}` | Delete a dimension
[**Get-V2024Dimension**](#get-dimension) | **GET** `/roles/{roleId}/dimensions/{dimensionId}` | Get a dimension under role.
[**Get-V2024DimensionEntitlements**](#get-dimension-entitlements) | **GET** `/roles/{roleId}/dimensions/{dimensionId}/entitlements` | List dimension's entitlements
[**Get-V2024DimensionAccessProfiles**](#list-dimension-access-profiles) | **GET** `/roles/{roleId}/dimensions/{dimensionId}/access-profiles` | List dimension's access profiles
[**Get-V2024Dimensions**](#list-dimensions) | **GET** `/roles/{roleId}/dimensions` | List dimensions
[**Update-V2024Dimension**](#patch-dimension) | **PATCH** `/roles/{roleId}/dimensions/{dimensionId}` | Patch a specified dimension
## create-dimension
@@ -150,7 +150,7 @@ $Dimension = @"{
"parentId" : "2c918086749d78830174a1a40e121518"
}"@
# Create a Dimension
# Create a dimension
try {
$Result = ConvertFrom-JsonToDimension -Json $Dimension
@@ -203,7 +203,7 @@ $DimensionBulkDeleteRequest = @"{
"dimensionIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ]
}"@
# Delete Dimension(s)
# Delete dimension(s)
try {
$Result = ConvertFrom-JsonToDimensionBulkDeleteRequest -Json $DimensionBulkDeleteRequest
@@ -252,7 +252,7 @@ Code | Description | Data Type
$RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension.
$DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension
# Delete a Dimension
# Delete a dimension
try {
Remove-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId
@@ -301,7 +301,7 @@ Code | Description | Data Type
$RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension.
$DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension
# Get a Dimension under Role.
# Get a dimension under role.
try {
Get-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId
@@ -360,7 +360,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$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 Dimension's Entitlements
# List dimension's entitlements
try {
Get-V2024DimensionEntitlements -RoleId $RoleId -DimensionId $DimensionId
@@ -420,7 +420,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'source.id eq "2c91808982f979270182f99e386d00fa"' # 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* **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, created, modified** (optional)
# List Dimension's Access Profiles
# List dimension's access profiles
try {
Get-V2024DimensionAccessProfiles -RoleId $RoleId -DimensionId $DimensionId
@@ -479,7 +479,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'id eq '2c918086749d78830174a1a40e121518'' # 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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.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, created, modified** (optional)
# List Dimensions
# List dimensions
try {
Get-V2024Dimensions -RoleId $RoleId
@@ -537,7 +537,7 @@ $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension
}"@ # JsonPatchOperation[] |
# Patch a specified Dimension
# Patch a specified dimension
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation

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

@@ -69,14 +69,14 @@ Method | HTTP request | Description
[**New-V2024AccessModelMetadataForEntitlement**](#create-access-model-metadata-for-entitlement) | **POST** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add metadata to an entitlement.
[**Remove-V2024AccessModelMetadataFromEntitlement**](#delete-access-model-metadata-from-entitlement) | **DELETE** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove metadata from an entitlement.
[**Get-V2024Entitlement**](#get-entitlement) | **GET** `/entitlements/{id}` | Get an entitlement
[**Get-V2024EntitlementRequestConfig**](#get-entitlement-request-config) | **GET** `/entitlements/{id}/entitlement-request-config` | Get Entitlement Request Config
[**Import-V2024EntitlementsBySource**](#import-entitlements-by-source) | **POST** `/entitlements/aggregate/sources/{id}` | Aggregate Entitlements
[**Get-V2024EntitlementRequestConfig**](#get-entitlement-request-config) | **GET** `/entitlements/{id}/entitlement-request-config` | Get entitlement request config
[**Import-V2024EntitlementsBySource**](#import-entitlements-by-source) | **POST** `/entitlements/aggregate/sources/{id}` | Aggregate entitlements
[**Get-V2024EntitlementChildren**](#list-entitlement-children) | **GET** `/entitlements/{id}/children` | List of entitlements children
[**Get-V2024EntitlementParents**](#list-entitlement-parents) | **GET** `/entitlements/{id}/parents` | List of entitlements parents
[**Get-V2024Entitlements**](#list-entitlements) | **GET** `/entitlements` | Gets a list of entitlements.
[**Update-V2024Entitlement**](#patch-entitlement) | **PATCH** `/entitlements/{id}` | Patch an entitlement
[**Send-V2024EntitlementRequestConfig**](#put-entitlement-request-config) | **PUT** `/entitlements/{id}/entitlement-request-config` | Replace Entitlement Request Config
[**Reset-V2024SourceEntitlements**](#reset-source-entitlements) | **POST** `/entitlements/reset/sources/{id}` | Reset Source Entitlements
[**Send-V2024EntitlementRequestConfig**](#put-entitlement-request-config) | **PUT** `/entitlements/{id}/entitlement-request-config` | Replace entitlement request config
[**Reset-V2024SourceEntitlements**](#reset-source-entitlements) | **POST** `/entitlements/reset/sources/{id}` | Reset source entitlements
[**Update-V2024EntitlementsInBulk**](#update-entitlements-in-bulk) | **POST** `/entitlements/bulk-update` | Bulk update an entitlement list
@@ -276,7 +276,7 @@ Code | Description | Data Type
$Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get Entitlement Request Config
# Get entitlement request config
try {
Get-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -335,7 +335,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional)
# Aggregate Entitlements
# Aggregate entitlements
try {
Import-V2024EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -664,7 +664,7 @@ $EntitlementRequestConfig = @"{
}
}"@
# Replace Entitlement Request Config
# Replace entitlement request config
try {
$Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig
@@ -716,7 +716,7 @@ Code | Description | Data Type
$Id = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Reset Source Entitlements
# Reset source entitlements
try {
Reset-V2024SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental

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

@@ -21,14 +21,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024AuthOrgNetworkConfig**](#create-auth-org-network-config) | **POST** `/auth-org/network-config` | Create security network configuration.
[**Get-V2024AuthOrgLockoutConfig**](#get-auth-org-lockout-config) | **GET** `/auth-org/lockout-config` | Get Auth Org Lockout Configuration.
[**Get-V2024AuthOrgLockoutConfig**](#get-auth-org-lockout-config) | **GET** `/auth-org/lockout-config` | Get auth org lockout configuration.
[**Get-V2024AuthOrgNetworkConfig**](#get-auth-org-network-config) | **GET** `/auth-org/network-config` | Get security network configuration.
[**Get-V2024AuthOrgServiceProviderConfig**](#get-auth-org-service-provider-config) | **GET** `/auth-org/service-provider-config` | Get Service Provider Configuration.
[**Get-V2024AuthOrgSessionConfig**](#get-auth-org-session-config) | **GET** `/auth-org/session-config` | Get Auth Org Session Configuration.
[**Update-V2024AuthOrgLockoutConfig**](#patch-auth-org-lockout-config) | **PATCH** `/auth-org/lockout-config` | Update Auth Org Lockout Configuration
[**Get-V2024AuthOrgServiceProviderConfig**](#get-auth-org-service-provider-config) | **GET** `/auth-org/service-provider-config` | Get service provider configuration.
[**Get-V2024AuthOrgSessionConfig**](#get-auth-org-session-config) | **GET** `/auth-org/session-config` | Get auth org session configuration.
[**Update-V2024AuthOrgLockoutConfig**](#patch-auth-org-lockout-config) | **PATCH** `/auth-org/lockout-config` | Update auth org lockout configuration
[**Update-V2024AuthOrgNetworkConfig**](#patch-auth-org-network-config) | **PATCH** `/auth-org/network-config` | Update security network configuration.
[**Update-V2024AuthOrgServiceProviderConfig**](#patch-auth-org-service-provider-config) | **PATCH** `/auth-org/service-provider-config` | Update Service Provider Configuration
[**Update-V2024AuthOrgSessionConfig**](#patch-auth-org-session-config) | **PATCH** `/auth-org/session-config` | Update Auth Org Session Configuration
[**Update-V2024AuthOrgServiceProviderConfig**](#patch-auth-org-service-provider-config) | **PATCH** `/auth-org/service-provider-config` | Update service provider configuration
[**Update-V2024AuthOrgSessionConfig**](#patch-auth-org-session-config) | **PATCH** `/auth-org/session-config` | Update auth org session configuration
## create-auth-org-network-config
@@ -112,7 +112,7 @@ Code | Description | Data Type
### Example
```powershell
# Get Auth Org Lockout Configuration.
# Get auth org lockout configuration.
try {
Get-V2024AuthOrgLockoutConfig
@@ -200,7 +200,7 @@ Code | Description | Data Type
### Example
```powershell
# Get Service Provider Configuration.
# Get service provider configuration.
try {
Get-V2024AuthOrgServiceProviderConfig
@@ -244,7 +244,7 @@ Code | Description | Data Type
### Example
```powershell
# Get Auth Org Session Configuration.
# Get auth org session configuration.
try {
Get-V2024AuthOrgSessionConfig
@@ -296,7 +296,7 @@ Code | Description | Data Type
}"@ # JsonPatchOperation[] | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60`
# Update Auth Org Lockout Configuration
# Update auth org lockout configuration
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
@@ -401,7 +401,7 @@ Code | Description | Data Type
}"@ # JsonPatchOperation[] | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email)
# Update Service Provider Configuration
# Update service provider configuration
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
@@ -453,7 +453,7 @@ Code | Description | Data Type
}"@ # JsonPatchOperation[] | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.`
# Update Auth Org Session Configuration
# Update auth org session configuration
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation

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

@@ -22,16 +22,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024Workgroup**](#create-workgroup) | **POST** `/workgroups` | Create a new Governance Group.
[**Remove-V2024Workgroup**](#delete-workgroup) | **DELETE** `/workgroups/{id}` | Delete a Governance Group
[**Remove-V2024WorkgroupMembers**](#delete-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-delete` | Remove members from Governance Group
[**Remove-V2024WorkgroupsInBulk**](#delete-workgroups-in-bulk) | **POST** `/workgroups/bulk-delete` | Delete Governance Group(s)
[**Get-V2024Workgroup**](#get-workgroup) | **GET** `/workgroups/{id}` | Get Governance Group by Id
[**Get-V2024Connections**](#list-connections) | **GET** `/workgroups/{workgroupId}/connections` | List connections for Governance Group
[**Get-V2024WorkgroupMembers**](#list-workgroup-members) | **GET** `/workgroups/{workgroupId}/members` | List Governance Group Members
[**Get-V2024Workgroups**](#list-workgroups) | **GET** `/workgroups` | List Governance Groups
[**Update-V2024Workgroup**](#patch-workgroup) | **PATCH** `/workgroups/{id}` | Patch a Governance Group
[**Update-V2024WorkgroupMembers**](#update-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-add` | Add members to Governance Group
[**New-V2024Workgroup**](#create-workgroup) | **POST** `/workgroups` | Create a new governance group.
[**Remove-V2024Workgroup**](#delete-workgroup) | **DELETE** `/workgroups/{id}` | Delete a governance group
[**Remove-V2024WorkgroupMembers**](#delete-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-delete` | Remove members from governance group
[**Remove-V2024WorkgroupsInBulk**](#delete-workgroups-in-bulk) | **POST** `/workgroups/bulk-delete` | Delete governance group(s)
[**Get-V2024Workgroup**](#get-workgroup) | **GET** `/workgroups/{id}` | Get governance group by id
[**Get-V2024Connections**](#list-connections) | **GET** `/workgroups/{workgroupId}/connections` | List connections for governance group
[**Get-V2024WorkgroupMembers**](#list-workgroup-members) | **GET** `/workgroups/{workgroupId}/members` | List governance group members
[**Get-V2024Workgroups**](#list-workgroups) | **GET** `/workgroups` | List governance groups
[**Update-V2024Workgroup**](#patch-workgroup) | **PATCH** `/workgroups/{id}` | Patch a governance group
[**Update-V2024WorkgroupMembers**](#update-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-add` | Add members to governance group
## create-workgroup
@@ -85,7 +85,7 @@ $WorkgroupDto = @"{
"id" : "2c91808568c529c60168cca6f90c1313"
}"@
# Create a new Governance Group.
# Create a new governance group.
try {
$Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto
@@ -136,7 +136,7 @@ Code | Description | Data Type
$Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Delete a Governance Group
# Delete a governance group
try {
Remove-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -192,7 +192,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
$IdentityPreviewResponseIdentity = @""@ # IdentityPreviewResponseIdentity[] | List of identities to be removed from a Governance Group members list.
# Remove members from Governance Group
# Remove members from governance group
try {
$Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity
@@ -256,7 +256,7 @@ $WorkgroupBulkDeleteRequest = @"{
"ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ]
}"@
# Delete Governance Group(s)
# Delete governance group(s)
try {
$Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest
@@ -307,7 +307,7 @@ Code | Description | Data Type
$Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get Governance Group by Id
# Get governance group by id
try {
Get-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -365,7 +365,7 @@ $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)
$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
# List connections for governance group
try {
Get-V2024Connections -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental
@@ -423,7 +423,7 @@ $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)
$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
# List governance group members
try {
Get-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental
@@ -481,7 +481,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$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
# List governance groups
try {
Get-V2024Workgroups -XSailPointExperimental $XSailPointExperimental
@@ -541,7 +541,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
}"@ # JsonPatchOperation[] | (optional)
# Patch a Governance Group
# Patch a governance group
try {
Update-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -598,7 +598,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
$IdentityPreviewResponseIdentity = @""@ # IdentityPreviewResponseIdentity[] | List of identities to be added to a Governance Group members list.
# Add members to Governance Group
# Add members to governance group
try {
$Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity

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

@@ -17,16 +17,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Add-V2024AccessRequestRecommendationsIgnoredItem**](#add-access-request-recommendations-ignored-item) | **POST** `/ai-access-request-recommendations/ignored-items` | Ignore Access Request Recommendation
[**Add-V2024AccessRequestRecommendationsRequestedItem**](#add-access-request-recommendations-requested-item) | **POST** `/ai-access-request-recommendations/requested-items` | Accept Access Request Recommendation
[**Add-V2024AccessRequestRecommendationsViewedItem**](#add-access-request-recommendations-viewed-item) | **POST** `/ai-access-request-recommendations/viewed-items` | Mark Viewed Access Request Recommendations
[**Add-V2024AccessRequestRecommendationsViewedItems**](#add-access-request-recommendations-viewed-items) | **POST** `/ai-access-request-recommendations/viewed-items/bulk-create` | Bulk Mark Viewed Access Request Recommendations
[**Get-V2024AccessRequestRecommendations**](#get-access-request-recommendations) | **GET** `/ai-access-request-recommendations` | Identity Access Request Recommendations
[**Get-V2024AccessRequestRecommendationsConfig**](#get-access-request-recommendations-config) | **GET** `/ai-access-request-recommendations/config` | Get Access Request Recommendations config
[**Get-V2024AccessRequestRecommendationsIgnoredItems**](#get-access-request-recommendations-ignored-items) | **GET** `/ai-access-request-recommendations/ignored-items` | List Ignored Access Request Recommendations
[**Get-V2024AccessRequestRecommendationsRequestedItems**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List Accepted Access Request Recommendations
[**Get-V2024AccessRequestRecommendationsViewedItems**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List Viewed Access Request Recommendations
[**Set-V2024AccessRequestRecommendationsConfig**](#set-access-request-recommendations-config) | **PUT** `/ai-access-request-recommendations/config` | Update Access Request Recommendations config
[**Add-V2024AccessRequestRecommendationsIgnoredItem**](#add-access-request-recommendations-ignored-item) | **POST** `/ai-access-request-recommendations/ignored-items` | Ignore access request recommendation
[**Add-V2024AccessRequestRecommendationsRequestedItem**](#add-access-request-recommendations-requested-item) | **POST** `/ai-access-request-recommendations/requested-items` | Accept access request recommendation
[**Add-V2024AccessRequestRecommendationsViewedItem**](#add-access-request-recommendations-viewed-item) | **POST** `/ai-access-request-recommendations/viewed-items` | Mark viewed access request recommendations
[**Add-V2024AccessRequestRecommendationsViewedItems**](#add-access-request-recommendations-viewed-items) | **POST** `/ai-access-request-recommendations/viewed-items/bulk-create` | Bulk mark viewed access request recommendations
[**Get-V2024AccessRequestRecommendations**](#get-access-request-recommendations) | **GET** `/ai-access-request-recommendations` | Identity access request recommendations
[**Get-V2024AccessRequestRecommendationsConfig**](#get-access-request-recommendations-config) | **GET** `/ai-access-request-recommendations/config` | Get access request recommendations config
[**Get-V2024AccessRequestRecommendationsIgnoredItems**](#get-access-request-recommendations-ignored-items) | **GET** `/ai-access-request-recommendations/ignored-items` | List ignored access request recommendations
[**Get-V2024AccessRequestRecommendationsRequestedItems**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List accepted access request recommendations
[**Get-V2024AccessRequestRecommendationsViewedItems**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List viewed access request recommendations
[**Set-V2024AccessRequestRecommendationsConfig**](#set-access-request-recommendations-config) | **PUT** `/ai-access-request-recommendations/config` | Update access request recommendations config
## add-access-request-recommendations-ignored-item
@@ -71,7 +71,7 @@ $AccessRequestRecommendationActionItemDto = @"{
"identityId" : "2c91808570313110017040b06f344ec9"
}"@
# Ignore Access Request Recommendation
# Ignore access request recommendation
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
@@ -128,7 +128,7 @@ $AccessRequestRecommendationActionItemDto = @"{
"identityId" : "2c91808570313110017040b06f344ec9"
}"@
# Accept Access Request Recommendation
# Accept access request recommendation
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
@@ -185,7 +185,7 @@ $AccessRequestRecommendationActionItemDto = @"{
"identityId" : "2c91808570313110017040b06f344ec9"
}"@
# Mark Viewed Access Request Recommendations
# Mark viewed access request recommendations
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
@@ -243,7 +243,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
}"@ # AccessRequestRecommendationActionItemDto[] | The recommended access items that were viewed for an identity.
# Bulk Mark Viewed Access Request Recommendations
# Bulk mark viewed access request recommendations
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
@@ -306,7 +306,7 @@ $IncludeTranslationMessages = $false # Boolean | If *true* it will populate a li
$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 = "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, access.type** By default the recommendations are sorted by highest confidence first. (optional)
# Identity Access Request Recommendations
# Identity access request recommendations
try {
Get-V2024AccessRequestRecommendations -XSailPointExperimental $XSailPointExperimental
@@ -354,7 +354,7 @@ Code | Description | Data Type
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get Access Request Recommendations config
# Get access request recommendations config
try {
Get-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental
@@ -412,7 +412,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$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 Ignored Access Request Recommendations
# List ignored access request recommendations
try {
Get-V2024AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental
@@ -470,7 +470,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$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 = "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 Accepted Access Request Recommendations
# List accepted access request recommendations
try {
Get-V2024AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental
@@ -528,7 +528,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$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 = "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 Viewed Access Request Recommendations
# List viewed access request recommendations
try {
Get-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental
@@ -585,7 +585,7 @@ $AccessRequestRecommendationConfigDto = @"{
"useRestrictionAttribute" : true
}"@
# Update Access Request Recommendations config
# Update access request recommendations config
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationConfigDto -Json $AccessRequestRecommendationConfigDto

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

@@ -17,15 +17,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Export-V2024OutliersZip**](#export-outliers-zip) | **GET** `/outliers/export` | IAI Identity Outliers Export
[**Get-V2024IdentityOutlierSnapshots**](#get-identity-outlier-snapshots) | **GET** `/outlier-summaries` | IAI Identity Outliers Summary
[**Get-V2024IdentityOutliers**](#get-identity-outliers) | **GET** `/outliers` | IAI Get Identity Outliers
[**Get-V2024LatestIdentityOutlierSnapshots**](#get-latest-identity-outlier-snapshots) | **GET** `/outlier-summaries/latest` | IAI Identity Outliers Latest Summary
[**Export-V2024OutliersZip**](#export-outliers-zip) | **GET** `/outliers/export` | Iai identity outliers export
[**Get-V2024IdentityOutlierSnapshots**](#get-identity-outlier-snapshots) | **GET** `/outlier-summaries` | Iai identity outliers summary
[**Get-V2024IdentityOutliers**](#get-identity-outliers) | **GET** `/outliers` | Iai get identity outliers
[**Get-V2024LatestIdentityOutlierSnapshots**](#get-latest-identity-outlier-snapshots) | **GET** `/outlier-summaries/latest` | Iai identity outliers latest summary
[**Get-V2024OutlierContributingFeatureSummary**](#get-outlier-contributing-feature-summary) | **GET** `/outlier-feature-summaries/{outlierFeatureId}` | Get identity outlier contibuting feature summary
[**Get-V2024PeerGroupOutliersContributingFeatures**](#get-peer-group-outliers-contributing-features) | **GET** `/outliers/{outlierId}/contributing-features` | Get identity outlier&#39;s contibuting features
[**Invoke-V2024IgnoreIdentityOutliers**](#ignore-identity-outliers) | **POST** `/outliers/ignore` | IAI Identity Outliers Ignore
[**Invoke-V2024IgnoreIdentityOutliers**](#ignore-identity-outliers) | **POST** `/outliers/ignore` | Iai identity outliers ignore
[**Get-V2024OutliersContributingFeatureAccessItems**](#list-outliers-contributing-feature-access-items) | **GET** `/outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items` | Gets a list of access items associated with each identity outlier contributing feature
[**Invoke-V2024UnIgnoreIdentityOutliers**](#un-ignore-identity-outliers) | **POST** `/outliers/unignore` | IAI Identity Outliers Unignore
[**Invoke-V2024UnIgnoreIdentityOutliers**](#un-ignore-identity-outliers) | **POST** `/outliers/unignore` | Iai identity outliers unignore
## export-outliers-zip
@@ -67,7 +67,7 @@ Code | Description | Data Type
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional)
# IAI Identity Outliers Export
# Iai identity outliers export
try {
Export-V2024OutliersZip -XSailPointExperimental $XSailPointExperimental
@@ -126,7 +126,7 @@ $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to fi
$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
# Iai identity outliers summary
try {
Get-V2024IdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental
@@ -186,7 +186,7 @@ $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to fi
$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
# Iai get identity outliers
try {
Get-V2024IdentityOutliers -XSailPointExperimental $XSailPointExperimental
@@ -237,7 +237,7 @@ Code | Description | Data Type
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional)
# IAI Identity Outliers Latest Summary
# Iai identity outliers latest summary
try {
Get-V2024LatestIdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental
@@ -407,7 +407,7 @@ $RequestBody = "MyRequestBody" # String[] |
$RequestBody = @""@ # String[] |
# IAI Identity Outliers Ignore
# Iai identity outliers ignore
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
@@ -526,7 +526,7 @@ $RequestBody = "MyRequestBody" # String[] |
$RequestBody = @""@ # String[] |
# IAI Identity Outliers Unignore
# Iai identity outliers unignore
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody

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

@@ -17,7 +17,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024PeerGroupOutliers**](#get-peer-group-outliers) | **GET** `/peer-group-strategies/{strategy}/identity-outliers` | Identity Outliers List
[**Get-V2024PeerGroupOutliers**](#get-peer-group-outliers) | **GET** `/peer-group-strategies/{strategy}/identity-outliers` | Identity outliers list
## get-peer-group-outliers
@@ -65,7 +65,7 @@ $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)
# Identity Outliers List
# Identity outliers list
try {
Get-V2024PeerGroupOutliers -Strategy $Strategy -XSailPointExperimental $XSailPointExperimental

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

@@ -17,7 +17,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024Recommendations**](#get-recommendations) | **POST** `/recommendations/request` | Returns Recommendation Based on Object
[**Get-V2024Recommendations**](#get-recommendations) | **POST** `/recommendations/request` | Returns recommendation based on object
[**Get-V2024RecommendationsConfig**](#get-recommendations-config) | **GET** `/recommendations/config` | Get certification recommendation config values
[**Update-V2024RecommendationsConfig**](#update-recommendations-config) | **PUT** `/recommendations/config` | Update certification recommendation config values
@@ -76,7 +76,7 @@ $RecommendationRequestDto = @"{
"includeDebugInformation" : true
}"@
# Returns Recommendation Based on Object
# Returns recommendation based on object
try {
$Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto

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

@@ -33,15 +33,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Remove-V2024Identity**](#delete-identity) | **DELETE** `/identities/{id}` | Delete identity
[**Get-V2024Identity**](#get-identity) | **GET** `/identities/{id}` | Identity Details
[**Get-V2024Identity**](#get-identity) | **GET** `/identities/{id}` | Identity details
[**Get-V2024IdentityOwnershipDetails**](#get-identity-ownership-details) | **GET** `/identities/{identityId}/ownership` | Get ownership details
[**Get-V2024RoleAssignment**](#get-role-assignment) | **GET** `/identities/{identityId}/role-assignments/{assignmentId}` | Role assignment details
[**Get-V2024RoleAssignments**](#get-role-assignments) | **GET** `/identities/{identityId}/role-assignments` | List role assignments
[**Get-V2024Identities**](#list-identities) | **GET** `/identities` | List Identities
[**Get-V2024Identities**](#list-identities) | **GET** `/identities` | List identities
[**Reset-V2024Identity**](#reset-identity) | **POST** `/identities/{id}/reset` | Reset an identity
[**Send-V2024IdentityVerificationAccountToken**](#send-identity-verification-account-token) | **POST** `/identities/{id}/verification/account/send` | Send password reset email
[**Start-V2024IdentitiesInvite**](#start-identities-invite) | **POST** `/identities/invite` | Invite identities to register
[**Start-V2024IdentityProcessing**](#start-identity-processing) | **POST** `/identities/process` | Process a list of identityIds
[**Start-V2024IdentityProcessing**](#start-identity-processing) | **POST** `/identities/process` | Process a list of identityids
[**Sync-V2024hronizeAttributesForIdentity**](#synchronize-attributes-for-identity) | **POST** `/identities/{identityId}/synchronize-attributes` | Attribute synchronization for single identity.
@@ -133,7 +133,7 @@ Code | Description | Data Type
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Identity Details
# Identity details
try {
Get-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -354,7 +354,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$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
# List identities
try {
Get-V2024Identities -XSailPointExperimental $XSailPointExperimental
@@ -583,7 +583,7 @@ $ProcessIdentitiesRequest = @"{
"identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ]
}"@
# Process a list of identityIds
# Process a list of identityids
try {
$Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest

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

@@ -17,12 +17,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024IdentityAttribute**](#create-identity-attribute) | **POST** `/identity-attributes` | Create Identity Attribute
[**Remove-V2024IdentityAttribute**](#delete-identity-attribute) | **DELETE** `/identity-attributes/{name}` | Delete Identity Attribute
[**Remove-V2024IdentityAttributesInBulk**](#delete-identity-attributes-in-bulk) | **DELETE** `/identity-attributes/bulk-delete` | Bulk delete Identity Attributes
[**Get-V2024IdentityAttribute**](#get-identity-attribute) | **GET** `/identity-attributes/{name}` | Get Identity Attribute
[**Get-V2024IdentityAttributes**](#list-identity-attributes) | **GET** `/identity-attributes` | List Identity Attributes
[**Send-V2024IdentityAttribute**](#put-identity-attribute) | **PUT** `/identity-attributes/{name}` | Update Identity Attribute
[**New-V2024IdentityAttribute**](#create-identity-attribute) | **POST** `/identity-attributes` | Create identity attribute
[**Remove-V2024IdentityAttribute**](#delete-identity-attribute) | **DELETE** `/identity-attributes/{name}` | Delete identity attribute
[**Remove-V2024IdentityAttributesInBulk**](#delete-identity-attributes-in-bulk) | **DELETE** `/identity-attributes/bulk-delete` | Bulk delete identity attributes
[**Get-V2024IdentityAttribute**](#get-identity-attribute) | **GET** `/identity-attributes/{name}` | Get identity attribute
[**Get-V2024IdentityAttributes**](#list-identity-attributes) | **GET** `/identity-attributes` | List identity attributes
[**Send-V2024IdentityAttribute**](#put-identity-attribute) | **PUT** `/identity-attributes/{name}` | Update identity attribute
## create-identity-attribute
@@ -83,7 +83,7 @@ $IdentityAttribute = @"{
"multi" : false
}"@
# Create Identity Attribute
# Create identity attribute
try {
$Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute
@@ -135,7 +135,7 @@ Code | Description | Data Type
$Name = "displayName" # String | The attribute's technical name.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Delete Identity Attribute
# Delete identity attribute
try {
Remove-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental
@@ -188,7 +188,7 @@ $IdentityAttributeNames = @"{
"ids" : [ "name", "displayName" ]
}"@
# Bulk delete Identity Attributes
# Bulk delete identity attributes
try {
$Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames
@@ -240,7 +240,7 @@ Code | Description | Data Type
$Name = "displayName" # String | The attribute's technical name.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get Identity Attribute
# Get identity attribute
try {
Get-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental
@@ -296,7 +296,7 @@ $IncludeSilent = $false # Boolean | Include 'silent' attributes in the response.
$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
# List identity attributes
try {
Get-V2024IdentityAttributes -XSailPointExperimental $XSailPointExperimental
@@ -370,7 +370,7 @@ $IdentityAttribute = @"{
"multi" : false
}"@
# Update Identity Attribute
# Update identity attribute
try {
$Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute

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

@@ -18,14 +18,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Compare-V2024IdentitySnapshots**](#compare-identity-snapshots) | **GET** `/historical-identities/{id}/compare` | Gets a difference of count for each access item types for the given identity between 2 snapshots
[**Compare-V2024IdentitySnapshotsAccessType**](#compare-identity-snapshots-access-type) | **GET** `/historical-identities/{id}/compare/{access-type}` | Gets a list of differences of specific accessType for the given identity between 2 snapshots
[**Compare-V2024IdentitySnapshotsAccessType**](#compare-identity-snapshots-access-type) | **GET** `/historical-identities/{id}/compare/{access-type}` | Gets a list of differences of specific accesstype for the given identity between 2 snapshots
[**Get-V2024HistoricalIdentity**](#get-historical-identity) | **GET** `/historical-identities/{id}` | Get latest snapshot of identity
[**Get-V2024HistoricalIdentityEvents**](#get-historical-identity-events) | **GET** `/historical-identities/{id}/events` | Lists all events for the given identity
[**Get-V2024IdentitySnapshot**](#get-identity-snapshot) | **GET** `/historical-identities/{id}/snapshots/{date}` | Gets an identity snapshot at a given date
[**Get-V2024IdentitySnapshotSummary**](#get-identity-snapshot-summary) | **GET** `/historical-identities/{id}/snapshot-summary` | Gets the summary for the event count for a specific identity
[**Get-V2024IdentityStartDate**](#get-identity-start-date) | **GET** `/historical-identities/{id}/start-date` | Gets the start date of the identity
[**Get-V2024HistoricalIdentities**](#list-historical-identities) | **GET** `/historical-identities` | Lists all the identities
[**Get-V2024IdentityAccessItems**](#list-identity-access-items) | **GET** `/historical-identities/{id}/access-items` | List Access Items by Identity
[**Get-V2024IdentityAccessItems**](#list-identity-access-items) | **GET** `/historical-identities/{id}/access-items` | List access items by identity
[**Get-V2024IdentitySnapshotAccessItems**](#list-identity-snapshot-access-items) | **GET** `/historical-identities/{id}/snapshots/{date}/access-items` | Gets the list of identity access items at a given date filterd by item type
[**Get-V2024IdentitySnapshots**](#list-identity-snapshots) | **GET** `/historical-identities/{id}/snapshots` | Lists all the snapshots for the identity
@@ -144,7 +144,7 @@ $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)
# Gets a list of differences of specific accessType for the given identity between 2 snapshots
# Gets a list of differences of specific accesstype for the given identity between 2 snapshots
try {
Compare-V2024IdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -XSailPointExperimental $XSailPointExperimental
@@ -543,7 +543,7 @@ $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)
# List Access Items by Identity
# List access items by identity
try {
Get-V2024IdentityAccessItems -Id $Id -XSailPointExperimental $XSailPointExperimental

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

@@ -27,17 +27,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024IdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create Identity Profile
[**Remove-V2024IdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete Identity Profile
[**Remove-V2024IdentityProfiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete Identity Profiles
[**Export-V2024IdentityProfiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export Identity Profiles
[**New-V2024IdentityPreview**](#generate-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview
[**Get-V2024DefaultIdentityAttributeConfig**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default Identity Attribute Config
[**Get-V2024IdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get Identity Profile
[**Import-V2024IdentityProfiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import Identity Profiles
[**Get-V2024IdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List Identity Profiles
[**New-V2024IdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create identity profile
[**Remove-V2024IdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete identity profile
[**Remove-V2024IdentityProfiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete identity profiles
[**Export-V2024IdentityProfiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export identity profiles
[**New-V2024IdentityPreview**](#generate-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate identity profile preview
[**Get-V2024DefaultIdentityAttributeConfig**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default identity attribute config
[**Get-V2024IdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get identity profile
[**Import-V2024IdentityProfiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import identity profiles
[**Get-V2024IdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List identity profiles
[**Sync-V2024IdentityProfile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile
[**Update-V2024IdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update Identity Profile
[**Update-V2024IdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update identity profile
## create-identity-profile
@@ -119,7 +119,7 @@ $IdentityProfile = @"{
"id" : "id12345"
}"@
# Create Identity Profile
# Create identity profile
try {
$Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile
@@ -167,7 +167,7 @@ Code | Description | Data Type
```powershell
$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID.
# Delete Identity Profile
# Delete identity profile
try {
Remove-V2024IdentityProfile -IdentityProfileId $IdentityProfileId
@@ -218,7 +218,7 @@ $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request
$RequestBody = @""@ # String[] | Identity Profile bulk delete request body.
# Delete Identity Profiles
# Delete identity profiles
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
@@ -272,7 +272,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional)
$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional)
# Export Identity Profiles
# Export identity profiles
try {
Export-V2024IdentityProfiles
@@ -348,7 +348,7 @@ $IdentityPreviewRequest = @"{
}
}"@
# Generate Identity Profile Preview
# Generate identity profile preview
try {
$Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest
@@ -395,7 +395,7 @@ Code | Description | Data Type
```powershell
$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID.
# Get default Identity Attribute Config
# Get default identity attribute config
try {
Get-V2024DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId
@@ -441,7 +441,7 @@ Code | Description | Data Type
```powershell
$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID.
# Get Identity Profile
# Get identity profile
try {
Get-V2024IdentityProfile -IdentityProfileId $IdentityProfileId
@@ -548,7 +548,7 @@ Code | Description | Data Type
}"@ # IdentityProfileExportedObject[] | Previously exported Identity Profiles.
# Import Identity Profiles
# Import identity profiles
try {
$Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject
@@ -602,7 +602,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional)
$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional)
# List Identity Profiles
# List identity profiles
try {
Get-V2024IdentityProfiles
@@ -713,7 +713,7 @@ $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity prof
}"@ # JsonPatchOperation[] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
# Update Identity Profile
# Update identity profile
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation

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

@@ -55,12 +55,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024LifecycleState**](#create-lifecycle-state) | **POST** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Create Lifecycle State
[**Remove-V2024LifecycleState**](#delete-lifecycle-state) | **DELETE** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Delete Lifecycle State
[**Get-V2024LifecycleState**](#get-lifecycle-state) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get Lifecycle State
[**Get-V2024LifecycleStates**](#get-lifecycle-states) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Lists LifecycleStates
[**Set-V2024LifecycleState**](#set-lifecycle-state) | **POST** `/identities/{identity-id}/set-lifecycle-state` | Set Lifecycle State
[**Update-V2024LifecycleStates**](#update-lifecycle-states) | **PATCH** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State
[**New-V2024LifecycleState**](#create-lifecycle-state) | **POST** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Create lifecycle state
[**Remove-V2024LifecycleState**](#delete-lifecycle-state) | **DELETE** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Delete lifecycle state
[**Get-V2024LifecycleState**](#get-lifecycle-state) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get lifecycle state
[**Get-V2024LifecycleStates**](#get-lifecycle-states) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Lists lifecyclestates
[**Set-V2024LifecycleState**](#set-lifecycle-state) | **POST** `/identities/{identity-id}/set-lifecycle-state` | Set lifecycle state
[**Update-V2024LifecycleStates**](#update-lifecycle-states) | **PATCH** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update lifecycle state
## create-lifecycle-state
@@ -120,7 +120,7 @@ $LifecycleState = @"{
"enabled" : true
}"@
# Create Lifecycle State
# Create lifecycle state
try {
$Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState
@@ -169,7 +169,7 @@ Code | Description | Data Type
$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID.
$LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID.
# Delete Lifecycle State
# Delete lifecycle state
try {
Remove-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
@@ -217,7 +217,7 @@ Code | Description | Data Type
$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID.
$LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID.
# Get Lifecycle State
# Get lifecycle state
try {
Get-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
@@ -270,7 +270,7 @@ $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 = "created,modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional)
# Lists LifecycleStates
# Lists lifecyclestates
try {
Get-V2024LifecycleStates -IdentityProfileId $IdentityProfileId
@@ -318,7 +318,7 @@ Code | Description | Data Type
$IdentityId = "2c9180857893f1290178944561990364" # String | ID of the identity to update.
$SetLifecycleStateRequest = @""@
# Set Lifecycle State
# Set lifecycle state
try {
$Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest
@@ -374,7 +374,7 @@ $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle stat
}"@ # 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
# Update lifecycle state
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation

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

@@ -17,13 +17,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024MFADuoConfig**](#get-mfa-duo-config) | **GET** `/mfa/duo-web/config` | Configuration of Duo MFA method
[**Get-V2024MFAKbaConfig**](#get-mfa-kba-config) | **GET** `/mfa/kba/config` | Configuration of KBA MFA method
[**Get-V2024MFAOktaConfig**](#get-mfa-okta-config) | **GET** `/mfa/okta-verify/config` | Configuration of Okta MFA method
[**Set-V2024MFADuoConfig**](#set-mfa-duo-config) | **PUT** `/mfa/duo-web/config` | Set Duo MFA configuration
[**Set-V2024MFAKBAConfig**](#set-mfakba-config) | **POST** `/mfa/kba/config/answers` | Set MFA KBA configuration
[**Set-V2024MFAOktaConfig**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set Okta MFA configuration
[**Test-V2024MFAConfig**](#test-mfa-config) | **GET** `/mfa/{method}/test` | MFA method&#39;s test configuration
[**Get-V2024MFADuoConfig**](#get-mfa-duo-config) | **GET** `/mfa/duo-web/config` | Configuration of duo mfa method
[**Get-V2024MFAKbaConfig**](#get-mfa-kba-config) | **GET** `/mfa/kba/config` | Configuration of kba mfa method
[**Get-V2024MFAOktaConfig**](#get-mfa-okta-config) | **GET** `/mfa/okta-verify/config` | Configuration of okta mfa method
[**Set-V2024MFADuoConfig**](#set-mfa-duo-config) | **PUT** `/mfa/duo-web/config` | Set duo mfa configuration
[**Set-V2024MFAKBAConfig**](#set-mfakba-config) | **POST** `/mfa/kba/config/answers` | Set mfa kba configuration
[**Set-V2024MFAOktaConfig**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set okta mfa configuration
[**Test-V2024MFAConfig**](#test-mfa-config) | **GET** `/mfa/{method}/test` | Mfa method&#39;s test configuration
## get-mfa-duo-config
@@ -55,7 +55,7 @@ Code | Description | Data Type
### Example
```powershell
# Configuration of Duo MFA method
# Configuration of duo mfa method
try {
Get-V2024MFADuoConfig
@@ -100,7 +100,7 @@ Code | Description | Data Type
```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
# Configuration of kba mfa method
try {
Get-V2024MFAKbaConfig
@@ -143,7 +143,7 @@ Code | Description | Data Type
### Example
```powershell
# Configuration of Okta MFA method
# Configuration of okta mfa method
try {
Get-V2024MFAOktaConfig
@@ -198,7 +198,7 @@ $MfaDuoConfig = @"{
"identityAttribute" : "email"
}"@
# Set Duo MFA configuration
# Set duo mfa configuration
try {
$Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig
@@ -248,7 +248,7 @@ Code | Description | Data Type
}"@ # KbaAnswerRequestItem[] |
# Set MFA KBA configuration
# Set mfa kba configuration
try {
$Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem
@@ -300,7 +300,7 @@ $MfaOktaConfig = @"{
"identityAttribute" : "email"
}"@
# Set Okta MFA configuration
# Set okta mfa configuration
try {
$Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig
@@ -346,7 +346,7 @@ Code | Description | Data Type
```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
# Mfa method's test configuration
try {
Test-V2024MFAConfig -Method $Method

16
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineAccountMappingsApi.md
View File

@@ -17,10 +17,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024MachineAccountMappings**](#create-machine-account-mappings) | **POST** `/sources/{sourceId}/machine-account-mappings` | Create Machine Account Mappings
[**Remove-V2024MachineAccountMappings**](#delete-machine-account-mappings) | **DELETE** `/sources/{sourceId}/machine-account-mappings` | Delete Source&#39;s Machine Account Mappings
[**Get-V2024MachineAccountMappings**](#list-machine-account-mappings) | **GET** `/sources/{sourceId}/machine-account-mappings` | Machine Account Mapping for Source
[**Set-V2024MachineAccountMappings**](#set-machine-account-mappings) | **PUT** `/sources/{sourceId}/machine-mappings` | Update Source&#39;s Machine Account Mappings
[**New-V2024MachineAccountMappings**](#create-machine-account-mappings) | **POST** `/sources/{sourceId}/machine-account-mappings` | Create machine account mappings
[**Remove-V2024MachineAccountMappings**](#delete-machine-account-mappings) | **DELETE** `/sources/{sourceId}/machine-account-mappings` | Delete source&#39;s machine account mappings
[**Get-V2024MachineAccountMappings**](#list-machine-account-mappings) | **GET** `/sources/{sourceId}/machine-account-mappings` | Machine account mapping for source
[**Set-V2024MachineAccountMappings**](#set-machine-account-mappings) | **PUT** `/sources/{sourceId}/machine-mappings` | Update source&#39;s machine account mappings
## create-machine-account-mappings
@@ -77,7 +77,7 @@ $AttributeMappings = @"{
}
}"@
# Create Machine Account Mappings
# Create machine account mappings
try {
$Result = ConvertFrom-JsonToAttributeMappings -Json $AttributeMappings
@@ -125,7 +125,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | source ID.
# Delete Source's Machine Account Mappings
# Delete source's machine account mappings
try {
Remove-V2024MachineAccountMappings -Id $Id
@@ -175,7 +175,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source ID
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
# Machine Account Mapping for Source
# Machine account mapping for source
try {
Get-V2024MachineAccountMappings -Id $Id
@@ -243,7 +243,7 @@ $AttributeMappings = @"{
}
}"@
# Update Source's Machine Account Mappings
# Update source's machine account mappings
try {
$Result = ConvertFrom-JsonToAttributeMappings -Json $AttributeMappings

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

@@ -17,9 +17,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024MachineAccount**](#get-machine-account) | **GET** `/machine-accounts/{id}` | Machine Account Details
[**Get-V2024MachineAccounts**](#list-machine-accounts) | **GET** `/machine-accounts` | Machine Accounts List
[**Update-V2024MachineAccount**](#update-machine-account) | **PATCH** `/machine-accounts/{id}` | Update a Machine Account
[**Get-V2024MachineAccount**](#get-machine-account) | **GET** `/machine-accounts/{id}` | Machine account details
[**Get-V2024MachineAccounts**](#list-machine-accounts) | **GET** `/machine-accounts` | Machine accounts list
[**Update-V2024MachineAccount**](#update-machine-account) | **PATCH** `/machine-accounts/{id}` | Update a machine account
## get-machine-account
@@ -59,7 +59,7 @@ Code | Description | Data Type
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Machine Account Details
# Machine account details
try {
Get-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -118,7 +118,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$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* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *eq* (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, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional)
# Machine Accounts List
# Machine accounts list
try {
Get-V2024MachineAccounts -XSailPointExperimental $XSailPointExperimental
@@ -174,7 +174,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON
$RequestBody = @"[{op=add, path=/environment, value=test}]"@ # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes
# Update a Machine Account
# Update a machine account
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody

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

@@ -17,9 +17,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Remove-V2024MachineClassificationConfig**](#delete-machine-classification-config) | **DELETE** `/sources/{sourceId}/machine-classification-config` | Delete Source&#39;s Classification Config
[**Get-V2024MachineClassificationConfig**](#get-machine-classification-config) | **GET** `/sources/{sourceId}/machine-classification-config` | Machine Classification Config for Source
[**Set-V2024MachineClassificationConfig**](#set-machine-classification-config) | **PUT** `/sources/{sourceId}/machine-classification-config` | Update Source&#39;s Classification Config
[**Remove-V2024MachineClassificationConfig**](#delete-machine-classification-config) | **DELETE** `/sources/{sourceId}/machine-classification-config` | Delete source&#39;s classification config
[**Get-V2024MachineClassificationConfig**](#get-machine-classification-config) | **GET** `/sources/{sourceId}/machine-classification-config` | Machine classification config for source
[**Set-V2024MachineClassificationConfig**](#set-machine-classification-config) | **PUT** `/sources/{sourceId}/machine-classification-config` | Update source&#39;s classification config
## delete-machine-classification-config
@@ -55,7 +55,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source ID.
# Delete Source's Classification Config
# Delete source's classification config
try {
Remove-V2024MachineClassificationConfig -Id $Id
@@ -101,7 +101,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source ID
# Machine Classification Config for Source
# Machine classification config for source
try {
Get-V2024MachineClassificationConfig -Id $Id
@@ -155,7 +155,7 @@ $MachineClassificationConfig = @"{
"enabled" : true
}"@
# Update Source's Classification Config
# Update source's classification config
try {
$Result = ConvertFrom-JsonToMachineClassificationConfig -Json $MachineClassificationConfig

16
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineIdentitiesApi.md
View File

@@ -17,11 +17,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024MachineIdentity**](#create-machine-identity) | **POST** `/machine-identities` | Create Machine Identities
[**New-V2024MachineIdentity**](#create-machine-identity) | **POST** `/machine-identities` | Create machine identities
[**Remove-V2024MachineIdentity**](#delete-machine-identity) | **DELETE** `/machine-identities/{id}` | Delete machine identity
[**Get-V2024MachineIdentity**](#get-machine-identity) | **GET** `/machine-identities/{id}` | Machine Identity Details
[**Get-V2024MachineIdentities**](#list-machine-identities) | **GET** `/machine-identities` | List Machine Identities
[**Update-V2024MachineIdentity**](#update-machine-identity) | **PATCH** `/machine-identities/{id}` | Update a Machine Identity
[**Get-V2024MachineIdentity**](#get-machine-identity) | **GET** `/machine-identities/{id}` | Machine identity details
[**Get-V2024MachineIdentities**](#list-machine-identities) | **GET** `/machine-identities` | List machine identities
[**Update-V2024MachineIdentity**](#update-machine-identity) | **PATCH** `/machine-identities/{id}` | Update a machine identity
## create-machine-identity
@@ -71,7 +71,7 @@ $MachineIdentity = @"{
"manuallyEdited" : true
}"@
# Create Machine Identities
# Create machine identities
try {
$Result = ConvertFrom-JsonToMachineIdentity -Json $MachineIdentity
@@ -174,7 +174,7 @@ Code | Description | Data Type
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Machine Identity Details
# Machine identity details
try {
Get-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -233,7 +233,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$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 Machine Identities
# List machine identities
try {
Get-V2024MachineIdentities -XSailPointExperimental $XSailPointExperimental
@@ -289,7 +289,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON
$RequestBody = @"[{op=add, path=/attributes/securityRisk, value=medium}]"@ # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
# Update a Machine Identity
# Update a machine identity
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody

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

@@ -19,12 +19,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024ManagedClient**](#create-managed-client) | **POST** `/managed-clients` | Create Managed Client
[**Remove-V2024ManagedClient**](#delete-managed-client) | **DELETE** `/managed-clients/{id}` | Delete Managed Client
[**Get-V2024ManagedClient**](#get-managed-client) | **GET** `/managed-clients/{id}` | Get Managed Client
[**Get-V2024ManagedClientStatus**](#get-managed-client-status) | **GET** `/managed-clients/{id}/status` | Get Managed Client Status
[**Get-V2024ManagedClients**](#get-managed-clients) | **GET** `/managed-clients` | Get Managed Clients
[**Update-V2024ManagedClient**](#update-managed-client) | **PATCH** `/managed-clients/{id}` | Update Managed Client
[**New-V2024ManagedClient**](#create-managed-client) | **POST** `/managed-clients` | Create managed client
[**Remove-V2024ManagedClient**](#delete-managed-client) | **DELETE** `/managed-clients/{id}` | Delete managed client
[**Get-V2024ManagedClient**](#get-managed-client) | **GET** `/managed-clients/{id}` | Get managed client
[**Get-V2024ManagedClientStatus**](#get-managed-client-status) | **GET** `/managed-clients/{id}/status` | Get managed client status
[**Get-V2024ManagedClients**](#get-managed-clients) | **GET** `/managed-clients` | Get managed clients
[**Update-V2024ManagedClient**](#update-managed-client) | **PATCH** `/managed-clients/{id}` | Update managed client
## create-managed-client
@@ -64,7 +64,7 @@ $ManagedClientRequest = @"{
"type" : "VA"
}"@
# Create Managed Client
# Create managed client
try {
$Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest
@@ -110,7 +110,7 @@ Code | Description | Data Type
```powershell
$Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID.
# Delete Managed Client
# Delete managed client
try {
Remove-V2024ManagedClient -Id $Id
@@ -156,7 +156,7 @@ Code | Description | Data Type
```powershell
$Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID.
# Get Managed Client
# Get managed client
try {
Get-V2024ManagedClient -Id $Id
@@ -204,7 +204,7 @@ Code | Description | Data Type
$Id = "aClientId" # String | Managed client ID to get status for.
$Type = "CCG" # ManagedClientType | Managed client type to get status for.
# Get Managed Client Status
# Get managed client status
try {
Get-V2024ManagedClientStatus -Id $Id -Type $Type
@@ -255,7 +255,7 @@ $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 = 'name eq "client name"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional)
# Get Managed Clients
# Get managed clients
try {
Get-V2024ManagedClients
@@ -308,7 +308,7 @@ $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID.
}"@ # JsonPatchOperation[] | JSONPatch payload used to update the object.
# Update Managed Client
# Update managed client
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation

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

@@ -19,11 +19,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024ManagedClusterType**](#create-managed-cluster-type) | **POST** `/managed-cluster-types` | Create new Managed Cluster Type
[**Remove-V2024ManagedClusterType**](#delete-managed-cluster-type) | **DELETE** `/managed-cluster-types/{id}` | Delete a Managed Cluster Type
[**Get-V2024ManagedClusterType**](#get-managed-cluster-type) | **GET** `/managed-cluster-types/{id}` | Get a Managed Cluster Type
[**Get-V2024ManagedClusterTypes**](#get-managed-cluster-types) | **GET** `/managed-cluster-types` | Get Managed Cluster Types
[**Update-V2024ManagedClusterType**](#update-managed-cluster-type) | **PATCH** `/managed-cluster-types/{id}` | Update a Managed Cluster Type
[**New-V2024ManagedClusterType**](#create-managed-cluster-type) | **POST** `/managed-cluster-types` | Create new managed cluster type
[**Remove-V2024ManagedClusterType**](#delete-managed-cluster-type) | **DELETE** `/managed-cluster-types/{id}` | Delete a managed cluster type
[**Get-V2024ManagedClusterType**](#get-managed-cluster-type) | **GET** `/managed-cluster-types/{id}` | Get a managed cluster type
[**Get-V2024ManagedClusterTypes**](#get-managed-cluster-types) | **GET** `/managed-cluster-types` | Get managed cluster types
[**Update-V2024ManagedClusterType**](#update-managed-cluster-type) | **PATCH** `/managed-cluster-types/{id}` | Update a managed cluster type
## create-managed-cluster-type
@@ -66,7 +66,7 @@ $ManagedClusterType = @"{
"type" : "idn"
}"@
# Create new Managed Cluster Type
# Create new managed cluster type
try {
$Result = ConvertFrom-JsonToManagedClusterType -Json $ManagedClusterType
@@ -113,7 +113,7 @@ Code | Description | Data Type
```powershell
$Id = "aClusterTypeId" # String | The Managed Cluster Type ID
# Delete a Managed Cluster Type
# Delete a managed cluster type
try {
Remove-V2024ManagedClusterType -Id $Id
@@ -160,7 +160,7 @@ Code | Description | Data Type
```powershell
$Id = "aClusterTypeId" # String | The Managed Cluster Type ID
# Get a Managed Cluster Type
# Get a managed cluster type
try {
Get-V2024ManagedClusterType -Id $Id
@@ -215,7 +215,7 @@ $Org = "denali-xyz" # String | Pinned org (or default) (optional)
$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)
# Get Managed Cluster Types
# Get managed cluster types
try {
Get-V2024ManagedClusterTypes
@@ -274,7 +274,7 @@ $JsonPatch = @"{
} ]
}"@
# Update a Managed Cluster Type
# Update a managed cluster type
try {
$Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch

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

@@ -19,14 +19,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024ManagedCluster**](#create-managed-cluster) | **POST** `/managed-clusters` | Create Create Managed Cluster
[**Remove-V2024ManagedCluster**](#delete-managed-cluster) | **DELETE** `/managed-clusters/{id}` | Delete Managed Cluster
[**Get-V2024ClientLogConfiguration**](#get-client-log-configuration) | **GET** `/managed-clusters/{id}/log-config` | Get Managed Cluster Log Configuration
[**Get-V2024ManagedCluster**](#get-managed-cluster) | **GET** `/managed-clusters/{id}` | Get Managed Cluster
[**Get-V2024ManagedClusters**](#get-managed-clusters) | **GET** `/managed-clusters` | Get Managed Clusters
[**Send-V2024ClientLogConfiguration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update Managed Cluster Log Configuration
[**Update-V2024**](#update) | **POST** `/managed-clusters/{id}/manualUpgrade` | Trigger Manual Upgrade for Managed Cluster
[**Update-V2024ManagedCluster**](#update-managed-cluster) | **PATCH** `/managed-clusters/{id}` | Update Managed Cluster
[**New-V2024ManagedCluster**](#create-managed-cluster) | **POST** `/managed-clusters` | Create create managed cluster
[**Remove-V2024ManagedCluster**](#delete-managed-cluster) | **DELETE** `/managed-clusters/{id}` | Delete managed cluster
[**Get-V2024ClientLogConfiguration**](#get-client-log-configuration) | **GET** `/managed-clusters/{id}/log-config` | Get managed cluster log configuration
[**Get-V2024ManagedCluster**](#get-managed-cluster) | **GET** `/managed-clusters/{id}` | Get managed cluster
[**Get-V2024ManagedClusters**](#get-managed-clusters) | **GET** `/managed-clusters` | Get managed clusters
[**Send-V2024ClientLogConfiguration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update managed cluster log configuration
[**Update-V2024**](#update) | **POST** `/managed-clusters/{id}/manualUpgrade` | Trigger manual upgrade for managed cluster
[**Update-V2024ManagedCluster**](#update-managed-cluster) | **PATCH** `/managed-clusters/{id}` | Update managed cluster
## create-managed-cluster
@@ -69,7 +69,7 @@ $ManagedClusterRequest = @"{
"type" : "idn"
}"@
# Create Create Managed Cluster
# Create create managed cluster
try {
$Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest
@@ -117,7 +117,7 @@ Code | Description | Data Type
$Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID.
$RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false)
# Delete Managed Cluster
# Delete managed cluster
try {
Remove-V2024ManagedCluster -Id $Id
@@ -164,7 +164,7 @@ Code | Description | Data Type
```powershell
$Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for.
# Get Managed Cluster Log Configuration
# Get managed cluster log configuration
try {
Get-V2024ClientLogConfiguration -Id $Id
@@ -210,7 +210,7 @@ Code | Description | Data Type
```powershell
$Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID.
# Get Managed Cluster
# Get managed cluster
try {
Get-V2024ManagedCluster -Id $Id
@@ -261,7 +261,7 @@ $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 = '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* **name**: *eq* **type**: *eq* **status**: *eq* (optional)
# Get Managed Clusters
# Get managed clusters
try {
Get-V2024ManagedClusters
@@ -309,7 +309,7 @@ Code | Description | Data Type
$Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for.
$PutClientLogConfigurationRequest = @""@
# Update Managed Cluster Log Configuration
# Update managed cluster log configuration
try {
$Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest
@@ -357,7 +357,7 @@ Code | Description | Data Type
```powershell
$Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to trigger manual upgrade.
# Trigger Manual Upgrade for Managed Cluster
# Trigger manual upgrade for managed cluster
try {
Update-V2024 -Id $Id
@@ -410,7 +410,7 @@ $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID.
}"@ # JsonPatchOperation[] | JSONPatch payload used to update the object.
# Update Managed Cluster
# Update managed cluster
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation

52
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MultiHostIntegrationApi.md
View File

@@ -20,19 +20,19 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024MultiHostIntegration**](#create-multi-host-integration) | **POST** `/multihosts` | Create Multi-Host Integration
[**New-V2024SourcesWithinMultiHost**](#create-sources-within-multi-host) | **POST** `/multihosts/{multihostId}` | Create Sources Within Multi-Host Integration
[**Remove-V2024MultiHost**](#delete-multi-host) | **DELETE** `/multihosts/{multihostId}` | Delete Multi-Host Integration
[**Get-V2024AcctAggregationGroups**](#get-acct-aggregation-groups) | **GET** `/multihosts/{multihostId}/acctAggregationGroups` | List Account-Aggregation-Groups by Multi-Host ID
[**Get-V2024EntitlementAggregationGroups**](#get-entitlement-aggregation-groups) | **GET** `/multihosts/{multiHostId}/entitlementAggregationGroups` | List Entitlement-Aggregation-Groups by Integration ID
[**Get-V2024MultiHostIntegrations**](#get-multi-host-integrations) | **GET** `/multihosts/{multihostId}` | Get Multi-Host Integration By ID
[**Get-V2024MultiHostIntegrationsList**](#get-multi-host-integrations-list) | **GET** `/multihosts` | List All Existing Multi-Host Integrations
[**Get-V2024MultiHostSourceCreationErrors**](#get-multi-host-source-creation-errors) | **GET** `/multihosts/{multiHostId}/sources/errors` | List Multi-Host Source Creation Errors
[**Get-V2024MultihostIntegrationTypes**](#get-multihost-integration-types) | **GET** `/multihosts/types` | List Multi-Host Integration Types
[**Get-V2024SourcesWithinMultiHost**](#get-sources-within-multi-host) | **GET** `/multihosts/{multihostId}/sources` | List Sources Within Multi-Host Integration
[**Test-V2024ConnectionMultiHostSources**](#test-connection-multi-host-sources) | **POST** `/multihosts/{multihostId}/sources/testConnection` | Test Configuration For Multi-Host Integration
[**Test-V2024SourceConnectionMultihost**](#test-source-connection-multihost) | **GET** `/multihosts/{multihostId}/sources/{sourceId}/testConnection` | Test Configuration For Multi-Host Integration&#39;s Single Source
[**Update-V2024MultiHostSources**](#update-multi-host-sources) | **PATCH** `/multihosts/{multihostId}` | Update Multi-Host Integration
[**New-V2024MultiHostIntegration**](#create-multi-host-integration) | **POST** `/multihosts` | Create multi-host integration
[**New-V2024SourcesWithinMultiHost**](#create-sources-within-multi-host) | **POST** `/multihosts/{multihostId}` | Create sources within multi-host integration
[**Remove-V2024MultiHost**](#delete-multi-host) | **DELETE** `/multihosts/{multihostId}` | Delete multi-host integration
[**Get-V2024AcctAggregationGroups**](#get-acct-aggregation-groups) | **GET** `/multihosts/{multihostId}/acctAggregationGroups` | List account-aggregation-groups by multi-host id
[**Get-V2024EntitlementAggregationGroups**](#get-entitlement-aggregation-groups) | **GET** `/multihosts/{multiHostId}/entitlementAggregationGroups` | List entitlement-aggregation-groups by integration id
[**Get-V2024MultiHostIntegrations**](#get-multi-host-integrations) | **GET** `/multihosts/{multihostId}` | Get multi-host integration by id
[**Get-V2024MultiHostIntegrationsList**](#get-multi-host-integrations-list) | **GET** `/multihosts` | List all existing multi-host integrations
[**Get-V2024MultiHostSourceCreationErrors**](#get-multi-host-source-creation-errors) | **GET** `/multihosts/{multiHostId}/sources/errors` | List multi-host source creation errors
[**Get-V2024MultihostIntegrationTypes**](#get-multihost-integration-types) | **GET** `/multihosts/types` | List multi-host integration types
[**Get-V2024SourcesWithinMultiHost**](#get-sources-within-multi-host) | **GET** `/multihosts/{multihostId}/sources` | List sources within multi-host integration
[**Test-V2024ConnectionMultiHostSources**](#test-connection-multi-host-sources) | **POST** `/multihosts/{multihostId}/sources/testConnection` | Test configuration for multi-host integration
[**Test-V2024SourceConnectionMultihost**](#test-source-connection-multihost) | **GET** `/multihosts/{multihostId}/sources/{sourceId}/testConnection` | Test configuration for multi-host integration&#39;s single source
[**Update-V2024MultiHostSources**](#update-multi-host-sources) | **PATCH** `/multihosts/{multihostId}` | Update multi-host integration
## create-multi-host-integration
@@ -94,7 +94,7 @@ $MultiHostIntegrationsCreate = @"{
"modified" : "2024-01-23T18:08:50.897Z"
}"@
# Create Multi-Host Integration
# Create multi-host integration
try {
$Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate
@@ -157,7 +157,7 @@ $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Hos
}"@ # MultiHostIntegrationsCreateSources[] | The specifics of the sources to create within Multi-Host Integration.
# Create Sources Within Multi-Host Integration
# Create sources within multi-host integration
try {
$Result = ConvertFrom-JsonToMultiHostIntegrationsCreateSources -Json $MultiHostIntegrationsCreateSources
@@ -206,7 +206,7 @@ Code | Description | Data Type
```powershell
$MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of Multi-Host Integration to delete.
# Delete Multi-Host Integration
# Delete multi-host integration
try {
Remove-V2024MultiHost -MultihostId $MultihostId
@@ -257,7 +257,7 @@ $MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to upd
$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)
# List Account-Aggregation-Groups by Multi-Host ID
# List account-aggregation-groups by multi-host id
try {
Get-V2024AcctAggregationGroups -MultihostId $MultihostId
@@ -309,7 +309,7 @@ $MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to upd
$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)
# List Entitlement-Aggregation-Groups by Integration ID
# List entitlement-aggregation-groups by integration id
try {
Get-V2024EntitlementAggregationGroups -MultiHostId $MultiHostId
@@ -357,7 +357,7 @@ Code | Description | Data Type
```powershell
$MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration.
# Get Multi-Host Integration By ID
# Get multi-host integration by id
try {
Get-V2024MultiHostIntegrations -MultihostId $MultihostId
@@ -415,7 +415,7 @@ $Filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # String | Filter results us
$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
# List all existing multi-host integrations
try {
Get-V2024MultiHostIntegrationsList
@@ -463,7 +463,7 @@ Code | Description | Data Type
```powershell
$MultiHostId = "004091cb79b04636b88662afa50a4440" # String | ID of the Multi-Host Integration
# List Multi-Host Source Creation Errors
# List multi-host source creation errors
try {
Get-V2024MultiHostSourceCreationErrors -MultiHostId $MultiHostId
@@ -509,7 +509,7 @@ Code | Description | Data Type
### Example
```powershell
# List Multi-Host Integration Types
# List multi-host integration types
try {
Get-V2024MultihostIntegrationTypes
@@ -567,7 +567,7 @@ $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: **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
# List sources within multi-host integration
try {
Get-V2024SourcesWithinMultiHost -MultihostId $MultihostId
@@ -615,7 +615,7 @@ Code | Description | Data Type
```powershell
$MultihostId = "2c91808568c529c60168cca6f90c1324" # String | ID of the Multi-Host Integration
# Test Configuration For Multi-Host Integration
# Test configuration for multi-host integration
try {
Test-V2024ConnectionMultiHostSources -MultihostId $MultihostId
@@ -665,7 +665,7 @@ Code | Description | Data Type
$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
# Test configuration for multi-host integration's single source
try {
Test-V2024SourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId
@@ -716,7 +716,7 @@ $MultihostId = "anId" # String | ID of the Multi-Host Integration to update.
$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
# Update multi-host integration
try {
$Result = ConvertFrom-JsonToUpdateMultiHostSourcesRequestInner -Json $UpdateMultiHostSourcesRequestInner

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

@@ -48,38 +48,38 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Approve-V2024NonEmployeeRequest**](#approve-non-employee-request) | **POST** `/non-employee-approvals/{id}/approve` | Approve a Non-Employee Request
[**New-V2024NonEmployeeRecord**](#create-non-employee-record) | **POST** `/non-employee-records` | Create Non-Employee Record
[**New-V2024NonEmployeeRequest**](#create-non-employee-request) | **POST** `/non-employee-requests` | Create Non-Employee Request
[**New-V2024NonEmployeeSource**](#create-non-employee-source) | **POST** `/non-employee-sources` | Create Non-Employee Source
[**New-V2024NonEmployeeSourceSchemaAttributes**](#create-non-employee-source-schema-attributes) | **POST** `/non-employee-sources/{sourceId}/schema-attributes` | Create a new Schema Attribute for Non-Employee Source
[**Remove-V2024NonEmployeeRecord**](#delete-non-employee-record) | **DELETE** `/non-employee-records/{id}` | Delete Non-Employee Record
[**Remove-V2024NonEmployeeRecordsInBulk**](#delete-non-employee-records-in-bulk) | **POST** `/non-employee-records/bulk-delete` | Delete Multiple Non-Employee Records
[**Remove-V2024NonEmployeeRequest**](#delete-non-employee-request) | **DELETE** `/non-employee-requests/{id}` | Delete Non-Employee Request
[**Remove-V2024NonEmployeeSchemaAttribute**](#delete-non-employee-schema-attribute) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete a Schema Attribute for Non-Employee Source
[**Remove-V2024NonEmployeeSource**](#delete-non-employee-source) | **DELETE** `/non-employee-sources/{sourceId}` | Delete Non-Employee Source
[**Remove-V2024NonEmployeeSourceSchemaAttributes**](#delete-non-employee-source-schema-attributes) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes for Non-Employee Source
[**Export-V2024NonEmployeeRecords**](#export-non-employee-records) | **GET** `/non-employee-sources/{id}/non-employees/download` | Exports Non-Employee Records to CSV
[**Export-V2024NonEmployeeSourceSchemaTemplate**](#export-non-employee-source-schema-template) | **GET** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports Source Schema Template
[**Approve-V2024NonEmployeeRequest**](#approve-non-employee-request) | **POST** `/non-employee-approvals/{id}/approve` | Approve a non-employee request
[**New-V2024NonEmployeeRecord**](#create-non-employee-record) | **POST** `/non-employee-records` | Create non-employee record
[**New-V2024NonEmployeeRequest**](#create-non-employee-request) | **POST** `/non-employee-requests` | Create non-employee request
[**New-V2024NonEmployeeSource**](#create-non-employee-source) | **POST** `/non-employee-sources` | Create non-employee source
[**New-V2024NonEmployeeSourceSchemaAttributes**](#create-non-employee-source-schema-attributes) | **POST** `/non-employee-sources/{sourceId}/schema-attributes` | Create a new schema attribute for non-employee source
[**Remove-V2024NonEmployeeRecord**](#delete-non-employee-record) | **DELETE** `/non-employee-records/{id}` | Delete non-employee record
[**Remove-V2024NonEmployeeRecordsInBulk**](#delete-non-employee-records-in-bulk) | **POST** `/non-employee-records/bulk-delete` | Delete multiple non-employee records
[**Remove-V2024NonEmployeeRequest**](#delete-non-employee-request) | **DELETE** `/non-employee-requests/{id}` | Delete non-employee request
[**Remove-V2024NonEmployeeSchemaAttribute**](#delete-non-employee-schema-attribute) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete a schema attribute for non-employee source
[**Remove-V2024NonEmployeeSource**](#delete-non-employee-source) | **DELETE** `/non-employee-sources/{sourceId}` | Delete non-employee source
[**Remove-V2024NonEmployeeSourceSchemaAttributes**](#delete-non-employee-source-schema-attributes) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes for non-employee source
[**Export-V2024NonEmployeeRecords**](#export-non-employee-records) | **GET** `/non-employee-sources/{id}/non-employees/download` | Exports non-employee records to csv
[**Export-V2024NonEmployeeSourceSchemaTemplate**](#export-non-employee-source-schema-template) | **GET** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports source schema template
[**Get-V2024NonEmployeeApproval**](#get-non-employee-approval) | **GET** `/non-employee-approvals/{id}` | Get a non-employee approval item detail
[**Get-V2024NonEmployeeApprovalSummary**](#get-non-employee-approval-summary) | **GET** `/non-employee-approvals/summary/{requested-for}` | Get Summary of Non-Employee Approval Requests
[**Get-V2024NonEmployeeApprovalSummary**](#get-non-employee-approval-summary) | **GET** `/non-employee-approvals/summary/{requested-for}` | Get summary of non-employee approval requests
[**Get-V2024NonEmployeeBulkUploadStatus**](#get-non-employee-bulk-upload-status) | **GET** `/non-employee-sources/{id}/non-employee-bulk-upload/status` | Obtain the status of bulk upload on the source
[**Get-V2024NonEmployeeRecord**](#get-non-employee-record) | **GET** `/non-employee-records/{id}` | Get a Non-Employee Record
[**Get-V2024NonEmployeeRequest**](#get-non-employee-request) | **GET** `/non-employee-requests/{id}` | Get a Non-Employee Request
[**Get-V2024NonEmployeeRequestSummary**](#get-non-employee-request-summary) | **GET** `/non-employee-requests/summary/{requested-for}` | Get Summary of Non-Employee Requests
[**Get-V2024NonEmployeeSchemaAttribute**](#get-non-employee-schema-attribute) | **GET** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get Schema Attribute Non-Employee Source
[**Get-V2024NonEmployeeSource**](#get-non-employee-source) | **GET** `/non-employee-sources/{sourceId}` | Get a Non-Employee Source
[**Get-V2024NonEmployeeSourceSchemaAttributes**](#get-non-employee-source-schema-attributes) | **GET** `/non-employee-sources/{sourceId}/schema-attributes` | List Schema Attributes Non-Employee Source
[**Import-V2024NonEmployeeRecordsInBulk**](#import-non-employee-records-in-bulk) | **POST** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or Updates, Non-Employee Records
[**Get-V2024NonEmployeeApprovals**](#list-non-employee-approvals) | **GET** `/non-employee-approvals` | Get List of Non-Employee Approval Requests
[**Get-V2024NonEmployeeRecords**](#list-non-employee-records) | **GET** `/non-employee-records` | List Non-Employee Records
[**Get-V2024NonEmployeeRequests**](#list-non-employee-requests) | **GET** `/non-employee-requests` | List Non-Employee Requests
[**Get-V2024NonEmployeeSources**](#list-non-employee-sources) | **GET** `/non-employee-sources` | List Non-Employee Sources
[**Update-V2024NonEmployeeRecord**](#patch-non-employee-record) | **PATCH** `/non-employee-records/{id}` | Patch Non-Employee Record
[**Update-V2024NonEmployeeSchemaAttribute**](#patch-non-employee-schema-attribute) | **PATCH** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch a Schema Attribute for Non-Employee Source
[**Update-V2024NonEmployeeSource**](#patch-non-employee-source) | **PATCH** `/non-employee-sources/{sourceId}` | Patch a Non-Employee Source
[**Deny-V2024NonEmployeeRequest**](#reject-non-employee-request) | **POST** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request
[**Update-V2024NonEmployeeRecord**](#update-non-employee-record) | **PUT** `/non-employee-records/{id}` | Update Non-Employee Record
[**Get-V2024NonEmployeeRecord**](#get-non-employee-record) | **GET** `/non-employee-records/{id}` | Get a non-employee record
[**Get-V2024NonEmployeeRequest**](#get-non-employee-request) | **GET** `/non-employee-requests/{id}` | Get a non-employee request
[**Get-V2024NonEmployeeRequestSummary**](#get-non-employee-request-summary) | **GET** `/non-employee-requests/summary/{requested-for}` | Get summary of non-employee requests
[**Get-V2024NonEmployeeSchemaAttribute**](#get-non-employee-schema-attribute) | **GET** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get schema attribute non-employee source
[**Get-V2024NonEmployeeSource**](#get-non-employee-source) | **GET** `/non-employee-sources/{sourceId}` | Get a non-employee source
[**Get-V2024NonEmployeeSourceSchemaAttributes**](#get-non-employee-source-schema-attributes) | **GET** `/non-employee-sources/{sourceId}/schema-attributes` | List schema attributes non-employee source
[**Import-V2024NonEmployeeRecordsInBulk**](#import-non-employee-records-in-bulk) | **POST** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or updates, non-employee records
[**Get-V2024NonEmployeeApprovals**](#list-non-employee-approvals) | **GET** `/non-employee-approvals` | Get list of non-employee approval requests
[**Get-V2024NonEmployeeRecords**](#list-non-employee-records) | **GET** `/non-employee-records` | List non-employee records
[**Get-V2024NonEmployeeRequests**](#list-non-employee-requests) | **GET** `/non-employee-requests` | List non-employee requests
[**Get-V2024NonEmployeeSources**](#list-non-employee-sources) | **GET** `/non-employee-sources` | List non-employee sources
[**Update-V2024NonEmployeeRecord**](#patch-non-employee-record) | **PATCH** `/non-employee-records/{id}` | Patch non-employee record
[**Update-V2024NonEmployeeSchemaAttribute**](#patch-non-employee-schema-attribute) | **PATCH** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch a schema attribute for non-employee source
[**Update-V2024NonEmployeeSource**](#patch-non-employee-source) | **PATCH** `/non-employee-sources/{sourceId}` | Patch a non-employee source
[**Deny-V2024NonEmployeeRequest**](#reject-non-employee-request) | **POST** `/non-employee-approvals/{id}/reject` | Reject a non-employee request
[**Update-V2024NonEmployeeRecord**](#update-non-employee-record) | **PUT** `/non-employee-records/{id}` | Update non-employee record
## approve-non-employee-request
@@ -117,7 +117,7 @@ $NonEmployeeApprovalDecision = @"{
"comment" : "Approved by manager"
}"@
# Approve a Non-Employee Request
# Approve a non-employee request
try {
$Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision
@@ -177,7 +177,7 @@ $NonEmployeeRequestBody = @"{
"startDate" : "2020-03-24T00:00:00-05:00"
}"@
# Create Non-Employee Record
# Create non-employee record
try {
$Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody
@@ -236,7 +236,7 @@ $NonEmployeeRequestBody = @"{
"startDate" : "2020-03-24T00:00:00-05:00"
}"@
# Create Non-Employee Request
# Create non-employee request
try {
$Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody
@@ -307,7 +307,7 @@ $NonEmployeeSourceRequestBody = @"{
} ]
}"@
# Create Non-Employee Source
# Create non-employee source
try {
$Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody
@@ -363,7 +363,7 @@ $NonEmployeeSchemaAttributeBody = @"{
"required" : true
}"@
# Create a new Schema Attribute for Non-Employee Source
# Create a new schema attribute for non-employee source
try {
$Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody
@@ -410,7 +410,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID)
# Delete Non-Employee Record
# Delete non-employee record
try {
Remove-V2024NonEmployeeRecord -Id $Id
@@ -455,7 +455,7 @@ Code | Description | Data Type
```powershell
$DeleteNonEmployeeRecordsInBulkRequest = @""@
# Delete Multiple Non-Employee Records
# Delete multiple non-employee records
try {
$Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest
@@ -503,7 +503,7 @@ Code | Description | Data Type
```powershell
$Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id in the UUID format
# Delete Non-Employee Request
# Delete non-employee request
try {
Remove-V2024NonEmployeeRequest -Id $Id
@@ -552,7 +552,7 @@ Code | Description | Data Type
$AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID)
$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
# Delete a Schema Attribute for Non-Employee Source
# Delete a schema attribute for non-employee source
try {
Remove-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
@@ -597,7 +597,7 @@ Code | Description | Data Type
```powershell
$SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id
# Delete Non-Employee Source
# Delete non-employee source
try {
Remove-V2024NonEmployeeSource -SourceId $SourceId
@@ -642,7 +642,7 @@ Code | Description | Data Type
```powershell
$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
# Delete all custom schema attributes for Non-Employee Source
# Delete all custom schema attributes for non-employee source
try {
Remove-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId
@@ -688,7 +688,7 @@ Code | Description | Data Type
```powershell
$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID)
# Exports Non-Employee Records to CSV
# Exports non-employee records to csv
try {
Export-V2024NonEmployeeRecords -Id $Id
@@ -734,7 +734,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID)
# Exports Source Schema Template
# Exports source schema template
try {
Export-V2024NonEmployeeSourceSchemaTemplate -Id $Id
@@ -833,7 +833,7 @@ Code | Description | Data Type
```powershell
$RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user.
# Get Summary of Non-Employee Approval Requests
# Get summary of non-employee approval requests
try {
Get-V2024NonEmployeeApprovalSummary -RequestedFor $RequestedFor
@@ -926,7 +926,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID)
# Get a Non-Employee Record
# Get a non-employee record
try {
Get-V2024NonEmployeeRecord -Id $Id
@@ -976,7 +976,7 @@ Code | Description | Data Type
```powershell
$Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id (UUID)
# Get a Non-Employee Request
# Get a non-employee request
try {
Get-V2024NonEmployeeRequest -Id $Id
@@ -1025,7 +1025,7 @@ Code | Description | Data Type
```powershell
$RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user.
# Get Summary of Non-Employee Requests
# Get summary of non-employee requests
try {
Get-V2024NonEmployeeRequestSummary -RequestedFor $RequestedFor
@@ -1072,7 +1072,7 @@ Code | Description | Data Type
$AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID)
$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
# Get Schema Attribute Non-Employee Source
# Get schema attribute non-employee source
try {
Get-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
@@ -1121,7 +1121,7 @@ Code | Description | Data Type
```powershell
$SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id
# Get a Non-Employee Source
# Get a non-employee source
try {
Get-V2024NonEmployeeSource -SourceId $SourceId
@@ -1168,7 +1168,7 @@ Code | Description | Data Type
```powershell
$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
# List Schema Attributes Non-Employee Source
# List schema attributes non-employee source
try {
Get-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId
@@ -1216,7 +1216,7 @@ Code | Description | Data Type
$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID)
$Data = # System.IO.FileInfo |
# Imports, or Updates, Non-Employee Records
# Imports, or updates, non-employee records
try {
Import-V2024NonEmployeeRecordsInBulk -Id $Id -Data $Data
@@ -1275,7 +1275,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'approvalStatus 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: **approvalStatus**: *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: **created, modified** (optional)
# Get List of Non-Employee Approval Requests
# Get list of non-employee approval requests
try {
Get-V2024NonEmployeeApprovals
@@ -1330,7 +1330,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Sorters = "accountName,sourceId" # 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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional)
$Filters = 'sourceId 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: **sourceId**: *eq* (optional)
# List Non-Employee Records
# List non-employee records
try {
Get-V2024NonEmployeeRecords
@@ -1389,7 +1389,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Sorters = "created,approvalStatus" # 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, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional)
$Filters = 'sourceId 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: **sourceId**: *eq* (optional)
# List Non-Employee Requests
# List non-employee requests
try {
Get-V2024NonEmployeeRequests -RequestedFor $RequestedFor
@@ -1446,7 +1446,7 @@ $RequestedFor = "me" # String | Identity the request was made for. Use 'me' to i
$NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false)
$Sorters = "name,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: **name, created, sourceId** (optional)
# List Non-Employee Sources
# List non-employee sources
try {
Get-V2024NonEmployeeSources
@@ -1503,7 +1503,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID
}"@ # JsonPatchOperation[] | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields.
# Patch Non-Employee Record
# Patch non-employee record
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
@@ -1561,7 +1561,7 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
}"@ # JsonPatchOperation[] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'.
# Patch a Schema Attribute for Non-Employee Source
# Patch a schema attribute for non-employee source
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
@@ -1614,7 +1614,7 @@ $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id
}"@ # JsonPatchOperation[] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
# Patch a Non-Employee Source
# Patch a non-employee source
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
@@ -1664,7 +1664,7 @@ $NonEmployeeRejectApprovalDecision = @"{
"comment" : "approved"
}"@
# Reject a Non-Employee Request
# Reject a non-employee request
try {
$Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision
@@ -1730,7 +1730,7 @@ $NonEmployeeRequestBody = @"{
"startDate" : "2020-03-24T00:00:00-05:00"
}"@
# Update Non-Employee Record
# Update non-employee record
try {
$Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody

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

@@ -17,21 +17,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024DomainDkim**](#create-domain-dkim) | **POST** `/verified-domains` | Verify domain address via DKIM
[**New-V2024NotificationTemplate**](#create-notification-template) | **POST** `/notification-templates` | Create Notification Template
[**New-V2024VerifiedFromAddress**](#create-verified-from-address) | **POST** `/verified-from-addresses` | Create Verified From Address
[**Remove-V2024NotificationTemplatesInBulk**](#delete-notification-templates-in-bulk) | **POST** `/notification-templates/bulk-delete` | Bulk Delete Notification Templates
[**Remove-V2024VerifiedFromAddress**](#delete-verified-from-address) | **DELETE** `/verified-from-addresses/{id}` | Delete Verified From Address
[**Get-V2024DkimAttributes**](#get-dkim-attributes) | **GET** `/verified-domains` | Get DKIM Attributes
[**Get-V2024MailFromAttributes**](#get-mail-from-attributes) | **GET** `/mail-from-attributes/{identity}` | Get MAIL FROM Attributes
[**Get-V2024NotificationTemplate**](#get-notification-template) | **GET** `/notification-templates/{id}` | Get Notification Template By Id
[**Get-V2024NotificationsTemplateContext**](#get-notifications-template-context) | **GET** `/notification-template-context` | Get Notification Template Context
[**Get-V2024FromAddresses**](#list-from-addresses) | **GET** `/verified-from-addresses` | List From Addresses
[**Get-V2024NotificationPreferences**](#list-notification-preferences) | **GET** `/notification-preferences/{key}` | List Notification Preferences for tenant.
[**Get-V2024NotificationTemplateDefaults**](#list-notification-template-defaults) | **GET** `/notification-template-defaults` | List Notification Template Defaults
[**Get-V2024NotificationTemplates**](#list-notification-templates) | **GET** `/notification-templates` | List Notification Templates
[**Send-V2024MailFromAttributes**](#put-mail-from-attributes) | **PUT** `/mail-from-attributes` | Change MAIL FROM domain
[**Send-V2024TestNotification**](#send-test-notification) | **POST** `/send-test-notification` | Send Test Notification
[**New-V2024DomainDkim**](#create-domain-dkim) | **POST** `/verified-domains` | Verify domain address via dkim
[**New-V2024NotificationTemplate**](#create-notification-template) | **POST** `/notification-templates` | Create notification template
[**New-V2024VerifiedFromAddress**](#create-verified-from-address) | **POST** `/verified-from-addresses` | Create verified from address
[**Remove-V2024NotificationTemplatesInBulk**](#delete-notification-templates-in-bulk) | **POST** `/notification-templates/bulk-delete` | Bulk delete notification templates
[**Remove-V2024VerifiedFromAddress**](#delete-verified-from-address) | **DELETE** `/verified-from-addresses/{id}` | Delete verified from address
[**Get-V2024DkimAttributes**](#get-dkim-attributes) | **GET** `/verified-domains` | Get dkim attributes
[**Get-V2024MailFromAttributes**](#get-mail-from-attributes) | **GET** `/mail-from-attributes/{identity}` | Get mail from attributes
[**Get-V2024NotificationTemplate**](#get-notification-template) | **GET** `/notification-templates/{id}` | Get notification template by id
[**Get-V2024NotificationsTemplateContext**](#get-notifications-template-context) | **GET** `/notification-template-context` | Get notification template context
[**Get-V2024FromAddresses**](#list-from-addresses) | **GET** `/verified-from-addresses` | List from addresses
[**Get-V2024NotificationPreferences**](#list-notification-preferences) | **GET** `/notification-preferences/{key}` | List notification preferences for tenant.
[**Get-V2024NotificationTemplateDefaults**](#list-notification-template-defaults) | **GET** `/notification-template-defaults` | List notification template defaults
[**Get-V2024NotificationTemplates**](#list-notification-templates) | **GET** `/notification-templates` | List notification templates
[**Send-V2024MailFromAttributes**](#put-mail-from-attributes) | **PUT** `/mail-from-attributes` | Change mail from domain
[**Send-V2024TestNotification**](#send-test-notification) | **POST** `/send-test-notification` | Send test notification
## create-domain-dkim
@@ -73,7 +73,7 @@ $DomainAddress = @"{
"domain" : "sailpoint.com"
}"@
# Verify domain address via DKIM
# Verify domain address via dkim
try {
$Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress
@@ -143,7 +143,7 @@ $TemplateDto = @"{
"key" : "cloud_manual_work_item_summary"
}"@
# Create Notification Template
# Create notification template
try {
$Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto
@@ -199,7 +199,7 @@ $EmailStatusDto = @"{
"email" : "sender@example.com"
}"@
# Create Verified From Address
# Create verified from address
try {
$Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto
@@ -255,7 +255,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
}"@ # TemplateBulkDeleteDto[] |
# Bulk Delete Notification Templates
# Bulk delete notification templates
try {
$Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto
@@ -307,7 +307,7 @@ Code | Description | Data Type
$Id = "MyId" # String |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Delete Verified From Address
# Delete verified from address
try {
Remove-V2024VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -355,7 +355,7 @@ Code | Description | Data Type
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get DKIM Attributes
# Get dkim attributes
try {
Get-V2024DkimAttributes -XSailPointExperimental $XSailPointExperimental
@@ -405,7 +405,7 @@ Code | Description | Data Type
$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
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get MAIL FROM Attributes
# Get mail from attributes
try {
Get-V2024MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -455,7 +455,7 @@ Code | Description | Data Type
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification Template
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get Notification Template By Id
# Get notification template by id
try {
Get-V2024NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -504,7 +504,7 @@ Code | Description | Data Type
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get Notification Template Context
# Get notification template context
try {
Get-V2024NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental
@@ -561,7 +561,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$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
# List from addresses
try {
Get-V2024FromAddresses -XSailPointExperimental $XSailPointExperimental
@@ -610,7 +610,7 @@ Code | Description | Data Type
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# List Notification Preferences for tenant.
# List notification preferences for tenant.
try {
Get-V2024NotificationPreferences -XSailPointExperimental $XSailPointExperimental
@@ -664,7 +664,7 @@ $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)
$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
# List notification template defaults
try {
Get-V2024NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental
@@ -718,7 +718,7 @@ $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)
$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
# List notification templates
try {
Get-V2024NotificationTemplates -XSailPointExperimental $XSailPointExperimental
@@ -771,7 +771,7 @@ $MailFromAttributesDto = @"{
"mailFromDomain" : "example.sailpoint.com"
}"@
# Change MAIL FROM domain
# Change mail from domain
try {
$Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto
@@ -827,7 +827,7 @@ $SendTestNotificationRequestDto = @"{
"key" : "cloud_manual_work_item_summary"
}"@
# Send Test Notification
# Send test notification
try {
$Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto

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

@@ -20,11 +20,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024OauthClient**](#create-oauth-client) | **POST** `/oauth-clients` | Create OAuth Client
[**Remove-V2024OauthClient**](#delete-oauth-client) | **DELETE** `/oauth-clients/{id}` | Delete OAuth Client
[**Get-V2024OauthClient**](#get-oauth-client) | **GET** `/oauth-clients/{id}` | Get OAuth Client
[**Get-V2024OauthClients**](#list-oauth-clients) | **GET** `/oauth-clients` | List OAuth Clients
[**Update-V2024OauthClient**](#patch-oauth-client) | **PATCH** `/oauth-clients/{id}` | Patch OAuth Client
[**New-V2024OauthClient**](#create-oauth-client) | **POST** `/oauth-clients` | Create oauth client
[**Remove-V2024OauthClient**](#delete-oauth-client) | **DELETE** `/oauth-clients/{id}` | Delete oauth client
[**Get-V2024OauthClient**](#get-oauth-client) | **GET** `/oauth-clients/{id}` | Get oauth client
[**Get-V2024OauthClients**](#list-oauth-clients) | **GET** `/oauth-clients` | List oauth clients
[**Update-V2024OauthClient**](#patch-oauth-client) | **PATCH** `/oauth-clients/{id}` | Patch oauth client
## create-oauth-client
@@ -74,7 +74,7 @@ $CreateOAuthClientRequest = @"{
"claimsSupported" : false
}"@
# Create OAuth Client
# Create oauth client
try {
$Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest
@@ -121,7 +121,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id
# Delete OAuth Client
# Delete oauth client
try {
Remove-V2024OauthClient -Id $Id
@@ -167,7 +167,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id
# Get OAuth Client
# Get oauth client
try {
Get-V2024OauthClient -Id $Id
@@ -212,7 +212,7 @@ Code | Description | Data Type
```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
# List oauth clients
try {
Get-V2024OauthClients
@@ -265,7 +265,7 @@ $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
# Patch OAuth Client
# Patch oauth client
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation

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

@@ -19,9 +19,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024OrgConfig**](#get-org-config) | **GET** `/org-config` | Get Org Config Settings
[**Get-V2024ValidTimeZones**](#get-valid-time-zones) | **GET** `/org-config/valid-time-zones` | Get Valid Time Zones
[**Update-V2024OrgConfig**](#patch-org-config) | **PATCH** `/org-config` | Patch Org Config
[**Get-V2024OrgConfig**](#get-org-config) | **GET** `/org-config` | Get org config settings
[**Get-V2024ValidTimeZones**](#get-valid-time-zones) | **GET** `/org-config/valid-time-zones` | Get valid time zones
[**Update-V2024OrgConfig**](#patch-org-config) | **PATCH** `/org-config` | Patch org config
## get-org-config
@@ -59,7 +59,7 @@ Code | Description | Data Type
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get Org Config Settings
# Get org config settings
try {
Get-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental
@@ -113,7 +113,7 @@ $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50.
$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 Valid Time Zones
# Get valid time zones
try {
Get-V2024ValidTimeZones -XSailPointExperimental $XSailPointExperimental
@@ -169,7 +169,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
}"@ # JsonPatchOperation[] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
# Patch Org Config
# Patch org config
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation

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

@@ -23,9 +23,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024PasswordOrgConfig**](#create-password-org-config) | **POST** `/password-org-config` | Create Password Org Config
[**Get-V2024PasswordOrgConfig**](#get-password-org-config) | **GET** `/password-org-config` | Get Password Org Config
[**Send-V2024PasswordOrgConfig**](#put-password-org-config) | **PUT** `/password-org-config` | Update Password Org Config
[**New-V2024PasswordOrgConfig**](#create-password-org-config) | **POST** `/password-org-config` | Create password org config
[**Get-V2024PasswordOrgConfig**](#get-password-org-config) | **GET** `/password-org-config` | Get password org config
[**Send-V2024PasswordOrgConfig**](#put-password-org-config) | **PUT** `/password-org-config` | Update password org config
## create-password-org-config
@@ -66,7 +66,7 @@ $PasswordOrgConfig = @"{
"customInstructionsEnabled" : true
}"@
# Create Password Org Config
# Create password org config
try {
$Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig
@@ -110,7 +110,7 @@ Code | Description | Data Type
### Example
```powershell
# Get Password Org Config
# Get password org config
try {
Get-V2024PasswordOrgConfig
@@ -162,7 +162,7 @@ $PasswordOrgConfig = @"{
"customInstructionsEnabled" : true
}"@
# Update Password Org Config
# Update password org config
try {
$Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig

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

@@ -64,8 +64,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024PasswordDictionary**](#get-password-dictionary) | **GET** `/password-dictionary` | Get Password Dictionary
[**Send-V2024PasswordDictionary**](#put-password-dictionary) | **PUT** `/password-dictionary` | Update Password Dictionary
[**Get-V2024PasswordDictionary**](#get-password-dictionary) | **GET** `/password-dictionary` | Get password dictionary
[**Send-V2024PasswordDictionary**](#put-password-dictionary) | **PUT** `/password-dictionary` | Update password dictionary
## get-password-dictionary
@@ -126,7 +126,7 @@ Code | Description | Data Type
### Example
```powershell
# Get Password Dictionary
# Get password dictionary
try {
Get-V2024PasswordDictionary
@@ -201,7 +201,7 @@ Code | Description | Data Type
```powershell
$File = # System.IO.FileInfo | (optional)
# Update Password Dictionary
# Update password dictionary
try {
Send-V2024PasswordDictionary

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

@@ -42,9 +42,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024DigitToken**](#create-digit-token) | **POST** `/generate-password-reset-token/digit` | Generate a digit token
[**Get-V2024PasswordChangeStatus**](#get-password-change-status) | **GET** `/password-change-status/{id}` | Get Password Change Request Status
[**Search-V2024PasswordInfo**](#query-password-info) | **POST** `/query-password-info` | Query Password Info
[**Set-V2024Password**](#set-password) | **POST** `/set-password` | Set Identity&#39;s Password
[**Get-V2024PasswordChangeStatus**](#get-password-change-status) | **GET** `/password-change-status/{id}` | Get password change request status
[**Search-V2024PasswordInfo**](#query-password-info) | **POST** `/query-password-info` | Query password info
[**Set-V2024Password**](#set-password) | **POST** `/set-password` | Set identity&#39;s password
## create-digit-token
@@ -134,7 +134,7 @@ Code | Description | Data Type
```powershell
$Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID
# Get Password Change Request Status
# Get password change request status
try {
Get-V2024PasswordChangeStatus -Id $Id
@@ -183,7 +183,7 @@ $PasswordInfoQueryDTO = @"{
"userName" : "Abby.Smith"
}"@
# Query Password Info
# Query password info
try {
$Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO
@@ -254,7 +254,7 @@ $PasswordChangeRequest = @"{
"encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A=="
}"@
# Set Identity's Password
# Set identity's password
try {
$Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest

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

@@ -25,11 +25,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024PasswordPolicy**](#create-password-policy) | **POST** `/password-policies` | Create Password Policy
[**Remove-V2024PasswordPolicy**](#delete-password-policy) | **DELETE** `/password-policies/{id}` | Delete Password Policy by ID
[**Get-V2024PasswordPolicyById**](#get-password-policy-by-id) | **GET** `/password-policies/{id}` | Get Password Policy by ID
[**Get-V2024PasswordPolicies**](#list-password-policies) | **GET** `/password-policies` | List Password Policies
[**Set-V2024PasswordPolicy**](#set-password-policy) | **PUT** `/password-policies/{id}` | Update Password Policy by ID
[**New-V2024PasswordPolicy**](#create-password-policy) | **POST** `/password-policies` | Create password policy
[**Remove-V2024PasswordPolicy**](#delete-password-policy) | **DELETE** `/password-policies/{id}` | Delete password policy by id
[**Get-V2024PasswordPolicyById**](#get-password-policy-by-id) | **GET** `/password-policies/{id}` | Get password policy by id
[**Get-V2024PasswordPolicies**](#list-password-policies) | **GET** `/password-policies` | List password policies
[**Set-V2024PasswordPolicy**](#set-password-policy) | **PUT** `/password-policies/{id}` | Update password policy by id
## create-password-policy
@@ -96,7 +96,7 @@ $PasswordPolicyV3Dto = @"{
"maxLength" : 25
}"@
# Create Password Policy
# Create password policy
try {
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
@@ -143,7 +143,7 @@ Code | Description | Data Type
```powershell
$Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete.
# Delete Password Policy by ID
# Delete password policy by id
try {
Remove-V2024PasswordPolicy -Id $Id
@@ -189,7 +189,7 @@ Code | Description | Data Type
```powershell
$Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve.
# Get Password Policy by ID
# Get password policy by id
try {
Get-V2024PasswordPolicyById -Id $Id
@@ -239,7 +239,7 @@ $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)
# List Password Policies
# List password policies
try {
Get-V2024PasswordPolicies
@@ -319,7 +319,7 @@ $PasswordPolicyV3Dto = @"{
"maxLength" : 25
}"@
# Update Password Policy by ID
# Update password policy by id
try {
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto

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

@@ -49,11 +49,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024PasswordSyncGroup**](#create-password-sync-group) | **POST** `/password-sync-groups` | Create Password Sync Group
[**Remove-V2024PasswordSyncGroup**](#delete-password-sync-group) | **DELETE** `/password-sync-groups/{id}` | Delete Password Sync Group by ID
[**Get-V2024PasswordSyncGroup**](#get-password-sync-group) | **GET** `/password-sync-groups/{id}` | Get Password Sync Group by ID
[**Get-V2024PasswordSyncGroups**](#get-password-sync-groups) | **GET** `/password-sync-groups` | Get Password Sync Group List
[**Update-V2024PasswordSyncGroup**](#update-password-sync-group) | **PUT** `/password-sync-groups/{id}` | Update Password Sync Group by ID
[**New-V2024PasswordSyncGroup**](#create-password-sync-group) | **POST** `/password-sync-groups` | Create password sync group
[**Remove-V2024PasswordSyncGroup**](#delete-password-sync-group) | **DELETE** `/password-sync-groups/{id}` | Delete password sync group by id
[**Get-V2024PasswordSyncGroup**](#get-password-sync-group) | **GET** `/password-sync-groups/{id}` | Get password sync group by id
[**Get-V2024PasswordSyncGroups**](#get-password-sync-groups) | **GET** `/password-sync-groups` | Get password sync group list
[**Update-V2024PasswordSyncGroup**](#update-password-sync-group) | **PUT** `/password-sync-groups/{id}` | Update password sync group by id
## create-password-sync-group
@@ -94,7 +94,7 @@ $PasswordSyncGroup = @"{
"sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ]
}"@
# Create Password Sync Group
# Create password sync group
try {
$Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup
@@ -140,7 +140,7 @@ Code | Description | Data Type
```powershell
$Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete.
# Delete Password Sync Group by ID
# Delete password sync group by id
try {
Remove-V2024PasswordSyncGroup -Id $Id
@@ -186,7 +186,7 @@ Code | Description | Data Type
```powershell
$Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve.
# Get Password Sync Group by ID
# Get password sync group by id
try {
Get-V2024PasswordSyncGroup -Id $Id
@@ -235,7 +235,7 @@ $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)
# Get Password Sync Group List
# Get password sync group list
try {
Get-V2024PasswordSyncGroups
@@ -290,7 +290,7 @@ $PasswordSyncGroup = @"{
"sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ]
}"@
# Update Password Sync Group by ID
# Update password sync group by id
try {
$Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup

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

@@ -28,10 +28,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024PersonalAccessToken**](#create-personal-access-token) | **POST** `/personal-access-tokens` | Create Personal Access Token
[**Remove-V2024PersonalAccessToken**](#delete-personal-access-token) | **DELETE** `/personal-access-tokens/{id}` | Delete Personal Access Token
[**Get-V2024PersonalAccessTokens**](#list-personal-access-tokens) | **GET** `/personal-access-tokens` | List Personal Access Tokens
[**Update-V2024PersonalAccessToken**](#patch-personal-access-token) | **PATCH** `/personal-access-tokens/{id}` | Patch Personal Access Token
[**New-V2024PersonalAccessToken**](#create-personal-access-token) | **POST** `/personal-access-tokens` | Create personal access token
[**Remove-V2024PersonalAccessToken**](#delete-personal-access-token) | **DELETE** `/personal-access-tokens/{id}` | Delete personal access token
[**Get-V2024PersonalAccessTokens**](#list-personal-access-tokens) | **GET** `/personal-access-tokens` | List personal access tokens
[**Update-V2024PersonalAccessToken**](#patch-personal-access-token) | **PATCH** `/personal-access-tokens/{id}` | Patch personal access token
## create-personal-access-token
@@ -69,7 +69,7 @@ $CreatePersonalAccessTokenRequest = @"{
"name" : "NodeJS Integration"
}"@
# Create Personal Access Token
# Create personal access token
try {
$Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest
@@ -116,7 +116,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id
# Delete Personal Access Token
# Delete personal access token
try {
Remove-V2024PersonalAccessToken -Id $Id
@@ -163,7 +163,7 @@ Code | Description | Data Type
$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
# List personal access tokens
try {
Get-V2024PersonalAccessTokens
@@ -217,7 +217,7 @@ $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
# Patch Personal Access Token
# Patch personal access token
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation

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

@@ -27,8 +27,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024PublicIdentityConfig**](#get-public-identity-config) | **GET** `/public-identities-config` | Get the Public Identities Configuration
[**Update-V2024PublicIdentityConfig**](#update-public-identity-config) | **PUT** `/public-identities-config` | Update the Public Identities Configuration
[**Get-V2024PublicIdentityConfig**](#get-public-identity-config) | **GET** `/public-identities-config` | Get the public identities configuration
[**Update-V2024PublicIdentityConfig**](#update-public-identity-config) | **PUT** `/public-identities-config` | Update the public identities configuration
## get-public-identity-config
@@ -60,7 +60,7 @@ Code | Description | Data Type
### Example
```powershell
# Get the Public Identities Configuration
# Get the public identities configuration
try {
Get-V2024PublicIdentityConfig
@@ -119,7 +119,7 @@ $PublicIdentityConfig = @"{
}
}"@
# Update the Public Identities Configuration
# Update the public identities configuration
try {
$Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig

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

@@ -20,10 +20,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Suspend-V2024Report**](#cancel-report) | **POST** `/reports/{id}/cancel` | Cancel Report
[**Get-V2024Report**](#get-report) | **GET** `/reports/{taskResultId}` | Get Report File
[**Get-V2024ReportResult**](#get-report-result) | **GET** `/reports/{taskResultId}/result` | Get Report Result
[**Start-V2024Report**](#start-report) | **POST** `/reports/run` | Run Report
[**Suspend-V2024Report**](#cancel-report) | **POST** `/reports/{id}/cancel` | Cancel report
[**Get-V2024Report**](#get-report) | **GET** `/reports/{taskResultId}` | Get report file
[**Get-V2024ReportResult**](#get-report-result) | **GET** `/reports/{taskResultId}/result` | Get report result
[**Start-V2024Report**](#start-report) | **POST** `/reports/run` | Run report
## cancel-report
@@ -57,7 +57,7 @@ Code | Description | Data Type
```powershell
$Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to cancel
# Cancel Report
# Cancel report
try {
Suspend-V2024Report -Id $Id
@@ -109,7 +109,7 @@ $FileFormat = "csv" # String | Output format of the requested report file
$Name = "Identities Details Report" # String | preferred Report file name, by default will be used report name from task result. (optional)
$Auditable = $true # Boolean | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to $false)
# Get Report File
# Get report file
try {
Get-V2024Report -TaskResultId $TaskResultId -FileFormat $FileFormat
@@ -156,7 +156,7 @@ Code | Description | Data Type
$TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report
$Completed = $true # Boolean | state of task result to apply ordering when results are fetching from the DB (optional) (default to $false)
# Get Report Result
# Get report result
try {
Get-V2024ReportResult -TaskResultId $TaskResultId
@@ -207,7 +207,7 @@ $ReportDetails = @"{
}
}"@
# Run Report
# Run report
try {
$Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails

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

@@ -20,7 +20,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024RequestableObjects**](#list-requestable-objects) | **GET** `/requestable-objects` | Requestable Objects List
[**Get-V2024RequestableObjects**](#list-requestable-objects) | **GET** `/requestable-objects` | Requestable objects list
## list-requestable-objects
@@ -75,7 +75,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$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
# Requestable objects list
try {
Get-V2024RequestableObjects

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

@@ -54,22 +54,22 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024Role**](#create-role) | **POST** `/roles` | Create a Role
[**Remove-V2024BulkRoles**](#delete-bulk-roles) | **POST** `/roles/bulk-delete` | Delete Role(s)
[**Remove-V2024MetadataFromRoleByKeyAndValue**](#delete-metadata-from-role-by-key-and-value) | **DELETE** `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove a Metadata From Role.
[**Remove-V2024Role**](#delete-role) | **DELETE** `/roles/{id}` | Delete a Role
[**Get-V2024BulkUpdateStatus**](#get-bulk-update-status) | **GET** `/roles/access-model-metadata/bulk-update` | Get Bulk-Update Statuses
[**Get-V2024BulkUpdateStatusById**](#get-bulk-update-status-by-id) | **GET** `/roles/access-model-metadata/bulk-update/id` | Get Bulk-Update Status by ID
[**Get-V2024Role**](#get-role) | **GET** `/roles/{id}` | Get a Role
[**Get-V2024RoleAssignedIdentities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | List Identities assigned a Role
[**Get-V2024RoleEntitlements**](#get-role-entitlements) | **GET** `/roles/{id}/entitlements` | List Role&#39;s Entitlements
[**Get-V2024Roles**](#list-roles) | **GET** `/roles` | List Roles
[**Update-V2024Role**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified Role
[**Search-V2024RolesByFilter**](#search-roles-by-filter) | **POST** `/roles/filter` | Filter Roles by Metadata
[**Update-V2024AttributeKeyAndValueToRole**](#update-attribute-key-and-value-to-role) | **POST** `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add a Metadata to Role.
[**Update-V2024RolesMetadataByFilter**](#update-roles-metadata-by-filter) | **POST** `/roles/access-model-metadata/bulk-update/filter` | Bulk-Update Roles&#39; Metadata by Filters
[**Update-V2024RolesMetadataByIds**](#update-roles-metadata-by-ids) | **POST** `/roles/access-model-metadata/bulk-update/ids` | Bulk-Update Roles&#39; Metadata by ID
[**Update-V2024RolesMetadataByQuery**](#update-roles-metadata-by-query) | **POST** `/roles/access-model-metadata/bulk-update/query` | Bulk-Update Roles&#39; Metadata by Query
[**New-V2024Role**](#create-role) | **POST** `/roles` | Create a role
[**Remove-V2024BulkRoles**](#delete-bulk-roles) | **POST** `/roles/bulk-delete` | Delete role(s)
[**Remove-V2024MetadataFromRoleByKeyAndValue**](#delete-metadata-from-role-by-key-and-value) | **DELETE** `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove a metadata from role.
[**Remove-V2024Role**](#delete-role) | **DELETE** `/roles/{id}` | Delete a role
[**Get-V2024BulkUpdateStatus**](#get-bulk-update-status) | **GET** `/roles/access-model-metadata/bulk-update` | Get bulk-update statuses
[**Get-V2024BulkUpdateStatusById**](#get-bulk-update-status-by-id) | **GET** `/roles/access-model-metadata/bulk-update/id` | Get bulk-update status by id
[**Get-V2024Role**](#get-role) | **GET** `/roles/{id}` | Get a role
[**Get-V2024RoleAssignedIdentities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | List identities assigned a role
[**Get-V2024RoleEntitlements**](#get-role-entitlements) | **GET** `/roles/{id}/entitlements` | List role&#39;s entitlements
[**Get-V2024Roles**](#list-roles) | **GET** `/roles` | List roles
[**Update-V2024Role**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified role
[**Search-V2024RolesByFilter**](#search-roles-by-filter) | **POST** `/roles/filter` | Filter roles by metadata
[**Update-V2024AttributeKeyAndValueToRole**](#update-attribute-key-and-value-to-role) | **POST** `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add a metadata to role.
[**Update-V2024RolesMetadataByFilter**](#update-roles-metadata-by-filter) | **POST** `/roles/access-model-metadata/bulk-update/filter` | Bulk-update roles&#39; metadata by filters
[**Update-V2024RolesMetadataByIds**](#update-roles-metadata-by-ids) | **POST** `/roles/access-model-metadata/bulk-update/ids` | Bulk-update roles&#39; metadata by id
[**Update-V2024RolesMetadataByQuery**](#update-roles-metadata-by-query) | **POST** `/roles/access-model-metadata/bulk-update/query` | Bulk-update roles&#39; metadata by query
## create-role
@@ -267,7 +267,7 @@ $Role = @"{
"requestable" : true
}"@
# Create a Role
# Create a role
try {
$Result = ConvertFrom-JsonToRole -Json $Role
@@ -318,7 +318,7 @@ $RoleBulkDeleteRequest = @"{
"roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ]
}"@
# Delete Role(s)
# Delete role(s)
try {
$Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest
@@ -368,7 +368,7 @@ $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The role's id.
$AttributeKey = "iscPrivacy" # String | Technical name of the Attribute.
$AttributeValue = "public" # String | Technical name of the Attribute Value.
# Remove a Metadata From Role.
# Remove a metadata from role.
try {
Remove-V2024MetadataFromRoleByKeyAndValue -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue
@@ -415,7 +415,7 @@ Code | Description | Data Type
```powershell
$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role
# Delete a Role
# Delete a role
try {
Remove-V2024Role -Id $Id
@@ -458,7 +458,7 @@ Code | Description | Data Type
### Example
```powershell
# Get Bulk-Update Statuses
# Get bulk-update statuses
try {
Get-V2024BulkUpdateStatus
@@ -505,7 +505,7 @@ Code | Description | Data Type
```powershell
$Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of the bulk update task.
# Get Bulk-Update Status by ID
# Get bulk-update status by id
try {
Get-V2024BulkUpdateStatusById -Id $Id
@@ -551,7 +551,7 @@ Code | Description | Data Type
```powershell
$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role
# Get a Role
# Get a role
try {
Get-V2024Role -Id $Id
@@ -606,7 +606,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'name sw Joe' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional)
$Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional)
# List Identities assigned a Role
# List identities assigned a role
try {
Get-V2024RoleAssignedIdentities -Id $Id
@@ -666,7 +666,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$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
# List role's entitlements
try {
Get-V2024RoleEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -727,7 +727,7 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de
$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
# List roles
try {
Get-V2024Roles
@@ -799,7 +799,7 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch
}"@ # JsonPatchOperation[] |
# Patch a specified Role
# Patch a specified role
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
@@ -866,7 +866,7 @@ $RoleListFilterDTO = @"{
"filters" : "dimensional eq false"
}"@
# Filter Roles by Metadata
# Filter roles by metadata
try {
Search-V2024RolesByFilter
@@ -915,7 +915,7 @@ $Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of a role
$AttributeKey = "iscPrivacy" # String | Technical name of the Attribute.
$AttributeValue = "public" # String | Technical name of the Attribute Value.
# Add a Metadata to Role.
# Add a metadata to role.
try {
Update-V2024AttributeKeyAndValueToRole -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue
@@ -971,7 +971,7 @@ $RoleMetadataBulkUpdateByFilterRequest = @"{
"operation" : "REPLACE"
}"@
# Bulk-Update Roles' Metadata by Filters
# Bulk-update roles' metadata by filters
try {
$Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByFilterRequest -Json $RoleMetadataBulkUpdateByFilterRequest
@@ -1028,7 +1028,7 @@ $RoleMetadataBulkUpdateByIdRequest = @"{
"operation" : "REPLACE"
}"@
# Bulk-Update Roles' Metadata by ID
# Bulk-update roles' metadata by id
try {
$Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByIdRequest -Json $RoleMetadataBulkUpdateByIdRequest
@@ -1100,7 +1100,7 @@ $RoleMetadataBulkUpdateByQueryRequest = @"{
"operation" : "REPLACE"
}"@
# Bulk-Update Roles' Metadata by Query
# Bulk-update roles' metadata by query
try {
$Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByQueryRequest -Json $RoleMetadataBulkUpdateByQueryRequest

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

@@ -24,13 +24,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024SIMIntegration**](#create-sim-integration) | **POST** `/sim-integrations` | Create new SIM integration
[**Remove-V2024SIMIntegration**](#delete-sim-integration) | **DELETE** `/sim-integrations/{id}` | Delete a SIM integration
[**Get-V2024SIMIntegration**](#get-sim-integration) | **GET** `/sim-integrations/{id}` | Get a SIM integration details.
[**Get-V2024SIMIntegrations**](#get-sim-integrations) | **GET** `/sim-integrations` | List the existing SIM integrations.
[**Update-V2024BeforeProvisioningRule**](#patch-before-provisioning-rule) | **PATCH** `/sim-integrations/{id}/beforeProvisioningRule` | Patch a SIM beforeProvisioningRule attribute.
[**Update-V2024SIMAttributes**](#patch-sim-attributes) | **PATCH** `/sim-integrations/{id}` | Patch a SIM attribute.
[**Send-V2024SIMIntegration**](#put-sim-integration) | **PUT** `/sim-integrations/{id}` | Update an existing SIM integration
[**New-V2024SIMIntegration**](#create-sim-integration) | **POST** `/sim-integrations` | Create new sim integration
[**Remove-V2024SIMIntegration**](#delete-sim-integration) | **DELETE** `/sim-integrations/{id}` | Delete a sim integration
[**Get-V2024SIMIntegration**](#get-sim-integration) | **GET** `/sim-integrations/{id}` | Get a sim integration details.
[**Get-V2024SIMIntegrations**](#get-sim-integrations) | **GET** `/sim-integrations` | List the existing sim integrations.
[**Update-V2024BeforeProvisioningRule**](#patch-before-provisioning-rule) | **PATCH** `/sim-integrations/{id}/beforeProvisioningRule` | Patch a sim beforeprovisioningrule attribute.
[**Update-V2024SIMAttributes**](#patch-sim-attributes) | **PATCH** `/sim-integrations/{id}` | Patch a sim attribute.
[**Send-V2024SIMIntegration**](#put-sim-integration) | **PUT** `/sim-integrations/{id}` | Update an existing sim integration
## create-sim-integration
@@ -87,7 +87,7 @@ $SimIntegrationDetails = @"{
}
}"@
# Create new SIM integration
# Create new sim integration
try {
$Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails
@@ -139,7 +139,7 @@ Code | Description | Data Type
$Id = "12345" # String | The id of the integration to delete.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Delete a SIM integration
# Delete a sim integration
try {
Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -190,7 +190,7 @@ Code | Description | Data Type
$Id = "12345" # String | The id of the integration.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get a SIM integration details.
# Get a sim integration details.
try {
Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -239,7 +239,7 @@ Code | Description | Data Type
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# List the existing SIM integrations.
# List the existing sim integrations.
try {
Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental
@@ -302,7 +302,7 @@ $JsonPatch = @"{
} ]
}"@
# Patch a SIM beforeProvisioningRule attribute.
# Patch a sim beforeprovisioningrule attribute.
try {
$Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch
@@ -366,7 +366,7 @@ $JsonPatch = @"{
} ]
}"@
# Patch a SIM attribute.
# Patch a sim attribute.
try {
$Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch
@@ -437,7 +437,7 @@ $SimIntegrationDetails = @"{
}
}"@
# Update an existing SIM integration
# Update an existing sim integration
try {
$Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails

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

@@ -43,23 +43,23 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024SodPolicy**](#create-sod-policy) | **POST** `/sod-policies` | Create SOD policy
[**Remove-V2024SodPolicy**](#delete-sod-policy) | **DELETE** `/sod-policies/{id}` | Delete SOD policy by ID
[**Remove-V2024SodPolicySchedule**](#delete-sod-policy-schedule) | **DELETE** `/sod-policies/{id}/schedule` | Delete SOD policy schedule
[**New-V2024SodPolicy**](#create-sod-policy) | **POST** `/sod-policies` | Create sod policy
[**Remove-V2024SodPolicy**](#delete-sod-policy) | **DELETE** `/sod-policies/{id}` | Delete sod policy by id
[**Remove-V2024SodPolicySchedule**](#delete-sod-policy-schedule) | **DELETE** `/sod-policies/{id}/schedule` | Delete sod policy schedule
[**Get-V2024CustomViolationReport**](#get-custom-violation-report) | **GET** `/sod-violation-report/{reportResultId}/download/{fileName}` | Download custom violation report
[**Get-V2024DefaultViolationReport**](#get-default-violation-report) | **GET** `/sod-violation-report/{reportResultId}/download` | Download violation report
[**Get-V2024SodAllReportRunStatus**](#get-sod-all-report-run-status) | **GET** `/sod-violation-report` | Get multi-report run task status
[**Get-V2024SodPolicy**](#get-sod-policy) | **GET** `/sod-policies/{id}` | Get SOD policy by ID
[**Get-V2024SodPolicySchedule**](#get-sod-policy-schedule) | **GET** `/sod-policies/{id}/schedule` | Get SOD policy schedule
[**Get-V2024SodPolicy**](#get-sod-policy) | **GET** `/sod-policies/{id}` | Get sod policy by id
[**Get-V2024SodPolicySchedule**](#get-sod-policy-schedule) | **GET** `/sod-policies/{id}/schedule` | Get sod policy schedule
[**Get-V2024SodViolationReportRunStatus**](#get-sod-violation-report-run-status) | **GET** `/sod-policies/sod-violation-report-status/{reportResultId}` | Get violation report run status
[**Get-V2024SodViolationReportStatus**](#get-sod-violation-report-status) | **GET** `/sod-policies/{id}/violation-report` | Get SOD violation report status
[**Get-V2024SodPolicies**](#list-sod-policies) | **GET** `/sod-policies` | List SOD policies
[**Update-V2024SodPolicy**](#patch-sod-policy) | **PATCH** `/sod-policies/{id}` | Patch SOD policy by ID
[**Send-V2024PolicySchedule**](#put-policy-schedule) | **PUT** `/sod-policies/{id}/schedule` | Update SOD Policy schedule
[**Send-V2024SodPolicy**](#put-sod-policy) | **PUT** `/sod-policies/{id}` | Update SOD policy by ID
[**Start-V2024EvaluateSodPolicy**](#start-evaluate-sod-policy) | **POST** `/sod-policies/{id}/evaluate` | Evaluate one policy by ID
[**Get-V2024SodViolationReportStatus**](#get-sod-violation-report-status) | **GET** `/sod-policies/{id}/violation-report` | Get sod violation report status
[**Get-V2024SodPolicies**](#list-sod-policies) | **GET** `/sod-policies` | List sod policies
[**Update-V2024SodPolicy**](#patch-sod-policy) | **PATCH** `/sod-policies/{id}` | Patch sod policy by id
[**Send-V2024PolicySchedule**](#put-policy-schedule) | **PUT** `/sod-policies/{id}/schedule` | Update sod policy schedule
[**Send-V2024SodPolicy**](#put-sod-policy) | **PUT** `/sod-policies/{id}` | Update sod policy by id
[**Start-V2024EvaluateSodPolicy**](#start-evaluate-sod-policy) | **POST** `/sod-policies/{id}/evaluate` | Evaluate one policy by id
[**Start-V2024SodAllPoliciesForOrg**](#start-sod-all-policies-for-org) | **POST** `/sod-violation-report/run` | Runs all policies for org
[**Start-V2024SodPolicy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report
[**Start-V2024SodPolicy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs sod policy violation report
## create-sod-policy
@@ -149,7 +149,7 @@ $SodPolicy = @"{
"externalPolicyReference" : "XYZ policy"
}"@
# Create SOD policy
# Create sod policy
try {
$Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy
@@ -199,7 +199,7 @@ Code | Description | Data Type
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete.
$Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true)
# Delete SOD policy by ID
# Delete sod policy by id
try {
Remove-V2024SodPolicy -Id $Id
@@ -245,7 +245,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for.
# Delete SOD policy schedule
# Delete sod policy schedule
try {
Remove-V2024SodPolicySchedule -Id $Id
@@ -429,7 +429,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve.
# Get SOD policy by ID
# Get sod policy by id
try {
Get-V2024SodPolicy -Id $Id
@@ -474,7 +474,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve.
# Get SOD policy schedule
# Get sod policy schedule
try {
Get-V2024SodPolicySchedule -Id $Id
@@ -566,7 +566,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for.
# Get SOD violation report status
# Get sod violation report status
try {
Get-V2024SodViolationReportStatus -Id $Id
@@ -620,7 +620,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$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
# List sod policies
try {
Get-V2024SodPolicies
@@ -675,7 +675,7 @@ $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy
}"@ # JsonPatchOperation[] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria
# Patch SOD policy by ID
# Patch sod policy by id
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
@@ -808,7 +808,7 @@ $SodPolicySchedule = @"{
"emailEmptyResults" : false
}"@
# Update SOD Policy schedule
# Update sod policy schedule
try {
$Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule
@@ -913,7 +913,7 @@ $SodPolicy = @"{
"externalPolicyReference" : "XYZ policy"
}"@
# Update SOD policy by ID
# Update sod policy by id
try {
$Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy
@@ -959,7 +959,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run.
# Evaluate one policy by ID
# Evaluate one policy by id
try {
Start-V2024EvaluateSodPolicy -Id $Id
@@ -1052,7 +1052,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run.
# Runs SOD policy violation report
# Runs sod policy violation report
try {
Start-V2024SodPolicy -Id $Id

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

@@ -35,8 +35,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Start-V2024PredictSodViolations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict SOD violations for identity.
[**Start-V2024ViolationCheck**](#start-violation-check) | **POST** `/sod-violations/check` | Check SOD violations
[**Start-V2024PredictSodViolations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict sod violations for identity.
[**Start-V2024ViolationCheck**](#start-violation-check) | **POST** `/sod-violations/check` | Check sod violations
## start-predict-sod-violations
@@ -82,7 +82,7 @@ $IdentityWithNewAccess = @"{
} ]
}"@
# Predict SOD violations for identity.
# Predict sod violations for identity.
try {
$Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess
@@ -129,7 +129,7 @@ Code | Description | Data Type
```powershell
$IdentityWithNewAccess1 = @"{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}"@
# Check SOD violations
# Check sod violations
try {
$Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1

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

@@ -23,7 +23,7 @@ Method | HTTP request | Description
[**Get-V2024SpConfigImport**](#get-sp-config-import) | **GET** `/sp-config/import/{id}/download` | Download import job result
[**Get-V2024SpConfigImportStatus**](#get-sp-config-import-status) | **GET** `/sp-config/import/{id}` | Get import job status
[**Import-V2024SpConfig**](#import-sp-config) | **POST** `/sp-config/import` | Initiates configuration objects import job
[**Get-V2024SpConfigObjects**](#list-sp-config-objects) | **GET** `/sp-config/config-objects` | List Config Objects
[**Get-V2024SpConfigObjects**](#list-sp-config-objects) | **GET** `/sp-config/config-objects` | List config objects
## export-sp-config
@@ -360,7 +360,7 @@ Code | Description | Data Type
### Example
```powershell
# List Config Objects
# List config objects
try {
Get-V2024SpConfigObjects

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

@@ -28,10 +28,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024SavedSearch**](#create-saved-search) | **POST** `/saved-searches` | Create a saved search
[**Remove-V2024SavedSearch**](#delete-saved-search) | **DELETE** `/saved-searches/{id}` | Delete document by ID
[**Invoke-V2024ExecuteSavedSearch**](#execute-saved-search) | **POST** `/saved-searches/{id}/execute` | Execute a saved search by ID
[**Get-V2024SavedSearch**](#get-saved-search) | **GET** `/saved-searches/{id}` | Return saved search by ID
[**Get-V2024SavedSearches**](#list-saved-searches) | **GET** `/saved-searches` | A list of Saved Searches
[**Remove-V2024SavedSearch**](#delete-saved-search) | **DELETE** `/saved-searches/{id}` | Delete document by id
[**Invoke-V2024ExecuteSavedSearch**](#execute-saved-search) | **POST** `/saved-searches/{id}/execute` | Execute a saved search by id
[**Get-V2024SavedSearch**](#get-saved-search) | **GET** `/saved-searches/{id}` | Return saved search by id
[**Get-V2024SavedSearches**](#list-saved-searches) | **GET** `/saved-searches` | A list of saved searches
[**Send-V2024SavedSearch**](#put-saved-search) | **PUT** `/saved-searches/{id}` | Updates an existing saved search
@@ -115,7 +115,7 @@ Code | Description | Data Type
```powershell
$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document.
# Delete document by ID
# Delete document by id
try {
Remove-V2024SavedSearch -Id $Id
@@ -174,7 +174,7 @@ $SearchArguments = @"{
"scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8"
}"@
# Execute a saved search by ID
# Execute a saved search by id
try {
$Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments
@@ -222,7 +222,7 @@ Code | Description | Data Type
```powershell
$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document.
# Return saved search by ID
# Return saved search by id
try {
Get-V2024SavedSearch -Id $Id
@@ -274,7 +274,7 @@ $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 = 'owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional)
# A list of Saved Searches
# A list of saved searches
try {
Get-V2024SavedSearches

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

@@ -44,11 +44,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024ScheduledSearch**](#create-scheduled-search) | **POST** `/scheduled-searches` | Create a new scheduled search
[**Remove-V2024ScheduledSearch**](#delete-scheduled-search) | **DELETE** `/scheduled-searches/{id}` | Delete a Scheduled Search
[**Get-V2024ScheduledSearch**](#get-scheduled-search) | **GET** `/scheduled-searches/{id}` | Get a Scheduled Search
[**Remove-V2024ScheduledSearch**](#delete-scheduled-search) | **DELETE** `/scheduled-searches/{id}` | Delete a scheduled search
[**Get-V2024ScheduledSearch**](#get-scheduled-search) | **GET** `/scheduled-searches/{id}` | Get a scheduled search
[**Get-V2024ScheduledSearch**](#list-scheduled-search) | **GET** `/scheduled-searches` | List scheduled searches
[**Invoke-V2024UnsubscribeScheduledSearch**](#unsubscribe-scheduled-search) | **POST** `/scheduled-searches/{id}/unsubscribe` | Unsubscribe a recipient from Scheduled Search
[**Update-V2024ScheduledSearch**](#update-scheduled-search) | **PUT** `/scheduled-searches/{id}` | Update an existing Scheduled Search
[**Invoke-V2024UnsubscribeScheduledSearch**](#unsubscribe-scheduled-search) | **POST** `/scheduled-searches/{id}/unsubscribe` | Unsubscribe a recipient from scheduled search
[**Update-V2024ScheduledSearch**](#update-scheduled-search) | **PUT** `/scheduled-searches/{id}` | Update an existing scheduled search
## create-scheduled-search
@@ -132,7 +132,7 @@ Code | Description | Data Type
```powershell
$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document.
# Delete a Scheduled Search
# Delete a scheduled search
try {
Remove-V2024ScheduledSearch -Id $Id
@@ -178,7 +178,7 @@ Code | Description | Data Type
```powershell
$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document.
# Get a Scheduled Search
# Get a scheduled search
try {
Get-V2024ScheduledSearch -Id $Id
@@ -280,7 +280,7 @@ $TypedReference = @"{
"type" : "IDENTITY"
}"@
# Unsubscribe a recipient from Scheduled Search
# Unsubscribe a recipient from scheduled search
try {
$Result = ConvertFrom-JsonToTypedReference -Json $TypedReference
@@ -420,7 +420,7 @@ $ScheduledSearch = @"{
"emailEmptyResults" : false
}"@
# Update an existing Scheduled Search
# Update an existing scheduled search
try {
$Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch

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

@@ -40,10 +40,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Search-V2024Aggregate**](#search-aggregate) | **POST** `/search/aggregate` | Perform a Search Query Aggregation
[**Search-V2024Count**](#search-count) | **POST** `/search/count` | Count Documents Satisfying a Query
[**Search-V2024Get**](#search-get) | **GET** `/search/{index}/{id}` | Get a Document by ID
[**Search-V2024Post**](#search-post) | **POST** `/search` | Perform Search
[**Search-V2024Aggregate**](#search-aggregate) | **POST** `/search/aggregate` | Perform a search query aggregation
[**Search-V2024Count**](#search-count) | **POST** `/search/count` | Count documents satisfying a query
[**Search-V2024Get**](#search-get) | **GET** `/search/{index}/{id}` | Get a document by id
[**Search-V2024Post**](#search-post) | **POST** `/search` | Perform search
## search-aggregate
@@ -199,7 +199,7 @@ $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)
# Perform a Search Query Aggregation
# Perform a search query aggregation
try {
$Result = ConvertFrom-JsonToSearch -Json $Search
@@ -361,7 +361,7 @@ $Search = @"{
}
}"@
# Count Documents Satisfying a Query
# Count documents satisfying a query
try {
$Result = ConvertFrom-JsonToSearch -Json $Search
@@ -410,7 +410,7 @@ Code | Description | Data Type
$Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*.
$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document.
# Get a Document by ID
# Get a document by id
try {
Search-V2024Get -Index $Index -Id $Id
@@ -577,7 +577,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Limit = 10000 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
# Perform Search
# Perform search
try {
$Result = ConvertFrom-JsonToSearch -Json $Search

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

@@ -35,11 +35,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024SearchAttributeConfig**](#create-search-attribute-config) | **POST** `/accounts/search-attribute-config` | Create Extended Search Attributes
[**Remove-V2024SearchAttributeConfig**](#delete-search-attribute-config) | **DELETE** `/accounts/search-attribute-config/{name}` | Delete Extended Search Attribute
[**Get-V2024SearchAttributeConfig**](#get-search-attribute-config) | **GET** `/accounts/search-attribute-config` | List Extended Search Attributes
[**Get-V2024SingleSearchAttributeConfig**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute
[**Update-V2024SearchAttributeConfig**](#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute
[**New-V2024SearchAttributeConfig**](#create-search-attribute-config) | **POST** `/accounts/search-attribute-config` | Create extended search attributes
[**Remove-V2024SearchAttributeConfig**](#delete-search-attribute-config) | **DELETE** `/accounts/search-attribute-config/{name}` | Delete extended search attribute
[**Get-V2024SearchAttributeConfig**](#get-search-attribute-config) | **GET** `/accounts/search-attribute-config` | List extended search attributes
[**Get-V2024SingleSearchAttributeConfig**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get extended search attribute
[**Update-V2024SearchAttributeConfig**](#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update extended search attribute
## create-search-attribute-config
@@ -87,7 +87,7 @@ $SearchAttributeConfig = @"{
}
}"@
# Create Extended Search Attributes
# Create extended search attributes
try {
$Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig
@@ -138,7 +138,7 @@ Code | Description | Data Type
$Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Delete Extended Search Attribute
# Delete extended search attribute
try {
Remove-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental
@@ -190,7 +190,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
$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 Extended Search Attributes
# List extended search attributes
try {
Get-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental
@@ -241,7 +241,7 @@ Code | Description | Data Type
$Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get Extended Search Attribute
# Get extended search attribute
try {
Get-V2024SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental
@@ -301,7 +301,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
}"@ # JsonPatchOperation[] |
# Update Extended Search Attribute
# Update extended search attribute
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation

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

@@ -34,11 +34,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024Segment**](#create-segment) | **POST** `/segments` | Create Segment
[**Remove-V2024Segment**](#delete-segment) | **DELETE** `/segments/{id}` | Delete Segment by ID
[**Get-V2024Segment**](#get-segment) | **GET** `/segments/{id}` | Get Segment by ID
[**Get-V2024Segments**](#list-segments) | **GET** `/segments` | List Segments
[**Update-V2024Segment**](#patch-segment) | **PATCH** `/segments/{id}` | Update Segment
[**New-V2024Segment**](#create-segment) | **POST** `/segments` | Create segment
[**Remove-V2024Segment**](#delete-segment) | **DELETE** `/segments/{id}` | Delete segment by id
[**Get-V2024Segment**](#get-segment) | **GET** `/segments/{id}` | Get segment by id
[**Get-V2024Segments**](#list-segments) | **GET** `/segments` | List segments
[**Update-V2024Segment**](#patch-segment) | **PATCH** `/segments/{id}` | Update segment
## create-segment
@@ -96,7 +96,7 @@ $Segment = @"{
"id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"
}"@
# Create Segment
# Create segment
try {
$Result = ConvertFrom-JsonToSegment -Json $Segment
@@ -144,7 +144,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete.
# Delete Segment by ID
# Delete segment by id
try {
Remove-V2024Segment -Id $Id
@@ -190,7 +190,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve.
# Get Segment by ID
# Get segment by id
try {
Get-V2024Segment -Id $Id
@@ -239,7 +239,7 @@ $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)
# List Segments
# List segments
try {
Get-V2024Segments
@@ -290,7 +290,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operat
$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
# Update segment
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody

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

@@ -41,15 +41,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024ServiceDeskIntegration**](#create-service-desk-integration) | **POST** `/service-desk-integrations` | Create new Service Desk integration
[**Remove-V2024ServiceDeskIntegration**](#delete-service-desk-integration) | **DELETE** `/service-desk-integrations/{id}` | Delete a Service Desk integration
[**Get-V2024ServiceDeskIntegration**](#get-service-desk-integration) | **GET** `/service-desk-integrations/{id}` | Get a Service Desk integration
[**Get-V2024ServiceDeskIntegrationTemplate**](#get-service-desk-integration-template) | **GET** `/service-desk-integrations/templates/{scriptName}` | Service Desk integration template by scriptName
[**Get-V2024ServiceDeskIntegrationTypes**](#get-service-desk-integration-types) | **GET** `/service-desk-integrations/types` | List Service Desk integration types
[**Get-V2024ServiceDeskIntegrations**](#get-service-desk-integrations) | **GET** `/service-desk-integrations` | List existing Service Desk integrations
[**New-V2024ServiceDeskIntegration**](#create-service-desk-integration) | **POST** `/service-desk-integrations` | Create new service desk integration
[**Remove-V2024ServiceDeskIntegration**](#delete-service-desk-integration) | **DELETE** `/service-desk-integrations/{id}` | Delete a service desk integration
[**Get-V2024ServiceDeskIntegration**](#get-service-desk-integration) | **GET** `/service-desk-integrations/{id}` | Get a service desk integration
[**Get-V2024ServiceDeskIntegrationTemplate**](#get-service-desk-integration-template) | **GET** `/service-desk-integrations/templates/{scriptName}` | Service desk integration template by scriptname
[**Get-V2024ServiceDeskIntegrationTypes**](#get-service-desk-integration-types) | **GET** `/service-desk-integrations/types` | List service desk integration types
[**Get-V2024ServiceDeskIntegrations**](#get-service-desk-integrations) | **GET** `/service-desk-integrations` | List existing service desk integrations
[**Get-V2024StatusCheckDetails**](#get-status-check-details) | **GET** `/service-desk-integrations/status-check-configuration` | Get the time check configuration
[**Update-V2024ServiceDeskIntegration**](#patch-service-desk-integration) | **PATCH** `/service-desk-integrations/{id}` | Patch a Service Desk Integration
[**Send-V2024ServiceDeskIntegration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a Service Desk integration
[**Update-V2024ServiceDeskIntegration**](#patch-service-desk-integration) | **PATCH** `/service-desk-integrations/{id}` | Patch a service desk integration
[**Send-V2024ServiceDeskIntegration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a service desk integration
[**Update-V2024StatusCheckDetails**](#update-status-check-details) | **PUT** `/service-desk-integrations/status-check-configuration` | Update the time check configuration
@@ -118,7 +118,7 @@ $ServiceDeskIntegrationDto = @"{
"beforeProvisioningRule" : ""
}"@
# Create new Service Desk integration
# Create new service desk integration
try {
$Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto
@@ -165,7 +165,7 @@ Code | Description | Data Type
```powershell
$Id = "anId" # String | ID of Service Desk integration to delete
# Delete a Service Desk integration
# Delete a service desk integration
try {
Remove-V2024ServiceDeskIntegration -Id $Id
@@ -211,7 +211,7 @@ Code | Description | Data Type
```powershell
$Id = "anId" # String | ID of the Service Desk integration to get
# Get a Service Desk integration
# Get a service desk integration
try {
Get-V2024ServiceDeskIntegration -Id $Id
@@ -257,7 +257,7 @@ Code | Description | Data Type
```powershell
$ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get
# Service Desk integration template by scriptName
# Service desk integration template by scriptname
try {
Get-V2024ServiceDeskIntegrationTemplate -ScriptName $ScriptName
@@ -301,7 +301,7 @@ Code | Description | Data Type
### Example
```powershell
# List Service Desk integration types
# List service desk integration types
try {
Get-V2024ServiceDeskIntegrationTypes
@@ -355,7 +355,7 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
$Filters = 'name eq "John Doe"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
# List existing Service Desk integrations
# List existing service desk integrations
try {
Get-V2024ServiceDeskIntegrations
@@ -452,7 +452,7 @@ $Id = "anId" # String | ID of the Service Desk integration to update
}"@ # JsonPatchOperation[] | 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.
# Patch a Service Desk Integration
# Patch a service desk integration
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
@@ -534,7 +534,7 @@ $ServiceDeskIntegrationDto = @"{
"beforeProvisioningRule" : ""
}"@
# Update a Service Desk integration
# Update a service desk integration
try {
$Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto

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

@@ -74,56 +74,56 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024ProvisioningPolicy**](#create-provisioning-policy) | **POST** `/sources/{sourceId}/provisioning-policies` | Create Provisioning Policy
[**New-V2024Source**](#create-source) | **POST** `/sources` | Creates a source in IdentityNow.
[**New-V2024SourceSchedule**](#create-source-schedule) | **POST** `/sources/{sourceId}/schedules` | Create Schedule on Source
[**New-V2024SourceSchema**](#create-source-schema) | **POST** `/sources/{sourceId}/schemas` | Create Schema on Source
[**Remove-V2024AccountsAsync**](#delete-accounts-async) | **POST** `/sources/{id}/remove-accounts` | Remove All Accounts in a Source
[**Remove-V2024NativeChangeDetectionConfig**](#delete-native-change-detection-config) | **DELETE** `/sources/{sourceId}/native-change-detection-config` | Delete Native Change Detection Configuration
[**Remove-V2024ProvisioningPolicy**](#delete-provisioning-policy) | **DELETE** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete Provisioning Policy by UsageType
[**Remove-V2024Source**](#delete-source) | **DELETE** `/sources/{id}` | Delete Source by ID
[**Remove-V2024SourceSchedule**](#delete-source-schedule) | **DELETE** `/sources/{sourceId}/schedules/{scheduleType}` | Delete Source Schedule by type.
[**Remove-V2024SourceSchema**](#delete-source-schema) | **DELETE** `/sources/{sourceId}/schemas/{schemaId}` | Delete Source Schema by ID
[**New-V2024ProvisioningPolicy**](#create-provisioning-policy) | **POST** `/sources/{sourceId}/provisioning-policies` | Create provisioning policy
[**New-V2024Source**](#create-source) | **POST** `/sources` | Creates a source in identitynow.
[**New-V2024SourceSchedule**](#create-source-schedule) | **POST** `/sources/{sourceId}/schedules` | Create schedule on source
[**New-V2024SourceSchema**](#create-source-schema) | **POST** `/sources/{sourceId}/schemas` | Create schema on source
[**Remove-V2024AccountsAsync**](#delete-accounts-async) | **POST** `/sources/{id}/remove-accounts` | Remove all accounts in a source
[**Remove-V2024NativeChangeDetectionConfig**](#delete-native-change-detection-config) | **DELETE** `/sources/{sourceId}/native-change-detection-config` | Delete native change detection configuration
[**Remove-V2024ProvisioningPolicy**](#delete-provisioning-policy) | **DELETE** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete provisioning policy by usagetype
[**Remove-V2024Source**](#delete-source) | **DELETE** `/sources/{id}` | Delete source by id
[**Remove-V2024SourceSchedule**](#delete-source-schedule) | **DELETE** `/sources/{sourceId}/schedules/{scheduleType}` | Delete source schedule by type.
[**Remove-V2024SourceSchema**](#delete-source-schema) | **DELETE** `/sources/{sourceId}/schemas/{schemaId}` | Delete source schema by id
[**Get-V2024AccountsSchema**](#get-accounts-schema) | **GET** `/sources/{id}/schemas/accounts` | Downloads source accounts schema template
[**Get-V2024CorrelationConfig**](#get-correlation-config) | **GET** `/sources/{id}/correlation-config` | Get Source Correlation Configuration
[**Get-V2024CorrelationConfig**](#get-correlation-config) | **GET** `/sources/{id}/correlation-config` | Get source correlation configuration
[**Get-V2024EntitlementsSchema**](#get-entitlements-schema) | **GET** `/sources/{id}/schemas/entitlements` | Downloads source entitlements schema template
[**Get-V2024NativeChangeDetectionConfig**](#get-native-change-detection-config) | **GET** `/sources/{sourceId}/native-change-detection-config` | Native Change Detection Configuration
[**Get-V2024ProvisioningPolicy**](#get-provisioning-policy) | **GET** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get Provisioning Policy by UsageType
[**Get-V2024Source**](#get-source) | **GET** `/sources/{id}` | Get Source by ID
[**Get-V2024SourceAttrSyncConfig**](#get-source-attr-sync-config) | **GET** `/sources/{id}/attribute-sync-config` | Attribute Sync Config
[**Get-V2024NativeChangeDetectionConfig**](#get-native-change-detection-config) | **GET** `/sources/{sourceId}/native-change-detection-config` | Native change detection configuration
[**Get-V2024ProvisioningPolicy**](#get-provisioning-policy) | **GET** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get provisioning policy by usagetype
[**Get-V2024Source**](#get-source) | **GET** `/sources/{id}` | Get source by id
[**Get-V2024SourceAttrSyncConfig**](#get-source-attr-sync-config) | **GET** `/sources/{id}/attribute-sync-config` | Attribute sync config
[**Get-V2024SourceConfig**](#get-source-config) | **GET** `/sources/{id}/connectors/source-config` | Gets source config with language-translations
[**Get-V2024SourceConnections**](#get-source-connections) | **GET** `/sources/{sourceId}/connections` | Get Source Connections by ID
[**Get-V2024SourceEntitlementRequestConfig**](#get-source-entitlement-request-config) | **GET** `/sources/{id}/entitlement-request-config` | Get Source Entitlement Request Configuration
[**Get-V2024SourceConnections**](#get-source-connections) | **GET** `/sources/{sourceId}/connections` | Get source connections by id
[**Get-V2024SourceEntitlementRequestConfig**](#get-source-entitlement-request-config) | **GET** `/sources/{id}/entitlement-request-config` | Get source entitlement request configuration
[**Get-V2024SourceHealth**](#get-source-health) | **GET** `/sources/{sourceId}/source-health` | Fetches source health by id
[**Get-V2024SourceSchedule**](#get-source-schedule) | **GET** `/sources/{sourceId}/schedules/{scheduleType}` | Get Source Schedule by Type
[**Get-V2024SourceSchedules**](#get-source-schedules) | **GET** `/sources/{sourceId}/schedules` | List Schedules on Source
[**Get-V2024SourceSchema**](#get-source-schema) | **GET** `/sources/{sourceId}/schemas/{schemaId}` | Get Source Schema by ID
[**Get-V2024SourceSchemas**](#get-source-schemas) | **GET** `/sources/{sourceId}/schemas` | List Schemas on Source
[**Import-V2024Accounts**](#import-accounts) | **POST** `/sources/{id}/load-accounts` | Account Aggregation
[**Get-V2024SourceSchedule**](#get-source-schedule) | **GET** `/sources/{sourceId}/schedules/{scheduleType}` | Get source schedule by type
[**Get-V2024SourceSchedules**](#get-source-schedules) | **GET** `/sources/{sourceId}/schedules` | List schedules on source
[**Get-V2024SourceSchema**](#get-source-schema) | **GET** `/sources/{sourceId}/schemas/{schemaId}` | Get source schema by id
[**Get-V2024SourceSchemas**](#get-source-schemas) | **GET** `/sources/{sourceId}/schemas` | List schemas on source
[**Import-V2024Accounts**](#import-accounts) | **POST** `/sources/{id}/load-accounts` | Account aggregation
[**Import-V2024AccountsSchema**](#import-accounts-schema) | **POST** `/sources/{id}/schemas/accounts` | Uploads source accounts schema template
[**Import-V2024ConnectorFile**](#import-connector-file) | **POST** `/sources/{sourceId}/upload-connector-file` | Upload connector file to source
[**Import-V2024EntitlementsSchema**](#import-entitlements-schema) | **POST** `/sources/{id}/schemas/entitlements` | Uploads source entitlements schema template
[**Import-V2024UncorrelatedAccounts**](#import-uncorrelated-accounts) | **POST** `/sources/{id}/load-uncorrelated-accounts` | Process Uncorrelated Accounts
[**Get-V2024ProvisioningPolicies**](#list-provisioning-policies) | **GET** `/sources/{sourceId}/provisioning-policies` | Lists ProvisioningPolicies
[**Get-V2024Sources**](#list-sources) | **GET** `/sources` | Lists all sources in IdentityNow.
[**Import-V2024UncorrelatedAccounts**](#import-uncorrelated-accounts) | **POST** `/sources/{id}/load-uncorrelated-accounts` | Process uncorrelated accounts
[**Get-V2024ProvisioningPolicies**](#list-provisioning-policies) | **GET** `/sources/{sourceId}/provisioning-policies` | Lists provisioningpolicies
[**Get-V2024Sources**](#list-sources) | **GET** `/sources` | Lists all sources in identitynow.
[**Ping-V2024Cluster**](#ping-cluster) | **POST** `/sources/{sourceId}/connector/ping-cluster` | Ping cluster for source connector
[**Send-V2024CorrelationConfig**](#put-correlation-config) | **PUT** `/sources/{id}/correlation-config` | Update Source Correlation Configuration
[**Send-V2024NativeChangeDetectionConfig**](#put-native-change-detection-config) | **PUT** `/sources/{sourceId}/native-change-detection-config` | Update Native Change Detection Configuration
[**Send-V2024ProvisioningPolicy**](#put-provisioning-policy) | **PUT** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update Provisioning Policy by UsageType
[**Send-V2024Source**](#put-source) | **PUT** `/sources/{id}` | Update Source (Full)
[**Send-V2024SourceAttrSyncConfig**](#put-source-attr-sync-config) | **PUT** `/sources/{id}/attribute-sync-config` | Update Attribute Sync Config
[**Send-V2024SourceSchema**](#put-source-schema) | **PUT** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Full)
[**Send-V2024CorrelationConfig**](#put-correlation-config) | **PUT** `/sources/{id}/correlation-config` | Update source correlation configuration
[**Send-V2024NativeChangeDetectionConfig**](#put-native-change-detection-config) | **PUT** `/sources/{sourceId}/native-change-detection-config` | Update native change detection configuration
[**Send-V2024ProvisioningPolicy**](#put-provisioning-policy) | **PUT** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update provisioning policy by usagetype
[**Send-V2024Source**](#put-source) | **PUT** `/sources/{id}` | Update source (full)
[**Send-V2024SourceAttrSyncConfig**](#put-source-attr-sync-config) | **PUT** `/sources/{id}/attribute-sync-config` | Update attribute sync config
[**Send-V2024SourceSchema**](#put-source-schema) | **PUT** `/sources/{sourceId}/schemas/{schemaId}` | Update source schema (full)
[**Search-V2024ResourceObjects**](#search-resource-objects) | **POST** `/sources/{sourceId}/connector/peek-resource-objects` | Peek source connector&#39;s resource objects
[**Sync-V2024AttributesForSource**](#sync-attributes-for-source) | **POST** `/sources/{id}/synchronize-attributes` | Synchronize single source attributes.
[**Test-V2024SourceConfiguration**](#test-source-configuration) | **POST** `/sources/{sourceId}/connector/test-configuration` | Test configuration for source connector
[**Test-V2024SourceConnection**](#test-source-connection) | **POST** `/sources/{sourceId}/connector/check-connection` | Check connection for source connector.
[**Update-V2024PasswordPolicyHolders**](#update-password-policy-holders) | **PATCH** `/sources/{sourceId}/password-policies` | Update Password Policy
[**Update-V2024ProvisioningPoliciesInBulk**](#update-provisioning-policies-in-bulk) | **POST** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk Update Provisioning Policies
[**Update-V2024ProvisioningPolicy**](#update-provisioning-policy) | **PATCH** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of Provisioning Policy
[**Update-V2024Source**](#update-source) | **PATCH** `/sources/{id}` | Update Source (Partial)
[**Update-V2024SourceEntitlementRequestConfig**](#update-source-entitlement-request-config) | **PUT** `/sources/{id}/entitlement-request-config` | Update Source Entitlement Request Configuration
[**Update-V2024SourceSchedule**](#update-source-schedule) | **PATCH** `/sources/{sourceId}/schedules/{scheduleType}` | Update Source Schedule (Partial)
[**Update-V2024SourceSchema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial)
[**Update-V2024PasswordPolicyHolders**](#update-password-policy-holders) | **PATCH** `/sources/{sourceId}/password-policies` | Update password policy
[**Update-V2024ProvisioningPoliciesInBulk**](#update-provisioning-policies-in-bulk) | **POST** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk update provisioning policies
[**Update-V2024ProvisioningPolicy**](#update-provisioning-policy) | **PATCH** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of provisioning policy
[**Update-V2024Source**](#update-source) | **PATCH** `/sources/{id}` | Update source (partial)
[**Update-V2024SourceEntitlementRequestConfig**](#update-source-entitlement-request-config) | **PUT** `/sources/{id}/entitlement-request-config` | Update source entitlement request configuration
[**Update-V2024SourceSchedule**](#update-source-schedule) | **PATCH** `/sources/{sourceId}/schedules/{scheduleType}` | Update source schedule (partial)
[**Update-V2024SourceSchema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update source schema (partial)
## create-provisioning-policy
@@ -201,7 +201,7 @@ $ProvisioningPolicyDto = @"{
"usageType" : "CREATE"
}"@
# Create Provisioning Policy
# Create provisioning policy
try {
$Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto
@@ -331,7 +331,7 @@ $Source = @"{
}"@
$ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional)
# Creates a source in IdentityNow.
# Creates a source in identitynow.
try {
$Result = ConvertFrom-JsonToSource -Json $Source
@@ -380,7 +380,7 @@ Code | Description | Data Type
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
$Schedule1 = @""@
# Create Schedule on Source
# Create schedule on source
try {
$Result = ConvertFrom-JsonToSchedule1 -Json $Schedule1
@@ -462,7 +462,7 @@ $Schema = @"{
"identityAttribute" : "sAMAccountName"
}"@
# Create Schema on Source
# Create schema on source
try {
$Result = ConvertFrom-JsonToSchema -Json $Schema
@@ -519,7 +519,7 @@ Code | Description | Data Type
$Id = "ebbf35756e1140699ce52b233121384a" # String | The source id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Remove All Accounts in a Source
# Remove all accounts in a source
try {
Remove-V2024AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -570,7 +570,7 @@ Code | Description | Data Type
$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Delete Native Change Detection Configuration
# Delete native change detection configuration
try {
Remove-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -618,7 +618,7 @@ Code | Description | Data Type
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID.
$UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
# Delete Provisioning Policy by UsageType
# Delete provisioning policy by usagetype
try {
Remove-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType
@@ -665,7 +665,7 @@ Code | Description | Data Type
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
# Delete Source by ID
# Delete source by id
try {
Remove-V2024Source -Id $Id
@@ -713,7 +713,7 @@ Code | Description | Data Type
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
$ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type.
# Delete Source Schedule by type.
# Delete source schedule by type.
try {
Remove-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType
@@ -761,7 +761,7 @@ Code | Description | Data Type
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id.
# Delete Source Schema by ID
# Delete source schema by id
try {
Remove-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId
@@ -854,7 +854,7 @@ Code | Description | Data Type
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id
# Get Source Correlation Configuration
# Get source correlation configuration
try {
Get-V2024CorrelationConfig -Id $Id
@@ -955,7 +955,7 @@ Code | Description | Data Type
$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Native Change Detection Configuration
# Native change detection configuration
try {
Get-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -1003,7 +1003,7 @@ Code | Description | Data Type
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID.
$UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
# Get Provisioning Policy by UsageType
# Get provisioning policy by usagetype
try {
Get-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType
@@ -1049,7 +1049,7 @@ Code | Description | Data Type
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
# Get Source by ID
# Get source by id
try {
Get-V2024Source -Id $Id
@@ -1100,7 +1100,7 @@ Code | Description | Data Type
$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Attribute Sync Config
# Attribute sync config
try {
Get-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -1194,7 +1194,7 @@ Code | Description | Data Type
```powershell
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
# Get Source Connections by ID
# Get source connections by id
try {
Get-V2024SourceConnections -SourceId $SourceId
@@ -1246,7 +1246,7 @@ Code | Description | Data Type
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get Source Entitlement Request Configuration
# Get source entitlement request configuration
try {
Get-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental
@@ -1341,7 +1341,7 @@ Code | Description | Data Type
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
$ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type.
# Get Source Schedule by Type
# Get source schedule by type
try {
Get-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType
@@ -1395,7 +1395,7 @@ Code | Description | Data Type
```powershell
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
# List Schedules on Source
# List schedules on source
try {
Get-V2024SourceSchedules -SourceId $SourceId
@@ -1444,7 +1444,7 @@ Code | Description | Data Type
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id.
# Get Source Schema by ID
# Get source schema by id
try {
Get-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId
@@ -1494,7 +1494,7 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
$IncludeTypes = "group" # String | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional)
$IncludeNames = "account" # String | A comma-separated list of schema names to filter result. (optional)
# List Schemas on Source
# List schemas on source
try {
Get-V2024SourceSchemas -SourceId $SourceId
@@ -1550,7 +1550,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
$File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional)
$DisableOptimization = "MyDisableOptimization" # String | Use this flag to reprocess every account whether or not the data has changed. (optional)
# Account Aggregation
# Account aggregation
try {
Import-V2024Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -1757,7 +1757,7 @@ $Id = "75dbec1ebe154d5785da27b95e1dd5d7" # String | Source Id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$File = # System.IO.FileInfo | (optional)
# Process Uncorrelated Accounts
# Process uncorrelated accounts
try {
Import-V2024UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -1803,7 +1803,7 @@ Code | Description | Data Type
```powershell
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id
# Lists ProvisioningPolicies
# Lists provisioningpolicies
try {
Get-V2024ProvisioningPolicies -SourceId $SourceId
@@ -1861,7 +1861,7 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
$ForSubadmin = "name" # String | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional)
$IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the response. (optional) (default to $false)
# Lists all sources in IdentityNow.
# Lists all sources in identitynow.
try {
Get-V2024Sources
@@ -1975,7 +1975,7 @@ $CorrelationConfig = @"{
"id" : "2c9180835d191a86015d28455b4a2329"
}"@
# Update Source Correlation Configuration
# Update source correlation configuration
try {
$Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig
@@ -2036,7 +2036,7 @@ $NativeChangeDetectionConfig = @"{
"enabled" : true
}"@
# Update Native Change Detection Configuration
# Update native change detection configuration
try {
$Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig
@@ -2128,7 +2128,7 @@ $ProvisioningPolicyDto = @"{
"usageType" : "CREATE"
}"@
# Update Provisioning Policy by UsageType
# Update provisioning policy by usagetype
try {
$Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto
@@ -2271,7 +2271,7 @@ $Source = @"{
"since" : "2021-09-28T15:48:29.3801666300Z"
}"@
# Update Source (Full)
# Update source (full)
try {
$Result = ConvertFrom-JsonToSource -Json $Source
@@ -2343,7 +2343,7 @@ $AttrSyncSourceConfig = @"{
}
}"@
# Update Attribute Sync Config
# Update attribute sync config
try {
$Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig
@@ -2437,7 +2437,7 @@ $Schema = @"{
"identityAttribute" : "sAMAccountName"
}"@
# Update Source Schema (Full)
# Update source schema (full)
try {
$Result = ConvertFrom-JsonToSchema -Json $Schema
@@ -2684,7 +2684,7 @@ $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id
$PasswordPolicyHoldersDtoInner = @""@ # PasswordPolicyHoldersDtoInner[] |
# Update Password Policy
# Update password policy
try {
$Result = ConvertFrom-JsonToPasswordPolicyHoldersDtoInner -Json $PasswordPolicyHoldersDtoInner
@@ -2773,7 +2773,7 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
}"@ # ProvisioningPolicyDto[] |
# Bulk Update Provisioning Policies
# Bulk update provisioning policies
try {
$Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto
@@ -2831,7 +2831,7 @@ $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In I
}"@ # JsonPatchOperation[] | The JSONPatch payload used to update the schema.
# Partial update of Provisioning Policy
# Partial update of provisioning policy
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
@@ -2900,7 +2900,7 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
}"@ # JsonPatchOperation[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC).
# Update Source (Partial)
# Update source (partial)
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
@@ -2977,7 +2977,7 @@ $SourceEntitlementRequestConfig = @"{
}
}"@
# Update Source Entitlement Request Configuration
# Update source entitlement request configuration
try {
$Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig
@@ -3038,7 +3038,7 @@ $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type.
}"@ # JsonPatchOperation[] | The JSONPatch payload used to update the schedule.
# Update Source Schedule (Partial)
# Update source schedule (partial)
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
@@ -3123,7 +3123,7 @@ $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id.
}"@ # JsonPatchOperation[] | The JSONPatch payload used to update the schema.
# Update Source Schema (Partial)
# Update source schema (partial)
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation

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

@@ -20,13 +20,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024SedBatchStats**](#get-sed-batch-stats) | **GET** `/suggested-entitlement-description-batches/{batchId}/stats` | Submit Sed Batch Stats Request
[**Get-V2024SedBatches**](#get-sed-batches) | **GET** `/suggested-entitlement-description-batches` | List Sed Batch Request
[**Get-V2024Seds**](#list-seds) | **GET** `/suggested-entitlement-descriptions` | List Suggested Entitlement Descriptions
[**Update-V2024Sed**](#patch-sed) | **PATCH** `/suggested-entitlement-descriptions` | Patch Suggested Entitlement Description
[**Submit-V2024SedApproval**](#submit-sed-approval) | **POST** `/suggested-entitlement-description-approvals` | Submit Bulk Approval Request
[**Submit-V2024SedAssignment**](#submit-sed-assignment) | **POST** `/suggested-entitlement-description-assignments` | Submit Sed Assignment Request
[**Submit-V2024SedBatchRequest**](#submit-sed-batch-request) | **POST** `/suggested-entitlement-description-batches` | Submit Sed Batch Request
[**Get-V2024SedBatchStats**](#get-sed-batch-stats) | **GET** `/suggested-entitlement-description-batches/{batchId}/stats` | Submit sed batch stats request
[**Get-V2024SedBatches**](#get-sed-batches) | **GET** `/suggested-entitlement-description-batches` | List Sed Batch Record
[**Get-V2024Seds**](#list-seds) | **GET** `/suggested-entitlement-descriptions` | List suggested entitlement descriptions
[**Update-V2024Sed**](#patch-sed) | **PATCH** `/suggested-entitlement-descriptions` | Patch suggested entitlement description
[**Submit-V2024SedApproval**](#submit-sed-approval) | **POST** `/suggested-entitlement-description-approvals` | Submit bulk approval request
[**Submit-V2024SedAssignment**](#submit-sed-assignment) | **POST** `/suggested-entitlement-description-assignments` | Submit sed assignment request
[**Submit-V2024SedBatchRequest**](#submit-sed-batch-request) | **POST** `/suggested-entitlement-description-batches` | Submit sed batch request
## get-sed-batch-stats
@@ -65,7 +65,7 @@ Code | Description | Data Type
```powershell
$BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id
# Submit Sed Batch Stats Request
# Submit sed batch stats request
try {
Get-V2024SedBatchStats -BatchId $BatchId
@@ -81,21 +81,26 @@ try {
## get-sed-batches
List Sed Batches.
API responses with Sed Batch Status
API responses with Sed Batch Records
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sed-batches)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Query | Offset | **Int64** | (optional) (default to 0) | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0.
Query | Limit | **Int64** | (optional) (default to 250) | 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.
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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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.
Query | CountOnly | **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. This parameter differs from the `count` parameter in that this one skips executing the actual query and always return an empty array.
Query | Status | **String** | (optional) | Batch Status
### Return type
[**SedBatchStatus**](../models/sed-batch-status)
[**SedBatchRecord[]**](../models/sed-batch-record)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Status of batch | SedBatchStatus
200 | List of Sed Batch Records | SedBatchRecord[]
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn&#39;t have access to this end-point. | ErrorResponseDto
@@ -109,14 +114,19 @@ Code | Description | Data Type
### Example
```powershell
$Offset = 0 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0)
$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)
$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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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. (optional) (default to $false)
$CountOnly = $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. This parameter differs from the `count` parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to $false)
$Status = "completed, failed, submitted, materialized, failed" # String | Batch Status (optional)
# List Sed Batch Request
# List Sed Batch Record
try {
Get-V2024SedBatches
# Below is a request that includes all optional parameters
# Get-V2024SedBatches
# Get-V2024SedBatches -Offset $Offset -Limit $Limit -Count $Count -CountOnly $CountOnly -Status $Status
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatches"
Write-Host $_.ErrorDetails
@@ -184,7 +194,7 @@ $CountOnly = $false # Boolean | If `true` it will populate the `X-Total-Count` r
$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) (default to $false)
$ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) (default to $false)
# List Suggested Entitlement Descriptions
# List suggested entitlement descriptions
try {
Get-V2024Seds
@@ -237,7 +247,7 @@ $Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id
}"@ # SedPatch[] | Sed Patch Request
# Patch Suggested Entitlement Description
# Patch suggested entitlement description
try {
$Result = ConvertFrom-JsonToSedPatch -Json $SedPatch
@@ -288,7 +298,7 @@ Code | Description | Data Type
}"@ # SedApproval[] | Sed Approval
# Submit Bulk Approval Request
# Submit bulk approval request
try {
$Result = ConvertFrom-JsonToSedApproval -Json $SedApproval
@@ -342,7 +352,7 @@ $SedAssignment = @"{
"items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ]
}"@
# Submit Sed Assignment Request
# Submit sed assignment request
try {
$Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment
@@ -390,10 +400,33 @@ Code | Description | Data Type
```powershell
$SedBatchRequest = @"{
"entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ],
"seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ]
"seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ],
"searchCriteria" : {
"key" : {
"indices" : [ "entitlements" ],
"query" : {
"query" : "status:active"
},
"textQuery" : {
"terms" : [ "admin", "user" ],
"matchAny" : true,
"fields" : [ "role", "name" ]
},
"searchAfter" : [ "12345", "67890" ],
"filters" : {
"status" : {
"type" : "TERMS",
"terms" : [ "active", "inactive" ]
}
},
"sort" : [ "name:asc", "createdAt:desc" ],
"queryType" : "TEXT",
"includeNested" : true
}
}
}"@
# Submit Sed Batch Request
# Submit sed batch request
try {
Submit-V2024SedBatchRequest

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

@@ -70,14 +70,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Remove-V2024TaggedObject**](#delete-tagged-object) | **DELETE** `/tagged-objects/{type}/{id}` | Delete Object Tags
[**Remove-V2024TagsToManyObject**](#delete-tags-to-many-object) | **POST** `/tagged-objects/bulk-remove` | Remove Tags from Multiple Objects
[**Get-V2024TaggedObject**](#get-tagged-object) | **GET** `/tagged-objects/{type}/{id}` | Get Tagged Object
[**Get-V2024TaggedObjects**](#list-tagged-objects) | **GET** `/tagged-objects` | List Tagged Objects
[**Get-V2024TaggedObjectsByType**](#list-tagged-objects-by-type) | **GET** `/tagged-objects/{type}` | List Tagged Objects by Type
[**Send-V2024TaggedObject**](#put-tagged-object) | **PUT** `/tagged-objects/{type}/{id}` | Update Tagged Object
[**Set-V2024TagToObject**](#set-tag-to-object) | **POST** `/tagged-objects` | Add Tag to Object
[**Set-V2024TagsToManyObjects**](#set-tags-to-many-objects) | **POST** `/tagged-objects/bulk-add` | Tag Multiple Objects
[**Remove-V2024TaggedObject**](#delete-tagged-object) | **DELETE** `/tagged-objects/{type}/{id}` | Delete object tags
[**Remove-V2024TagsToManyObject**](#delete-tags-to-many-object) | **POST** `/tagged-objects/bulk-remove` | Remove tags from multiple objects
[**Get-V2024TaggedObject**](#get-tagged-object) | **GET** `/tagged-objects/{type}/{id}` | Get tagged object
[**Get-V2024TaggedObjects**](#list-tagged-objects) | **GET** `/tagged-objects` | List tagged objects
[**Get-V2024TaggedObjectsByType**](#list-tagged-objects-by-type) | **GET** `/tagged-objects/{type}` | List tagged objects by type
[**Send-V2024TaggedObject**](#put-tagged-object) | **PUT** `/tagged-objects/{type}/{id}` | Update tagged object
[**Set-V2024TagToObject**](#set-tag-to-object) | **POST** `/tagged-objects` | Add tag to object
[**Set-V2024TagsToManyObjects**](#set-tags-to-many-objects) | **POST** `/tagged-objects/bulk-add` | Tag multiple objects
## delete-tagged-object
@@ -113,7 +113,7 @@ Code | Description | Data Type
$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
# Delete object tags
try {
Remove-V2024TaggedObject -Type $Type -Id $Id
@@ -169,7 +169,7 @@ $BulkRemoveTaggedObject = @"{
"tags" : [ "BU_FINANCE", "PCI" ]
}"@
# Remove Tags from Multiple Objects
# Remove tags from multiple objects
try {
$Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject
@@ -217,7 +217,7 @@ Code | Description | Data Type
$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
# Get tagged object
try {
Get-V2024TaggedObject -Type $Type -Id $Id
@@ -270,7 +270,7 @@ $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 = '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
# List tagged objects
try {
Get-V2024TaggedObjects
@@ -325,7 +325,7 @@ $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 = '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
# List tagged objects by type
try {
Get-V2024TaggedObjectsByType -Type $Type
@@ -381,7 +381,7 @@ $TaggedObject = @"{
"tags" : [ "BU_FINANCE", "PCI" ]
}"@
# Update Tagged Object
# Update tagged object
try {
$Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject
@@ -436,7 +436,7 @@ $TaggedObject = @"{
"tags" : [ "BU_FINANCE", "PCI" ]
}"@
# Add Tag to Object
# Add tag to object
try {
$Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject
@@ -494,7 +494,7 @@ $BulkAddTaggedObject = @"{
"tags" : [ "BU_FINANCE", "PCI" ]
}"@
# Tag Multiple Objects
# Tag multiple objects
try {
$Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject

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

@@ -17,11 +17,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024PendingTaskHeaders**](#get-pending-task-headers) | **HEAD** `/task-status/pending-tasks` | Retrieve Pending Task List Headers
[**Get-V2024PendingTasks**](#get-pending-tasks) | **GET** `/task-status/pending-tasks` | Retrieve Pending Task Status List
[**Get-V2024TaskStatus**](#get-task-status) | **GET** `/task-status/{id}` | Get Task Status by ID
[**Get-V2024TaskStatusList**](#get-task-status-list) | **GET** `/task-status` | Retrieve Task Status List
[**Update-V2024TaskStatus**](#update-task-status) | **PATCH** `/task-status/{id}` | Update Task Status by ID
[**Get-V2024PendingTaskHeaders**](#get-pending-task-headers) | **HEAD** `/task-status/pending-tasks` | Retrieve pending task list headers
[**Get-V2024PendingTasks**](#get-pending-tasks) | **GET** `/task-status/pending-tasks` | Retrieve pending task status list
[**Get-V2024TaskStatus**](#get-task-status) | **GET** `/task-status/{id}` | Get task status by id
[**Get-V2024TaskStatusList**](#get-task-status-list) | **GET** `/task-status` | Retrieve task status list
[**Update-V2024TaskStatus**](#update-task-status) | **PATCH** `/task-status/{id}` | Update task status by id
## get-pending-task-headers
@@ -65,7 +65,7 @@ $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)
# Retrieve Pending Task List Headers
# Retrieve pending task list headers
try {
Get-V2024PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental
@@ -120,7 +120,7 @@ $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)
# Retrieve Pending Task Status List
# Retrieve pending task status list
try {
Get-V2024PendingTasks -XSailPointExperimental $XSailPointExperimental
@@ -171,7 +171,7 @@ Code | Description | Data Type
$Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get Task Status by ID
# Get task status by id
try {
Get-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -231,7 +231,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$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
# Retrieve task status list
try {
Get-V2024TaskStatusList -XSailPointExperimental $XSailPointExperimental
@@ -289,7 +289,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
}"@ # JsonPatchOperation[] | The JSONPatch payload used to update the object.
# Update Task Status by ID
# Update task status by id
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation

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

@@ -17,7 +17,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024Tenant**](#get-tenant) | **GET** `/tenant` | Get Tenant Information.
[**Get-V2024Tenant**](#get-tenant) | **GET** `/tenant` | Get tenant information.
## get-tenant
@@ -50,7 +50,7 @@ Code | Description | Data Type
### Example
```powershell
# Get Tenant Information.
# Get tenant information.
try {
Get-V2024Tenant

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

@@ -24,7 +24,7 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024Transform**](#create-transform) | **POST** `/transforms` | Create transform
[**Remove-V2024Transform**](#delete-transform) | **DELETE** `/transforms/{id}` | Delete a transform
[**Get-V2024Transform**](#get-transform) | **GET** `/transforms/{id}` | Transform by ID
[**Get-V2024Transform**](#get-transform) | **GET** `/transforms/{id}` | Transform by id
[**Get-V2024Transforms**](#list-transforms) | **GET** `/transforms` | List transforms
[**Update-V2024Transform**](#update-transform) | **PUT** `/transforms/{id}` | Update a transform
@@ -174,7 +174,7 @@ Code | Description | Data Type
```powershell
$Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve
# Transform by ID
# Transform by id
try {
Get-V2024Transform -Id $Id

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

@@ -58,16 +58,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Complete-V2024TriggerInvocation**](#complete-trigger-invocation) | **POST** `/trigger-invocations/{id}/complete` | Complete Trigger Invocation
[**New-V2024Subscription**](#create-subscription) | **POST** `/trigger-subscriptions` | Create a Subscription
[**Remove-V2024Subscription**](#delete-subscription) | **DELETE** `/trigger-subscriptions/{id}` | Delete a Subscription
[**Get-V2024Subscriptions**](#list-subscriptions) | **GET** `/trigger-subscriptions` | List Subscriptions
[**Get-V2024TriggerInvocationStatus**](#list-trigger-invocation-status) | **GET** `/trigger-invocations/status` | List Latest Invocation Statuses
[**Get-V2024Triggers**](#list-triggers) | **GET** `/triggers` | List Triggers
[**Update-V2024Subscription**](#patch-subscription) | **PATCH** `/trigger-subscriptions/{id}` | Patch a Subscription
[**Start-V2024TestTriggerInvocation**](#start-test-trigger-invocation) | **POST** `/trigger-invocations/test` | Start a Test Invocation
[**Test-V2024SubscriptionFilter**](#test-subscription-filter) | **POST** `/trigger-subscriptions/validate-filter` | Validate a Subscription Filter
[**Update-V2024Subscription**](#update-subscription) | **PUT** `/trigger-subscriptions/{id}` | Update a Subscription
[**Complete-V2024TriggerInvocation**](#complete-trigger-invocation) | **POST** `/trigger-invocations/{id}/complete` | Complete trigger invocation
[**New-V2024Subscription**](#create-subscription) | **POST** `/trigger-subscriptions` | Create a subscription
[**Remove-V2024Subscription**](#delete-subscription) | **DELETE** `/trigger-subscriptions/{id}` | Delete a subscription
[**Get-V2024Subscriptions**](#list-subscriptions) | **GET** `/trigger-subscriptions` | List subscriptions
[**Get-V2024TriggerInvocationStatus**](#list-trigger-invocation-status) | **GET** `/trigger-invocations/status` | List latest invocation statuses
[**Get-V2024Triggers**](#list-triggers) | **GET** `/triggers` | List triggers
[**Update-V2024Subscription**](#patch-subscription) | **PATCH** `/trigger-subscriptions/{id}` | Patch a subscription
[**Start-V2024TestTriggerInvocation**](#start-test-trigger-invocation) | **POST** `/trigger-invocations/test` | Start a test invocation
[**Test-V2024SubscriptionFilter**](#test-subscription-filter) | **POST** `/trigger-subscriptions/validate-filter` | Validate a subscription filter
[**Update-V2024Subscription**](#update-subscription) | **PUT** `/trigger-subscriptions/{id}` | Update a subscription
## complete-trigger-invocation
@@ -114,7 +114,7 @@ $CompleteInvocation = @"{
"error" : "Access request is denied."
}"@
# Complete Trigger Invocation
# Complete trigger invocation
try {
$Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation
@@ -191,7 +191,7 @@ $SubscriptionPostRequest = @"{
"enabled" : true
}"@
# Create a Subscription
# Create a subscription
try {
$Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest
@@ -243,7 +243,7 @@ Code | Description | Data Type
$Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Delete a Subscription
# Delete a subscription
try {
Remove-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -301,7 +301,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$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
# List subscriptions
try {
Get-V2024Subscriptions -XSailPointExperimental $XSailPointExperimental
@@ -361,7 +361,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$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
# List latest invocation statuses
try {
Get-V2024TriggerInvocationStatus -XSailPointExperimental $XSailPointExperimental
@@ -419,7 +419,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$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
# List triggers
try {
Get-V2024Triggers -XSailPointExperimental $XSailPointExperimental
@@ -475,7 +475,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
$SubscriptionPatchRequestInner = @""@ # SubscriptionPatchRequestInner[] |
# Patch a Subscription
# Patch a subscription
try {
$Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner
@@ -536,7 +536,7 @@ $TestInvocation = @"{
}
}"@
# Start a Test Invocation
# Start a test invocation
try {
$Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation
@@ -593,7 +593,7 @@ $ValidateFilterInputDto = @"{
}
}"@
# Validate a Subscription Filter
# Validate a subscription filter
try {
$Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto
@@ -679,7 +679,7 @@ $SubscriptionPutRequest = @"{
"enabled" : true
}"@
# Update a Subscription
# Update a subscription
try {
$Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest

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

@@ -18,8 +18,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024TenantUiMetadata**](#get-tenant-ui-metadata) | **GET** `/ui-metadata/tenant` | Get a tenant UI metadata
[**Set-V2024TenantUiMetadata**](#set-tenant-ui-metadata) | **PUT** `/ui-metadata/tenant` | Update tenant UI metadata
[**Get-V2024TenantUiMetadata**](#get-tenant-ui-metadata) | **GET** `/ui-metadata/tenant` | Get a tenant ui metadata
[**Set-V2024TenantUiMetadata**](#set-tenant-ui-metadata) | **PUT** `/ui-metadata/tenant` | Update tenant ui metadata
## get-tenant-ui-metadata
@@ -57,7 +57,7 @@ Code | Description | Data Type
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get a tenant UI metadata
# Get a tenant ui metadata
try {
Get-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental
@@ -112,7 +112,7 @@ $TenantUiMetadataItemUpdateRequest = @"{
"iframeWhiteList" : "http://example.com http://example2.com"
}"@
# Update tenant UI metadata
# Update tenant ui metadata
try {
$Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest

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

@@ -21,9 +21,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024VendorConnectorMapping**](#create-vendor-connector-mapping) | **POST** `/vendor-connector-mappings` | Create Vendor Connector Mapping
[**Remove-V2024VendorConnectorMapping**](#delete-vendor-connector-mapping) | **DELETE** `/vendor-connector-mappings` | Delete Vendor Connector Mapping
[**Get-V2024VendorConnectorMappings**](#get-vendor-connector-mappings) | **GET** `/vendor-connector-mappings` | List Vendor Connector Mappings
[**New-V2024VendorConnectorMapping**](#create-vendor-connector-mapping) | **POST** `/vendor-connector-mappings` | Create vendor connector mapping
[**Remove-V2024VendorConnectorMapping**](#delete-vendor-connector-mapping) | **DELETE** `/vendor-connector-mappings` | Delete vendor connector mapping
[**Get-V2024VendorConnectorMappings**](#get-vendor-connector-mappings) | **GET** `/vendor-connector-mappings` | List vendor connector mappings
## create-vendor-connector-mapping
@@ -81,7 +81,7 @@ $VendorConnectorMapping = @"{
}
}"@
# Create Vendor Connector Mapping
# Create vendor connector mapping
try {
$Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping
@@ -151,7 +151,7 @@ $VendorConnectorMapping = @"{
}
}"@
# Delete Vendor Connector Mapping
# Delete vendor connector mapping
try {
$Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping
@@ -197,7 +197,7 @@ Code | Description | Data Type
### Example
```powershell
# List Vendor Connector Mappings
# List vendor connector mappings
try {
Get-V2024VendorConnectorMappings

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

@@ -31,19 +31,19 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Approve-V2024ApprovalItem**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item
[**Approve-V2024ApprovalItemsInBulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items
[**Complete-V2024WorkItem**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a Work Item
[**Invoke-V2024ForwardWorkItem**](#forward-work-item) | **POST** `/work-items/{id}/forward` | Forward a Work Item
[**Get-V2024CompletedWorkItems**](#get-completed-work-items) | **GET** `/work-items/completed` | Completed Work Items
[**Get-V2024CountCompletedWorkItems**](#get-count-completed-work-items) | **GET** `/work-items/completed/count` | Count Completed Work Items
[**Get-V2024CountWorkItems**](#get-count-work-items) | **GET** `/work-items/count` | Count Work Items
[**Get-V2024WorkItem**](#get-work-item) | **GET** `/work-items/{id}` | Get a Work Item
[**Get-V2024WorkItemsSummary**](#get-work-items-summary) | **GET** `/work-items/summary` | Work Items Summary
[**Get-V2024WorkItems**](#list-work-items) | **GET** `/work-items` | List Work Items
[**Deny-V2024ApprovalItem**](#reject-approval-item) | **POST** `/work-items/{id}/reject/{approvalItemId}` | Reject an Approval Item
[**Deny-V2024ApprovalItemsInBulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items
[**Submit-V2024AccountSelection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit Account Selections
[**Approve-V2024ApprovalItem**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an approval item
[**Approve-V2024ApprovalItemsInBulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve approval items
[**Complete-V2024WorkItem**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a work item
[**Invoke-V2024ForwardWorkItem**](#forward-work-item) | **POST** `/work-items/{id}/forward` | Forward a work item
[**Get-V2024CompletedWorkItems**](#get-completed-work-items) | **GET** `/work-items/completed` | Completed work items
[**Get-V2024CountCompletedWorkItems**](#get-count-completed-work-items) | **GET** `/work-items/completed/count` | Count completed work items
[**Get-V2024CountWorkItems**](#get-count-work-items) | **GET** `/work-items/count` | Count work items
[**Get-V2024WorkItem**](#get-work-item) | **GET** `/work-items/{id}` | Get a work item
[**Get-V2024WorkItemsSummary**](#get-work-items-summary) | **GET** `/work-items/summary` | Work items summary
[**Get-V2024WorkItems**](#list-work-items) | **GET** `/work-items` | List work items
[**Deny-V2024ApprovalItem**](#reject-approval-item) | **POST** `/work-items/{id}/reject/{approvalItemId}` | Reject an approval item
[**Deny-V2024ApprovalItemsInBulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject approval items
[**Submit-V2024AccountSelection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit account selections
## approve-approval-item
@@ -80,7 +80,7 @@ Code | Description | Data Type
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item.
# Approve an Approval Item
# Approve an approval item
try {
Approve-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId
@@ -126,7 +126,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
# Bulk approve Approval Items
# Bulk approve approval items
try {
Approve-V2024ApprovalItemsInBulk -Id $Id
@@ -174,7 +174,7 @@ Code | Description | Data Type
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$Body = "MyBody" # String | Body is the request payload to create form definition request (optional)
# Complete a Work Item
# Complete a work item
try {
Complete-V2024WorkItem -Id $Id
@@ -230,7 +230,7 @@ $WorkItemForward = @"{
"sendNotifications" : true
}"@
# Forward a Work Item
# Forward a work item
try {
$Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward
@@ -282,7 +282,7 @@ $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)
# Completed Work Items
# Completed work items
try {
Get-V2024CompletedWorkItems
@@ -330,7 +330,7 @@ Code | Description | Data Type
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional)
# Count Completed Work Items
# Count completed work items
try {
Get-V2024CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental
@@ -375,7 +375,7 @@ Code | Description | Data Type
```powershell
$OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional)
# Count Work Items
# Count work items
try {
Get-V2024CountWorkItems
@@ -420,7 +420,7 @@ Code | Description | Data Type
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item.
# Get a Work Item
# Get a work item
try {
Get-V2024WorkItem -Id $Id
@@ -465,7 +465,7 @@ Code | Description | Data Type
```powershell
$OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional)
# Work Items Summary
# Work items summary
try {
Get-V2024WorkItemsSummary
@@ -516,7 +516,7 @@ $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)
$OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional)
# List Work Items
# List work items
try {
Get-V2024WorkItems
@@ -564,7 +564,7 @@ Code | Description | Data Type
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item.
# Reject an Approval Item
# Reject an approval item
try {
Deny-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId
@@ -610,7 +610,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
# Bulk reject Approval Items
# Bulk reject approval items
try {
Deny-V2024ApprovalItemsInBulk -Id $Id
@@ -658,7 +658,7 @@ Code | Description | Data Type
$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
# Submit account selections
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody

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

@@ -27,15 +27,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024ReassignmentConfiguration**](#create-reassignment-configuration) | **POST** `/reassignment-configurations` | Create a Reassignment Configuration
[**Remove-V2024ReassignmentConfiguration**](#delete-reassignment-configuration) | **DELETE** `/reassignment-configurations/{identityId}/{configType}` | Delete Reassignment Configuration
[**Get-V2024EvaluateReassignmentConfiguration**](#get-evaluate-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}/evaluate/{configType}` | Evaluate Reassignment Configuration
[**Get-V2024ReassignmentConfigTypes**](#get-reassignment-config-types) | **GET** `/reassignment-configurations/types` | List Reassignment Config Types
[**Get-V2024ReassignmentConfiguration**](#get-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}` | Get Reassignment Configuration
[**Get-V2024TenantConfigConfiguration**](#get-tenant-config-configuration) | **GET** `/reassignment-configurations/tenant-config` | Get Tenant-wide Reassignment Configuration settings
[**Get-V2024ReassignmentConfigurations**](#list-reassignment-configurations) | **GET** `/reassignment-configurations` | List Reassignment Configurations
[**Send-V2024ReassignmentConfig**](#put-reassignment-config) | **PUT** `/reassignment-configurations/{identityId}` | Update Reassignment Configuration
[**Send-V2024TenantConfiguration**](#put-tenant-configuration) | **PUT** `/reassignment-configurations/tenant-config` | Update Tenant-wide Reassignment Configuration settings
[**New-V2024ReassignmentConfiguration**](#create-reassignment-configuration) | **POST** `/reassignment-configurations` | Create a reassignment configuration
[**Remove-V2024ReassignmentConfiguration**](#delete-reassignment-configuration) | **DELETE** `/reassignment-configurations/{identityId}/{configType}` | Delete reassignment configuration
[**Get-V2024EvaluateReassignmentConfiguration**](#get-evaluate-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}/evaluate/{configType}` | Evaluate reassignment configuration
[**Get-V2024ReassignmentConfigTypes**](#get-reassignment-config-types) | **GET** `/reassignment-configurations/types` | List reassignment config types
[**Get-V2024ReassignmentConfiguration**](#get-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}` | Get reassignment configuration
[**Get-V2024TenantConfigConfiguration**](#get-tenant-config-configuration) | **GET** `/reassignment-configurations/tenant-config` | Get tenant-wide reassignment configuration settings
[**Get-V2024ReassignmentConfigurations**](#list-reassignment-configurations) | **GET** `/reassignment-configurations` | List reassignment configurations
[**Send-V2024ReassignmentConfig**](#put-reassignment-config) | **PUT** `/reassignment-configurations/{identityId}` | Update reassignment configuration
[**Send-V2024TenantConfiguration**](#put-tenant-configuration) | **PUT** `/reassignment-configurations/tenant-config` | Update tenant-wide reassignment configuration settings
## create-reassignment-configuration
@@ -80,7 +80,7 @@ $ConfigurationItemRequest = @"{
"startDate" : "2022-07-21T11:13:12.345Z"
}"@
# Create a Reassignment Configuration
# Create a reassignment configuration
try {
$Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest
@@ -133,7 +133,7 @@ $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id
$ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Delete Reassignment Configuration
# Delete reassignment configuration
try {
Remove-V2024ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental
@@ -189,7 +189,7 @@ $ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that dis
$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
# Evaluate reassignment configuration
try {
Get-V2024EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental
@@ -237,7 +237,7 @@ Code | Description | Data Type
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# List Reassignment Config Types
# List reassignment config types
try {
Get-V2024ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental
@@ -288,7 +288,7 @@ Code | Description | Data Type
$IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get Reassignment Configuration
# Get reassignment configuration
try {
Get-V2024ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental
@@ -337,7 +337,7 @@ Code | Description | Data Type
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get Tenant-wide Reassignment Configuration settings
# Get tenant-wide reassignment configuration settings
try {
Get-V2024TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental
@@ -386,7 +386,7 @@ Code | Description | Data Type
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# List Reassignment Configurations
# List reassignment configurations
try {
Get-V2024ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental
@@ -444,7 +444,7 @@ $ConfigurationItemRequest = @"{
"startDate" : "2022-07-21T11:13:12.345Z"
}"@
# Update Reassignment Configuration
# Update reassignment configuration
try {
$Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest
@@ -499,7 +499,7 @@ $TenantConfigurationRequest = @"{
}
}"@
# Update Tenant-wide Reassignment Configuration settings
# Update tenant-wide reassignment configuration settings
try {
$Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest

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

@@ -18,24 +18,24 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Suspend-V2024WorkflowExecution**](#cancel-workflow-execution) | **POST** `/workflow-executions/{id}/cancel` | Cancel Workflow Execution by ID
[**New-V2024ExternalExecuteWorkflow**](#create-external-execute-workflow) | **POST** `/workflows/execute/external/{id}` | Execute Workflow via External Trigger
[**New-V2024Workflow**](#create-workflow) | **POST** `/workflows` | Create Workflow
[**New-V2024WorkflowExternalTrigger**](#create-workflow-external-trigger) | **POST** `/workflows/{id}/external/oauth-clients` | Generate External Trigger OAuth Client
[**Remove-V2024Workflow**](#delete-workflow) | **DELETE** `/workflows/{id}` | Delete Workflow By Id
[**Get-V2024Workflow**](#get-workflow) | **GET** `/workflows/{id}` | Get Workflow By Id
[**Get-V2024WorkflowExecution**](#get-workflow-execution) | **GET** `/workflow-executions/{id}` | Get Workflow Execution
[**Get-V2024WorkflowExecutionHistory**](#get-workflow-execution-history) | **GET** `/workflow-executions/{id}/history` | Get Workflow Execution History
[**Get-V2024WorkflowExecutions**](#get-workflow-executions) | **GET** `/workflows/{id}/executions` | List Workflow Executions
[**Get-V2024CompleteWorkflowLibrary**](#list-complete-workflow-library) | **GET** `/workflow-library` | List Complete Workflow Library
[**Get-V2024WorkflowLibraryActions**](#list-workflow-library-actions) | **GET** `/workflow-library/actions` | List Workflow Library Actions
[**Get-V2024WorkflowLibraryOperators**](#list-workflow-library-operators) | **GET** `/workflow-library/operators` | List Workflow Library Operators
[**Get-V2024WorkflowLibraryTriggers**](#list-workflow-library-triggers) | **GET** `/workflow-library/triggers` | List Workflow Library Triggers
[**Get-V2024Workflows**](#list-workflows) | **GET** `/workflows` | List Workflows
[**Update-V2024Workflow**](#patch-workflow) | **PATCH** `/workflows/{id}` | Patch Workflow
[**Send-V2024Workflow**](#put-workflow) | **PUT** `/workflows/{id}` | Update Workflow
[**Test-V2024ExternalExecuteWorkflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger
[**Test-V2024Workflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test Workflow By Id
[**Suspend-V2024WorkflowExecution**](#cancel-workflow-execution) | **POST** `/workflow-executions/{id}/cancel` | Cancel workflow execution by id
[**New-V2024ExternalExecuteWorkflow**](#create-external-execute-workflow) | **POST** `/workflows/execute/external/{id}` | Execute workflow via external trigger
[**New-V2024Workflow**](#create-workflow) | **POST** `/workflows` | Create workflow
[**New-V2024WorkflowExternalTrigger**](#create-workflow-external-trigger) | **POST** `/workflows/{id}/external/oauth-clients` | Generate external trigger oauth client
[**Remove-V2024Workflow**](#delete-workflow) | **DELETE** `/workflows/{id}` | Delete workflow by id
[**Get-V2024Workflow**](#get-workflow) | **GET** `/workflows/{id}` | Get workflow by id
[**Get-V2024WorkflowExecution**](#get-workflow-execution) | **GET** `/workflow-executions/{id}` | Get workflow execution
[**Get-V2024WorkflowExecutionHistory**](#get-workflow-execution-history) | **GET** `/workflow-executions/{id}/history` | Get workflow execution history
[**Get-V2024WorkflowExecutions**](#get-workflow-executions) | **GET** `/workflows/{id}/executions` | List workflow executions
[**Get-V2024CompleteWorkflowLibrary**](#list-complete-workflow-library) | **GET** `/workflow-library` | List complete workflow library
[**Get-V2024WorkflowLibraryActions**](#list-workflow-library-actions) | **GET** `/workflow-library/actions` | List workflow library actions
[**Get-V2024WorkflowLibraryOperators**](#list-workflow-library-operators) | **GET** `/workflow-library/operators` | List workflow library operators
[**Get-V2024WorkflowLibraryTriggers**](#list-workflow-library-triggers) | **GET** `/workflow-library/triggers` | List workflow library triggers
[**Get-V2024Workflows**](#list-workflows) | **GET** `/workflows` | List workflows
[**Update-V2024Workflow**](#patch-workflow) | **PATCH** `/workflows/{id}` | Patch workflow
[**Send-V2024Workflow**](#put-workflow) | **PUT** `/workflows/{id}` | Update workflow
[**Test-V2024ExternalExecuteWorkflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test workflow via external trigger
[**Test-V2024Workflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test workflow by id
## cancel-workflow-execution
@@ -70,7 +70,7 @@ Code | Description | Data Type
```powershell
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID
# Cancel Workflow Execution by ID
# Cancel workflow execution by id
try {
Suspend-V2024WorkflowExecution -Id $Id
@@ -117,7 +117,7 @@ Code | Description | Data Type
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
$CreateExternalExecuteWorkflowRequest = @""@
# Execute Workflow via External Trigger
# Execute workflow via external trigger
try {
New-V2024ExternalExecuteWorkflow -Id $Id
@@ -162,7 +162,7 @@ Code | Description | Data Type
```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
# Create workflow
try {
$Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest
@@ -208,7 +208,7 @@ Code | Description | Data Type
```powershell
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
# Generate External Trigger OAuth Client
# Generate external trigger oauth client
try {
New-V2024WorkflowExternalTrigger -Id $Id
@@ -253,7 +253,7 @@ Code | Description | Data Type
```powershell
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow
# Delete Workflow By Id
# Delete workflow by id
try {
Remove-V2024Workflow -Id $Id
@@ -298,7 +298,7 @@ Code | Description | Data Type
```powershell
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
# Get Workflow By Id
# Get workflow by id
try {
Get-V2024Workflow -Id $Id
@@ -344,7 +344,7 @@ Code | Description | Data Type
```powershell
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID.
# Get Workflow Execution
# Get workflow execution
try {
Get-V2024WorkflowExecution -Id $Id
@@ -390,7 +390,7 @@ Code | Description | Data Type
```powershell
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution
# Get Workflow Execution History
# Get workflow execution history
try {
Get-V2024WorkflowExecutionHistory -Id $Id
@@ -454,7 +454,7 @@ $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 = 'status eq "Failed"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional)
# List Workflow Executions
# List workflow executions
try {
Get-V2024WorkflowExecutions -Id $Id
@@ -501,7 +501,7 @@ 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)
# List Complete Workflow Library
# List complete workflow library
try {
Get-V2024CompleteWorkflowLibrary
@@ -550,7 +550,7 @@ $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)
$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
# List workflow library actions
try {
Get-V2024WorkflowLibraryActions
@@ -593,7 +593,7 @@ Code | Description | Data Type
### Example
```powershell
# List Workflow Library Operators
# List workflow library operators
try {
Get-V2024WorkflowLibraryOperators
@@ -642,7 +642,7 @@ $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)
$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
# List workflow library triggers
try {
Get-V2024WorkflowLibraryTriggers
@@ -685,7 +685,7 @@ Code | Description | Data Type
### Example
```powershell
# List Workflows
# List workflows
try {
Get-V2024Workflows
@@ -737,7 +737,7 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow
}"@ # JsonPatchOperation[] |
# Patch Workflow
# Patch workflow
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
@@ -824,7 +824,7 @@ $WorkflowBody = @"{
"enabled" : false
}"@
# Update Workflow
# Update workflow
try {
$Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody
@@ -872,7 +872,7 @@ Code | Description | Data Type
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
$TestExternalExecuteWorkflowRequest = @""@
# Test Workflow via External Trigger
# Test workflow via external trigger
try {
Test-V2024ExternalExecuteWorkflow -Id $Id
@@ -930,7 +930,7 @@ Code | Description | Data Type
$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
# Test workflow by id
try {
$Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest

49
docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteria.md Normal file
View File

@@ -0,0 +1,49 @@
---
id: v2024-search-criteria
title: SearchCriteria
pagination_label: SearchCriteria
sidebar_label: SearchCriteria
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteria', 'V2024SearchCriteria']
slug: /tools/sdk/powershell/v2024/models/search-criteria
tags: ['SDK', 'Software Development Kit', 'SearchCriteria', 'V2024SearchCriteria']
---
# SearchCriteria
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Indices** | **[]String** | A list of indices to search within. Must contain exactly one item, typically ""entitlements"". | [required]
**Filters** | [**map[string]SearchCriteriaFiltersValue**](search-criteria-filters-value) | A map of filters applied to the search. Keys are filter names, and values are filter definitions. | [optional]
**Query** | [**SearchCriteriaQuery**](search-criteria-query) | | [optional]
**QueryType** | **String** | Specifies the type of query. Must be ""TEXT"" if `textQuery` is used. | [optional]
**TextQuery** | [**SearchCriteriaTextQuery**](search-criteria-text-query) | | [optional]
**IncludeNested** | **Boolean** | Whether to include nested objects in the search results. | [optional] [default to $false]
**Sort** | **[]String** | Specifies the sorting order for the results. | [optional]
**SearchAfter** | **[]String** | Used for pagination to fetch results after a specific point. | [optional]
## Examples
- Prepare the resource
```powershell
$SearchCriteria = Initialize-V2024SearchCriteria -Indices [entitlements] `
-Filters {status={type=TERMS, terms=[active, inactive]}} `
-Query null `
-QueryType TEXT `
-TextQuery null `
-IncludeNested true `
-Sort [name:asc, createdAt:desc] `
-SearchAfter [12345, 67890]
```
- Convert the resource to JSON
```powershell
$SearchCriteria | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaFiltersValue.md Normal file
View File

@@ -0,0 +1,39 @@
---
id: v2024-search-criteria-filters-value
title: SearchCriteriaFiltersValue
pagination_label: SearchCriteriaFiltersValue
sidebar_label: SearchCriteriaFiltersValue
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaFiltersValue', 'V2024SearchCriteriaFiltersValue']
slug: /tools/sdk/powershell/v2024/models/search-criteria-filters-value
tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValue', 'V2024SearchCriteriaFiltersValue']
---
# SearchCriteriaFiltersValue
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **String** | The type of filter, e.g., ""TERMS"" or ""RANGE"". | [optional]
**Terms** | **[]String** | Terms to filter by (for ""TERMS"" type). | [optional]
**Range** | [**SearchCriteriaFiltersValueRange**](search-criteria-filters-value-range) | | [optional]
## Examples
- Prepare the resource
```powershell
$SearchCriteriaFiltersValue = Initialize-V2024SearchCriteriaFiltersValue -Type TERMS `
-Terms [active, inactive] `
-Range null
```
- Convert the resource to JSON
```powershell
$SearchCriteriaFiltersValue | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaFiltersValueRange.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: v2024-search-criteria-filters-value-range
title: SearchCriteriaFiltersValueRange
pagination_label: SearchCriteriaFiltersValueRange
sidebar_label: SearchCriteriaFiltersValueRange
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaFiltersValueRange', 'V2024SearchCriteriaFiltersValueRange']
slug: /tools/sdk/powershell/v2024/models/search-criteria-filters-value-range
tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRange', 'V2024SearchCriteriaFiltersValueRange']
---
# SearchCriteriaFiltersValueRange
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Lower** | [**SearchCriteriaFiltersValueRangeLower**](search-criteria-filters-value-range-lower) | | [optional]
**Upper** | [**SearchCriteriaFiltersValueRangeUpper**](search-criteria-filters-value-range-upper) | | [optional]
## Examples
- Prepare the resource
```powershell
$SearchCriteriaFiltersValueRange = Initialize-V2024SearchCriteriaFiltersValueRange -Lower null `
-Upper null
```
- Convert the resource to JSON
```powershell
$SearchCriteriaFiltersValueRange | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaFiltersValueRangeLower.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: v2024-search-criteria-filters-value-range-lower
title: SearchCriteriaFiltersValueRangeLower
pagination_label: SearchCriteriaFiltersValueRangeLower
sidebar_label: SearchCriteriaFiltersValueRangeLower
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaFiltersValueRangeLower', 'V2024SearchCriteriaFiltersValueRangeLower']
slug: /tools/sdk/powershell/v2024/models/search-criteria-filters-value-range-lower
tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRangeLower', 'V2024SearchCriteriaFiltersValueRangeLower']
---
# SearchCriteriaFiltersValueRangeLower
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Value** | **String** | The lower bound value. | [optional]
**Inclusive** | **Boolean** | Whether the lower bound is inclusive. | [optional] [default to $false]
## Examples
- Prepare the resource
```powershell
$SearchCriteriaFiltersValueRangeLower = Initialize-V2024SearchCriteriaFiltersValueRangeLower -Value 10 `
-Inclusive true
```
- Convert the resource to JSON
```powershell
$SearchCriteriaFiltersValueRangeLower | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaFiltersValueRangeUpper.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: v2024-search-criteria-filters-value-range-upper
title: SearchCriteriaFiltersValueRangeUpper
pagination_label: SearchCriteriaFiltersValueRangeUpper
sidebar_label: SearchCriteriaFiltersValueRangeUpper
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaFiltersValueRangeUpper', 'V2024SearchCriteriaFiltersValueRangeUpper']
slug: /tools/sdk/powershell/v2024/models/search-criteria-filters-value-range-upper
tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRangeUpper', 'V2024SearchCriteriaFiltersValueRangeUpper']
---
# SearchCriteriaFiltersValueRangeUpper
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Value** | **String** | The upper bound value. | [optional]
**Inclusive** | **Boolean** | Whether the upper bound is inclusive. | [optional] [default to $false]
## Examples
- Prepare the resource
```powershell
$SearchCriteriaFiltersValueRangeUpper = Initialize-V2024SearchCriteriaFiltersValueRangeUpper -Value 20 `
-Inclusive false
```
- Convert the resource to JSON
```powershell
$SearchCriteriaFiltersValueRangeUpper | ConvertTo-JSON
```
[[Back to top]](#)

35
docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaQuery.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: v2024-search-criteria-query
title: SearchCriteriaQuery
pagination_label: SearchCriteriaQuery
sidebar_label: SearchCriteriaQuery
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaQuery', 'V2024SearchCriteriaQuery']
slug: /tools/sdk/powershell/v2024/models/search-criteria-query
tags: ['SDK', 'Software Development Kit', 'SearchCriteriaQuery', 'V2024SearchCriteriaQuery']
---
# SearchCriteriaQuery
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Query** | **String** | A structured query for advanced search. | [optional]
## Examples
- Prepare the resource
```powershell
$SearchCriteriaQuery = Initialize-V2024SearchCriteriaQuery -Query status:active
```
- Convert the resource to JSON
```powershell
$SearchCriteriaQuery | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaTextQuery.md Normal file
View File

@@ -0,0 +1,39 @@
---
id: v2024-search-criteria-text-query
title: SearchCriteriaTextQuery
pagination_label: SearchCriteriaTextQuery
sidebar_label: SearchCriteriaTextQuery
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaTextQuery', 'V2024SearchCriteriaTextQuery']
slug: /tools/sdk/powershell/v2024/models/search-criteria-text-query
tags: ['SDK', 'Software Development Kit', 'SearchCriteriaTextQuery', 'V2024SearchCriteriaTextQuery']
---
# SearchCriteriaTextQuery
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Terms** | **[]String** | Terms to search for. | [optional]
**Fields** | **[]String** | Fields to search within. | [optional]
**MatchAny** | **Boolean** | Whether to match any of the terms. | [optional] [default to $false]
## Examples
- Prepare the resource
```powershell
$SearchCriteriaTextQuery = Initialize-V2024SearchCriteriaTextQuery -Terms [admin, user] `
-Fields [role, name] `
-MatchAny true
```
- Convert the resource to JSON
```powershell
$SearchCriteriaTextQuery | ConvertTo-JSON
```
[[Back to top]](#)

51
docs/tools/sdk/powershell/Reference/V2024/Models/SedBatchRecord.md Normal file
View File

@@ -0,0 +1,51 @@
---
id: v2024-sed-batch-record
title: SedBatchRecord
pagination_label: SedBatchRecord
sidebar_label: SedBatchRecord
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SedBatchRecord', 'V2024SedBatchRecord']
slug: /tools/sdk/powershell/v2024/models/sed-batch-record
tags: ['SDK', 'Software Development Kit', 'SedBatchRecord', 'V2024SedBatchRecord']
---
# SedBatchRecord
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**TenantId** | **String** | The tenant ID associated with the batch. | [optional]
**BatchId** | **String** | The unique ID of the batch. | [optional]
**Name** | **String** | The name of the batch. | [optional]
**ProcessedState** | **String** | The current state of the batch (e.g., submitted, materialized, completed). | [optional]
**RequestedBy** | **String** | The ID of the user who requested the batch. | [optional]
**MaterializedCount** | **Int32** | The number of items materialized in the batch. | [optional]
**ProcessedCount** | **Int32** | The number of items processed in the batch. | [optional]
**CreatedAt** | **System.DateTime** | The timestamp when the batch was created. | [optional]
**UpdatedAt** | **System.DateTime** | The timestamp when the batch was last updated. | [optional]
## Examples
- Prepare the resource
```powershell
$SedBatchRecord = Initialize-V2024SedBatchRecord -TenantId 123e4567-e89b-12d3-a456-426614174000 `
-BatchId 016629d1-1d25-463f-97f3-0c6686846650 `
-Name Example Batch Name `
-ProcessedState submitted | materialized | completed | failed `
-RequestedBy 987e6543-e21b-45d3-b123-123456789abc `
-MaterializedCount 50 `
-ProcessedCount 45 `
-CreatedAt 2023-10-01T12:00Z `
-UpdatedAt 2023-10-02T15:30Z
```
- Convert the resource to JSON
```powershell
$SedBatchRecord | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -18,13 +18,15 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Entitlements** | **[]String** | list of entitlement ids | [optional]
**Seds** | **[]String** | list of sed ids | [optional]
**SearchCriteria** | [**map[string]SearchCriteria**](search-criteria) | Search criteria for the batch request. | [optional]
## Examples
- Prepare the resource
```powershell
$SedBatchRequest = Initialize-V2024SedBatchRequest -Entitlements null `
-Seds null
-Seds null `
-SearchCriteria null
```
- Convert the resource to JSON

35
docs/tools/sdk/powershell/Reference/V2024/Models/SedBatchStatus.md
View File

@@ -1,35 +0,0 @@
---
id: v2024-sed-batch-status
title: SedBatchStatus
pagination_label: SedBatchStatus
sidebar_label: SedBatchStatus
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SedBatchStatus', 'V2024SedBatchStatus']
slug: /tools/sdk/powershell/v2024/models/sed-batch-status
tags: ['SDK', 'Software Development Kit', 'SedBatchStatus', 'V2024SedBatchStatus']
---
# SedBatchStatus
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Status** | **String** | status of batch | [optional]
## Examples
- Prepare the resource
```powershell
$SedBatchStatus = Initialize-V2024SedBatchStatus -Status OK
```
- Convert the resource to JSON
```powershell
$SedBatchStatus | ConvertTo-JSON
```
[[Back to top]](#)