From b87617f99f22a6ac4c232cd9617d7afdd4ab0ecf Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Fri, 28 Feb 2025 17:21:02 +0000 Subject: [PATCH] Update to powershell SDK docs: 13593177491 --- .../Reference/Beta/Methods/BetaAccountsApi.md | 8 +- .../Beta/Methods/BetaIdentityProfilesApi.md | 69 +- .../BetaNonEmployeeLifecycleManagementApi.md | 22 +- .../Reference/Beta/Models/AccountUsage.md | 2 +- .../Beta/Models/IdentityAttributeConfig.md | 2 +- .../Beta/Models/IdentityAttributeConfig1.md | 2 +- .../Beta/Models/IdentityAttributeTransform.md | 2 +- .../Models/IdentityAttributeTransform1.md | 2 +- .../IdentityExceptionReportReference.md | 4 +- .../IdentityExceptionReportReference1.md | 4 +- .../Reference/Beta/Models/IdentityProfile.md | 10 +- .../Reference/Beta/Models/IdentityProfile1.md | 10 +- ...dentityProfile1AllOfAuthoritativeSource.md | 6 +- ...IdentityProfileAllOfAuthoritativeSource.md | 6 +- .../Beta/Models/IdentityProfileAllOfOwner.md | 6 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Models/NonEmployeeSourceWithNECount.md | 2 +- .../Reference/Beta/Models/SourceUsage.md | 2 +- .../Reference/Beta/Models/SpConfigObject.md | 2 + .../Reference/Beta/Models/SpConfigRule.md | 6 +- .../Beta/Models/SpConfigRuleValue.md | 34 + .../Beta/Models/TransformDefinition.md | 2 +- .../Beta/Models/TransformDefinition1.md | 2 +- .../Beta/Models/WorkflowExecution.md | 2 +- .../V2024AccessRequestIdentityMetricsApi.md | 9 +- .../V2024/Methods/V2024AccountsApi.md | 8 +- ...V2024IAIAccessRequestRecommendationsApi.md | 108 + .../V2024/Methods/V2024IdentityProfilesApi.md | 68 +- .../V2024/Methods/V2024MachineAccountsApi.md | 190 + .../Methods/V2024MachineIdentitiesApi.md | 298 + .../V2024NonEmployeeLifecycleManagementApi.md | 22 +- .../V2024/Methods/V2024SPConfigApi.md | 63 +- ...V2024SuggestedEntitlementDescriptionApi.md | 85 +- .../Reference/V2024/Methods/V2024TenantApi.md | 9 +- .../AccessRequestRecommendationConfigDto.md | 45 + .../Reference/V2024/Models/AccountUsage.md | 2 +- .../V2024/Models/IdentityAttributeConfig.md | 2 +- .../Models/IdentityAttributeTransform.md | 2 +- .../IdentityExceptionReportReference.md | 4 +- .../Reference/V2024/Models/IdentityProfile.md | 10 +- ...IdentityProfileAllOfAuthoritativeSource.md | 6 +- .../V2024/Models/IdentityProfileAllOfOwner.md | 6 +- .../Reference/V2024/Models/MachineAccount.md | 75 + .../Reference/V2024/Models/MachineIdentity.md | 49 + .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Models/NonEmployeeSourceWithNECount.md | 2 +- .../Reference/V2024/Models/SourceUsage.md | 2 +- .../Reference/V2024/Models/SpConfigObject.md | 2 + .../Reference/V2024/Models/SpConfigRule.md | 6 +- .../V2024/Models/SpConfigRuleValue.md | 34 + .../V2024/Models/TransformDefinition.md | 2 +- .../V2024/Models/WorkflowExecution.md | 2 +- .../Reference/V3/Methods/AccountsApi.md | 8 +- .../V3/Methods/IdentityProfilesApi.md | 68 +- .../NonEmployeeLifecycleManagementApi.md | 22 +- .../Reference/V3/Models/AccountUsage.md | 2 +- .../V3/Models/IdentityAttributeConfig.md | 2 +- .../V3/Models/IdentityAttributeTransform.md | 2 +- .../IdentityExceptionReportReference.md | 4 +- .../Reference/V3/Models/IdentityProfile.md | 10 +- ...IdentityProfileAllOfAuthoritativeSource.md | 6 +- .../V3/Models/IdentityProfileAllOfOwner.md | 6 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../V3/Models/NonEmployeeSourceWithNECount.md | 2 +- .../Reference/V3/Models/SourceUsage.md | 2 +- .../V3/Models/TransformDefinition.md | 2 +- .../Reference/V3/Models/WorkflowExecution.md | 2 +- .../beta/code_examples_overlay.yaml | 3052 ++++----- .../v2024/code_examples_overlay.yaml | 5540 +++++++++-------- .../v3/code_examples_overlay.yaml | 4028 ++++++------ 70 files changed, 7521 insertions(+), 6567 deletions(-) create mode 100644 docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigRuleValue.md create mode 100644 docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineAccountsApi.md create mode 100644 docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineIdentitiesApi.md create mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestRecommendationConfigDto.md create mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/MachineAccount.md create mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/MachineIdentity.md create mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigRuleValue.md diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountsApi.md index 0407500d0a09..221e70f40a77 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountsApi.md @@ -635,8 +635,8 @@ 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** + 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le* **modified**: *eq, ge, gt, le, lt* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** ### Return type [**Account[]**](../models/account) @@ -661,8 +661,8 @@ $DetailLevel = "SLIM" # String | This value determines whether the API provides $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 = 'identityId eq "2c9180858082150f0180893dbaf44201"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* (optional) -$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) +$Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le* **modified**: *eq, ge, gt, le, lt* (optional) +$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (optional) # Accounts List diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityProfilesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityProfilesApi.md index ff5322690ce2..773ab8d5b336 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityProfilesApi.md @@ -28,22 +28,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-BetaIdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create an Identity Profile -[**Remove-BetaIdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete an Identity Profile +[**New-BetaIdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create Identity Profile +[**Remove-BetaIdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete Identity Profile [**Remove-BetaIdentityProfiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete Identity Profiles [**Export-BetaIdentityProfiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export Identity Profiles [**Get-BetaDefaultIdentityAttributeConfig**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Default identity attribute config -[**Get-BetaIdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Gets a single Identity Profile +[**Get-BetaIdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get Identity Profile [**Import-BetaIdentityProfiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import Identity Profiles -[**Get-BetaIdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | Identity Profiles List +[**Get-BetaIdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List Identity Profiles [**Show-BetaGenerateIdentityPreview**](#show-generate-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview [**Sync-BetaIdentityProfile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile -[**Update-BetaIdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update the Identity Profile +[**Update-BetaIdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update Identity Profile ## create-identity-profile -This creates an Identity Profile. - +Create an identity profile. A token with ORG_ADMIN authority is required to call this API to create an Identity Profile. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-identity-profile) @@ -59,7 +58,7 @@ Param Type | Name | Data Type | Required | Description ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -201 | The created Identity Profile | IdentityProfile +201 | Created identity profile | IdentityProfile 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -122,7 +121,7 @@ $IdentityProfile = @"{ "id" : "id12345" }"@ -# Create an Identity Profile +# Create Identity Profile try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile @@ -138,20 +137,16 @@ try { [[Back to top]](#) ## delete-identity-profile -This deletes an Identity Profile based on ID. - +Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. - A token with ORG_ADMIN authority is required to call this API. -The following rights are required to access this endpoint: idn:identity-profile:delete - [API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity-profile) ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | The Identity Profile ID. +Path | IdentityProfileId | **String** | True | Identity profile ID. ### Return type [**TaskResultSimplified**](../models/task-result-simplified) @@ -173,9 +168,9 @@ Code | Description | Data Type ### Example ```powershell -$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID. +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. -# Delete an Identity Profile +# Delete Identity Profile try { Remove-BetaIdentityProfile -IdentityProfileId $IdentityProfileId @@ -345,8 +340,7 @@ try { [[Back to top]](#) ## get-identity-profile -This returns a single Identity Profile based on ID. - +Get a single identity profile by ID. A token with ORG_ADMIN or API authority is required to call this API. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-profile) @@ -354,7 +348,7 @@ A token with ORG_ADMIN or API authority is required to call this API. ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | The Identity Profile ID +Path | IdentityProfileId | **String** | True | Identity profile ID. ### Return type [**IdentityProfile**](../models/identity-profile) @@ -362,7 +356,7 @@ Path | IdentityProfileId | **String** | True | The Identity Profile ID ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | An Identity Profile object | IdentityProfile +200 | Identity profile object. | IdentityProfile 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -376,9 +370,9 @@ Code | Description | Data Type ### Example ```powershell -$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. -# Gets a single Identity Profile +# Get Identity Profile try { Get-BetaIdentityProfile -IdentityProfileId $IdentityProfileId @@ -501,7 +495,7 @@ try { [[Back to top]](#) ## list-identity-profiles -This returns a list of Identity Profiles based on the specified query parameters. +Get a list of identity profiles, based on the specified query parameters. A token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-profiles) @@ -512,7 +506,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, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, in, le, lt, isnull, sw* **priority**: *eq, ne* + 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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** ### Return type @@ -521,7 +515,7 @@ Param Type | Name | Data Type | Required | Description ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | List of identityProfiles. | IdentityProfile[] +200 | List of identity profiles. | IdentityProfile[] 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -537,10 +531,10 @@ Code | Description | Data Type $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'id eq 8c190e6787aa4ed9a90bd9d5344523fb' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional) +$Filters = 'id eq 8c190e6787aa4ed9a90bd9d5344523fb' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) $Sorters = "name,-priority" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) -# Identity Profiles List +# List Identity Profiles try { Get-BetaIdentityProfiles @@ -680,13 +674,10 @@ try { [[Back to top]](#) ## update-identity-profile -This updates the specified Identity Profile. - +Update the specified identity profile with this PATCH request. A token with ORG_ADMIN authority is required to call this API to update the Identity Profile. - -Some fields of the Schema cannot be updated. These fields are listed below: +These fields cannot be updated: * id -* name * created * modified * identityCount @@ -698,8 +689,8 @@ Some fields of the Schema cannot be updated. These fields are listed below: ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | The Identity Profile ID - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +Path | IdentityProfileId | **String** | True | Identity profile ID. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. ### Return type [**IdentityProfile**](../models/identity-profile) @@ -707,7 +698,7 @@ Path | IdentityProfileId | **String** | True | The Identity Profile ID ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | The updated Identity Profile. | IdentityProfile +200 | Updated identity profile. | IdentityProfile 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -721,15 +712,15 @@ Code | Description | Data Type ### Example ```powershell -$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" -}"@ # JsonPatchOperation[] | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +}"@ # JsonPatchOperation[] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -# Update the Identity Profile +# Update Identity Profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNonEmployeeLifecycleManagementApi.md index d4045321d210..ec64aa91b3ee 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNonEmployeeLifecycleManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNonEmployeeLifecycleManagementApi.md @@ -253,9 +253,7 @@ try { [[Back to top]](#) ## create-non-employee-source -This request will create a non-employee source. -Request will require the following security scope: -'idn:nesr:create' +Create a non-employee source. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-non-employee-source) @@ -1377,18 +1375,20 @@ try { [[Back to top]](#) ## list-non-employee-sources -This gets a list of non-employee sources. +Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: + 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager's `id`. + 2. If the current user is an account manager, the user should provide 'me' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-non-employee-sources) ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - Query | RequestedFor | **String** | True | The identity for whom the request was made. *me* indicates the current user. - Query | NonEmployeeCount | **Boolean** | True | The flag to determine whether return a non-employee count associate with source. 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 | RequestedFor | **String** | (optional) | Identity the request was made for. Use 'me' to indicate the current user. + Query | NonEmployeeCount | **Boolean** | (optional) (default to $false) | Flag that determines whether the API will return a non-employee count associated with the source. Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** ### Return type @@ -1397,7 +1397,7 @@ Param Type | Name | Data Type | Required | Description ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | List of non-employee sources objects. | NonEmployeeSourceWithNECount[] +200 | List of non-employee source objects. | NonEmployeeSourceWithNECount[] 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -1410,20 +1410,20 @@ Code | Description | Data Type ### Example ```powershell -$RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. -$NonEmployeeCount = $false # Boolean | The flag to determine whether return a non-employee count associate with 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) +$RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) +$NonEmployeeCount = $false # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) # List Non-Employee Sources try { - Get-BetaNonEmployeeSources -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount + Get-BetaNonEmployeeSources # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeSources -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + # Get-BetaNonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSources" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md index f6a1eaaa2640..9d6d480118b2 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 Thu Apr 20 20:00:00 EDT 2023 ` +$AccountUsage = Initialize-PSSailpoint.BetaAccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeConfig.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeConfig.md index ec5a872e1ffa..d77241abdb65 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeConfig.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeConfig.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig', 'BetaIdenti Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Enabled** | **Boolean** | If the profile or mapping is enabled | [optional] [default to $true] +**Enabled** | **Boolean** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to $true] **AttributeTransforms** | [**[]IdentityAttributeTransform**](identity-attribute-transform) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeConfig1.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeConfig1.md index b196d282f46c..aaff6049b9af 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeConfig1.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeConfig1.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig1', 'BetaIdent Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Enabled** | **Boolean** | The backend will only promote values if the profile/mapping is enabled. | [optional] [default to $false] +**Enabled** | **Boolean** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to $false] **AttributeTransforms** | [**[]IdentityAttributeTransform1**](identity-attribute-transform1) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeTransform.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeTransform.md index 842ae324672a..577385071926 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeTransform.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeTransform.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform', 'BetaIde Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IdentityAttributeName** | **String** | Name of the identity attribute | [optional] +**IdentityAttributeName** | **String** | Identity attribute's name. | [optional] **TransformDefinition** | [**TransformDefinition**](transform-definition) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeTransform1.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeTransform1.md index 0566d880c92b..f3e2f164598f 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeTransform1.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeTransform1.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform1', 'BetaId Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IdentityAttributeName** | **String** | Name of the identity attribute. | [optional] +**IdentityAttributeName** | **String** | Identity attribute's name. | [optional] **TransformDefinition** | [**TransformDefinition1**](transform-definition1) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityExceptionReportReference.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityExceptionReportReference.md index e67b7642a309..b35016972b19 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityExceptionReportReference.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityExceptionReportReference.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference', 'B Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TaskResultId** | **String** | The id of the task result | [optional] -**ReportName** | **String** | The name of the report | [optional] +**TaskResultId** | **String** | Task result ID. | [optional] +**ReportName** | **String** | Report name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityExceptionReportReference1.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityExceptionReportReference1.md index ff6802237a6c..5d6d544e49e5 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityExceptionReportReference1.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityExceptionReportReference1.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference1', ' Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TaskResultId** | **String** | The id of the task result. | [optional] -**ReportName** | **String** | The name of the report. | [optional] +**TaskResultId** | **String** | Task result ID. | [optional] +**ReportName** | **String** | Report name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile.md index bd7871006f9e..a83a0e0695e7 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile.md @@ -20,15 +20,15 @@ Name | Type | Description | Notes **Name** | **String** | Name of the Object | [required] **Created** | **System.DateTime** | Creation date of the Object | [optional] [readonly] **Modified** | **System.DateTime** | Last modification date of the Object | [optional] [readonly] -**Description** | **String** | The description of the Identity Profile. | [optional] +**Description** | **String** | Identity profile's description. | [optional] **Owner** | [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional] -**Priority** | **Int64** | The priority for an Identity Profile. | [optional] +**Priority** | **Int64** | Identity profile's priority. | [optional] **AuthoritativeSource** | [**IdentityProfileAllOfAuthoritativeSource**](identity-profile-all-of-authoritative-source) | | [required] -**IdentityRefreshRequired** | **Boolean** | True if a identity refresh is needed. Typically triggered when a change on the source has been made | [optional] [default to $false] -**IdentityCount** | **Int32** | The number of identities that belong to the Identity Profile. | [optional] +**IdentityRefreshRequired** | **Boolean** | Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. | [optional] [default to $false] +**IdentityCount** | **Int32** | Number of identities belonging to the identity profile. | [optional] **IdentityAttributeConfig** | [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] **IdentityExceptionReportReference** | [**IdentityExceptionReportReference**](identity-exception-report-reference) | | [optional] -**HasTimeBasedAttr** | **Boolean** | Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. | [optional] [default to $true] +**HasTimeBasedAttr** | **Boolean** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to $true] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile1.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile1.md index 2bc7191bdf72..30245f14af13 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile1.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile1.md @@ -20,15 +20,15 @@ Name | Type | Description | Notes **Name** | **String** | Name of the Object | [required] **Created** | **System.DateTime** | Creation date of the Object | [optional] [readonly] **Modified** | **System.DateTime** | Last modification date of the Object | [optional] [readonly] -**Description** | **String** | The description of the Identity Profile. | [optional] +**Description** | **String** | Identity profile's description. | [optional] **Owner** | [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional] -**Priority** | **Int64** | The priority for an Identity Profile. | [optional] +**Priority** | **Int64** | Identity profile's priority. | [optional] **AuthoritativeSource** | [**IdentityProfile1AllOfAuthoritativeSource**](identity-profile1-all-of-authoritative-source) | | [required] -**IdentityRefreshRequired** | **Boolean** | True if a identity refresh is needed. Typically triggered when a change on the source has been made. | [optional] [default to $false] -**IdentityCount** | **Int32** | The number of identities that belong to the Identity Profile. | [optional] +**IdentityRefreshRequired** | **Boolean** | Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. | [optional] [default to $false] +**IdentityCount** | **Int32** | Number of identities belonging to the identity profile. | [optional] **IdentityAttributeConfig** | [**IdentityAttributeConfig1**](identity-attribute-config1) | | [optional] **IdentityExceptionReportReference** | [**IdentityExceptionReportReference1**](identity-exception-report-reference1) | | [optional] -**HasTimeBasedAttr** | **Boolean** | Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. | [optional] [default to $false] +**HasTimeBasedAttr** | **Boolean** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to $false] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile1AllOfAuthoritativeSource.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile1AllOfAuthoritativeSource.md index 82b6803bf0a4..7b50f0f25c5a 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile1AllOfAuthoritativeSource.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile1AllOfAuthoritativeSource.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfile1AllOfAuthoritativeSou Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **Enum** [ "SOURCE" ] | Type of the object to which this reference applies | [optional] -**Id** | **String** | ID of the object to which this reference applies | [optional] -**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional] +**Type** | **Enum** [ "SOURCE" ] | Authoritative source's object type. | [optional] +**Id** | **String** | Authoritative source's ID. | [optional] +**Name** | **String** | Authoritative source's name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfileAllOfAuthoritativeSource.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfileAllOfAuthoritativeSource.md index ef7b5a835c81..11dbdeb896ce 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfileAllOfAuthoritativeSource.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfileAllOfAuthoritativeSource.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfAuthoritativeSour Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **Enum** [ "SOURCE" ] | Type of the object to which this reference applies | [optional] -**Id** | **String** | ID of the object to which this reference applies | [optional] -**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional] +**Type** | **Enum** [ "SOURCE" ] | Authoritative source's object type. | [optional] +**Id** | **String** | Authoritative source's ID. | [optional] +**Name** | **String** | Authoritative source's name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfileAllOfOwner.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfileAllOfOwner.md index f0a586e8674c..f2ac84e83cd4 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfileAllOfOwner.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfileAllOfOwner.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfOwner', 'BetaIden Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY" ] | Type of the object to which this reference applies | [optional] -**Id** | **String** | ID of the object to which this reference applies | [optional] -**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional] +**Type** | **Enum** [ "IDENTITY" ] | Owner's object type. | [optional] +**Id** | **String** | Owner's ID. | [optional] +**Name** | **String** | Owner's name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md index 4eef8010323f..414c1c74016b 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 Mon Mar 23 20:00:00 EDT 2020 ` - -EndDate Wed Mar 24 20:00:00 EDT 2021 ` + -StartDate Tue Mar 24 00:00:00 UTC 2020 ` + -EndDate Thu Mar 25 00:00:00 UTC 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeSourceWithNECount.md b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeSourceWithNECount.md index c09833c8a162..e6e843328deb 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeSourceWithNECount.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeSourceWithNECount.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes **AccountManagers** | [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of account managers | [optional] **Modified** | **System.DateTime** | When the request was last modified. | [optional] **Created** | **System.DateTime** | When the request was created. | [optional] -**NonEmployeeCount** | **Int32** | Number of non-employee records associated with this source. | [optional] +**NonEmployeeCount** | **Int32** | Number of non-employee records associated with this source. This value is 'null' by default. To get the non-employee count, you must set the `non-employee-count` flag in your request to 'true'. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md index bb3b653839f5..05cceab03379 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 Thu Apr 20 20:00:00 EDT 2023 ` +$SourceUsage = Initialize-PSSailpoint.BetaSourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10.45 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigObject.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigObject.md index 0acc1f6212f5..d0dfc3176dba 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigObject.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigObject.md @@ -19,6 +19,7 @@ Name | Type | Description | Notes **ObjectType** | **String** | The object type this configuration is for. | [optional] **ReferenceExtractors** | **[]String** | List of json paths within an exported object of this type that represent references that need to be resolved. | [optional] **SignatureRequired** | **Boolean** | If true, this type of object will be JWS signed and cannot be modified before import. | [optional] [default to $false] +**AlwaysResolveById** | **Boolean** | Whether this object type has to be resolved always by ID | [optional] [default to $false] **LegacyObject** | **Boolean** | Whether this is a legacy object | [optional] [default to $false] **OnePerTenant** | **Boolean** | Whether there is only one object of this type | [optional] [default to $false] **Exportable** | **Boolean** | Whether this object can be exported or it is just a reference object | [optional] [default to $false] @@ -31,6 +32,7 @@ Name | Type | Description | Notes $SpConfigObject = Initialize-PSSailpoint.BetaSpConfigObject -ObjectType TRIGGER_SUBSCRIPTION ` -ReferenceExtractors [$.owner] ` -SignatureRequired false ` + -AlwaysResolveById true ` -LegacyObject false ` -OnePerTenant false ` -Exportable true ` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigRule.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigRule.md index 843212093beb..61e9a11135d7 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigRule.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigRule.md @@ -17,8 +17,8 @@ tags: ['SDK', 'Software Development Kit', 'SpConfigRule', 'BetaSpConfigRule'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Path** | **String** | JSONPath expression denoting the path within the object where a value substitution should be applied | [optional] -**Value** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Value to be assigned at the jsonPath location within the object | [optional] -**Mode** | **[]String** | Draft modes to which this rule will apply | [optional] +**Value** | [**SpConfigRuleValue**](sp-config-rule-value) | | [optional] +**Modes** | **[]String** | Draft modes to which this rule will apply | [optional] ## Examples @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $SpConfigRule = Initialize-PSSailpoint.BetaSpConfigRule -Path $.enabled ` -Value null ` - -Mode [RESTORE, PROMOTE] + -Modes [RESTORE, PROMOTE] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigRuleValue.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigRuleValue.md new file mode 100644 index 000000000000..212c5c347368 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigRuleValue.md @@ -0,0 +1,34 @@ +--- +id: beta-sp-config-rule-value +title: SpConfigRuleValue +pagination_label: SpConfigRuleValue +sidebar_label: SpConfigRuleValue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigRuleValue', 'BetaSpConfigRuleValue'] +slug: /tools/sdk/powershell/beta/models/sp-config-rule-value +tags: ['SDK', 'Software Development Kit', 'SpConfigRuleValue', 'BetaSpConfigRuleValue'] +--- + + +# SpConfigRuleValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$SpConfigRuleValue = Initialize-PSSailpoint.BetaSpConfigRuleValue +``` + +- Convert the resource to JSON +```powershell +$SpConfigRuleValue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/TransformDefinition.md b/docs/tools/sdk/powershell/Reference/Beta/Models/TransformDefinition.md index fb6a5960165b..0a121712a800 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/TransformDefinition.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/TransformDefinition.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'TransformDefinition', 'BetaTransformD Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **String** | The type of the transform definition. | [optional] +**Type** | **String** | Transform definition type. | [optional] **Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Arbitrary key-value pairs to store any metadata for the object | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/TransformDefinition1.md b/docs/tools/sdk/powershell/Reference/Beta/Models/TransformDefinition1.md index 440d0b3892ae..18066d6c6fee 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/TransformDefinition1.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/TransformDefinition1.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'TransformDefinition1', 'BetaTransform Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **String** | The type of the transform definition. | [optional] +**Type** | **String** | Transform definition type. | [optional] **Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Arbitrary key-value pairs to store any metadata for the object | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowExecution.md b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowExecution.md index 867c40b0d5e5..8e629a09c346 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowExecution.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowExecution.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **RequestId** | **String** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] **StartTime** | **System.DateTime** | Date/time when the workflow started. | [optional] **CloseTime** | **System.DateTime** | Date/time when the workflow ended. | [optional] -**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Executing" ] | Workflow execution status. | [optional] +**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Running" ] | Workflow execution status. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestIdentityMetricsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestIdentityMetricsApi.md index 37ff66bfba47..aeb2ba634de9 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestIdentityMetricsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestIdentityMetricsApi.md @@ -25,9 +25,6 @@ Method | HTTP request | Description ## get-access-request-identity-metrics -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: Use this API to return information access metrics. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-identity-metrics) @@ -38,7 +35,6 @@ Param Type | Name | Data Type | Required | Description Path | IdentityId | **String** | True | Manager's identity ID. Path | RequestedObjectId | **String** | True | Requested access item's ID. Path | Type | **String** | True | Requested access item's type. - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. ### Return type [**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) @@ -62,15 +58,14 @@ Code | Description | Data Type $IdentityId = "7025c863-c270-4ba6-beea-edf3cb091573" # String | Manager's identity ID. $RequestedObjectId = "2db501be-f0fb-4cc5-a695-334133c52891" # String | Requested access item's ID. $Type = "ENTITLEMENT" # String | Requested access item's type. -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Return access request identity metrics try { - Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type -XSailPointExperimental $XSailPointExperimental + Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type # Below is a request that includes all optional parameters - # Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type -XSailPointExperimental $XSailPointExperimental + # Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestIdentityMetrics" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountsApi.md index 176ee99adc5f..9129c4d990b7 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountsApi.md @@ -655,8 +655,8 @@ Param Type | Name | Data Type | Required | Description Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. 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 | DetailLevel | **String** | (optional) | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. - 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** + 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** ### Return type [**Account[]**](../models/account) @@ -681,8 +681,8 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) -$Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* (optional) -$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) +$Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) +$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) # Accounts List diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIAccessRequestRecommendationsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIAccessRequestRecommendationsApi.md index ffd15ce6f20b..96fe5d17f6bf 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIAccessRequestRecommendationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIAccessRequestRecommendationsApi.md @@ -22,9 +22,11 @@ Method | HTTP request | Description [**Add-V2024AccessRequestRecommendationsViewedItem**](#add-access-request-recommendations-viewed-item) | **POST** `/ai-access-request-recommendations/viewed-items` | Notification of Viewed Access Request Recommendations [**Add-V2024AccessRequestRecommendationsViewedItems**](#add-access-request-recommendations-viewed-items) | **POST** `/ai-access-request-recommendations/viewed-items/bulk-create` | Notification of Viewed Access Request Recommendations in Bulk [**Get-V2024AccessRequestRecommendations**](#get-access-request-recommendations) | **GET** `/ai-access-request-recommendations` | Identity Access Request Recommendations +[**Get-V2024AccessRequestRecommendationsConfig**](#get-access-request-recommendations-config) | **GET** `/ai-access-request-recommendations/config` | Get Access Request Recommendations config [**Get-V2024AccessRequestRecommendationsIgnoredItems**](#get-access-request-recommendations-ignored-items) | **GET** `/ai-access-request-recommendations/ignored-items` | List of Ignored Access Request Recommendations [**Get-V2024AccessRequestRecommendationsRequestedItems**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List of Requested Access Request Recommendations [**Get-V2024AccessRequestRecommendationsViewedItems**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List of Viewed Access Request Recommendations +[**Set-V2024AccessRequestRecommendationsConfig**](#set-access-request-recommendations-config) | **PUT** `/ai-access-request-recommendations/config` | Update Access Request Recommendations config ## add-access-request-recommendations-ignored-item @@ -318,6 +320,54 @@ try { ``` [[Back to top]](#) +## get-access-request-recommendations-config +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +This API returns the configurations for Access Request Recommender for the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations-config) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**AccessRequestRecommendationConfigDto**](../models/access-request-recommendation-config-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Configurations for Access Request Recommender for the tenant. | AccessRequestRecommendationConfigDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get Access Request Recommendations config + +try { + Get-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + ## get-access-request-recommendations-ignored-items :::warning experimental This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. @@ -491,3 +541,61 @@ try { } ``` [[Back to top]](#) + +## set-access-request-recommendations-config +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +This API updates the configurations for Access Request Recommender for the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-access-request-recommendations-config) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | AccessRequestRecommendationConfigDto | [**AccessRequestRecommendationConfigDto**](../models/access-request-recommendation-config-dto) | True | The desired configurations for Access Request Recommender for the tenant. + +### Return type +[**AccessRequestRecommendationConfigDto**](../models/access-request-recommendation-config-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Successfully updated configurations for Access Request Recommender for the tenant. | AccessRequestRecommendationConfigDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$AccessRequestRecommendationConfigDto = @"{ + "scoreThreshold" : 0.5, + "startDateAttribute" : "startDate", + "restrictionAttribute" : "location", + "moverAttribute" : "isMover", + "joinerAttribute" : "isJoiner", + "useRestrictionAttribute" : true +}"@ + +# Update Access Request Recommendations config + +try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationConfigDto -Json $AccessRequestRecommendationConfigDto + Set-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationConfigDto $Result + + # Below is a request that includes all optional parameters + # Set-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationConfigDto $Result +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024AccessRequestRecommendationsConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityProfilesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityProfilesApi.md index 90e793ceb6bc..c91de9c099b5 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityProfilesApi.md @@ -27,21 +27,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024IdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create an Identity Profile -[**Remove-V2024IdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete an Identity Profile +[**New-V2024IdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create Identity Profile +[**Remove-V2024IdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete Identity Profile [**Remove-V2024IdentityProfiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete Identity Profiles [**Export-V2024IdentityProfiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export Identity Profiles [**Get-V2024DefaultIdentityAttributeConfig**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default Identity Attribute Config -[**Get-V2024IdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get single Identity Profile +[**Get-V2024IdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get Identity Profile [**Import-V2024IdentityProfiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import Identity Profiles -[**Get-V2024IdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | Identity Profiles List +[**Get-V2024IdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List Identity Profiles [**Show-V2024IdentityPreview**](#show-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview [**Sync-V2024IdentityProfile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile -[**Update-V2024IdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update the Identity Profile +[**Update-V2024IdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update Identity Profile ## create-identity-profile -This creates an Identity Profile. +Creates an identity profile. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-identity-profile) @@ -56,7 +56,7 @@ Param Type | Name | Data Type | Required | Description ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -201 | The created Identity Profile | IdentityProfile +201 | Created identity profile. | IdentityProfile 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -119,7 +119,7 @@ $IdentityProfile = @"{ "id" : "id12345" }"@ -# Create an Identity Profile +# Create Identity Profile try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile @@ -135,19 +135,15 @@ try { [[Back to top]](#) ## delete-identity-profile -This deletes an Identity Profile based on ID. - +Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. - - -The following rights are required to access this endpoint: idn:identity-profile:delete [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity-profile) ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | The Identity Profile ID. +Path | IdentityProfileId | **String** | True | Identity profile ID. ### Return type [**TaskResultSimplified**](../models/task-result-simplified) @@ -169,9 +165,9 @@ Code | Description | Data Type ### Example ```powershell -$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID. +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. -# Delete an Identity Profile +# Delete Identity Profile try { Remove-V2024IdentityProfile -IdentityProfileId $IdentityProfileId @@ -337,14 +333,14 @@ try { [[Back to top]](#) ## get-identity-profile -This returns a single Identity Profile based on ID. +Get a single identity profile by ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-profile) ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | The Identity Profile ID. +Path | IdentityProfileId | **String** | True | Identity profile ID. ### Return type [**IdentityProfile**](../models/identity-profile) @@ -352,7 +348,7 @@ Path | IdentityProfileId | **String** | True | The Identity Profile ID. ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | An Identity Profile object. | IdentityProfile +200 | Identity profile object. | IdentityProfile 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -366,9 +362,9 @@ Code | Description | Data Type ### Example ```powershell -$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. +$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. -# Get single Identity Profile +# Get Identity Profile try { Get-V2024IdentityProfile -IdentityProfileId $IdentityProfileId @@ -491,7 +487,7 @@ try { [[Back to top]](#) ## list-identity-profiles -This returns a list of Identity Profiles based on the specified query parameters. +Get a list of identity profiles, based on the specified query parameters. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-profiles) @@ -501,7 +497,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, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* + 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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** ### Return type @@ -510,7 +506,7 @@ Param Type | Name | Data Type | Required | Description ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | List of identityProfiles. | IdentityProfile[] +200 | List of identity profiles. | IdentityProfile[] 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -526,10 +522,10 @@ Code | Description | Data Type $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional) +$Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) -# Identity Profiles List +# List Identity Profiles try { Get-V2024IdentityProfiles @@ -667,25 +663,23 @@ try { [[Back to top]](#) ## update-identity-profile -This updates the specified Identity Profile. +Update a specified identity profile with this PATCH request. - -Some fields of the Schema cannot be updated. These fields are listed below: +You cannot update these fields: * id -* name * created * modified * identityCount * identityRefreshRequired -* Authoritative Source and Identity Attribute Configuration cannot be modified at once. +* Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. [API Spec](https://developer.sailpoint.com/docs/api/v2024/update-identity-profile) ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | The Identity Profile ID - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +Path | IdentityProfileId | **String** | True | Identity profile ID. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. ### Return type [**IdentityProfile**](../models/identity-profile) @@ -693,7 +687,7 @@ Path | IdentityProfileId | **String** | True | The Identity Profile ID ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | The updated Identity Profile. | IdentityProfile +200 | Updated identity profile. | IdentityProfile 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -707,15 +701,15 @@ Code | Description | Data Type ### Example ```powershell -$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" -}"@ # JsonPatchOperation[] | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +}"@ # JsonPatchOperation[] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -# Update the Identity Profile +# Update Identity Profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineAccountsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineAccountsApi.md new file mode 100644 index 000000000000..dcf869e042b3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineAccountsApi.md @@ -0,0 +1,190 @@ +--- +id: v2024-machine-accounts +title: MachineAccounts +pagination_label: MachineAccounts +sidebar_label: MachineAccounts +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MachineAccounts', 'V2024MachineAccounts'] +slug: /tools/sdk/powershell/v2024/methods/machine-accounts +tags: ['SDK', 'Software Development Kit', 'MachineAccounts', 'V2024MachineAccounts'] +--- + +# MachineAccounts + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-V2024MachineAccount**](#get-machine-account) | **GET** `/machine-accounts/{id}` | Machine Account Details +[**Get-V2024MachineAccounts**](#list-machine-accounts) | **GET** `/machine-accounts` | Machine Accounts List +[**Update-V2024MachineAccount**](#update-machine-account) | **PATCH** `/machine-accounts/{id}` | Update a Machine Account + + +## get-machine-account +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Use this API to return the details for a single machine account by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-machine-account) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Machine Account ID. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**MachineAccount**](../models/machine-account) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Machine Account object. | MachineAccount +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Machine Account Details + +try { + Get-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineAccount" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + +## list-machine-accounts +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +This returns a list of machine accounts. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-machine-accounts) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + 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, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **source.name**: *eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** + +### Return type +[**MachineAccount[]**](../models/machine-account) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of machine account objects | MachineAccount[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$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 = 'identityId eq "2c9180858082150f0180893dbaf44201"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **source.name**: *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, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional) + +# Machine Accounts List + +try { + Get-V2024MachineAccounts -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024MachineAccounts -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineAccounts" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + +## update-machine-account +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Use this API to update machine accounts details. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-machine-account) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Machine Account ID. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | RequestBody | [**[]SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | True | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### Return type +[**MachineAccount**](../models/machine-account) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated Machine Account object. | MachineAccount +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}"@ # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +# Update a Machine Account + +try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MachineAccount" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineIdentitiesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineIdentitiesApi.md new file mode 100644 index 000000000000..24fcaa823807 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineIdentitiesApi.md @@ -0,0 +1,298 @@ +--- +id: v2024-machine-identities +title: MachineIdentities +pagination_label: MachineIdentities +sidebar_label: MachineIdentities +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MachineIdentities', 'V2024MachineIdentities'] +slug: /tools/sdk/powershell/v2024/methods/machine-identities +tags: ['SDK', 'Software Development Kit', 'MachineIdentities', 'V2024MachineIdentities'] +--- + +# MachineIdentities + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024MachineIdentity**](#create-machine-identity) | **POST** `/machine-identities` | Create Machine Identities +[**Remove-V2024MachineIdentity**](#delete-machine-identity) | **DELETE** `/machine-identities/{id}` | Delete machine identity +[**Get-V2024MachineIdentity**](#get-machine-identity) | **GET** `/machine-identities/{id}` | Machine Identity Details +[**Get-V2024MachineIdentities**](#list-machine-identities) | **GET** `/machine-identities` | List Machine Identities +[**Update-V2024MachineIdentity**](#update-machine-identity) | **PATCH** `/machine-identities/{id}` | Update a Machine Identity + + +## create-machine-identity +Use this API to create a machine identity. +The maximum supported length for the description field is 2000 characters. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-machine-identity) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | MachineIdentity | [**MachineIdentity**](../models/machine-identity) | True | + +### Return type +[**MachineIdentity**](../models/machine-identity) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Machine Identity created. | MachineIdentity +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$MachineIdentity = @"{ + "created" : "2015-05-28T14:07:17Z", + "businessApplication" : "ADService", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "", + "attributes" : "{\"Region\":\"EU\"}", + "id" : "id12345", + "manuallyEdited" : true +}"@ + +# Create Machine Identities + +try { + $Result = ConvertFrom-JsonToMachineIdentity -Json $MachineIdentity + New-V2024MachineIdentity -MachineIdentity $Result + + # Below is a request that includes all optional parameters + # New-V2024MachineIdentity -MachineIdentity $Result +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024MachineIdentity" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + +## delete-machine-identity +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +The API returns successful response if the requested machine identity was deleted. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-machine-identity) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Machine Identity ID + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Delete machine identity + +try { + Remove-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MachineIdentity" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + +## get-machine-identity +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +This API returns a single machine identity using the Machine Identity ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-machine-identity) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Machine Identity ID + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**MachineIdentity**](../models/machine-identity) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A machine identity object | MachineIdentity +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Machine Identity Details + +try { + Get-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineIdentity" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + +## list-machine-identities +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +This API returns a list of machine identities. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-machine-identities) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + 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: **businessApplication, name** + 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 | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**MachineIdentity[]**](../models/machine-identity) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of machine identities. | MachineIdentity[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Sorters = "businessApplication" # 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: **businessApplication, name** (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) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + +# List Machine Identities + +try { + Get-V2024MachineIdentities -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024MachineIdentities -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Count $Count -Limit $Limit -Offset $Offset +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineIdentities" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + +## update-machine-identity +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Use this API to update machine identity details. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-machine-identity) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Machine Identity ID. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | RequestBody | [**[]SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | True | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### Return type +[**MachineIdentity**](../models/machine-identity) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated Machine Identity object. | MachineIdentity +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}}"@ # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +# Update a Machine Identity + +try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MachineIdentity" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NonEmployeeLifecycleManagementApi.md index 0fcbcb23aaa7..3089eb44f3dc 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NonEmployeeLifecycleManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NonEmployeeLifecycleManagementApi.md @@ -252,7 +252,7 @@ try { [[Back to top]](#) ## create-non-employee-source -This request will create a non-employee source. Requires role context of `idn:nesr:create` +Create a non-employee source. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-non-employee-source) @@ -1404,22 +1404,20 @@ try { [[Back to top]](#) ## list-non-employee-sources -This gets a list of non-employee sources. There are two contextual uses for the requested-for path parameter: - 1. The user has the role context of `idn:nesr:read`, in which case he or -she may request a list sources assigned to a particular account manager by passing in that manager's id. - 2. The current user is an account manager, in which case "me" should be -provided as the `requested-for` value. This will provide the user with a list of the sources that he or she owns. +Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: + 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager's `id`. + 2. If the current user is an account manager, the user should provide 'me' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-non-employee-sources) ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - Query | RequestedFor | **String** | True | The identity for whom the request was made. *me* indicates the current user. 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 | NonEmployeeCount | **Boolean** | (optional) | The flag to determine whether return a non-employee count associate with source. + Query | RequestedFor | **String** | (optional) | Identity the request was made for. Use 'me' to indicate the current user. + Query | NonEmployeeCount | **Boolean** | (optional) (default to $false) | Flag that determines whether the API will return a non-employee count associated with the source. Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** ### Return type @@ -1441,20 +1439,20 @@ Code | Description | Data Type ### Example ```powershell -$RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. $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) -$NonEmployeeCount = $true # Boolean | The flag to determine whether return a non-employee count associate with source. (optional) +$RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) +$NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) # List Non-Employee Sources try { - Get-V2024NonEmployeeSources -RequestedFor $RequestedFor + Get-V2024NonEmployeeSources # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeSources -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters + # Get-V2024NonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSources" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SPConfigApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SPConfigApi.md index 50057bc70348..2c29ac34879c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SPConfigApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SPConfigApi.md @@ -27,9 +27,6 @@ Method | HTTP request | Description ## export-sp-config -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects). @@ -38,7 +35,6 @@ For more information about the object types that currently support export functi ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. Body | ExportPayload | [**ExportPayload**](../models/export-payload) | True | Export options control what will be included in the export. ### Return type @@ -61,7 +57,6 @@ Code | Description | Data Type ### Example ```powershell -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $ExportPayload = @"{ "description" : "Export Job 1 Test" }"@ @@ -70,10 +65,10 @@ $ExportPayload = @"{ try { $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-V2024SpConfig -XSailPointExperimental $XSailPointExperimental -ExportPayload $Result + Export-V2024SpConfig -ExportPayload $Result # Below is a request that includes all optional parameters - # Export-V2024SpConfig -XSailPointExperimental $XSailPointExperimental -ExportPayload $Result + # Export-V2024SpConfig -ExportPayload $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024SpConfig" Write-Host $_.ErrorDetails @@ -82,9 +77,6 @@ try { [[Back to top]](#) ## get-sp-config-export -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. The request will need one of the following security scopes: - sp:config:read - sp:config:manage @@ -95,7 +87,6 @@ The request will need one of the following security scopes: Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | The ID of the export job whose results will be downloaded. - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. ### Return type [**SpConfigExportResults**](../models/sp-config-export-results) @@ -118,15 +109,14 @@ Code | Description | Data Type ### Example ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Download export job result. try { - Get-V2024SpConfigExport -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2024SpConfigExport -Id $Id # Below is a request that includes all optional parameters - # Get-V2024SpConfigExport -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2024SpConfigExport -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExport" Write-Host $_.ErrorDetails @@ -135,9 +125,6 @@ try { [[Back to top]](#) ## get-sp-config-export-status -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: This gets the status of the export job identified by the `id` parameter. The request will need one of the following security scopes: - sp:config:read - sp:config:manage @@ -148,7 +135,6 @@ The request will need one of the following security scopes: Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | The ID of the export job whose status will be returned. - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. ### Return type [**SpConfigExportJobStatus**](../models/sp-config-export-job-status) @@ -171,15 +157,14 @@ Code | Description | Data Type ### Example ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Get export job status try { - Get-V2024SpConfigExportStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2024SpConfigExportStatus -Id $Id # Below is a request that includes all optional parameters - # Get-V2024SpConfigExportStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2024SpConfigExportStatus -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExportStatus" Write-Host $_.ErrorDetails @@ -188,9 +173,6 @@ try { [[Back to top]](#) ## get-sp-config-import -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. The request will need the following security scope: - sp:config:manage @@ -201,7 +183,6 @@ The request will need the following security scope: Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | The ID of the import job whose results will be downloaded. - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. ### Return type [**SpConfigImportResults**](../models/sp-config-import-results) @@ -224,15 +205,14 @@ Code | Description | Data Type ### Example ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Download import job result try { - Get-V2024SpConfigImport -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2024SpConfigImport -Id $Id # Below is a request that includes all optional parameters - # Get-V2024SpConfigImport -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2024SpConfigImport -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImport" Write-Host $_.ErrorDetails @@ -241,9 +221,6 @@ try { [[Back to top]](#) ## get-sp-config-import-status -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: 'This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, @@ -256,7 +233,6 @@ This API is currently in an experimental state. The API is subject to change bas Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | The ID of the import job whose status will be returned. - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. ### Return type [**SpConfigImportJobStatus**](../models/sp-config-import-job-status) @@ -279,15 +255,14 @@ Code | Description | Data Type ### Example ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Get import job status try { - Get-V2024SpConfigImportStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2024SpConfigImportStatus -Id $Id # Below is a request that includes all optional parameters - # Get-V2024SpConfigImportStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2024SpConfigImportStatus -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImportStatus" Write-Host $_.ErrorDetails @@ -296,9 +271,6 @@ try { [[Back to top]](#) ## import-sp-config -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: "This post will import objects from a JSON configuration file into\ \ a tenant. By default, every import will first export all existing objects supported\ \ by sp-config as a backup before the import is attempted. The backup is provided\ @@ -318,7 +290,6 @@ This API is currently in an experimental state. The API is subject to change bas ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. | Data | **System.IO.FileInfo** | True | JSON file containing the objects to be imported. Query | Preview | **Boolean** | (optional) (default to $false) | 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. | Options | [**ImportOptions**](../models/import-options) | (optional) | @@ -343,7 +314,6 @@ Code | Description | Data Type ### Example ```powershell -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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 = @""@ @@ -351,10 +321,10 @@ $Options = @""@ # Initiates configuration objects import job try { - Import-V2024SpConfig -XSailPointExperimental $XSailPointExperimental -Data $Data + Import-V2024SpConfig -Data $Data # Below is a request that includes all optional parameters - # Import-V2024SpConfig -XSailPointExperimental $XSailPointExperimental -Data $Data -Preview $Preview -Options $Options + # Import-V2024SpConfig -Data $Data -Preview $Preview -Options $Options } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024SpConfig" Write-Host $_.ErrorDetails @@ -363,9 +333,6 @@ try { [[Back to top]](#) ## list-sp-config-objects -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: This gets the list of object configurations which are known to the tenant export/import service. Object configurations that contain "importUrl" and "exportUrl" are available for export/import. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-sp-config-objects) @@ -373,7 +340,6 @@ This gets the list of object configurations which are known to the tenant export ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. ### Return type [**SpConfigObject[]**](../models/sp-config-object) @@ -395,15 +361,14 @@ Code | Description | Data Type ### Example ```powershell -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Get config object details try { - Get-V2024SpConfigObjects -XSailPointExperimental $XSailPointExperimental + Get-V2024SpConfigObjects # Below is a request that includes all optional parameters - # Get-V2024SpConfigObjects -XSailPointExperimental $XSailPointExperimental + # Get-V2024SpConfigObjects } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigObjects" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SuggestedEntitlementDescriptionApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SuggestedEntitlementDescriptionApi.md index 7313b66068bd..b8ed4a753ccd 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SuggestedEntitlementDescriptionApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SuggestedEntitlementDescriptionApi.md @@ -30,9 +30,6 @@ Method | HTTP request | Description ## get-sed-batch-stats -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: 'Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats @@ -45,7 +42,6 @@ This API is currently in an experimental state. The API is subject to change bas Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | BatchId | **String** | True | Batch Id - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. ### Return type [**SedBatchStats**](../models/sed-batch-stats) @@ -68,15 +64,14 @@ Code | Description | Data Type ### Example ```powershell $BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Submit Sed Batch Stats Request try { - Get-V2024SedBatchStats -BatchId $BatchId -XSailPointExperimental $XSailPointExperimental + Get-V2024SedBatchStats -BatchId $BatchId # Below is a request that includes all optional parameters - # Get-V2024SedBatchStats -BatchId $BatchId -XSailPointExperimental $XSailPointExperimental + # Get-V2024SedBatchStats -BatchId $BatchId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatchStats" Write-Host $_.ErrorDetails @@ -85,9 +80,6 @@ try { [[Back to top]](#) ## get-sed-batches -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: List Sed Batches. API responses with Sed Batch Status @@ -96,7 +88,6 @@ API responses with Sed Batch Status ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. ### Return type [**SedBatchStatus**](../models/sed-batch-status) @@ -118,15 +109,14 @@ Code | Description | Data Type ### Example ```powershell -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # List Sed Batch Request try { - Get-V2024SedBatches -XSailPointExperimental $XSailPointExperimental + Get-V2024SedBatches # Below is a request that includes all optional parameters - # Get-V2024SedBatches -XSailPointExperimental $XSailPointExperimental + # Get-V2024SedBatches } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatches" Write-Host $_.ErrorDetails @@ -135,9 +125,6 @@ try { [[Back to top]](#) ## list-seds -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: List of Suggested Entitlement Descriptions (SED) SED field descriptions: @@ -159,14 +146,14 @@ SED field descriptions: ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. - Query | Limit | **Int64** | (optional) | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + Query | 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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** - Query | Count | **Boolean** | (optional) | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. - Query | CountOnly | **Boolean** | (optional) | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. - Query | RequestedByAnyone | **Boolean** | (optional) | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested - Query | ShowPendingStatusOnly | **Boolean** | (optional) | Will limit records to items that are in ""suggested"" or ""approved"" status + Query | CountOnly | **Boolean** | (optional) (default to $false) | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. + Query | RequestedByAnyone | **Boolean** | (optional) (default to $false) | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested + Query | ShowPendingStatusOnly | **Boolean** | (optional) (default to $false) | Will limit records to items that are in ""suggested"" or ""approved"" status ### Return type [**Sed[]**](../models/sed) @@ -188,22 +175,22 @@ Code | Description | Data Type ### Example ```powershell -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -$Limit = limit=25 # Int64 | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) +$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 = 'displayName co "Read and Write"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) $Sorters = "sorters=displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional) -$Count = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) -$CountOnly = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) -$RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) -$ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) +$CountOnly = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to $false) +$RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to $false) +$ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) (default to $false) # List Suggested Entitlement Descriptions try { - Get-V2024Seds -XSailPointExperimental $XSailPointExperimental + Get-V2024Seds # Below is a request that includes all optional parameters - # Get-V2024Seds -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Filters $Filters -Sorters $Sorters -Count $Count -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $ShowPendingStatusOnly + # Get-V2024Seds -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $ShowPendingStatusOnly } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Seds" Write-Host $_.ErrorDetails @@ -212,9 +199,6 @@ try { [[Back to top]](#) ## patch-sed -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: Patch Suggested Entitlement Description [API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-sed) @@ -223,7 +207,6 @@ Patch Suggested Entitlement Description Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | id is sed id - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. Body | SedPatch | [**[]SedPatch**](../models/sed-patch) | True | Sed Patch Request ### Return type @@ -247,7 +230,6 @@ Code | Description | Data Type ### Example ```powershell $Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $SedPatch = @"{ "op" : "replace", "path" : "status", @@ -259,10 +241,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch - Update-V2024Sed -Id $Id -XSailPointExperimental $XSailPointExperimental -SedPatch $Result + Update-V2024Sed -Id $Id -SedPatch $Result # Below is a request that includes all optional parameters - # Update-V2024Sed -Id $Id -XSailPointExperimental $XSailPointExperimental -SedPatch $Result + # Update-V2024Sed -Id $Id -SedPatch $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Sed" Write-Host $_.ErrorDetails @@ -271,9 +253,6 @@ try { [[Back to top]](#) ## submit-sed-approval -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: Submit Bulk Approval Request for SED. Request body takes list of SED Ids. API responses with list of SED Approval Status @@ -282,7 +261,6 @@ Request body takes list of SED Ids. API responses with list of SED Approval Stat ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. Body | SedApproval | [**[]SedApproval**](../models/sed-approval) | True | Sed Approval ### Return type @@ -305,7 +283,6 @@ Code | Description | Data Type ### Example ```powershell -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $SedApproval = @"{ "items" : "016629d1-1d25-463f-97f3-c6686846650" }"@ # SedApproval[] | Sed Approval @@ -315,10 +292,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval - Submit-V2024SedApproval -XSailPointExperimental $XSailPointExperimental -SedApproval $Result + Submit-V2024SedApproval -SedApproval $Result # Below is a request that includes all optional parameters - # Submit-V2024SedApproval -XSailPointExperimental $XSailPointExperimental -SedApproval $Result + # Submit-V2024SedApproval -SedApproval $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedApproval" Write-Host $_.ErrorDetails @@ -327,9 +304,6 @@ try { [[Back to top]](#) ## submit-sed-assignment -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: Submit Assignment Request. Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together @@ -338,7 +312,6 @@ Request body has an assignee, and list of SED Ids that are assigned to that assi ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. Body | SedAssignment | [**SedAssignment**](../models/sed-assignment) | True | Sed Assignment Request ### Return type @@ -361,7 +334,6 @@ Code | Description | Data Type ### Example ```powershell -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $SedAssignment = @"{ "assignee" : { "type" : "SOURCE_OWNER", @@ -374,10 +346,10 @@ $SedAssignment = @"{ try { $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment - Submit-V2024SedAssignment -XSailPointExperimental $XSailPointExperimental -SedAssignment $Result + Submit-V2024SedAssignment -SedAssignment $Result # Below is a request that includes all optional parameters - # Submit-V2024SedAssignment -XSailPointExperimental $XSailPointExperimental -SedAssignment $Result + # Submit-V2024SedAssignment -SedAssignment $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedAssignment" Write-Host $_.ErrorDetails @@ -386,9 +358,6 @@ try { [[Back to top]](#) ## submit-sed-batch-request -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: Submit Sed Batch Request. Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together @@ -397,7 +366,6 @@ Request body has one of the following: - a list of entitlement Ids - a list of S ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. Body | SedBatchRequest | [**SedBatchRequest**](../models/sed-batch-request) | (optional) | Sed Batch Request ### Return type @@ -420,7 +388,6 @@ Code | Description | Data Type ### Example ```powershell -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $SedBatchRequest = @"{ "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] @@ -429,10 +396,10 @@ $SedBatchRequest = @"{ # Submit Sed Batch Request try { - Submit-V2024SedBatchRequest -XSailPointExperimental $XSailPointExperimental + Submit-V2024SedBatchRequest # Below is a request that includes all optional parameters - # Submit-V2024SedBatchRequest -XSailPointExperimental $XSailPointExperimental -SedBatchRequest $Result + # Submit-V2024SedBatchRequest -SedBatchRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedBatchRequest" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TenantApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TenantApi.md index 1a7dbdbbc57a..c54ae3159103 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TenantApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TenantApi.md @@ -21,9 +21,6 @@ Method | HTTP request | Description ## get-tenant -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: This rest endpoint can be used to retrieve tenant details. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-tenant) @@ -31,7 +28,6 @@ This rest endpoint can be used to retrieve tenant details. ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. ### Return type [**Tenant**](../models/tenant) @@ -53,15 +49,14 @@ Code | Description | Data Type ### Example ```powershell -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Get Tenant Information. try { - Get-V2024Tenant -XSailPointExperimental $XSailPointExperimental + Get-V2024Tenant # Below is a request that includes all optional parameters - # Get-V2024Tenant -XSailPointExperimental $XSailPointExperimental + # Get-V2024Tenant } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Tenant" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestRecommendationConfigDto.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestRecommendationConfigDto.md new file mode 100644 index 000000000000..859a39adeecf --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestRecommendationConfigDto.md @@ -0,0 +1,45 @@ +--- +id: v2024-access-request-recommendation-config-dto +title: AccessRequestRecommendationConfigDto +pagination_label: AccessRequestRecommendationConfigDto +sidebar_label: AccessRequestRecommendationConfigDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationConfigDto', 'V2024AccessRequestRecommendationConfigDto'] +slug: /tools/sdk/powershell/v2024/models/access-request-recommendation-config-dto +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationConfigDto', 'V2024AccessRequestRecommendationConfigDto'] +--- + + +# AccessRequestRecommendationConfigDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ScoreThreshold** | **Double** | The value that internal calculations need to exceed for recommendations to be made. | [required] +**StartDateAttribute** | **String** | Use to map an attribute name for determining identities' start date. | [optional] +**RestrictionAttribute** | **String** | Use to only give recommendations based on this attribute. | [optional] +**MoverAttribute** | **String** | Use to map an attribute name for determining whether identities are movers. | [optional] +**JoinerAttribute** | **String** | Use to map an attribute name for determining whether identities are joiners. | [optional] +**UseRestrictionAttribute** | **Boolean** | Use only the attribute named in restrictionAttribute to make recommendations. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestRecommendationConfigDto = Initialize-PSSailpoint.V2024AccessRequestRecommendationConfigDto -ScoreThreshold 0.5 ` + -StartDateAttribute startDate ` + -RestrictionAttribute location ` + -MoverAttribute isMover ` + -JoinerAttribute isJoiner ` + -UseRestrictionAttribute true +``` + +- Convert the resource to JSON +```powershell +$AccessRequestRecommendationConfigDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md index 9cb9ee94fc6c..b901e027d0bc 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 Thu Apr 20 20:00:00 EDT 2023 ` +$AccountUsage = Initialize-PSSailpoint.V2024AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttributeConfig.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttributeConfig.md index 82aba545b9be..dc79b5362397 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttributeConfig.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttributeConfig.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig', 'V2024Ident Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Enabled** | **Boolean** | The backend will only promote values if the profile/mapping is enabled. | [optional] [default to $false] +**Enabled** | **Boolean** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to $false] **AttributeTransforms** | [**[]IdentityAttributeTransform**](identity-attribute-transform) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttributeTransform.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttributeTransform.md index 1c0ccc4054a4..13b767113dba 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttributeTransform.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttributeTransform.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform', 'V2024Id Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IdentityAttributeName** | **String** | Name of the identity attribute. | [optional] +**IdentityAttributeName** | **String** | Identity attribute's name. | [optional] **TransformDefinition** | [**TransformDefinition**](transform-definition) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityExceptionReportReference.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityExceptionReportReference.md index f4e7a125e75f..8df214ad6110 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityExceptionReportReference.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityExceptionReportReference.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference', 'V Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TaskResultId** | **String** | The id of the task result. | [optional] -**ReportName** | **String** | The name of the report. | [optional] +**TaskResultId** | **String** | Task result ID. | [optional] +**ReportName** | **String** | Report name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfile.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfile.md index 2c14ca9eb361..bca39a3f36a0 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfile.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfile.md @@ -20,15 +20,15 @@ Name | Type | Description | Notes **Name** | **String** | Name of the Object | [required] **Created** | **System.DateTime** | Creation date of the Object | [optional] [readonly] **Modified** | **System.DateTime** | Last modification date of the Object | [optional] [readonly] -**Description** | **String** | The description of the Identity Profile. | [optional] +**Description** | **String** | Identity profile's description. | [optional] **Owner** | [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional] -**Priority** | **Int64** | The priority for an Identity Profile. | [optional] +**Priority** | **Int64** | Identity profile's priority. | [optional] **AuthoritativeSource** | [**IdentityProfileAllOfAuthoritativeSource**](identity-profile-all-of-authoritative-source) | | [required] -**IdentityRefreshRequired** | **Boolean** | True if a identity refresh is needed. Typically triggered when a change on the source has been made. | [optional] [default to $false] -**IdentityCount** | **Int32** | The number of identities that belong to the Identity Profile. | [optional] +**IdentityRefreshRequired** | **Boolean** | Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. | [optional] [default to $false] +**IdentityCount** | **Int32** | Number of identities belonging to the identity profile. | [optional] **IdentityAttributeConfig** | [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] **IdentityExceptionReportReference** | [**IdentityExceptionReportReference**](identity-exception-report-reference) | | [optional] -**HasTimeBasedAttr** | **Boolean** | Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. | [optional] [default to $false] +**HasTimeBasedAttr** | **Boolean** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to $false] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfileAllOfAuthoritativeSource.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfileAllOfAuthoritativeSource.md index 783b99110147..07ac75fe8ec7 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfileAllOfAuthoritativeSource.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfileAllOfAuthoritativeSource.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfAuthoritativeSour Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **Enum** [ "SOURCE" ] | Type of the object to which this reference applies | [optional] -**Id** | **String** | ID of the object to which this reference applies | [optional] -**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional] +**Type** | **Enum** [ "SOURCE" ] | Authoritative source's object type. | [optional] +**Id** | **String** | Authoritative source's ID. | [optional] +**Name** | **String** | Authoritative source's name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfileAllOfOwner.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfileAllOfOwner.md index dd76789ffe0a..5e543c4c126e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfileAllOfOwner.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfileAllOfOwner.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfOwner', 'V2024Ide Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY" ] | Type of the object to which this reference applies | [optional] -**Id** | **String** | ID of the object to which this reference applies | [optional] -**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional] +**Type** | **Enum** [ "IDENTITY" ] | Owner's object type. | [optional] +**Id** | **String** | Owner's ID. | [optional] +**Name** | **String** | Owner's name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/MachineAccount.md b/docs/tools/sdk/powershell/Reference/V2024/Models/MachineAccount.md new file mode 100644 index 000000000000..b14a12f768a0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/MachineAccount.md @@ -0,0 +1,75 @@ +--- +id: v2024-machine-account +title: MachineAccount +pagination_label: MachineAccount +sidebar_label: MachineAccount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MachineAccount', 'V2024MachineAccount'] +slug: /tools/sdk/powershell/v2024/models/machine-account +tags: ['SDK', 'Software Development Kit', 'MachineAccount', 'V2024MachineAccount'] +--- + + +# MachineAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **String** | Name of the Object | [required] +**Created** | **System.DateTime** | Creation date of the Object | [optional] [readonly] +**Modified** | **System.DateTime** | Last modification date of the Object | [optional] [readonly] +**Description** | **String** | A description of the machine account | [optional] +**NativeIdentity** | **String** | The unique ID of the machine account generated by the source system | [required] +**Uuid** | **String** | The unique ID of the account as determined by the account schema | [optional] +**ClassificationMethod** | **Enum** [ "SOURCE", "CRITERIA", "DISCOVERY", "MANUAL" ] | Classification Method | [required] +**MachineIdentity** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The machine identity this account is associated with | [optional] +**OwnerIdentity** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The identity who owns this account. | [optional] +**AccessType** | **String** | The connection type of the source this account is from | [optional] +**Subtype** | **String** | The sub-type | [optional] +**Environment** | **String** | Environment | [optional] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Custom attributes specific to the machine account | [optional] +**ConnectorAttributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The connector attributes for the account | [required] +**ManuallyCorrelated** | **Boolean** | Indicates if the account has been manually correlated to an identity | [optional] [default to $false] +**ManuallyEdited** | **Boolean** | Indicates if the account has been manually edited | [required][default to $false] +**Locked** | **Boolean** | Indicates if the account is currently locked | [required] +**Enabled** | **Boolean** | Indicates if the account is enabled | [required][default to $false] +**HasEntitlements** | **Boolean** | Indicates if the account has entitlements | [required][default to $true] +**Source** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The source this machine account belongs to. | [required] + +## Examples + +- Prepare the resource +```powershell +$MachineAccount = Initialize-PSSailpoint.V2024MachineAccount -Id id12345 ` + -Name aName ` + -Created 2015-05-28T14:07:17Z ` + -Modified 2015-05-28T14:07:17Z ` + -Description Service account for Active Directory ` + -NativeIdentity 552775 ` + -Uuid {b0dce506-d6d4-44d2-8a32-d9a5b21fb175} ` + -ClassificationMethod SOURCE ` + -MachineIdentity {id=1540e5a4-6c2e-4bf1-b88e-c08cae0696e9, type=MACHINE_IDENTITY, name=SVC_ADService} ` + -OwnerIdentity {id=2c918084660f45d6016617daa9210584, type=IDENTITY, name=Adam Kennedy} ` + -AccessType direct ` + -Subtype null ` + -Environment TEST ` + -Attributes {firstName=SailPoint, lastName=Support, displayName=SailPoint Support} ` + -ConnectorAttributes {mail=machine-178@sailpoint.com, givenName=Support, displayName=SailPoint Support} ` + -ManuallyCorrelated true ` + -ManuallyEdited true ` + -Locked false ` + -Enabled false ` + -HasEntitlements false ` + -Source {id=8d3e0094e99445de98eef6c75e25jc04, type=SOURCE, name=Active Directory} +``` + +- Convert the resource to JSON +```powershell +$MachineAccount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/MachineIdentity.md b/docs/tools/sdk/powershell/Reference/V2024/Models/MachineIdentity.md new file mode 100644 index 000000000000..1b12110bf75b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/MachineIdentity.md @@ -0,0 +1,49 @@ +--- +id: v2024-machine-identity +title: MachineIdentity +pagination_label: MachineIdentity +sidebar_label: MachineIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MachineIdentity', 'V2024MachineIdentity'] +slug: /tools/sdk/powershell/v2024/models/machine-identity +tags: ['SDK', 'Software Development Kit', 'MachineIdentity', 'V2024MachineIdentity'] +--- + + +# MachineIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **String** | Name of the Object | [required] +**Created** | **System.DateTime** | Creation date of the Object | [optional] [readonly] +**Modified** | **System.DateTime** | Last modification date of the Object | [optional] [readonly] +**BusinessApplication** | **String** | The business application that the identity represents | [required] +**Description** | **String** | Description of machine identity | [optional] +**ManuallyEdited** | **Boolean** | Indicates if the machine identity has been manually edited | [optional] [default to $false] +**Attributes** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A map of custom machine identity attributes | [optional] + +## Examples + +- Prepare the resource +```powershell +$MachineIdentity = Initialize-PSSailpoint.V2024MachineIdentity -Id id12345 ` + -Name aName ` + -Created 2015-05-28T14:07:17Z ` + -Modified 2015-05-28T14:07:17Z ` + -BusinessApplication ADService ` + -Description ` + -ManuallyEdited true ` + -Attributes {"Region":"EU"} +``` + +- Convert the resource to JSON +```powershell +$MachineIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md index 54727248f717..6393f6ed6e03 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 Mon Mar 23 20:00:00 EDT 2020 ` - -EndDate Wed Mar 24 20:00:00 EDT 2021 ` + -StartDate Tue Mar 24 00:00:00 UTC 2020 ` + -EndDate Thu Mar 25 00:00:00 UTC 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeSourceWithNECount.md b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeSourceWithNECount.md index 60c1c34c67ed..eb4e7318c2b1 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeSourceWithNECount.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeSourceWithNECount.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes **AccountManagers** | [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] **Modified** | **System.DateTime** | When the request was last modified. | [optional] **Created** | **System.DateTime** | When the request was created. | [optional] -**NonEmployeeCount** | **Int32** | Number of non-employee records associated with this source. | [optional] +**NonEmployeeCount** | **Int32** | Number of non-employee records associated with this source. This value is 'NULL' by default. To get the non-employee count, you must set the `non-employee-count` flag in your request to 'true'. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md index 235e4ab2c339..3d6b4c94acc1 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 Thu Apr 20 20:00:00 EDT 2023 ` +$SourceUsage = Initialize-PSSailpoint.V2024SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10.45 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigObject.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigObject.md index f715ae4ac2c3..207e294e5695 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigObject.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigObject.md @@ -19,6 +19,7 @@ Name | Type | Description | Notes **ObjectType** | **String** | The object type this configuration is for. | [optional] **ReferenceExtractors** | **[]String** | List of json paths within an exported object of this type that represent references that need to be resolved. | [optional] **SignatureRequired** | **Boolean** | If true, this type of object will be JWS signed and cannot be modified before import. | [optional] [default to $false] +**AlwaysResolveById** | **Boolean** | Whether this object type has to be resolved always by ID | [optional] [default to $false] **LegacyObject** | **Boolean** | Whether this is a legacy object | [optional] [default to $false] **OnePerTenant** | **Boolean** | Whether there is only one object of this type | [optional] [default to $false] **Exportable** | **Boolean** | Whether this object can be exported or it is just a reference object | [optional] [default to $false] @@ -31,6 +32,7 @@ Name | Type | Description | Notes $SpConfigObject = Initialize-PSSailpoint.V2024SpConfigObject -ObjectType TRIGGER_SUBSCRIPTION ` -ReferenceExtractors [$.owner] ` -SignatureRequired false ` + -AlwaysResolveById true ` -LegacyObject false ` -OnePerTenant false ` -Exportable true ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigRule.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigRule.md index f1baab92676d..67141faf23f9 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigRule.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigRule.md @@ -17,8 +17,8 @@ tags: ['SDK', 'Software Development Kit', 'SpConfigRule', 'V2024SpConfigRule'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Path** | **String** | JSONPath expression denoting the path within the object where a value substitution should be applied | [optional] -**Value** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Value to be assigned at the jsonPath location within the object | [optional] -**Mode** | **[]String** | Draft modes to which this rule will apply | [optional] +**Value** | [**SpConfigRuleValue**](sp-config-rule-value) | | [optional] +**Modes** | **[]String** | Draft modes to which this rule will apply | [optional] ## Examples @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $SpConfigRule = Initialize-PSSailpoint.V2024SpConfigRule -Path $.enabled ` -Value null ` - -Mode [RESTORE, PROMOTE] + -Modes [RESTORE, PROMOTE] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigRuleValue.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigRuleValue.md new file mode 100644 index 000000000000..a975f10153d5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigRuleValue.md @@ -0,0 +1,34 @@ +--- +id: v2024-sp-config-rule-value +title: SpConfigRuleValue +pagination_label: SpConfigRuleValue +sidebar_label: SpConfigRuleValue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigRuleValue', 'V2024SpConfigRuleValue'] +slug: /tools/sdk/powershell/v2024/models/sp-config-rule-value +tags: ['SDK', 'Software Development Kit', 'SpConfigRuleValue', 'V2024SpConfigRuleValue'] +--- + + +# SpConfigRuleValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$SpConfigRuleValue = Initialize-PSSailpoint.V2024SpConfigRuleValue +``` + +- Convert the resource to JSON +```powershell +$SpConfigRuleValue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/TransformDefinition.md b/docs/tools/sdk/powershell/Reference/V2024/Models/TransformDefinition.md index d58c716ee0f8..2a7340bd55dd 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/TransformDefinition.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/TransformDefinition.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'TransformDefinition', 'V2024Transform Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **String** | The type of the transform definition. | [optional] +**Type** | **String** | Transform definition type. | [optional] **Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Arbitrary key-value pairs to store any metadata for the object | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowExecution.md b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowExecution.md index c2fdf1dec278..534e28991045 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowExecution.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowExecution.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **RequestId** | **String** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] **StartTime** | **System.DateTime** | Date/time when the workflow started. | [optional] **CloseTime** | **System.DateTime** | Date/time when the workflow ended. | [optional] -**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Executing" ] | Workflow execution status. | [optional] +**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Running" ] | Workflow execution status. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/AccountsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/AccountsApi.md index 410d3e0523ee..efd82e759b90 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/AccountsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/AccountsApi.md @@ -386,8 +386,8 @@ Param Type | Name | Data Type | Required | Description Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. 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 | DetailLevel | **String** | (optional) | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. - 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** + 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** ### Return type [**Account[]**](../models/account) @@ -412,8 +412,8 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) -$Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* (optional) -$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) +$Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) +$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) # Accounts List diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/IdentityProfilesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/IdentityProfilesApi.md index 1ef0b0c0c908..d45a1b87eddf 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/IdentityProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/IdentityProfilesApi.md @@ -27,21 +27,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-IdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create an Identity Profile -[**Remove-IdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete an Identity Profile +[**New-IdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create Identity Profile +[**Remove-IdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete Identity Profile [**Remove-IdentityProfiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete Identity Profiles [**Export-IdentityProfiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export Identity Profiles [**Get-DefaultIdentityAttributeConfig**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default Identity Attribute Config -[**Get-IdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get single Identity Profile +[**Get-IdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get Identity Profile [**Import-IdentityProfiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import Identity Profiles -[**Get-IdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | Identity Profiles List +[**Get-IdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List Identity Profiles [**Show-IdentityPreview**](#show-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview [**Sync-IdentityProfile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile -[**Update-IdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update the Identity Profile +[**Update-IdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update Identity Profile ## create-identity-profile -This creates an Identity Profile. +Creates an identity profile. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-identity-profile) @@ -56,7 +56,7 @@ Param Type | Name | Data Type | Required | Description ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -201 | The created Identity Profile | IdentityProfile +201 | Created identity profile. | IdentityProfile 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -119,7 +119,7 @@ $IdentityProfile = @"{ "id" : "id12345" }"@ -# Create an Identity Profile +# Create Identity Profile try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile @@ -135,19 +135,15 @@ try { [[Back to top]](#) ## delete-identity-profile -This deletes an Identity Profile based on ID. - +Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. - - -The following rights are required to access this endpoint: idn:identity-profile:delete [API Spec](https://developer.sailpoint.com/docs/api/v3/delete-identity-profile) ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | The Identity Profile ID. +Path | IdentityProfileId | **String** | True | Identity profile ID. ### Return type [**TaskResultSimplified**](../models/task-result-simplified) @@ -169,9 +165,9 @@ Code | Description | Data Type ### Example ```powershell -$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID. +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. -# Delete an Identity Profile +# Delete Identity Profile try { Remove-IdentityProfile -IdentityProfileId $IdentityProfileId @@ -337,14 +333,14 @@ try { [[Back to top]](#) ## get-identity-profile -This returns a single Identity Profile based on ID. +Get a single identity profile by ID. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-profile) ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | The Identity Profile ID. +Path | IdentityProfileId | **String** | True | Identity profile ID. ### Return type [**IdentityProfile**](../models/identity-profile) @@ -352,7 +348,7 @@ Path | IdentityProfileId | **String** | True | The Identity Profile ID. ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | An Identity Profile object. | IdentityProfile +200 | Identity profile object. | IdentityProfile 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -366,9 +362,9 @@ Code | Description | Data Type ### Example ```powershell -$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. +$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. -# Get single Identity Profile +# Get Identity Profile try { Get-IdentityProfile -IdentityProfileId $IdentityProfileId @@ -491,7 +487,7 @@ try { [[Back to top]](#) ## list-identity-profiles -This returns a list of Identity Profiles based on the specified query parameters. +Get a list of identity profiles, based on the specified query parameters. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-identity-profiles) @@ -501,7 +497,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, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* + 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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** ### Return type @@ -510,7 +506,7 @@ Param Type | Name | Data Type | Required | Description ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | List of identityProfiles. | IdentityProfile[] +200 | List of identity profiles. | IdentityProfile[] 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -526,10 +522,10 @@ Code | Description | Data Type $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional) +$Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) -# Identity Profiles List +# List Identity Profiles try { Get-IdentityProfiles @@ -667,25 +663,23 @@ try { [[Back to top]](#) ## update-identity-profile -This updates the specified Identity Profile. +Update a specified identity profile with this PATCH request. - -Some fields of the Schema cannot be updated. These fields are listed below: +You cannot update these fields: * id -* name * created * modified * identityCount * identityRefreshRequired -* Authoritative Source and Identity Attribute Configuration cannot be modified at once. +* Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. [API Spec](https://developer.sailpoint.com/docs/api/v3/update-identity-profile) ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | The Identity Profile ID - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +Path | IdentityProfileId | **String** | True | Identity profile ID. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. ### Return type [**IdentityProfile**](../models/identity-profile) @@ -693,7 +687,7 @@ Path | IdentityProfileId | **String** | True | The Identity Profile ID ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | The updated Identity Profile. | IdentityProfile +200 | Updated identity profile. | IdentityProfile 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -707,15 +701,15 @@ Code | Description | Data Type ### Example ```powershell -$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" -}"@ # JsonPatchOperation[] | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +}"@ # JsonPatchOperation[] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -# Update the Identity Profile +# Update Identity Profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md index 5f9bbcb62eec..58c560f9494c 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md @@ -252,7 +252,7 @@ try { [[Back to top]](#) ## create-non-employee-source -This request will create a non-employee source. Requires role context of `idn:nesr:create` +Create a non-employee source. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-non-employee-source) @@ -1404,22 +1404,20 @@ try { [[Back to top]](#) ## list-non-employee-sources -This gets a list of non-employee sources. There are two contextual uses for the requested-for path parameter: - 1. The user has the role context of `idn:nesr:read`, in which case he or -she may request a list sources assigned to a particular account manager by passing in that manager's id. - 2. The current user is an account manager, in which case "me" should be -provided as the `requested-for` value. This will provide the user with a list of the sources that he or she owns. +Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: + 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager's `id`. + 2. If the current user is an account manager, the user should provide 'me' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-non-employee-sources) ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - Query | RequestedFor | **String** | True | The identity for whom the request was made. *me* indicates the current user. 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 | NonEmployeeCount | **Boolean** | (optional) | The flag to determine whether return a non-employee count associate with source. + Query | RequestedFor | **String** | (optional) | Identity the request was made for. Use 'me' to indicate the current user. + Query | NonEmployeeCount | **Boolean** | (optional) (default to $false) | Flag that determines whether the API will return a non-employee count associated with the source. Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** ### Return type @@ -1441,20 +1439,20 @@ Code | Description | Data Type ### Example ```powershell -$RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. $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) -$NonEmployeeCount = $true # Boolean | The flag to determine whether return a non-employee count associate with source. (optional) +$RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) +$NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) # List Non-Employee Sources try { - Get-NonEmployeeSources -RequestedFor $RequestedFor + Get-NonEmployeeSources # Below is a request that includes all optional parameters - # Get-NonEmployeeSources -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters + # Get-NonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSources" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md index 3b9cae031d5f..35c8a92f6b89 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 Thu Apr 20 20:00:00 EDT 2023 ` +$AccountUsage = Initialize-PSSailpoint.V3AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAttributeConfig.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAttributeConfig.md index f5693610feed..7ba016fe415b 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAttributeConfig.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAttributeConfig.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig', 'IdentityAt Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Enabled** | **Boolean** | The backend will only promote values if the profile/mapping is enabled. | [optional] [default to $false] +**Enabled** | **Boolean** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to $false] **AttributeTransforms** | [**[]IdentityAttributeTransform**](identity-attribute-transform) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAttributeTransform.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAttributeTransform.md index f1622242f6b4..f884829601e7 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAttributeTransform.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAttributeTransform.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform', 'Identit Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IdentityAttributeName** | **String** | Name of the identity attribute. | [optional] +**IdentityAttributeName** | **String** | Identity attribute's name. | [optional] **TransformDefinition** | [**TransformDefinition**](transform-definition) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityExceptionReportReference.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityExceptionReportReference.md index 0dc3f7dd2189..4290c57af4a0 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityExceptionReportReference.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityExceptionReportReference.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference', 'I Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TaskResultId** | **String** | The id of the task result. | [optional] -**ReportName** | **String** | The name of the report. | [optional] +**TaskResultId** | **String** | Task result ID. | [optional] +**ReportName** | **String** | Report name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfile.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfile.md index 332626ceb26b..020457df8fb3 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfile.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfile.md @@ -20,15 +20,15 @@ Name | Type | Description | Notes **Name** | **String** | Name of the Object | [required] **Created** | **System.DateTime** | Creation date of the Object | [optional] [readonly] **Modified** | **System.DateTime** | Last modification date of the Object | [optional] [readonly] -**Description** | **String** | The description of the Identity Profile. | [optional] +**Description** | **String** | Identity profile's description. | [optional] **Owner** | [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional] -**Priority** | **Int64** | The priority for an Identity Profile. | [optional] +**Priority** | **Int64** | Identity profile's priority. | [optional] **AuthoritativeSource** | [**IdentityProfileAllOfAuthoritativeSource**](identity-profile-all-of-authoritative-source) | | [required] -**IdentityRefreshRequired** | **Boolean** | True if a identity refresh is needed. Typically triggered when a change on the source has been made. | [optional] [default to $false] -**IdentityCount** | **Int32** | The number of identities that belong to the Identity Profile. | [optional] +**IdentityRefreshRequired** | **Boolean** | Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. | [optional] [default to $false] +**IdentityCount** | **Int32** | Number of identities belonging to the identity profile. | [optional] **IdentityAttributeConfig** | [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] **IdentityExceptionReportReference** | [**IdentityExceptionReportReference**](identity-exception-report-reference) | | [optional] -**HasTimeBasedAttr** | **Boolean** | Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. | [optional] [default to $false] +**HasTimeBasedAttr** | **Boolean** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to $false] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfileAllOfAuthoritativeSource.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfileAllOfAuthoritativeSource.md index ef2d8c38798e..ab7a1b937ff4 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfileAllOfAuthoritativeSource.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfileAllOfAuthoritativeSource.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfAuthoritativeSour Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **Enum** [ "SOURCE" ] | Type of the object to which this reference applies | [optional] -**Id** | **String** | ID of the object to which this reference applies | [optional] -**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional] +**Type** | **Enum** [ "SOURCE" ] | Authoritative source's object type. | [optional] +**Id** | **String** | Authoritative source's ID. | [optional] +**Name** | **String** | Authoritative source's name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfileAllOfOwner.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfileAllOfOwner.md index e3a823081ebf..000fd33d1002 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfileAllOfOwner.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfileAllOfOwner.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfOwner', 'Identity Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY" ] | Type of the object to which this reference applies | [optional] -**Id** | **String** | ID of the object to which this reference applies | [optional] -**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional] +**Type** | **Enum** [ "IDENTITY" ] | Owner's object type. | [optional] +**Id** | **String** | Owner's ID. | [optional] +**Name** | **String** | Owner's name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md index 071f0e39af08..17d96a07351b 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 Mon Mar 23 20:00:00 EDT 2020 ` - -EndDate Wed Mar 24 20:00:00 EDT 2021 ` + -StartDate Tue Mar 24 00:00:00 UTC 2020 ` + -EndDate Thu Mar 25 00:00:00 UTC 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeSourceWithNECount.md b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeSourceWithNECount.md index 4e5b4bae238b..4cce4ddd4ad8 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeSourceWithNECount.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeSourceWithNECount.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes **AccountManagers** | [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] **Modified** | **System.DateTime** | When the request was last modified. | [optional] **Created** | **System.DateTime** | When the request was created. | [optional] -**NonEmployeeCount** | **Int32** | Number of non-employee records associated with this source. | [optional] +**NonEmployeeCount** | **Int32** | Number of non-employee records associated with this source. This value is 'NULL' by default. To get the non-employee count, you must set the `non-employee-count` flag in your request to 'true'. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md index 92919ac01f24..0328c565b955 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 Thu Apr 20 20:00:00 EDT 2023 ` +$SourceUsage = Initialize-PSSailpoint.V3SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` -Count 10.45 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/TransformDefinition.md b/docs/tools/sdk/powershell/Reference/V3/Models/TransformDefinition.md index 5102243eeb1d..6234edfd8c4c 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/TransformDefinition.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/TransformDefinition.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'TransformDefinition', 'TransformDefin Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **String** | The type of the transform definition. | [optional] +**Type** | **String** | Transform definition type. | [optional] **Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Arbitrary key-value pairs to store any metadata for the object | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowExecution.md b/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowExecution.md index 28b3d0e3c1ab..b8adc8865773 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowExecution.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowExecution.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **RequestId** | **String** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] **StartTime** | **System.DateTime** | Date/time when the workflow started. | [optional] **CloseTime** | **System.DateTime** | Date/time when the workflow ended. | [optional] -**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Executing" ] | Workflow execution status. | [optional] +**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Running" ] | Workflow execution status. | [optional] ## Examples diff --git a/static/code-examples/beta/code_examples_overlay.yaml b/static/code-examples/beta/code_examples_overlay.yaml index b771228d4180..ce5537cf6d15 100644 --- a/static/code-examples/beta/code_examples_overlay.yaml +++ b/static/code-examples/beta/code_examples_overlay.yaml @@ -803,6 +803,29 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountAggregationStatus" Write-Host $_.ErrorDetails } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/account-usages#get-usages-by-account-id + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + Get-BetaUsagesByAccountId -AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-BetaUsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesByAccountId" + Write-Host $_.ErrorDetails + } - path: /accounts method: POST xCodeSample: @@ -1061,8 +1084,8 @@ $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 = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) + $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le* **modified**: *eq, ge, gt, le, lt* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (optional) # Accounts List @@ -1175,29 +1198,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccount" Write-Host $_.ErrorDetails } -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/account-usages#get-usages-by-account-id - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns account usage insights - - try { - Get-BetaUsagesByAccountId -AccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-BetaUsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesByAccountId" - Write-Host $_.ErrorDetails - } - path: /discovered-applications/{id} method: GET xCodeSample: @@ -6034,7 +6034,7 @@ } "@ - # Create an Identity Profile + # Create Identity Profile try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile @@ -6052,9 +6052,9 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#delete-identity-profile source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID. + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. - # Delete an Identity Profile + # Delete Identity Profile try { Remove-BetaIdentityProfile -IdentityProfileId $IdentityProfileId @@ -6135,9 +6135,9 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#get-identity-profile source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. - # Gets a single Identity Profile + # Get Identity Profile try { Get-BetaIdentityProfile -IdentityProfileId $IdentityProfileId @@ -6239,10 +6239,10 @@ $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 8c190e6787aa4ed9a90bd9d5344523fb" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional) + $Filters = "id eq 8c190e6787aa4ed9a90bd9d5344523fb" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) $Sorters = "name,-priority" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) - # Identity Profiles List + # List Identity Profiles try { Get-BetaIdentityProfiles @@ -6326,7 +6326,7 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#update-identity-profile source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", @@ -6334,7 +6334,7 @@ }"@ - # Update the Identity Profile + # Update Identity Profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -6536,162 +6536,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaLifecycleStates" Write-Host $_.ErrorDetails } -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clients#get-managed-client-status - source: | - $Id = "aClientId" # String | ID of the Managed Client Status to get - $Type = "CCG" # ManagedClientType | Type of the Managed Client Status to get - - # Specified Managed Client Status. - - try { - Get-BetaManagedClientStatus -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-BetaManagedClientStatus -Id $Id -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClientStatus" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id}/status - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clients#update-managed-client-status - source: | - $Id = "aClientId" # String | ID of the Managed Client Status to update - $ManagedClientStatus = @" - { - "body" : { - "alertKey" : "", - "id" : "5678", - "clusterId" : "1234", - "ccg_etag" : "ccg_etag123xyz456", - "ccg_pin" : "NONE", - "cookbook_etag" : "20210420125956-20210511144538", - "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", - "internal_ip" : "127.0.0.1", - "lastSeen" : "1620843964604", - "sinceSeen" : "14708", - "sinceSeenMillis" : "14708", - "localDev" : false, - "stacktrace" : "", - "status" : "NORMAL", - "product" : "idn", - "platform_version" : "2", - "os_version" : "2345.3.1", - "os_type" : "flatcar", - "hypervisor" : "unknown" - }, - "type" : "CCG", - "status" : "NORMAL", - "timestamp" : "2020-01-01T00:00:00Z" - } - "@ - - # Handle status request from client - - try { - $Result = ConvertFrom-JsonToManagedClientStatus -Json $ManagedClientStatus - Update-BetaManagedClientStatus -Id $Id -BetaManagedClientStatus $Result - - # Below is a request that includes all optional parameters - # Update-BetaManagedClientStatus -Id $Id -BetaManagedClientStatus $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 -BetaClientLogConfiguration $Result - - # Below is a request that includes all optional parameters - # Send-BetaClientLogConfiguration -Id $Id -BetaClientLogConfiguration $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaClientLogConfiguration" - Write-Host $_.ErrorDetails - } - path: /mfa/{method}/delete method: DELETE xCodeSample: @@ -7018,62 +6862,218 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTokenAuthRequest" Write-Host $_.ErrorDetails } -- path: /multihosts - method: POST +- path: /managed-clients/{id}/status + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#create-multi-host-integration + label: SDK_tools/sdk/powershell/beta/methods/managed-clients#get-managed-client-status source: | - $MultiHostIntegrationsCreate = @" - { - "owner" : { - "name" : "MyName", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "managementWorkgroup" : { - "name" : "My Management Workgroup", - "id" : "2c91808568c529c60168cca6f90c2222", - "type" : "GOVERNANCE_GROUP" - }, - "cluster" : { - "name" : "Corporate Cluster", - "id" : "2c9180866166b5b0016167c32ef31a66", - "type" : "CLUSTER" - }, - "connector" : "multihost-microsoft-sql-server", - "connectorAttributes" : { - "maxSourcesPerAggGroup" : 10, - "maxAllowedSources" : 300 - }, - "created" : "2022-02-08T14:50:03.827Z", - "name" : "My Multi-Host Integration", - "description" : "This is the Multi-Host Integration.", - "modified" : "2024-01-23T18:08:50.897Z" - } - "@ + $Id = "aClientId" # String | ID of the Managed Client Status to get + $Type = "CCG" # ManagedClientType | Type of the Managed Client Status to get - # Create Multi-Host Integration + # Specified Managed Client Status. try { - $Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate - New-BetaMultiHostIntegration -BetaMultiHostIntegrationsCreate $Result + Get-BetaManagedClientStatus -Id $Id -Type $Type # Below is a request that includes all optional parameters - # New-BetaMultiHostIntegration -BetaMultiHostIntegrationsCreate $Result + # Get-BetaManagedClientStatus -Id $Id -Type $Type } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaMultiHostIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClientStatus" Write-Host $_.ErrorDetails } -- path: /multihosts/{multihostId} +- path: /managed-clients/{id}/status method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#create-sources-within-multi-host + label: SDK_tools/sdk/powershell/beta/methods/managed-clients#update-managed-client-status source: | - $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. - $MultiHostIntegrationsCreateSources = @"{ - "connectorAttributes" : { + $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 -BetaManagedClientStatus $Result + + # Below is a request that includes all optional parameters + # Update-BetaManagedClientStatus -Id $Id -BetaManagedClientStatus $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 -BetaClientLogConfiguration $Result + + # Below is a request that includes all optional parameters + # Send-BetaClientLogConfiguration -Id $Id -BetaClientLogConfiguration $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /multihosts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#create-multi-host-integration + source: | + $MultiHostIntegrationsCreate = @" + { + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "connector" : "multihost-microsoft-sql-server", + "connectorAttributes" : { + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "created" : "2022-02-08T14:50:03.827Z", + "name" : "My Multi-Host Integration", + "description" : "This is the Multi-Host Integration.", + "modified" : "2024-01-23T18:08:50.897Z" + } + "@ + + # Create Multi-Host Integration + + try { + $Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate + New-BetaMultiHostIntegration -BetaMultiHostIntegrationsCreate $Result + + # Below is a request that includes all optional parameters + # New-BetaMultiHostIntegration -BetaMultiHostIntegrationsCreate $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaMultiHostIntegration" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihostId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#create-sources-within-multi-host + source: | + $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. + $MultiHostIntegrationsCreateSources = @"{ + "connectorAttributes" : { "authType" : "SQLAuthentication", "url" : "jdbc:sqlserver://178.18.41.118:1433", "user" : "username", @@ -7918,20 +7918,20 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#list-non-employee-sources source: | - $RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. - $NonEmployeeCount = $false # Boolean | The flag to determine whether return a non-employee count associate with 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) + $RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) + $NonEmployeeCount = $false # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) # List Non-Employee Sources try { - Get-BetaNonEmployeeSources -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount + Get-BetaNonEmployeeSources # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeSources -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + # Get-BetaNonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSources" Write-Host $_.ErrorDetails @@ -9796,1248 +9796,1430 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRole" Write-Host $_.ErrorDetails } -- path: /accounts/search-attribute-config +- path: /sim-integrations method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#create-search-attribute-config + label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#create-sim-integration source: | - $SearchAttributeConfig = @" + $SimIntegrationDetails = @" { - "displayName" : "New Mail Attribute", - "name" : "newMailAttribute", - "applicationAttributes" : { - "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", - "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + "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" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "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 Extended Search Attributes + # Create new SIM integration try { - $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig - New-BetaSearchAttributeConfig -BetaSearchAttributeConfig $Result + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + New-BetaSIMIntegration -BetaSimIntegrationDetails $Result # Below is a request that includes all optional parameters - # New-BetaSearchAttributeConfig -BetaSearchAttributeConfig $Result + # New-BetaSIMIntegration -BetaSimIntegrationDetails $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSIMIntegration" Write-Host $_.ErrorDetails } -- path: /accounts/search-attribute-config/{name} +- path: /sim-integrations/{id} method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#delete-search-attribute-config + label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#delete-sim-integration source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. + $Id = "12345" # String | The id of the integration to delete. - # Delete Extended Search Attribute + # Delete a SIM integration try { - Remove-BetaSearchAttributeConfig -Name $Name + Remove-BetaSIMIntegration -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaSearchAttributeConfig -Name $Name + # Remove-BetaSIMIntegration -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSIMIntegration" Write-Host $_.ErrorDetails } -- path: /accounts/search-attribute-config +- path: /sim-integrations/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-search-attribute-config + label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#get-sim-integration source: | + $Id = "12345" # String | The id of the integration. - # List Extended Search Attributes + # Get a SIM integration details. try { - Get-BetaSearchAttributeConfig + Get-BetaSIMIntegration -Id $Id # Below is a request that includes all optional parameters - # Get-BetaSearchAttributeConfig + # Get-BetaSIMIntegration -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegration" Write-Host $_.ErrorDetails } -- path: /accounts/search-attribute-config/{name} +- path: /sim-integrations method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-single-search-attribute-config + label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#get-sim-integrations source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. - # Get Extended Search Attribute + # List the existing SIM integrations. try { - Get-BetaSingleSearchAttributeConfig -Name $Name + Get-BetaSIMIntegrations # Below is a request that includes all optional parameters - # Get-BetaSingleSearchAttributeConfig -Name $Name + # Get-BetaSIMIntegrations } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSingleSearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegrations" Write-Host $_.ErrorDetails } -- path: /accounts/search-attribute-config/{name} +- path: /sim-integrations/{id}/beforeProvisioningRule method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#patch-search-attribute-config + label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#patch-before-provisioning-rule source: | - $Name = "promotedMailAttribute" # String | Name of the extended search attribute configuration to patch. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ + $Id = "12345" # String | SIM integration id + $JsonPatch = @" + "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" + "@ + # Patch a SIM beforeProvisioningRule attribute. - # Update Extended Search Attribute + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-BetaBeforeProvisioningRule -Id $Id -BetaJsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-BetaBeforeProvisioningRule -Id $Id -BetaJsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaBeforeProvisioningRule" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#patch-sim-attributes + source: | + $Id = "12345" # String | SIM integration id + $JsonPatch = @" + "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" + "@ + + # Patch a SIM attribute. try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaSearchAttributeConfig -Name $Name -BetaJsonPatchOperation $Result + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-BetaSIMAttributes -Id $Id -BetaJsonPatch $Result # Below is a request that includes all optional parameters - # Update-BetaSearchAttributeConfig -Name $Name -BetaJsonPatchOperation $Result + # Update-BetaSIMAttributes -Id $Id -BetaJsonPatch $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSIMAttributes" Write-Host $_.ErrorDetails } -- path: /segments +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#put-sim-integration + source: | + $Id = "12345" # String | The id of the integration. + $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" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "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-BetaSIMIntegration -Id $Id -BetaSimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # Send-BetaSIMIntegration -Id $Id -BetaSimIntegrationDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sod-policies method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#create-segment + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#create-sod-policy source: | - $Segment = @" + $SodPolicy = @" { - "owner" : { - "name" : "support", + "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", - "visibilityCriteria" : { - "expression" : { - "children" : [ ], - "attribute" : "location", - "value" : { - "type" : "STRING", - "value" : "Austin" - }, - "operator" : "EQUALS" + "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" } }, - "name" : "segment-xyz", + "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", - "description" : "This segment represents xyz", - "active" : true, - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + "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 Segment + # Create SOD policy try { - $Result = ConvertFrom-JsonToSegment -Json $Segment - New-BetaSegment -BetaSegment $Result + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-BetaSodPolicy -BetaSodPolicy $Result # Below is a request that includes all optional parameters - # New-BetaSegment -BetaSegment $Result + # New-BetaSodPolicy -BetaSodPolicy $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSegment" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSodPolicy" Write-Host $_.ErrorDetails } -- path: /segments/{id} +- path: /sod-policies/{id} method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#delete-segment + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#delete-sod-policy source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD Policy to delete. + $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. (optional) (default to $true) - # Delete Segment by ID + # Delete SOD policy by ID try { - Remove-BetaSegment -Id $Id + Remove-BetaSodPolicy -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaSegment -Id $Id + # Remove-BetaSodPolicy -Id $Id -Logical $Logical } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSegment" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicy" Write-Host $_.ErrorDetails } -- path: /segments/{id} - method: GET +- path: /sod-policies/{id}/schedule + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#get-segment + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#delete-sod-policy-schedule source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - # Get Segment by ID + # Delete SOD policy schedule try { - Get-BetaSegment -Id $Id + Remove-BetaSodPolicySchedule -Id $Id # Below is a request that includes all optional parameters - # Get-BetaSegment -Id $Id + # Remove-BetaSodPolicySchedule -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegment" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicySchedule" Write-Host $_.ErrorDetails } -- path: /segments +- path: /sod-violation-report/{reportResultId}/download/{fileName} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#list-segments + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-custom-violation-report 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) + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. - # List Segments + # Download custom violation report try { - Get-BetaSegments + Get-BetaCustomViolationReport -ReportResultId $ReportResultId -FileName $FileName # Below is a request that includes all optional parameters - # Get-BetaSegments -Limit $Limit -Offset $Offset -Count $Count + # Get-BetaCustomViolationReport -ReportResultId $ReportResultId -FileName $FileName } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegments" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCustomViolationReport" Write-Host $_.ErrorDetails } -- path: /segments/{id} - method: PATCH +- path: /sod-violation-report/{reportResultId}/download + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#patch-segment + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-default-violation-report 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}}]}}}]"@ - + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - # Update Segment + # Download violation report try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-BetaSegment -Id $Id -RequestBody $Result + Get-BetaDefaultViolationReport -ReportResultId $ReportResultId # Below is a request that includes all optional parameters - # Update-BetaSegment -Id $Id -RequestBody $Result + # Get-BetaDefaultViolationReport -ReportResultId $ReportResultId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSegment" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDefaultViolationReport" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations - method: POST +- path: /sod-violation-report + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#create-service-desk-integration + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-all-report-run-status 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 + # Get multi-report run task status try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - New-BetaServiceDeskIntegration -BetaServiceDeskIntegrationDto $Result + Get-BetaSodAllReportRunStatus # Below is a request that includes all optional parameters - # New-BetaServiceDeskIntegration -BetaServiceDeskIntegrationDto $Result + # Get-BetaSodAllReportRunStatus } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaServiceDeskIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodAllReportRunStatus" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/{id} - method: DELETE +- path: /sod-policies/{id} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#delete-service-desk-integration + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-policy source: | - $Id = "anId" # String | ID of Service Desk integration to delete + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. - # Delete a Service Desk integration + # Get SOD policy by ID try { - Remove-BetaServiceDeskIntegration -Id $Id + Get-BetaSodPolicy -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaServiceDeskIntegration -Id $Id + # Get-BetaSodPolicy -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaServiceDeskIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicy" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/{id} +- path: /sod-policies/{id}/schedule method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-policy-schedule source: | - $Id = "anId" # String | ID of the Service Desk integration to get + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. - # Get a Service Desk integration + # Get SOD policy schedule try { - Get-BetaServiceDeskIntegration -Id $Id + Get-BetaSodPolicySchedule -Id $Id # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegration -Id $Id + # Get-BetaSodPolicySchedule -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicySchedule" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations +- path: /sod-policies/sod-violation-report-status/{reportResultId} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-list + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-violation-report-run-status 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) + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. - # List existing Service Desk integrations + # Get violation report run status try { - Get-BetaServiceDeskIntegrationList + Get-BetaSodViolationReportRunStatus -ReportResultId $ReportResultId # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegrationList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count + # Get-BetaSodViolationReportRunStatus -ReportResultId $ReportResultId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationList" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportRunStatus" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/templates/{scriptName} +- path: /sod-policies/{id}/violation-report method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-template + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-violation-report-status source: | - $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. - # Service Desk integration template by scriptName + # Get SOD violation report status try { - Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName + Get-BetaSodViolationReportStatus -Id $Id # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName + # Get-BetaSodViolationReportStatus -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTemplate" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportStatus" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/types +- path: /sod-policies method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-types + label: SDK_tools/sdk/powershell/beta/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 Service Desk integration types + # List SOD policies try { - Get-BetaServiceDeskIntegrationTypes + Get-BetaSodPolicies # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegrationTypes + # Get-BetaSodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTypes" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicies" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/status-check-configuration - method: GET +- path: /sod-policies/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-status-check-details + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#patch-sod-policy source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The ID of the SOD policy being modified. + $RequestBody = # SystemCollectionsHashtable[] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + $RequestBody = @"[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]"@ - # Get the time check configuration + + # Patch a SOD policy try { - Get-BetaStatusCheckDetails + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-BetaSodPolicy -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters - # Get-BetaStatusCheckDetails + # Update-BetaSodPolicy -Id $Id -RequestBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusCheckDetails" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSodPolicy" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/{id} - method: PATCH +- path: /sod-policies/{id}/schedule + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#patch-service-desk-integration + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#put-policy-schedule source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $PatchServiceDeskIntegrationRequest = @" - + $Id = "ef38f94347e94562b5bb8424a56397d8" # 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" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } "@ - # Patch a Service Desk Integration + # Update SOD Policy schedule try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-BetaServiceDeskIntegration -Id $Id -BetaPatchServiceDeskIntegrationRequest $Result + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-BetaPolicySchedule -Id $Id -BetaSodPolicySchedule $Result # Below is a request that includes all optional parameters - # Update-BetaServiceDeskIntegration -Id $Id -BetaPatchServiceDeskIntegrationRequest $Result + # Send-BetaPolicySchedule -Id $Id -BetaSodPolicySchedule $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPolicySchedule" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/{id} +- path: /sod-policies/{id} method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#put-service-desk-integration + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#put-sod-policy source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $ServiceDeskIntegrationDto = @" + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" { - "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" + "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" + } ] } }, - "name" : "Service Desk Integration Name", - "description" : "A very nice Service Desk integration", - "attributes" : { - "property" : "value", - "key" : "value" + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" }, - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "beforeProvisioningRule" : "" + "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 a Service Desk integration + # Update SOD policy by ID try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - Send-BetaServiceDeskIntegration -Id $Id -BetaServiceDeskIntegrationDto $Result + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-BetaSodPolicy -Id $Id -BetaSodPolicy $Result # Below is a request that includes all optional parameters - # Send-BetaServiceDeskIntegration -Id $Id -BetaServiceDeskIntegrationDto $Result + # Send-BetaSodPolicy -Id $Id -BetaSodPolicy $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaServiceDeskIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSodPolicy" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/status-check-configuration - method: PUT +- path: /sod-violation-report/run + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#update-status-check-details + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#start-sod-all-policies-for-org source: | - $QueuedCheckConfigDetails = @" + $MultiPolicyRequest = @" { - "provisioningStatusCheckIntervalMinutes" : "30", - "provisioningMaxStatusCheckDays" : "2" + "filteredPolicyList" : [ "filteredPolicyList", "filteredPolicyList" ] } "@ - # Update the time check configuration + # Runs all policies for org try { - $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails - Update-BetaStatusCheckDetails -BetaQueuedCheckConfigDetails $Result + Start-BetaSodAllPoliciesForOrg # Below is a request that includes all optional parameters - # Update-BetaStatusCheckDetails -BetaQueuedCheckConfigDetails $Result + # Start-BetaSodAllPoliciesForOrg -BetaMultiPolicyRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaStatusCheckDetails" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodAllPoliciesForOrg" Write-Host $_.ErrorDetails } -- path: /sim-integrations +- path: /sod-policies/{id}/violation-report/run method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#create-sim-integration + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#start-sod-policy source: | - $SimIntegrationDetails = @" + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The SOD policy ID to run. + + # Runs SOD policy violation report + + try { + Start-BetaSodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-BetaSodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-violations#start-predict-sod-violations + source: | + $IdentityWithNewAccess = @" { - "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" : "2023-01-03T21:16:22.432Z", - "name" : "aName", - "modified" : "2023-01-03T21:16:22.432Z", - "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" - } + "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" + } ] } "@ - # Create new SIM integration + # Predict SOD violations for identity. try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - New-BetaSIMIntegration -BetaSimIntegrationDetails $Result + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-BetaPredictSodViolations -BetaIdentityWithNewAccess $Result # Below is a request that includes all optional parameters - # New-BetaSIMIntegration -BetaSimIntegrationDetails $Result + # Start-BetaPredictSodViolations -BetaIdentityWithNewAccess $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSIMIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaPredictSodViolations" Write-Host $_.ErrorDetails } -- path: /sim-integrations/{id} - method: DELETE +- path: /sp-config/export + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#delete-sim-integration + label: SDK_tools/sdk/powershell/beta/methods/sp-config#export-sp-config source: | - $Id = "12345" # String | The id of the integration to delete. + $ExportPayload = @" + { + "description" : "Export Job 1 Test" + } + "@ - # Delete a SIM integration + # Initiates configuration objects export job try { - Remove-BetaSIMIntegration -Id $Id + $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload + Export-BetaSpConfig -BetaExportPayload $Result # Below is a request that includes all optional parameters - # Remove-BetaSIMIntegration -Id $Id + # Export-BetaSpConfig -BetaExportPayload $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSIMIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaSpConfig" Write-Host $_.ErrorDetails } -- path: /sim-integrations/{id} +- path: /sp-config/export/{id}/download method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#get-sim-integration + label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export source: | - $Id = "12345" # String | The id of the integration. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. - # Get a SIM integration details. + # Download export job result. try { - Get-BetaSIMIntegration -Id $Id + Get-BetaSpConfigExport -Id $Id # Below is a request that includes all optional parameters - # Get-BetaSIMIntegration -Id $Id + # Get-BetaSpConfigExport -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExport" Write-Host $_.ErrorDetails } -- path: /sim-integrations +- path: /sp-config/export/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#get-sim-integrations + 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. - # List the existing SIM integrations. + # Get export job status try { - Get-BetaSIMIntegrations + Get-BetaSpConfigExportStatus -Id $Id # Below is a request that includes all optional parameters - # Get-BetaSIMIntegrations + # Get-BetaSpConfigExportStatus -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegrations" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExportStatus" Write-Host $_.ErrorDetails } -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH +- path: /sp-config/import/{id}/download + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#patch-before-provisioning-rule + label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import source: | - $Id = "12345" # String | SIM integration id - $JsonPatch = @" - "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" - "@ + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. - # Patch a SIM beforeProvisioningRule attribute. + # Download import job result try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-BetaBeforeProvisioningRule -Id $Id -BetaJsonPatch $Result + Get-BetaSpConfigImport -Id $Id # Below is a request that includes all optional parameters - # Update-BetaBeforeProvisioningRule -Id $Id -BetaJsonPatch $Result + # Get-BetaSpConfigImport -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaBeforeProvisioningRule" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImport" Write-Host $_.ErrorDetails } -- path: /sim-integrations/{id} - method: PATCH +- path: /sp-config/import/{id} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#patch-sim-attributes + label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import-status source: | - $Id = "12345" # String | SIM integration id - $JsonPatch = @" - "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" - "@ + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. - # Patch a SIM attribute. + # Get import job status try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-BetaSIMAttributes -Id $Id -BetaJsonPatch $Result + Get-BetaSpConfigImportStatus -Id $Id # Below is a request that includes all optional parameters - # Update-BetaSIMAttributes -Id $Id -BetaJsonPatch $Result + # Get-BetaSpConfigImportStatus -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSIMAttributes" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImportStatus" Write-Host $_.ErrorDetails } -- path: /sim-integrations/{id} - method: PUT +- path: /sp-config/import + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#put-sim-integration + label: SDK_tools/sdk/powershell/beta/methods/sp-config#import-sp-config source: | - $Id = "12345" # String | The id of the integration. - $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" : "2023-01-03T21:16:22.432Z", - "name" : "aName", - "modified" : "2023-01-03T21:16:22.432Z", - "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" - } - } + $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 = @" "@ - # Update an existing SIM integration + # Initiates configuration objects import job try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - Send-BetaSIMIntegration -Id $Id -BetaSimIntegrationDetails $Result + Import-BetaSpConfig -Data $Data # Below is a request that includes all optional parameters - # Send-BetaSIMIntegration -Id $Id -BetaSimIntegrationDetails $Result + # Import-BetaSpConfig -Data $Data -Preview $Preview -BetaOptions $Options } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSIMIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSpConfig" Write-Host $_.ErrorDetails } -- path: /sod-policies - method: POST +- path: /sp-config/config-objects + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#create-sod-policy + label: SDK_tools/sdk/powershell/beta/methods/sp-config#list-sp-config-objects 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 + # Get config object details try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-BetaSodPolicy -BetaSodPolicy $Result + Get-BetaSpConfigObjects # Below is a request that includes all optional parameters - # New-BetaSodPolicy -BetaSodPolicy $Result + # Get-BetaSpConfigObjects } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigObjects" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id} - method: DELETE +- path: /accounts/search-attribute-config + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#delete-sod-policy + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#create-search-attribute-config source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD Policy to delete. - $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. (optional) (default to $true) + $SearchAttributeConfig = @" + { + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + } + "@ - # Delete SOD policy by ID + # Create Extended Search Attributes try { - Remove-BetaSodPolicy -Id $Id + $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig + New-BetaSearchAttributeConfig -BetaSearchAttributeConfig $Result # Below is a request that includes all optional parameters - # Remove-BetaSodPolicy -Id $Id -Logical $Logical + # New-BetaSearchAttributeConfig -BetaSearchAttributeConfig $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSearchAttributeConfig" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id}/schedule +- path: /accounts/search-attribute-config/{name} method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#delete-sod-policy-schedule + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#delete-search-attribute-config source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. - # Delete SOD policy schedule + # Delete Extended Search Attribute try { - Remove-BetaSodPolicySchedule -Id $Id + Remove-BetaSearchAttributeConfig -Name $Name # Below is a request that includes all optional parameters - # Remove-BetaSodPolicySchedule -Id $Id + # Remove-BetaSearchAttributeConfig -Name $Name } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicySchedule" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSearchAttributeConfig" Write-Host $_.ErrorDetails } -- path: /sod-violation-report/{reportResultId}/download/{fileName} +- path: /accounts/search-attribute-config method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-custom-violation-report + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-search-attribute-config 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 + # List Extended Search Attributes try { - Get-BetaCustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + Get-BetaSearchAttributeConfig # Below is a request that includes all optional parameters - # Get-BetaCustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + # Get-BetaSearchAttributeConfig } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCustomViolationReport" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSearchAttributeConfig" Write-Host $_.ErrorDetails } -- path: /sod-violation-report/{reportResultId}/download +- path: /accounts/search-attribute-config/{name} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-default-violation-report + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-single-search-attribute-config source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. - # Download violation report + # Get Extended Search Attribute try { - Get-BetaDefaultViolationReport -ReportResultId $ReportResultId + Get-BetaSingleSearchAttributeConfig -Name $Name # Below is a request that includes all optional parameters - # Get-BetaDefaultViolationReport -ReportResultId $ReportResultId + # Get-BetaSingleSearchAttributeConfig -Name $Name } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDefaultViolationReport" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSingleSearchAttributeConfig" Write-Host $_.ErrorDetails } -- path: /sod-violation-report - method: GET +- path: /accounts/search-attribute-config/{name} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-all-report-run-status + 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" + }"@ - # Get multi-report run task status + + # Update Extended Search Attribute try { - Get-BetaSodAllReportRunStatus + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaSearchAttributeConfig -Name $Name -BetaJsonPatchOperation $Result # Below is a request that includes all optional parameters - # Get-BetaSodAllReportRunStatus + # Update-BetaSearchAttributeConfig -Name $Name -BetaJsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodAllReportRunStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSearchAttributeConfig" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id} - method: GET +- path: /segments + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-policy + label: SDK_tools/sdk/powershell/beta/methods/segments#create-segment source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + $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" + } + "@ - # Get SOD policy by ID + # Create Segment try { - Get-BetaSodPolicy -Id $Id + $Result = ConvertFrom-JsonToSegment -Json $Segment + New-BetaSegment -BetaSegment $Result # Below is a request that includes all optional parameters - # Get-BetaSodPolicy -Id $Id + # New-BetaSegment -BetaSegment $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSegment" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id}/schedule - method: GET +- path: /segments/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-policy-schedule + label: SDK_tools/sdk/powershell/beta/methods/segments#delete-segment source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. - # Get SOD policy schedule + # Delete Segment by ID try { - Get-BetaSodPolicySchedule -Id $Id + Remove-BetaSegment -Id $Id # Below is a request that includes all optional parameters - # Get-BetaSodPolicySchedule -Id $Id + # Remove-BetaSegment -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicySchedule" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSegment" Write-Host $_.ErrorDetails } -- path: /sod-policies/sod-violation-report-status/{reportResultId} +- path: /segments/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-violation-report-run-status + label: SDK_tools/sdk/powershell/beta/methods/segments#get-segment source: | - $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. - # Get violation report run status + # Get Segment by ID try { - Get-BetaSodViolationReportRunStatus -ReportResultId $ReportResultId + Get-BetaSegment -Id $Id # Below is a request that includes all optional parameters - # Get-BetaSodViolationReportRunStatus -ReportResultId $ReportResultId + # Get-BetaSegment -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportRunStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegment" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id}/violation-report +- path: /segments method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-violation-report-status + label: SDK_tools/sdk/powershell/beta/methods/segments#list-segments source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - # Get SOD violation report status + # List Segments try { - Get-BetaSodViolationReportStatus -Id $Id + Get-BetaSegments # Below is a request that includes all optional parameters - # Get-BetaSodViolationReportStatus -Id $Id + # Get-BetaSegments -Limit $Limit -Offset $Offset -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegments" Write-Host $_.ErrorDetails } -- path: /sod-policies +- 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 -BetaServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # New-BetaServiceDeskIntegration -BetaServiceDeskIntegrationDto $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/sod-policies#list-sod-policies + 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: | - $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) + $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) - $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - # List SOD policies + # List existing Service Desk integrations try { - Get-BetaSodPolicies + Get-BetaServiceDeskIntegrationList # Below is a request that includes all optional parameters - # Get-BetaSodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + # Get-BetaServiceDeskIntegrationList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicies" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationList" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id} - method: PATCH +- path: /service-desk-integrations/templates/{scriptName} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#patch-sod-policy + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-template source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The ID of the SOD policy being modified. - $RequestBody = # SystemCollectionsHashtable[] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - $RequestBody = @"[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]"@ + $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get + # Service Desk integration template by scriptName - # Patch a SOD policy + 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 { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-BetaSodPolicy -Id $Id -RequestBody $Result + Get-BetaServiceDeskIntegrationTypes # Below is a request that includes all optional parameters - # Update-BetaSodPolicy -Id $Id -RequestBody $Result + # Get-BetaServiceDeskIntegrationTypes } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTypes" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id}/schedule - method: PUT +- path: /service-desk-integrations/status-check-configuration + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#put-policy-schedule + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-status-check-details source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # 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" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false + + # 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 = @" + "@ - # Update SOD Policy schedule + # Patch a Service Desk Integration try { - $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-BetaPolicySchedule -Id $Id -BetaSodPolicySchedule $Result + $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest + Update-BetaServiceDeskIntegration -Id $Id -BetaPatchServiceDeskIntegrationRequest $Result # Below is a request that includes all optional parameters - # Send-BetaPolicySchedule -Id $Id -BetaSodPolicySchedule $Result + # Update-BetaServiceDeskIntegration -Id $Id -BetaPatchServiceDeskIntegrationRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPolicySchedule" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id} +- path: /service-desk-integrations/{id} method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#put-sod-policy + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#put-service-desk-integration source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy to update. - $SodPolicy = @" + $Id = "anId" # String | ID of the Service Desk integration to update + $ServiceDeskIntegrationDto = @" { - "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" : "", + "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" } }, - "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" - } + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" }, - "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" + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" } "@ - # Update SOD policy by ID + # Update a Service Desk integration try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-BetaSodPolicy -Id $Id -BetaSodPolicy $Result + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + Send-BetaServiceDeskIntegration -Id $Id -BetaServiceDeskIntegrationDto $Result # Below is a request that includes all optional parameters - # Send-BetaSodPolicy -Id $Id -BetaSodPolicy $Result + # Send-BetaServiceDeskIntegration -Id $Id -BetaServiceDeskIntegrationDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaServiceDeskIntegration" Write-Host $_.ErrorDetails } -- path: /sod-violation-report/run - method: POST +- path: /service-desk-integrations/status-check-configuration + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#start-sod-all-policies-for-org + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#update-status-check-details source: | - $MultiPolicyRequest = @" + $QueuedCheckConfigDetails = @" { - "filteredPolicyList" : [ "filteredPolicyList", "filteredPolicyList" ] + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" } "@ - # Runs all policies for org + # Update the time check configuration try { - Start-BetaSodAllPoliciesForOrg + $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails + Update-BetaStatusCheckDetails -BetaQueuedCheckConfigDetails $Result # Below is a request that includes all optional parameters - # Start-BetaSodAllPoliciesForOrg -BetaMultiPolicyRequest $Result + # Update-BetaStatusCheckDetails -BetaQueuedCheckConfigDetails $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodAllPoliciesForOrg" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaStatusCheckDetails" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id}/violation-report/run - method: POST +- path: /source-usages/{sourceId}/status + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#start-sod-policy + label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-status-by-source-id source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The SOD policy ID to run. + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - # Runs SOD policy violation report + # Finds status of source usage try { - Start-BetaSodPolicy -Id $Id + Get-BetaStatusBySourceId -SourceId $SourceId # Below is a request that includes all optional parameters - # Start-BetaSodPolicy -Id $Id + # Get-BetaStatusBySourceId -SourceId $SourceId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusBySourceId" Write-Host $_.ErrorDetails } -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/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" - } ] - } - "@ +- 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) - # Predict SOD violations for identity. + # Returns source usage insights try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-BetaPredictSodViolations -BetaIdentityWithNewAccess $Result + Get-BetaUsagesBySourceId -SourceId $SourceId # Below is a request that includes all optional parameters - # Start-BetaPredictSodViolations -BetaIdentityWithNewAccess $Result + # Get-BetaUsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaPredictSodViolations" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesBySourceId" Write-Host $_.ErrorDetails } - path: /sources/{sourceId}/provisioning-policies @@ -12357,188 +12539,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceSchema" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-status-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - - # Finds status of source usage - - try { - Get-BetaStatusBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaStatusBySourceId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusBySourceId" - Write-Host $_.ErrorDetails - } -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-usages-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns source usage insights - - try { - Get-BetaUsagesBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaUsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesBySourceId" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#export-sp-config - source: | - $ExportPayload = @" - { - "description" : "Export Job 1 Test" - } - "@ - - # Initiates configuration objects export job - - try { - $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-BetaSpConfig -BetaExportPayload $Result - - # Below is a request that includes all optional parameters - # Export-BetaSpConfig -BetaExportPayload $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 -BetaOptions $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: | - - # Get config object details - - 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: @@ -13724,878 +13724,878 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaVendorConnectorMappings" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id}/cancel +- path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#cancel-workflow-execution + label: SDK_tools/sdk/powershell/beta/methods/work-items#approve-approval-item source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - # Cancel Workflow Execution by ID + # Approve an Approval Item try { - Suspend-BetaWorkflowExecution -Id $Id + Approve-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId # Below is a request that includes all optional parameters - # Suspend-BetaWorkflowExecution -Id $Id + # Approve-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaWorkflowExecution" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItem" Write-Host $_.ErrorDetails } -- path: /workflows +- path: /work-items/bulk-approve/{id} method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#create-workflow + label: SDK_tools/sdk/powershell/beta/methods/work-items#approve-approval-items-in-bulk 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')]}}} - "@ + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - # Create Workflow + # Bulk approve Approval Items try { - $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-BetaWorkflow -BetaCreateWorkflowRequest $Result + Approve-BetaApprovalItemsInBulk -Id $Id # Below is a request that includes all optional parameters - # New-BetaWorkflow -BetaCreateWorkflowRequest $Result + # Approve-BetaApprovalItemsInBulk -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItemsInBulk" Write-Host $_.ErrorDetails } -- path: /workflows/{id} - method: DELETE +- path: /work-items/{id} + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#delete-workflow + label: SDK_tools/sdk/powershell/beta/methods/work-items#complete-work-item source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - # Delete Workflow By Id + # Complete a Work Item try { - Remove-BetaWorkflow -Id $Id + Complete-BetaWorkItem -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaWorkflow -Id $Id + # Complete-BetaWorkItem -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaWorkItem" Write-Host $_.ErrorDetails } -- path: /workflows/{id} - method: GET +- path: /work-items/{id}/forward + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow + label: SDK_tools/sdk/powershell/beta/methods/work-items#forward-work-item source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $WorkItemForward = @" + { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } + "@ - # Get Workflow By Id + # Forward a Work Item try { - Get-BetaWorkflow -Id $Id + $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward + Invoke-BetaForwardWorkItem -Id $Id -BetaWorkItemForward $Result # Below is a request that includes all optional parameters - # Get-BetaWorkflow -Id $Id + # Invoke-BetaForwardWorkItem -Id $Id -BetaWorkItemForward $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardWorkItem" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id} +- path: /work-items/completed method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution + label: SDK_tools/sdk/powershell/beta/methods/work-items#get-completed-work-items source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + $OwnerId = "MyOwnerId" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - # Get Workflow Execution + # Completed Work Items try { - Get-BetaWorkflowExecution -Id $Id + Get-BetaCompletedWorkItems # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecution -Id $Id + # Get-BetaCompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecution" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedWorkItems" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id}/history +- path: /work-items/completed/count method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution-history + label: SDK_tools/sdk/powershell/beta/methods/work-items#get-count-completed-work-items source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) - # Get Workflow Execution History + # Count Completed Work Items try { - Get-BetaWorkflowExecutionHistory -Id $Id + Get-BetaCountCompletedWorkItems # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecutionHistory -Id $Id + # Get-BetaCountCompletedWorkItems -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutionHistory" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountCompletedWorkItems" Write-Host $_.ErrorDetails } -- path: /workflows/{id}/executions +- path: /work-items/count method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-executions + label: SDK_tools/sdk/powershell/beta/methods/work-items#get-count-work-items 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) + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) - # List Workflow Executions + # Count Work Items try { - Get-BetaWorkflowExecutions -Id $Id + Get-BetaCountWorkItems # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + # Get-BetaCountWorkItems -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountWorkItems" Write-Host $_.ErrorDetails } -- path: /workflow-library +- path: /work-items/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-complete-workflow-library + label: SDK_tools/sdk/powershell/beta/methods/work-items#get-work-item 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) + $Id = "MyId" # String | ID of the work item. + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) - # List Complete Workflow Library + # Get a Work Item try { - Get-BetaCompleteWorkflowLibrary + Get-BetaWorkItem -Id $Id # Below is a request that includes all optional parameters - # Get-BetaCompleteWorkflowLibrary -Limit $Limit -Offset $Offset + # Get-BetaWorkItem -Id $Id -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompleteWorkflowLibrary" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItem" Write-Host $_.ErrorDetails } -- path: /workflow-library/actions +- path: /work-items/summary method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-actions + label: SDK_tools/sdk/powershell/beta/methods/work-items#get-work-items-summary 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) + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) - # List Workflow Library Actions + # Work Items Summary try { - Get-BetaWorkflowLibraryActions + Get-BetaWorkItemsSummary # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + # Get-BetaWorkItemsSummary -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryActions" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItemsSummary" Write-Host $_.ErrorDetails } -- path: /workflow-library/operators +- path: /work-items method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-operators + label: SDK_tools/sdk/powershell/beta/methods/work-items#list-work-items source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) - # List Workflow Library Operators + # List Work Items try { - Get-BetaWorkflowLibraryOperators + Get-BetaWorkItems # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryOperators + # Get-BetaWorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryOperators" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItems" Write-Host $_.ErrorDetails } -- path: /workflow-library/triggers - method: GET +- path: /work-items/{id}/reject/{approvalItemId} + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-triggers + label: SDK_tools/sdk/powershell/beta/methods/work-items#reject-approval-item 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) + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - # List Workflow Library Triggers + # Reject an Approval Item try { - Get-BetaWorkflowLibraryTriggers + Deny-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + # Deny-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryTriggers" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItem" Write-Host $_.ErrorDetails } -- path: /workflows - method: GET +- path: /work-items/bulk-reject/{id} + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflows + label: SDK_tools/sdk/powershell/beta/methods/work-items#reject-approval-items-in-bulk source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - # List Workflows + # Bulk reject Approval Items try { - Get-BetaWorkflows + Deny-BetaApprovalItemsInBulk -Id $Id # Below is a request that includes all optional parameters - # Get-BetaWorkflows + # Deny-BetaApprovalItemsInBulk -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflows" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItemsInBulk" Write-Host $_.ErrorDetails } -- path: /workflows/{id} - method: PATCH +- path: /work-items/{id}/submit-account-selection + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#patch-workflow + label: SDK_tools/sdk/powershell/beta/methods/work-items#submit-account-selection source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName - # Patch Workflow + # Submit Account Selections try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaWorkflow -Id $Id -BetaJsonPatchOperation $Result + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Submit-BetaAccountSelection -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters - # Update-BetaWorkflow -Id $Id -BetaJsonPatchOperation $Result + # Submit-BetaAccountSelection -Id $Id -RequestBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaAccountSelection" Write-Host $_.ErrorDetails } -- path: /workflows/execute/external/{id} +- path: /reassignment-configurations method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#post-external-execute-workflow + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#create-reassignment-configuration source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $PostExternalExecuteWorkflowRequest = @" - + $ConfigurationItemRequest = @" + { + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + } "@ - # Execute Workflow via External Trigger + # Create a Reassignment Configuration try { - Submit-BetaExternalExecuteWorkflow -Id $Id + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + New-BetaReassignmentConfiguration -BetaConfigurationItemRequest $Result # Below is a request that includes all optional parameters - # Submit-BetaExternalExecuteWorkflow -Id $Id -BetaPostExternalExecuteWorkflowRequest $Result + # New-BetaReassignmentConfiguration -BetaConfigurationItemRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaExternalExecuteWorkflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaReassignmentConfiguration" Write-Host $_.ErrorDetails } -- path: /workflows/{id}/external/oauth-clients - method: POST +- path: /reassignment-configurations/{identityId}/{configType} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#post-workflow-external-trigger + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#delete-reassignment-configuration source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | - # Generate External Trigger OAuth Client + # Delete Reassignment Configuration try { - Submit-BetaWorkflowExternalTrigger -Id $Id + Remove-BetaReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType # Below is a request that includes all optional parameters - # Submit-BetaWorkflowExternalTrigger -Id $Id + # Remove-BetaReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaWorkflowExternalTrigger" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaReassignmentConfiguration" Write-Host $_.ErrorDetails } -- path: /workflows/execute/external/{id}/test - method: POST +- path: /reassignment-configurations/{identityId}/evaluate/{configType} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#test-external-execute-workflow + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-evaluate-reassignment-configuration source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestExternalExecuteWorkflowRequest = @" + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type + $ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) - "@ + $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ - # Test Workflow via External Trigger + # Evaluate Reassignment Configuration try { - Test-BetaExternalExecuteWorkflow -Id $Id + Get-BetaEvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType # Below is a request that includes all optional parameters - # Test-BetaExternalExecuteWorkflow -Id $Id -BetaTestExternalExecuteWorkflowRequest $Result + # Get-BetaEvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -ExclusionFilters $ExclusionFilters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaExternalExecuteWorkflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEvaluateReassignmentConfiguration" Write-Host $_.ErrorDetails } -- path: /workflows/{id}/test - method: POST +- path: /reassignment-configurations/types + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#test-workflow + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-reassignment-config-types 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 + # List Reassignment Config Types try { - $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-BetaWorkflow -Id $Id -BetaTestWorkflowRequest $Result + Get-BetaReassignmentConfigTypes # Below is a request that includes all optional parameters - # Test-BetaWorkflow -Id $Id -BetaTestWorkflowRequest $Result + # Get-BetaReassignmentConfigTypes } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigTypes" Write-Host $_.ErrorDetails } -- path: /workflows/{id} - method: PUT +- path: /reassignment-configurations/{identityId} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#update-workflow + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-reassignment-configuration 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" : "description", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - } - "@ + $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id - # Update Workflow + # Get Reassignment Configuration try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Update-BetaWorkflow -Id $Id -BetaWorkflowBody $Result + Get-BetaReassignmentConfiguration -IdentityId $IdentityId # Below is a request that includes all optional parameters - # Update-BetaWorkflow -Id $Id -BetaWorkflowBody $Result + # Get-BetaReassignmentConfiguration -IdentityId $IdentityId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfiguration" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/approve/{approvalItemId} - method: POST +- path: /reassignment-configurations/tenant-config + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#approve-approval-item + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-tenant-config-configuration source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - # Approve an Approval Item + # Get Tenant-wide Reassignment Configuration settings try { - Approve-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + Get-BetaTenantConfigConfiguration # Below is a request that includes all optional parameters - # Approve-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + # Get-BetaTenantConfigConfiguration } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenantConfigConfiguration" Write-Host $_.ErrorDetails } -- path: /work-items/bulk-approve/{id} - method: POST +- path: /reassignment-configurations + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#approve-approval-items-in-bulk + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#list-reassignment-configurations source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - # Bulk approve Approval Items + # List Reassignment Configurations try { - Approve-BetaApprovalItemsInBulk -Id $Id + Get-BetaReassignmentConfigurations # Below is a request that includes all optional parameters - # Approve-BetaApprovalItemsInBulk -Id $Id + # Get-BetaReassignmentConfigurations } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItemsInBulk" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigurations" Write-Host $_.ErrorDetails } -- path: /work-items/{id} - method: POST +- path: /reassignment-configurations/{identityId} + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#complete-work-item + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#put-reassignment-config source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigurationItemRequest = @" + { + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + } + "@ - # Complete a Work Item + # Update Reassignment Configuration try { - Complete-BetaWorkItem -Id $Id + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + Send-BetaReassignmentConfig -IdentityId $IdentityId -BetaConfigurationItemRequest $Result # Below is a request that includes all optional parameters - # Complete-BetaWorkItem -Id $Id + # Send-BetaReassignmentConfig -IdentityId $IdentityId -BetaConfigurationItemRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaWorkItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaReassignmentConfig" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/forward - method: POST +- path: /reassignment-configurations/tenant-config + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#forward-work-item + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#put-tenant-configuration source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $WorkItemForward = @" + $TenantConfigurationRequest = @" { - "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I'm going on vacation.", - "sendNotifications" : true + "configDetails" : { + "disabled" : true + } } "@ - # Forward a Work Item + # Update Tenant-wide Reassignment Configuration settings try { - $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward - Invoke-BetaForwardWorkItem -Id $Id -BetaWorkItemForward $Result + $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest + Send-BetaTenantConfiguration -BetaTenantConfigurationRequest $Result # Below is a request that includes all optional parameters - # Invoke-BetaForwardWorkItem -Id $Id -BetaWorkItemForward $Result + # Send-BetaTenantConfiguration -BetaTenantConfigurationRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardWorkItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTenantConfiguration" Write-Host $_.ErrorDetails } -- path: /work-items/completed - method: GET +- path: /workflow-executions/{id}/cancel + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#get-completed-work-items + label: SDK_tools/sdk/powershell/beta/methods/workflows#cancel-workflow-execution source: | - $OwnerId = "MyOwnerId" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - # Completed Work Items + # Cancel Workflow Execution by ID try { - Get-BetaCompletedWorkItems + Suspend-BetaWorkflowExecution -Id $Id # Below is a request that includes all optional parameters - # Get-BetaCompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count + # Suspend-BetaWorkflowExecution -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedWorkItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaWorkflowExecution" Write-Host $_.ErrorDetails } -- path: /work-items/completed/count - method: GET +- path: /workflows + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#get-count-completed-work-items + label: SDK_tools/sdk/powershell/beta/methods/workflows#create-workflow source: | - $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + $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')]}}} + "@ - # Count Completed Work Items + # Create Workflow try { - Get-BetaCountCompletedWorkItems + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-BetaWorkflow -BetaCreateWorkflowRequest $Result # Below is a request that includes all optional parameters - # Get-BetaCountCompletedWorkItems -OwnerId $OwnerId + # New-BetaWorkflow -BetaCreateWorkflowRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountCompletedWorkItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkflow" Write-Host $_.ErrorDetails } -- path: /work-items/count - method: GET +- path: /workflows/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#get-count-work-items + label: SDK_tools/sdk/powershell/beta/methods/workflows#delete-workflow source: | - $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - # Count Work Items + # Delete Workflow By Id try { - Get-BetaCountWorkItems + Remove-BetaWorkflow -Id $Id # Below is a request that includes all optional parameters - # Get-BetaCountWorkItems -OwnerId $OwnerId + # Remove-BetaWorkflow -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountWorkItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkflow" Write-Host $_.ErrorDetails } -- path: /work-items/{id} +- path: /workflows/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#get-work-item + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow source: | - $Id = "MyId" # String | ID of the work item. - $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - # Get a Work Item + # Get Workflow By Id try { - Get-BetaWorkItem -Id $Id + Get-BetaWorkflow -Id $Id # Below is a request that includes all optional parameters - # Get-BetaWorkItem -Id $Id -OwnerId $OwnerId + # Get-BetaWorkflow -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflow" Write-Host $_.ErrorDetails } -- path: /work-items/summary +- path: /workflow-executions/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#get-work-items-summary + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution source: | - $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - # Work Items Summary + # Get Workflow Execution try { - Get-BetaWorkItemsSummary + Get-BetaWorkflowExecution -Id $Id # Below is a request that includes all optional parameters - # Get-BetaWorkItemsSummary -OwnerId $OwnerId + # Get-BetaWorkflowExecution -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItemsSummary" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecution" Write-Host $_.ErrorDetails } -- path: /work-items +- path: /workflow-executions/{id}/history method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#list-work-items + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution-history source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - # List Work Items + # Get Workflow Execution History try { - Get-BetaWorkItems + Get-BetaWorkflowExecutionHistory -Id $Id # Below is a request that includes all optional parameters - # Get-BetaWorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId + # Get-BetaWorkflowExecutionHistory -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutionHistory" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/reject/{approvalItemId} - method: POST +- path: /workflows/{id}/executions + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#reject-approval-item + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-executions source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + $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) - # Reject an Approval Item + # List Workflow Executions try { - Deny-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + Get-BetaWorkflowExecutions -Id $Id # Below is a request that includes all optional parameters - # Deny-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + # Get-BetaWorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions" Write-Host $_.ErrorDetails } -- path: /work-items/bulk-reject/{id} - method: POST +- path: /workflow-library + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#reject-approval-items-in-bulk + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-complete-workflow-library source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $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) - # Bulk reject Approval Items + # List Complete Workflow Library try { - Deny-BetaApprovalItemsInBulk -Id $Id + Get-BetaCompleteWorkflowLibrary # Below is a request that includes all optional parameters - # Deny-BetaApprovalItemsInBulk -Id $Id + # Get-BetaCompleteWorkflowLibrary -Limit $Limit -Offset $Offset } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItemsInBulk" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompleteWorkflowLibrary" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/submit-account-selection - method: POST +- path: /workflow-library/actions + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#submit-account-selection + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-actions source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName + $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) - # Submit Account Selections + # List Workflow Library Actions try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Submit-BetaAccountSelection -Id $Id -RequestBody $Result + Get-BetaWorkflowLibraryActions # Below is a request that includes all optional parameters - # Submit-BetaAccountSelection -Id $Id -RequestBody $Result + # Get-BetaWorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaAccountSelection" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryActions" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations - method: POST +- path: /workflow-library/operators + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#create-reassignment-configuration + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-operators source: | - $ConfigurationItemRequest = @" - { - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" - } - "@ - # Create a Reassignment Configuration + # List Workflow Library Operators try { - $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - New-BetaReassignmentConfiguration -BetaConfigurationItemRequest $Result + Get-BetaWorkflowLibraryOperators # Below is a request that includes all optional parameters - # New-BetaReassignmentConfiguration -BetaConfigurationItemRequest $Result + # Get-BetaWorkflowLibraryOperators } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaReassignmentConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryOperators" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations/{identityId}/{configType} - method: DELETE +- path: /workflow-library/triggers + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#delete-reassignment-configuration + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-triggers source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | + $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) - # Delete Reassignment Configuration + # List Workflow Library Triggers try { - Remove-BetaReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType + Get-BetaWorkflowLibraryTriggers # Below is a request that includes all optional parameters - # Remove-BetaReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType + # Get-BetaWorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaReassignmentConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryTriggers" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations/{identityId}/evaluate/{configType} +- path: /workflows method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-evaluate-reassignment-configuration + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflows source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type - $ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) - $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ - - # Evaluate Reassignment Configuration + # List Workflows try { - Get-BetaEvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType + Get-BetaWorkflows # Below is a request that includes all optional parameters - # Get-BetaEvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -ExclusionFilters $ExclusionFilters + # Get-BetaWorkflows } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEvaluateReassignmentConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflows" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations/types - method: GET +- path: /workflows/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-reassignment-config-types + 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" + }"@ - # List Reassignment Config Types + + # Patch Workflow try { - Get-BetaReassignmentConfigTypes + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaWorkflow -Id $Id -BetaJsonPatchOperation $Result # Below is a request that includes all optional parameters - # Get-BetaReassignmentConfigTypes + # Update-BetaWorkflow -Id $Id -BetaJsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigTypes" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations/{identityId} - method: GET +- path: /workflows/execute/external/{id} + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-reassignment-configuration + label: SDK_tools/sdk/powershell/beta/methods/workflows#post-external-execute-workflow source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $PostExternalExecuteWorkflowRequest = @" - # Get Reassignment Configuration + "@ + + # Execute Workflow via External Trigger try { - Get-BetaReassignmentConfiguration -IdentityId $IdentityId + Submit-BetaExternalExecuteWorkflow -Id $Id # Below is a request that includes all optional parameters - # Get-BetaReassignmentConfiguration -IdentityId $IdentityId + # Submit-BetaExternalExecuteWorkflow -Id $Id -BetaPostExternalExecuteWorkflowRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaExternalExecuteWorkflow" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations/tenant-config - method: GET +- path: /workflows/{id}/external/oauth-clients + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-tenant-config-configuration + label: SDK_tools/sdk/powershell/beta/methods/workflows#post-workflow-external-trigger source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - # Get Tenant-wide Reassignment Configuration settings + # Generate External Trigger OAuth Client try { - Get-BetaTenantConfigConfiguration + Submit-BetaWorkflowExternalTrigger -Id $Id # Below is a request that includes all optional parameters - # Get-BetaTenantConfigConfiguration + # Submit-BetaWorkflowExternalTrigger -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenantConfigConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaWorkflowExternalTrigger" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations - method: GET +- path: /workflows/execute/external/{id}/test + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#list-reassignment-configurations + 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 = @" - # List Reassignment Configurations + "@ + + # Test Workflow via External Trigger try { - Get-BetaReassignmentConfigurations + Test-BetaExternalExecuteWorkflow -Id $Id # Below is a request that includes all optional parameters - # Get-BetaReassignmentConfigurations + # Test-BetaExternalExecuteWorkflow -Id $Id -BetaTestExternalExecuteWorkflowRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigurations" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaExternalExecuteWorkflow" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations/{identityId} - method: PUT +- path: /workflows/{id}/test + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#put-reassignment-config + label: SDK_tools/sdk/powershell/beta/methods/workflows#test-workflow source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $ConfigurationItemRequest = @" - { - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" - } + $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}]}} "@ - # Update Reassignment Configuration + # Test Workflow By Id try { - $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - Send-BetaReassignmentConfig -IdentityId $IdentityId -BetaConfigurationItemRequest $Result + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-BetaWorkflow -Id $Id -BetaTestWorkflowRequest $Result # Below is a request that includes all optional parameters - # Send-BetaReassignmentConfig -IdentityId $IdentityId -BetaConfigurationItemRequest $Result + # Test-BetaWorkflow -Id $Id -BetaTestWorkflowRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaReassignmentConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations/tenant-config +- path: /workflows/{id} method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#put-tenant-configuration + label: SDK_tools/sdk/powershell/beta/methods/workflows#update-workflow source: | - $TenantConfigurationRequest = @" + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $WorkflowBody = @" { - "configDetails" : { - "disabled" : true - } + "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" : "description", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false } "@ - # Update Tenant-wide Reassignment Configuration settings + # Update Workflow try { - $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest - Send-BetaTenantConfiguration -BetaTenantConfigurationRequest $Result + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Update-BetaWorkflow -Id $Id -BetaWorkflowBody $Result # Below is a request that includes all optional parameters - # Send-BetaTenantConfiguration -BetaTenantConfigurationRequest $Result + # Update-BetaWorkflow -Id $Id -BetaWorkflowBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTenantConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" Write-Host $_.ErrorDetails } diff --git a/static/code-examples/v2024/code_examples_overlay.yaml b/static/code-examples/v2024/code_examples_overlay.yaml index 576d4fd0d577..bf47e940f777 100644 --- a/static/code-examples/v2024/code_examples_overlay.yaml +++ b/static/code-examples/v2024/code_examples_overlay.yaml @@ -532,15 +532,14 @@ $IdentityId = "7025c863-c270-4ba6-beea-edf3cb091573" # String | Manager's identity ID. $RequestedObjectId = "2db501be-f0fb-4cc5-a695-334133c52891" # String | Requested access item's ID. $Type = "ENTITLEMENT" # String | Requested access item's type. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Return access request identity metrics try { - Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type -XSailPointExperimental $XSailPointExperimental + Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type # Below is a request that includes all optional parameters - # Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type -XSailPointExperimental $XSailPointExperimental + # Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestIdentityMetrics" Write-Host $_.ErrorDetails @@ -909,6 +908,29 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountAggregationStatus" Write-Host $_.ErrorDetails } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/account-usages#get-usages-by-account-id + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + Get-V2024UsagesByAccountId -AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-V2024UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesByAccountId" + Write-Host $_.ErrorDetails + } - path: /accounts method: POST xCodeSample: @@ -1172,8 +1194,8 @@ $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) $DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) - $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) + $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) # Accounts List @@ -1286,29 +1308,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Account" Write-Host $_.ErrorDetails } -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/account-usages#get-usages-by-account-id - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns account usage insights - - try { - Get-V2024UsagesByAccountId -AccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-V2024UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesByAccountId" - Write-Host $_.ErrorDetails - } - path: /discovered-applications method: GET xCodeSample: @@ -2849,6 +2848,95 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Campaign" Write-Host $_.ErrorDetails } +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-access-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Type = "ROLE" # String | The type of access review item to retrieve summaries for + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + + # Access Summaries + + try { + Get-V2024IdentityAccessSummaries -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessSummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-decision-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + + # Summary of Certification Decisions + + try { + Get-V2024IdentityDecisionSummary -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentityDecisionSummary -Id $Id -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityDecisionSummary" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Identity Summaries for Campaign Certification + + try { + Get-V2024IdentitySummaries -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID + + # Summary for Identity + + try { + Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummary" + Write-Host $_.ErrorDetails + } - path: /certification-tasks/{id} method: GET xCodeSample: @@ -3127,95 +3215,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024ReassignCertsAsync" Write-Host $_.ErrorDetails } -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-access-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Type = "ROLE" # String | The type of access review item to retrieve summaries for - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - - # Access Summaries - - try { - Get-V2024IdentityAccessSummaries -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-V2024IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessSummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-decision-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - - # Summary of Certification Decisions - - try { - Get-V2024IdentityDecisionSummary -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024IdentityDecisionSummary -Id $Id -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityDecisionSummary" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Identity Summaries for Campaign Certification - - try { - Get-V2024IdentitySummaries -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID - - # Summary for Identity - - try { - Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - - # Below is a request that includes all optional parameters - # Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummary" - Write-Host $_.ErrorDetails - } - path: /configuration-hub/deploys method: POST xCodeSample: @@ -5851,6 +5850,25 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendations" Write-Host $_.ErrorDetails } +- path: /ai-access-request-recommendations/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Access Request Recommendations config + + try { + Get-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsConfig" + Write-Host $_.ErrorDetails + } - path: /ai-access-request-recommendations/ignored-items method: GET xCodeSample: @@ -5923,6 +5941,36 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsViewedItems" Write-Host $_.ErrorDetails } +- path: /ai-access-request-recommendations/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#set-access-request-recommendations-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessRequestRecommendationConfigDto = @" + { + "scoreThreshold" : 0.5, + "startDateAttribute" : "startDate", + "restrictionAttribute" : "location", + "moverAttribute" : "isMover", + "joinerAttribute" : "isJoiner", + "useRestrictionAttribute" : true + } + "@ + + # Update Access Request Recommendations config + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationConfigDto -Json $AccessRequestRecommendationConfigDto + Set-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationConfigDto $Result + + # Below is a request that includes all optional parameters + # Set-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationConfigDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024AccessRequestRecommendationsConfig" + Write-Host $_.ErrorDetails + } - path: /common-access method: POST xCodeSample: @@ -7747,7 +7795,7 @@ } "@ - # Create an Identity Profile + # Create Identity Profile try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile @@ -7765,9 +7813,9 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#delete-identity-profile source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID. + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. - # Delete an Identity Profile + # Delete Identity Profile try { Remove-V2024IdentityProfile -IdentityProfileId $IdentityProfileId @@ -7848,9 +7896,9 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#get-identity-profile source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - # Get single Identity Profile + # Get Identity Profile try { Get-V2024IdentityProfile -IdentityProfileId $IdentityProfileId @@ -7952,10 +8000,10 @@ $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, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) - # Identity Profiles List + # List Identity Profiles try { Get-V2024IdentityProfiles @@ -8039,7 +8087,7 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#update-identity-profile source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", @@ -8047,7 +8095,7 @@ }"@ - # Update the Identity Profile + # Update Identity Profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -8219,605 +8267,791 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024LifecycleStates" Write-Host $_.ErrorDetails } -- path: /managed-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/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-V2024ManagedClient -V2024ManagedClientRequest $Result - - # Below is a request that includes all optional parameters - # New-V2024ManagedClient -V2024ManagedClientRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id} - method: DELETE +- path: /mfa/duo-web/config + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#delete-managed-client + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-duo-config source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - # Delete Managed Client + # Configuration of Duo MFA method try { - Remove-V2024ManagedClient -Id $Id + Get-V2024MFADuoConfig # Below is a request that includes all optional parameters - # Remove-V2024ManagedClient -Id $Id + # Get-V2024MFADuoConfig } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedClient" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFADuoConfig" Write-Host $_.ErrorDetails } -- path: /managed-clients/{id} +- path: /mfa/kba/config method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#get-managed-client + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-kba-config source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + $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) - # Get Managed Client + # Configuration of KBA MFA method try { - Get-V2024ManagedClient -Id $Id + Get-V2024MFAKbaConfig # Below is a request that includes all optional parameters - # Get-V2024ManagedClient -Id $Id + # Get-V2024MFAKbaConfig -AllLanguages $AllLanguages } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClient" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAKbaConfig" Write-Host $_.ErrorDetails } -- path: /managed-clients/{id}/status +- path: /mfa/okta-verify/config method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#get-managed-client-status + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-okta-config 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 + # Configuration of Okta MFA method try { - Get-V2024ManagedClientStatus -Id $Id -Type $Type + Get-V2024MFAOktaConfig # Below is a request that includes all optional parameters - # Get-V2024ManagedClientStatus -Id $Id -Type $Type + # Get-V2024MFAOktaConfig } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClientStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAOktaConfig" Write-Host $_.ErrorDetails } -- path: /managed-clients - method: GET +- path: /mfa/duo-web/config + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#get-managed-clients + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-duo-config 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) + $MfaDuoConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + } + "@ - # Get Managed Clients + # Set Duo MFA configuration try { - Get-V2024ManagedClients + $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig + Set-V2024MFADuoConfig -V2024MfaDuoConfig $Result # Below is a request that includes all optional parameters - # Get-V2024ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + # Set-V2024MFADuoConfig -V2024MfaDuoConfig $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClients" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFADuoConfig" Write-Host $_.ErrorDetails } -- path: /managed-clients/{id} - method: PATCH +- path: /mfa/kba/config/answers + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#update-managed-client + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfakba-config source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" }"@ - # Update Managed Client + # Set MFA KBA configuration try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024ManagedClient -Id $Id -V2024JsonPatchOperation $Result + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $Result # Below is a request that includes all optional parameters - # Update-V2024ManagedClient -Id $Id -V2024JsonPatchOperation $Result + # Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClient" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAKBAConfig" Write-Host $_.ErrorDetails } -- path: /managed-clusters - method: POST +- path: /mfa/okta-verify/config + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#create-managed-cluster + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-okta-config source: | - $ManagedClusterRequest = @" + $MfaOktaConfig = @" { - "configuration" : { - "clusterExternalId" : "externalId", - "ccgVersion" : "77.0.0" - }, - "name" : "Managed Cluster Name", - "description" : "A short description of the managed cluster.", - "type" : "idn" + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" } "@ - # Create Create Managed Cluster + # Set Okta MFA configuration try { - $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest - New-V2024ManagedCluster -V2024ManagedClusterRequest $Result + $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig + Set-V2024MFAOktaConfig -V2024MfaOktaConfig $Result # Below is a request that includes all optional parameters - # New-V2024ManagedCluster -V2024ManagedClusterRequest $Result + # Set-V2024MFAOktaConfig -V2024MfaOktaConfig $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedCluster" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAOktaConfig" Write-Host $_.ErrorDetails } -- path: /managed-clusters/{id} - method: DELETE +- path: /mfa/{method}/test + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#delete-managed-cluster + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#test-mfa-config 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) + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - # Delete Managed Cluster + # MFA method's test configuration try { - Remove-V2024ManagedCluster -Id $Id + Test-V2024MFAConfig -Method $Method # Below is a request that includes all optional parameters - # Remove-V2024ManagedCluster -Id $Id -RemoveClients $RemoveClients + # Test-V2024MFAConfig -Method $Method } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedCluster" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024MFAConfig" Write-Host $_.ErrorDetails } -- path: /managed-clusters/{id}/log-config +- path: /machine-accounts/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#get-client-log-configuration + label: SDK_tools/sdk/powershell/v2024/methods/machine-accounts#get-machine-account source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Managed Cluster Log Configuration + # Machine Account Details try { - Get-V2024ClientLogConfiguration -Id $Id + Get-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024ClientLogConfiguration -Id $Id + # Get-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ClientLogConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineAccount" Write-Host $_.ErrorDetails } -- path: /managed-clusters/{id} +- path: /machine-accounts method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#get-managed-cluster + label: SDK_tools/sdk/powershell/v2024/methods/machine-accounts#list-machine-accounts source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $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 = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **source.name**: *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, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional) - # Get Managed Cluster + # Machine Accounts List try { - Get-V2024ManagedCluster -Id $Id + Get-V2024MachineAccounts -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024ManagedCluster -Id $Id + # Get-V2024MachineAccounts -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedCluster" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineAccounts" Write-Host $_.ErrorDetails } -- path: /managed-clusters - method: GET +- path: /machine-accounts/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#get-managed-clusters + label: SDK_tools/sdk/powershell/v2024/methods/machine-accounts#update-machine-account 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) + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}"@ - # Get Managed Clusters + + # Update a Machine Account try { - Get-V2024ManagedClusters + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result # Below is a request that includes all optional parameters - # Get-V2024ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + # Update-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusters" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MachineAccount" Write-Host $_.ErrorDetails } -- path: /managed-clusters/{id}/log-config - method: PUT +- path: /machine-identities + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#put-client-log-configuration + label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#create-machine-identity source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. - $PutClientLogConfigurationRequest = @" - + $MachineIdentity = @" + { + "created" : "2015-05-28T14:07:17Z", + "businessApplication" : "ADService", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "", + "attributes" : "{\"Region\":\"EU\"}", + "id" : "id12345", + "manuallyEdited" : true + } "@ - # Update Managed Cluster Log Configuration + # Create Machine Identities try { - $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest - Send-V2024ClientLogConfiguration -Id $Id -V2024PutClientLogConfigurationRequest $Result + $Result = ConvertFrom-JsonToMachineIdentity -Json $MachineIdentity + New-V2024MachineIdentity -V2024MachineIdentity $Result # Below is a request that includes all optional parameters - # Send-V2024ClientLogConfiguration -Id $Id -V2024PutClientLogConfigurationRequest $Result + # New-V2024MachineIdentity -V2024MachineIdentity $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ClientLogConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024MachineIdentity" Write-Host $_.ErrorDetails } -- path: /managed-clusters/{id} - method: PATCH +- path: /machine-identities/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#update-managed-cluster + label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#delete-machine-identity source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Update Managed Cluster + # Delete machine identity try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024ManagedCluster -Id $Id -V2024JsonPatchOperation $Result + Remove-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Update-V2024ManagedCluster -Id $Id -V2024JsonPatchOperation $Result + # Remove-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedCluster" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MachineIdentity" Write-Host $_.ErrorDetails } -- path: /mfa/duo-web/config +- path: /machine-identities/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-duo-config + label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#get-machine-identity source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Configuration of Duo MFA method + # Machine Identity Details try { - Get-V2024MFADuoConfig + Get-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024MFADuoConfig + # Get-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFADuoConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineIdentity" Write-Host $_.ErrorDetails } -- path: /mfa/kba/config +- path: /machine-identities method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-kba-config + label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#list-machine-identities 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) + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "businessApplication" # 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: **businessApplication, name** (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) + $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) - # Configuration of KBA MFA method + # List Machine Identities try { - Get-V2024MFAKbaConfig + Get-V2024MachineIdentities -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024MFAKbaConfig -AllLanguages $AllLanguages + # Get-V2024MachineIdentities -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Count $Count -Limit $Limit -Offset $Offset } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAKbaConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineIdentities" Write-Host $_.ErrorDetails } -- path: /mfa/okta-verify/config - method: GET +- path: /machine-identities/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-okta-config + label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#update-machine-identity source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}}"@ - # Configuration of Okta MFA method + + # Update a Machine Identity try { - Get-V2024MFAOktaConfig + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result # Below is a request that includes all optional parameters - # Get-V2024MFAOktaConfig + # Update-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAOktaConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MachineIdentity" Write-Host $_.ErrorDetails } -- path: /mfa/duo-web/config - method: PUT +- path: /managed-clients + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-duo-config + label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#create-managed-client source: | - $MfaDuoConfig = @" + $ManagedClientRequest = @" { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" } "@ - # Set Duo MFA configuration + # Create Managed Client try { - $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig - Set-V2024MFADuoConfig -V2024MfaDuoConfig $Result + $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest + New-V2024ManagedClient -V2024ManagedClientRequest $Result # Below is a request that includes all optional parameters - # Set-V2024MFADuoConfig -V2024MfaDuoConfig $Result + # New-V2024ManagedClient -V2024ManagedClientRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFADuoConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedClient" Write-Host $_.ErrorDetails } -- path: /mfa/kba/config/answers - method: POST +- path: /managed-clients/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfakba-config + label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#delete-managed-client source: | - $KbaAnswerRequestItem = @"{ - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" - }"@ - + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - # Set MFA KBA configuration + # Delete Managed Client try { - $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $Result + Remove-V2024ManagedClient -Id $Id # Below is a request that includes all optional parameters - # Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $Result + # Remove-V2024ManagedClient -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAKBAConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedClient" Write-Host $_.ErrorDetails } -- path: /mfa/okta-verify/config - method: PUT +- path: /managed-clients/{id} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-okta-config + label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#get-managed-client source: | - $MfaOktaConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - } - "@ + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - # Set Okta MFA configuration + # Get Managed Client try { - $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig - Set-V2024MFAOktaConfig -V2024MfaOktaConfig $Result + Get-V2024ManagedClient -Id $Id # Below is a request that includes all optional parameters - # Set-V2024MFAOktaConfig -V2024MfaOktaConfig $Result + # Get-V2024ManagedClient -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAOktaConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClient" Write-Host $_.ErrorDetails } -- path: /mfa/{method}/test +- path: /managed-clients/{id}/status method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#test-mfa-config + label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#get-managed-client-status source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + $Id = "aClientId" # String | Managed client ID to get status for. + $Type = "CCG" # ManagedClientType | Managed client type to get status for. - # MFA method's test configuration + # Get Managed Client Status try { - Test-V2024MFAConfig -Method $Method + Get-V2024ManagedClientStatus -Id $Id -Type $Type # Below is a request that includes all optional parameters - # Test-V2024MFAConfig -Method $Method + # Get-V2024ManagedClientStatus -Id $Id -Type $Type } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024MFAConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClientStatus" Write-Host $_.ErrorDetails } -- path: /non-employee-approvals/{id}/approve - method: POST +- path: /managed-clients + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#approve-non-employee-request + label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#get-managed-clients source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) - $NonEmployeeApprovalDecision = @" - { - "comment" : "Approved by manager" - } - "@ + $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) - # Approve a Non-Employee Request + # Get Managed Clients try { - $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision - Approve-V2024NonEmployeeRequest -Id $Id -V2024NonEmployeeApprovalDecision $Result + Get-V2024ManagedClients # Below is a request that includes all optional parameters - # Approve-V2024NonEmployeeRequest -Id $Id -V2024NonEmployeeApprovalDecision $Result + # Get-V2024ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024NonEmployeeRequest" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClients" Write-Host $_.ErrorDetails } -- path: /non-employee-records - method: POST +- path: /managed-clients/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#create-non-employee-record + label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#update-managed-client source: | - $NonEmployeeRequestBody = @" - { - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - } - "@ + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ - # Create Non-Employee Record + + # Update Managed Client try { - $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-V2024NonEmployeeRecord -V2024NonEmployeeRequestBody $Result + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ManagedClient -Id $Id -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # New-V2024NonEmployeeRecord -V2024NonEmployeeRequestBody $Result + # Update-V2024ManagedClient -Id $Id -V2024JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRecord" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClient" Write-Host $_.ErrorDetails } -- path: /non-employee-requests +- path: /managed-clusters method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#create-non-employee-request + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#create-managed-cluster source: | - $NonEmployeeRequestBody = @" + $ManagedClusterRequest = @" { - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" } "@ - # Create Non-Employee Request + # Create Create Managed Cluster try { - $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-V2024NonEmployeeRequest -V2024NonEmployeeRequestBody $Result + $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest + New-V2024ManagedCluster -V2024ManagedClusterRequest $Result # Below is a request that includes all optional parameters - # New-V2024NonEmployeeRequest -V2024NonEmployeeRequestBody $Result + # New-V2024ManagedCluster -V2024ManagedClusterRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRequest" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedCluster" Write-Host $_.ErrorDetails } -- path: /non-employee-sources - method: POST +- path: /managed-clusters/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#create-non-employee-source + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#delete-managed-cluster source: | - $NonEmployeeSourceRequestBody = @" - { - "owner" : { - "id" : "2c91808570313110017040b06f344ec9" - }, - "managementWorkgroup" : "123299", - "accountManagers" : [ { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - } ], - "name" : "Retail", - "description" : "Source description", - "approvers" : [ { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - } ] - } - "@ + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) - # Create Non-Employee Source + # Delete Managed Cluster try { - $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody - New-V2024NonEmployeeSource -V2024NonEmployeeSourceRequestBody $Result + Remove-V2024ManagedCluster -Id $Id # Below is a request that includes all optional parameters - # New-V2024NonEmployeeSource -V2024NonEmployeeSourceRequestBody $Result + # Remove-V2024ManagedCluster -Id $Id -RemoveClients $RemoveClients } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeSource" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedCluster" Write-Host $_.ErrorDetails } -- path: /non-employee-sources/{sourceId}/schema-attributes - method: POST +- path: /managed-clusters/{id}/log-config + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#get-client-log-configuration source: | - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. + + # Get Managed Cluster Log Configuration + + try { + Get-V2024ClientLogConfiguration -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ClientLogConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#get-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + + # Get Managed Cluster + + try { + Get-V2024ManagedCluster -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ManagedCluster -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024ManagedClusters + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusters" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024ClientLogConfiguration -Id $Id -V2024PutClientLogConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-V2024ClientLogConfiguration -Id $Id -V2024PutClientLogConfigurationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024ManagedCluster -Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024ManagedCluster -Id $Id -V2024JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id}/approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#approve-non-employee-request + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) + $NonEmployeeApprovalDecision = @" + { + "comment" : "Approved by manager" + } + "@ + + # Approve a Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision + Approve-V2024NonEmployeeRequest -Id $Id -V2024NonEmployeeApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Approve-V2024NonEmployeeRequest -Id $Id -V2024NonEmployeeApprovalDecision $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#create-non-employee-record + source: | + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Create Non-Employee Record + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-V2024NonEmployeeRecord -V2024NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-V2024NonEmployeeRecord -V2024NonEmployeeRequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#create-non-employee-request + source: | + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Create Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-V2024NonEmployeeRequest -V2024NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-V2024NonEmployeeRequest -V2024NonEmployeeRequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#create-non-employee-source + source: | + $NonEmployeeSourceRequestBody = @" + { + "owner" : { + "id" : "2c91808570313110017040b06f344ec9" + }, + "managementWorkgroup" : "123299", + "accountManagers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ], + "name" : "Retail", + "description" : "Source description", + "approvers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ] + } + "@ + + # Create Non-Employee Source + + try { + $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody + New-V2024NonEmployeeSource -V2024NonEmployeeSourceRequestBody $Result + + # Below is a request that includes all optional parameters + # New-V2024NonEmployeeSource -V2024NonEmployeeSourceRequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes + source: | + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id $NonEmployeeSchemaAttributeBody = @" { "helpText" : "The unique identifier for the account", @@ -9267,20 +9501,20 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#list-non-employee-sources source: | - $RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. $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) - $NonEmployeeCount = $true # Boolean | The flag to determine whether return a non-employee count associate with source. (optional) + $RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) + $NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) # List Non-Employee Sources try { - Get-V2024NonEmployeeSources -RequestedFor $RequestedFor + Get-V2024NonEmployeeSources # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeSources -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters + # Get-V2024NonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSources" Write-Host $_.ErrorDetails @@ -11507,2148 +11741,2330 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByQuery" Write-Host $_.ErrorDetails } -- path: /saved-searches +- path: /sim-integrations method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/saved-search#create-saved-search + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#create-sim-integration source: | - $CreateSavedSearchRequest = @" - + $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" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "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 a saved search + # Create new SIM integration try { - $Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest - New-V2024SavedSearch -V2024CreateSavedSearchRequest $Result + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result # Below is a request that includes all optional parameters - # New-V2024SavedSearch -V2024CreateSavedSearchRequest $Result + # New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SavedSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SIMIntegration" Write-Host $_.ErrorDetails } -- path: /saved-searches/{id} +- path: /sim-integrations/{id} method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/saved-search#delete-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Delete document by ID - - try { - Remove-V2024SavedSearch -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024SavedSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SavedSearch" - Write-Host $_.ErrorDetails - } -- path: /saved-searches/{id}/execute - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/saved-search#execute-saved-search + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#delete-sim-integration source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $SearchArguments = @" - { - "owner" : "", - "recipients" : [ { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" - } - "@ + $Id = "12345" # String | The id of the integration to delete. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Execute a saved search by ID + # Delete a SIM integration try { - $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments - Invoke-V2024ExecuteSavedSearch -Id $Id -V2024SearchArguments $Result + Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Invoke-V2024ExecuteSavedSearch -Id $Id -V2024SearchArguments $Result + # Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ExecuteSavedSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SIMIntegration" Write-Host $_.ErrorDetails } -- path: /saved-searches/{id} +- path: /sim-integrations/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/saved-search#get-saved-search + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integration source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $Id = "12345" # String | The id of the integration. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Return saved search by ID + # Get a SIM integration details. try { - Get-V2024SavedSearch -Id $Id + Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SavedSearch -Id $Id + # Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegration" Write-Host $_.ErrorDetails } -- path: /saved-searches +- path: /sim-integrations method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/saved-search#list-saved-searches + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integrations 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 = "owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # A list of Saved Searches + # List the existing SIM integrations. try { - Get-V2024SavedSearches + Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SavedSearches -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + # Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedSearches" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegrations" Write-Host $_.ErrorDetails } -- path: /saved-searches/{id} - method: PUT +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/saved-search#put-saved-search + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-before-provisioning-rule source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $SavedSearch = @" - { - "owner" : { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "created" : "2018-06-25T20:22:28.104Z", - "columns" : { - "identity" : [ { - "field" : "displayName", - "header" : "Display Name" - }, { - "field" : "e-mail", - "header" : "Work Email" - } ] - }, - "query" : "@accounts(disabled:true)", - "description" : "Disabled accounts", - "orderBy" : { - "identity" : [ "lastName", "firstName" ], - "role" : [ "name" ] - }, - "sort" : [ "displayName" ], - "filters" : { - "terms" : [ "account_count", "account_count" ], - "range" : { - "lower" : { - "inclusive" : false, - "value" : "1" - }, - "upper" : { - "inclusive" : false, - "value" : "1" - } - }, - "exclude" : false, - "type" : "RANGE" - }, - "ownerId" : "2c91808568c529c60168cca6f90c1313", - "indices" : [ "identities" ], - "public" : false, - "name" : "Disabled accounts", - "modified" : "2018-06-25T20:22:28.104Z", - "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", - "fields" : [ "disabled" ] - } + $Id = "12345" # String | SIM integration id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatch = @" + "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" "@ - # Updates an existing saved search + # Patch a SIM beforeProvisioningRule attribute. try { - $Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch - Send-V2024SavedSearch -Id $Id -V2024SavedSearch $Result + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result # Below is a request that includes all optional parameters - # Send-V2024SavedSearch -Id $Id -V2024SavedSearch $Result + # Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SavedSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024BeforeProvisioningRule" Write-Host $_.ErrorDetails } -- path: /scheduled-searches - method: POST +- path: /sim-integrations/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#create-scheduled-search + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-sim-attributes source: | - $CreateScheduledSearchRequest = @" - {savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]} + $Id = "12345" # String | SIM integration id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatch = @" + "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" "@ - # Create a new scheduled search + # Patch a SIM attribute. try { - $Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest - New-V2024ScheduledSearch -V2024CreateScheduledSearchRequest $Result + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result # Below is a request that includes all optional parameters - # New-V2024ScheduledSearch -V2024CreateScheduledSearchRequest $Result + # Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ScheduledSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SIMAttributes" Write-Host $_.ErrorDetails } -- path: /scheduled-searches/{id} - method: DELETE +- path: /sim-integrations/{id} + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#delete-scheduled-search + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#put-sim-integration source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $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" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "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" + } + } + "@ - # Delete a Scheduled Search + # Update an existing SIM integration try { - Remove-V2024ScheduledSearch -Id $Id + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result # Below is a request that includes all optional parameters - # Remove-V2024ScheduledSearch -Id $Id + # Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ScheduledSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SIMIntegration" Write-Host $_.ErrorDetails } -- path: /scheduled-searches/{id} - method: GET +- path: /sod-policies + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#get-scheduled-search + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#create-sod-policy source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Get a Scheduled Search - - try { - Get-V2024ScheduledSearch -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024ScheduledSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledSearch" + $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 -V2024SodPolicy $Result + + # Below is a request that includes all optional parameters + # New-V2024SodPolicy -V2024SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SodPolicy" Write-Host $_.ErrorDetails } -- path: /scheduled-searches - method: GET +- path: /sod-policies/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#list-scheduled-search + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy 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 = "savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* (optional) + $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) - # List scheduled searches + # Delete SOD policy by ID try { - Get-V2024ScheduledSearch + Remove-V2024SodPolicy -Id $Id # Below is a request that includes all optional parameters - # Get-V2024ScheduledSearch -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + # Remove-V2024SodPolicy -Id $Id -Logical $Logical } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicy" Write-Host $_.ErrorDetails } -- path: /scheduled-searches/{id}/unsubscribe - method: POST +- path: /sod-policies/{id}/schedule + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#unsubscribe-scheduled-search + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy-schedule source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $TypedReference = @" - { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } - "@ + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - # Unsubscribe a recipient from Scheduled Search + # Delete SOD policy schedule try { - $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference - Invoke-V2024UnsubscribeScheduledSearch -Id $Id -V2024TypedReference $Result + Remove-V2024SodPolicySchedule -Id $Id # Below is a request that includes all optional parameters - # Invoke-V2024UnsubscribeScheduledSearch -Id $Id -V2024TypedReference $Result + # Remove-V2024SodPolicySchedule -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024UnsubscribeScheduledSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicySchedule" Write-Host $_.ErrorDetails } -- path: /scheduled-searches/{id} - method: PUT +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#update-scheduled-search + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-custom-violation-report source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $ScheduledSearch = @" - { - "owner" : { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, - "displayQueryDetails" : false, - "created" : "", - "description" : "Daily disabled accounts", - "ownerId" : "2c9180867624cbd7017642d8c8c81f67", - "enabled" : false, - "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" - }, - "recipients" : [ { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - } ], - "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", - "name" : "Daily disabled accounts", - "modified" : "", - "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", - "emailEmptyResults" : false + $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. - # Update an existing Scheduled Search + # Download violation report try { - $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch - Update-V2024ScheduledSearch -Id $Id -V2024ScheduledSearch $Result + Get-V2024DefaultViolationReport -ReportResultId $ReportResultId # Below is a request that includes all optional parameters - # Update-V2024ScheduledSearch -Id $Id -V2024ScheduledSearch $Result + # Get-V2024DefaultViolationReport -ReportResultId $ReportResultId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ScheduledSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultViolationReport" Write-Host $_.ErrorDetails } -- path: /search/aggregate - method: POST +- path: /sod-violation-report + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search#search-aggregate + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-all-report-run-status source: | - $Search = @" - { - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" + + # 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 -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024SodPolicy -Id $Id -V2024JsonPatchOperation $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 + } ] + } ] + } }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" + "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 + } ] + } ] + } }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" + "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 + } ] + } ] } }, - "nested" : { - "name" : "id", - "type" : "access" - } + "applicationId" : "2c91808874ff91550175097daaec161c\"" }, - "nested" : { - "name" : "id", - "type" : "access" - } - } + "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 } "@ - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - # Perform a Search Query Aggregation + # Update SOD Policy schedule try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-V2024Aggregate -V2024Search $Result + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-V2024PolicySchedule -Id $Id -V2024SodPolicySchedule $Result # Below is a request that includes all optional parameters - # Search-V2024Aggregate -V2024Search $Result -Offset $Offset -Limit $Limit -Count $Count + # Send-V2024PolicySchedule -Id $Id -V2024SodPolicySchedule $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Aggregate" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PolicySchedule" Write-Host $_.ErrorDetails } -- path: /search/count - method: POST +- path: /sod-policies/{id} + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search#search-count + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-sod-policy source: | - $Search = @" + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" { - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" + "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" + } ] } }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" + "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" } "@ - # Count Documents Satisfying a Query + # Update SOD policy by ID try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-V2024Count -V2024Search $Result + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-V2024SodPolicy -Id $Id -V2024SodPolicy $Result # Below is a request that includes all optional parameters - # Search-V2024Count -V2024Search $Result + # Send-V2024SodPolicy -Id $Id -V2024SodPolicy $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Count" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SodPolicy" Write-Host $_.ErrorDetails } -- path: /search/{index}/{id} - method: GET +- path: /sod-policies/{id}/evaluate + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search#search-get + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-evaluate-sod-policy source: | - $Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - # Get a Document by ID + # Evaluate one policy by ID try { - Search-V2024Get -Index $Index -Id $Id + Start-V2024EvaluateSodPolicy -Id $Id # Below is a request that includes all optional parameters - # Search-V2024Get -Index $Index -Id $Id + # Start-V2024EvaluateSodPolicy -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Get" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024EvaluateSodPolicy" Write-Host $_.ErrorDetails } -- path: /search +- path: /sod-violation-report/run method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search#search-post + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-all-policies-for-org source: | - $Search = @" + $MultiPolicyRequest = @" { - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - } + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] } "@ - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 10000 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - # Perform Search + # Runs all policies for org try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-V2024Post -V2024Search $Result + Start-V2024SodAllPoliciesForOrg # Below is a request that includes all optional parameters - # Search-V2024Post -V2024Search $Result -Offset $Offset -Limit $Limit -Count $Count + # Start-V2024SodAllPoliciesForOrg -V2024MultiPolicyRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Post" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodAllPoliciesForOrg" Write-Host $_.ErrorDetails } -- path: /accounts/search-attribute-config +- 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 -V2024IdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-V2024PredictSodViolations -V2024IdentityWithNewAccess $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 -V2024IdentityWithNewAccess1 $Result + + # Below is a request that includes all optional parameters + # Start-V2024ViolationCheck -V2024IdentityWithNewAccess1 $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/search-attribute-configuration#create-search-attribute-config + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#export-sp-config source: | - $SearchAttributeConfig = @" + $ExportPayload = @" { - "displayName" : "New Mail Attribute", - "name" : "newMailAttribute", - "applicationAttributes" : { - "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", - "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" - } + "description" : "Export Job 1 Test" } "@ - # Create Extended Search Attributes + # Initiates configuration objects export job try { - $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig - New-V2024SearchAttributeConfig -V2024SearchAttributeConfig $Result + $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload + Export-V2024SpConfig -V2024ExportPayload $Result # Below is a request that includes all optional parameters - # New-V2024SearchAttributeConfig -V2024SearchAttributeConfig $Result + # Export-V2024SpConfig -V2024ExportPayload $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024SpConfig" Write-Host $_.ErrorDetails } -- path: /accounts/search-attribute-config/{name} - method: DELETE +- path: /sp-config/export/{id}/download + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#delete-search-attribute-config + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. - # Delete Extended Search Attribute + # Download export job result. try { - Remove-V2024SearchAttributeConfig -Name $Name + Get-V2024SpConfigExport -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024SearchAttributeConfig -Name $Name + # Get-V2024SpConfigExport -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExport" Write-Host $_.ErrorDetails } -- path: /accounts/search-attribute-config +- path: /sp-config/export/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#get-search-attribute-config + 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. - # List Extended Search Attributes + # Get export job status try { - Get-V2024SearchAttributeConfig + Get-V2024SpConfigExportStatus -Id $Id # Below is a request that includes all optional parameters - # Get-V2024SearchAttributeConfig + # Get-V2024SpConfigExportStatus -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExportStatus" Write-Host $_.ErrorDetails } -- path: /accounts/search-attribute-config/{name} +- path: /sp-config/import/{id}/download method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#get-single-search-attribute-config + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to retrieve. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. - # Get Extended Search Attribute + # Download import job result try { - Get-V2024SingleSearchAttributeConfig -Name $Name + Get-V2024SpConfigImport -Id $Id # Below is a request that includes all optional parameters - # Get-V2024SingleSearchAttributeConfig -Name $Name + # Get-V2024SpConfigImport -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SingleSearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImport" Write-Host $_.ErrorDetails } -- path: /accounts/search-attribute-config/{name} - method: PATCH +- path: /sp-config/import/{id} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#patch-search-attribute-config + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import-status source: | - $Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. - # Update Extended Search Attribute + # Get import job status try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024SearchAttributeConfig -Name $Name -V2024JsonPatchOperation $Result + Get-V2024SpConfigImportStatus -Id $Id # Below is a request that includes all optional parameters - # Update-V2024SearchAttributeConfig -Name $Name -V2024JsonPatchOperation $Result + # Get-V2024SpConfigImportStatus -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImportStatus" Write-Host $_.ErrorDetails } -- path: /segments +- path: /sp-config/import method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/segments#create-segment + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#import-sp-config 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" - } + $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 = @" "@ - # Create Segment + # Initiates configuration objects import job try { - $Result = ConvertFrom-JsonToSegment -Json $Segment - New-V2024Segment -V2024Segment $Result + Import-V2024SpConfig -Data $Data # Below is a request that includes all optional parameters - # New-V2024Segment -V2024Segment $Result + # Import-V2024SpConfig -Data $Data -Preview $Preview -V2024Options $Options } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Segment" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024SpConfig" Write-Host $_.ErrorDetails } -- path: /segments/{id} - method: DELETE +- path: /sp-config/config-objects + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/segments#delete-segment + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#list-sp-config-objects source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. - # Delete Segment by ID + # Get config object details try { - Remove-V2024Segment -Id $Id + Get-V2024SpConfigObjects # Below is a request that includes all optional parameters - # Remove-V2024Segment -Id $Id + # Get-V2024SpConfigObjects } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Segment" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigObjects" Write-Host $_.ErrorDetails } -- path: /segments/{id} - method: GET +- path: /saved-searches + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/segments#get-segment + label: SDK_tools/sdk/powershell/v2024/methods/saved-search#create-saved-search source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. + $CreateSavedSearchRequest = @" - # Get Segment by ID + "@ + + # Create a saved search try { - Get-V2024Segment -Id $Id + $Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest + New-V2024SavedSearch -V2024CreateSavedSearchRequest $Result # Below is a request that includes all optional parameters - # Get-V2024Segment -Id $Id + # New-V2024SavedSearch -V2024CreateSavedSearchRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Segment" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SavedSearch" Write-Host $_.ErrorDetails } -- path: /segments - method: GET +- path: /saved-searches/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/segments#list-segments + label: SDK_tools/sdk/powershell/v2024/methods/saved-search#delete-saved-search 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) + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # List Segments + # Delete document by ID try { - Get-V2024Segments + Remove-V2024SavedSearch -Id $Id # Below is a request that includes all optional parameters - # Get-V2024Segments -Limit $Limit -Offset $Offset -Count $Count + # Remove-V2024SavedSearch -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Segments" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SavedSearch" Write-Host $_.ErrorDetails } -- path: /segments/{id} - method: PATCH +- path: /saved-searches/{id}/execute + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/segments#patch-segment + label: SDK_tools/sdk/powershell/v2024/methods/saved-search#execute-saved-search 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}}]}}}]"@ - + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $SearchArguments = @" + { + "owner" : "", + "recipients" : [ { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" + } + "@ - # Update Segment + # Execute a saved search by ID try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2024Segment -Id $Id -RequestBody $Result + $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments + Invoke-V2024ExecuteSavedSearch -Id $Id -V2024SearchArguments $Result # Below is a request that includes all optional parameters - # Update-V2024Segment -Id $Id -RequestBody $Result + # Invoke-V2024ExecuteSavedSearch -Id $Id -V2024SearchArguments $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Segment" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ExecuteSavedSearch" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations - method: POST +- path: /saved-searches/{id} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#create-service-desk-integration + label: SDK_tools/sdk/powershell/v2024/methods/saved-search#get-saved-search source: | - $ServiceDeskIntegrationDto = @" - { - "ownerRef" : "", - "cluster" : "xyzzy999", - "created" : "2024-01-17T18:45:25.994Z", - "description" : "A very nice Service Desk integration", - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "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", - "modified" : "2024-02-18T18:45:25.994Z", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "id" : "62945a496ef440189b1f03e3623411c8", - "beforeProvisioningRule" : "" - } - "@ + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # Create new Service Desk integration + # Return saved search by ID try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - New-V2024ServiceDeskIntegration -V2024ServiceDeskIntegrationDto $Result + Get-V2024SavedSearch -Id $Id # Below is a request that includes all optional parameters - # New-V2024ServiceDeskIntegration -V2024ServiceDeskIntegrationDto $Result + # Get-V2024SavedSearch -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ServiceDeskIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedSearch" Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: DELETE + } +- path: /saved-searches + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#delete-service-desk-integration + label: SDK_tools/sdk/powershell/v2024/methods/saved-search#list-saved-searches source: | - $Id = "anId" # String | ID of Service Desk integration to delete + $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 = "owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) - # Delete a Service Desk integration + # A list of Saved Searches try { - Remove-V2024ServiceDeskIntegration -Id $Id + Get-V2024SavedSearches # Below is a request that includes all optional parameters - # Remove-V2024ServiceDeskIntegration -Id $Id + # Get-V2024SavedSearches -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ServiceDeskIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedSearches" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/{id} - method: GET +- path: /saved-searches/{id} + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integration + label: SDK_tools/sdk/powershell/v2024/methods/saved-search#put-saved-search source: | - $Id = "anId" # String | ID of the Service Desk integration to get + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $SavedSearch = @" + { + "owner" : { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2018-06-25T20:22:28.104Z", + "columns" : { + "identity" : [ { + "field" : "displayName", + "header" : "Display Name" + }, { + "field" : "e-mail", + "header" : "Work Email" + } ] + }, + "query" : "@accounts(disabled:true)", + "description" : "Disabled accounts", + "orderBy" : { + "identity" : [ "lastName", "firstName" ], + "role" : [ "name" ] + }, + "sort" : [ "displayName" ], + "filters" : { + "terms" : [ "account_count", "account_count" ], + "range" : { + "lower" : { + "inclusive" : false, + "value" : "1" + }, + "upper" : { + "inclusive" : false, + "value" : "1" + } + }, + "exclude" : false, + "type" : "RANGE" + }, + "ownerId" : "2c91808568c529c60168cca6f90c1313", + "indices" : [ "identities" ], + "public" : false, + "name" : "Disabled accounts", + "modified" : "2018-06-25T20:22:28.104Z", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "fields" : [ "disabled" ] + } + "@ - # Get a Service Desk integration + # Updates an existing saved search try { - Get-V2024ServiceDeskIntegration -Id $Id + $Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch + Send-V2024SavedSearch -Id $Id -V2024SavedSearch $Result # Below is a request that includes all optional parameters - # Get-V2024ServiceDeskIntegration -Id $Id + # Send-V2024SavedSearch -Id $Id -V2024SavedSearch $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SavedSearch" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/templates/{scriptName} - method: GET +- path: /scheduled-searches + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integration-template + label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#create-scheduled-search source: | - $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get + $CreateScheduledSearchRequest = @" + {savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]} + "@ - # Service Desk integration template by scriptName + # Create a new scheduled search try { - Get-V2024ServiceDeskIntegrationTemplate -ScriptName $ScriptName + $Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest + New-V2024ScheduledSearch -V2024CreateScheduledSearchRequest $Result # Below is a request that includes all optional parameters - # Get-V2024ServiceDeskIntegrationTemplate -ScriptName $ScriptName + # New-V2024ScheduledSearch -V2024CreateScheduledSearchRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrationTemplate" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ScheduledSearch" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/types - method: GET +- path: /scheduled-searches/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integration-types + label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#delete-scheduled-search source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # List Service Desk integration types + # Delete a Scheduled Search try { - Get-V2024ServiceDeskIntegrationTypes + Remove-V2024ScheduledSearch -Id $Id # Below is a request that includes all optional parameters - # Get-V2024ServiceDeskIntegrationTypes + # Remove-V2024ScheduledSearch -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrationTypes" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ScheduledSearch" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations +- path: /scheduled-searches/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integrations + label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#get-scheduled-search 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 = "name eq "John Doe"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # List existing Service Desk integrations + # Get a Scheduled Search try { - Get-V2024ServiceDeskIntegrations + Get-V2024ScheduledSearch -Id $Id # Below is a request that includes all optional parameters - # Get-V2024ServiceDeskIntegrations -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count + # Get-V2024ScheduledSearch -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrations" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledSearch" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/status-check-configuration +- path: /scheduled-searches method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-status-check-details + label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#list-scheduled-search 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 = "savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* (optional) - # Get the time check configuration + # List scheduled searches try { - Get-V2024StatusCheckDetails + Get-V2024ScheduledSearch # Below is a request that includes all optional parameters - # Get-V2024StatusCheckDetails + # Get-V2024ScheduledSearch -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusCheckDetails" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledSearch" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/{id} - method: PATCH +- path: /scheduled-searches/{id}/unsubscribe + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#patch-service-desk-integration + label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#unsubscribe-scheduled-search source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $PatchServiceDeskIntegrationRequest = @" - + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $TypedReference = @" + { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } "@ - # Patch a Service Desk Integration + # Unsubscribe a recipient from Scheduled Search try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-V2024ServiceDeskIntegration -Id $Id -V2024PatchServiceDeskIntegrationRequest $Result + $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference + Invoke-V2024UnsubscribeScheduledSearch -Id $Id -V2024TypedReference $Result # Below is a request that includes all optional parameters - # Update-V2024ServiceDeskIntegration -Id $Id -V2024PatchServiceDeskIntegrationRequest $Result + # Invoke-V2024UnsubscribeScheduledSearch -Id $Id -V2024TypedReference $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ServiceDeskIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024UnsubscribeScheduledSearch" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/{id} +- path: /scheduled-searches/{id} method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#put-service-desk-integration + label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#update-scheduled-search source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $ServiceDeskIntegrationDto = @" + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $ScheduledSearch = @" { - "ownerRef" : "", - "cluster" : "xyzzy999", - "created" : "2024-01-17T18:45:25.994Z", - "description" : "A very nice Service Desk integration", - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "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" - } + "owner" : { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" }, - "name" : "Service Desk Integration Name", - "modified" : "2024-02-18T18:45:25.994Z", - "attributes" : { - "property" : "value", - "key" : "value" + "displayQueryDetails" : false, + "created" : "", + "description" : "Daily disabled accounts", + "ownerId" : "2c9180867624cbd7017642d8c8c81f67", + "enabled" : false, + "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" }, - "id" : "62945a496ef440189b1f03e3623411c8", - "beforeProvisioningRule" : "" + "recipients" : [ { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + } ], + "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", + "name" : "Daily disabled accounts", + "modified" : "", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "emailEmptyResults" : false } "@ - # Update a Service Desk integration + # Update an existing Scheduled Search try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - Send-V2024ServiceDeskIntegration -Id $Id -V2024ServiceDeskIntegrationDto $Result + $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch + Update-V2024ScheduledSearch -Id $Id -V2024ScheduledSearch $Result # Below is a request that includes all optional parameters - # Send-V2024ServiceDeskIntegration -Id $Id -V2024ServiceDeskIntegrationDto $Result + # Update-V2024ScheduledSearch -Id $Id -V2024ScheduledSearch $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ServiceDeskIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ScheduledSearch" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/status-check-configuration - method: PUT +- path: /search/aggregate + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#update-status-check-details + label: SDK_tools/sdk/powershell/v2024/methods/search#search-aggregate source: | - $QueuedCheckConfigDetails = @" + $Search = @" { - "provisioningStatusCheckIntervalMinutes" : "30", - "provisioningMaxStatusCheckDays" : "2" + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } } "@ + $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) - # Update the time check configuration + # Perform a Search Query Aggregation try { - $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails - Update-V2024StatusCheckDetails -V2024QueuedCheckConfigDetails $Result + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-V2024Aggregate -V2024Search $Result # Below is a request that includes all optional parameters - # Update-V2024StatusCheckDetails -V2024QueuedCheckConfigDetails $Result + # Search-V2024Aggregate -V2024Search $Result -Offset $Offset -Limit $Limit -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024StatusCheckDetails" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Aggregate" Write-Host $_.ErrorDetails } -- path: /sim-integrations +- path: /search/count method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#create-sim-integration + label: SDK_tools/sdk/powershell/v2024/methods/search#search-count source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SimIntegrationDetails = @" + $Search = @" { - "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" : "2023-01-03T21:16:22.432Z", - "name" : "aName", - "modified" : "2023-01-03T21:16:22.432Z", - "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" + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } } } "@ - # Create new SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $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. + # Count Documents Satisfying a Query try { - Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-V2024Count -V2024Search $Result # Below is a request that includes all optional parameters - # Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + # Search-V2024Count -V2024Search $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Count" Write-Host $_.ErrorDetails } -- path: /sim-integrations +- path: /search/{index}/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integrations + label: SDK_tools/sdk/powershell/v2024/methods/search#search-get source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # List the existing SIM integrations. + # Get a Document by ID try { - Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental + Search-V2024Get -Index $Index -Id $Id # Below is a request that includes all optional parameters - # Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental + # Search-V2024Get -Index $Index -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegrations" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Get" Write-Host $_.ErrorDetails } -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH +- path: /search + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-before-provisioning-rule + label: SDK_tools/sdk/powershell/v2024/methods/search#search-post source: | - $Id = "12345" # String | SIM integration id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatch = @" - "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" - "@ - - # Patch a SIM beforeProvisioningRule attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024BeforeProvisioningRule" - Write-Host $_.ErrorDetails + $Search = @" + { + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } } -- 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 = @" - "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" "@ + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 10000 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - # Patch a SIM attribute. + # Perform Search try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-V2024Post -V2024Search $Result # Below is a request that includes all optional parameters - # Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result + # Search-V2024Post -V2024Search $Result -Offset $Offset -Limit $Limit -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SIMAttributes" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Post" Write-Host $_.ErrorDetails } -- path: /sim-integrations/{id} - method: PUT +- path: /accounts/search-attribute-config + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#put-sim-integration + label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#create-search-attribute-config source: | - $Id = "12345" # String | The id of the integration. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SimIntegrationDetails = @" + $SearchAttributeConfig = @" { - "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" : "2023-01-03T21:16:22.432Z", - "name" : "aName", - "modified" : "2023-01-03T21:16:22.432Z", - "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" + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" } } "@ - # Update an existing SIM integration + # Create Extended Search Attributes try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result + $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig + New-V2024SearchAttributeConfig -V2024SearchAttributeConfig $Result # Below is a request that includes all optional parameters - # Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result + # New-V2024SearchAttributeConfig -V2024SearchAttributeConfig $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SIMIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SearchAttributeConfig" Write-Host $_.ErrorDetails } -- path: /sod-policies - method: POST +- path: /accounts/search-attribute-config/{name} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#create-sod-policy + label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#delete-search-attribute-config 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" - } - "@ + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. - # Create SOD policy + # Delete Extended Search Attribute try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-V2024SodPolicy -V2024SodPolicy $Result + Remove-V2024SearchAttributeConfig -Name $Name # Below is a request that includes all optional parameters - # New-V2024SodPolicy -V2024SodPolicy $Result + # Remove-V2024SearchAttributeConfig -Name $Name } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SearchAttributeConfig" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id} - method: DELETE +- path: /accounts/search-attribute-config + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy + label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#get-search-attribute-config 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 + # List Extended Search Attributes try { - Remove-V2024SodPolicy -Id $Id + Get-V2024SearchAttributeConfig # Below is a request that includes all optional parameters - # Remove-V2024SodPolicy -Id $Id -Logical $Logical + # Get-V2024SearchAttributeConfig } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SearchAttributeConfig" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id}/schedule - method: DELETE +- path: /accounts/search-attribute-config/{name} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy-schedule + label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#get-single-search-attribute-config source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to retrieve. - # Delete SOD policy schedule + # Get Extended Search Attribute try { - Remove-V2024SodPolicySchedule -Id $Id + Get-V2024SingleSearchAttributeConfig -Name $Name # Below is a request that includes all optional parameters - # Remove-V2024SodPolicySchedule -Id $Id + # Get-V2024SingleSearchAttributeConfig -Name $Name } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicySchedule" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SingleSearchAttributeConfig" Write-Host $_.ErrorDetails } -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET +- path: /accounts/search-attribute-config/{name} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-custom-violation-report + label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#patch-search-attribute-config source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - $FileName = "custom-name" # String | Custom Name for the file. + $Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ - # Download custom violation report + + # Update Extended Search Attribute try { - Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SearchAttributeConfig -Name $Name -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + # Update-V2024SearchAttributeConfig -Name $Name -V2024JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomViolationReport" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SearchAttributeConfig" Write-Host $_.ErrorDetails } -- path: /sod-violation-report/{reportResultId}/download - method: GET +- path: /segments + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-default-violation-report + label: SDK_tools/sdk/powershell/v2024/methods/segments#create-segment 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 + $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" } -- 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 + # Create Segment try { - Get-V2024SodAllReportRunStatus + $Result = ConvertFrom-JsonToSegment -Json $Segment + New-V2024Segment -V2024Segment $Result # Below is a request that includes all optional parameters - # Get-V2024SodAllReportRunStatus + # New-V2024Segment -V2024Segment $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodAllReportRunStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Segment" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id} - method: GET +- path: /segments/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy + label: SDK_tools/sdk/powershell/v2024/methods/segments#delete-segment source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. - # Get SOD policy by ID + # Delete Segment by ID try { - Get-V2024SodPolicy -Id $Id + Remove-V2024Segment -Id $Id # Below is a request that includes all optional parameters - # Get-V2024SodPolicy -Id $Id + # Remove-V2024Segment -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Segment" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id}/schedule +- path: /segments/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy-schedule + label: SDK_tools/sdk/powershell/v2024/methods/segments#get-segment source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. - # Get SOD policy schedule + # Get Segment by ID try { - Get-V2024SodPolicySchedule -Id $Id + Get-V2024Segment -Id $Id # Below is a request that includes all optional parameters - # Get-V2024SodPolicySchedule -Id $Id + # Get-V2024Segment -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicySchedule" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Segment" Write-Host $_.ErrorDetails } -- path: /sod-policies/sod-violation-report-status/{reportResultId} +- path: /segments method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-run-status + label: SDK_tools/sdk/powershell/v2024/methods/segments#list-segments source: | - $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - # Get violation report run status + # List Segments try { - Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId + Get-V2024Segments # Below is a request that includes all optional parameters - # Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId + # Get-V2024Segments -Limit $Limit -Offset $Offset -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportRunStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Segments" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id}/violation-report - method: GET +- path: /segments/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-status + label: SDK_tools/sdk/powershell/v2024/methods/segments#patch-segment source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. + $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}}]}}}]"@ - # Get SOD violation report status + + # Update Segment try { - Get-V2024SodViolationReportStatus -Id $Id + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-V2024Segment -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters - # Get-V2024SodViolationReportStatus -Id $Id + # Update-V2024Segment -Id $Id -RequestBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Segment" Write-Host $_.ErrorDetails } -- path: /sod-policies - method: GET +- path: /service-desk-integrations + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#list-sod-policies + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#create-service-desk-integration 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) + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "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", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } + "@ - # List SOD policies + # Create new Service Desk integration try { - Get-V2024SodPolicies + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + New-V2024ServiceDeskIntegration -V2024ServiceDeskIntegrationDto $Result # Below is a request that includes all optional parameters - # Get-V2024SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + # New-V2024ServiceDeskIntegration -V2024ServiceDeskIntegrationDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicies" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ServiceDeskIntegration" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id} - method: PATCH +- path: /service-desk-integrations/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#patch-sod-policy + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#delete-service-desk-integration source: | - $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - + $Id = "anId" # String | ID of Service Desk integration to delete - # Patch SOD policy by ID + # Delete a Service Desk integration try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024SodPolicy -Id $Id -V2024JsonPatchOperation $Result + Remove-V2024ServiceDeskIntegration -Id $Id # Below is a request that includes all optional parameters - # Update-V2024SodPolicy -Id $Id -V2024JsonPatchOperation $Result + # Remove-V2024ServiceDeskIntegration -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ServiceDeskIntegration" 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 - } - "@ +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to get - # Update SOD Policy schedule + # Get a Service Desk integration try { - $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-V2024PolicySchedule -Id $Id -V2024SodPolicySchedule $Result + Get-V2024ServiceDeskIntegration -Id $Id # Below is a request that includes all optional parameters - # Send-V2024PolicySchedule -Id $Id -V2024SodPolicySchedule $Result + # Get-V2024ServiceDeskIntegration -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PolicySchedule" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegration" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id} - method: PUT +- path: /service-desk-integrations/templates/{scriptName} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-sod-policy + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integration-template 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" + $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get + + # Service Desk integration template by scriptName + + try { + Get-V2024ServiceDeskIntegrationTemplate -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2024ServiceDeskIntegrationTemplate -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrationTemplate" + Write-Host $_.ErrorDetails } - "@ +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integration-types + source: | - # Update SOD policy by ID + # List Service Desk integration types try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-V2024SodPolicy -Id $Id -V2024SodPolicy $Result + Get-V2024ServiceDeskIntegrationTypes # Below is a request that includes all optional parameters - # Send-V2024SodPolicy -Id $Id -V2024SodPolicy $Result + # Get-V2024ServiceDeskIntegrationTypes } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrationTypes" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id}/evaluate - method: POST +- path: /service-desk-integrations + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-evaluate-sod-policy + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integrations source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + $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 = "name eq "John Doe"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - # Evaluate one policy by ID + # List existing Service Desk integrations try { - Start-V2024EvaluateSodPolicy -Id $Id + Get-V2024ServiceDeskIntegrations # Below is a request that includes all optional parameters - # Start-V2024EvaluateSodPolicy -Id $Id + # Get-V2024ServiceDeskIntegrations -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024EvaluateSodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrations" Write-Host $_.ErrorDetails } -- path: /sod-violation-report/run - method: POST +- path: /service-desk-integrations/status-check-configuration + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-all-policies-for-org + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-status-check-details source: | - $MultiPolicyRequest = @" - { - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + + # Get the time check configuration + + try { + Get-V2024StatusCheckDetails + + # Below is a request that includes all optional parameters + # Get-V2024StatusCheckDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusCheckDetails" + Write-Host $_.ErrorDetails } +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#patch-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $PatchServiceDeskIntegrationRequest = @" + "@ - # Runs all policies for org + # Patch a Service Desk Integration try { - Start-V2024SodAllPoliciesForOrg + $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest + Update-V2024ServiceDeskIntegration -Id $Id -V2024PatchServiceDeskIntegrationRequest $Result # Below is a request that includes all optional parameters - # Start-V2024SodAllPoliciesForOrg -V2024MultiPolicyRequest $Result + # Update-V2024ServiceDeskIntegration -Id $Id -V2024PatchServiceDeskIntegrationRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodAllPoliciesForOrg" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ServiceDeskIntegration" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id}/violation-report/run - method: POST +- path: /service-desk-integrations/{id} + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-policy + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#put-service-desk-integration source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + $Id = "anId" # String | ID of the Service Desk integration to update + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "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", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } + "@ - # Runs SOD policy violation report + # Update a Service Desk integration try { - Start-V2024SodPolicy -Id $Id + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + Send-V2024ServiceDeskIntegration -Id $Id -V2024ServiceDeskIntegrationDto $Result # Below is a request that includes all optional parameters - # Start-V2024SodPolicy -Id $Id + # Send-V2024ServiceDeskIntegration -Id $Id -V2024ServiceDeskIntegrationDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ServiceDeskIntegration" Write-Host $_.ErrorDetails } -- path: /sod-violations/predict - method: POST +- path: /service-desk-integrations/status-check-configuration + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-predict-sod-violations + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#update-status-check-details source: | - $IdentityWithNewAccess = @" + $QueuedCheckConfigDetails = @" { - "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" - } ] + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" } "@ - # Predict SOD violations for identity. + # Update the time check configuration + + try { + $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails + Update-V2024StatusCheckDetails -V2024QueuedCheckConfigDetails $Result + + # Below is a request that includes all optional parameters + # Update-V2024StatusCheckDetails -V2024QueuedCheckConfigDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024StatusCheckDetails" + 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 { - $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-V2024PredictSodViolations -V2024IdentityWithNewAccess $Result + Get-V2024StatusBySourceId -SourceId $SourceId # Below is a request that includes all optional parameters - # Start-V2024PredictSodViolations -V2024IdentityWithNewAccess $Result + # Get-V2024StatusBySourceId -SourceId $SourceId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024PredictSodViolations" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusBySourceId" Write-Host $_.ErrorDetails } -- path: /sod-violations/check - method: POST +- path: /source-usages/{sourceId}/summaries + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-violation-check + label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-usages-by-source-id 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}} - "@ + $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) - # Check SOD violations + # Returns source usage insights try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 - Start-V2024ViolationCheck -V2024IdentityWithNewAccess1 $Result + Get-V2024UsagesBySourceId -SourceId $SourceId # Below is a request that includes all optional parameters - # Start-V2024ViolationCheck -V2024IdentityWithNewAccess1 $Result + # Get-V2024UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024ViolationCheck" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesBySourceId" Write-Host $_.ErrorDetails } - path: /sources/{sourceId}/provisioning-policies @@ -14946,359 +15362,170 @@ }, "isMultiValued" : false, "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" - }"@ - - - # Bulk Update Provisioning Policies - - try { - $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - Update-V2024ProvisioningPoliciesInBulk -SourceId $SourceId -V2024ProvisioningPolicyDto $Result - - # Below is a request that includes all optional parameters - # Update-V2024ProvisioningPoliciesInBulk -SourceId $SourceId -V2024ProvisioningPolicyDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPoliciesInBulk" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/provisioning-policies/{usageType} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#update-provisioning-policy - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Partial update of Provisioning Policy - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -V2024JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -V2024JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPolicy" - Write-Host $_.ErrorDetails - } -- path: /sources/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Source (Partial) - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Source -Id $Id -V2024JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024Source -Id $Id -V2024JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Source" - Write-Host $_.ErrorDetails - } -- path: /sources/{id}/entitlement-request-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source-entitlement-request-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SourceEntitlementRequestConfig = @" - { - "accessRequestConfig" : { - "denialCommentRequired" : false, - "approvalSchemes" : [ { - "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", - "approverType" : "GOVERNANCE_GROUP" - } ], - "requestCommentRequired" : true - } - } - "@ - - # Update Source Entitlement Request Configuration - - try { - $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig - Update-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -V2024SourceEntitlementRequestConfig $Result - - # Below is a request that includes all optional parameters - # Update-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -V2024SourceEntitlementRequestConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceEntitlementRequestConfig" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schedules/{scheduleType} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source-schedule - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Source Schedule (Partial) - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -V2024JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -V2024JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchedule" - Write-Host $_.ErrorDetails - } -- path: /sources/{sourceId}/schemas/{schemaId} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source-schema - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Source Schema (Partial) - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -V2024JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -V2024JsonPatchOperation $Result - } catch { - 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: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ExportPayload = @" - { - "description" : "Export Job 1 Test" - } - "@ - - # Initiates configuration objects export job + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }"@ - try { - $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-V2024SpConfig -XSailPointExperimental $XSailPointExperimental -V2024ExportPayload $Result - - # Below is a request that includes all optional parameters - # Export-V2024SpConfig -XSailPointExperimental $XSailPointExperimental -V2024ExportPayload $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. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Download export job result. + # Bulk Update Provisioning Policies try { - Get-V2024SpConfigExport -Id $Id -XSailPointExperimental $XSailPointExperimental + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Update-V2024ProvisioningPoliciesInBulk -SourceId $SourceId -V2024ProvisioningPolicyDto $Result # Below is a request that includes all optional parameters - # Get-V2024SpConfigExport -Id $Id -XSailPointExperimental $XSailPointExperimental + # Update-V2024ProvisioningPoliciesInBulk -SourceId $SourceId -V2024ProvisioningPolicyDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExport" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPoliciesInBulk" Write-Host $_.ErrorDetails } -- path: /sp-config/export/{id} - method: GET +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export-status + label: SDK_tools/sdk/powershell/v2024/methods/sources#update-provisioning-policy source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ - # Get export job status + + # Partial update of Provisioning Policy try { - Get-V2024SpConfigExportStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Get-V2024SpConfigExportStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + # Update-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -V2024JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExportStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPolicy" Write-Host $_.ErrorDetails } -- path: /sp-config/import/{id}/download - method: GET +- path: /sources/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import + label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ - # Download import job result + + # Update Source (Partial) try { - Get-V2024SpConfigImport -Id $Id -XSailPointExperimental $XSailPointExperimental + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Source -Id $Id -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Get-V2024SpConfigImport -Id $Id -XSailPointExperimental $XSailPointExperimental + # Update-V2024Source -Id $Id -V2024JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImport" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Source" Write-Host $_.ErrorDetails } -- path: /sp-config/import/{id} - method: GET +- path: /sources/{id}/entitlement-request-config + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import-status + label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source-entitlement-request-config source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SourceEntitlementRequestConfig = @" + { + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + } + "@ - # Get import job status + # Update Source Entitlement Request Configuration try { - Get-V2024SpConfigImportStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig + Update-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -V2024SourceEntitlementRequestConfig $Result # Below is a request that includes all optional parameters - # Get-V2024SpConfigImportStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + # Update-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -V2024SourceEntitlementRequestConfig $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImportStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceEntitlementRequestConfig" Write-Host $_.ErrorDetails } -- path: /sp-config/import - method: POST +- path: /sources/{sourceId}/schedules/{scheduleType} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#import-sp-config + label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source-schedule source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $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 = @" - "@ + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ - # Initiates configuration objects import job + + # Update Source Schedule (Partial) try { - Import-V2024SpConfig -XSailPointExperimental $XSailPointExperimental -Data $Data + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Import-V2024SpConfig -XSailPointExperimental $XSailPointExperimental -Data $Data -Preview $Preview -V2024Options $Options + # Update-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -V2024JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024SpConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchedule" Write-Host $_.ErrorDetails } -- path: /sp-config/config-objects - method: GET +- path: /sources/{sourceId}/schemas/{schemaId} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#list-sp-config-objects + label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source-schema source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ - # Get config object details + + # Update Source Schema (Partial) try { - Get-V2024SpConfigObjects -XSailPointExperimental $XSailPointExperimental + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Get-V2024SpConfigObjects -XSailPointExperimental $XSailPointExperimental + # Update-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -V2024JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigObjects" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchema" Write-Host $_.ErrorDetails } - path: /suggested-entitlement-description-batches/{batchId}/stats @@ -15308,15 +15535,14 @@ label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#get-sed-batch-stats source: | $BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Submit Sed Batch Stats Request try { - Get-V2024SedBatchStats -BatchId $BatchId -XSailPointExperimental $XSailPointExperimental + Get-V2024SedBatchStats -BatchId $BatchId # Below is a request that includes all optional parameters - # Get-V2024SedBatchStats -BatchId $BatchId -XSailPointExperimental $XSailPointExperimental + # Get-V2024SedBatchStats -BatchId $BatchId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatchStats" Write-Host $_.ErrorDetails @@ -15327,15 +15553,14 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#get-sed-batches source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # List Sed Batch Request try { - Get-V2024SedBatches -XSailPointExperimental $XSailPointExperimental + Get-V2024SedBatches # Below is a request that includes all optional parameters - # Get-V2024SedBatches -XSailPointExperimental $XSailPointExperimental + # Get-V2024SedBatches } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatches" Write-Host $_.ErrorDetails @@ -15346,22 +15571,22 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#list-seds source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = limit=25 # Int64 | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) + $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 = "displayName co "Read and Write"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) $Sorters = "sorters=displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional) - $Count = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) - $CountOnly = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) - $RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) - $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) + $CountOnly = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to $false) + $RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to $false) + $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) (default to $false) # List Suggested Entitlement Descriptions try { - Get-V2024Seds -XSailPointExperimental $XSailPointExperimental + Get-V2024Seds # Below is a request that includes all optional parameters - # Get-V2024Seds -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Filters $Filters -Sorters $Sorters -Count $Count -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $ShowPendingStatusOnly + # Get-V2024Seds -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $ShowPendingStatusOnly } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Seds" Write-Host $_.ErrorDetails @@ -15373,7 +15598,6 @@ label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#patch-sed source: | $Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $SedPatch = @"{ "op" : "replace", "path" : "status", @@ -15385,10 +15609,10 @@ try { $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch - Update-V2024Sed -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SedPatch $Result + Update-V2024Sed -Id $Id -V2024SedPatch $Result # Below is a request that includes all optional parameters - # Update-V2024Sed -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SedPatch $Result + # Update-V2024Sed -Id $Id -V2024SedPatch $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Sed" Write-Host $_.ErrorDetails @@ -15399,7 +15623,6 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#submit-sed-approval source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $SedApproval = @"{ "items" : "016629d1-1d25-463f-97f3-c6686846650" }"@ @@ -15409,10 +15632,10 @@ try { $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval - Submit-V2024SedApproval -XSailPointExperimental $XSailPointExperimental -V2024SedApproval $Result + Submit-V2024SedApproval -V2024SedApproval $Result # Below is a request that includes all optional parameters - # Submit-V2024SedApproval -XSailPointExperimental $XSailPointExperimental -V2024SedApproval $Result + # Submit-V2024SedApproval -V2024SedApproval $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedApproval" Write-Host $_.ErrorDetails @@ -15423,7 +15646,6 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#submit-sed-assignment source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $SedAssignment = @" { "assignee" : { @@ -15438,10 +15660,10 @@ try { $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment - Submit-V2024SedAssignment -XSailPointExperimental $XSailPointExperimental -V2024SedAssignment $Result + Submit-V2024SedAssignment -V2024SedAssignment $Result # Below is a request that includes all optional parameters - # Submit-V2024SedAssignment -XSailPointExperimental $XSailPointExperimental -V2024SedAssignment $Result + # Submit-V2024SedAssignment -V2024SedAssignment $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedAssignment" Write-Host $_.ErrorDetails @@ -15452,7 +15674,6 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#submit-sed-batch-request source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $SedBatchRequest = @" { "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], @@ -15463,10 +15684,10 @@ # Submit Sed Batch Request try { - Submit-V2024SedBatchRequest -XSailPointExperimental $XSailPointExperimental + Submit-V2024SedBatchRequest # Below is a request that includes all optional parameters - # Submit-V2024SedBatchRequest -XSailPointExperimental $XSailPointExperimental -V2024SedBatchRequest $Result + # Submit-V2024SedBatchRequest -V2024SedBatchRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedBatchRequest" Write-Host $_.ErrorDetails @@ -15804,15 +16025,14 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/tenant#get-tenant source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Get Tenant Information. try { - Get-V2024Tenant -XSailPointExperimental $XSailPointExperimental + Get-V2024Tenant # Below is a request that includes all optional parameters - # Get-V2024Tenant -XSailPointExperimental $XSailPointExperimental + # Get-V2024Tenant } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Tenant" Write-Host $_.ErrorDetails @@ -16413,887 +16633,887 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024VendorConnectorMappings" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id}/cancel +- path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#cancel-workflow-execution + label: SDK_tools/sdk/powershell/v2024/methods/work-items#approve-approval-item source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - # Cancel Workflow Execution by ID + # Approve an Approval Item try { - Suspend-V2024WorkflowExecution -Id $Id + Approve-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId # Below is a request that includes all optional parameters - # Suspend-V2024WorkflowExecution -Id $Id + # Approve-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024WorkflowExecution" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024ApprovalItem" Write-Host $_.ErrorDetails } -- path: /workflows/execute/external/{id} +- path: /work-items/bulk-approve/{id} method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-external-execute-workflow + label: SDK_tools/sdk/powershell/v2024/methods/work-items#approve-approval-items-in-bulk source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $CreateExternalExecuteWorkflowRequest = @" - - "@ + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - # Execute Workflow via External Trigger + # Bulk approve Approval Items try { - New-V2024ExternalExecuteWorkflow -Id $Id + Approve-V2024ApprovalItemsInBulk -Id $Id # Below is a request that includes all optional parameters - # New-V2024ExternalExecuteWorkflow -Id $Id -V2024CreateExternalExecuteWorkflowRequest $Result + # Approve-V2024ApprovalItemsInBulk -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ExternalExecuteWorkflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024ApprovalItemsInBulk" Write-Host $_.ErrorDetails } -- path: /workflows +- path: /work-items/{id} method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow + label: SDK_tools/sdk/powershell/v2024/methods/work-items#complete-work-item 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')]}}} - "@ + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - # Create Workflow + # Complete a Work Item try { - $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-V2024Workflow -V2024CreateWorkflowRequest $Result + Complete-V2024WorkItem -Id $Id # Below is a request that includes all optional parameters - # New-V2024Workflow -V2024CreateWorkflowRequest $Result + # Complete-V2024WorkItem -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024WorkItem" Write-Host $_.ErrorDetails } -- path: /workflows/{id}/external/oauth-clients - method: POST +- path: /work-items/completed + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow-external-trigger + label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-completed-work-items source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $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) - # Generate External Trigger OAuth Client + # Completed Work Items try { - New-V2024WorkflowExternalTrigger -Id $Id + Get-V2024CompletedWorkItems # Below is a request that includes all optional parameters - # New-V2024WorkflowExternalTrigger -Id $Id + # Get-V2024CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024WorkflowExternalTrigger" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompletedWorkItems" Write-Host $_.ErrorDetails } -- path: /workflows/{id} - method: DELETE +- path: /work-items/completed/count + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#delete-workflow + label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-count-completed-work-items source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - # Delete Workflow By Id + # Count Completed Work Items try { - Remove-V2024Workflow -Id $Id + Get-V2024CountCompletedWorkItems # Below is a request that includes all optional parameters - # Remove-V2024Workflow -Id $Id + # Get-V2024CountCompletedWorkItems -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountCompletedWorkItems" Write-Host $_.ErrorDetails } -- path: /workflows/{id} +- path: /work-items/count method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow + label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-count-work-items source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) - # Get Workflow By Id + # Count Work Items try { - Get-V2024Workflow -Id $Id + Get-V2024CountWorkItems # Below is a request that includes all optional parameters - # Get-V2024Workflow -Id $Id + # Get-V2024CountWorkItems -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountWorkItems" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id} +- path: /work-items/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution + label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-work-item source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. - # Get Workflow Execution + # Get a Work Item try { - Get-V2024WorkflowExecution -Id $Id + Get-V2024WorkItem -Id $Id # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecution -Id $Id + # Get-V2024WorkItem -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecution" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItem" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id}/history +- path: /work-items/summary method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution-history + label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-work-items-summary source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - # Get Workflow Execution History + # Work Items Summary try { - Get-V2024WorkflowExecutionHistory -Id $Id + Get-V2024WorkItemsSummary # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecutionHistory -Id $Id + # Get-V2024WorkItemsSummary -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutionHistory" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItemsSummary" Write-Host $_.ErrorDetails } -- path: /workflows/{id}/executions +- path: /work-items method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-executions + label: SDK_tools/sdk/powershell/v2024/methods/work-items#list-work-items 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) + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - # List Workflow Executions + # List Work Items try { - Get-V2024WorkflowExecutions -Id $Id + Get-V2024WorkItems # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + # Get-V2024WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutions" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItems" Write-Host $_.ErrorDetails } -- path: /workflow-library - method: GET +- path: /work-items/{id}/reject/{approvalItemId} + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-complete-workflow-library + label: SDK_tools/sdk/powershell/v2024/methods/work-items#reject-approval-item 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) + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - # List Complete Workflow Library + # Reject an Approval Item try { - Get-V2024CompleteWorkflowLibrary + Deny-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId # Below is a request that includes all optional parameters - # Get-V2024CompleteWorkflowLibrary -Limit $Limit -Offset $Offset + # Deny-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompleteWorkflowLibrary" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItem" Write-Host $_.ErrorDetails } -- path: /workflow-library/actions - method: GET +- path: /work-items/bulk-reject/{id} + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-actions + label: SDK_tools/sdk/powershell/v2024/methods/work-items#reject-approval-items-in-bulk 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) + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - # List Workflow Library Actions + # Bulk reject Approval Items try { - Get-V2024WorkflowLibraryActions + Deny-V2024ApprovalItemsInBulk -Id $Id # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + # Deny-V2024ApprovalItemsInBulk -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryActions" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItemsInBulk" Write-Host $_.ErrorDetails } -- path: /workflow-library/operators - method: GET +- path: /work-items/{id}/forward + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-operators + label: SDK_tools/sdk/powershell/v2024/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 + } + "@ - # List Workflow Library Operators + # Forward a Work Item try { - Get-V2024WorkflowLibraryOperators + $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward + Send-V2024WorkItemForward -Id $Id -V2024WorkItemForward $Result # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryOperators + # Send-V2024WorkItemForward -Id $Id -V2024WorkItemForward $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryOperators" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024WorkItemForward" Write-Host $_.ErrorDetails } -- path: /workflow-library/triggers - method: GET +- path: /work-items/{id}/submit-account-selection + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-triggers + label: SDK_tools/sdk/powershell/v2024/methods/work-items#submit-account-selection 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) + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName - # List Workflow Library Triggers + # Submit Account Selections try { - Get-V2024WorkflowLibraryTriggers + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Submit-V2024AccountSelection -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + # Submit-V2024AccountSelection -Id $Id -RequestBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryTriggers" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024AccountSelection" Write-Host $_.ErrorDetails } -- path: /workflows - method: GET +- path: /reassignment-configurations + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflows + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#create-reassignment-configuration source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ConfigurationItemRequest = @" + { + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + } + "@ - # List Workflows + # Create a Reassignment Configuration try { - Get-V2024Workflows + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result # Below is a request that includes all optional parameters - # Get-V2024Workflows + # New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflows" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ReassignmentConfiguration" Write-Host $_.ErrorDetails } -- path: /workflows/{id} - method: PATCH +- path: /reassignment-configurations/{identityId}/{configType} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#patch-workflow + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#delete-reassignment-configuration source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Patch Workflow + # Delete Reassignment Configuration try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Workflow -Id $Id -V2024JsonPatchOperation $Result + Remove-V2024ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Update-V2024Workflow -Id $Id -V2024JsonPatchOperation $Result + # Remove-V2024ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ReassignmentConfiguration" Write-Host $_.ErrorDetails } -- path: /workflows/{id} - method: PUT +- path: /reassignment-configurations/{identityId}/evaluate/{configType} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#put-workflow + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-evaluate-reassignment-configuration 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", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - } - "@ + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) - # Update Workflow + $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ + + # Evaluate Reassignment Configuration try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Send-V2024Workflow -Id $Id -V2024WorkflowBody $Result + Get-V2024EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Send-V2024Workflow -Id $Id -V2024WorkflowBody $Result + # Get-V2024EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental -ExclusionFilters $ExclusionFilters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EvaluateReassignmentConfiguration" Write-Host $_.ErrorDetails } -- path: /workflows/execute/external/{id}/test - method: POST +- path: /reassignment-configurations/types + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-external-execute-workflow + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-reassignment-config-types source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestExternalExecuteWorkflowRequest = @" - - "@ + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Test Workflow via External Trigger + # List Reassignment Config Types try { - Test-V2024ExternalExecuteWorkflow -Id $Id + Get-V2024ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Test-V2024ExternalExecuteWorkflow -Id $Id -V2024TestExternalExecuteWorkflowRequest $Result + # Get-V2024ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ExternalExecuteWorkflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfigTypes" Write-Host $_.ErrorDetails } -- path: /workflows/{id}/test - method: POST +- path: /reassignment-configurations/{identityId} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-workflow + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-reassignment-configuration 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}]}} - "@ + $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Test Workflow By Id + # Get Reassignment Configuration try { - $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-V2024Workflow -Id $Id -V2024TestWorkflowRequest $Result + Get-V2024ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Test-V2024Workflow -Id $Id -V2024TestWorkflowRequest $Result + # Get-V2024ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfiguration" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/approve/{approvalItemId} - method: POST +- path: /reassignment-configurations/tenant-config + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#approve-approval-item + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-tenant-config-configuration source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Approve an Approval Item + # Get Tenant-wide Reassignment Configuration settings try { - Approve-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + Get-V2024TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Approve-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + # Get-V2024TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024ApprovalItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TenantConfigConfiguration" Write-Host $_.ErrorDetails } -- path: /work-items/bulk-approve/{id} - method: POST +- path: /reassignment-configurations + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#approve-approval-items-in-bulk + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#list-reassignment-configurations source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Bulk approve Approval Items + # List Reassignment Configurations try { - Approve-V2024ApprovalItemsInBulk -Id $Id + Get-V2024ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Approve-V2024ApprovalItemsInBulk -Id $Id + # Get-V2024ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024ApprovalItemsInBulk" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfigurations" Write-Host $_.ErrorDetails } -- path: /work-items/{id} - method: POST +- path: /reassignment-configurations/{identityId} + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#complete-work-item + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#put-reassignment-config source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ConfigurationItemRequest = @" + { + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + } + "@ - # Complete a Work Item + # Update Reassignment Configuration try { - Complete-V2024WorkItem -Id $Id + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result # Below is a request that includes all optional parameters - # Complete-V2024WorkItem -Id $Id + # Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024WorkItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ReassignmentConfig" Write-Host $_.ErrorDetails } -- path: /work-items/completed - method: GET +- path: /reassignment-configurations/tenant-config + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-completed-work-items + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#put-tenant-configuration 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) + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $TenantConfigurationRequest = @" + { + "configDetails" : { + "disabled" : true + } + } + "@ - # Completed Work Items + # Update Tenant-wide Reassignment Configuration settings try { - Get-V2024CompletedWorkItems + $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest + Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -V2024TenantConfigurationRequest $Result # Below is a request that includes all optional parameters - # Get-V2024CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count + # Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -V2024TenantConfigurationRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompletedWorkItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TenantConfiguration" Write-Host $_.ErrorDetails } -- path: /work-items/completed/count - method: GET +- path: /workflow-executions/{id}/cancel + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-count-completed-work-items + label: SDK_tools/sdk/powershell/v2024/methods/workflows#cancel-workflow-execution source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - # Count Completed Work Items + # Cancel Workflow Execution by ID try { - Get-V2024CountCompletedWorkItems + Suspend-V2024WorkflowExecution -Id $Id # Below is a request that includes all optional parameters - # Get-V2024CountCompletedWorkItems -OwnerId $OwnerId + # Suspend-V2024WorkflowExecution -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountCompletedWorkItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024WorkflowExecution" Write-Host $_.ErrorDetails } -- path: /work-items/count - method: GET +- path: /workflows/execute/external/{id} + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-count-work-items + label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-external-execute-workflow source: | - $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $CreateExternalExecuteWorkflowRequest = @" - # Count Work Items + "@ + + # Execute Workflow via External Trigger try { - Get-V2024CountWorkItems + New-V2024ExternalExecuteWorkflow -Id $Id # Below is a request that includes all optional parameters - # Get-V2024CountWorkItems -OwnerId $OwnerId + # New-V2024ExternalExecuteWorkflow -Id $Id -V2024CreateExternalExecuteWorkflowRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountWorkItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ExternalExecuteWorkflow" Write-Host $_.ErrorDetails } -- path: /work-items/{id} - method: GET +- path: /workflows + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-work-item + label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. + $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')]}}} + "@ - # Get a Work Item + # Create Workflow try { - Get-V2024WorkItem -Id $Id + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-V2024Workflow -V2024CreateWorkflowRequest $Result # Below is a request that includes all optional parameters - # Get-V2024WorkItem -Id $Id + # New-V2024Workflow -V2024CreateWorkflowRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workflow" Write-Host $_.ErrorDetails } -- path: /work-items/summary - method: GET +- path: /workflows/{id}/external/oauth-clients + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-work-items-summary + label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow-external-trigger source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - # Work Items Summary + # Generate External Trigger OAuth Client try { - Get-V2024WorkItemsSummary + New-V2024WorkflowExternalTrigger -Id $Id # Below is a request that includes all optional parameters - # Get-V2024WorkItemsSummary -OwnerId $OwnerId + # New-V2024WorkflowExternalTrigger -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItemsSummary" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024WorkflowExternalTrigger" Write-Host $_.ErrorDetails } -- path: /work-items - method: GET +- path: /workflows/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#list-work-items + label: SDK_tools/sdk/powershell/v2024/methods/workflows#delete-workflow 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) + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - # List Work Items + # Delete Workflow By Id try { - Get-V2024WorkItems + Remove-V2024Workflow -Id $Id # Below is a request that includes all optional parameters - # Get-V2024WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId + # Remove-V2024Workflow -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workflow" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/reject/{approvalItemId} - method: POST +- path: /workflows/{id} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#reject-approval-item + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - # Reject an Approval Item + # Get Workflow By Id try { - Deny-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + Get-V2024Workflow -Id $Id # Below is a request that includes all optional parameters - # Deny-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + # Get-V2024Workflow -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflow" Write-Host $_.ErrorDetails } -- path: /work-items/bulk-reject/{id} - method: POST +- path: /workflow-executions/{id} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#reject-approval-items-in-bulk + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - # Bulk reject Approval Items + # Get Workflow Execution try { - Deny-V2024ApprovalItemsInBulk -Id $Id + Get-V2024WorkflowExecution -Id $Id # Below is a request that includes all optional parameters - # Deny-V2024ApprovalItemsInBulk -Id $Id + # Get-V2024WorkflowExecution -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItemsInBulk" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecution" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/forward - method: POST +- path: /workflow-executions/{id}/history + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#send-work-item-forward + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution-history source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $WorkItemForward = @" - { - "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I'm going on vacation.", - "sendNotifications" : true - } - "@ + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - # Forward a Work Item + # Get Workflow Execution History try { - $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward - Send-V2024WorkItemForward -Id $Id -V2024WorkItemForward $Result + Get-V2024WorkflowExecutionHistory -Id $Id # Below is a request that includes all optional parameters - # Send-V2024WorkItemForward -Id $Id -V2024WorkItemForward $Result + # Get-V2024WorkflowExecutionHistory -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024WorkItemForward" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutionHistory" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/submit-account-selection - method: POST +- path: /workflows/{id}/executions + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#submit-account-selection + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-executions source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName + $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) - # Submit Account Selections + # List Workflow Executions try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Submit-V2024AccountSelection -Id $Id -RequestBody $Result + Get-V2024WorkflowExecutions -Id $Id # Below is a request that includes all optional parameters - # Submit-V2024AccountSelection -Id $Id -RequestBody $Result + # Get-V2024WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024AccountSelection" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutions" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations - method: POST +- path: /workflow-library + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#create-reassignment-configuration + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-complete-workflow-library source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ConfigurationItemRequest = @" - { - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" - } - "@ + $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) - # Create a Reassignment Configuration + # List Complete Workflow Library try { - $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result + Get-V2024CompleteWorkflowLibrary # Below is a request that includes all optional parameters - # New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result + # Get-V2024CompleteWorkflowLibrary -Limit $Limit -Offset $Offset } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ReassignmentConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompleteWorkflowLibrary" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations/{identityId}/{configType} - method: DELETE +- path: /workflow-library/actions + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#delete-reassignment-configuration + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-actions source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $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) - # Delete Reassignment Configuration + # List Workflow Library Actions try { - Remove-V2024ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental + Get-V2024WorkflowLibraryActions # Below is a request that includes all optional parameters - # Remove-V2024ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental + # Get-V2024WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ReassignmentConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryActions" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations/{identityId}/evaluate/{configType} +- path: /workflow-library/operators method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-evaluate-reassignment-configuration + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-operators source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) - - $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ - # Evaluate Reassignment Configuration + # List Workflow Library Operators try { - Get-V2024EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental + Get-V2024WorkflowLibraryOperators # Below is a request that includes all optional parameters - # Get-V2024EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental -ExclusionFilters $ExclusionFilters + # Get-V2024WorkflowLibraryOperators } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EvaluateReassignmentConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryOperators" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations/types +- path: /workflow-library/triggers method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-reassignment-config-types + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-triggers source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $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 Reassignment Config Types + # List Workflow Library Triggers try { - Get-V2024ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental + Get-V2024WorkflowLibraryTriggers # Below is a request that includes all optional parameters - # Get-V2024ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental + # Get-V2024WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfigTypes" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryTriggers" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations/{identityId} +- path: /workflows method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-reassignment-configuration + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflows source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Reassignment Configuration + # List Workflows try { - Get-V2024ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + Get-V2024Workflows # Below is a request that includes all optional parameters - # Get-V2024ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + # Get-V2024Workflows } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflows" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations/tenant-config - method: GET +- path: /workflows/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-tenant-config-configuration + label: SDK_tools/sdk/powershell/v2024/methods/workflows#patch-workflow source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ - # Get Tenant-wide Reassignment Configuration settings + + # Patch Workflow try { - Get-V2024TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Workflow -Id $Id -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Get-V2024TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental + # Update-V2024Workflow -Id $Id -V2024JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TenantConfigConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workflow" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations - method: GET +- path: /workflows/{id} + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#list-reassignment-configurations + label: SDK_tools/sdk/powershell/v2024/methods/workflows#put-workflow source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $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", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ - # List Reassignment Configurations + # Update Workflow try { - Get-V2024ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-V2024Workflow -Id $Id -V2024WorkflowBody $Result # Below is a request that includes all optional parameters - # Get-V2024ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental + # Send-V2024Workflow -Id $Id -V2024WorkflowBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfigurations" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Workflow" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations/{identityId} - method: PUT +- path: /workflows/execute/external/{id}/test + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#put-reassignment-config + label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-external-execute-workflow source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ConfigurationItemRequest = @" - { - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" - } + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + "@ - # Update Reassignment Configuration + # Test Workflow via External Trigger try { - $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result + Test-V2024ExternalExecuteWorkflow -Id $Id # Below is a request that includes all optional parameters - # Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result + # Test-V2024ExternalExecuteWorkflow -Id $Id -V2024TestExternalExecuteWorkflowRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ReassignmentConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ExternalExecuteWorkflow" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations/tenant-config - method: PUT +- path: /workflows/{id}/test + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#put-tenant-configuration + label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-workflow source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $TenantConfigurationRequest = @" - { - "configDetails" : { - "disabled" : true - } - } + $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}]}} "@ - # Update Tenant-wide Reassignment Configuration settings + # Test Workflow By Id try { - $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest - Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -V2024TenantConfigurationRequest $Result + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-V2024Workflow -Id $Id -V2024TestWorkflowRequest $Result # Below is a request that includes all optional parameters - # Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -V2024TenantConfigurationRequest $Result + # Test-V2024Workflow -Id $Id -V2024TestWorkflowRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TenantConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024Workflow" Write-Host $_.ErrorDetails } diff --git a/static/code-examples/v3/code_examples_overlay.yaml b/static/code-examples/v3/code_examples_overlay.yaml index 55ebb86abeb2..12eb2b3029b9 100644 --- a/static/code-examples/v3/code_examples_overlay.yaml +++ b/static/code-examples/v3/code_examples_overlay.yaml @@ -636,6 +636,29 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountActivities" Write-Host $_.ErrorDetails } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/account-usages#get-usages-by-account-id + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + Get-UsagesByAccountId -AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesByAccountId" + Write-Host $_.ErrorDetails + } - path: /accounts method: POST xCodeSample: @@ -789,8 +812,8 @@ $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) $DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) - $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) + $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) # Accounts List @@ -903,29 +926,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Account" Write-Host $_.ErrorDetails } -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/account-usages#get-usages-by-account-id - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns account usage insights - - try { - Get-UsagesByAccountId -AccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesByAccountId" - Write-Host $_.ErrorDetails - } - path: /discovered-applications method: GET xCodeSample: @@ -2013,6 +2013,95 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Campaign" Write-Host $_.ErrorDetails } +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-access-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Type = "ROLE" # String | The type of access review item to retrieve summaries for + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + + # Access Summaries + + try { + Get-IdentityAccessSummaries -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityAccessSummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-decision-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + + # Summary of Certification Decisions + + try { + Get-IdentityDecisionSummary -Id $Id + + # Below is a request that includes all optional parameters + # Get-IdentityDecisionSummary -Id $Id -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityDecisionSummary" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Identity Summaries for Campaign Certification + + try { + Get-IdentitySummaries -Id $Id + + # Below is a request that includes all optional parameters + # Get-IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID + + # Summary for Identity + + try { + Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + + # Below is a request that includes all optional parameters + # Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummary" + Write-Host $_.ErrorDetails + } - path: /certification-tasks/{id} method: GET xCodeSample: @@ -2291,95 +2380,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-ReassignCertsAsync" Write-Host $_.ErrorDetails } -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-access-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Type = "ROLE" # String | The type of access review item to retrieve summaries for - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - - # Access Summaries - - try { - Get-IdentityAccessSummaries -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityAccessSummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-decision-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - - # Summary of Certification Decisions - - try { - Get-IdentityDecisionSummary -Id $Id - - # Below is a request that includes all optional parameters - # Get-IdentityDecisionSummary -Id $Id -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityDecisionSummary" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Identity Summaries for Campaign Certification - - try { - Get-IdentitySummaries -Id $Id - - # Below is a request that includes all optional parameters - # Get-IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID - - # Summary for Identity - - try { - Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - - # Below is a request that includes all optional parameters - # Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummary" - Write-Host $_.ErrorDetails - } - path: /configuration-hub/object-mappings/{sourceOrg} method: POST xCodeSample: @@ -3088,7 +3088,7 @@ } "@ - # Create an Identity Profile + # Create Identity Profile try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile @@ -3106,9 +3106,9 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#delete-identity-profile source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID. + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. - # Delete an Identity Profile + # Delete Identity Profile try { Remove-IdentityProfile -IdentityProfileId $IdentityProfileId @@ -3189,9 +3189,9 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#get-identity-profile source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - # Get single Identity Profile + # Get Identity Profile try { Get-IdentityProfile -IdentityProfileId $IdentityProfileId @@ -3293,10 +3293,10 @@ $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, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) - # Identity Profiles List + # List Identity Profiles try { Get-IdentityProfiles @@ -3380,7 +3380,7 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#update-identity-profile source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", @@ -3388,7 +3388,7 @@ }"@ - # Update the Identity Profile + # Update Identity Profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -3560,622 +3560,622 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-LifecycleStates" Write-Host $_.ErrorDetails } -- path: /managed-clients - method: POST +- path: /mfa/{method}/delete + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#create-managed-client + label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#delete-mfa-config source: | - $ManagedClientRequest = @" - { - "name" : "aName", - "description" : "A short description of the ManagedClient", - "clusterId" : "aClusterId", - "type" : "VA" - } - "@ + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - # Create Managed Client + # Delete MFA method configuration try { - $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest - New-ManagedClient -ManagedClientRequest $Result + Remove-MFAConfig -Method $Method # Below is a request that includes all optional parameters - # New-ManagedClient -ManagedClientRequest $Result + # Remove-MFAConfig -Method $Method } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedClient" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-MFAConfig" Write-Host $_.ErrorDetails } -- path: /managed-clients/{id} - method: DELETE +- path: /mfa/duo-web/config + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#delete-managed-client + label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#get-mfa-duo-config source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - # Delete Managed Client + # Configuration of Duo MFA method try { - Remove-ManagedClient -Id $Id + Get-MFADuoConfig # Below is a request that includes all optional parameters - # Remove-ManagedClient -Id $Id + # Get-MFADuoConfig } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedClient" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFADuoConfig" Write-Host $_.ErrorDetails } -- path: /managed-clients/{id} +- path: /mfa/kba/config method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client + label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#get-mfa-kba-config source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + $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) - # Get Managed Client + # Configuration of KBA MFA method try { - Get-ManagedClient -Id $Id + Get-MFAKbaConfig # Below is a request that includes all optional parameters - # Get-ManagedClient -Id $Id + # Get-MFAKbaConfig -AllLanguages $AllLanguages } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClient" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFAKbaConfig" Write-Host $_.ErrorDetails } -- path: /managed-clients/{id}/status +- path: /mfa/okta-verify/config method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client-status + label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#get-mfa-okta-config 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 + # Configuration of Okta MFA method try { - Get-ManagedClientStatus -Id $Id -Type $Type + Get-MFAOktaConfig # Below is a request that includes all optional parameters - # Get-ManagedClientStatus -Id $Id -Type $Type + # Get-MFAOktaConfig } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClientStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFAOktaConfig" Write-Host $_.ErrorDetails } -- path: /managed-clients - method: GET +- path: /mfa/duo-web/config + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-clients + label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#set-mfa-duo-config 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) + $MfaDuoConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + } + "@ - # Get Managed Clients + # Set Duo MFA configuration try { - Get-ManagedClients + $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig + Set-MFADuoConfig -MfaDuoConfig $Result # Below is a request that includes all optional parameters - # Get-ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + # Set-MFADuoConfig -MfaDuoConfig $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClients" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFADuoConfig" Write-Host $_.ErrorDetails } -- path: /managed-clients/{id} - method: PATCH +- path: /mfa/kba/config/answers + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#update-managed-client + label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#set-mfakba-config source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" }"@ - # Update Managed Client + # Set MFA KBA configuration try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-ManagedClient -Id $Id -JsonPatchOperation $Result + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Set-MFAKBAConfig -KbaAnswerRequestItem $Result # Below is a request that includes all optional parameters - # Update-ManagedClient -Id $Id -JsonPatchOperation $Result + # Set-MFAKBAConfig -KbaAnswerRequestItem $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedClient" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFAKBAConfig" Write-Host $_.ErrorDetails } -- path: /managed-clusters - method: POST +- path: /mfa/okta-verify/config + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#create-managed-cluster + label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#set-mfa-okta-config source: | - $ManagedClusterRequest = @" + $MfaOktaConfig = @" { - "configuration" : { - "clusterExternalId" : "externalId", - "ccgVersion" : "77.0.0" - }, - "name" : "Managed Cluster Name", - "description" : "A short description of the managed cluster.", - "type" : "idn" + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" } "@ - # Create Create Managed Cluster + # Set Okta MFA configuration try { - $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest - New-ManagedCluster -ManagedClusterRequest $Result + $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig + Set-MFAOktaConfig -MfaOktaConfig $Result # Below is a request that includes all optional parameters - # New-ManagedCluster -ManagedClusterRequest $Result + # Set-MFAOktaConfig -MfaOktaConfig $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedCluster" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFAOktaConfig" Write-Host $_.ErrorDetails } -- path: /managed-clusters/{id} - method: DELETE +- path: /mfa/{method}/test + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#delete-managed-cluster + label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#test-mfa-config 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) + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - # Delete Managed Cluster + # MFA method's test configuration try { - Remove-ManagedCluster -Id $Id + Test-MFAConfig -Method $Method # Below is a request that includes all optional parameters - # Remove-ManagedCluster -Id $Id -RemoveClients $RemoveClients + # Test-MFAConfig -Method $Method } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedCluster" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-MFAConfig" Write-Host $_.ErrorDetails } -- path: /managed-clusters/{id}/log-config - method: GET +- path: /mfa/token/send + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-client-log-configuration + label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#create-send-token source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. + $SendTokenRequest = @" + { + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK" + } + "@ - # Get Managed Cluster Log Configuration + # Create and send user token try { - Get-ClientLogConfiguration -Id $Id + $Result = ConvertFrom-JsonToSendTokenRequest -Json $SendTokenRequest + New-SendToken -SendTokenRequest $Result # Below is a request that includes all optional parameters - # Get-ClientLogConfiguration -Id $Id + # New-SendToken -SendTokenRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ClientLogConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SendToken" Write-Host $_.ErrorDetails } -- path: /managed-clusters/{id} - method: GET +- path: /mfa/{method}/poll + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-cluster + label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#ping-verification-status source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' + $VerificationPollRequest = @" + { + "requestId" : "089899f13a8f4da7824996191587bab9" + } + "@ - # Get Managed Cluster + # Polling MFA method by VerificationPollRequest try { - Get-ManagedCluster -Id $Id + $Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest + Ping-VerificationStatus -Method $Method -VerificationPollRequest $Result # Below is a request that includes all optional parameters - # Get-ManagedCluster -Id $Id + # Ping-VerificationStatus -Method $Method -VerificationPollRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedCluster" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-VerificationStatus" Write-Host $_.ErrorDetails } -- path: /managed-clusters - method: GET +- path: /mfa/duo-web/verify + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-clusters + label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#send-duo-verify-request 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) + $DuoVerificationRequest = @" + { + "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", + "userId" : "2c9180947f0ef465017f215cbcfd004b" + } + "@ - # Get Managed Clusters + # Verifying authentication via Duo method try { - Get-ManagedClusters + $Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest + Send-DuoVerifyRequest -DuoVerificationRequest $Result # Below is a request that includes all optional parameters - # Get-ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + # Send-DuoVerifyRequest -DuoVerificationRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClusters" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-DuoVerifyRequest" Write-Host $_.ErrorDetails } -- path: /managed-clusters/{id}/log-config - method: PUT +- path: /mfa/kba/authenticate + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#put-client-log-configuration + label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#send-kba-answers source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. - $PutClientLogConfigurationRequest = @" + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + }"@ - "@ - # Update Managed Cluster Log Configuration + # Authenticate KBA provided MFA method try { - $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest - Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Send-KbaAnswers -KbaAnswerRequestItem $Result # Below is a request that includes all optional parameters - # Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result + # Send-KbaAnswers -KbaAnswerRequestItem $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ClientLogConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-KbaAnswers" Write-Host $_.ErrorDetails } -- path: /managed-clusters/{id} - method: PATCH +- path: /mfa/okta-verify/verify + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#update-managed-cluster + label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#send-okta-verify-request source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - + $OktaVerificationRequest = @" + { + "userId" : "example@mail.com" + } + "@ - # Update Managed Cluster + # Verifying authentication via Okta method try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-ManagedCluster -Id $Id -JsonPatchOperation $Result + $Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest + Send-OktaVerifyRequest -OktaVerificationRequest $Result # Below is a request that includes all optional parameters - # Update-ManagedCluster -Id $Id -JsonPatchOperation $Result + # Send-OktaVerifyRequest -OktaVerificationRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedCluster" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-OktaVerifyRequest" Write-Host $_.ErrorDetails } -- path: /mfa/{method}/delete - method: DELETE +- path: /mfa/token/authenticate + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#delete-mfa-config + label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#send-token-auth-request source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + $TokenAuthRequest = @" + { + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK", + "token" : "12345" + } + "@ - # Delete MFA method configuration + # Authenticate Token provided MFA method try { - Remove-MFAConfig -Method $Method + $Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest + Send-TokenAuthRequest -TokenAuthRequest $Result # Below is a request that includes all optional parameters - # Remove-MFAConfig -Method $Method + # Send-TokenAuthRequest -TokenAuthRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-MFAConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TokenAuthRequest" Write-Host $_.ErrorDetails } -- path: /mfa/duo-web/config - method: GET +- path: /managed-clients + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#get-mfa-duo-config + 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" + } + "@ - # Configuration of Duo MFA method + # Create Managed Client try { - Get-MFADuoConfig + $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest + New-ManagedClient -ManagedClientRequest $Result # Below is a request that includes all optional parameters - # Get-MFADuoConfig + # New-ManagedClient -ManagedClientRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFADuoConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedClient" Write-Host $_.ErrorDetails } -- path: /mfa/kba/config - method: GET +- path: /managed-clients/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#get-mfa-kba-config + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#delete-managed-client 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) + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - # Configuration of KBA MFA method + # Delete Managed Client try { - Get-MFAKbaConfig + Remove-ManagedClient -Id $Id # Below is a request that includes all optional parameters - # Get-MFAKbaConfig -AllLanguages $AllLanguages + # Remove-ManagedClient -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFAKbaConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedClient" Write-Host $_.ErrorDetails } -- path: /mfa/okta-verify/config +- path: /managed-clients/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#get-mfa-okta-config + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - # Configuration of Okta MFA method + # Get Managed Client try { - Get-MFAOktaConfig + Get-ManagedClient -Id $Id # Below is a request that includes all optional parameters - # Get-MFAOktaConfig + # Get-ManagedClient -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFAOktaConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClient" Write-Host $_.ErrorDetails } -- path: /mfa/duo-web/config - method: PUT +- path: /managed-clients/{id}/status + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#set-mfa-duo-config + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client-status source: | - $MfaDuoConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" + $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) - # Set Duo MFA configuration + # Get Managed Clients try { - $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig - Set-MFADuoConfig -MfaDuoConfig $Result + Get-ManagedClients # Below is a request that includes all optional parameters - # Set-MFADuoConfig -MfaDuoConfig $Result + # Get-ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFADuoConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClients" Write-Host $_.ErrorDetails } -- path: /mfa/kba/config/answers - method: POST +- path: /managed-clients/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#set-mfakba-config + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#update-managed-client source: | - $KbaAnswerRequestItem = @"{ - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" }"@ - # Set MFA KBA configuration + # Update Managed Client try { - $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Set-MFAKBAConfig -KbaAnswerRequestItem $Result + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-ManagedClient -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Set-MFAKBAConfig -KbaAnswerRequestItem $Result + # Update-ManagedClient -Id $Id -JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFAKBAConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedClient" Write-Host $_.ErrorDetails } -- path: /mfa/okta-verify/config - method: PUT +- path: /managed-clusters + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#set-mfa-okta-config + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#create-managed-cluster source: | - $MfaOktaConfig = @" + $ManagedClusterRequest = @" { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" } "@ - # Set Okta MFA configuration + # Create Create Managed Cluster try { - $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig - Set-MFAOktaConfig -MfaOktaConfig $Result + $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest + New-ManagedCluster -ManagedClusterRequest $Result # Below is a request that includes all optional parameters - # Set-MFAOktaConfig -MfaOktaConfig $Result + # New-ManagedCluster -ManagedClusterRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFAOktaConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedCluster" Write-Host $_.ErrorDetails } -- path: /mfa/{method}/test - method: GET +- path: /managed-clusters/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#test-mfa-config + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#delete-managed-cluster source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) - # MFA method's test configuration + # Delete Managed Cluster try { - Test-MFAConfig -Method $Method + Remove-ManagedCluster -Id $Id # Below is a request that includes all optional parameters - # Test-MFAConfig -Method $Method + # Remove-ManagedCluster -Id $Id -RemoveClients $RemoveClients } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-MFAConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedCluster" Write-Host $_.ErrorDetails } -- path: /mfa/token/send - method: POST +- path: /managed-clusters/{id}/log-config + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#create-send-token + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-client-log-configuration source: | - $SendTokenRequest = @" - { - "userAlias" : "will.albin", - "deliveryType" : "EMAIL_WORK" - } - "@ + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. - # Create and send user token + # Get Managed Cluster Log Configuration try { - $Result = ConvertFrom-JsonToSendTokenRequest -Json $SendTokenRequest - New-SendToken -SendTokenRequest $Result + Get-ClientLogConfiguration -Id $Id # Below is a request that includes all optional parameters - # New-SendToken -SendTokenRequest $Result + # Get-ClientLogConfiguration -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SendToken" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ClientLogConfiguration" Write-Host $_.ErrorDetails } -- path: /mfa/{method}/poll - method: POST +- path: /managed-clusters/{id} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#ping-verification-status + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-cluster source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' - $VerificationPollRequest = @" - { - "requestId" : "089899f13a8f4da7824996191587bab9" - } - "@ + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - # Polling MFA method by VerificationPollRequest + # Get Managed Cluster try { - $Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest - Ping-VerificationStatus -Method $Method -VerificationPollRequest $Result + Get-ManagedCluster -Id $Id # Below is a request that includes all optional parameters - # Ping-VerificationStatus -Method $Method -VerificationPollRequest $Result + # Get-ManagedCluster -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-VerificationStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedCluster" Write-Host $_.ErrorDetails } -- path: /mfa/duo-web/verify - method: POST +- path: /managed-clusters + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#send-duo-verify-request + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-clusters source: | - $DuoVerificationRequest = @" - { - "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", - "userId" : "2c9180947f0ef465017f215cbcfd004b" - } - "@ + $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) - # Verifying authentication via Duo method + # Get Managed Clusters try { - $Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest - Send-DuoVerifyRequest -DuoVerificationRequest $Result + Get-ManagedClusters # Below is a request that includes all optional parameters - # Send-DuoVerifyRequest -DuoVerificationRequest $Result + # Get-ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-DuoVerifyRequest" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClusters" Write-Host $_.ErrorDetails } -- path: /mfa/kba/authenticate - method: POST +- path: /managed-clusters/{id}/log-config + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#send-kba-answers + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#put-client-log-configuration source: | - $KbaAnswerRequestItem = @"{ - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" - }"@ - - - # Authenticate KBA provided MFA method + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. + $PutClientLogConfigurationRequest = @" - try { - $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Send-KbaAnswers -KbaAnswerRequestItem $Result - - # Below is a request that includes all optional parameters - # Send-KbaAnswers -KbaAnswerRequestItem $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-KbaAnswers" - Write-Host $_.ErrorDetails - } -- path: /mfa/okta-verify/verify - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#send-okta-verify-request - source: | - $OktaVerificationRequest = @" - { - "userId" : "example@mail.com" - } "@ - # Verifying authentication via Okta method + # Update Managed Cluster Log Configuration try { - $Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest - Send-OktaVerifyRequest -OktaVerificationRequest $Result + $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest + Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result # Below is a request that includes all optional parameters - # Send-OktaVerifyRequest -OktaVerificationRequest $Result + # Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-OktaVerifyRequest" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ClientLogConfiguration" Write-Host $_.ErrorDetails } -- path: /mfa/token/authenticate - method: POST +- path: /managed-clusters/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#send-token-auth-request + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#update-managed-cluster source: | - $TokenAuthRequest = @" - { - "userAlias" : "will.albin", - "deliveryType" : "EMAIL_WORK", - "token" : "12345" - } - "@ + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ - # Authenticate Token provided MFA method + + # Update Managed Cluster try { - $Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest - Send-TokenAuthRequest -TokenAuthRequest $Result + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-ManagedCluster -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Send-TokenAuthRequest -TokenAuthRequest $Result + # Update-ManagedCluster -Id $Id -JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TokenAuthRequest" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedCluster" Write-Host $_.ErrorDetails } - path: /non-employee-approvals/{id}/approve @@ -4776,20 +4776,20 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#list-non-employee-sources source: | - $RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. $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) - $NonEmployeeCount = $true # Boolean | The flag to determine whether return a non-employee count associate with source. (optional) + $RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) + $NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) # List Non-Employee Sources try { - Get-NonEmployeeSources -RequestedFor $RequestedFor + Get-NonEmployeeSources # Below is a request that includes all optional parameters - # Get-NonEmployeeSources -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters + # Get-NonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSources" Write-Host $_.ErrorDetails @@ -6128,314 +6128,313 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Role" Write-Host $_.ErrorDetails } -- path: /saved-searches +- path: /sod-policies method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/saved-search#create-saved-search + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#create-sod-policy source: | - $CreateSavedSearchRequest = @" - + $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 a saved search + # Create SOD policy try { - $Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest - New-SavedSearch -CreateSavedSearchRequest $Result + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-SodPolicy -SodPolicy $Result # Below is a request that includes all optional parameters - # New-SavedSearch -CreateSavedSearchRequest $Result + # New-SodPolicy -SodPolicy $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SavedSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SodPolicy" Write-Host $_.ErrorDetails } -- path: /saved-searches/{id} +- path: /sod-policies/{id} method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/saved-search#delete-saved-search + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $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 document by ID + # Delete SOD policy by ID try { - Remove-SavedSearch -Id $Id + Remove-SodPolicy -Id $Id # Below is a request that includes all optional parameters - # Remove-SavedSearch -Id $Id + # Remove-SodPolicy -Id $Id -Logical $Logical } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SavedSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicy" Write-Host $_.ErrorDetails } -- path: /saved-searches/{id}/execute - method: POST +- path: /sod-policies/{id}/schedule + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/saved-search#execute-saved-search + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy-schedule source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $SearchArguments = @" - { - "owner" : "", - "recipients" : [ { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" - } - "@ + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - # Execute a saved search by ID + # Delete SOD policy schedule try { - $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments - Invoke-ExecuteSavedSearch -Id $Id -SearchArguments $Result + Remove-SodPolicySchedule -Id $Id # Below is a request that includes all optional parameters - # Invoke-ExecuteSavedSearch -Id $Id -SearchArguments $Result + # Remove-SodPolicySchedule -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ExecuteSavedSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicySchedule" Write-Host $_.ErrorDetails } -- path: /saved-searches/{id} +- path: /sod-violation-report/{reportResultId}/download/{fileName} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/saved-search#get-saved-search + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-custom-violation-report source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. - # Return saved search by ID + # Download custom violation report try { - Get-SavedSearch -Id $Id + Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName # Below is a request that includes all optional parameters - # Get-SavedSearch -Id $Id + # Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SavedSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CustomViolationReport" Write-Host $_.ErrorDetails } -- path: /saved-searches +- path: /sod-violation-report/{reportResultId}/download method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/saved-search#list-saved-searches + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-default-violation-report 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 = "owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - # A list of Saved Searches + # Download violation report try { - Get-SavedSearches + Get-DefaultViolationReport -ReportResultId $ReportResultId # Below is a request that includes all optional parameters - # Get-SavedSearches -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + # Get-DefaultViolationReport -ReportResultId $ReportResultId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SavedSearches" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultViolationReport" Write-Host $_.ErrorDetails } -- path: /saved-searches/{id} - method: PUT +- path: /sod-violation-report + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/saved-search#put-saved-search + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-all-report-run-status source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $SavedSearch = @" - { - "owner" : { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "created" : "2018-06-25T20:22:28.104Z", - "columns" : { - "identity" : [ { - "field" : "displayName", - "header" : "Display Name" - }, { - "field" : "e-mail", - "header" : "Work Email" - } ] - }, - "query" : "@accounts(disabled:true)", - "description" : "Disabled accounts", - "orderBy" : { - "identity" : [ "lastName", "firstName" ], - "role" : [ "name" ] - }, - "sort" : [ "displayName" ], - "filters" : { - "terms" : [ "account_count", "account_count" ], - "range" : { - "lower" : { - "inclusive" : false, - "value" : "1" - }, - "upper" : { - "inclusive" : false, - "value" : "1" - } - }, - "exclude" : false, - "type" : "RANGE" - }, - "ownerId" : "2c91808568c529c60168cca6f90c1313", - "indices" : [ "identities" ], - "public" : false, - "name" : "Disabled accounts", - "modified" : "2018-06-25T20:22:28.104Z", - "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", - "fields" : [ "disabled" ] + + # 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. - # Updates an existing saved search + # Get SOD policy by ID try { - $Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch - Send-SavedSearch -Id $Id -SavedSearch $Result + Get-SodPolicy -Id $Id # Below is a request that includes all optional parameters - # Send-SavedSearch -Id $Id -SavedSearch $Result + # Get-SodPolicy -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SavedSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicy" Write-Host $_.ErrorDetails } -- path: /scheduled-searches - method: POST +- path: /sod-policies/{id}/schedule + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#create-scheduled-search + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy-schedule source: | - $CreateScheduledSearchRequest = @" - {savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]} - "@ + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. - # Create a new scheduled search + # Get SOD policy schedule try { - $Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest - New-ScheduledSearch -CreateScheduledSearchRequest $Result + Get-SodPolicySchedule -Id $Id # Below is a request that includes all optional parameters - # New-ScheduledSearch -CreateScheduledSearchRequest $Result + # Get-SodPolicySchedule -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ScheduledSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicySchedule" Write-Host $_.ErrorDetails } -- path: /scheduled-searches/{id} - method: DELETE +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#delete-scheduled-search + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-run-status source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. - # Delete a Scheduled Search + # Get violation report run status try { - Remove-ScheduledSearch -Id $Id + Get-SodViolationReportRunStatus -ReportResultId $ReportResultId # Below is a request that includes all optional parameters - # Remove-ScheduledSearch -Id $Id + # Get-SodViolationReportRunStatus -ReportResultId $ReportResultId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ScheduledSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportRunStatus" Write-Host $_.ErrorDetails } -- path: /scheduled-searches/{id} +- path: /sod-policies/{id}/violation-report method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#get-scheduled-search + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-status source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. - # Get a Scheduled Search + # Get SOD violation report status try { - Get-ScheduledSearch -Id $Id + Get-SodViolationReportStatus -Id $Id # Below is a request that includes all optional parameters - # Get-ScheduledSearch -Id $Id + # Get-SodViolationReportStatus -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ScheduledSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportStatus" Write-Host $_.ErrorDetails } -- path: /scheduled-searches +- path: /sod-policies method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#list-scheduled-search + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#list-sod-policies 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) + $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 = "savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* (optional) + $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 scheduled searches + # List SOD policies try { - Get-ScheduledSearch + Get-SodPolicies # Below is a request that includes all optional parameters - # Get-ScheduledSearch -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + # Get-SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ScheduledSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicies" Write-Host $_.ErrorDetails } -- path: /scheduled-searches/{id}/unsubscribe - method: POST +- path: /sod-policies/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#unsubscribe-scheduled-search + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#patch-sod-policy source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $TypedReference = @" - { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } - "@ + $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ - # Unsubscribe a recipient from Scheduled Search + + # Patch SOD policy by ID try { - $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference - Invoke-UnsubscribeScheduledSearch -Id $Id -TypedReference $Result + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-SodPolicy -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Invoke-UnsubscribeScheduledSearch -Id $Id -TypedReference $Result + # Update-SodPolicy -Id $Id -JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-UnsubscribeScheduledSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SodPolicy" Write-Host $_.ErrorDetails } -- path: /scheduled-searches/{id} +- path: /sod-policies/{id}/schedule method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#update-scheduled-search + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-policy-schedule source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $ScheduledSearch = @" + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. + $SodPolicySchedule = @" { - "owner" : { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, - "displayQueryDetails" : false, - "created" : "", - "description" : "Daily disabled accounts", - "ownerId" : "2c9180867624cbd7017642d8c8c81f67", - "enabled" : false, "schedule" : { "hours" : { "values" : [ "MON", "WED" ], @@ -6456,337 +6455,591 @@ "expiration" : "2018-06-25T20:22:28.104Z", "type" : "WEEKLY" }, + "created" : "2020-01-01T00:00:00Z", "recipients" : [ { - "id" : "2c9180867624cbd7017642d8c8c81f67", + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", "type" : "IDENTITY" }, { - "id" : "2c9180867624cbd7017642d8c8c81f67", + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", "type" : "IDENTITY" } ], - "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", - "name" : "Daily disabled accounts", - "modified" : "", - "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", "emailEmptyResults" : false } "@ - # Update an existing Scheduled Search + # Update SOD Policy schedule try { - $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch - Update-ScheduledSearch -Id $Id -ScheduledSearch $Result + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-PolicySchedule -Id $Id -SodPolicySchedule $Result # Below is a request that includes all optional parameters - # Update-ScheduledSearch -Id $Id -ScheduledSearch $Result + # Send-PolicySchedule -Id $Id -SodPolicySchedule $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ScheduledSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PolicySchedule" Write-Host $_.ErrorDetails } -- path: /search/aggregate - method: POST +- path: /sod-policies/{id} + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search#search-aggregate + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-sod-policy source: | - $Search = @" + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" { - "queryDsl" : { - "match" : { - "name" : "john.doe" + "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" + } ] } }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] + "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" + } }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 + "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: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/saved-search#create-saved-search + source: | + $CreateSavedSearchRequest = @" + + "@ + + # Create a saved search + + try { + $Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest + New-SavedSearch -CreateSavedSearchRequest $Result + + # Below is a request that includes all optional parameters + # New-SavedSearch -CreateSavedSearchRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/saved-search#delete-saved-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Delete document by ID + + try { + Remove-SavedSearch -Id $Id + + # Below is a request that includes all optional parameters + # Remove-SavedSearch -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id}/execute + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/saved-search#execute-saved-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $SearchArguments = @" + { + "owner" : "", + "recipients" : [ { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" + } + "@ + + # Execute a saved search by ID + + try { + $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments + Invoke-ExecuteSavedSearch -Id $Id -SearchArguments $Result + + # Below is a request that includes all optional parameters + # Invoke-ExecuteSavedSearch -Id $Id -SearchArguments $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ExecuteSavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/saved-search#get-saved-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Return saved search by ID + + try { + Get-SavedSearch -Id $Id + + # Below is a request that includes all optional parameters + # Get-SavedSearch -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/saved-search#list-saved-searches + 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 = "owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) + + # A list of Saved Searches + + try { + Get-SavedSearches + + # Below is a request that includes all optional parameters + # Get-SavedSearches -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SavedSearches" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/saved-search#put-saved-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $SavedSearch = @" + { + "owner" : { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] + "created" : "2018-06-25T20:22:28.104Z", + "columns" : { + "identity" : [ { + "field" : "displayName", + "header" : "Display Name" + }, { + "field" : "e-mail", + "header" : "Work Email" + } ] }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } + "query" : "@accounts(disabled:true)", + "description" : "Disabled accounts", + "orderBy" : { + "identity" : [ "lastName", "firstName" ], + "role" : [ "name" ] + }, + "sort" : [ "displayName" ], + "filters" : { + "terms" : [ "account_count", "account_count" ], + "range" : { + "lower" : { + "inclusive" : false, + "value" : "1" }, - "nested" : { - "name" : "id", - "type" : "access" + "upper" : { + "inclusive" : false, + "value" : "1" } }, - "nested" : { - "name" : "id", - "type" : "access" - } - } + "exclude" : false, + "type" : "RANGE" + }, + "ownerId" : "2c91808568c529c60168cca6f90c1313", + "indices" : [ "identities" ], + "public" : false, + "name" : "Disabled accounts", + "modified" : "2018-06-25T20:22:28.104Z", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "fields" : [ "disabled" ] + } + "@ + + # Updates an existing saved search + + try { + $Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch + Send-SavedSearch -Id $Id -SavedSearch $Result + + # Below is a request that includes all optional parameters + # Send-SavedSearch -Id $Id -SavedSearch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SavedSearch" + Write-Host $_.ErrorDetails } +- path: /scheduled-searches + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#create-scheduled-search + source: | + $CreateScheduledSearchRequest = @" + {savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]} "@ + + # Create a new scheduled search + + try { + $Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest + New-ScheduledSearch -CreateScheduledSearchRequest $Result + + # Below is a request that includes all optional parameters + # New-ScheduledSearch -CreateScheduledSearchRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#delete-scheduled-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Delete a Scheduled Search + + try { + Remove-ScheduledSearch -Id $Id + + # Below is a request that includes all optional parameters + # Remove-ScheduledSearch -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#get-scheduled-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Get a Scheduled Search + + try { + Get-ScheduledSearch -Id $Id + + # Below is a request that includes all optional parameters + # Get-ScheduledSearch -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#list-scheduled-search + 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 = "savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* (optional) - # Perform a Search Query Aggregation + # List scheduled searches try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-Aggregate -Search $Result + Get-ScheduledSearch # Below is a request that includes all optional parameters - # Search-Aggregate -Search $Result -Offset $Offset -Limit $Limit -Count $Count + # Get-ScheduledSearch -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Aggregate" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ScheduledSearch" Write-Host $_.ErrorDetails } -- path: /search/count +- path: /scheduled-searches/{id}/unsubscribe method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search#search-count + label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#unsubscribe-scheduled-search source: | - $Search = @" + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $TypedReference = @" { - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + "@ + + # Unsubscribe a recipient from Scheduled Search + + try { + $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference + Invoke-UnsubscribeScheduledSearch -Id $Id -TypedReference $Result + + # Below is a request that includes all optional parameters + # Invoke-UnsubscribeScheduledSearch -Id $Id -TypedReference $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-UnsubscribeScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#update-scheduled-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $ScheduledSearch = @" + { + "owner" : { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" + "displayQueryDetails" : false, + "created" : "", + "description" : "Daily disabled accounts", + "ownerId" : "2c9180867624cbd7017642d8c8c81f67", + "enabled" : false, + "schedule" : { + "hours" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" + "months" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } + "timeZoneId" : "America/Chicago", + "days" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" }, - "nested" : { - "name" : "id", - "type" : "access" - } - } + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "recipients" : [ { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + } ], + "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", + "name" : "Daily disabled accounts", + "modified" : "", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "emailEmptyResults" : false } "@ - # Count Documents Satisfying a Query - - try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-Count -Search $Result - - # Below is a request that includes all optional parameters - # Search-Count -Search $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Count" - Write-Host $_.ErrorDetails - } -- path: /search/{index}/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search#search-get - source: | - $Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Get a Document by ID + # Update an existing Scheduled Search try { - Search-Get -Index $Index -Id $Id + $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch + Update-ScheduledSearch -Id $Id -ScheduledSearch $Result # Below is a request that includes all optional parameters - # Search-Get -Index $Index -Id $Id + # Update-ScheduledSearch -Id $Id -ScheduledSearch $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Get" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ScheduledSearch" Write-Host $_.ErrorDetails } -- path: /search +- path: /search/aggregate method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search#search-post + label: SDK_tools/sdk/powershell/v3/methods/search#search-aggregate source: | $Search = @" { @@ -6895,1097 +7148,886 @@ "type" : "access" } }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - } - } - "@ - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 10000 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # Perform Search - - try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-Post -Search $Result - - # Below is a request that includes all optional parameters - # Search-Post -Search $Result -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Post" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/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-SearchAttributeConfig -SearchAttributeConfig $Result - - # Below is a request that includes all optional parameters - # New-SearchAttributeConfig -SearchAttributeConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/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-SearchAttributeConfig -Name $Name - - # Below is a request that includes all optional parameters - # Remove-SearchAttributeConfig -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#get-search-attribute-config - source: | - - # List Extended Search Attributes - - try { - Get-SearchAttributeConfig - - # Below is a request that includes all optional parameters - # Get-SearchAttributeConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#get-single-search-attribute-config - source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to retrieve. - - # Get Extended Search Attribute - - try { - Get-SingleSearchAttributeConfig -Name $Name - - # Below is a request that includes all optional parameters - # Get-SingleSearchAttributeConfig -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SingleSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#patch-search-attribute-config - source: | - $Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Extended Search Attribute - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-SearchAttributeConfig -Name $Name -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-SearchAttributeConfig -Name $Name -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /segments - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/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-Segment -Segment $Result - - # Below is a request that includes all optional parameters - # New-Segment -Segment $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Segment" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/segments#delete-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. - - # Delete Segment by ID - - try { - Remove-Segment -Id $Id - - # Below is a request that includes all optional parameters - # Remove-Segment -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Segment" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/segments#get-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. - - # Get Segment by ID - - try { - Get-Segment -Id $Id - - # Below is a request that includes all optional parameters - # Get-Segment -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Segment" - Write-Host $_.ErrorDetails + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } } -- path: /segments - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/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) + $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) - # List Segments - - try { - Get-Segments - - # Below is a request that includes all optional parameters - # Get-Segments -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Segments" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/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 + # Perform a Search Query Aggregation try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-Segment -Id $Id -RequestBody $Result + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-Aggregate -Search $Result # Below is a request that includes all optional parameters - # Update-Segment -Id $Id -RequestBody $Result + # Search-Aggregate -Search $Result -Offset $Offset -Limit $Limit -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Segment" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Aggregate" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations +- path: /search/count method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#create-service-desk-integration + label: SDK_tools/sdk/powershell/v3/methods/search#search-count source: | - $ServiceDeskIntegrationDto = @" + $Search = @" { - "ownerRef" : "", - "cluster" : "xyzzy999", - "created" : "2024-01-17T18:45:25.994Z", - "description" : "A very nice Service Desk integration", - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "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" + "queryDsl" : { + "match" : { + "name" : "john.doe" } }, - "name" : "Service Desk Integration Name", - "modified" : "2024-02-18T18:45:25.994Z", - "attributes" : { - "property" : "value", - "key" : "value" + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } }, - "id" : "62945a496ef440189b1f03e3623411c8", - "beforeProvisioningRule" : "" - } - "@ - - # Create new Service Desk integration - - try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - New-ServiceDeskIntegration -ServiceDeskIntegrationDto $Result - - # Below is a request that includes all optional parameters - # New-ServiceDeskIntegration -ServiceDeskIntegrationDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/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-ServiceDeskIntegration -Id $Id - - # Below is a request that includes all optional parameters - # Remove-ServiceDeskIntegration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/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-ServiceDeskIntegration -Id $Id - - # Below is a request that includes all optional parameters - # Get-ServiceDeskIntegration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/templates/{scriptName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-service-desk-integration-template - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + } + "@ - # Service Desk integration template by scriptName + # Count Documents Satisfying a Query try { - Get-ServiceDeskIntegrationTemplate -ScriptName $ScriptName + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-Count -Search $Result # Below is a request that includes all optional parameters - # Get-ServiceDeskIntegrationTemplate -ScriptName $ScriptName + # Search-Count -Search $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrationTemplate" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Count" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/types +- path: /search/{index}/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-service-desk-integration-types + label: SDK_tools/sdk/powershell/v3/methods/search#search-get source: | + $Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # List Service Desk integration types + # Get a Document by ID try { - Get-ServiceDeskIntegrationTypes + Search-Get -Index $Index -Id $Id # Below is a request that includes all optional parameters - # Get-ServiceDeskIntegrationTypes + # Search-Get -Index $Index -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrationTypes" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Get" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations - method: GET +- path: /search + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-service-desk-integrations + label: SDK_tools/sdk/powershell/v3/methods/search#search-post source: | + $Search = @" + { + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + } + "@ $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 = "name eq "John Doe"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) + $Limit = 10000 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - # List existing Service Desk integrations + # Perform Search try { - Get-ServiceDeskIntegrations + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-Post -Search $Result # Below is a request that includes all optional parameters - # Get-ServiceDeskIntegrations -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count + # Search-Post -Search $Result -Offset $Offset -Limit $Limit -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrations" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Post" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/status-check-configuration - method: GET +- path: /accounts/search-attribute-config + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-status-check-details + label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#create-search-attribute-config source: | + $SearchAttributeConfig = @" + { + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + } + "@ - # Get the time check configuration + # Create Extended Search Attributes try { - Get-StatusCheckDetails + $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig + New-SearchAttributeConfig -SearchAttributeConfig $Result # Below is a request that includes all optional parameters - # Get-StatusCheckDetails + # New-SearchAttributeConfig -SearchAttributeConfig $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusCheckDetails" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SearchAttributeConfig" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/{id} - method: PATCH +- path: /accounts/search-attribute-config/{name} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#patch-service-desk-integration + label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#delete-search-attribute-config source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $PatchServiceDeskIntegrationRequest = @" - - "@ + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. - # Patch a Service Desk Integration + # Delete Extended Search Attribute try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + Remove-SearchAttributeConfig -Name $Name # Below is a request that includes all optional parameters - # Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + # Remove-SearchAttributeConfig -Name $Name } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ServiceDeskIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SearchAttributeConfig" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/{id} - method: PUT +- path: /accounts/search-attribute-config + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#put-service-desk-integration + label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#get-search-attribute-config source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $ServiceDeskIntegrationDto = @" - { - "ownerRef" : "", - "cluster" : "xyzzy999", - "created" : "2024-01-17T18:45:25.994Z", - "description" : "A very nice Service Desk integration", - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "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", - "modified" : "2024-02-18T18:45:25.994Z", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "id" : "62945a496ef440189b1f03e3623411c8", - "beforeProvisioningRule" : "" + + # List Extended Search Attributes + + try { + Get-SearchAttributeConfig + + # Below is a request that includes all optional parameters + # Get-SearchAttributeConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SearchAttributeConfig" + Write-Host $_.ErrorDetails } - "@ +- path: /accounts/search-attribute-config/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to retrieve. - # Update a Service Desk integration + # Get Extended Search Attribute try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - Send-ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result + Get-SingleSearchAttributeConfig -Name $Name # Below is a request that includes all optional parameters - # Send-ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result + # Get-SingleSearchAttributeConfig -Name $Name } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ServiceDeskIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SingleSearchAttributeConfig" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/status-check-configuration - method: PUT +- path: /accounts/search-attribute-config/{name} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#update-status-check-details + label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#patch-search-attribute-config source: | - $QueuedCheckConfigDetails = @" - { - "provisioningStatusCheckIntervalMinutes" : "30", - "provisioningMaxStatusCheckDays" : "2" - } - "@ + $Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ - # Update the time check configuration + + # Update Extended Search Attribute try { - $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails - Update-StatusCheckDetails -QueuedCheckConfigDetails $Result + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-SearchAttributeConfig -Name $Name -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-StatusCheckDetails -QueuedCheckConfigDetails $Result + # Update-SearchAttributeConfig -Name $Name -JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-StatusCheckDetails" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SearchAttributeConfig" Write-Host $_.ErrorDetails } -- path: /sod-policies +- path: /segments method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#create-sod-policy + label: SDK_tools/sdk/powershell/v3/methods/segments#create-segment source: | - $SodPolicy = @" + $Segment = @" { - "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", + "owner" : { + "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" + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" } }, - "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", + "name" : "segment-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" + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" } "@ - # Create SOD policy + # Create Segment try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-SodPolicy -SodPolicy $Result + $Result = ConvertFrom-JsonToSegment -Json $Segment + New-Segment -Segment $Result # Below is a request that includes all optional parameters - # New-SodPolicy -SodPolicy $Result + # New-Segment -Segment $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Segment" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id} +- path: /segments/{id} method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy + label: SDK_tools/sdk/powershell/v3/methods/segments#delete-segment 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) + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. - # Delete SOD policy by ID + # Delete Segment by ID try { - Remove-SodPolicy -Id $Id + Remove-Segment -Id $Id # Below is a request that includes all optional parameters - # Remove-SodPolicy -Id $Id -Logical $Logical + # Remove-Segment -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Segment" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id}/schedule - method: DELETE +- path: /segments/{id} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy-schedule + label: SDK_tools/sdk/powershell/v3/methods/segments#get-segment source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. - # Delete SOD policy schedule + # Get Segment by ID try { - Remove-SodPolicySchedule -Id $Id + Get-Segment -Id $Id # Below is a request that includes all optional parameters - # Remove-SodPolicySchedule -Id $Id + # Get-Segment -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicySchedule" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Segment" Write-Host $_.ErrorDetails } -- path: /sod-violation-report/{reportResultId}/download/{fileName} +- path: /segments method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-custom-violation-report + label: SDK_tools/sdk/powershell/v3/methods/segments#list-segments source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - $FileName = "custom-name" # String | Custom Name for the file. + $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) - # Download custom violation report + # List Segments try { - Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + Get-Segments # Below is a request that includes all optional parameters - # Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + # Get-Segments -Limit $Limit -Offset $Offset -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CustomViolationReport" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Segments" Write-Host $_.ErrorDetails } -- path: /sod-violation-report/{reportResultId}/download - method: GET +- path: /segments/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-default-violation-report + label: SDK_tools/sdk/powershell/v3/methods/segments#patch-segment source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $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}}]}}}]"@ - # Download violation report + + # Update Segment try { - Get-DefaultViolationReport -ReportResultId $ReportResultId + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-Segment -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters - # Get-DefaultViolationReport -ReportResultId $ReportResultId + # Update-Segment -Id $Id -RequestBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultViolationReport" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Segment" Write-Host $_.ErrorDetails } -- path: /sod-violation-report - method: GET +- path: /service-desk-integrations + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-all-report-run-status + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#create-service-desk-integration source: | + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "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", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } + "@ - # Get multi-report run task status + # Create new Service Desk integration try { - Get-SodAllReportRunStatus + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + New-ServiceDeskIntegration -ServiceDeskIntegrationDto $Result # Below is a request that includes all optional parameters - # Get-SodAllReportRunStatus + # New-ServiceDeskIntegration -ServiceDeskIntegrationDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodAllReportRunStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ServiceDeskIntegration" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id} - method: GET +- path: /service-desk-integrations/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#delete-service-desk-integration source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. + $Id = "anId" # String | ID of Service Desk integration to delete - # Get SOD policy by ID + # Delete a Service Desk integration try { - Get-SodPolicy -Id $Id + Remove-ServiceDeskIntegration -Id $Id # Below is a request that includes all optional parameters - # Get-SodPolicy -Id $Id + # Remove-ServiceDeskIntegration -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ServiceDeskIntegration" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id}/schedule +- path: /service-desk-integrations/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy-schedule + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-service-desk-integration source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. + $Id = "anId" # String | ID of the Service Desk integration to get - # Get SOD policy schedule + # Get a Service Desk integration try { - Get-SodPolicySchedule -Id $Id + Get-ServiceDeskIntegration -Id $Id # Below is a request that includes all optional parameters - # Get-SodPolicySchedule -Id $Id + # Get-ServiceDeskIntegration -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicySchedule" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegration" Write-Host $_.ErrorDetails } -- path: /sod-policies/sod-violation-report-status/{reportResultId} +- path: /service-desk-integrations/templates/{scriptName} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-run-status + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-service-desk-integration-template source: | - $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get - # Get violation report run status + # Service Desk integration template by scriptName try { - Get-SodViolationReportRunStatus -ReportResultId $ReportResultId + Get-ServiceDeskIntegrationTemplate -ScriptName $ScriptName # Below is a request that includes all optional parameters - # Get-SodViolationReportRunStatus -ReportResultId $ReportResultId + # Get-ServiceDeskIntegrationTemplate -ScriptName $ScriptName } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportRunStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrationTemplate" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id}/violation-report +- path: /service-desk-integrations/types method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-status + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-service-desk-integration-types source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. - # Get SOD violation report status + # List Service Desk integration types try { - Get-SodViolationReportStatus -Id $Id + Get-ServiceDeskIntegrationTypes # Below is a request that includes all optional parameters - # Get-SodViolationReportStatus -Id $Id + # Get-ServiceDeskIntegrationTypes } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrationTypes" Write-Host $_.ErrorDetails } -- path: /sod-policies +- path: /service-desk-integrations method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#list-sod-policies + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-service-desk-integrations 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) + $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 = "name eq "John Doe"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - # List SOD policies + # List existing Service Desk integrations try { - Get-SodPolicies + Get-ServiceDeskIntegrations # Below is a request that includes all optional parameters - # Get-SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + # Get-ServiceDeskIntegrations -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicies" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrations" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id} - method: PATCH +- path: /service-desk-integrations/status-check-configuration + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#patch-sod-policy + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-status-check-details 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 + # Get the time check configuration try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-SodPolicy -Id $Id -JsonPatchOperation $Result + Get-StatusCheckDetails # Below is a request that includes all optional parameters - # Update-SodPolicy -Id $Id -JsonPatchOperation $Result + # Get-StatusCheckDetails } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusCheckDetails" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id}/schedule - method: PUT +- path: /service-desk-integrations/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-policy-schedule + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#patch-service-desk-integration 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 - } + $Id = "anId" # String | ID of the Service Desk integration to update + $PatchServiceDeskIntegrationRequest = @" + "@ - # Update SOD Policy schedule + # Patch a Service Desk Integration try { - $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-PolicySchedule -Id $Id -SodPolicySchedule $Result + $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest + Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result # Below is a request that includes all optional parameters - # Send-PolicySchedule -Id $Id -SodPolicySchedule $Result + # Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PolicySchedule" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ServiceDeskIntegration" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id} +- path: /service-desk-integrations/{id} method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-sod-policy + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#put-service-desk-integration source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. - $SodPolicy = @" + $Id = "anId" # String | ID of the Service Desk integration to update + $ServiceDeskIntegrationDto = @" { - "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" + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "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" } }, - "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. + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } + "@ - # Evaluate one policy by ID + # Update a Service Desk integration try { - Start-EvaluateSodPolicy -Id $Id + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + Send-ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result # Below is a request that includes all optional parameters - # Start-EvaluateSodPolicy -Id $Id + # Send-ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-EvaluateSodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ServiceDeskIntegration" Write-Host $_.ErrorDetails } -- path: /sod-violation-report/run - method: POST +- path: /service-desk-integrations/status-check-configuration + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-sod-all-policies-for-org + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#update-status-check-details source: | - $MultiPolicyRequest = @" + $QueuedCheckConfigDetails = @" { - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" } "@ - # 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 + # Update the time check configuration try { - Start-SodPolicy -Id $Id + $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails + Update-StatusCheckDetails -QueuedCheckConfigDetails $Result # Below is a request that includes all optional parameters - # Start-SodPolicy -Id $Id + # Update-StatusCheckDetails -QueuedCheckConfigDetails $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-StatusCheckDetails" Write-Host $_.ErrorDetails } -- path: /sod-violations/predict - method: POST +- path: /source-usages/{sourceId}/status + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-violations#start-predict-sod-violations + label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-status-by-source-id 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" - } ] - } - "@ + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - # Predict SOD violations for identity. + # Finds status of source usage try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-PredictSodViolations -IdentityWithNewAccess $Result + Get-StatusBySourceId -SourceId $SourceId # Below is a request that includes all optional parameters - # Start-PredictSodViolations -IdentityWithNewAccess $Result + # Get-StatusBySourceId -SourceId $SourceId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-PredictSodViolations" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusBySourceId" Write-Host $_.ErrorDetails } -- path: /sod-violations/check - method: POST +- path: /source-usages/{sourceId}/summaries + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-violations#start-violation-check + label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-usages-by-source-id 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}} - "@ + $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) - # Check SOD violations + # Returns source usage insights try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 - Start-ViolationCheck -IdentityWithNewAccess1 $Result + Get-UsagesBySourceId -SourceId $SourceId # Below is a request that includes all optional parameters - # Start-ViolationCheck -IdentityWithNewAccess1 $Result + # Get-UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-ViolationCheck" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesBySourceId" Write-Host $_.ErrorDetails } - path: /sources/{sourceId}/provisioning-policies @@ -8898,48 +8940,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SourceSchema" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-status-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - - # Finds status of source usage - - try { - Get-StatusBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-StatusBySourceId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusBySourceId" - Write-Host $_.ErrorDetails - } -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-usages-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns source usage insights - - try { - Get-UsagesBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesBySourceId" - Write-Host $_.ErrorDetails - } - path: /tagged-objects/{type}/{id} method: DELETE xCodeSample: @@ -9403,679 +9403,679 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-VendorConnectorMappings" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id}/cancel +- path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#cancel-workflow-execution + label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-item source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - # Cancel Workflow Execution by ID + # Approve an Approval Item try { - Suspend-WorkflowExecution -Id $Id + Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId # Below is a request that includes all optional parameters - # Suspend-WorkflowExecution -Id $Id + # Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-WorkflowExecution" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItem" Write-Host $_.ErrorDetails } -- path: /workflows/execute/external/{id} +- path: /work-items/bulk-approve/{id} method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#create-external-execute-workflow + label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-items-in-bulk source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $CreateExternalExecuteWorkflowRequest = @" - - "@ + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - # Execute Workflow via External Trigger + # Bulk approve Approval Items try { - New-ExternalExecuteWorkflow -Id $Id + Approve-ApprovalItemsInBulk -Id $Id # Below is a request that includes all optional parameters - # New-ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result + # Approve-ApprovalItemsInBulk -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ExternalExecuteWorkflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItemsInBulk" Write-Host $_.ErrorDetails } -- path: /workflows +- path: /work-items/{id} method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#create-workflow + label: SDK_tools/sdk/powershell/v3/methods/work-items#complete-work-item 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')]}}} - "@ + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - # Create Workflow + # Complete a Work Item try { - $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-Workflow -CreateWorkflowRequest $Result + Complete-WorkItem -Id $Id # Below is a request that includes all optional parameters - # New-Workflow -CreateWorkflowRequest $Result + # Complete-WorkItem -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-WorkItem" Write-Host $_.ErrorDetails } -- path: /workflows/{id}/external/oauth-clients - method: POST +- path: /work-items/completed + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#create-workflow-external-trigger + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-completed-work-items source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $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) - # Generate External Trigger OAuth Client + # Completed Work Items try { - New-WorkflowExternalTrigger -Id $Id + Get-CompletedWorkItems # Below is a request that includes all optional parameters - # New-WorkflowExternalTrigger -Id $Id + # Get-CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-WorkflowExternalTrigger" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompletedWorkItems" Write-Host $_.ErrorDetails } -- path: /workflows/{id} - method: DELETE +- path: /work-items/completed/count + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#delete-workflow + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-completed-work-items source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - # Delete Workflow By Id + # Count Completed Work Items try { - Remove-Workflow -Id $Id + Get-CountCompletedWorkItems # Below is a request that includes all optional parameters - # Remove-Workflow -Id $Id + # Get-CountCompletedWorkItems -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountCompletedWorkItems" Write-Host $_.ErrorDetails } -- path: /workflows/{id} +- path: /work-items/count method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-work-items source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) - # Get Workflow By Id + # Count Work Items try { - Get-Workflow -Id $Id + Get-CountWorkItems # Below is a request that includes all optional parameters - # Get-Workflow -Id $Id + # Get-CountWorkItems -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountWorkItems" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id} +- path: /work-items/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow-execution + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-item source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. - # Get Workflow Execution + # Get a Work Item try { - Get-WorkflowExecution -Id $Id + Get-WorkItem -Id $Id # Below is a request that includes all optional parameters - # Get-WorkflowExecution -Id $Id + # Get-WorkItem -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecution" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItem" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id}/history +- path: /work-items/summary method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow-execution-history + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-items-summary source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - # Get Workflow Execution History + # Work Items Summary try { - Get-WorkflowExecutionHistory -Id $Id + Get-WorkItemsSummary # Below is a request that includes all optional parameters - # Get-WorkflowExecutionHistory -Id $Id + # Get-WorkItemsSummary -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutionHistory" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItemsSummary" Write-Host $_.ErrorDetails } -- path: /workflows/{id}/executions +- path: /work-items method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow-executions + label: SDK_tools/sdk/powershell/v3/methods/work-items#list-work-items 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) + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - # List Workflow Executions + # List Work Items try { - Get-WorkflowExecutions -Id $Id + Get-WorkItems # Below is a request that includes all optional parameters - # Get-WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + # Get-WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutions" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItems" Write-Host $_.ErrorDetails } -- path: /workflow-library - method: GET +- path: /work-items/{id}/reject/{approvalItemId} + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#list-complete-workflow-library + label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-item 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) + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - # List Complete Workflow Library + # Reject an Approval Item try { - Get-CompleteWorkflowLibrary + Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId # Below is a request that includes all optional parameters - # Get-CompleteWorkflowLibrary -Limit $Limit -Offset $Offset + # Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompleteWorkflowLibrary" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItem" Write-Host $_.ErrorDetails } -- path: /workflow-library/actions - method: GET +- path: /work-items/bulk-reject/{id} + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflow-library-actions + label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-items-in-bulk 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) + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - # List Workflow Library Actions + # Bulk reject Approval Items try { - Get-WorkflowLibraryActions + Deny-ApprovalItemsInBulk -Id $Id # Below is a request that includes all optional parameters - # Get-WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + # Deny-ApprovalItemsInBulk -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryActions" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItemsInBulk" Write-Host $_.ErrorDetails } -- path: /workflow-library/operators - method: GET +- path: /work-items/{id}/forward + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflow-library-operators + 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 + } + "@ - # List Workflow Library Operators + # Forward a Work Item try { - Get-WorkflowLibraryOperators + $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward + Send-WorkItemForward -Id $Id -WorkItemForward $Result # Below is a request that includes all optional parameters - # Get-WorkflowLibraryOperators + # Send-WorkItemForward -Id $Id -WorkItemForward $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryOperators" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-WorkItemForward" Write-Host $_.ErrorDetails } -- path: /workflow-library/triggers - method: GET +- path: /work-items/{id}/submit-account-selection + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflow-library-triggers + label: SDK_tools/sdk/powershell/v3/methods/work-items#submit-account-selection 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) + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName - # List Workflow Library Triggers + # Submit Account Selections try { - Get-WorkflowLibraryTriggers + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Submit-AccountSelection -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters - # Get-WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + # Submit-AccountSelection -Id $Id -RequestBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryTriggers" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-AccountSelection" Write-Host $_.ErrorDetails } -- path: /workflows - method: GET +- path: /workflow-executions/{id}/cancel + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflows + label: SDK_tools/sdk/powershell/v3/methods/workflows#cancel-workflow-execution source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - # List Workflows + # Cancel Workflow Execution by ID try { - Get-Workflows + Suspend-WorkflowExecution -Id $Id # Below is a request that includes all optional parameters - # Get-Workflows + # Suspend-WorkflowExecution -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflows" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-WorkflowExecution" Write-Host $_.ErrorDetails } -- path: /workflows/{id} - method: PATCH +- path: /workflows/execute/external/{id} + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#patch-workflow + label: SDK_tools/sdk/powershell/v3/methods/workflows#create-external-execute-workflow source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $CreateExternalExecuteWorkflowRequest = @" + "@ - # Patch Workflow + # Execute Workflow via External Trigger try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-Workflow -Id $Id -JsonPatchOperation $Result + New-ExternalExecuteWorkflow -Id $Id # Below is a request that includes all optional parameters - # Update-Workflow -Id $Id -JsonPatchOperation $Result + # New-ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ExternalExecuteWorkflow" Write-Host $_.ErrorDetails } -- path: /workflows/{id} - method: PUT +- path: /workflows + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#put-workflow + label: SDK_tools/sdk/powershell/v3/methods/workflows#create-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", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - } + $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')]}}} "@ - # Update Workflow + # Create Workflow try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Send-Workflow -Id $Id -WorkflowBody $Result + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-Workflow -CreateWorkflowRequest $Result # Below is a request that includes all optional parameters - # Send-Workflow -Id $Id -WorkflowBody $Result + # New-Workflow -CreateWorkflowRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Workflow" Write-Host $_.ErrorDetails } -- path: /workflows/execute/external/{id}/test +- path: /workflows/{id}/external/oauth-clients method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#test-external-execute-workflow + label: SDK_tools/sdk/powershell/v3/methods/workflows#create-workflow-external-trigger source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestExternalExecuteWorkflowRequest = @" - - "@ - # Test Workflow via External Trigger + # Generate External Trigger OAuth Client try { - Test-ExternalExecuteWorkflow -Id $Id + New-WorkflowExternalTrigger -Id $Id # Below is a request that includes all optional parameters - # Test-ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result + # New-WorkflowExternalTrigger -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-ExternalExecuteWorkflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-WorkflowExternalTrigger" Write-Host $_.ErrorDetails } -- path: /workflows/{id}/test - method: POST +- path: /workflows/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#test-workflow + label: SDK_tools/sdk/powershell/v3/methods/workflows#delete-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}]}} - "@ + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - # Test Workflow By Id + # Delete Workflow By Id try { - $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-Workflow -Id $Id -TestWorkflowRequest $Result + Remove-Workflow -Id $Id # Below is a request that includes all optional parameters - # Test-Workflow -Id $Id -TestWorkflowRequest $Result + # Remove-Workflow -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Workflow" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/approve/{approvalItemId} - method: POST +- path: /workflows/{id} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-item + label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - # Approve an Approval Item + # Get Workflow By Id try { - Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + Get-Workflow -Id $Id # Below is a request that includes all optional parameters - # Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + # Get-Workflow -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflow" Write-Host $_.ErrorDetails } -- path: /work-items/bulk-approve/{id} - method: POST +- path: /workflow-executions/{id} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-items-in-bulk + label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow-execution source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - # Bulk approve Approval Items + # Get Workflow Execution try { - Approve-ApprovalItemsInBulk -Id $Id + Get-WorkflowExecution -Id $Id # Below is a request that includes all optional parameters - # Approve-ApprovalItemsInBulk -Id $Id + # Get-WorkflowExecution -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItemsInBulk" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecution" Write-Host $_.ErrorDetails } -- path: /work-items/{id} - method: POST +- path: /workflow-executions/{id}/history + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#complete-work-item + label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow-execution-history source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - # Complete a Work Item + # Get Workflow Execution History try { - Complete-WorkItem -Id $Id + Get-WorkflowExecutionHistory -Id $Id # Below is a request that includes all optional parameters - # Complete-WorkItem -Id $Id + # Get-WorkflowExecutionHistory -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-WorkItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutionHistory" Write-Host $_.ErrorDetails } -- path: /work-items/completed +- path: /workflows/{id}/executions method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-completed-work-items + label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow-executions 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) + $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) - # Completed Work Items + # List Workflow Executions try { - Get-CompletedWorkItems + Get-WorkflowExecutions -Id $Id # Below is a request that includes all optional parameters - # Get-CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count + # Get-WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompletedWorkItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutions" Write-Host $_.ErrorDetails } -- path: /work-items/completed/count +- path: /workflow-library method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-completed-work-items + label: SDK_tools/sdk/powershell/v3/methods/workflows#list-complete-workflow-library source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - # Count Completed Work Items + # List Complete Workflow Library try { - Get-CountCompletedWorkItems + Get-CompleteWorkflowLibrary # Below is a request that includes all optional parameters - # Get-CountCompletedWorkItems -OwnerId $OwnerId + # Get-CompleteWorkflowLibrary -Limit $Limit -Offset $Offset } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountCompletedWorkItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompleteWorkflowLibrary" Write-Host $_.ErrorDetails } -- path: /work-items/count +- path: /workflow-library/actions method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-work-items + label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflow-library-actions source: | - $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $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) - # Count Work Items + # List Workflow Library Actions try { - Get-CountWorkItems + Get-WorkflowLibraryActions # Below is a request that includes all optional parameters - # Get-CountWorkItems -OwnerId $OwnerId + # Get-WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountWorkItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryActions" Write-Host $_.ErrorDetails } -- path: /work-items/{id} +- path: /workflow-library/operators method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-item + label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflow-library-operators source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. - # Get a Work Item + # List Workflow Library Operators try { - Get-WorkItem -Id $Id + Get-WorkflowLibraryOperators # Below is a request that includes all optional parameters - # Get-WorkItem -Id $Id + # Get-WorkflowLibraryOperators } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryOperators" Write-Host $_.ErrorDetails } -- path: /work-items/summary +- path: /workflow-library/triggers method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-items-summary + label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflow-library-triggers source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $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) - # Work Items Summary + # List Workflow Library Triggers try { - Get-WorkItemsSummary + Get-WorkflowLibraryTriggers # Below is a request that includes all optional parameters - # Get-WorkItemsSummary -OwnerId $OwnerId + # Get-WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItemsSummary" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryTriggers" Write-Host $_.ErrorDetails } -- path: /work-items +- path: /workflows method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#list-work-items + label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflows 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 + # List Workflows try { - Get-WorkItems + Get-Workflows # Below is a request that includes all optional parameters - # Get-WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId + # Get-Workflows } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflows" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/reject/{approvalItemId} - method: POST +- path: /workflows/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-item + label: SDK_tools/sdk/powershell/v3/methods/workflows#patch-workflow source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ - # Reject an Approval Item + + # Patch Workflow try { - Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-Workflow -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + # Update-Workflow -Id $Id -JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Workflow" Write-Host $_.ErrorDetails } -- path: /work-items/bulk-reject/{id} - method: POST +- path: /workflows/{id} + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-items-in-bulk + label: SDK_tools/sdk/powershell/v3/methods/workflows#put-workflow source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $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", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ - # Bulk reject Approval Items + # Update Workflow try { - Deny-ApprovalItemsInBulk -Id $Id + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-Workflow -Id $Id -WorkflowBody $Result # Below is a request that includes all optional parameters - # Deny-ApprovalItemsInBulk -Id $Id + # Send-Workflow -Id $Id -WorkflowBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItemsInBulk" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Workflow" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/forward +- path: /workflows/execute/external/{id}/test method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#send-work-item-forward + label: SDK_tools/sdk/powershell/v3/methods/workflows#test-external-execute-workflow source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $WorkItemForward = @" - { - "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I'm going on vacation.", - "sendNotifications" : true - } + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + "@ - # Forward a Work Item + # Test Workflow via External Trigger try { - $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward - Send-WorkItemForward -Id $Id -WorkItemForward $Result + Test-ExternalExecuteWorkflow -Id $Id # Below is a request that includes all optional parameters - # Send-WorkItemForward -Id $Id -WorkItemForward $Result + # Test-ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-WorkItemForward" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-ExternalExecuteWorkflow" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/submit-account-selection +- path: /workflows/{id}/test method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#submit-account-selection + label: SDK_tools/sdk/powershell/v3/methods/workflows#test-workflow source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName + $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}]}} + "@ - # Submit Account Selections + # Test Workflow By Id try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Submit-AccountSelection -Id $Id -RequestBody $Result + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-Workflow -Id $Id -TestWorkflowRequest $Result # Below is a request that includes all optional parameters - # Submit-AccountSelection -Id $Id -RequestBody $Result + # Test-Workflow -Id $Id -TestWorkflowRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-AccountSelection" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-Workflow" Write-Host $_.ErrorDetails }