From fe184ae8e8bab8dc9762899e3d7fc51bb0259641 Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Tue, 13 May 2025 16:13:23 +0000 Subject: [PATCH] Update to powershell SDK docs: 15001529666 --- .../Beta/Methods/BetaAccessRequestsApi.md | 19 +- .../Reference/Beta/Methods/BetaAccountsApi.md | 47 +- .../Methods/BetaPublicIdentitiesConfigApi.md | 6 + .../Beta/Methods/BetaWorkItemsApi.md | 191 +- .../Reference/Beta/Models/AccessRequest.md | 2 +- .../Beta/Models/AccessRequestItem.md | 2 +- .../Reference/Beta/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Beta/Models/RequestedItemDtoRef.md | 4 - .../Reference/Beta/Models/SourceUsage.md | 2 +- .../V2024/Methods/V2024AccessRequestsApi.md | 19 +- .../Reference/V2024/Models/AccessRequest.md | 2 +- .../V2024/Models/AccessRequestItem.md | 2 +- .../Reference/V2024/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../V2024/Models/RequestedItemDtoRef.md | 4 - .../Reference/V2024/Models/SourceUsage.md | 2 +- .../V2025/Methods/V2025AccessRequestsApi.md | 39 +- .../Reference/V2025/Models/AccessRequest.md | 2 +- .../V2025/Models/AccessRequestItem.md | 6 +- .../V2025/Models/AccessRequestItem1.md | 47 - .../Reference/V2025/Models/AccountUsage.md | 2 +- .../V2025/Models/AccountsSelectionRequest.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../V2025/Models/RequestedItemDtoRef.md | 4 - .../Reference/V2025/Models/SourceUsage.md | 2 +- .../Reference/V3/Methods/AccessRequestsApi.md | 19 +- .../Reference/V3/Models/AccessRequest.md | 2 +- .../Reference/V3/Models/AccessRequestItem.md | 2 +- .../Reference/V3/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../V3/Models/RequestedItemDtoRef.md | 4 - .../Reference/V3/Models/SourceUsage.md | 2 +- .../powershell_code_examples_overlay.yaml | 2700 +++++++------ .../powershell_code_examples_overlay.yaml | 3550 ++++++++-------- .../powershell_code_examples_overlay.yaml | 3570 +++++++++-------- .../v3/powershell_code_examples_overlay.yaml | 2490 ++++++------ 37 files changed, 6397 insertions(+), 6370 deletions(-) delete mode 100644 docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequestItem1.md diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md index aa6c93e03..eea2b6d85 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md @@ -185,7 +185,8 @@ __REVOKE_ACCESS__ * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. -* Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. +* Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. These fields should be used within the 'requestedItems' section for the revoke requests. +* Usage of 'requestedForWithRequestedItems' field is not supported for revoke requests. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-access-request) @@ -306,9 +307,7 @@ $AccessRequest = @"{ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -336,9 +335,7 @@ $AccessRequest = @"{ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" } ] }, { "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", @@ -369,9 +366,7 @@ $AccessRequest = @"{ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -399,9 +394,7 @@ $AccessRequest = @"{ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" } ] } ] }"@ diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountsApi.md index 221e70f40..a11e10d31 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountsApi.md @@ -63,6 +63,9 @@ Method | HTTP request | Description ## create-account +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Submits an account creation task - the API then returns the task ID. The `sourceId` where this account will be created must be included in the `attributes` object. @@ -129,6 +132,9 @@ try { [[Back to top]](#) ## delete-account +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. @@ -230,6 +236,9 @@ try { [[Back to top]](#) ## disable-account +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This API submits a task to disable the account and returns the task ID. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. @@ -283,6 +292,9 @@ try { [[Back to top]](#) ## disable-account-for-identity +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This API submits a task to disable IDN account for a single identity. [API Spec](https://developer.sailpoint.com/docs/api/beta/disable-account-for-identity) @@ -329,6 +341,9 @@ try { [[Back to top]](#) ## disable-accounts-for-identities +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This API submits tasks to disable IDN account for each identity provided in the request body. [API Spec](https://developer.sailpoint.com/docs/api/beta/disable-accounts-for-identities) @@ -377,6 +392,9 @@ try { [[Back to top]](#) ## enable-account +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This API submits a task to enable account and returns the task ID. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. @@ -430,6 +448,9 @@ try { [[Back to top]](#) ## enable-account-for-identity +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This API submits a task to enable IDN account for a single identity. [API Spec](https://developer.sailpoint.com/docs/api/beta/enable-account-for-identity) @@ -476,6 +497,9 @@ try { [[Back to top]](#) ## enable-accounts-for-identities +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This API submits tasks to enable IDN account for each identity provided in the request body. [API Spec](https://developer.sailpoint.com/docs/api/beta/enable-accounts-for-identities) @@ -524,6 +548,9 @@ try { [[Back to top]](#) ## get-account +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Use this API to return the details for a single account by its ID. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. @@ -571,6 +598,9 @@ try { [[Back to top]](#) ## get-account-entitlements +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This API returns entitlements of the account. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. @@ -624,7 +654,10 @@ try { [[Back to top]](#) ## list-accounts -List accounts. +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +List accounts. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-accounts) @@ -679,6 +712,9 @@ try { [[Back to top]](#) ## put-account +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. @@ -743,6 +779,9 @@ try { [[Back to top]](#) ## submit-reload-account +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. @@ -790,6 +829,9 @@ try { [[Back to top]](#) ## unlock-account +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. @@ -845,6 +887,9 @@ try { [[Back to top]](#) ## update-account +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Use this API to update account details. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPublicIdentitiesConfigApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPublicIdentitiesConfigApi.md index 3999de6e9..0616c4b65 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPublicIdentitiesConfigApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPublicIdentitiesConfigApi.md @@ -32,6 +32,9 @@ Method | HTTP request | Description ## get-public-identity-config +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This gets details of public identity config. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-public-identity-config) @@ -75,6 +78,9 @@ try { [[Back to top]](#) ## update-public-identity-config +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This updates the details of public identity config. [API Spec](https://developer.sailpoint.com/docs/api/beta/update-public-identity-config) diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkItemsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkItemsApi.md index be065444a..7c9661cb2 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkItemsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkItemsApi.md @@ -34,7 +34,6 @@ Method | HTTP request | Description [**Approve-BetaApprovalItem**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item [**Approve-BetaApprovalItemsInBulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items [**Complete-BetaWorkItem**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a Work Item -[**Invoke-BetaForwardWorkItem**](#forward-work-item) | **POST** `/work-items/{id}/forward` | Forward a Work Item [**Get-BetaCompletedWorkItems**](#get-completed-work-items) | **GET** `/work-items/completed` | Completed Work Items [**Get-BetaCountCompletedWorkItems**](#get-count-completed-work-items) | **GET** `/work-items/completed/count` | Count Completed Work Items [**Get-BetaCountWorkItems**](#get-count-work-items) | **GET** `/work-items/count` | Count Work Items @@ -44,9 +43,13 @@ Method | HTTP request | Description [**Deny-BetaApprovalItem**](#reject-approval-item) | **POST** `/work-items/{id}/reject/{approvalItemId}` | Reject an Approval Item [**Deny-BetaApprovalItemsInBulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items [**Submit-BetaAccountSelection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit Account Selections +[**Submit-BetaForwardWorkItem**](#submit-forward-work-item) | **POST** `/work-items/{id}/forward` | Forward a Work Item ## approve-approval-item +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This API approves an Approval Item. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/beta/approve-approval-item) @@ -64,9 +67,12 @@ Path | ApprovalItemId | **String** | True | The ID of the approval item. Code | Description | Data Type ------------- | ------------- | ------------- 200 | A work items details object. | WorkItems +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto 404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto ### HTTP request headers - **Content-Type**: Not defined @@ -92,6 +98,9 @@ try { [[Back to top]](#) ## approve-approval-items-in-bulk +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/beta/approve-approval-items-in-bulk) @@ -108,9 +117,12 @@ Path | Id | **String** | True | The ID of the work item Code | Description | Data Type ------------- | ------------- | ------------- 200 | A work items details object. | WorkItems +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto 404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto ### HTTP request headers - **Content-Type**: Not defined @@ -135,6 +147,9 @@ try { [[Back to top]](#) ## complete-work-item +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This API completes a work item. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/beta/complete-work-item) @@ -182,59 +197,10 @@ try { ``` [[Back to top]](#) -## forward-work-item -This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. - -[API Spec](https://developer.sailpoint.com/docs/api/beta/forward-work-item) - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of the work item - Body | WorkItemForward | [**WorkItemForward**](../models/work-item-forward) | True | - -### Return type - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Success, but no data is returned. | -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. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item -$WorkItemForward = @"{ - "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I'm going on vacation.", - "sendNotifications" : true -}"@ - -# Forward a Work Item - -try { - $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward - Invoke-BetaForwardWorkItem -Id $Id -WorkItemForward $Result - - # Below is a request that includes all optional parameters - # Invoke-BetaForwardWorkItem -Id $Id -WorkItemForward $Result -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardWorkItem" - Write-Host $_.ErrorDetails -} -``` -[[Back to top]](#) - ## get-completed-work-items +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-completed-work-items) @@ -254,9 +220,12 @@ Param Type | Name | Data Type | Required | Description Code | Description | Data Type ------------- | ------------- | ------------- 200 | List of completed work items. | WorkItems[] +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto 404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto ### HTTP request headers - **Content-Type**: Not defined @@ -264,7 +233,7 @@ Code | Description | Data Type ### Example ```powershell -$OwnerId = "MyOwnerId" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) +$OwnerId = "2c91808571bcfcf80171c23e4b4221fc" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) @@ -284,6 +253,9 @@ try { [[Back to top]](#) ## get-count-completed-work-items +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This gets a count of completed work items belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-count-completed-work-items) @@ -292,6 +264,8 @@ This gets a count of completed work items belonging to either the specified user Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Query | OwnerId | **String** | (optional) | ID of the work item owner. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. ### Return type [**WorkItemsCount[]**](../models/work-items-count) @@ -300,9 +274,12 @@ Param Type | Name | Data Type | Required | Description Code | Description | Data Type ------------- | ------------- | ------------- 200 | List of work items | WorkItemsCount[] +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto 404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto ### HTTP request headers - **Content-Type**: Not defined @@ -310,7 +287,9 @@ Code | Description | Data Type ### Example ```powershell -$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) +$OwnerId = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the work item owner. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # Count Completed Work Items @@ -318,7 +297,7 @@ try { Get-BetaCountCompletedWorkItems # Below is a request that includes all optional parameters - # Get-BetaCountCompletedWorkItems -OwnerId $OwnerId + # Get-BetaCountCompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountCompletedWorkItems" Write-Host $_.ErrorDetails @@ -327,6 +306,9 @@ try { [[Back to top]](#) ## get-count-work-items +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This gets a count of work items belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-count-work-items) @@ -343,9 +325,12 @@ Param Type | Name | Data Type | Required | Description Code | Description | Data Type ------------- | ------------- | ------------- 200 | List of work items | WorkItemsCount +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto 404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto ### HTTP request headers - **Content-Type**: Not defined @@ -353,7 +338,7 @@ Code | Description | Data Type ### Example ```powershell -$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) +$OwnerId = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the work item owner. (optional) # Count Work Items @@ -370,6 +355,9 @@ try { [[Back to top]](#) ## get-work-item +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-work-item) @@ -418,6 +406,9 @@ try { [[Back to top]](#) ## get-work-items-summary +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This gets a summary of work items belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-work-items-summary) @@ -434,9 +425,12 @@ Param Type | Name | Data Type | Required | Description Code | Description | Data Type ------------- | ------------- | ------------- 200 | List of work items | WorkItemsSummary +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto 404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto ### HTTP request headers - **Content-Type**: Not defined @@ -444,7 +438,7 @@ Code | Description | Data Type ### Example ```powershell -$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) +$OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) # Work Items Summary @@ -461,6 +455,9 @@ try { [[Back to top]](#) ## list-work-items +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This gets a collection of work items belonging to either the specified user(admin required), or the current user. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-work-items) @@ -480,9 +477,12 @@ Param Type | Name | Data Type | Required | Description Code | Description | Data Type ------------- | ------------- | ------------- 200 | List of work items | WorkItems[] +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto 404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto ### HTTP request headers - **Content-Type**: Not defined @@ -493,7 +493,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) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) +$OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) # List Work Items @@ -510,6 +510,9 @@ try { [[Back to top]](#) ## reject-approval-item +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/beta/reject-approval-item) @@ -527,9 +530,12 @@ Path | ApprovalItemId | **String** | True | The ID of the approval item. Code | Description | Data Type ------------- | ------------- | ------------- 200 | A work items details object. | WorkItems +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto 404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto ### HTTP request headers - **Content-Type**: Not defined @@ -555,6 +561,9 @@ try { [[Back to top]](#) ## reject-approval-items-in-bulk +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/beta/reject-approval-items-in-bulk) @@ -571,9 +580,12 @@ Path | Id | **String** | True | The ID of the work item Code | Description | Data Type ------------- | ------------- | ------------- 200 | A work items details object. | WorkItems +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto 404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto ### HTTP request headers - **Content-Type**: Not defined @@ -598,6 +610,9 @@ try { [[Back to top]](#) ## submit-account-selection +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This API submits account selections. Either an admin, or the owning/current user must make this request. [API Spec](https://developer.sailpoint.com/docs/api/beta/submit-account-selection) @@ -615,9 +630,12 @@ Path | Id | **String** | True | The ID of the work item Code | Description | Data Type ------------- | ------------- | ------------- 200 | A work items details object. | WorkItems +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto 404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto ### HTTP request headers - **Content-Type**: application/json @@ -642,3 +660,58 @@ try { } ``` [[Back to top]](#) + +## submit-forward-work-item +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/submit-forward-work-item) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the work item + Body | WorkItemForward | [**WorkItemForward**](../models/work-item-forward) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Success, but no data is returned. | +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. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item +$WorkItemForward = @"{ + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true +}"@ + +# Forward a Work Item + +try { + $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward + Submit-BetaForwardWorkItem -Id $Id -WorkItemForward $Result + + # Below is a request that includes all optional parameters + # Submit-BetaForwardWorkItem -Id $Id -WorkItemForward $Result +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaForwardWorkItem" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequest.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequest.md index 0ba47ec9e..8c2361bb6 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequest.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequest.md @@ -20,7 +20,7 @@ Name | Type | Description | Notes **RequestType** | [**AccessRequestType**](access-request-type) | | [optional] **RequestedItems** | [**[]AccessRequestItem**](access-request-item) | | [required] **ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] -**RequestedForWithRequestedItems** | [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request | [optional] +**RequestedForWithRequestedItems** | [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request * Only for use in GRANT_ACCESS type requests | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestItem.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestItem.md index 0de7652c7..3a0c0c534 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestItem.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestItem.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes **ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] **RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] **AssignmentId** | **String** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] -**NativeIdentity** | **String** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] +**NativeIdentity** | **String** | The unique identifier for an account on the identity, designated as the account ID attribute in the source's account schema. This is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md index 607567a33..c4e704384 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-BetaAccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` +$AccountUsage = Initialize-BetaAccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md index aa9168a34..27c8e3c8c 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-BetaNonEmployeeRequestWithou -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Mon Mar 23 20:00:00 EDT 2020 ` - -EndDate Wed Mar 24 20:00:00 EDT 2021 ` + -StartDate Tue Mar 24 00:00:00 UTC 2020 ` + -EndDate Thu Mar 25 00:00:00 UTC 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/RequestedItemDtoRef.md b/docs/tools/sdk/powershell/Reference/Beta/Models/RequestedItemDtoRef.md index 0c092ff84..b799b5192 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/RequestedItemDtoRef.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/RequestedItemDtoRef.md @@ -21,8 +21,6 @@ Name | Type | Description | Notes **Comment** | **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] **ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] **RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] -**AssignmentId** | **String** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] -**NativeIdentity** | **String** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] **AccountSelection** | [**[]SourceItemRef**](source-item-ref) | The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account | [optional] ## Examples @@ -34,8 +32,6 @@ $RequestedItemDtoRef = Initialize-BetaRequestedItemDtoRef -Type ACCESS_PROFILE -Comment Requesting access profile for John Doe ` -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` -RemoveDate 2020-07-11T21:23:15Z ` - -AssignmentId ee48a191c00d49bf9264eb0a4fc3a9fc ` - -NativeIdentity CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN ` -AccountSelection null ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md index 16f5cb5d7..5d345af72 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-BetaSourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` +$SourceUsage = Initialize-BetaSourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10.45 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md index 28dbe1655..32cd26da0 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md @@ -295,7 +295,8 @@ __REVOKE_ACCESS__ * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. -* Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. +* Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. These fields should be used within the 'requestedItems' section for the revoke requests. +* Usage of 'requestedForWithRequestedItems' field is not supported for revoke requests. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-access-request) @@ -416,9 +417,7 @@ $AccessRequest = @"{ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -446,9 +445,7 @@ $AccessRequest = @"{ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" } ] }, { "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", @@ -479,9 +476,7 @@ $AccessRequest = @"{ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -509,9 +504,7 @@ $AccessRequest = @"{ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" } ] } ] }"@ diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequest.md index f5c9f3fc6..7d976ffa2 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequest.md @@ -20,7 +20,7 @@ Name | Type | Description | Notes **RequestType** | [**AccessRequestType**](access-request-type) | | [optional] **RequestedItems** | [**[]AccessRequestItem**](access-request-item) | | [required] **ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] -**RequestedForWithRequestedItems** | [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request | [optional] +**RequestedForWithRequestedItems** | [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request * Only for use in GRANT_ACCESS type requests | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestItem.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestItem.md index 7bce745e0..112c42063 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestItem.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestItem.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes **ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] **RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] **AssignmentId** | **String** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] -**NativeIdentity** | **String** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] +**NativeIdentity** | **String** | The unique identifier for an account on the identity, designated as the account ID attribute in the source's account schema. This is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md index cf03b4b80..8e14247b3 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-V2024AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` +$AccountUsage = Initialize-V2024AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md index bfee9e32f..8bcb67044 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-V2024NonEmployeeRequestWitho -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Mon Mar 23 20:00:00 EDT 2020 ` - -EndDate Wed Mar 24 20:00:00 EDT 2021 ` + -StartDate Tue Mar 24 00:00:00 UTC 2020 ` + -EndDate Thu Mar 25 00:00:00 UTC 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/RequestedItemDtoRef.md b/docs/tools/sdk/powershell/Reference/V2024/Models/RequestedItemDtoRef.md index 270512392..9b5885dac 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/RequestedItemDtoRef.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/RequestedItemDtoRef.md @@ -21,8 +21,6 @@ Name | Type | Description | Notes **Comment** | **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] **ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] **RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] -**AssignmentId** | **String** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] -**NativeIdentity** | **String** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] **AccountSelection** | [**[]SourceItemRef**](source-item-ref) | The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account | [optional] ## Examples @@ -34,8 +32,6 @@ $RequestedItemDtoRef = Initialize-V2024RequestedItemDtoRef -Type ACCESS_PROFILE -Comment Requesting access profile for John Doe ` -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` -RemoveDate 2020-07-11T21:23:15Z ` - -AssignmentId ee48a191c00d49bf9264eb0a4fc3a9fc ` - -NativeIdentity CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN ` -AccountSelection null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md index 55fe28783..887f5183e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-V2024SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` +$SourceUsage = Initialize-V2024SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10.45 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestsApi.md index 257884953..7cc8ee540 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestsApi.md @@ -296,7 +296,8 @@ __REVOKE_ACCESS__ * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. -* Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. +* Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. These fields should be used within the 'requestedItems' section for the revoke requests. +* Usage of 'requestedForWithRequestedItems' field is not supported for revoke requests. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-access-request) @@ -340,7 +341,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -349,7 +352,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -358,7 +363,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -367,7 +374,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -376,7 +385,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" } ], "requestedForWithRequestedItems" : [ { "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", @@ -407,9 +418,7 @@ $AccessRequest = @"{ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -437,9 +446,7 @@ $AccessRequest = @"{ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" } ] }, { "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", @@ -470,9 +477,7 @@ $AccessRequest = @"{ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -500,9 +505,7 @@ $AccessRequest = @"{ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" } ] } ] }"@ diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequest.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequest.md index 63adea7dd..89b69b315 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequest.md @@ -20,7 +20,7 @@ Name | Type | Description | Notes **RequestType** | [**AccessRequestType**](access-request-type) | | [optional] **RequestedItems** | [**[]AccessRequestItem**](access-request-item) | | [required] **ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] -**RequestedForWithRequestedItems** | [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request | [optional] +**RequestedForWithRequestedItems** | [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request * Only for use in GRANT_ACCESS type requests | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequestItem.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequestItem.md index ca224c580..08e149ef9 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequestItem.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequestItem.md @@ -21,6 +21,8 @@ Name | Type | Description | Notes **Comment** | **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] **ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] **RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**AssignmentId** | **String** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**NativeIdentity** | **String** | The unique identifier for an account on the identity, designated as the account ID attribute in the source's account schema. This is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] ## Examples @@ -30,7 +32,9 @@ $AccessRequestItem = Initialize-V2025AccessRequestItem -Type ACCESS_PROFILE ` -Id 2c9180835d2e5168015d32f890ca1581 ` -Comment Requesting access profile for John Doe ` -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` - -RemoveDate 2020-07-11T21:23:15Z + -RemoveDate 2020-07-11T21:23:15Z ` + -AssignmentId ee48a191c00d49bf9264eb0a4fc3a9fc ` + -NativeIdentity CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequestItem1.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequestItem1.md deleted file mode 100644 index 7b4bb906a..000000000 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequestItem1.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: v2025-access-request-item1 -title: AccessRequestItem1 -pagination_label: AccessRequestItem1 -sidebar_label: AccessRequestItem1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestItem1', 'V2025AccessRequestItem1'] -slug: /tools/sdk/powershell/v2025/models/access-request-item1 -tags: ['SDK', 'Software Development Kit', 'AccessRequestItem1', 'V2025AccessRequestItem1'] ---- - - -# AccessRequestItem1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of the item being requested. | [required] -**Id** | **String** | ID of Role, Access Profile or Entitlement being requested. | [required] -**Comment** | **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] -**ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] -**RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] -**AssignmentId** | **String** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] -**NativeIdentity** | **String** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessRequestItem1 = Initialize-V2025AccessRequestItem1 -Type ACCESS_PROFILE ` - -Id 2c9180835d2e5168015d32f890ca1581 ` - -Comment Requesting access profile for John Doe ` - -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` - -RemoveDate 2020-07-11T21:23:15Z ` - -AssignmentId ee48a191c00d49bf9264eb0a4fc3a9fc ` - -NativeIdentity CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN -``` - -- Convert the resource to JSON -```powershell -$AccessRequestItem1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountUsage.md index 663ef668f..a616aa6be 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-V2025AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` +$AccountUsage = Initialize-V2025AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccountsSelectionRequest.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountsSelectionRequest.md index d18a48677..c0f9585e4 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccountsSelectionRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountsSelectionRequest.md @@ -18,7 +18,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **RequestedFor** | **[]String** | A list of Identity IDs for whom the Access is requested. | [required] **RequestType** | [**AccessRequestType**](access-request-type) | | [optional] -**RequestedItems** | [**[]AccessRequestItem1**](access-request-item1) | | [required] +**RequestedItems** | [**[]AccessRequestItem**](access-request-item) | | [required] **ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md index 8f835fd80..a6607f896 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-V2025NonEmployeeRequestWitho -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Mon Mar 23 20:00:00 EDT 2020 ` - -EndDate Wed Mar 24 20:00:00 EDT 2021 ` + -StartDate Tue Mar 24 00:00:00 UTC 2020 ` + -EndDate Thu Mar 25 00:00:00 UTC 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/RequestedItemDtoRef.md b/docs/tools/sdk/powershell/Reference/V2025/Models/RequestedItemDtoRef.md index 44b61be3f..dbfd210c9 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/RequestedItemDtoRef.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/RequestedItemDtoRef.md @@ -21,8 +21,6 @@ Name | Type | Description | Notes **Comment** | **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] **ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] **RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] -**AssignmentId** | **String** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] -**NativeIdentity** | **String** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] **AccountSelection** | [**[]SourceItemRef**](source-item-ref) | The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account | [optional] ## Examples @@ -34,8 +32,6 @@ $RequestedItemDtoRef = Initialize-V2025RequestedItemDtoRef -Type ACCESS_PROFILE -Comment Requesting access profile for John Doe ` -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` -RemoveDate 2020-07-11T21:23:15Z ` - -AssignmentId ee48a191c00d49bf9264eb0a4fc3a9fc ` - -NativeIdentity CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN ` -AccountSelection null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V2025/Models/SourceUsage.md index 41134386d..4bc6ce030 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-V2025SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` +$SourceUsage = Initialize-V2025SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10.45 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestsApi.md index 66d8c0a83..0869a9a8a 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestsApi.md @@ -122,7 +122,8 @@ __REVOKE_ACCESS__ * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. -* Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. +* Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. These fields should be used within the 'requestedItems' section for the revoke requests. +* Usage of 'requestedForWithRequestedItems' field is not supported for revoke requests. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-access-request) @@ -243,9 +244,7 @@ $AccessRequest = @"{ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -273,9 +272,7 @@ $AccessRequest = @"{ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" } ] }, { "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", @@ -306,9 +303,7 @@ $AccessRequest = @"{ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -336,9 +331,7 @@ $AccessRequest = @"{ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" } ] } ] }"@ diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequest.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequest.md index 80677606f..f9f66cded 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequest.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequest.md @@ -20,7 +20,7 @@ Name | Type | Description | Notes **RequestType** | [**AccessRequestType**](access-request-type) | | [optional] **RequestedItems** | [**[]AccessRequestItem**](access-request-item) | | [required] **ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] -**RequestedForWithRequestedItems** | [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request | [optional] +**RequestedForWithRequestedItems** | [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request * Only for use in GRANT_ACCESS type requests | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequestItem.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequestItem.md index ccb9687c8..f8670bcc5 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequestItem.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequestItem.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes **ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] **RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] **AssignmentId** | **String** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] -**NativeIdentity** | **String** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] +**NativeIdentity** | **String** | The unique identifier for an account on the identity, designated as the account ID attribute in the source's account schema. This is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md index b8ee4355a..25eae460a 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` +$AccountUsage = Initialize-AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md index add1f8fa4..43bf4bb59 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-NonEmployeeRequestWithoutApp -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Mon Mar 23 20:00:00 EDT 2020 ` - -EndDate Wed Mar 24 20:00:00 EDT 2021 ` + -StartDate Tue Mar 24 00:00:00 UTC 2020 ` + -EndDate Thu Mar 25 00:00:00 UTC 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/RequestedItemDtoRef.md b/docs/tools/sdk/powershell/Reference/V3/Models/RequestedItemDtoRef.md index d5878cb0a..f4fac7701 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/RequestedItemDtoRef.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/RequestedItemDtoRef.md @@ -21,8 +21,6 @@ Name | Type | Description | Notes **Comment** | **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] **ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] **RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] -**AssignmentId** | **String** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] -**NativeIdentity** | **String** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] **AccountSelection** | [**[]SourceItemRef**](source-item-ref) | The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account | [optional] ## Examples @@ -34,8 +32,6 @@ $RequestedItemDtoRef = Initialize-RequestedItemDtoRef -Type ACCESS_PROFILE ` -Comment Requesting access profile for John Doe ` -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` -RemoveDate 2020-07-11T21:23:15Z ` - -AssignmentId ee48a191c00d49bf9264eb0a4fc3a9fc ` - -NativeIdentity CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN ` -AccountSelection null ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md index 1d696514d..db0c6fc05 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` +$SourceUsage = Initialize-SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10.45 ``` diff --git a/static/code-examples/beta/powershell_code_examples_overlay.yaml b/static/code-examples/beta/powershell_code_examples_overlay.yaml index 6bc5a0c96..9ca11684b 100644 --- a/static/code-examples/beta/powershell_code_examples_overlay.yaml +++ b/static/code-examples/beta/powershell_code_examples_overlay.yaml @@ -670,9 +670,7 @@ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -700,9 +698,7 @@ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" } ] }, { "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", @@ -733,9 +729,7 @@ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -763,9 +757,7 @@ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" } ] } ] } @@ -941,6 +933,29 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountAggregationStatus" Write-Host $_.ErrorDetails } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/account-usages#get-usages-by-account-id + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + Get-BetaUsagesByAccountId -AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-BetaUsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesByAccountId" + Write-Host $_.ErrorDetails + } - path: /accounts method: POST xCodeSample: @@ -1313,29 +1328,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccount" Write-Host $_.ErrorDetails } -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/account-usages#get-usages-by-account-id - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns account usage insights - - try { - Get-BetaUsagesByAccountId -AccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-BetaUsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesByAccountId" - Write-Host $_.ErrorDetails - } - path: /discovered-applications/{id} method: GET xCodeSample: @@ -6674,162 +6666,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaLifecycleStates" Write-Host $_.ErrorDetails } -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clients#get-managed-client-status - source: | - $Id = "aClientId" # String | ID of the Managed Client Status to get - $Type = "CCG" # ManagedClientType | Type of the Managed Client Status to get - - # Specified Managed Client Status. - - try { - Get-BetaManagedClientStatus -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-BetaManagedClientStatus -Id $Id -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClientStatus" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id}/status - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clients#update-managed-client-status - source: | - $Id = "aClientId" # String | ID of the Managed Client Status to update - $ManagedClientStatus = @" - { - "body" : { - "alertKey" : "", - "id" : "5678", - "clusterId" : "1234", - "ccg_etag" : "ccg_etag123xyz456", - "ccg_pin" : "NONE", - "cookbook_etag" : "20210420125956-20210511144538", - "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", - "internal_ip" : "127.0.0.1", - "lastSeen" : "1620843964604", - "sinceSeen" : "14708", - "sinceSeenMillis" : "14708", - "localDev" : false, - "stacktrace" : "", - "status" : "NORMAL", - "product" : "idn", - "platform_version" : "2", - "os_version" : "2345.3.1", - "os_type" : "flatcar", - "hypervisor" : "unknown" - }, - "type" : "CCG", - "status" : "NORMAL", - "timestamp" : "2020-01-01T00:00:00Z" - } - "@ - - # Handle status request from client - - try { - $Result = ConvertFrom-JsonToManagedClientStatus -Json $ManagedClientStatus - Update-BetaManagedClientStatus -Id $Id -ManagedClientStatus $Result - - # Below is a request that includes all optional parameters - # Update-BetaManagedClientStatus -Id $Id -ManagedClientStatus $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaManagedClientStatus" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-client-log-configuration - source: | - $Id = "aClusterId" # String | ID of ManagedCluster to get log configuration for - - # Get managed cluster's log configuration - - try { - Get-BetaClientLogConfiguration -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaClientLogConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-managed-cluster - source: | - $Id = "aClusterId" # String | ID of the ManagedCluster to get - - # Get a specified ManagedCluster. - - try { - Get-BetaManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaManagedCluster -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-managed-clusters - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "operational eq operation" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - - # Retrieve all Managed Clusters. - - try { - Get-BetaManagedClusters - - # Below is a request that includes all optional parameters - # Get-BetaManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClusters" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#put-client-log-configuration - source: | - $Id = "aClusterId" # String | ID of ManagedCluster to update log configuration for - $ClientLogConfiguration = @" - { - "durationMinutes" : 120, - "rootLevel" : "INFO", - "clientId" : "aClientId", - "expiration" : "2020-12-15T19:13:36.079Z", - "logLevels" : "INFO" - } - "@ - - # Update managed cluster's log configuration - - try { - Send-BetaClientLogConfiguration -Id $Id -ClientLogConfiguration $Result - - # Below is a request that includes all optional parameters - # Send-BetaClientLogConfiguration -Id $Id -ClientLogConfiguration $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaClientLogConfiguration" - Write-Host $_.ErrorDetails - } - path: /mfa/{method}/delete method: DELETE xCodeSample: @@ -7156,6 +6992,162 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTokenAuthRequest" Write-Host $_.ErrorDetails } +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clients#get-managed-client-status + source: | + $Id = "aClientId" # String | ID of the Managed Client Status to get + $Type = "CCG" # ManagedClientType | Type of the Managed Client Status to get + + # Specified Managed Client Status. + + try { + Get-BetaManagedClientStatus -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-BetaManagedClientStatus -Id $Id -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id}/status + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clients#update-managed-client-status + source: | + $Id = "aClientId" # String | ID of the Managed Client Status to update + $ManagedClientStatus = @" + { + "body" : { + "alertKey" : "", + "id" : "5678", + "clusterId" : "1234", + "ccg_etag" : "ccg_etag123xyz456", + "ccg_pin" : "NONE", + "cookbook_etag" : "20210420125956-20210511144538", + "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", + "internal_ip" : "127.0.0.1", + "lastSeen" : "1620843964604", + "sinceSeen" : "14708", + "sinceSeenMillis" : "14708", + "localDev" : false, + "stacktrace" : "", + "status" : "NORMAL", + "product" : "idn", + "platform_version" : "2", + "os_version" : "2345.3.1", + "os_type" : "flatcar", + "hypervisor" : "unknown" + }, + "type" : "CCG", + "status" : "NORMAL", + "timestamp" : "2020-01-01T00:00:00Z" + } + "@ + + # Handle status request from client + + try { + $Result = ConvertFrom-JsonToManagedClientStatus -Json $ManagedClientStatus + Update-BetaManagedClientStatus -Id $Id -ManagedClientStatus $Result + + # Below is a request that includes all optional parameters + # Update-BetaManagedClientStatus -Id $Id -ManagedClientStatus $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-client-log-configuration + source: | + $Id = "aClusterId" # String | ID of ManagedCluster to get log configuration for + + # Get managed cluster's log configuration + + try { + Get-BetaClientLogConfiguration -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaClientLogConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-managed-cluster + source: | + $Id = "aClusterId" # String | ID of the ManagedCluster to get + + # Get a specified ManagedCluster. + + try { + Get-BetaManagedCluster -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaManagedCluster -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-managed-clusters + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "operational eq operation" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + + # Retrieve all Managed Clusters. + + try { + Get-BetaManagedClusters + + # Below is a request that includes all optional parameters + # Get-BetaManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClusters" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#put-client-log-configuration + source: | + $Id = "aClusterId" # String | ID of ManagedCluster to update log configuration for + $ClientLogConfiguration = @" + { + "durationMinutes" : 120, + "rootLevel" : "INFO", + "clientId" : "aClientId", + "expiration" : "2020-12-15T19:13:36.079Z", + "logLevels" : "INFO" + } + "@ + + # Update managed cluster's log configuration + + try { + Send-BetaClientLogConfiguration -Id $Id -ClientLogConfiguration $Result + + # Below is a request that includes all optional parameters + # Send-BetaClientLogConfiguration -Id $Id -ClientLogConfiguration $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaClientLogConfiguration" + Write-Host $_.ErrorDetails + } - path: /multihosts method: POST xCodeSample: @@ -9935,518 +9927,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRole" Write-Host $_.ErrorDetails } -- path: /accounts/search-attribute-config - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#create-search-attribute-config - source: | - $SearchAttributeConfig = @" - { - "displayName" : "New Mail Attribute", - "name" : "newMailAttribute", - "applicationAttributes" : { - "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", - "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" - } - } - "@ - - # Create Extended Search Attributes - - try { - $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig - New-BetaSearchAttributeConfig -SearchAttributeConfig $Result - - # Below is a request that includes all optional parameters - # New-BetaSearchAttributeConfig -SearchAttributeConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#delete-search-attribute-config - source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. - - # Delete Extended Search Attribute - - try { - Remove-BetaSearchAttributeConfig -Name $Name - - # Below is a request that includes all optional parameters - # Remove-BetaSearchAttributeConfig -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-search-attribute-config - source: | - $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 - - try { - Get-BetaSearchAttributeConfig - - # Below is a request that includes all optional parameters - # Get-BetaSearchAttributeConfig -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-single-search-attribute-config - source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. - - # Get Extended Search Attribute - - try { - Get-BetaSingleSearchAttributeConfig -Name $Name - - # Below is a request that includes all optional parameters - # Get-BetaSingleSearchAttributeConfig -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSingleSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#patch-search-attribute-config - source: | - $Name = "promotedMailAttribute" # String | Name of the extended search attribute configuration to patch. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Extended Search Attribute - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaSearchAttributeConfig -Name $Name -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaSearchAttributeConfig -Name $Name -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /segments - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#create-segment - source: | - $Segment = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "visibilityCriteria" : { - "expression" : { - "children" : [ ], - "attribute" : "location", - "value" : { - "type" : "STRING", - "value" : "Austin" - }, - "operator" : "EQUALS" - } - }, - "name" : "segment-xyz", - "modified" : "2020-01-01T00:00:00Z", - "description" : "This segment represents xyz", - "active" : true, - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" - } - "@ - - # Create Segment - - try { - $Result = ConvertFrom-JsonToSegment -Json $Segment - New-BetaSegment -Segment $Result - - # Below is a request that includes all optional parameters - # New-BetaSegment -Segment $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSegment" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#delete-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. - - # Delete Segment by ID - - try { - Remove-BetaSegment -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaSegment -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSegment" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#get-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. - - # Get Segment by ID - - try { - Get-BetaSegment -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSegment -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegment" - Write-Host $_.ErrorDetails - } -- path: /segments - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#list-segments - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Segments - - try { - Get-BetaSegments - - # Below is a request that includes all optional parameters - # Get-BetaSegments -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegments" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#patch-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. - $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ - - - # Update Segment - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-BetaSegment -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-BetaSegment -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSegment" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#create-service-desk-integration - source: | - $ServiceDeskIntegrationDto = @" - { - "ownerRef" : "", - "cluster" : "xyzzy999", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "description" : "A very nice Service Desk integration", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "beforeProvisioningRule" : "" - } - "@ - - # Create new Service Desk integration - - try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - New-BetaServiceDeskIntegration -ServiceDeskIntegrationDto $Result - - # Below is a request that includes all optional parameters - # New-BetaServiceDeskIntegration -ServiceDeskIntegrationDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#delete-service-desk-integration - source: | - $Id = "anId" # String | ID of Service Desk integration to delete - - # Delete a Service Desk integration - - try { - Remove-BetaServiceDeskIntegration -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaServiceDeskIntegration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to get - - # Get a Service Desk integration - - try { - Get-BetaServiceDeskIntegration -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-list - source: | - $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) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List existing Service Desk integrations - - try { - Get-BetaServiceDeskIntegrationList - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegrationList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationList" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/templates/{scriptName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-template - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get - - # Service Desk integration template by scriptName - - try { - Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTemplate" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-types - source: | - - # List Service Desk integration types - - try { - Get-BetaServiceDeskIntegrationTypes - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegrationTypes - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTypes" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/status-check-configuration - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-status-check-details - source: | - - # Get the time check configuration - - try { - Get-BetaStatusCheckDetails - - # Below is a request that includes all optional parameters - # Get-BetaStatusCheckDetails - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusCheckDetails" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#patch-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a Service Desk Integration - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaServiceDeskIntegration -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaServiceDeskIntegration -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#put-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $ServiceDeskIntegrationDto = @" - { - "ownerRef" : "", - "cluster" : "xyzzy999", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "description" : "A very nice Service Desk integration", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "beforeProvisioningRule" : "" - } - "@ - - # Update a Service Desk integration - - try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - Send-BetaServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result - - # Below is a request that includes all optional parameters - # Send-BetaServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/status-check-configuration - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#update-status-check-details - source: | - $QueuedCheckConfigDetails = @" - { - "provisioningStatusCheckIntervalMinutes" : "30", - "provisioningMaxStatusCheckDays" : "2" - } - "@ - - # Update the time check configuration - - try { - $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails - Update-BetaStatusCheckDetails -QueuedCheckConfigDetails $Result - - # Below is a request that includes all optional parameters - # Update-BetaStatusCheckDetails -QueuedCheckConfigDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaStatusCheckDetails" - Write-Host $_.ErrorDetails - } - path: /sim-integrations method: POST xCodeSample: @@ -11184,6 +10664,700 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaPredictSodViolations" Write-Host $_.ErrorDetails } +- path: /sp-config/export + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#export-sp-config + source: | + $ExportPayload = @" + { + "description" : "Export Job 1 Test" + } + "@ + + # Initiates configuration objects export job + + try { + $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload + Export-BetaSpConfig -ExportPayload $Result + + # Below is a request that includes all optional parameters + # Export-BetaSpConfig -ExportPayload $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaSpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. + + # Download export job result. + + try { + Get-BetaSpConfigExport -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigExport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. + + # Get export job status + + try { + Get-BetaSpConfigExportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigExportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. + + # Download import job result + + try { + Get-BetaSpConfigImport -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigImport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. + + # Get import job status + + try { + Get-BetaSpConfigImportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigImportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#import-sp-config + source: | + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) + $Options = @" + "@ + + # Initiates configuration objects import job + + try { + Import-BetaSpConfig -Data $Data + + # Below is a request that includes all optional parameters + # Import-BetaSpConfig -Data $Data -Preview $Preview -Options $Options + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#list-sp-config-objects + source: | + + # List Config Objects + + try { + Get-BetaSpConfigObjects + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigObjects + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigObjects" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#create-search-attribute-config + source: | + $SearchAttributeConfig = @" + { + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + } + "@ + + # Create Extended Search Attributes + + try { + $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig + New-BetaSearchAttributeConfig -SearchAttributeConfig $Result + + # Below is a request that includes all optional parameters + # New-BetaSearchAttributeConfig -SearchAttributeConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#delete-search-attribute-config + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. + + # Delete Extended Search Attribute + + try { + Remove-BetaSearchAttributeConfig -Name $Name + + # Below is a request that includes all optional parameters + # Remove-BetaSearchAttributeConfig -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-search-attribute-config + source: | + $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 + + try { + Get-BetaSearchAttributeConfig + + # Below is a request that includes all optional parameters + # Get-BetaSearchAttributeConfig -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. + + # Get Extended Search Attribute + + try { + Get-BetaSingleSearchAttributeConfig -Name $Name + + # Below is a request that includes all optional parameters + # Get-BetaSingleSearchAttributeConfig -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSingleSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#patch-search-attribute-config + source: | + $Name = "promotedMailAttribute" # String | Name of the extended search attribute configuration to patch. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Extended Search Attribute + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaSearchAttributeConfig -Name $Name -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaSearchAttributeConfig -Name $Name -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /segments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#create-segment + source: | + $Segment = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + } + "@ + + # Create Segment + + try { + $Result = ConvertFrom-JsonToSegment -Json $Segment + New-BetaSegment -Segment $Result + + # Below is a request that includes all optional parameters + # New-BetaSegment -Segment $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#delete-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. + + # Delete Segment by ID + + try { + Remove-BetaSegment -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSegment -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#get-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. + + # Get Segment by ID + + try { + Get-BetaSegment -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSegment -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /segments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#list-segments + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Segments + + try { + Get-BetaSegments + + # Below is a request that includes all optional parameters + # Get-BetaSegments -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegments" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#patch-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. + $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ + + + # Update Segment + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-BetaSegment -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaSegment -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#create-service-desk-integration + source: | + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + } + "@ + + # Create new Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + New-BetaServiceDeskIntegration -ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # New-BetaServiceDeskIntegration -ServiceDeskIntegrationDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#delete-service-desk-integration + source: | + $Id = "anId" # String | ID of Service Desk integration to delete + + # Delete a Service Desk integration + + try { + Remove-BetaServiceDeskIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to get + + # Get a Service Desk integration + + try { + Get-BetaServiceDeskIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-list + source: | + $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) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List existing Service Desk integrations + + try { + Get-BetaServiceDeskIntegrationList + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationList" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/templates/{scriptName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-template + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get + + # Service Desk integration template by scriptName + + try { + Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTemplate" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-types + source: | + + # List Service Desk integration types + + try { + Get-BetaServiceDeskIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTypes" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-status-check-details + source: | + + # Get the time check configuration + + try { + Get-BetaStatusCheckDetails + + # Below is a request that includes all optional parameters + # Get-BetaStatusCheckDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusCheckDetails" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#patch-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Service Desk Integration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaServiceDeskIntegration -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaServiceDeskIntegration -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#put-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + } + "@ + + # Update a Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + Send-BetaServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # Send-BetaServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#update-status-check-details + source: | + $QueuedCheckConfigDetails = @" + { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } + "@ + + # Update the time check configuration + + try { + $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails + Update-BetaStatusCheckDetails -QueuedCheckConfigDetails $Result + + # Below is a request that includes all optional parameters + # Update-BetaStatusCheckDetails -QueuedCheckConfigDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaStatusCheckDetails" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-status-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + + # Finds status of source usage + + try { + Get-BetaStatusBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaStatusBySourceId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusBySourceId" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-usages-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns source usage insights + + try { + Get-BetaUsagesBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaUsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesBySourceId" + Write-Host $_.ErrorDetails + } - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -12501,188 +12675,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceSchema" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-status-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - - # Finds status of source usage - - try { - Get-BetaStatusBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaStatusBySourceId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusBySourceId" - Write-Host $_.ErrorDetails - } -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-usages-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns source usage insights - - try { - Get-BetaUsagesBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaUsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesBySourceId" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#export-sp-config - source: | - $ExportPayload = @" - { - "description" : "Export Job 1 Test" - } - "@ - - # Initiates configuration objects export job - - try { - $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-BetaSpConfig -ExportPayload $Result - - # Below is a request that includes all optional parameters - # Export-BetaSpConfig -ExportPayload $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaSpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. - - # Download export job result. - - try { - Get-BetaSpConfigExport -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigExport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. - - # Get export job status - - try { - Get-BetaSpConfigExportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigExportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. - - # Download import job result - - try { - Get-BetaSpConfigImport -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigImport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. - - # Get import job status - - try { - Get-BetaSpConfigImportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigImportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#import-sp-config - source: | - $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. - $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) - $Options = @" - "@ - - # Initiates configuration objects import job - - try { - Import-BetaSpConfig -Data $Data - - # Below is a request that includes all optional parameters - # Import-BetaSpConfig -Data $Data -Preview $Preview -Options $Options - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#list-sp-config-objects - source: | - - # List Config Objects - - try { - Get-BetaSpConfigObjects - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigObjects - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigObjects" - Write-Host $_.ErrorDetails - } - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -13868,6 +13860,476 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaVendorConnectorMappings" Write-Host $_.ErrorDetails } +- path: /work-items/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#approve-approval-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Approve an Approval Item + + try { + Approve-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Approve-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-approve/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#approve-approval-items-in-bulk + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk approve Approval Items + + try { + Approve-BetaApprovalItemsInBulk -Id $Id + + # Below is a request that includes all optional parameters + # Approve-BetaApprovalItemsInBulk -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#complete-work-item + source: | + $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 + + try { + Complete-BetaWorkItem -Id $Id + + # Below is a request that includes all optional parameters + # Complete-BetaWorkItem -Id $Id -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaWorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#get-completed-work-items + source: | + $OwnerId = "2c91808571bcfcf80171c23e4b4221fc" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Completed Work Items + + try { + Get-BetaCompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-BetaCompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#get-count-completed-work-items + source: | + $OwnerId = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the work item owner. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # Count Completed Work Items + + try { + Get-BetaCountCompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-BetaCountCompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountCompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#get-count-work-items + source: | + $OwnerId = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the work item owner. (optional) + + # Count Work Items + + try { + Get-BetaCountWorkItems + + # Below is a request that includes all optional parameters + # Get-BetaCountWorkItems -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#get-work-item + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. + $OwnerId = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item owner. (optional) + + # Get a Work Item + + try { + Get-BetaWorkItem -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkItem -Id $Id -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#get-work-items-summary + source: | + $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) + + # Work Items Summary + + try { + Get-BetaWorkItemsSummary + + # Below is a request that includes all optional parameters + # Get-BetaWorkItemsSummary -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItemsSummary" + Write-Host $_.ErrorDetails + } +- path: /work-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#list-work-items + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) + + # List Work Items + + try { + Get-BetaWorkItems + + # Below is a request that includes all optional parameters + # Get-BetaWorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#reject-approval-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Reject an Approval Item + + try { + Deny-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Deny-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-reject/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#reject-approval-items-in-bulk + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk reject Approval Items + + try { + Deny-BetaApprovalItemsInBulk -Id $Id + + # Below is a request that includes all optional parameters + # Deny-BetaApprovalItemsInBulk -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#submit-account-selection + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName + + # Submit Account Selections + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Submit-BetaAccountSelection -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Submit-BetaAccountSelection -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaAccountSelection" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/forward + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#submit-forward-work-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $WorkItemForward = @" + { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } + "@ + + # Forward a Work Item + + try { + $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward + Submit-BetaForwardWorkItem -Id $Id -WorkItemForward $Result + + # Below is a request that includes all optional parameters + # Submit-BetaForwardWorkItem -Id $Id -WorkItemForward $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaForwardWorkItem" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#create-reassignment-configuration + source: | + $ConfigurationItemRequest = @" + { + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + } + "@ + + # Create a Reassignment Configuration + + try { + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + New-BetaReassignmentConfiguration -ConfigurationItemRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaReassignmentConfiguration -ConfigurationItemRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId}/{configType} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#delete-reassignment-configuration + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | + + # Delete Reassignment Configuration + + try { + Remove-BetaReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType + + # Below is a request that includes all optional parameters + # Remove-BetaReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId}/evaluate/{configType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-evaluate-reassignment-configuration + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type + $ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) + + $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ + + # Evaluate Reassignment Configuration + + try { + Get-BetaEvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType + + # Below is a request that includes all optional parameters + # Get-BetaEvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -ExclusionFilters $ExclusionFilters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEvaluateReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-reassignment-config-types + source: | + + # List Reassignment Config Types + + try { + Get-BetaReassignmentConfigTypes + + # Below is a request that includes all optional parameters + # Get-BetaReassignmentConfigTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigTypes" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-reassignment-configuration + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id + + # Get Reassignment Configuration + + try { + Get-BetaReassignmentConfiguration -IdentityId $IdentityId + + # Below is a request that includes all optional parameters + # Get-BetaReassignmentConfiguration -IdentityId $IdentityId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/tenant-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-tenant-config-configuration + source: | + + # Get Tenant-wide Reassignment Configuration settings + + try { + Get-BetaTenantConfigConfiguration + + # Below is a request that includes all optional parameters + # Get-BetaTenantConfigConfiguration + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenantConfigConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#list-reassignment-configurations + source: | + $Limit = 20 # Int32 | Max number of results to return. (optional) (default to 20) + $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) + + # List Reassignment Configurations + + try { + Get-BetaReassignmentConfigurations + + # Below is a request that includes all optional parameters + # Get-BetaReassignmentConfigurations -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigurations" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#put-reassignment-config + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigurationItemRequest = @" + { + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + } + "@ + + # Update Reassignment Configuration + + try { + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + Send-BetaReassignmentConfig -IdentityId $IdentityId -ConfigurationItemRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaReassignmentConfig -IdentityId $IdentityId -ConfigurationItemRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaReassignmentConfig" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/tenant-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#put-tenant-configuration + source: | + $TenantConfigurationRequest = @" + { + "configDetails" : { + "disabled" : true + } + } + "@ + + # Update Tenant-wide Reassignment Configuration settings + + try { + $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest + Send-BetaTenantConfiguration -TenantConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaTenantConfiguration -TenantConfigurationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTenantConfiguration" + Write-Host $_.ErrorDetails + } - path: /workflow-executions/{id}/cancel method: POST xCodeSample: @@ -14285,471 +14747,3 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/approve/{approvalItemId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#approve-approval-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - - # Approve an Approval Item - - try { - Approve-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - - # Below is a request that includes all optional parameters - # Approve-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/bulk-approve/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#approve-approval-items-in-bulk - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - - # Bulk approve Approval Items - - try { - Approve-BetaApprovalItemsInBulk -Id $Id - - # Below is a request that includes all optional parameters - # Approve-BetaApprovalItemsInBulk -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItemsInBulk" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#complete-work-item - source: | - $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 - - try { - Complete-BetaWorkItem -Id $Id - - # Below is a request that includes all optional parameters - # Complete-BetaWorkItem -Id $Id -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaWorkItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/forward - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#forward-work-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $WorkItemForward = @" - { - "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I'm going on vacation.", - "sendNotifications" : true - } - "@ - - # Forward a Work Item - - try { - $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward - Invoke-BetaForwardWorkItem -Id $Id -WorkItemForward $Result - - # Below is a request that includes all optional parameters - # Invoke-BetaForwardWorkItem -Id $Id -WorkItemForward $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardWorkItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/completed - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#get-completed-work-items - source: | - $OwnerId = "MyOwnerId" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Completed Work Items - - try { - Get-BetaCompletedWorkItems - - # Below is a request that includes all optional parameters - # Get-BetaCompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/completed/count - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#get-count-completed-work-items - source: | - $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) - - # Count Completed Work Items - - try { - Get-BetaCountCompletedWorkItems - - # Below is a request that includes all optional parameters - # Get-BetaCountCompletedWorkItems -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountCompletedWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/count - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#get-count-work-items - source: | - $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) - - # Count Work Items - - try { - Get-BetaCountWorkItems - - # Below is a request that includes all optional parameters - # Get-BetaCountWorkItems -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#get-work-item - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. - $OwnerId = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item owner. (optional) - - # Get a Work Item - - try { - Get-BetaWorkItem -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkItem -Id $Id -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#get-work-items-summary - source: | - $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) - - # Work Items Summary - - try { - Get-BetaWorkItemsSummary - - # Below is a request that includes all optional parameters - # Get-BetaWorkItemsSummary -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItemsSummary" - Write-Host $_.ErrorDetails - } -- path: /work-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#list-work-items - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) - - # List Work Items - - try { - Get-BetaWorkItems - - # Below is a request that includes all optional parameters - # Get-BetaWorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/reject/{approvalItemId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#reject-approval-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - - # Reject an Approval Item - - try { - Deny-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - - # Below is a request that includes all optional parameters - # Deny-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/bulk-reject/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#reject-approval-items-in-bulk - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - - # Bulk reject Approval Items - - try { - Deny-BetaApprovalItemsInBulk -Id $Id - - # Below is a request that includes all optional parameters - # Deny-BetaApprovalItemsInBulk -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItemsInBulk" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/submit-account-selection - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#submit-account-selection - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName - - # Submit Account Selections - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Submit-BetaAccountSelection -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Submit-BetaAccountSelection -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaAccountSelection" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#create-reassignment-configuration - source: | - $ConfigurationItemRequest = @" - { - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" - } - "@ - - # Create a Reassignment Configuration - - try { - $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - New-BetaReassignmentConfiguration -ConfigurationItemRequest $Result - - # Below is a request that includes all optional parameters - # New-BetaReassignmentConfiguration -ConfigurationItemRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaReassignmentConfiguration" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations/{identityId}/{configType} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#delete-reassignment-configuration - source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | - - # Delete Reassignment Configuration - - try { - Remove-BetaReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType - - # Below is a request that includes all optional parameters - # Remove-BetaReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaReassignmentConfiguration" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations/{identityId}/evaluate/{configType} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-evaluate-reassignment-configuration - source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type - $ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) - - $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ - - # Evaluate Reassignment Configuration - - try { - Get-BetaEvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType - - # Below is a request that includes all optional parameters - # Get-BetaEvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -ExclusionFilters $ExclusionFilters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEvaluateReassignmentConfiguration" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations/types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-reassignment-config-types - source: | - - # List Reassignment Config Types - - try { - Get-BetaReassignmentConfigTypes - - # Below is a request that includes all optional parameters - # Get-BetaReassignmentConfigTypes - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigTypes" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations/{identityId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-reassignment-configuration - source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id - - # Get Reassignment Configuration - - try { - Get-BetaReassignmentConfiguration -IdentityId $IdentityId - - # Below is a request that includes all optional parameters - # Get-BetaReassignmentConfiguration -IdentityId $IdentityId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfiguration" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations/tenant-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-tenant-config-configuration - source: | - - # Get Tenant-wide Reassignment Configuration settings - - try { - Get-BetaTenantConfigConfiguration - - # Below is a request that includes all optional parameters - # Get-BetaTenantConfigConfiguration - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenantConfigConfiguration" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#list-reassignment-configurations - source: | - $Limit = 20 # Int32 | Max number of results to return. (optional) (default to 20) - $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) - - # List Reassignment Configurations - - try { - Get-BetaReassignmentConfigurations - - # Below is a request that includes all optional parameters - # Get-BetaReassignmentConfigurations -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigurations" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations/{identityId} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#put-reassignment-config - source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $ConfigurationItemRequest = @" - { - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" - } - "@ - - # Update Reassignment Configuration - - try { - $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - Send-BetaReassignmentConfig -IdentityId $IdentityId -ConfigurationItemRequest $Result - - # Below is a request that includes all optional parameters - # Send-BetaReassignmentConfig -IdentityId $IdentityId -ConfigurationItemRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaReassignmentConfig" - Write-Host $_.ErrorDetails - } -- path: /reassignment-configurations/tenant-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#put-tenant-configuration - source: | - $TenantConfigurationRequest = @" - { - "configDetails" : { - "disabled" : true - } - } - "@ - - # Update Tenant-wide Reassignment Configuration settings - - try { - $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest - Send-BetaTenantConfiguration -TenantConfigurationRequest $Result - - # Below is a request that includes all optional parameters - # Send-BetaTenantConfiguration -TenantConfigurationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTenantConfiguration" - Write-Host $_.ErrorDetails - } diff --git a/static/code-examples/v2024/powershell_code_examples_overlay.yaml b/static/code-examples/v2024/powershell_code_examples_overlay.yaml index 9e4d84eea..888051ba1 100644 --- a/static/code-examples/v2024/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2024/powershell_code_examples_overlay.yaml @@ -747,9 +747,7 @@ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -777,9 +775,7 @@ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" } ] }, { "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", @@ -810,9 +806,7 @@ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -840,9 +834,7 @@ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" } ] } ] } @@ -1138,6 +1130,29 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountAggregationStatus" Write-Host $_.ErrorDetails } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/account-usages#get-usages-by-account-id + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + Get-V2024UsagesByAccountId -AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-V2024UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesByAccountId" + Write-Host $_.ErrorDetails + } - path: /accounts method: POST xCodeSample: @@ -1515,29 +1530,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Account" Write-Host $_.ErrorDetails } -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/account-usages#get-usages-by-account-id - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns account usage insights - - try { - Get-V2024UsagesByAccountId -AccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-V2024UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesByAccountId" - Write-Host $_.ErrorDetails - } - path: /discovered-applications method: GET xCodeSample: @@ -3080,6 +3072,95 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Campaign" Write-Host $_.ErrorDetails } +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-access-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Type = "ROLE" # String | The type of access review item to retrieve summaries for + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + + # Access Summaries + + try { + Get-V2024IdentityAccessSummaries -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessSummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-decision-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + + # Summary of Certification Decisions + + try { + Get-V2024IdentityDecisionSummary -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentityDecisionSummary -Id $Id -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityDecisionSummary" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Identity Summaries for Campaign Certification + + try { + Get-V2024IdentitySummaries -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID + + # Summary for Identity + + try { + Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummary" + Write-Host $_.ErrorDetails + } - path: /certification-tasks/{id} method: GET xCodeSample: @@ -3358,95 +3439,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024ReassignCertsAsync" Write-Host $_.ErrorDetails } -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-access-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Type = "ROLE" # String | The type of access review item to retrieve summaries for - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - - # Access Summaries - - try { - Get-V2024IdentityAccessSummaries -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-V2024IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessSummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-decision-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - - # Summary of Certification Decisions - - try { - Get-V2024IdentityDecisionSummary -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024IdentityDecisionSummary -Id $Id -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityDecisionSummary" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Identity Summaries for Campaign Certification - - try { - Get-V2024IdentitySummaries -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID - - # Summary for Identity - - try { - Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - - # Below is a request that includes all optional parameters - # Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummary" - Write-Host $_.ErrorDetails - } - path: /configuration-hub/deploys method: POST xCodeSample: @@ -8844,6 +8836,164 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024LifecycleStates" Write-Host $_.ErrorDetails } +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-duo-config + source: | + + # Configuration of Duo MFA method + + try { + Get-V2024MFADuoConfig + + # Below is a request that includes all optional parameters + # Get-V2024MFADuoConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-kba-config + source: | + $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + + # Configuration of KBA MFA method + + try { + Get-V2024MFAKbaConfig + + # Below is a request that includes all optional parameters + # Get-V2024MFAKbaConfig -AllLanguages $AllLanguages + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAKbaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-okta-config + source: | + + # Configuration of Okta MFA method + + try { + Get-V2024MFAOktaConfig + + # Below is a request that includes all optional parameters + # Get-V2024MFAOktaConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-duo-config + source: | + $MfaDuoConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Duo MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig + Set-V2024MFADuoConfig -MfaDuoConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2024MFADuoConfig -MfaDuoConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfakba-config + source: | + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + }"@ + + + # Set MFA KBA configuration + + try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Set-V2024MFAKBAConfig -KbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Set-V2024MFAKBAConfig -KbaAnswerRequestItem $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAKBAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-okta-config + source: | + $MfaOktaConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Okta MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig + Set-V2024MFAOktaConfig -MfaOktaConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2024MFAOktaConfig -MfaOktaConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#test-mfa-config + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + # MFA method's test configuration + + try { + Test-V2024MFAConfig -Method $Method + + # Below is a request that includes all optional parameters + # Test-V2024MFAConfig -Method $Method + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024MFAConfig" + Write-Host $_.ErrorDetails + } - path: /accounts/{id}/classify method: POST xCodeSample: @@ -9378,6 +9528,128 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClient" Write-Host $_.ErrorDetails } +- path: /managed-cluster-types + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#create-managed-cluster-type + source: | + $ManagedClusterType = @" + { + "managedProcessIds" : [ "someId", "someId2" ], + "pod" : "megapod-useast1", + "org" : "denali-cjh", + "id" : "aClusterTypeId", + "type" : "idn" + } + "@ + + # Create new Managed Cluster Type + + try { + $Result = ConvertFrom-JsonToManagedClusterType -Json $ManagedClusterType + New-V2024ManagedClusterType -ManagedClusterType $Result + + # Below is a request that includes all optional parameters + # New-V2024ManagedClusterType -ManagedClusterType $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#delete-managed-cluster-type + source: | + $Id = "aClusterTypeId" # String | The Managed Cluster Type ID + + # Delete a Managed Cluster Type + + try { + Remove-V2024ManagedClusterType -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ManagedClusterType -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#get-managed-cluster-type + source: | + $Id = "aClusterTypeId" # String | The Managed Cluster Type ID + + # Get a Managed Cluster Type + + try { + Get-V2024ManagedClusterType -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClusterType -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#get-managed-cluster-types + source: | + $Type = "IDN" # String | Type descriptor (optional) + $Pod = "megapod-useast1" # String | Pinned pod (or default) (optional) + $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 + + try { + Get-V2024ManagedClusterTypes + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClusterTypes -Type $Type -Pod $Pod -Org $Org -Offset $Offset -Limit $Limit + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusterTypes" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#update-managed-cluster-type + source: | + $Id = "aClusterTypeId" # String | The Managed Cluster Type ID + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Update a Managed Cluster Type + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024ManagedClusterType -Id $Id -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024ManagedClusterType -Id $Id -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClusterType" + Write-Host $_.ErrorDetails + } - path: /managed-clusters method: POST xCodeSample: @@ -9556,286 +9828,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedCluster" Write-Host $_.ErrorDetails } -- path: /managed-cluster-types - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#create-managed-cluster-type - source: | - $ManagedClusterType = @" - { - "managedProcessIds" : [ "someId", "someId2" ], - "pod" : "megapod-useast1", - "org" : "denali-cjh", - "id" : "aClusterTypeId", - "type" : "idn" - } - "@ - - # Create new Managed Cluster Type - - try { - $Result = ConvertFrom-JsonToManagedClusterType -Json $ManagedClusterType - New-V2024ManagedClusterType -ManagedClusterType $Result - - # Below is a request that includes all optional parameters - # New-V2024ManagedClusterType -ManagedClusterType $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#delete-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - - # Delete a Managed Cluster Type - - try { - Remove-V2024ManagedClusterType -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024ManagedClusterType -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#get-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - - # Get a Managed Cluster Type - - try { - Get-V2024ManagedClusterType -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024ManagedClusterType -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#get-managed-cluster-types - source: | - $Type = "IDN" # String | Type descriptor (optional) - $Pod = "megapod-useast1" # String | Pinned pod (or default) (optional) - $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 - - try { - Get-V2024ManagedClusterTypes - - # Below is a request that includes all optional parameters - # Get-V2024ManagedClusterTypes -Type $Type -Pod $Pod -Org $Org -Offset $Offset -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusterTypes" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#update-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Update a Managed Cluster Type - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2024ManagedClusterType -Id $Id -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2024ManagedClusterType -Id $Id -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /mfa/duo-web/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-duo-config - source: | - - # Configuration of Duo MFA method - - try { - Get-V2024MFADuoConfig - - # Below is a request that includes all optional parameters - # Get-V2024MFADuoConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFADuoConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/kba/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-kba-config - source: | - $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - - # Configuration of KBA MFA method - - try { - Get-V2024MFAKbaConfig - - # Below is a request that includes all optional parameters - # Get-V2024MFAKbaConfig -AllLanguages $AllLanguages - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAKbaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/okta-verify/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-okta-config - source: | - - # Configuration of Okta MFA method - - try { - Get-V2024MFAOktaConfig - - # Below is a request that includes all optional parameters - # Get-V2024MFAOktaConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAOktaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/duo-web/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-duo-config - source: | - $MfaDuoConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Duo MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig - Set-V2024MFADuoConfig -MfaDuoConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2024MFADuoConfig -MfaDuoConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFADuoConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/kba/config/answers - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfakba-config - source: | - $KbaAnswerRequestItem = @"{ - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" - }"@ - - - # Set MFA KBA configuration - - try { - $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Set-V2024MFAKBAConfig -KbaAnswerRequestItem $Result - - # Below is a request that includes all optional parameters - # Set-V2024MFAKBAConfig -KbaAnswerRequestItem $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAKBAConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/okta-verify/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-okta-config - source: | - $MfaOktaConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Okta MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig - Set-V2024MFAOktaConfig -MfaOktaConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2024MFAOktaConfig -MfaOktaConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAOktaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/{method}/test - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#test-mfa-config - source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - - # MFA method's test configuration - - try { - Test-V2024MFAConfig -Method $Method - - # Below is a request that includes all optional parameters - # Test-V2024MFAConfig -Method $Method - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024MFAConfig" - Write-Host $_.ErrorDetails - } - path: /multihosts method: POST xCodeSample: @@ -12981,6 +12973,954 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByQuery" Write-Host $_.ErrorDetails } +- path: /sim-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#create-sim-integration + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ + + # Create new SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#delete-sim-integration + source: | + $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 + + try { + Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integration + source: | + $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. + + try { + Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integrations + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List the existing SIM integrations. + + try { + Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegrations" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-before-provisioning-rule + source: | + $Id = "12345" # String | SIM integration id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Patch a SIM beforeProvisioningRule attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024BeforeProvisioningRule" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-sim-attributes + source: | + $Id = "12345" # String | SIM integration id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Patch a SIM attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SIMAttributes" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#put-sim-integration + source: | + $Id = "12345" # String | The id of the integration. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ + + # Update an existing SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#create-sod-policy + source: | + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Create SOD policy + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-V2024SodPolicy -SodPolicy $Result + + # Below is a request that includes all optional parameters + # New-V2024SodPolicy -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. + $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) + + # Delete SOD policy by ID + + try { + Remove-V2024SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024SodPolicy -Id $Id -Logical $Logical + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + + # Delete SOD policy schedule + + try { + Remove-V2024SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-custom-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. + + # Download custom violation report + + try { + Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + + # Below is a request that includes all optional parameters + # Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-default-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + + # Download violation report + + try { + Get-V2024DefaultViolationReport -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-V2024DefaultViolationReport -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-all-report-run-status + source: | + + # Get multi-report run task status + + try { + Get-V2024SodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-V2024SodAllReportRunStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodAllReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. + + # Get SOD policy by ID + + try { + Get-V2024SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. + + # Get SOD policy schedule + + try { + Get-V2024SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-run-status + source: | + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + + # Get violation report run status + + try { + Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-status + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. + + # Get SOD violation report status + + try { + Get-V2024SodViolationReportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SodViolationReportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#list-sod-policies + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + + # List SOD policies + + try { + Get-V2024SodPolicies + + # Below is a request that includes all optional parameters + # Get-V2024SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicies" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#patch-sod-policy + source: | + $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch SOD policy by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. + $SodPolicySchedule = @" + { + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } + "@ + + # Update SOD Policy schedule + + try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Update SOD policy by ID + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-V2024SodPolicy -Id $Id -SodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-V2024SodPolicy -Id $Id -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-evaluate-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Evaluate one policy by ID + + try { + Start-V2024EvaluateSodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024EvaluateSodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024EvaluateSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-all-policies-for-org + source: | + $MultiPolicyRequest = @" + { + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + } + "@ + + # Runs all policies for org + + try { + Start-V2024SodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-V2024SodAllPoliciesForOrg -MultiPolicyRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodAllPoliciesForOrg" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Runs SOD policy violation report + + try { + Start-V2024SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-predict-sod-violations + source: | + $IdentityWithNewAccess = @" + { + "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" + } ] + } + "@ + + # Predict SOD violations for identity. + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-V2024PredictSodViolations -IdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-V2024PredictSodViolations -IdentityWithNewAccess $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024PredictSodViolations" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-violation-check + source: | + $IdentityWithNewAccess1 = @" + {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} + "@ + + # Check SOD violations + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 + Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result + + # Below is a request that includes all optional parameters + # Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024ViolationCheck" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#export-sp-config + source: | + $ExportPayload = @" + { + "description" : "Export Job 1 Test" + } + "@ + + # Initiates configuration objects export job + + try { + $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload + Export-V2024SpConfig -ExportPayload $Result + + # Below is a request that includes all optional parameters + # Export-V2024SpConfig -ExportPayload $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024SpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. + + # Download export job result. + + try { + Get-V2024SpConfigExport -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigExport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. + + # Get export job status + + try { + Get-V2024SpConfigExportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigExportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. + + # Download import job result + + try { + Get-V2024SpConfigImport -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigImport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. + + # Get import job status + + try { + Get-V2024SpConfigImportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigImportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#import-sp-config + source: | + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) + $Options = @" + "@ + + # Initiates configuration objects import job + + try { + Import-V2024SpConfig -Data $Data + + # Below is a request that includes all optional parameters + # Import-V2024SpConfig -Data $Data -Preview $Preview -Options $Options + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024SpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#list-sp-config-objects + source: | + + # List Config Objects + + try { + Get-V2024SpConfigObjects + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigObjects + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigObjects" + Write-Host $_.ErrorDetails + } - path: /saved-searches method: POST xCodeSample: @@ -14347,812 +15287,46 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024StatusCheckDetails" Write-Host $_.ErrorDetails } -- path: /sim-integrations - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#create-sim-integration - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SimIntegrationDetails = @" - { - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - } - "@ - - # Create new SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#delete-sim-integration - source: | - $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 - - try { - Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} +- path: /source-usages/{sourceId}/status method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integration + label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-status-by-source-id source: | - $Id = "12345" # String | The id of the integration. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - # Get a SIM integration details. + # Finds status of source usage try { - Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2024StatusBySourceId -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2024StatusBySourceId -SourceId $SourceId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusBySourceId" Write-Host $_.ErrorDetails } -- path: /sim-integrations +- path: /source-usages/{sourceId}/summaries method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integrations - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List the existing SIM integrations. - - try { - Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegrations" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-before-provisioning-rule - source: | - $Id = "12345" # String | SIM integration id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Patch a SIM beforeProvisioningRule attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024BeforeProvisioningRule" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-sim-attributes - source: | - $Id = "12345" # String | SIM integration id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Patch a SIM attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SIMAttributes" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#put-sim-integration - source: | - $Id = "12345" # String | The id of the integration. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SimIntegrationDetails = @" - { - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - } - "@ - - # Update an existing SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#create-sod-policy - source: | - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Create SOD policy - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-V2024SodPolicy -SodPolicy $Result - - # Below is a request that includes all optional parameters - # New-V2024SodPolicy -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. - $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) - - # Delete SOD policy by ID - - try { - Remove-V2024SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024SodPolicy -Id $Id -Logical $Logical - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - - # Delete SOD policy schedule - - try { - Remove-V2024SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-custom-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - $FileName = "custom-name" # String | Custom Name for the file. - - # Download custom violation report - - try { - Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - - # Below is a request that includes all optional parameters - # Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-default-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - - # Download violation report - - try { - Get-V2024DefaultViolationReport -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-V2024DefaultViolationReport -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-all-report-run-status - source: | - - # Get multi-report run task status - - try { - Get-V2024SodAllReportRunStatus - - # Below is a request that includes all optional parameters - # Get-V2024SodAllReportRunStatus - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodAllReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. - - # Get SOD policy by ID - - try { - Get-V2024SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. - - # Get SOD policy schedule - - try { - Get-V2024SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-run-status - source: | - $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. - - # Get violation report run status - - try { - Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-status - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. - - # Get SOD violation report status - - try { - Get-V2024SodViolationReportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SodViolationReportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#list-sod-policies + label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-usages-by-source-id source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "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) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - # List SOD policies + # Returns source usage insights try { - Get-V2024SodPolicies + Get-V2024UsagesBySourceId -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-V2024SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + # Get-V2024UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicies" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#patch-sod-policy - source: | - $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch SOD policy by ID - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. - $SodPolicySchedule = @" - { - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - } - "@ - - # Update SOD Policy schedule - - try { - $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result - - # Below is a request that includes all optional parameters - # Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Update SOD policy by ID - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-V2024SodPolicy -Id $Id -SodPolicy $Result - - # Below is a request that includes all optional parameters - # Send-V2024SodPolicy -Id $Id -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-evaluate-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Evaluate one policy by ID - - try { - Start-V2024EvaluateSodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2024EvaluateSodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024EvaluateSodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-all-policies-for-org - source: | - $MultiPolicyRequest = @" - { - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - } - "@ - - # Runs all policies for org - - try { - Start-V2024SodAllPoliciesForOrg - - # Below is a request that includes all optional parameters - # Start-V2024SodAllPoliciesForOrg -MultiPolicyRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodAllPoliciesForOrg" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Runs SOD policy violation report - - try { - Start-V2024SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2024SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-predict-sod-violations - source: | - $IdentityWithNewAccess = @" - { - "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" - } ] - } - "@ - - # Predict SOD violations for identity. - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-V2024PredictSodViolations -IdentityWithNewAccess $Result - - # Below is a request that includes all optional parameters - # Start-V2024PredictSodViolations -IdentityWithNewAccess $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024PredictSodViolations" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-violation-check - source: | - $IdentityWithNewAccess1 = @" - {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} - "@ - - # Check SOD violations - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 - Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result - - # Below is a request that includes all optional parameters - # Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024ViolationCheck" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesBySourceId" Write-Host $_.ErrorDetails } - path: /sources/{sourceId}/provisioning-policies @@ -16630,188 +16804,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchema" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-status-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - - # Finds status of source usage - - try { - Get-V2024StatusBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2024StatusBySourceId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusBySourceId" - Write-Host $_.ErrorDetails - } -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-usages-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns source usage insights - - try { - Get-V2024UsagesBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2024UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesBySourceId" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#export-sp-config - source: | - $ExportPayload = @" - { - "description" : "Export Job 1 Test" - } - "@ - - # Initiates configuration objects export job - - try { - $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-V2024SpConfig -ExportPayload $Result - - # Below is a request that includes all optional parameters - # Export-V2024SpConfig -ExportPayload $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024SpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. - - # Download export job result. - - try { - Get-V2024SpConfigExport -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigExport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. - - # Get export job status - - try { - Get-V2024SpConfigExportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigExportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. - - # Download import job result - - try { - Get-V2024SpConfigImport -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigImport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. - - # Get import job status - - try { - Get-V2024SpConfigImportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigImportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#import-sp-config - source: | - $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. - $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) - $Options = @" - "@ - - # Initiates configuration objects import job - - try { - Import-V2024SpConfig -Data $Data - - # Below is a request that includes all optional parameters - # Import-V2024SpConfig -Data $Data -Preview $Preview -Options $Options - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024SpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#list-sp-config-objects - source: | - - # List Config Objects - - try { - Get-V2024SpConfigObjects - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigObjects - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigObjects" - Write-Host $_.ErrorDetails - } - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -17963,418 +17955,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024VendorConnectorMappings" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#cancel-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - - # Cancel Workflow Execution by ID - - try { - Suspend-V2024WorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Suspend-V2024WorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024WorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $CreateExternalExecuteWorkflowRequest = @" - - "@ - - # Execute Workflow via External Trigger - - try { - New-V2024ExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # New-V2024ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow - source: | - $CreateWorkflowRequest = @" - {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} - "@ - - # Create Workflow - - try { - $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-V2024Workflow -CreateWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # New-V2024Workflow -CreateWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow-external-trigger - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Generate External Trigger OAuth Client - - try { - New-V2024WorkflowExternalTrigger -Id $Id - - # Below is a request that includes all optional parameters - # New-V2024WorkflowExternalTrigger -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024WorkflowExternalTrigger" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#delete-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - - # Delete Workflow By Id - - try { - Remove-V2024Workflow -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024Workflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Get Workflow By Id - - try { - Get-V2024Workflow -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024Workflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - - # Get Workflow Execution - - try { - Get-V2024WorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution-history - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - - # Get Workflow Execution History - - try { - Get-V2024WorkflowExecutionHistory -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecutionHistory -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutionHistory" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-executions - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - - # List Workflow Executions - - try { - Get-V2024WorkflowExecutions -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-complete-workflow-library - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Complete Workflow Library - - try { - Get-V2024CompleteWorkflowLibrary - - # Below is a request that includes all optional parameters - # Get-V2024CompleteWorkflowLibrary -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompleteWorkflowLibrary" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-actions - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Actions - - try { - Get-V2024WorkflowLibraryActions - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryActions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-operators - source: | - - # List Workflow Library Operators - - try { - Get-V2024WorkflowLibraryOperators - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryOperators - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryOperators" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-triggers - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Triggers - - try { - Get-V2024WorkflowLibraryTriggers - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryTriggers" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflows - source: | - - # List Workflows - - try { - Get-V2024Workflows - - # Below is a request that includes all optional parameters - # Get-V2024Workflows - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflows" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#patch-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Workflow - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Workflow -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024Workflow -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#put-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $WorkflowBody = @" - { - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "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", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - } - "@ - - # Update Workflow - - try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Send-V2024Workflow -Id $Id -WorkflowBody $Result - - # Below is a request that includes all optional parameters - # Send-V2024Workflow -Id $Id -WorkflowBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestExternalExecuteWorkflowRequest = @" - - "@ - - # Test Workflow via External Trigger - - try { - Test-V2024ExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Test-V2024ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestWorkflowRequest = @" - {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} - "@ - - # Test Workflow By Id - - try { - $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-V2024Workflow -Id $Id -TestWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # Test-V2024Workflow -Id $Id -TestWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024Workflow" - Write-Host $_.ErrorDetails - } - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -18851,3 +18431,415 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TenantConfiguration" Write-Host $_.ErrorDetails } +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#cancel-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + + # Cancel Workflow Execution by ID + + try { + Suspend-V2024WorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Suspend-V2024WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $CreateExternalExecuteWorkflowRequest = @" + + "@ + + # Execute Workflow via External Trigger + + try { + New-V2024ExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # New-V2024ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow + source: | + $CreateWorkflowRequest = @" + {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} + "@ + + # Create Workflow + + try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-V2024Workflow -CreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024Workflow -CreateWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow-external-trigger + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Generate External Trigger OAuth Client + + try { + New-V2024WorkflowExternalTrigger -Id $Id + + # Below is a request that includes all optional parameters + # New-V2024WorkflowExternalTrigger -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024WorkflowExternalTrigger" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#delete-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + + # Delete Workflow By Id + + try { + Remove-V2024Workflow -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Get Workflow By Id + + try { + Get-V2024Workflow -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + + # Get Workflow Execution + + try { + Get-V2024WorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution-history + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + + # Get Workflow Execution History + + try { + Get-V2024WorkflowExecutionHistory -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecutionHistory -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutionHistory" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-executions + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + # List Workflow Executions + + try { + Get-V2024WorkflowExecutions -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-complete-workflow-library + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Complete Workflow Library + + try { + Get-V2024CompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-V2024CompleteWorkflowLibrary -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompleteWorkflowLibrary" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-actions + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Actions + + try { + Get-V2024WorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryActions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-operators + source: | + + # List Workflow Library Operators + + try { + Get-V2024WorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryOperators + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryOperators" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-triggers + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Triggers + + try { + Get-V2024WorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryTriggers" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflows + source: | + + # List Workflows + + try { + Get-V2024Workflows + + # Below is a request that includes all optional parameters + # Get-V2024Workflows + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflows" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#patch-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Workflow + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Workflow -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Workflow -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#put-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $WorkflowBody = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "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", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ + + # Update Workflow + + try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-V2024Workflow -Id $Id -WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Send-V2024Workflow -Id $Id -WorkflowBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + + "@ + + # Test Workflow via External Trigger + + try { + Test-V2024ExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Test-V2024ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestWorkflowRequest = @" + {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} + "@ + + # Test Workflow By Id + + try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-V2024Workflow -Id $Id -TestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-V2024Workflow -Id $Id -TestWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024Workflow" + Write-Host $_.ErrorDetails + } diff --git a/static/code-examples/v2025/powershell_code_examples_overlay.yaml b/static/code-examples/v2025/powershell_code_examples_overlay.yaml index decf8ccc2..0d4436f7d 100644 --- a/static/code-examples/v2025/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2025/powershell_code_examples_overlay.yaml @@ -670,7 +670,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -679,7 +681,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -688,7 +692,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -697,7 +703,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -706,7 +714,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" } ], "requestedForWithRequestedItems" : [ { "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", @@ -737,9 +747,7 @@ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -767,9 +775,7 @@ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" } ] }, { "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", @@ -800,9 +806,7 @@ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -830,9 +834,7 @@ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" } ] } ] } @@ -1149,6 +1151,29 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccountAggregationStatus" Write-Host $_.ErrorDetails } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/account-usages#get-usages-by-account-id + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + Get-V2025UsagesByAccountId -AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-V2025UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UsagesByAccountId" + Write-Host $_.ErrorDetails + } - path: /accounts method: POST xCodeSample: @@ -1526,29 +1551,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Account" Write-Host $_.ErrorDetails } -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/account-usages#get-usages-by-account-id - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns account usage insights - - try { - Get-V2025UsagesByAccountId -AccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-V2025UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UsagesByAccountId" - Write-Host $_.ErrorDetails - } - path: /discovered-applications method: GET xCodeSample: @@ -3091,6 +3093,95 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Campaign" Write-Host $_.ErrorDetails } +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-access-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Type = "ROLE" # String | The type of access review item to retrieve summaries for + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + + # Access Summaries + + try { + Get-V2025IdentityAccessSummaries -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-V2025IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAccessSummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-decision-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + + # Summary of Certification Decisions + + try { + Get-V2025IdentityDecisionSummary -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025IdentityDecisionSummary -Id $Id -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityDecisionSummary" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Identity Summaries for Campaign Certification + + try { + Get-V2025IdentitySummaries -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID + + # Summary for Identity + + try { + Get-V2025IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + + # Below is a request that includes all optional parameters + # Get-V2025IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySummary" + Write-Host $_.ErrorDetails + } - path: /certification-tasks/{id} method: GET xCodeSample: @@ -3369,95 +3460,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025ReassignCertsAsync" Write-Host $_.ErrorDetails } -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-access-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Type = "ROLE" # String | The type of access review item to retrieve summaries for - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - - # Access Summaries - - try { - Get-V2025IdentityAccessSummaries -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-V2025IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAccessSummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-decision-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - - # Summary of Certification Decisions - - try { - Get-V2025IdentityDecisionSummary -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025IdentityDecisionSummary -Id $Id -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityDecisionSummary" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Identity Summaries for Campaign Certification - - try { - Get-V2025IdentitySummaries -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID - - # Summary for Identity - - try { - Get-V2025IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - - # Below is a request that includes all optional parameters - # Get-V2025IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySummary" - Write-Host $_.ErrorDetails - } - path: /configuration-hub/deploys method: POST xCodeSample: @@ -8855,6 +8857,164 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025LifecycleStates" Write-Host $_.ErrorDetails } +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-duo-config + source: | + + # Configuration of Duo MFA method + + try { + Get-V2025MFADuoConfig + + # Below is a request that includes all optional parameters + # Get-V2025MFADuoConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-kba-config + source: | + $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + + # Configuration of KBA MFA method + + try { + Get-V2025MFAKbaConfig + + # Below is a request that includes all optional parameters + # Get-V2025MFAKbaConfig -AllLanguages $AllLanguages + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFAKbaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-okta-config + source: | + + # Configuration of Okta MFA method + + try { + Get-V2025MFAOktaConfig + + # Below is a request that includes all optional parameters + # Get-V2025MFAOktaConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfa-duo-config + source: | + $MfaDuoConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Duo MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig + Set-V2025MFADuoConfig -MfaDuoConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2025MFADuoConfig -MfaDuoConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfakba-config + source: | + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + }"@ + + + # Set MFA KBA configuration + + try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Set-V2025MFAKBAConfig -KbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Set-V2025MFAKBAConfig -KbaAnswerRequestItem $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFAKBAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfa-okta-config + source: | + $MfaOktaConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Okta MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig + Set-V2025MFAOktaConfig -MfaOktaConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2025MFAOktaConfig -MfaOktaConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#test-mfa-config + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + # MFA method's test configuration + + try { + Test-V2025MFAConfig -Method $Method + + # Below is a request that includes all optional parameters + # Test-V2025MFAConfig -Method $Method + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025MFAConfig" + Write-Host $_.ErrorDetails + } - path: /machine-accounts/{id} method: GET xCodeSample: @@ -9176,6 +9336,128 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ManagedClient" Write-Host $_.ErrorDetails } +- path: /managed-cluster-types + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#create-managed-cluster-type + source: | + $ManagedClusterType = @" + { + "managedProcessIds" : [ "someId", "someId2" ], + "pod" : "megapod-useast1", + "org" : "denali-cjh", + "id" : "aClusterTypeId", + "type" : "idn" + } + "@ + + # Create new Managed Cluster Type + + try { + $Result = ConvertFrom-JsonToManagedClusterType -Json $ManagedClusterType + New-V2025ManagedClusterType -ManagedClusterType $Result + + # Below is a request that includes all optional parameters + # New-V2025ManagedClusterType -ManagedClusterType $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#delete-managed-cluster-type + source: | + $Id = "aClusterTypeId" # String | The Managed Cluster Type ID + + # Delete a Managed Cluster Type + + try { + Remove-V2025ManagedClusterType -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025ManagedClusterType -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#get-managed-cluster-type + source: | + $Id = "aClusterTypeId" # String | The Managed Cluster Type ID + + # Get a Managed Cluster Type + + try { + Get-V2025ManagedClusterType -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025ManagedClusterType -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#get-managed-cluster-types + source: | + $Type = "IDN" # String | Type descriptor (optional) + $Pod = "megapod-useast1" # String | Pinned pod (or default) (optional) + $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) + + # List Managed Cluster Types + + try { + Get-V2025ManagedClusterTypes + + # Below is a request that includes all optional parameters + # Get-V2025ManagedClusterTypes -Type $Type -Pod $Pod -Org $Org -Offset $Offset -Limit $Limit + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClusterTypes" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#update-managed-cluster-type + source: | + $Id = "aClusterTypeId" # String | The Managed Cluster Type ID + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Update a Managed Cluster Type + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2025ManagedClusterType -Id $Id -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2025ManagedClusterType -Id $Id -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ManagedClusterType" + Write-Host $_.ErrorDetails + } - path: /managed-clusters method: POST xCodeSample: @@ -9354,286 +9636,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ManagedCluster" Write-Host $_.ErrorDetails } -- path: /managed-cluster-types - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#create-managed-cluster-type - source: | - $ManagedClusterType = @" - { - "managedProcessIds" : [ "someId", "someId2" ], - "pod" : "megapod-useast1", - "org" : "denali-cjh", - "id" : "aClusterTypeId", - "type" : "idn" - } - "@ - - # Create new Managed Cluster Type - - try { - $Result = ConvertFrom-JsonToManagedClusterType -Json $ManagedClusterType - New-V2025ManagedClusterType -ManagedClusterType $Result - - # Below is a request that includes all optional parameters - # New-V2025ManagedClusterType -ManagedClusterType $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#delete-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - - # Delete a Managed Cluster Type - - try { - Remove-V2025ManagedClusterType -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025ManagedClusterType -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#get-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - - # Get a Managed Cluster Type - - try { - Get-V2025ManagedClusterType -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ManagedClusterType -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#get-managed-cluster-types - source: | - $Type = "IDN" # String | Type descriptor (optional) - $Pod = "megapod-useast1" # String | Pinned pod (or default) (optional) - $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) - - # List Managed Cluster Types - - try { - Get-V2025ManagedClusterTypes - - # Below is a request that includes all optional parameters - # Get-V2025ManagedClusterTypes -Type $Type -Pod $Pod -Org $Org -Offset $Offset -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClusterTypes" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#update-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Update a Managed Cluster Type - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2025ManagedClusterType -Id $Id -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2025ManagedClusterType -Id $Id -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /mfa/duo-web/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-duo-config - source: | - - # Configuration of Duo MFA method - - try { - Get-V2025MFADuoConfig - - # Below is a request that includes all optional parameters - # Get-V2025MFADuoConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFADuoConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/kba/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-kba-config - source: | - $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - - # Configuration of KBA MFA method - - try { - Get-V2025MFAKbaConfig - - # Below is a request that includes all optional parameters - # Get-V2025MFAKbaConfig -AllLanguages $AllLanguages - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFAKbaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/okta-verify/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-okta-config - source: | - - # Configuration of Okta MFA method - - try { - Get-V2025MFAOktaConfig - - # Below is a request that includes all optional parameters - # Get-V2025MFAOktaConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFAOktaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/duo-web/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfa-duo-config - source: | - $MfaDuoConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Duo MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig - Set-V2025MFADuoConfig -MfaDuoConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2025MFADuoConfig -MfaDuoConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFADuoConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/kba/config/answers - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfakba-config - source: | - $KbaAnswerRequestItem = @"{ - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" - }"@ - - - # Set MFA KBA configuration - - try { - $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Set-V2025MFAKBAConfig -KbaAnswerRequestItem $Result - - # Below is a request that includes all optional parameters - # Set-V2025MFAKBAConfig -KbaAnswerRequestItem $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFAKBAConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/okta-verify/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfa-okta-config - source: | - $MfaOktaConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Okta MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig - Set-V2025MFAOktaConfig -MfaOktaConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2025MFAOktaConfig -MfaOktaConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFAOktaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/{method}/test - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#test-mfa-config - source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - - # MFA method's test configuration - - try { - Test-V2025MFAConfig -Method $Method - - # Below is a request that includes all optional parameters - # Test-V2025MFAConfig -Method $Method - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025MFAConfig" - Write-Host $_.ErrorDetails - } - path: /multihosts method: POST xCodeSample: @@ -12779,6 +12781,954 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RolesMetadataByQuery" Write-Host $_.ErrorDetails } +- path: /sim-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#create-sim-integration + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ + + # Create new SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + New-V2025SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # New-V2025SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#delete-sim-integration + source: | + $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 + + try { + Remove-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#get-sim-integration + source: | + $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. + + try { + Get-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#get-sim-integrations + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List the existing SIM integrations. + + try { + Get-V2025SIMIntegrations -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025SIMIntegrations -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SIMIntegrations" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#patch-before-provisioning-rule + source: | + $Id = "12345" # String | SIM integration id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Patch a SIM beforeProvisioningRule attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2025BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2025BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025BeforeProvisioningRule" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#patch-sim-attributes + source: | + $Id = "12345" # String | SIM integration id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Patch a SIM attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2025SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2025SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SIMAttributes" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#put-sim-integration + source: | + $Id = "12345" # String | The id of the integration. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ + + # Update an existing SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + Send-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # Send-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#create-sod-policy + source: | + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Create SOD policy + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-V2025SodPolicy -SodPolicy $Result + + # Below is a request that includes all optional parameters + # New-V2025SodPolicy -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#delete-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. + $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) + + # Delete SOD policy by ID + + try { + Remove-V2025SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025SodPolicy -Id $Id -Logical $Logical + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#delete-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + + # Delete SOD policy schedule + + try { + Remove-V2025SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-custom-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. + + # Download custom violation report + + try { + Get-V2025CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + + # Below is a request that includes all optional parameters + # Get-V2025CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CustomViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-default-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + + # Download violation report + + try { + Get-V2025DefaultViolationReport -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-V2025DefaultViolationReport -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DefaultViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-all-report-run-status + source: | + + # Get multi-report run task status + + try { + Get-V2025SodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-V2025SodAllReportRunStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodAllReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. + + # Get SOD policy by ID + + try { + Get-V2025SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. + + # Get SOD policy schedule + + try { + Get-V2025SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-violation-report-run-status + source: | + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + + # Get violation report run status + + try { + Get-V2025SodViolationReportRunStatus -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-V2025SodViolationReportRunStatus -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodViolationReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-violation-report-status + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. + + # Get SOD violation report status + + try { + Get-V2025SodViolationReportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SodViolationReportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodViolationReportStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#list-sod-policies + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + + # List SOD policies + + try { + Get-V2025SodPolicies + + # Below is a request that includes all optional parameters + # Get-V2025SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicies" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#patch-sod-policy + source: | + $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch SOD policy by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025SodPolicy -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025SodPolicy -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#put-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. + $SodPolicySchedule = @" + { + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } + "@ + + # Update SOD Policy schedule + + try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-V2025PolicySchedule -Id $Id -SodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-V2025PolicySchedule -Id $Id -SodPolicySchedule $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025PolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#put-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Update SOD policy by ID + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-V2025SodPolicy -Id $Id -SodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-V2025SodPolicy -Id $Id -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-evaluate-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Evaluate one policy by ID + + try { + Start-V2025EvaluateSodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2025EvaluateSodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025EvaluateSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-sod-all-policies-for-org + source: | + $MultiPolicyRequest = @" + { + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + } + "@ + + # Runs all policies for org + + try { + Start-V2025SodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-V2025SodAllPoliciesForOrg -MultiPolicyRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025SodAllPoliciesForOrg" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Runs SOD policy violation report + + try { + Start-V2025SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2025SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-violations#start-predict-sod-violations + source: | + $IdentityWithNewAccess = @" + { + "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" + } ] + } + "@ + + # Predict SOD violations for identity. + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-V2025PredictSodViolations -IdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-V2025PredictSodViolations -IdentityWithNewAccess $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025PredictSodViolations" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-violations#start-violation-check + source: | + $IdentityWithNewAccess1 = @" + {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} + "@ + + # Check SOD violations + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 + Start-V2025ViolationCheck -IdentityWithNewAccess1 $Result + + # Below is a request that includes all optional parameters + # Start-V2025ViolationCheck -IdentityWithNewAccess1 $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025ViolationCheck" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#export-sp-config + source: | + $ExportPayload = @" + { + "description" : "Export Job 1 Test" + } + "@ + + # Initiates configuration objects export job + + try { + $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload + Export-V2025SpConfig -ExportPayload $Result + + # Below is a request that includes all optional parameters + # Export-V2025SpConfig -ExportPayload $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025SpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-export + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. + + # Download export job result. + + try { + Get-V2025SpConfigExport -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SpConfigExport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigExport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-export-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. + + # Get export job status + + try { + Get-V2025SpConfigExportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SpConfigExportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigExportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-import + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. + + # Download import job result + + try { + Get-V2025SpConfigImport -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SpConfigImport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigImport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-import-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. + + # Get import job status + + try { + Get-V2025SpConfigImportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SpConfigImportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigImportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#import-sp-config + source: | + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) + $Options = @" + "@ + + # Initiates configuration objects import job + + try { + Import-V2025SpConfig -Data $Data + + # Below is a request that includes all optional parameters + # Import-V2025SpConfig -Data $Data -Preview $Preview -Options $Options + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025SpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#list-sp-config-objects + source: | + + # List Config Objects + + try { + Get-V2025SpConfigObjects + + # Below is a request that includes all optional parameters + # Get-V2025SpConfigObjects + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigObjects" + Write-Host $_.ErrorDetails + } - path: /saved-searches method: POST xCodeSample: @@ -14145,812 +15095,46 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025StatusCheckDetails" Write-Host $_.ErrorDetails } -- path: /sim-integrations - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#create-sim-integration - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SimIntegrationDetails = @" - { - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - } - "@ - - # Create new SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - New-V2025SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # New-V2025SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#delete-sim-integration - source: | - $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 - - try { - Remove-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} +- path: /source-usages/{sourceId}/status method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#get-sim-integration + label: SDK_tools/sdk/powershell/v2025/methods/source-usages#get-status-by-source-id source: | - $Id = "12345" # String | The id of the integration. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - # Get a SIM integration details. + # Finds status of source usage try { - Get-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025StatusBySourceId -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2025StatusBySourceId -SourceId $SourceId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SIMIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025StatusBySourceId" Write-Host $_.ErrorDetails } -- path: /sim-integrations +- path: /source-usages/{sourceId}/summaries method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#get-sim-integrations - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List the existing SIM integrations. - - try { - Get-V2025SIMIntegrations -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SIMIntegrations -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SIMIntegrations" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#patch-before-provisioning-rule - source: | - $Id = "12345" # String | SIM integration id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Patch a SIM beforeProvisioningRule attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2025BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2025BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025BeforeProvisioningRule" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#patch-sim-attributes - source: | - $Id = "12345" # String | SIM integration id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Patch a SIM attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2025SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2025SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SIMAttributes" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#put-sim-integration - source: | - $Id = "12345" # String | The id of the integration. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SimIntegrationDetails = @" - { - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - } - "@ - - # Update an existing SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - Send-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # Send-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#create-sod-policy - source: | - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Create SOD policy - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-V2025SodPolicy -SodPolicy $Result - - # Below is a request that includes all optional parameters - # New-V2025SodPolicy -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#delete-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. - $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) - - # Delete SOD policy by ID - - try { - Remove-V2025SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025SodPolicy -Id $Id -Logical $Logical - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#delete-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - - # Delete SOD policy schedule - - try { - Remove-V2025SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-custom-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - $FileName = "custom-name" # String | Custom Name for the file. - - # Download custom violation report - - try { - Get-V2025CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - - # Below is a request that includes all optional parameters - # Get-V2025CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CustomViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-default-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - - # Download violation report - - try { - Get-V2025DefaultViolationReport -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-V2025DefaultViolationReport -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DefaultViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-all-report-run-status - source: | - - # Get multi-report run task status - - try { - Get-V2025SodAllReportRunStatus - - # Below is a request that includes all optional parameters - # Get-V2025SodAllReportRunStatus - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodAllReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. - - # Get SOD policy by ID - - try { - Get-V2025SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. - - # Get SOD policy schedule - - try { - Get-V2025SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-violation-report-run-status - source: | - $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. - - # Get violation report run status - - try { - Get-V2025SodViolationReportRunStatus -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-V2025SodViolationReportRunStatus -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodViolationReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-violation-report-status - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. - - # Get SOD violation report status - - try { - Get-V2025SodViolationReportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SodViolationReportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodViolationReportStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#list-sod-policies + label: SDK_tools/sdk/powershell/v2025/methods/source-usages#get-usages-by-source-id source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "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) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - # List SOD policies + # Returns source usage insights try { - Get-V2025SodPolicies + Get-V2025UsagesBySourceId -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-V2025SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + # Get-V2025UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicies" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#patch-sod-policy - source: | - $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch SOD policy by ID - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025SodPolicy -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025SodPolicy -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#put-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. - $SodPolicySchedule = @" - { - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - } - "@ - - # Update SOD Policy schedule - - try { - $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-V2025PolicySchedule -Id $Id -SodPolicySchedule $Result - - # Below is a request that includes all optional parameters - # Send-V2025PolicySchedule -Id $Id -SodPolicySchedule $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025PolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#put-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Update SOD policy by ID - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-V2025SodPolicy -Id $Id -SodPolicy $Result - - # Below is a request that includes all optional parameters - # Send-V2025SodPolicy -Id $Id -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-evaluate-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Evaluate one policy by ID - - try { - Start-V2025EvaluateSodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2025EvaluateSodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025EvaluateSodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-sod-all-policies-for-org - source: | - $MultiPolicyRequest = @" - { - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - } - "@ - - # Runs all policies for org - - try { - Start-V2025SodAllPoliciesForOrg - - # Below is a request that includes all optional parameters - # Start-V2025SodAllPoliciesForOrg -MultiPolicyRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025SodAllPoliciesForOrg" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Runs SOD policy violation report - - try { - Start-V2025SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2025SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-violations#start-predict-sod-violations - source: | - $IdentityWithNewAccess = @" - { - "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" - } ] - } - "@ - - # Predict SOD violations for identity. - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-V2025PredictSodViolations -IdentityWithNewAccess $Result - - # Below is a request that includes all optional parameters - # Start-V2025PredictSodViolations -IdentityWithNewAccess $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025PredictSodViolations" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-violations#start-violation-check - source: | - $IdentityWithNewAccess1 = @" - {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} - "@ - - # Check SOD violations - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 - Start-V2025ViolationCheck -IdentityWithNewAccess1 $Result - - # Below is a request that includes all optional parameters - # Start-V2025ViolationCheck -IdentityWithNewAccess1 $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025ViolationCheck" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UsagesBySourceId" Write-Host $_.ErrorDetails } - path: /sources/{sourceId}/provisioning-policies @@ -16427,188 +16611,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceSchema" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/source-usages#get-status-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - - # Finds status of source usage - - try { - Get-V2025StatusBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025StatusBySourceId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025StatusBySourceId" - Write-Host $_.ErrorDetails - } -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/source-usages#get-usages-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns source usage insights - - try { - Get-V2025UsagesBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-V2025UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UsagesBySourceId" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#export-sp-config - source: | - $ExportPayload = @" - { - "description" : "Export Job 1 Test" - } - "@ - - # Initiates configuration objects export job - - try { - $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-V2025SpConfig -ExportPayload $Result - - # Below is a request that includes all optional parameters - # Export-V2025SpConfig -ExportPayload $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025SpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-export - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. - - # Download export job result. - - try { - Get-V2025SpConfigExport -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigExport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigExport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-export-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. - - # Get export job status - - try { - Get-V2025SpConfigExportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigExportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigExportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-import - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. - - # Download import job result - - try { - Get-V2025SpConfigImport -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigImport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigImport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-import-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. - - # Get import job status - - try { - Get-V2025SpConfigImportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigImportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigImportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#import-sp-config - source: | - $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. - $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) - $Options = @" - "@ - - # Initiates configuration objects import job - - try { - Import-V2025SpConfig -Data $Data - - # Below is a request that includes all optional parameters - # Import-V2025SpConfig -Data $Data -Preview $Preview -Options $Options - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025SpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#list-sp-config-objects - source: | - - # List Config Objects - - try { - Get-V2025SpConfigObjects - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigObjects - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigObjects" - Write-Host $_.ErrorDetails - } - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -17760,418 +17762,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025VendorConnectorMappings" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#cancel-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - - # Cancel Workflow Execution by ID - - try { - Suspend-V2025WorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Suspend-V2025WorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2025WorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $CreateExternalExecuteWorkflowRequest = @" - - "@ - - # Execute Workflow via External Trigger - - try { - New-V2025ExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # New-V2025ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-workflow - source: | - $CreateWorkflowRequest = @" - {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} - "@ - - # Create Workflow - - try { - $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-V2025Workflow -CreateWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025Workflow -CreateWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-workflow-external-trigger - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Generate External Trigger OAuth Client - - try { - New-V2025WorkflowExternalTrigger -Id $Id - - # Below is a request that includes all optional parameters - # New-V2025WorkflowExternalTrigger -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025WorkflowExternalTrigger" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#delete-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - - # Delete Workflow By Id - - try { - Remove-V2025Workflow -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025Workflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Get Workflow By Id - - try { - Get-V2025Workflow -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025Workflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - - # Get Workflow Execution - - try { - Get-V2025WorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-execution-history - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - - # Get Workflow Execution History - - try { - Get-V2025WorkflowExecutionHistory -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowExecutionHistory -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutionHistory" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-executions - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - - # List Workflow Executions - - try { - Get-V2025WorkflowExecutions -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-complete-workflow-library - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Complete Workflow Library - - try { - Get-V2025CompleteWorkflowLibrary - - # Below is a request that includes all optional parameters - # Get-V2025CompleteWorkflowLibrary -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CompleteWorkflowLibrary" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-actions - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Actions - - try { - Get-V2025WorkflowLibraryActions - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryActions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-operators - source: | - - # List Workflow Library Operators - - try { - Get-V2025WorkflowLibraryOperators - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowLibraryOperators - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryOperators" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-triggers - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Triggers - - try { - Get-V2025WorkflowLibraryTriggers - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryTriggers" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflows - source: | - - # List Workflows - - try { - Get-V2025Workflows - - # Below is a request that includes all optional parameters - # Get-V2025Workflows - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workflows" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#patch-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Workflow - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025Workflow -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025Workflow -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#put-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $WorkflowBody = @" - { - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "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", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - } - "@ - - # Update Workflow - - try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Send-V2025Workflow -Id $Id -WorkflowBody $Result - - # Below is a request that includes all optional parameters - # Send-V2025Workflow -Id $Id -WorkflowBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#test-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestExternalExecuteWorkflowRequest = @" - - "@ - - # Test Workflow via External Trigger - - try { - Test-V2025ExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Test-V2025ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#test-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestWorkflowRequest = @" - {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} - "@ - - # Test Workflow By Id - - try { - $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-V2025Workflow -Id $Id -TestWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # Test-V2025Workflow -Id $Id -TestWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025Workflow" - Write-Host $_.ErrorDetails - } - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -18648,3 +18238,415 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025TenantConfiguration" Write-Host $_.ErrorDetails } +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#cancel-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + + # Cancel Workflow Execution by ID + + try { + Suspend-V2025WorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Suspend-V2025WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2025WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $CreateExternalExecuteWorkflowRequest = @" + + "@ + + # Execute Workflow via External Trigger + + try { + New-V2025ExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # New-V2025ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-workflow + source: | + $CreateWorkflowRequest = @" + {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} + "@ + + # Create Workflow + + try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-V2025Workflow -CreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-V2025Workflow -CreateWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-workflow-external-trigger + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Generate External Trigger OAuth Client + + try { + New-V2025WorkflowExternalTrigger -Id $Id + + # Below is a request that includes all optional parameters + # New-V2025WorkflowExternalTrigger -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025WorkflowExternalTrigger" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#delete-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + + # Delete Workflow By Id + + try { + Remove-V2025Workflow -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Get Workflow By Id + + try { + Get-V2025Workflow -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + + # Get Workflow Execution + + try { + Get-V2025WorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-execution-history + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + + # Get Workflow Execution History + + try { + Get-V2025WorkflowExecutionHistory -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowExecutionHistory -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutionHistory" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-executions + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + # List Workflow Executions + + try { + Get-V2025WorkflowExecutions -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-complete-workflow-library + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Complete Workflow Library + + try { + Get-V2025CompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-V2025CompleteWorkflowLibrary -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CompleteWorkflowLibrary" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-actions + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Actions + + try { + Get-V2025WorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryActions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-operators + source: | + + # List Workflow Library Operators + + try { + Get-V2025WorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowLibraryOperators + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryOperators" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-triggers + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Triggers + + try { + Get-V2025WorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryTriggers" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflows + source: | + + # List Workflows + + try { + Get-V2025Workflows + + # Below is a request that includes all optional parameters + # Get-V2025Workflows + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workflows" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#patch-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Workflow + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025Workflow -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025Workflow -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#put-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $WorkflowBody = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "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", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ + + # Update Workflow + + try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-V2025Workflow -Id $Id -WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Send-V2025Workflow -Id $Id -WorkflowBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#test-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + + "@ + + # Test Workflow via External Trigger + + try { + Test-V2025ExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Test-V2025ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#test-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestWorkflowRequest = @" + {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} + "@ + + # Test Workflow By Id + + try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-V2025Workflow -Id $Id -TestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-V2025Workflow -Id $Id -TestWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025Workflow" + Write-Host $_.ErrorDetails + } diff --git a/static/code-examples/v3/powershell_code_examples_overlay.yaml b/static/code-examples/v3/powershell_code_examples_overlay.yaml index 3c8a3e36c..488b85d30 100644 --- a/static/code-examples/v3/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v3/powershell_code_examples_overlay.yaml @@ -523,9 +523,7 @@ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -553,9 +551,7 @@ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" } ] }, { "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", @@ -586,9 +582,7 @@ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -616,9 +610,7 @@ } ], "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE", - "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", - "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + "type" : "ACCESS_PROFILE" } ] } ] } @@ -774,6 +766,29 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountActivities" Write-Host $_.ErrorDetails } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/account-usages#get-usages-by-account-id + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + Get-UsagesByAccountId -AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesByAccountId" + Write-Host $_.ErrorDetails + } - path: /accounts method: POST xCodeSample: @@ -1041,29 +1056,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Account" Write-Host $_.ErrorDetails } -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/account-usages#get-usages-by-account-id - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns account usage insights - - try { - Get-UsagesByAccountId -AccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesByAccountId" - Write-Host $_.ErrorDetails - } - path: /discovered-applications method: GET xCodeSample: @@ -2151,6 +2143,95 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Campaign" Write-Host $_.ErrorDetails } +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-access-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Type = "ROLE" # String | The type of access review item to retrieve summaries for + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + + # Access Summaries + + try { + Get-IdentityAccessSummaries -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityAccessSummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-decision-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + + # Summary of Certification Decisions + + try { + Get-IdentityDecisionSummary -Id $Id + + # Below is a request that includes all optional parameters + # Get-IdentityDecisionSummary -Id $Id -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityDecisionSummary" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Identity Summaries for Campaign Certification + + try { + Get-IdentitySummaries -Id $Id + + # Below is a request that includes all optional parameters + # Get-IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID + + # Summary for Identity + + try { + Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + + # Below is a request that includes all optional parameters + # Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummary" + Write-Host $_.ErrorDetails + } - path: /certification-tasks/{id} method: GET xCodeSample: @@ -2429,95 +2510,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-ReassignCertsAsync" Write-Host $_.ErrorDetails } -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-access-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Type = "ROLE" # String | The type of access review item to retrieve summaries for - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - - # Access Summaries - - try { - Get-IdentityAccessSummaries -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityAccessSummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-decision-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - - # Summary of Certification Decisions - - try { - Get-IdentityDecisionSummary -Id $Id - - # Below is a request that includes all optional parameters - # Get-IdentityDecisionSummary -Id $Id -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityDecisionSummary" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Identity Summaries for Campaign Certification - - try { - Get-IdentitySummaries -Id $Id - - # Below is a request that includes all optional parameters - # Get-IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID - - # Summary for Identity - - try { - Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - - # Below is a request that includes all optional parameters - # Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummary" - Write-Host $_.ErrorDetails - } - path: /configuration-hub/object-mappings/{sourceOrg} method: POST xCodeSample: @@ -3698,298 +3690,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-LifecycleStates" Write-Host $_.ErrorDetails } -- path: /managed-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#create-managed-client - source: | - $ManagedClientRequest = @" - { - "name" : "aName", - "description" : "A short description of the ManagedClient", - "clusterId" : "aClusterId", - "type" : "VA" - } - "@ - - # Create Managed Client - - try { - $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest - New-ManagedClient -ManagedClientRequest $Result - - # Below is a request that includes all optional parameters - # New-ManagedClient -ManagedClientRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#delete-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - - # Delete Managed Client - - try { - Remove-ManagedClient -Id $Id - - # Below is a request that includes all optional parameters - # Remove-ManagedClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - - # Get Managed Client - - try { - Get-ManagedClient -Id $Id - - # Below is a request that includes all optional parameters - # Get-ManagedClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client-status - source: | - $Id = "aClientId" # String | Managed client ID to get status for. - $Type = "CCG" # ManagedClientType | Managed client type to get status for. - - # Get Managed Client Status - - try { - Get-ManagedClientStatus -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-ManagedClientStatus -Id $Id -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClientStatus" - Write-Host $_.ErrorDetails - } -- path: /managed-clients - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-clients - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "client name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) - - # Get Managed Clients - - try { - Get-ManagedClients - - # Below is a request that includes all optional parameters - # Get-ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClients" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#update-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Managed Client - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-ManagedClient -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-ManagedClient -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#create-managed-cluster - source: | - $ManagedClusterRequest = @" - { - "configuration" : { - "clusterExternalId" : "externalId", - "ccgVersion" : "77.0.0" - }, - "name" : "Managed Cluster Name", - "description" : "A short description of the managed cluster.", - "type" : "idn" - } - "@ - - # Create Create Managed Cluster - - try { - $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest - New-ManagedCluster -ManagedClusterRequest $Result - - # Below is a request that includes all optional parameters - # New-ManagedCluster -ManagedClusterRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#delete-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) - - # Delete Managed Cluster - - try { - Remove-ManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Remove-ManagedCluster -Id $Id -RemoveClients $RemoveClients - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-client-log-configuration - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. - - # Get Managed Cluster Log Configuration - - try { - Get-ClientLogConfiguration -Id $Id - - # Below is a request that includes all optional parameters - # Get-ClientLogConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - - # Get Managed Cluster - - try { - Get-ManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Get-ManagedCluster -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-clusters - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "operational eq "operation"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - - # Get Managed Clusters - - try { - Get-ManagedClusters - - # Below is a request that includes all optional parameters - # Get-ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClusters" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#put-client-log-configuration - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. - $PutClientLogConfigurationRequest = @" - - "@ - - # Update Managed Cluster Log Configuration - - try { - $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest - Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result - - # Below is a request that includes all optional parameters - # Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#update-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Managed Cluster - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-ManagedCluster -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-ManagedCluster -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedCluster" - Write-Host $_.ErrorDetails - } - path: /mfa/{method}/delete method: DELETE xCodeSample: @@ -4316,6 +4016,298 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TokenAuthRequest" Write-Host $_.ErrorDetails } +- path: /managed-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#create-managed-client + source: | + $ManagedClientRequest = @" + { + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + } + "@ + + # Create Managed Client + + try { + $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest + New-ManagedClient -ManagedClientRequest $Result + + # Below is a request that includes all optional parameters + # New-ManagedClient -ManagedClientRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#delete-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + + # Delete Managed Client + + try { + Remove-ManagedClient -Id $Id + + # Below is a request that includes all optional parameters + # Remove-ManagedClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + + # Get Managed Client + + try { + Get-ManagedClient -Id $Id + + # Below is a request that includes all optional parameters + # Get-ManagedClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client-status + source: | + $Id = "aClientId" # String | Managed client ID to get status for. + $Type = "CCG" # ManagedClientType | Managed client type to get status for. + + # Get Managed Client Status + + try { + Get-ManagedClientStatus -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-ManagedClientStatus -Id $Id -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clients + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-clients + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "client name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) + + # Get Managed Clients + + try { + Get-ManagedClients + + # Below is a request that includes all optional parameters + # Get-ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClients" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#update-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Managed Client + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-ManagedClient -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-ManagedClient -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#create-managed-cluster + source: | + $ManagedClusterRequest = @" + { + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" + } + "@ + + # Create Create Managed Cluster + + try { + $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest + New-ManagedCluster -ManagedClusterRequest $Result + + # Below is a request that includes all optional parameters + # New-ManagedCluster -ManagedClusterRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#delete-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) + + # Delete Managed Cluster + + try { + Remove-ManagedCluster -Id $Id + + # Below is a request that includes all optional parameters + # Remove-ManagedCluster -Id $Id -RemoveClients $RemoveClients + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-client-log-configuration + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. + + # Get Managed Cluster Log Configuration + + try { + Get-ClientLogConfiguration -Id $Id + + # Below is a request that includes all optional parameters + # Get-ClientLogConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + + # Get Managed Cluster + + try { + Get-ManagedCluster -Id $Id + + # Below is a request that includes all optional parameters + # Get-ManagedCluster -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-clusters + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "operational eq "operation"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + + # Get Managed Clusters + + try { + Get-ManagedClusters + + # Below is a request that includes all optional parameters + # Get-ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClusters" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#put-client-log-configuration + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. + $PutClientLogConfigurationRequest = @" + + "@ + + # Update Managed Cluster Log Configuration + + try { + $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest + Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#update-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Managed Cluster + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-ManagedCluster -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-ManagedCluster -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedCluster" + Write-Host $_.ErrorDetails + } - path: /non-employee-approvals/{id}/approve method: POST xCodeSample: @@ -6267,6 +6259,558 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Role" Write-Host $_.ErrorDetails } +- path: /sod-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#create-sod-policy + source: | + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Create SOD policy + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-SodPolicy -SodPolicy $Result + + # Below is a request that includes all optional parameters + # New-SodPolicy -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. + $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) + + # Delete SOD policy by ID + + try { + Remove-SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Remove-SodPolicy -Id $Id -Logical $Logical + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + + # Delete SOD policy schedule + + try { + Remove-SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-custom-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. + + # Download custom violation report + + try { + Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + + # Below is a request that includes all optional parameters + # Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CustomViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-default-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + + # Download violation report + + try { + Get-DefaultViolationReport -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-DefaultViolationReport -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-all-report-run-status + source: | + + # Get multi-report run task status + + try { + Get-SodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-SodAllReportRunStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodAllReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. + + # Get SOD policy by ID + + try { + Get-SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Get-SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. + + # Get SOD policy schedule + + try { + Get-SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Get-SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-run-status + source: | + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + + # Get violation report run status + + try { + Get-SodViolationReportRunStatus -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-SodViolationReportRunStatus -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-status + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. + + # Get SOD violation report status + + try { + Get-SodViolationReportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-SodViolationReportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#list-sod-policies + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + + # List SOD policies + + try { + Get-SodPolicies + + # Below is a request that includes all optional parameters + # Get-SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicies" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#patch-sod-policy + source: | + $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch SOD policy by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-SodPolicy -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-SodPolicy -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. + $SodPolicySchedule = @" + { + "schedule" : { + "hours" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "months" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } + "@ + + # Update SOD Policy schedule + + try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-PolicySchedule -Id $Id -SodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-PolicySchedule -Id $Id -SodPolicySchedule $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Update SOD policy by ID + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-SodPolicy -Id $Id -SodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-SodPolicy -Id $Id -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-evaluate-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Evaluate one policy by ID + + try { + Start-EvaluateSodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-EvaluateSodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-EvaluateSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-sod-all-policies-for-org + source: | + $MultiPolicyRequest = @" + { + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + } + "@ + + # Runs all policies for org + + try { + Start-SodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-SodAllPoliciesForOrg -MultiPolicyRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodAllPoliciesForOrg" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Runs SOD policy violation report + + try { + Start-SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-violations#start-predict-sod-violations + source: | + $IdentityWithNewAccess = @" + { + "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" + } ] + } + "@ + + # Predict SOD violations for identity. + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-PredictSodViolations -IdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-PredictSodViolations -IdentityWithNewAccess $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-PredictSodViolations" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-violations#start-violation-check + source: | + $IdentityWithNewAccess1 = @" + {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} + "@ + + # Check SOD violations + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 + Start-ViolationCheck -IdentityWithNewAccess1 $Result + + # Below is a request that includes all optional parameters + # Start-ViolationCheck -IdentityWithNewAccess1 $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-ViolationCheck" + Write-Host $_.ErrorDetails + } - path: /saved-searches method: POST xCodeSample: @@ -7580,556 +8124,46 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-StatusCheckDetails" Write-Host $_.ErrorDetails } -- path: /sod-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#create-sod-policy - source: | - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Create SOD policy - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-SodPolicy -SodPolicy $Result - - # Below is a request that includes all optional parameters - # New-SodPolicy -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. - $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) - - # Delete SOD policy by ID - - try { - Remove-SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Remove-SodPolicy -Id $Id -Logical $Logical - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - - # Delete SOD policy schedule - - try { - Remove-SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download/{fileName} +- path: /source-usages/{sourceId}/status method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-custom-violation-report + label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-status-by-source-id source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - $FileName = "custom-name" # String | Custom Name for the file. + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - # Download custom violation report + # Finds status of source usage try { - Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + Get-StatusBySourceId -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + # Get-StatusBySourceId -SourceId $SourceId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CustomViolationReport" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusBySourceId" Write-Host $_.ErrorDetails } -- path: /sod-violation-report/{reportResultId}/download +- path: /source-usages/{sourceId}/summaries method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-default-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - - # Download violation report - - try { - Get-DefaultViolationReport -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-DefaultViolationReport -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-all-report-run-status - source: | - - # Get multi-report run task status - - try { - Get-SodAllReportRunStatus - - # Below is a request that includes all optional parameters - # Get-SodAllReportRunStatus - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodAllReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. - - # Get SOD policy by ID - - try { - Get-SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Get-SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. - - # Get SOD policy schedule - - try { - Get-SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Get-SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-run-status - source: | - $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. - - # Get violation report run status - - try { - Get-SodViolationReportRunStatus -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-SodViolationReportRunStatus -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-status - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. - - # Get SOD violation report status - - try { - Get-SodViolationReportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-SodViolationReportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#list-sod-policies + label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-usages-by-source-id source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "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) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - # List SOD policies + # Returns source usage insights try { - Get-SodPolicies + Get-UsagesBySourceId -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + # Get-UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicies" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#patch-sod-policy - source: | - $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch SOD policy by ID - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-SodPolicy -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-SodPolicy -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. - $SodPolicySchedule = @" - { - "schedule" : { - "hours" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "months" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - } - "@ - - # Update SOD Policy schedule - - try { - $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-PolicySchedule -Id $Id -SodPolicySchedule $Result - - # Below is a request that includes all optional parameters - # Send-PolicySchedule -Id $Id -SodPolicySchedule $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Update SOD policy by ID - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-SodPolicy -Id $Id -SodPolicy $Result - - # Below is a request that includes all optional parameters - # Send-SodPolicy -Id $Id -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-evaluate-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Evaluate one policy by ID - - try { - Start-EvaluateSodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-EvaluateSodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-EvaluateSodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-sod-all-policies-for-org - source: | - $MultiPolicyRequest = @" - { - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - } - "@ - - # Runs all policies for org - - try { - Start-SodAllPoliciesForOrg - - # Below is a request that includes all optional parameters - # Start-SodAllPoliciesForOrg -MultiPolicyRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodAllPoliciesForOrg" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Runs SOD policy violation report - - try { - Start-SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-violations#start-predict-sod-violations - source: | - $IdentityWithNewAccess = @" - { - "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" - } ] - } - "@ - - # Predict SOD violations for identity. - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-PredictSodViolations -IdentityWithNewAccess $Result - - # Below is a request that includes all optional parameters - # Start-PredictSodViolations -IdentityWithNewAccess $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-PredictSodViolations" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-violations#start-violation-check - source: | - $IdentityWithNewAccess1 = @" - {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} - "@ - - # Check SOD violations - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 - Start-ViolationCheck -IdentityWithNewAccess1 $Result - - # Below is a request that includes all optional parameters - # Start-ViolationCheck -IdentityWithNewAccess1 $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-ViolationCheck" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesBySourceId" Write-Host $_.ErrorDetails } - path: /sources/{sourceId}/provisioning-policies @@ -9042,48 +9076,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SourceSchema" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-status-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - - # Finds status of source usage - - try { - Get-StatusBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-StatusBySourceId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusBySourceId" - Write-Host $_.ErrorDetails - } -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-usages-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns source usage insights - - try { - Get-UsagesBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesBySourceId" - Write-Host $_.ErrorDetails - } - path: /tagged-objects/{type}/{id} method: DELETE xCodeSample: @@ -9547,6 +9539,272 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-VendorConnectorMappings" Write-Host $_.ErrorDetails } +- path: /work-items/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Approve an Approval Item + + try { + Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-approve/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-items-in-bulk + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk approve Approval Items + + try { + Approve-ApprovalItemsInBulk -Id $Id + + # Below is a request that includes all optional parameters + # Approve-ApprovalItemsInBulk -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#complete-work-item + source: | + $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 + + try { + Complete-WorkItem -Id $Id + + # Below is a request that includes all optional parameters + # Complete-WorkItem -Id $Id -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-WorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-completed-work-items + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Completed Work Items + + try { + Get-CompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-completed-work-items + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # Count Completed Work Items + + try { + Get-CountCompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-CountCompletedWorkItems -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountCompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-work-items + source: | + $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) + + # Count Work Items + + try { + Get-CountWorkItems + + # Below is a request that includes all optional parameters + # Get-CountWorkItems -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-item + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. + + # Get a Work Item + + try { + Get-WorkItem -Id $Id + + # Below is a request that includes all optional parameters + # Get-WorkItem -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-items-summary + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # Work Items Summary + + try { + Get-WorkItemsSummary + + # Below is a request that includes all optional parameters + # Get-WorkItemsSummary -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItemsSummary" + Write-Host $_.ErrorDetails + } +- path: /work-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#list-work-items + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # List Work Items + + try { + Get-WorkItems + + # Below is a request that includes all optional parameters + # Get-WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Reject an Approval Item + + try { + Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-reject/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-items-in-bulk + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk reject Approval Items + + try { + Deny-ApprovalItemsInBulk -Id $Id + + # Below is a request that includes all optional parameters + # Deny-ApprovalItemsInBulk -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/forward + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#send-work-item-forward + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $WorkItemForward = @" + { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } + "@ + + # Forward a Work Item + + try { + $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward + Send-WorkItemForward -Id $Id -WorkItemForward $Result + + # Below is a request that includes all optional parameters + # Send-WorkItemForward -Id $Id -WorkItemForward $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-WorkItemForward" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#submit-account-selection + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName + + # Submit Account Selections + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Submit-AccountSelection -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Submit-AccountSelection -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-AccountSelection" + Write-Host $_.ErrorDetails + } - path: /workflow-executions/{id}/cancel method: POST xCodeSample: @@ -9964,269 +10222,3 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-Workflow" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/approve/{approvalItemId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - - # Approve an Approval Item - - try { - Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - - # Below is a request that includes all optional parameters - # Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/bulk-approve/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-items-in-bulk - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - - # Bulk approve Approval Items - - try { - Approve-ApprovalItemsInBulk -Id $Id - - # Below is a request that includes all optional parameters - # Approve-ApprovalItemsInBulk -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItemsInBulk" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#complete-work-item - source: | - $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 - - try { - Complete-WorkItem -Id $Id - - # Below is a request that includes all optional parameters - # Complete-WorkItem -Id $Id -Body $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-WorkItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/completed - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-completed-work-items - source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Completed Work Items - - try { - Get-CompletedWorkItems - - # Below is a request that includes all optional parameters - # Get-CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompletedWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/completed/count - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-completed-work-items - source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - - # Count Completed Work Items - - try { - Get-CountCompletedWorkItems - - # Below is a request that includes all optional parameters - # Get-CountCompletedWorkItems -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountCompletedWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/count - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-work-items - source: | - $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) - - # Count Work Items - - try { - Get-CountWorkItems - - # Below is a request that includes all optional parameters - # Get-CountWorkItems -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-item - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. - - # Get a Work Item - - try { - Get-WorkItem -Id $Id - - # Below is a request that includes all optional parameters - # Get-WorkItem -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-items-summary - source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - - # Work Items Summary - - try { - Get-WorkItemsSummary - - # Below is a request that includes all optional parameters - # Get-WorkItemsSummary -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItemsSummary" - Write-Host $_.ErrorDetails - } -- path: /work-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#list-work-items - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - - # List Work Items - - try { - Get-WorkItems - - # Below is a request that includes all optional parameters - # Get-WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/reject/{approvalItemId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - - # Reject an Approval Item - - try { - Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - - # Below is a request that includes all optional parameters - # Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/bulk-reject/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-items-in-bulk - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - - # Bulk reject Approval Items - - try { - Deny-ApprovalItemsInBulk -Id $Id - - # Below is a request that includes all optional parameters - # Deny-ApprovalItemsInBulk -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItemsInBulk" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/forward - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#send-work-item-forward - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $WorkItemForward = @" - { - "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I'm going on vacation.", - "sendNotifications" : true - } - "@ - - # Forward a Work Item - - try { - $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward - Send-WorkItemForward -Id $Id -WorkItemForward $Result - - # Below is a request that includes all optional parameters - # Send-WorkItemForward -Id $Id -WorkItemForward $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-WorkItemForward" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/submit-account-selection - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#submit-account-selection - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName - - # Submit Account Selections - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Submit-AccountSelection -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Submit-AccountSelection -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-AccountSelection" - Write-Host $_.ErrorDetails - }