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

Update to powershell SDK docs: 13903254328

Browse Source
This commit is contained in:
developer-relations-sp
2025-03-17 15:24:32 +00:00
parent 63b6e70fec
commit 9ed39129fb
15 changed files with 55 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkflowsApi.md
View File

@@ -910,7 +910,9 @@ $WorkflowBody = @"{
"trigger" : { "trigger" : {
"displayName" : "displayName", "displayName" : "displayName",
"attributes" : { "attributes" : {
"description" : "description", "description" : "Triggered when an identity's manager attribute changes",
"formDefinitionId" : "Admin_Access_Request_Form",
"attributeToFilter" : "LifecycleState",
"id" : "idn:identity-attributes-changed", "id" : "idn:identity-attributes-changed",
"filter.$" : "$.changes[?(@.attribute == 'manager')]" "filter.$" : "$.changes[?(@.attribute == 'manager')]"
}, },

6
docs/tools/sdk/powershell/Reference/Beta/Models/EventAttributes.md
View File

@@ -19,6 +19,8 @@ Name | Type | Description | Notes
**Id** | **String** | The unique ID of the trigger | [required] **Id** | **String** | The unique ID of the trigger | [required]
**VarFilter** | **String** | JSON path expression that will limit which events the trigger will fire on | [optional] **VarFilter** | **String** | JSON path expression that will limit which events the trigger will fire on | [optional]
**Description** | **String** | Description of the event trigger | [optional] **Description** | **String** | Description of the event trigger | [optional]
**AttributeToFilter** | **String** | The attribute to filter on | [optional]
**FormDefinitionId** | **String** | Form definition's unique identifier. | [optional]
## Examples ## Examples
@@ -26,7 +28,9 @@ Name | Type | Description | Notes
```powershell ```powershell
$EventAttributes = Initialize-PSSailpoint.BetaEventAttributes -Id idn:identity-attributes-changed ` $EventAttributes = Initialize-PSSailpoint.BetaEventAttributes -Id idn:identity-attributes-changed `
-VarFilter $.changes[?(@.attribute == 'manager')] ` -VarFilter $.changes[?(@.attribute == 'manager')] `
-Description null -Description Triggered when an identity's manager attribute changes `
-AttributeToFilter LifecycleState `
-FormDefinitionId Admin_Access_Request_Form
``` ```
- Convert the resource to JSON - Convert the resource to JSON

8
docs/tools/sdk/powershell/Reference/Beta/Models/ScheduledAttributes.md
View File

@@ -18,19 +18,21 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**Frequency** | **Enum** [ "daily", "weekly", "monthly", "yearly", "cronSchedule" ] | Frequency of execution | [required] **Frequency** | **Enum** [ "daily", "weekly", "monthly", "yearly", "cronSchedule" ] | Frequency of execution | [required]
**TimeZone** | **String** | Time zone identifier | [optional] **TimeZone** | **String** | Time zone identifier | [optional]
**CronString** | **String** | | [optional] **CronString** | **String** | A valid CRON expression | [optional]
**WeeklyDays** | **[]String** | Scheduled days of the week for execution | [optional] **WeeklyDays** | **[]String** | Scheduled days of the week for execution | [optional]
**WeeklyTimes** | **[]String** | Scheduled execution times | [optional] **WeeklyTimes** | **[]String** | Scheduled execution times | [optional]
**YearlyTimes** | **[]String** | Scheduled execution times | [optional]
## Examples ## Examples
- Prepare the resource - Prepare the resource
```powershell ```powershell
$ScheduledAttributes = Initialize-PSSailpoint.BetaScheduledAttributes -Frequency null ` $ScheduledAttributes = Initialize-PSSailpoint.BetaScheduledAttributes -Frequency daily `
-TimeZone America/Chicago ` -TimeZone America/Chicago `
-CronString 0 9 * * 1 ` -CronString 0 9 * * 1 `
-WeeklyDays Monday ` -WeeklyDays Monday `
-WeeklyTimes Monday -WeeklyTimes Monday `
-YearlyTimes 1969-12-31T09:00:00.000Z
``` ```
- Convert the resource to JSON - Convert the resource to JSON

12
docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowTriggerAttributes.md
View File

@@ -19,14 +19,17 @@ Name | Type | Description | Notes
**Id** | **String** | The unique ID of the trigger | [required] **Id** | **String** | The unique ID of the trigger | [required]
**VarFilter** | **String** | JSON path expression that will limit which events the trigger will fire on | [optional] **VarFilter** | **String** | JSON path expression that will limit which events the trigger will fire on | [optional]
**Description** | **String** | Additional context about the external trigger | [optional] **Description** | **String** | Additional context about the external trigger | [optional]
**AttributeToFilter** | **String** | The attribute to filter on | [optional]
**FormDefinitionId** | **String** | Form definition's unique identifier. | [optional]
**Name** | **String** | A unique name for the external trigger | [optional] **Name** | **String** | A unique name for the external trigger | [optional]
**ClientId** | **String** | OAuth Client ID to authenticate with this trigger | [optional] **ClientId** | **String** | OAuth Client ID to authenticate with this trigger | [optional]
**Url** | **String** | URL to invoke this workflow | [optional] **Url** | **String** | URL to invoke this workflow | [optional]
**Frequency** | **Enum** [ "daily", "weekly", "monthly", "yearly", "cronSchedule" ] | Frequency of execution | [required] **Frequency** | **Enum** [ "daily", "weekly", "monthly", "yearly", "cronSchedule" ] | Frequency of execution | [required]
**TimeZone** | **String** | Time zone identifier | [optional] **TimeZone** | **String** | Time zone identifier | [optional]
**CronString** | **String** | | [optional] **CronString** | **String** | A valid CRON expression | [optional]
**WeeklyDays** | **[]String** | Scheduled days of the week for execution | [optional] **WeeklyDays** | **[]String** | Scheduled days of the week for execution | [optional]
**WeeklyTimes** | **[]String** | Scheduled execution times | [optional] **WeeklyTimes** | **[]String** | Scheduled execution times | [optional]
**YearlyTimes** | **[]String** | Scheduled execution times | [optional]
## Examples ## Examples
@@ -35,14 +38,17 @@ Name | Type | Description | Notes
$WorkflowTriggerAttributes = Initialize-PSSailpoint.BetaWorkflowTriggerAttributes -Id idn:identity-attributes-changed ` $WorkflowTriggerAttributes = Initialize-PSSailpoint.BetaWorkflowTriggerAttributes -Id idn:identity-attributes-changed `
-VarFilter $.changes[?(@.attribute == 'manager')] ` -VarFilter $.changes[?(@.attribute == 'manager')] `
-Description Run a search and notify the results ` -Description Run a search and notify the results `
-AttributeToFilter LifecycleState `
-FormDefinitionId Admin_Access_Request_Form `
-Name search-and-notify ` -Name search-and-notify `
-ClientId 87e239b2-b85b-4bde-b9a7-55bf304ddcdc ` -ClientId 87e239b2-b85b-4bde-b9a7-55bf304ddcdc `
-Url https://tenant.api.identitynow.com/beta/workflows/execute/external/c79e0079-562c-4df5-aa73-60a9e25c916d ` -Url https://tenant.api.identitynow.com/beta/workflows/execute/external/c79e0079-562c-4df5-aa73-60a9e25c916d `
-Frequency null ` -Frequency daily `
-TimeZone America/Chicago ` -TimeZone America/Chicago `
-CronString 0 9 * * 1 ` -CronString 0 9 * * 1 `
-WeeklyDays Monday ` -WeeklyDays Monday `
-WeeklyTimes Monday -WeeklyTimes Monday `
-YearlyTimes 1969-12-31T09:00:00.000Z
``` ```
- Convert the resource to JSON - Convert the resource to JSON

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

@@ -814,6 +814,7 @@ $WorkflowBody = @"{
"displayName" : "displayName", "displayName" : "displayName",
"attributes" : { "attributes" : {
"description" : "Triggered when an identity's manager attribute changes", "description" : "Triggered when an identity's manager attribute changes",
"formDefinitionId" : "Admin_Access_Request_Form",
"attributeToFilter" : "LifecycleState", "attributeToFilter" : "LifecycleState",
"id" : "idn:identity-attributes-changed", "id" : "idn:identity-attributes-changed",
"filter.$" : "$.changes[?(@.attribute == 'manager')]" "filter.$" : "$.changes[?(@.attribute == 'manager')]"

4
docs/tools/sdk/powershell/Reference/V2024/Models/EventAttributes.md
View File

@@ -20,6 +20,7 @@ Name | Type | Description | Notes
**VarFilter** | **String** | JSON path expression that will limit which events the trigger will fire on | [optional] **VarFilter** | **String** | JSON path expression that will limit which events the trigger will fire on | [optional]
**Description** | **String** | Description of the event trigger | [optional] **Description** | **String** | Description of the event trigger | [optional]
**AttributeToFilter** | **String** | The attribute to filter on | [optional] **AttributeToFilter** | **String** | The attribute to filter on | [optional]
**FormDefinitionId** | **String** | Form definition's unique identifier. | [optional]
## Examples ## Examples
@@ -28,7 +29,8 @@ Name | Type | Description | Notes
$EventAttributes = Initialize-PSSailpoint.V2024EventAttributes -Id idn:identity-attributes-changed ` $EventAttributes = Initialize-PSSailpoint.V2024EventAttributes -Id idn:identity-attributes-changed `
-VarFilter $.changes[?(@.attribute == 'manager')] ` -VarFilter $.changes[?(@.attribute == 'manager')] `
-Description Triggered when an identity's manager attribute changes ` -Description Triggered when an identity's manager attribute changes `
-AttributeToFilter LifecycleState -AttributeToFilter LifecycleState `
-FormDefinitionId Admin_Access_Request_Form
``` ```
- Convert the resource to JSON - Convert the resource to JSON

6
docs/tools/sdk/powershell/Reference/V2024/Models/ScheduledAttributes.md
View File

@@ -21,16 +21,18 @@ Name | Type | Description | Notes
**TimeZone** | **String** | Time zone identifier | [optional] **TimeZone** | **String** | Time zone identifier | [optional]
**WeeklyDays** | **[]String** | Scheduled days of the week for execution | [optional] **WeeklyDays** | **[]String** | Scheduled days of the week for execution | [optional]
**WeeklyTimes** | **[]String** | Scheduled execution times | [optional] **WeeklyTimes** | **[]String** | Scheduled execution times | [optional]
**YearlyTimes** | **[]String** | Scheduled execution times | [optional]
## Examples ## Examples
- Prepare the resource - Prepare the resource
```powershell ```powershell
$ScheduledAttributes = Initialize-PSSailpoint.V2024ScheduledAttributes -CronString 0 9 * * 1 ` $ScheduledAttributes = Initialize-PSSailpoint.V2024ScheduledAttributes -CronString 0 9 * * 1 `
-Frequency null ` -Frequency daily `
-TimeZone America/Chicago ` -TimeZone America/Chicago `
-WeeklyDays Monday ` -WeeklyDays Monday `
-WeeklyTimes Monday -WeeklyTimes Monday `
-YearlyTimes 1969-12-31T09:00:00.000Z
``` ```
- Convert the resource to JSON - Convert the resource to JSON

8
docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowTriggerAttributes.md
View File

@@ -20,6 +20,7 @@ Name | Type | Description | Notes
**VarFilter** | **String** | JSON path expression that will limit which events the trigger will fire on | [optional] **VarFilter** | **String** | JSON path expression that will limit which events the trigger will fire on | [optional]
**Description** | **String** | Additonal context about the external trigger | [optional] **Description** | **String** | Additonal context about the external trigger | [optional]
**AttributeToFilter** | **String** | The attribute to filter on | [optional] **AttributeToFilter** | **String** | The attribute to filter on | [optional]
**FormDefinitionId** | **String** | Form definition's unique identifier. | [optional]
**Name** | **String** | A unique name for the external trigger | [optional] **Name** | **String** | A unique name for the external trigger | [optional]
**ClientId** | **String** | OAuth Client ID to authenticate with this trigger | [optional] **ClientId** | **String** | OAuth Client ID to authenticate with this trigger | [optional]
**Url** | **String** | URL to invoke this workflow | [optional] **Url** | **String** | URL to invoke this workflow | [optional]
@@ -28,6 +29,7 @@ Name | Type | Description | Notes
**TimeZone** | **String** | Time zone identifier | [optional] **TimeZone** | **String** | Time zone identifier | [optional]
**WeeklyDays** | **[]String** | Scheduled days of the week for execution | [optional] **WeeklyDays** | **[]String** | Scheduled days of the week for execution | [optional]
**WeeklyTimes** | **[]String** | Scheduled execution times | [optional] **WeeklyTimes** | **[]String** | Scheduled execution times | [optional]
**YearlyTimes** | **[]String** | Scheduled execution times | [optional]
## Examples ## Examples
@@ -37,14 +39,16 @@ $WorkflowTriggerAttributes = Initialize-PSSailpoint.V2024WorkflowTriggerAttribut
-VarFilter $.changes[?(@.attribute == 'manager')] ` -VarFilter $.changes[?(@.attribute == 'manager')] `
-Description Run a search and notify the results ` -Description Run a search and notify the results `
-AttributeToFilter LifecycleState ` -AttributeToFilter LifecycleState `
-FormDefinitionId Admin_Access_Request_Form `
-Name search-and-notify ` -Name search-and-notify `
-ClientId 87e239b2-b85b-4bde-b9a7-55bf304ddcdc ` -ClientId 87e239b2-b85b-4bde-b9a7-55bf304ddcdc `
-Url https://tenant.api.identitynow.com/beta/workflows/execute/external/c79e0079-562c-4df5-aa73-60a9e25c916d ` -Url https://tenant.api.identitynow.com/beta/workflows/execute/external/c79e0079-562c-4df5-aa73-60a9e25c916d `
-CronString 0 9 * * 1 ` -CronString 0 9 * * 1 `
-Frequency null ` -Frequency daily `
-TimeZone America/Chicago ` -TimeZone America/Chicago `
-WeeklyDays Monday ` -WeeklyDays Monday `
-WeeklyTimes Monday -WeeklyTimes Monday `
-YearlyTimes 1969-12-31T09:00:00.000Z
``` ```
- Convert the resource to JSON - Convert the resource to JSON

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

@@ -814,6 +814,7 @@ $WorkflowBody = @"{
"displayName" : "displayName", "displayName" : "displayName",
"attributes" : { "attributes" : {
"description" : "Triggered when an identity's manager attribute changes", "description" : "Triggered when an identity's manager attribute changes",
"formDefinitionId" : "Admin_Access_Request_Form",
"attributeToFilter" : "LifecycleState", "attributeToFilter" : "LifecycleState",
"id" : "idn:identity-attributes-changed", "id" : "idn:identity-attributes-changed",
"filter.$" : "$.changes[?(@.attribute == 'manager')]" "filter.$" : "$.changes[?(@.attribute == 'manager')]"

4
docs/tools/sdk/powershell/Reference/V3/Models/EventAttributes.md
View File

@@ -20,6 +20,7 @@ Name | Type | Description | Notes
**VarFilter** | **String** | JSON path expression that will limit which events the trigger will fire on | [optional] **VarFilter** | **String** | JSON path expression that will limit which events the trigger will fire on | [optional]
**Description** | **String** | Description of the event trigger | [optional] **Description** | **String** | Description of the event trigger | [optional]
**AttributeToFilter** | **String** | The attribute to filter on | [optional] **AttributeToFilter** | **String** | The attribute to filter on | [optional]
**FormDefinitionId** | **String** | Form definition's unique identifier. | [optional]
## Examples ## Examples
@@ -28,7 +29,8 @@ Name | Type | Description | Notes
$EventAttributes = Initialize-PSSailpoint.V3EventAttributes -Id idn:identity-attributes-changed ` $EventAttributes = Initialize-PSSailpoint.V3EventAttributes -Id idn:identity-attributes-changed `
-VarFilter $.changes[?(@.attribute == 'manager')] ` -VarFilter $.changes[?(@.attribute == 'manager')] `
-Description Triggered when an identity's manager attribute changes ` -Description Triggered when an identity's manager attribute changes `
-AttributeToFilter LifecycleState -AttributeToFilter LifecycleState `
-FormDefinitionId Admin_Access_Request_Form
``` ```
- Convert the resource to JSON - Convert the resource to JSON

6
docs/tools/sdk/powershell/Reference/V3/Models/ScheduledAttributes.md
View File

@@ -21,16 +21,18 @@ Name | Type | Description | Notes
**TimeZone** | **String** | Time zone identifier | [optional] **TimeZone** | **String** | Time zone identifier | [optional]
**WeeklyDays** | **[]String** | Scheduled days of the week for execution | [optional] **WeeklyDays** | **[]String** | Scheduled days of the week for execution | [optional]
**WeeklyTimes** | **[]String** | Scheduled execution times | [optional] **WeeklyTimes** | **[]String** | Scheduled execution times | [optional]
**YearlyTimes** | **[]String** | Scheduled execution times | [optional]
## Examples ## Examples
- Prepare the resource - Prepare the resource
```powershell ```powershell
$ScheduledAttributes = Initialize-PSSailpoint.V3ScheduledAttributes -CronString 0 9 * * 1 ` $ScheduledAttributes = Initialize-PSSailpoint.V3ScheduledAttributes -CronString 0 9 * * 1 `
-Frequency null ` -Frequency daily `
-TimeZone America/Chicago ` -TimeZone America/Chicago `
-WeeklyDays Monday ` -WeeklyDays Monday `
-WeeklyTimes Monday -WeeklyTimes Monday `
-YearlyTimes 1969-12-31T09:00:00.000Z
``` ```
- Convert the resource to JSON - Convert the resource to JSON

8
docs/tools/sdk/powershell/Reference/V3/Models/WorkflowTriggerAttributes.md
View File

@@ -20,6 +20,7 @@ Name | Type | Description | Notes
**VarFilter** | **String** | JSON path expression that will limit which events the trigger will fire on | [optional] **VarFilter** | **String** | JSON path expression that will limit which events the trigger will fire on | [optional]
**Description** | **String** | Additonal context about the external trigger | [optional] **Description** | **String** | Additonal context about the external trigger | [optional]
**AttributeToFilter** | **String** | The attribute to filter on | [optional] **AttributeToFilter** | **String** | The attribute to filter on | [optional]
**FormDefinitionId** | **String** | Form definition's unique identifier. | [optional]
**Name** | **String** | A unique name for the external trigger | [optional] **Name** | **String** | A unique name for the external trigger | [optional]
**ClientId** | **String** | OAuth Client ID to authenticate with this trigger | [optional] **ClientId** | **String** | OAuth Client ID to authenticate with this trigger | [optional]
**Url** | **String** | URL to invoke this workflow | [optional] **Url** | **String** | URL to invoke this workflow | [optional]
@@ -28,6 +29,7 @@ Name | Type | Description | Notes
**TimeZone** | **String** | Time zone identifier | [optional] **TimeZone** | **String** | Time zone identifier | [optional]
**WeeklyDays** | **[]String** | Scheduled days of the week for execution | [optional] **WeeklyDays** | **[]String** | Scheduled days of the week for execution | [optional]
**WeeklyTimes** | **[]String** | Scheduled execution times | [optional] **WeeklyTimes** | **[]String** | Scheduled execution times | [optional]
**YearlyTimes** | **[]String** | Scheduled execution times | [optional]
## Examples ## Examples
@@ -37,14 +39,16 @@ $WorkflowTriggerAttributes = Initialize-PSSailpoint.V3WorkflowTriggerAttributes
-VarFilter $.changes[?(@.attribute == 'manager')] ` -VarFilter $.changes[?(@.attribute == 'manager')] `
-Description Run a search and notify the results ` -Description Run a search and notify the results `
-AttributeToFilter LifecycleState ` -AttributeToFilter LifecycleState `
-FormDefinitionId Admin_Access_Request_Form `
-Name search-and-notify ` -Name search-and-notify `
-ClientId 87e239b2-b85b-4bde-b9a7-55bf304ddcdc ` -ClientId 87e239b2-b85b-4bde-b9a7-55bf304ddcdc `
-Url https://tenant.api.identitynow.com/beta/workflows/execute/external/c79e0079-562c-4df5-aa73-60a9e25c916d ` -Url https://tenant.api.identitynow.com/beta/workflows/execute/external/c79e0079-562c-4df5-aa73-60a9e25c916d `
-CronString 0 9 * * 1 ` -CronString 0 9 * * 1 `
-Frequency null ` -Frequency daily `
-TimeZone America/Chicago ` -TimeZone America/Chicago `
-WeeklyDays Monday ` -WeeklyDays Monday `
-WeeklyTimes Monday -WeeklyTimes Monday `
-YearlyTimes 1969-12-31T09:00:00.000Z
``` ```
- Convert the resource to JSON - Convert the resource to JSON

4
static/code-examples/beta/powershell_code_examples_overlay.yaml
View File

@@ -14580,7 +14580,9 @@
"trigger" : { "trigger" : {
"displayName" : "displayName", "displayName" : "displayName",
"attributes" : { "attributes" : {
"description" : "description", "description" : "Triggered when an identity's manager attribute changes",
"formDefinitionId" : "Admin_Access_Request_Form",
"attributeToFilter" : "LifecycleState",
"id" : "idn:identity-attributes-changed", "id" : "idn:identity-attributes-changed",
"filter.$" : "$.changes[?(@.attribute == 'manager')]" "filter.$" : "$.changes[?(@.attribute == 'manager')]"
}, },

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

@@ -17513,6 +17513,7 @@
"displayName" : "displayName", "displayName" : "displayName",
"attributes" : { "attributes" : {
"description" : "Triggered when an identity's manager attribute changes", "description" : "Triggered when an identity's manager attribute changes",
"formDefinitionId" : "Admin_Access_Request_Form",
"attributeToFilter" : "LifecycleState", "attributeToFilter" : "LifecycleState",
"id" : "idn:identity-attributes-changed", "id" : "idn:identity-attributes-changed",
"filter.$" : "$.changes[?(@.attribute == 'manager')]" "filter.$" : "$.changes[?(@.attribute == 'manager')]"

1
static/code-examples/v3/powershell_code_examples_overlay.yaml
View File

@@ -10013,6 +10013,7 @@
"displayName" : "displayName", "displayName" : "displayName",
"attributes" : { "attributes" : {
"description" : "Triggered when an identity's manager attribute changes", "description" : "Triggered when an identity's manager attribute changes",
"formDefinitionId" : "Admin_Access_Request_Form",
"attributeToFilter" : "LifecycleState", "attributeToFilter" : "LifecycleState",
"id" : "idn:identity-attributes-changed", "id" : "idn:identity-attributes-changed",
"filter.$" : "$.changes[?(@.attribute == 'manager')]" "filter.$" : "$.changes[?(@.attribute == 'manager')]"