From 1a2b875b8d2cfd72e8894470c9a7ee9715d25dc7 Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Mon, 5 May 2025 15:40:38 +0000 Subject: [PATCH] Update to powershell SDK docs: 14840363765 --- .../V2024/Methods/V2024AccessRequestsApi.md | 15 +++++++--- .../V2024/Methods/V2024EntitlementsApi.md | 15 +++++++--- .../V2024/Methods/V2024WorkflowsApi.md | 3 ++ .../V2024/Models/EntitlementRequestConfig.md | 10 ++----- .../V2025/Methods/V2025AccessRequestsApi.md | 15 +++++++--- .../V2025/Methods/V2025EntitlementsApi.md | 15 +++++++--- .../V2025/Methods/V2025WorkflowsApi.md | 3 ++ .../V2025/Models/EntitlementRequestConfig.md | 10 ++----- .../Reference/V3/Methods/WorkflowsApi.md | 3 ++ .../powershell_code_examples_overlay.yaml | 30 ++++++++++++++----- .../powershell_code_examples_overlay.yaml | 30 ++++++++++++++----- 11 files changed, 101 insertions(+), 48 deletions(-) diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md index 79ee383c2..28dbe1655 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md @@ -862,10 +862,17 @@ $AccessRequestConfig = @"{ }, "autoApprovalEnabled" : true, "entitlementRequestConfig" : { - "requestCommentsRequired" : false, - "deniedCommentsRequired" : false, - "allowEntitlementRequest" : true, - "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } }, "reauthorizationEnabled" : true, "approvalsMustBeExternal" : true diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024EntitlementsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024EntitlementsApi.md index d19f7fec7..a133900dc 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024EntitlementsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024EntitlementsApi.md @@ -641,10 +641,17 @@ Code | Description | Data Type $Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $EntitlementRequestConfig = @"{ - "requestCommentsRequired" : false, - "deniedCommentsRequired" : false, - "allowEntitlementRequest" : true, - "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } }"@ # Replace Entitlement Request Config diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkflowsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkflowsApi.md index d149282a2..bf6ecc994 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkflowsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkflowsApi.md @@ -887,6 +887,9 @@ try { [[Back to top]](#) ## test-workflow +::: info +Workflow must be disabled in order to use this endpoint. +::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/idn/docs/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementRequestConfig.md b/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementRequestConfig.md index c526b9cde..14ac46486 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementRequestConfig.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementRequestConfig.md @@ -16,19 +16,13 @@ tags: ['SDK', 'Software Development Kit', 'EntitlementRequestConfig', 'V2024Enti Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**AllowEntitlementRequest** | **Boolean** | If this is true, entitlement requests are allowed. | [optional] [default to $false] -**RequestCommentsRequired** | **Boolean** | If this is true, comments are required to submit entitlement requests. | [optional] [default to $false] -**DeniedCommentsRequired** | **Boolean** | If this is true, comments are required to reject entitlement requests. | [optional] [default to $false] -**GrantRequestApprovalSchemes** | **String** | Approval schemes for granting entitlement request. This can be empty if no approval is needed. Multiple schemes must be comma-separated. The valid schemes are ""entitlementOwner"", ""sourceOwner"", ""manager"" and ""`workgroup:{id}`"". You can use multiple governance groups (workgroups). | [optional] [default to "sourceOwner"] +**AccessRequestConfig** | [**EntitlementAccessRequestConfig**](entitlement-access-request-config) | | [optional] ## Examples - Prepare the resource ```powershell -$EntitlementRequestConfig = Initialize-PSSailpoint.V2024EntitlementRequestConfig -AllowEntitlementRequest true ` - -RequestCommentsRequired false ` - -DeniedCommentsRequired false ` - -GrantRequestApprovalSchemes entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584 +$EntitlementRequestConfig = Initialize-PSSailpoint.V2024EntitlementRequestConfig -AccessRequestConfig null ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestsApi.md index 66b9f3e20..257884953 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestsApi.md @@ -906,10 +906,17 @@ $AccessRequestConfig = @"{ }, "autoApprovalEnabled" : true, "entitlementRequestConfig" : { - "requestCommentsRequired" : false, - "deniedCommentsRequired" : false, - "allowEntitlementRequest" : true, - "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } }, "reauthorizationEnabled" : true, "approvalsMustBeExternal" : true diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025EntitlementsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025EntitlementsApi.md index 7f6128b95..3872cb4b6 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025EntitlementsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025EntitlementsApi.md @@ -641,10 +641,17 @@ Code | Description | Data Type $Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $EntitlementRequestConfig = @"{ - "requestCommentsRequired" : false, - "deniedCommentsRequired" : false, - "allowEntitlementRequest" : true, - "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } }"@ # Replace Entitlement Request Config diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025WorkflowsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025WorkflowsApi.md index 4c39bab56..346054319 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025WorkflowsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025WorkflowsApi.md @@ -887,6 +887,9 @@ try { [[Back to top]](#) ## test-workflow +::: info +Workflow must be disabled in order to use this endpoint. +::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/idn/docs/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/EntitlementRequestConfig.md b/docs/tools/sdk/powershell/Reference/V2025/Models/EntitlementRequestConfig.md index 0297abc1b..3e46e3f12 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/EntitlementRequestConfig.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/EntitlementRequestConfig.md @@ -16,19 +16,13 @@ tags: ['SDK', 'Software Development Kit', 'EntitlementRequestConfig', 'V2025Enti Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**AllowEntitlementRequest** | **Boolean** | If this is true, entitlement requests are allowed. | [optional] [default to $false] -**RequestCommentsRequired** | **Boolean** | If this is true, comments are required to submit entitlement requests. | [optional] [default to $false] -**DeniedCommentsRequired** | **Boolean** | If this is true, comments are required to reject entitlement requests. | [optional] [default to $false] -**GrantRequestApprovalSchemes** | **String** | Approval schemes for granting entitlement request. This can be empty if no approval is needed. Multiple schemes must be comma-separated. The valid schemes are ""entitlementOwner"", ""sourceOwner"", ""manager"" and ""`workgroup:{id}`"". You can use multiple governance groups (workgroups). | [optional] [default to "sourceOwner"] +**AccessRequestConfig** | [**EntitlementAccessRequestConfig**](entitlement-access-request-config) | | [optional] ## Examples - Prepare the resource ```powershell -$EntitlementRequestConfig = Initialize-PSSailpoint.V2025EntitlementRequestConfig -AllowEntitlementRequest true ` - -RequestCommentsRequired false ` - -DeniedCommentsRequired false ` - -GrantRequestApprovalSchemes entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584 +$EntitlementRequestConfig = Initialize-PSSailpoint.V2025EntitlementRequestConfig -AccessRequestConfig null ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/WorkflowsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/WorkflowsApi.md index 4fac5d581..d6a626ba7 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/WorkflowsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/WorkflowsApi.md @@ -897,6 +897,9 @@ try { [[Back to top]](#) ## test-workflow +::: info +Workflow must be disabled in order to use this endpoint. +::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/idn/docs/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** diff --git a/static/code-examples/v2024/powershell_code_examples_overlay.yaml b/static/code-examples/v2024/powershell_code_examples_overlay.yaml index ec401b572..6eb5a96c0 100644 --- a/static/code-examples/v2024/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2024/powershell_code_examples_overlay.yaml @@ -1044,10 +1044,17 @@ }, "autoApprovalEnabled" : true, "entitlementRequestConfig" : { - "requestCommentsRequired" : false, - "deniedCommentsRequired" : false, - "allowEntitlementRequest" : true, - "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } }, "reauthorizationEnabled" : true, "approvalsMustBeExternal" : true @@ -5753,10 +5760,17 @@ $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $EntitlementRequestConfig = @" { - "requestCommentsRequired" : false, - "deniedCommentsRequired" : false, - "allowEntitlementRequest" : true, - "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } } "@ diff --git a/static/code-examples/v2025/powershell_code_examples_overlay.yaml b/static/code-examples/v2025/powershell_code_examples_overlay.yaml index fa248eb4a..50f95bf27 100644 --- a/static/code-examples/v2025/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2025/powershell_code_examples_overlay.yaml @@ -1055,10 +1055,17 @@ }, "autoApprovalEnabled" : true, "entitlementRequestConfig" : { - "requestCommentsRequired" : false, - "deniedCommentsRequired" : false, - "allowEntitlementRequest" : true, - "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } }, "reauthorizationEnabled" : true, "approvalsMustBeExternal" : true @@ -5764,10 +5771,17 @@ $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $EntitlementRequestConfig = @" { - "requestCommentsRequired" : false, - "deniedCommentsRequired" : false, - "allowEntitlementRequest" : true, - "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } } "@