Update PowerShell SDK docs: 16148673912

2025-12-07 04:19:34 +00:00 · 2025-07-08 16:16:31 +00:00
parent 5bf98f5958
commit 16e520a919
5 changed files with 79 additions and 20 deletions
--- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025LifecycleStatesApi.md
+++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025LifecycleStatesApi.md
@@ -95,6 +95,9 @@ Code | Description  | Data Type
 ```powershell
 $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID.
 $LifecycleState = @"{
+  "accessActionConfiguration" : {
+    "removeAllAccessEnabled" : true
+  },
  "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ],
  "emailNotificationOption" : {
    "notifyManagers" : true,
@@ -103,21 +106,26 @@ $LifecycleState = @"{
    "notifyAllAdmins" : true
  },
  "created" : "2015-05-28T14:07:17Z",
+  "description" : "Lifecycle description",
+  "identityCount" : 42,
+  "priority" : 10,
+  "technicalName" : "Technical Name",
+  "identityState" : "INACTIVE_LONG_TERM",
+  "enabled" : true,
  "name" : "aName",
  "modified" : "2015-05-28T14:07:17Z",
-  "description" : "Lifecycle description",
  "accountActions" : [ {
+    "allSources" : true,
    "action" : "ENABLE",
+    "excludeSourceIds" : [ "3b551ccf5566478b9b77f37de25303aa" ],
    "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ]
  }, {
+    "allSources" : true,
    "action" : "ENABLE",
+    "excludeSourceIds" : [ "3b551ccf5566478b9b77f37de25303aa" ],
    "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ]
  } ],
-  "id" : "id12345",
-  "identityCount" : 42,
-  "technicalName" : "Technical Name",
-  "identityState" : "identityState",
-  "enabled" : true
+  "id" : "id12345"
 }"@

 # Create lifecycle state
@@ -136,7 +144,7 @@ try {
 [[Back to top]](#) 

 ## delete-lifecycle-state
-Use this endpoint to delete the lifecycle state by its ID. 
+Use this endpoint to delete the lifecycle state by its ID.

 [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-lifecycle-state)

@@ -184,7 +192,7 @@ try {
 [[Back to top]](#) 

 ## get-lifecycle-state
-Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. 
+Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID.

 [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-lifecycle-state)

@@ -343,7 +351,7 @@ Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
 Path   | IdentityProfileId | **String** | True  | Identity profile ID.
 Path   | LifecycleStateId | **String** | True  | Lifecycle state ID.
- Body  | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True  | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.  The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption 
+ Body  | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True  | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.  The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption * accessActionConfiguration * priority 

 ### Return type
 [**LifecycleState**](../models/lifecycle-state)
@@ -371,7 +379,7 @@ $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle stat
  "op" : "replace",
  "path" : "/description",
  "value" : "New description"
-}"@ # JsonPatchOperation[] | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.  The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption 
+}"@ # JsonPatchOperation[] | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.  The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption * accessActionConfiguration * priority 
 

 # Update lifecycle state
--- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessActionConfiguration.md
+++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessActionConfiguration.md
@@ -0,0 +1,35 @@
+---
+id: v2025-access-action-configuration
+title: AccessActionConfiguration
+pagination_label: AccessActionConfiguration
+sidebar_label: AccessActionConfiguration
+sidebar_class_name: powershellsdk
+keywords: ['powershell', 'PowerShell', 'sdk', 'AccessActionConfiguration', 'V2025AccessActionConfiguration'] 
+slug: /tools/sdk/powershell/v2025/models/access-action-configuration
+tags: ['SDK', 'Software Development Kit', 'AccessActionConfiguration', 'V2025AccessActionConfiguration']
+---
+
+
+# AccessActionConfiguration
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**RemoveAllAccessEnabled** | **Boolean** | If true, then all accesses are marked for removal. | [optional] [default to $false]
+
+## Examples
+
+- Prepare the resource
+```powershell
+$AccessActionConfiguration = Initialize-V2025AccessActionConfiguration  -RemoveAllAccessEnabled true
+```
+
+- Convert the resource to JSON
+```powershell
+$AccessActionConfiguration | ConvertTo-JSON
+```
+
+
+[[Back to top]](#) 
+
--- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccountAction.md
+++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountAction.md
@@ -17,14 +17,18 @@ tags: ['SDK', 'Software Development Kit', 'AccountAction', 'V2025AccountAction']
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Action** |  **Enum** [  "ENABLE",    "DISABLE" ] | Describes if action will be enabled or disabled | [optional] 
-**SourceIds** | **[]String** | List of unique source IDs. The sources must have the ENABLE feature or flat file source. See ""/sources"" endpoint for source features. | [optional] 
+**SourceIds** | **[]String** | A unique list of specific source IDs to apply the action to. The sources must have the ENABLE feature or flat file source. Required if allSources is not true. Must not be provided if allSources is true. Cannot be used together with excludeSourceIds See ""/sources"" endpoint for source features. | [optional] 
+**ExcludeSourceIds** | **[]String** | A list of source IDs to exclude from the action. Cannot be used together with sourceIds. | [optional] 
+**AllSources** | **Boolean** | If true, the action applies to all available sources. If true, sourceIds must not be provided. If false or not set, sourceIds is required. | [optional] [default to $false]

 ## Examples

 - Prepare the resource
 ```powershell
 $AccountAction = Initialize-V2025AccountAction  -Action ENABLE `
- -SourceIds [2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500]
+ -SourceIds [2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500] `
+ -ExcludeSourceIds [3b551ccf5566478b9b77f37de25303aa] `
+ -AllSources true
 ```

 - Convert the resource to JSON
--- a/docs/tools/sdk/powershell/Reference/V2025/Models/LifecycleState.md
+++ b/docs/tools/sdk/powershell/Reference/V2025/Models/LifecycleState.md
@@ -27,7 +27,9 @@ Name | Type | Description | Notes
 **EmailNotificationOption** | [**EmailNotificationOption**](email-notification-option) |  | [optional] 
 **AccountActions** | [**[]AccountAction**](account-action) |  | [optional] 
 **AccessProfileIds** | **[]String** | List of unique access-profile IDs that are associated with the lifecycle state. | [optional] 
-**IdentityState** | **String** | The lifecycle state's associated identity state. This field is generally 'null'. | [optional] 
+**IdentityState** |  **Enum** [  "ACTIVE",    "INACTIVE_SHORT_TERM",    "INACTIVE_LONG_TERM" ] | The lifecycle state's associated identity state. This field is generally 'null'. | [optional] 
+**AccessActionConfiguration** | [**AccessActionConfiguration**](access-action-configuration) |  | [optional] 
+**Priority** | **Int32** | Priority level used to determine which profile to assign when a user exists in multiple profiles. Lower numeric values have higher priority.  By default, new profiles are assigned the lowest priority. The assigned profile also controls access granted or removed during provisioning based on lifecycle state changes. | [optional] 

 ## Examples

@@ -44,7 +46,9 @@ $LifecycleState = Initialize-V2025LifecycleState  -Id id12345 `
 -EmailNotificationOption null `
 -AccountActions null `
 -AccessProfileIds [2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500] `
- -IdentityState null
+ -IdentityState INACTIVE_LONG_TERM `
+ -AccessActionConfiguration null `
+ -Priority 10
 ```

 - Convert the resource to JSON