From e3154507bce2b8aa2746f6ea721f4ad8d8a8502c Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Wed, 2 Apr 2025 01:20:21 +0000 Subject: [PATCH] Update to powershell SDK docs: 14209385488 --- .../Reference/Beta/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/Beta/Models/SourceUsage.md | 2 +- .../Reference/V2024/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/V2024/Models/SourceUsage.md | 2 +- .../V2025/Methods/V2025AccessProfilesApi.md | 7 +- .../Reference/V2025/Methods/V2025RolesApi.md | 5 +- .../Reference/V2025/Models/AccessProfile.md | 18 +- .../Models/AccessProfileApprovalScheme.md | 4 +- .../V2025/Models/AccessProfileSourceRef.md | 6 +- .../Reference/V2025/Models/OwnerReference.md | 4 +- .../Models/ProvisioningCriteriaLevel1.md | 6 +- .../Models/ProvisioningCriteriaLevel2.md | 6 +- .../Models/ProvisioningCriteriaLevel3.md | 6 +- .../Reference/V2025/Models/Requestability.md | 8 +- .../V2025/Models/RequestabilityForRole.md | 2 + .../Reference/V2025/Models/Revocability.md | 2 +- .../Reference/V3/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/V3/Models/SourceUsage.md | 2 +- .../powershell_code_examples_overlay.yaml | 2564 ++++++------ .../powershell_code_examples_overlay.yaml | 3536 ++++++++-------- .../powershell_code_examples_overlay.yaml | 3542 +++++++++-------- .../v3/powershell_code_examples_overlay.yaml | 2476 ++++++------ 25 files changed, 6112 insertions(+), 6104 deletions(-) diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md index 9d6d48011..f6a1eaaa2 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-PSSailpoint.BetaAccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$AccountUsage = Initialize-PSSailpoint.BetaAccountUsage -Date Thu Apr 20 20:00:00 EDT 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 414c1c740..4eef80103 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-PSSailpoint.BetaNonEmployeeR -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Tue Mar 24 00:00:00 UTC 2020 ` - -EndDate Thu Mar 25 00:00:00 UTC 2021 ` + -StartDate Mon Mar 23 20:00:00 EDT 2020 ` + -EndDate Wed Mar 24 20:00:00 EDT 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/SourceUsage.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md index 05cceab03..bb3b65383 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-PSSailpoint.BetaSourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$SourceUsage = Initialize-PSSailpoint.BetaSourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10.45 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md index b901e027d..9cb9ee94f 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-PSSailpoint.V2024AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$AccountUsage = Initialize-PSSailpoint.V2024AccountUsage -Date Thu Apr 20 20:00:00 EDT 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 6393f6ed6..54727248f 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-PSSailpoint.V2024NonEmployee -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Tue Mar 24 00:00:00 UTC 2020 ` - -EndDate Thu Mar 25 00:00:00 UTC 2021 ` + -StartDate Mon Mar 23 20:00:00 EDT 2020 ` + -EndDate Wed Mar 24 20:00:00 EDT 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/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md index 3d6b4c94a..235e4ab2c 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-PSSailpoint.V2024SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$SourceUsage = Initialize-PSSailpoint.V2024SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10.45 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessProfilesApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessProfilesApi.md index b5ab471ee..d6790d1d0 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessProfilesApi.md @@ -63,7 +63,7 @@ Method | HTTP request | Description ## create-access-profile Create an access profile. -A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source. +A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-access-profile) @@ -127,6 +127,7 @@ $AccessProfile = @"{ "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -411,7 +412,7 @@ Param Type | Name | Data Type | Required | Description 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. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | ForSegmentIds | **String** | (optional) | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. @@ -439,7 +440,7 @@ $ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Filters the returne $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'name eq "SailPoint Support"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) +$Filters = 'name eq "SailPoint Support"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025RolesApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025RolesApi.md index 7cb8f10e1..3d7fdf0de 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025RolesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025RolesApi.md @@ -226,6 +226,7 @@ $Role = @"{ }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -693,7 +694,7 @@ Param Type | Name | Data Type | Required | Description Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. 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. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | ForSegmentIds | **String** | (optional) | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. @@ -721,7 +722,7 @@ $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filter $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) $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 = 'requestable eq false' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) +$Filters = 'requestable eq false' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfile.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfile.md index 5c19903d4..5f3d93d6d 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfile.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfile.md @@ -16,19 +16,19 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'V2025AccessProfile'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **String** | The ID of the Access Profile | [optional] [readonly] -**Name** | **String** | Name of the Access Profile | [required] -**Description** | **String** | Information about the Access Profile | [optional] -**Created** | **System.DateTime** | Date the Access Profile was created | [optional] [readonly] -**Modified** | **System.DateTime** | Date the Access Profile was last modified. | [optional] [readonly] -**Enabled** | **Boolean** | Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. | [optional] [default to $true] +**Id** | **String** | Access profile ID. | [optional] [readonly] +**Name** | **String** | Access profile name. | [required] +**Description** | **String** | Access profile description. | [optional] +**Created** | **System.DateTime** | Date and time when the access profile was created. | [optional] [readonly] +**Modified** | **System.DateTime** | Date and time when the access profile was last modified. | [optional] [readonly] +**Enabled** | **Boolean** | Indicates whether the access profile is enabled. If it's enabled, you must include at least one entitlement. | [optional] [default to $false] **Owner** | [**OwnerReference**](owner-reference) | | [required] **Source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | [required] -**Entitlements** | [**[]EntitlementRef**](entitlement-ref) | A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. | [optional] -**Requestable** | **Boolean** | Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. | [optional] [default to $true] +**Entitlements** | [**[]EntitlementRef**](entitlement-ref) | List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. | [optional] +**Requestable** | **Boolean** | Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. | [optional] [default to $true] **AccessRequestConfig** | [**Requestability**](requestability) | | [optional] **RevocationRequestConfig** | [**Revocability**](revocability) | | [optional] -**Segments** | **[]String** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] +**Segments** | **[]String** | List of segment IDs, if any, that the access profile is assigned to. | [optional] **ProvisioningCriteria** | [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfileApprovalScheme.md index 1f9d69ce3..22cc8b7a5 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfileApprovalScheme.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfileApprovalScheme.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'V2025A Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApproverType** | **Enum** [ "APP_OWNER", "OWNER", "SOURCE_OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] -**ApproverId** | **String** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] +**ApproverType** | **Enum** [ "APP_OWNER", "OWNER", "SOURCE_OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**ApproverId** | **String** | Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfileSourceRef.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfileSourceRef.md index 17f87fa1c..20739b738 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfileSourceRef.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfileSourceRef.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'V2025Access Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **String** | The ID of the Source with with which the Access Profile is associated | [optional] -**Type** | **Enum** [ "SOURCE" ] | The type of the Source, will always be SOURCE | [optional] -**Name** | **String** | The display name of the associated Source | [optional] +**Id** | **String** | ID of the source the access profile is associated with. | [optional] +**Type** | **Enum** [ "SOURCE" ] | Source's DTO type. | [optional] +**Name** | **String** | Source name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/OwnerReference.md b/docs/tools/sdk/powershell/Reference/V2025/Models/OwnerReference.md index e0aee5fc5..207757788 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/OwnerReference.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/OwnerReference.md @@ -17,8 +17,8 @@ tags: ['SDK', 'Software Development Kit', 'OwnerReference', 'V2025OwnerReference Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Type** | **Enum** [ "IDENTITY" ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] -**Id** | **String** | Identity id | [optional] -**Name** | **String** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] +**Id** | **String** | Owner's identity ID. | [optional] +**Name** | **String** | Owner's name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel1.md index 148abe98b..b1a98a01a 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel1.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel1.md @@ -17,9 +17,9 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1', 'V2025Pr Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**Attribute** | **String** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | **String** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel2.md index abb38f860..857dad112 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel2.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel2.md @@ -17,9 +17,9 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2', 'V2025Pr Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**Attribute** | **String** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | **String** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel3.md index a7bb5ea15..79a9b347e 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel3.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel3.md @@ -17,9 +17,9 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3', 'V2025Pr Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | **String** | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**Attribute** | **String** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | **String** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | **String** | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/Requestability.md b/docs/tools/sdk/powershell/Reference/V2025/Models/Requestability.md index 2ba89ac9d..da3aa25a6 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/Requestability.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/Requestability.md @@ -16,9 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'Requestability', 'V2025Requestability Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CommentsRequired** | **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] -**DenialCommentsRequired** | **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] -**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the request | [optional] +**CommentsRequired** | **Boolean** | Indicates whether the requester of the containing object must provide comments justifying the request. | [optional] [default to $false] +**DenialCommentsRequired** | **Boolean** | Indicates whether an approver must provide comments when denying the request. | [optional] [default to $false] +**ReauthorizationRequired** | **Boolean** | Indicates whether reauthorization is required for the request. | [optional] [default to $false] +**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the request. | [optional] ## Examples @@ -26,6 +27,7 @@ Name | Type | Description | Notes ```powershell $Requestability = Initialize-PSSailpoint.V2025Requestability -CommentsRequired true ` -DenialCommentsRequired true ` + -ReauthorizationRequired true ` -ApprovalSchemes null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/RequestabilityForRole.md b/docs/tools/sdk/powershell/Reference/V2025/Models/RequestabilityForRole.md index 83a294f1b..45bd29deb 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/RequestabilityForRole.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/RequestabilityForRole.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **CommentsRequired** | **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] **DenialCommentsRequired** | **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] +**ReauthorizationRequired** | **Boolean** | Indicates whether reauthorization is required for the request. | [optional] [default to $false] **ApprovalSchemes** | [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] ## Examples @@ -26,6 +27,7 @@ Name | Type | Description | Notes ```powershell $RequestabilityForRole = Initialize-PSSailpoint.V2025RequestabilityForRole -CommentsRequired true ` -DenialCommentsRequired true ` + -ReauthorizationRequired true ` -ApprovalSchemes null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/Revocability.md b/docs/tools/sdk/powershell/Reference/V2025/Models/Revocability.md index 3cc905e0c..9821efa31 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/Revocability.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/Revocability.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'Revocability', 'V2025Revocability'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the revocation request | [optional] +**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the revocation request. | [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 35c8a92f6..3b9cae031 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-PSSailpoint.V3AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$AccountUsage = Initialize-PSSailpoint.V3AccountUsage -Date Thu Apr 20 20:00:00 EDT 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 17d96a073..071f0e39a 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-PSSailpoint.V3NonEmployeeReq -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Tue Mar 24 00:00:00 UTC 2020 ` - -EndDate Thu Mar 25 00:00:00 UTC 2021 ` + -StartDate Mon Mar 23 20:00:00 EDT 2020 ` + -EndDate Wed Mar 24 20:00:00 EDT 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/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md index 0328c565b..92919ac01 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-PSSailpoint.V3SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$SourceUsage = Initialize-PSSailpoint.V3SourceUsage -Date Thu Apr 20 20:00:00 EDT 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 ad831aa53..5f6b70bf2 100644 --- a/static/code-examples/beta/powershell_code_examples_overlay.yaml +++ b/static/code-examples/beta/powershell_code_examples_overlay.yaml @@ -803,29 +803,6 @@ 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: @@ -1198,6 +1175,29 @@ 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: @@ -6536,6 +6536,162 @@ 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: @@ -6862,162 +7018,6 @@ 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: @@ -9796,6 +9796,515 @@ 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 + $PatchServiceDeskIntegrationRequest = @" + + "@ + + # Patch a Service Desk Integration + + try { + $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest + Update-BetaServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + + # Below is a request that includes all optional parameters + # Update-BetaServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $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: @@ -10533,697 +11042,6 @@ 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 - $PatchServiceDeskIntegrationRequest = @" - - "@ - - # Patch a Service Desk Integration - - try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-BetaServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result - - # Below is a request that includes all optional parameters - # Update-BetaServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $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: @@ -12541,6 +12359,188 @@ 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: @@ -13726,6 +13726,418 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaVendorConnectorMappings" Write-Host $_.ErrorDetails } +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#cancel-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + + # Cancel Workflow Execution by ID + + try { + Suspend-BetaWorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Suspend-BetaWorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaWorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaWorkflow -CreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaWorkflow -CreateWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#delete-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + + # Delete Workflow By Id + + try { + Remove-BetaWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaWorkflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Get Workflow By Id + + try { + Get-BetaWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + + # Get Workflow Execution + + try { + Get-BetaWorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaWorkflowExecutionHistory -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecutionHistory -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutionHistory" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + # List Workflow Executions + + try { + Get-BetaWorkflowExecutions -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaCompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-BetaCompleteWorkflowLibrary -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompleteWorkflowLibrary" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaWorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryActions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-operators + source: | + + # List Workflow Library Operators + + try { + Get-BetaWorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryOperators + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryOperators" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaWorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryTriggers" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflows + source: | + + # List Workflows + + try { + Get-BetaWorkflows + + # Below is a request that includes all optional parameters + # Get-BetaWorkflows + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflows" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaWorkflow -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaWorkflow -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#post-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $PostExternalExecuteWorkflowRequest = @" + + "@ + + # Execute Workflow via External Trigger + + try { + Submit-BetaExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Submit-BetaExternalExecuteWorkflow -Id $Id -PostExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#post-workflow-external-trigger + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Generate External Trigger OAuth Client + + try { + Submit-BetaWorkflowExternalTrigger -Id $Id + + # Below is a request that includes all optional parameters + # Submit-BetaWorkflowExternalTrigger -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaWorkflowExternalTrigger" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Test-BetaExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaWorkflow -Id $Id -TestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-BetaWorkflow -Id $Id -TestWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#update-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 + Update-BetaWorkflow -Id $Id -WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaWorkflow -Id $Id -WorkflowBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" + Write-Host $_.ErrorDetails + } - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -14194,415 +14606,3 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTenantConfiguration" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#cancel-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - - # Cancel Workflow Execution by ID - - try { - Suspend-BetaWorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Suspend-BetaWorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaWorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/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-BetaWorkflow -CreateWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # New-BetaWorkflow -CreateWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#delete-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - - # Delete Workflow By Id - - try { - Remove-BetaWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaWorkflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Get Workflow By Id - - try { - Get-BetaWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - - # Get Workflow Execution - - try { - Get-BetaWorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/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-BetaWorkflowExecutionHistory -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecutionHistory -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutionHistory" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/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: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - - # List Workflow Executions - - try { - Get-BetaWorkflowExecutions -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/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-BetaCompleteWorkflowLibrary - - # Below is a request that includes all optional parameters - # Get-BetaCompleteWorkflowLibrary -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompleteWorkflowLibrary" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/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-BetaWorkflowLibraryActions - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryActions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-operators - source: | - - # List Workflow Library Operators - - try { - Get-BetaWorkflowLibraryOperators - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryOperators - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryOperators" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/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-BetaWorkflowLibraryTriggers - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryTriggers" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflows - source: | - - # List Workflows - - try { - Get-BetaWorkflows - - # Below is a request that includes all optional parameters - # Get-BetaWorkflows - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflows" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/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-BetaWorkflow -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaWorkflow -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#post-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $PostExternalExecuteWorkflowRequest = @" - - "@ - - # Execute Workflow via External Trigger - - try { - Submit-BetaExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Submit-BetaExternalExecuteWorkflow -Id $Id -PostExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#post-workflow-external-trigger - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Generate External Trigger OAuth Client - - try { - Submit-BetaWorkflowExternalTrigger -Id $Id - - # Below is a request that includes all optional parameters - # Submit-BetaWorkflowExternalTrigger -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaWorkflowExternalTrigger" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/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-BetaExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Test-BetaExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/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-BetaWorkflow -Id $Id -TestWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # Test-BetaWorkflow -Id $Id -TestWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#update-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 - Update-BetaWorkflow -Id $Id -WorkflowBody $Result - - # Below is a request that includes all optional parameters - # Update-BetaWorkflow -Id $Id -WorkflowBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" - 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 f2656ac8f..dc3795d02 100644 --- a/static/code-examples/v2024/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2024/powershell_code_examples_overlay.yaml @@ -909,29 +909,6 @@ 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: @@ -1309,6 +1286,29 @@ 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: @@ -2851,95 +2851,6 @@ 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: @@ -3218,6 +3129,95 @@ 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: @@ -8479,164 +8479,6 @@ 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: /machine-accounts/{id} method: GET xCodeSample: @@ -8958,128 +8800,6 @@ 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: @@ -9258,6 +8978,286 @@ 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: @@ -12403,954 +12403,6 @@ 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: @@ -14714,46 +13766,812 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024StatusCheckDetails" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/status - method: GET +- path: /sim-integrations + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-status-by-source-id + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#create-sim-integration source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN 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" + } + } + "@ - # Finds status of source usage + # Create new SIM integration try { - Get-V2024StatusBySourceId -SourceId $SourceId + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result # Below is a request that includes all optional parameters - # Get-V2024StatusBySourceId -SourceId $SourceId + # New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusBySourceId" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SIMIntegration" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/summaries +- 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/source-usages#get-usages-by-source-id + 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: | - $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) + $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) - # Returns source usage insights + # List SOD policies try { - Get-V2024UsagesBySourceId -SourceId $SourceId + Get-V2024SodPolicies # Below is a request that includes all optional parameters - # Get-V2024UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + # Get-V2024SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesBySourceId" + 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: /sources/{sourceId}/provisioning-policies @@ -16231,6 +16049,188 @@ 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: @@ -17382,6 +17382,418 @@ 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: @@ -17858,415 +18270,3 @@ 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 a10a0e7a6..5a73e13b7 100644 --- a/static/code-examples/v2025/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2025/powershell_code_examples_overlay.yaml @@ -121,6 +121,7 @@ "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -282,7 +283,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) @@ -908,29 +909,6 @@ 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: @@ -1308,6 +1286,29 @@ 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: @@ -2850,95 +2851,6 @@ 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: @@ -3217,6 +3129,95 @@ 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: @@ -8478,164 +8479,6 @@ 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: @@ -8957,128 +8800,6 @@ 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: @@ -9257,6 +8978,286 @@ 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: @@ -11967,6 +11968,7 @@ }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -12199,7 +12201,7 @@ $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) $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 = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) @@ -12401,954 +12403,6 @@ 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: | - - # Get config object details - - 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: @@ -14712,46 +13766,812 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025StatusCheckDetails" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/status - method: GET +- path: /sim-integrations + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/source-usages#get-status-by-source-id + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#create-sim-integration source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN 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" + } + } + "@ - # Finds status of source usage + # Create new SIM integration try { - Get-V2025StatusBySourceId -SourceId $SourceId + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + New-V2025SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result # Below is a request that includes all optional parameters - # Get-V2025StatusBySourceId -SourceId $SourceId + # New-V2025SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025StatusBySourceId" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SIMIntegration" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/summaries +- 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/source-usages#get-usages-by-source-id + 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: | - $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) + $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) - # Returns source usage insights + # List SOD policies try { - Get-V2025UsagesBySourceId -SourceId $SourceId + Get-V2025SodPolicies # Below is a request that includes all optional parameters - # Get-V2025UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + # Get-V2025SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UsagesBySourceId" + 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: /sources/{sourceId}/provisioning-policies @@ -16229,6 +16049,188 @@ 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: @@ -17380,6 +17382,418 @@ 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: @@ -17856,415 +18270,3 @@ 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 - } \ No newline at end of file diff --git a/static/code-examples/v3/powershell_code_examples_overlay.yaml b/static/code-examples/v3/powershell_code_examples_overlay.yaml index f60bafeec..f4d1a2791 100644 --- a/static/code-examples/v3/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v3/powershell_code_examples_overlay.yaml @@ -636,29 +636,6 @@ 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: @@ -926,6 +903,29 @@ 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: @@ -2013,95 +2013,6 @@ 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: @@ -2380,6 +2291,95 @@ 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: @@ -3560,6 +3560,298 @@ 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: @@ -3886,298 +4178,6 @@ 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: @@ -6128,558 +6128,6 @@ 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: @@ -7990,46 +7438,556 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-StatusCheckDetails" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/status - method: GET +- path: /sod-policies + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-status-by-source-id + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#create-sod-policy source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN 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" + } + "@ - # Finds status of source usage + # Create SOD policy try { - Get-StatusBySourceId -SourceId $SourceId + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-SodPolicy -SodPolicy $Result # Below is a request that includes all optional parameters - # Get-StatusBySourceId -SourceId $SourceId + # New-SodPolicy -SodPolicy $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusBySourceId" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SodPolicy" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/summaries +- 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/source-usages#get-usages-by-source-id + 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: | - $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) + $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) - # Returns source usage insights + # List SOD policies try { - Get-UsagesBySourceId -SourceId $SourceId + Get-SodPolicies # Below is a request that includes all optional parameters - # Get-UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + # Get-SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesBySourceId" + 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: /sources/{sourceId}/provisioning-policies @@ -8942,6 +8900,48 @@ 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: @@ -9405,272 +9405,6 @@ 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: @@ -10083,3 +9817,269 @@ 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 + }