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

Update to powershell SDK docs: 14840363765

Browse Source
This commit is contained in:
developer-relations-sp
2025-05-05 15:40:38 +00:00
parent bec28973e7
commit 1a2b875b8d
11 changed files with 101 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -862,10 +862,17 @@ $AccessRequestConfig = @"{
}, },
"autoApprovalEnabled" : true, "autoApprovalEnabled" : true,
"entitlementRequestConfig" : { "entitlementRequestConfig" : {
"requestCommentsRequired" : false, "accessRequestConfig" : {
"deniedCommentsRequired" : false, "denialCommentRequired" : false,
"allowEntitlementRequest" : true, "approvalSchemes" : [ {
"grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8",
"approverType" : "GOVERNANCE_GROUP"
}, {
"approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8",
"approverType" : "GOVERNANCE_GROUP"
} ],
"requestCommentRequired" : true
}
}, },
"reauthorizationEnabled" : true, "reauthorizationEnabled" : true,
"approvalsMustBeExternal" : true "approvalsMustBeExternal" : true

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

@@ -641,10 +641,17 @@ Code | Description | Data Type
$Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID $Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$EntitlementRequestConfig = @"{ $EntitlementRequestConfig = @"{
"requestCommentsRequired" : false, "accessRequestConfig" : {
"deniedCommentsRequired" : false, "denialCommentRequired" : false,
"allowEntitlementRequest" : true, "approvalSchemes" : [ {
"grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8",
"approverType" : "GOVERNANCE_GROUP"
}, {
"approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8",
"approverType" : "GOVERNANCE_GROUP"
} ],
"requestCommentRequired" : true
}
}"@ }"@
# Replace Entitlement Request Config # Replace Entitlement Request Config

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

@@ -887,6 +887,9 @@ try {
[[Back to top]](#) [[Back to top]](#)
## test-workflow ## 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. 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 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.** **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.**

10
docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementRequestConfig.md
View File

@@ -16,19 +16,13 @@ tags: ['SDK', 'Software Development Kit', 'EntitlementRequestConfig', 'V2024Enti
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**AllowEntitlementRequest** | **Boolean** | If this is true, entitlement requests are allowed. | [optional] [default to $false] **AccessRequestConfig** | [**EntitlementAccessRequestConfig**](entitlement-access-request-config) | | [optional]
**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"]
## Examples ## Examples
- Prepare the resource - Prepare the resource
```powershell ```powershell
$EntitlementRequestConfig = Initialize-PSSailpoint.V2024EntitlementRequestConfig -AllowEntitlementRequest true ` $EntitlementRequestConfig = Initialize-PSSailpoint.V2024EntitlementRequestConfig -AccessRequestConfig null
-RequestCommentsRequired false `
-DeniedCommentsRequired false `
-GrantRequestApprovalSchemes entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584
``` ```
- Convert the resource to JSON - Convert the resource to JSON

15
docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestsApi.md
View File

@@ -906,10 +906,17 @@ $AccessRequestConfig = @"{
}, },
"autoApprovalEnabled" : true, "autoApprovalEnabled" : true,
"entitlementRequestConfig" : { "entitlementRequestConfig" : {
"requestCommentsRequired" : false, "accessRequestConfig" : {
"deniedCommentsRequired" : false, "denialCommentRequired" : false,
"allowEntitlementRequest" : true, "approvalSchemes" : [ {
"grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8",
"approverType" : "GOVERNANCE_GROUP"
}, {
"approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8",
"approverType" : "GOVERNANCE_GROUP"
} ],
"requestCommentRequired" : true
}
}, },
"reauthorizationEnabled" : true, "reauthorizationEnabled" : true,
"approvalsMustBeExternal" : true "approvalsMustBeExternal" : true

15
docs/tools/sdk/powershell/Reference/V2025/Methods/V2025EntitlementsApi.md
View File

@@ -641,10 +641,17 @@ Code | Description | Data Type
$Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID $Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$EntitlementRequestConfig = @"{ $EntitlementRequestConfig = @"{
"requestCommentsRequired" : false, "accessRequestConfig" : {
"deniedCommentsRequired" : false, "denialCommentRequired" : false,
"allowEntitlementRequest" : true, "approvalSchemes" : [ {
"grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8",
"approverType" : "GOVERNANCE_GROUP"
}, {
"approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8",
"approverType" : "GOVERNANCE_GROUP"
} ],
"requestCommentRequired" : true
}
}"@ }"@
# Replace Entitlement Request Config # Replace Entitlement Request Config

3
docs/tools/sdk/powershell/Reference/V2025/Methods/V2025WorkflowsApi.md
View File

@@ -887,6 +887,9 @@ try {
[[Back to top]](#) [[Back to top]](#)
## test-workflow ## 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. 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 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.** **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.**

10
docs/tools/sdk/powershell/Reference/V2025/Models/EntitlementRequestConfig.md
View File

@@ -16,19 +16,13 @@ tags: ['SDK', 'Software Development Kit', 'EntitlementRequestConfig', 'V2025Enti
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**AllowEntitlementRequest** | **Boolean** | If this is true, entitlement requests are allowed. | [optional] [default to $false] **AccessRequestConfig** | [**EntitlementAccessRequestConfig**](entitlement-access-request-config) | | [optional]
**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"]
## Examples ## Examples
- Prepare the resource - Prepare the resource
```powershell ```powershell
$EntitlementRequestConfig = Initialize-PSSailpoint.V2025EntitlementRequestConfig -AllowEntitlementRequest true ` $EntitlementRequestConfig = Initialize-PSSailpoint.V2025EntitlementRequestConfig -AccessRequestConfig null
-RequestCommentsRequired false `
-DeniedCommentsRequired false `
-GrantRequestApprovalSchemes entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584
``` ```
- Convert the resource to JSON - Convert the resource to JSON

3
docs/tools/sdk/powershell/Reference/V3/Methods/WorkflowsApi.md
View File

@@ -897,6 +897,9 @@ try {
[[Back to top]](#) [[Back to top]](#)
## test-workflow ## 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. 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 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.** **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.**

30
static/code-examples/v2024/powershell_code_examples_overlay.yaml
View File

@@ -1044,10 +1044,17 @@
}, },
"autoApprovalEnabled" : true, "autoApprovalEnabled" : true,
"entitlementRequestConfig" : { "entitlementRequestConfig" : {
"requestCommentsRequired" : false, "accessRequestConfig" : {
"deniedCommentsRequired" : false, "denialCommentRequired" : false,
"allowEntitlementRequest" : true, "approvalSchemes" : [ {
"grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8",
"approverType" : "GOVERNANCE_GROUP"
}, {
"approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8",
"approverType" : "GOVERNANCE_GROUP"
} ],
"requestCommentRequired" : true
}
}, },
"reauthorizationEnabled" : true, "reauthorizationEnabled" : true,
"approvalsMustBeExternal" : true "approvalsMustBeExternal" : true
@@ -5753,10 +5760,17 @@
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$EntitlementRequestConfig = @" $EntitlementRequestConfig = @"
{ {
"requestCommentsRequired" : false, "accessRequestConfig" : {
"deniedCommentsRequired" : false, "denialCommentRequired" : false,
"allowEntitlementRequest" : true, "approvalSchemes" : [ {
"grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8",
"approverType" : "GOVERNANCE_GROUP"
}, {
"approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8",
"approverType" : "GOVERNANCE_GROUP"
} ],
"requestCommentRequired" : true
}
} }
"@ "@

30
static/code-examples/v2025/powershell_code_examples_overlay.yaml
View File

@@ -1055,10 +1055,17 @@
}, },
"autoApprovalEnabled" : true, "autoApprovalEnabled" : true,
"entitlementRequestConfig" : { "entitlementRequestConfig" : {
"requestCommentsRequired" : false, "accessRequestConfig" : {
"deniedCommentsRequired" : false, "denialCommentRequired" : false,
"allowEntitlementRequest" : true, "approvalSchemes" : [ {
"grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8",
"approverType" : "GOVERNANCE_GROUP"
}, {
"approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8",
"approverType" : "GOVERNANCE_GROUP"
} ],
"requestCommentRequired" : true
}
}, },
"reauthorizationEnabled" : true, "reauthorizationEnabled" : true,
"approvalsMustBeExternal" : true "approvalsMustBeExternal" : true
@@ -5764,10 +5771,17 @@
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$EntitlementRequestConfig = @" $EntitlementRequestConfig = @"
{ {
"requestCommentsRequired" : false, "accessRequestConfig" : {
"deniedCommentsRequired" : false, "denialCommentRequired" : false,
"allowEntitlementRequest" : true, "approvalSchemes" : [ {
"grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8",
"approverType" : "GOVERNANCE_GROUP"
}, {
"approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8",
"approverType" : "GOVERNANCE_GROUP"
} ],
"requestCommentRequired" : true
}
} }
"@ "@