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: 13843636109

Browse Source
This commit is contained in:
developer-relations-sp
2025-03-13 20:06:00 +00:00
parent ddc8e1ebe6
commit a62aa05c04
53 changed files with 323 additions and 284 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemApproverDto', 'BetaAccessIt
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "IDENTITY" ] | DTO type of identity who approved the access item request. | [optional]
**Id** | **String** | ID of identity who approved the access item request. | [optional]
**Name** | **String** | Human-readable display name of identity who approved the access item request. | [optional]
**Type** | **Enum** [ "IDENTITY" ] | DTO type of the identity who approved the access item request. | [optional]
**Id** | **String** | ID of the identity who approved the access item request. | [optional]
**Name** | **String** | Name of the identity who approved the access item request. | [optional]
## Examples

39
docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemRequestedForDto1.md Normal file
View File

@@ -0,0 +1,39 @@
---
id: beta-access-item-requested-for-dto1
title: AccessItemRequestedForDto1
pagination_label: AccessItemRequestedForDto1
sidebar_label: AccessItemRequestedForDto1
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemRequestedForDto1', 'BetaAccessItemRequestedForDto1']
slug: /tools/sdk/powershell/beta/models/access-item-requested-for-dto1
tags: ['SDK', 'Software Development Kit', 'AccessItemRequestedForDto1', 'BetaAccessItemRequestedForDto1']
---
# AccessItemRequestedForDto1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "IDENTITY" ] | DTO type of the identity whom the access item is requested for. | [optional]
**Id** | **String** | ID of the identity whom the access item is requested for. | [optional]
**Name** | **String** | Name of the identity whom the access item is requested for. | [optional]
## Examples
- Prepare the resource
```powershell
$AccessItemRequestedForDto1 = Initialize-PSSailpoint.BetaAccessItemRequestedForDto1 -Type IDENTITY `
-Id 2c4180a46faadee4016fb4e018c20626 `
-Name Robert Robinson
```
- Convert the resource to JSON
```powershell
$AccessItemRequestedForDto1 | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemRequesterDto1.md Normal file
View File

@@ -0,0 +1,39 @@
---
id: beta-access-item-requester-dto1
title: AccessItemRequesterDto1
pagination_label: AccessItemRequesterDto1
sidebar_label: AccessItemRequesterDto1
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemRequesterDto1', 'BetaAccessItemRequesterDto1']
slug: /tools/sdk/powershell/beta/models/access-item-requester-dto1
tags: ['SDK', 'Software Development Kit', 'AccessItemRequesterDto1', 'BetaAccessItemRequesterDto1']
---
# AccessItemRequesterDto1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "IDENTITY" ] | Access item requester's DTO type. | [optional]
**Id** | **String** | Access item requester's identity ID. | [optional]
**Name** | **String** | Access item requester's name. | [optional]
## Examples
- Prepare the resource
```powershell
$AccessItemRequesterDto1 = Initialize-PSSailpoint.BetaAccessItemRequesterDto1 -Type IDENTITY `
-Id 2c7180a46faadee4016fb4e018c20648 `
-Name William Wilson
```
- Convert the resource to JSON
```powershell
$AccessItemRequesterDto1 | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApprover', 'BetaA
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessRequestId** | **String** | The unique ID of the access request object. Can be used with the [access request status endpoint](https://developer.sailpoint.com/idn/api/beta/list-access-request-status) to get the status of the request. | [required]
**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required]
**RequestedItems** | [**[]AccessRequestDynamicApproverRequestedItemsInner**](access-request-dynamic-approver-requested-items-inner) | The access items that are being requested. | [required]
**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required]
**AccessRequestId** | **String** | Unique ID of the access request object. You can use this ID with the [Access Request Status endpoint](https://developer.sailpoint.com/idn/api/beta/list-access-request-status) to get the request's status. | [required]
**RequestedFor** | [**[]AccessItemRequestedForDto1**](access-item-requested-for-dto1) | Identities access was requested for. | [required]
**RequestedItems** | [**[]AccessRequestDynamicApproverRequestedItemsInner**](access-request-dynamic-approver-requested-items-inner) | Requested access items. | [required]
**RequestedBy** | [**AccessItemRequesterDto1**](access-item-requester-dto1) | | [required]
## Examples

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

@@ -16,12 +16,12 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApproverRequested
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | The unique ID of the access item. | [required]
**Name** | **String** | Human friendly name of the access item. | [required]
**Description** | **String** | Extended description of the access item. | [optional]
**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of access item being requested. | [required]
**Operation** | **Enum** [ "Add", "Remove" ] | Grant or revoke the access item | [required]
**Comment** | **String** | A comment from the requestor on why the access is needed. | [optional]
**Id** | **String** | Access item's unique identifier. | [required]
**Name** | **String** | Access item's name. | [required]
**Description** | **String** | Access item's extended description. | [optional]
**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | Type of access item being requested. | [required]
**Operation** | **Enum** [ "Add", "Remove" ] | Action to perform on the requested access item. | [required]
**Comment** | **String** | Comment from the requester about why the access is necessary. | [optional]
## Examples

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

@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApproval', 'BetaAcce
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessRequestId** | **String** | The unique ID of the access request. | [required]
**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required]
**RequestedItemsStatus** | [**[]AccessRequestPostApprovalRequestedItemsStatusInner**](access-request-post-approval-requested-items-status-inner) | Details on the outcome of each access item. | [required]
**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required]
**AccessRequestId** | **String** | Access request's unique ID. | [required]
**RequestedFor** | [**[]AccessItemRequestedForDto1**](access-item-requested-for-dto1) | Identities whom access was requested for. | [required]
**RequestedItemsStatus** | [**[]AccessRequestPostApprovalRequestedItemsStatusInner**](access-request-post-approval-requested-items-status-inner) | Details about the outcome of each requested access item. | [required]
**RequestedBy** | [**AccessItemRequesterDto1**](access-item-requester-dto1) | | [required]
## Examples

14
docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md
View File

@@ -16,14 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedIte
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | The unique ID of the access item being requested. | [required]
**Name** | **String** | The human friendly name of the access item. | [required]
**Description** | **String** | Detailed description of the access item. | [optional]
**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of access item. | [required]
**Operation** | **Enum** [ "Add", "Remove" ] | The action to perform on the access item. | [required]
**Comment** | **String** | A comment from the identity requesting the access. | [optional]
**Id** | **String** | Access item's unique ID. | [required]
**Name** | **String** | Access item's name. | [required]
**Description** | **String** | Access item's description. | [optional]
**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | Access item's type. | [required]
**Operation** | **Enum** [ "Add", "Remove" ] | Action to perform on the requested access item. | [required]
**Comment** | **String** | Comment from the identity requesting access. | [optional]
**ClientMetadata** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Additional customer defined metadata about the access item. | [optional]
**ApprovalInfo** | [**[]AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner**](access-request-post-approval-requested-items-status-inner-approval-info-inner) | A list of one or more approvers for the access request. | [required]
**ApprovalInfo** | [**[]AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner**](access-request-post-approval-requested-items-status-inner-approval-info-inner) | List of approvers for the access request. | [required]
## Examples

10
docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner.md
View File

@@ -16,16 +16,16 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedIte
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ApprovalComment** | **String** | A comment left by the approver. | [optional]
**ApprovalDecision** | **Enum** [ "APPROVED", "DENIED" ] | The final decision of the approver. | [required]
**ApproverName** | **String** | The name of the approver | [required]
**Approver** | [**AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover**](access-request-post-approval-requested-items-status-inner-approval-info-inner-approver) | | [required]
**ApprovalComment** | **String** | Approver's comment. | [optional]
**ApprovalDecision** | **Enum** [ "APPROVED", "DENIED" ] | Approver's final decision. | [required]
**ApproverName** | **String** | Approver's name. | [required]
**Approver** | [**AccessItemApproverDto**](access-item-approver-dto) | Approver's identity. | [required]
## Examples
- Prepare the resource
```powershell
$AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner = Initialize-PSSailpoint.BetaAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner -ApprovalComment This access looks good. Approved. `
$AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner = Initialize-PSSailpoint.BetaAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner -ApprovalComment This access looks good. Approved. `
-ApprovalDecision APPROVED `
-ApproverName Stephen.Austin `
-Approver null

39
docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md
View File

@@ -1,39 +0,0 @@
---
id: beta-access-request-post-approval-requested-items-status-inner-approval-info-inner-approver
title: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover
pagination_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover
sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover', 'BetaAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover']
slug: /tools/sdk/powershell/beta/models/access-request-post-approval-requested-items-status-inner-approval-info-inner-approver
tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover', 'BetaAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover']
---
# AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "IDENTITY" ] | The type of object that is referenced | [required]
**Id** | **String** | ID of identity who approved the access item request. | [required]
**Name** | **String** | Human-readable display name of identity who approved the access item request. | [required]
## Examples
- Prepare the resource
```powershell
$AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover = Initialize-PSSailpoint.BetaAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover -Type IDENTITY `
-Id 2c3780a46faadee4016fb4e018c20652 `
-Name Allen Albertson
```
- Convert the resource to JSON
```powershell
$AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApproval', 'BetaAcces
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessRequestId** | **String** | The unique ID of the access request. | [required]
**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required]
**RequestedItems** | [**[]AccessRequestPreApprovalRequestedItemsInner**](access-request-pre-approval-requested-items-inner) | Details of the access items being requested. | [required]
**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required]
**AccessRequestId** | **String** | Access request's unique ID. | [required]
**RequestedFor** | [**[]AccessItemRequestedForDto1**](access-item-requested-for-dto1) | Identities whom access was requested for. | [required]
**RequestedItems** | [**[]AccessRequestPreApprovalRequestedItemsInner**](access-request-pre-approval-requested-items-inner) | Details about each requested access item. | [required]
**RequestedBy** | [**AccessItemRequesterDto1**](access-item-requester-dto1) | | [required]
## Examples

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

@@ -16,12 +16,12 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApprovalRequestedItem
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | The unique ID of the access item being requested. | [required]
**Name** | **String** | The human friendly name of the access item. | [required]
**Description** | **String** | Detailed description of the access item. | [optional]
**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of access item. | [required]
**Operation** | **Enum** [ "Add", "Remove" ] | The action to perform on the access item. | [required]
**Comment** | **String** | A comment from the identity requesting the access. | [optional]
**Id** | **String** | Access item's unique ID. | [required]
**Name** | **String** | Access item's name. | [required]
**Description** | **String** | Access item's description. | [optional]
**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | Access item's type. | [required]
**Operation** | **Enum** [ "Add", "Remove" ] | Action to perform on the access item. | [required]
**Comment** | **String** | Comment from the identity requesting access. | [optional]
## Examples

10
docs/tools/sdk/powershell/Reference/Beta/Models/AccountAggregationCompleted.md
View File

@@ -17,11 +17,11 @@ tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompleted', 'BetaAc
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Source** | [**AccountAggregationCompletedSource**](account-aggregation-completed-source) | | [required]
**Status** | **Enum** [ "Success", "Failed", "Terminated" ] | The overall status of the aggregation. | [required]
**Started** | **System.DateTime** | The date and time when the account aggregation started. | [required]
**Completed** | **System.DateTime** | The date and time when the account aggregation finished. | [required]
**Errors** | **[]String** | A list of errors that occurred during the aggregation. | [required]
**Warnings** | **[]String** | A list of warnings that occurred during the aggregation. | [required]
**Status** | **Enum** [ "Success", "Failed", "Terminated" ] | Aggregation's overall status. | [required]
**Started** | **System.DateTime** | Date and time when the account aggregation started. | [required]
**Completed** | **System.DateTime** | Date and time when the account aggregation finished. | [required]
**Errors** | **[]String** | List of errors that occurred during the aggregation. | [required]
**Warnings** | **[]String** | List of warnings that occurred during the aggregation. | [required]
**Stats** | [**AccountAggregationCompletedStats**](account-aggregation-completed-stats) | | [required]
## Examples

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

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompletedSource', '
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "SOURCE" ] | The DTO type of the source the accounts are being aggregated from. | [required]
**Id** | **String** | The ID of the source the accounts are being aggregated from. | [required]
**Name** | **String** | Display name of the source the accounts are being aggregated from. | [required]
**Type** | **Enum** [ "SOURCE" ] | Source's DTO type. | [required]
**Id** | **String** | Source's unique ID. | [required]
**Name** | **String** | Source's name. | [required]
## Examples

10
docs/tools/sdk/powershell/Reference/Beta/Models/AccountAggregationCompletedStats.md
View File

@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompletedStats', 'B
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Scanned** | **Int32** | The number of accounts which were scanned / iterated over. | [required]
**Unchanged** | **Int32** | The number of accounts which existed before, but had no changes. | [required]
**Changed** | **Int32** | The number of accounts which existed before, but had changes. | [required]
**Added** | **Int32** | The number of accounts which are new - have not existed before. | [required]
**Removed** | **Int32** | The number accounts which existed before, but no longer exist (thus getting removed). | [required]
**Scanned** | **Int32** | Number of accounts scanned/iterated over. | [required]
**Unchanged** | **Int32** | Number of accounts that existed before but had no changes. | [required]
**Changed** | **Int32** | Number of accounts that existed before but had changes. | [required]
**Added** | **Int32** | Number of accounts that are new and didn't previously exist. | [required]
**Removed** | **Int32** | Number accounts that existed before but were removed and no longer exist. | [required]
## Examples

16
docs/tools/sdk/powershell/Reference/Beta/Models/CampaignActivatedCampaign.md
View File

@@ -16,15 +16,15 @@ tags: ['SDK', 'Software Development Kit', 'CampaignActivatedCampaign', 'BetaCamp
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | Unique ID for the campaign. | [required]
**Name** | **String** | The human friendly name of the campaign. | [required]
**Description** | **String** | Extended description of the campaign. | [required]
**Created** | **System.DateTime** | The date and time the campaign was created. | [required]
**Modified** | **System.DateTime** | The date and time the campaign was last modified. | [optional]
**Deadline** | **System.DateTime** | The date and time the campaign is due. | [required]
**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION" ] | The type of campaign. | [required]
**Id** | **String** | Campaign's unique ID. | [required]
**Name** | **String** | Campaign's name. | [required]
**Description** | **String** | Campaign's extended description. | [required]
**Created** | **System.DateTime** | Date and time when the campaign was created. | [required]
**Modified** | **System.DateTime** | Date and time when the campaign was last modified. | [optional]
**Deadline** | **System.DateTime** | Date and time when the campaign is due. | [required]
**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION" ] | Campaign's type. | [required]
**CampaignOwner** | [**CampaignActivatedCampaignCampaignOwner**](campaign-activated-campaign-campaign-owner) | | [required]
**Status** | **Enum** [ "ACTIVE" ] | The current status of the campaign. | [required]
**Status** | **Enum** [ "ACTIVE" ] | Campaign's current status. | [required]
## Examples

10
docs/tools/sdk/powershell/Reference/Beta/Models/CampaignActivatedCampaignCampaignOwner.md
View File

@@ -16,17 +16,17 @@ tags: ['SDK', 'Software Development Kit', 'CampaignActivatedCampaignCampaignOwne
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | The unique ID of the identity. | [required]
**DisplayName** | **String** | The human friendly name of the identity. | [required]
**Email** | **String** | The primary email address of the identity. | [required]
**Id** | **String** | Identity's unique ID. | [required]
**DisplayName** | **String** | Identity's name. | [required]
**Email** | **String** | Identity's primary email address. | [required]
## Examples
- Prepare the resource
```powershell
$CampaignActivatedCampaignCampaignOwner = Initialize-PSSailpoint.BetaCampaignActivatedCampaignCampaignOwner -Id 37f080867702c1910177031320c40n27 `
-DisplayName John Snow `
-Email john.snow@example.com
-DisplayName Albert Albertson `
-Email albert.albertson@example.com
```
- Convert the resource to JSON

16
docs/tools/sdk/powershell/Reference/Beta/Models/CampaignEndedCampaign.md
View File

@@ -16,15 +16,15 @@ tags: ['SDK', 'Software Development Kit', 'CampaignEndedCampaign', 'BetaCampaign
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | Unique ID for the campaign. | [required]
**Name** | **String** | The human friendly name of the campaign. | [required]
**Description** | **String** | Extended description of the campaign. | [required]
**Created** | **System.DateTime** | The date and time the campaign was created. | [required]
**Modified** | **System.DateTime** | The date and time the campaign was last modified. | [optional]
**Deadline** | **System.DateTime** | The date and time the campaign is due. | [required]
**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION" ] | The type of campaign. | [required]
**Id** | **String** | Campaign's unique ID for the campaign. | [required]
**Name** | **String** | Campaign's unique ID. | [required]
**Description** | **String** | Campaign's extended description. | [required]
**Created** | **System.DateTime** | Date and time when the campaign was created. | [required]
**Modified** | **System.DateTime** | Date and time when the campaign was last modified. | [optional]
**Deadline** | **System.DateTime** | Date and time when the campaign is due. | [required]
**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION" ] | Campaign's type. | [required]
**CampaignOwner** | [**CampaignActivatedCampaignCampaignOwner**](campaign-activated-campaign-campaign-owner) | | [required]
**Status** | **Enum** [ "COMPLETED" ] | The current status of the campaign. | [required]
**Status** | **Enum** [ "COMPLETED" ] | Campaign's current status. | [required]
## Examples

16
docs/tools/sdk/powershell/Reference/Beta/Models/CampaignGeneratedCampaign.md
View File

@@ -16,15 +16,15 @@ tags: ['SDK', 'Software Development Kit', 'CampaignGeneratedCampaign', 'BetaCamp
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | The unique ID of the campaign. | [required]
**Name** | **String** | Human friendly name of the campaign. | [required]
**Description** | **String** | Extended description of the campaign. | [required]
**Created** | **System.DateTime** | The date and time the campaign was created. | [required]
**Modified** | **String** | The date and time the campaign was last modified. | [optional]
**Deadline** | **String** | The date and time when the campaign must be finished by. | [optional]
**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION" ] | The type of campaign that was generated. | [required]
**Id** | **String** | Campaign's unique ID. | [required]
**Name** | **String** | Campaign's name. | [required]
**Description** | **String** | Campaign's extended description. | [required]
**Created** | **System.DateTime** | Date and time when the campaign was created. | [required]
**Modified** | **String** | Date and time when the campaign was last modified. | [optional]
**Deadline** | **String** | Date and time when the campaign must be finished. | [optional]
**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION" ] | Campaign's type. | [required]
**CampaignOwner** | [**CampaignGeneratedCampaignCampaignOwner**](campaign-generated-campaign-campaign-owner) | | [required]
**Status** | **Enum** [ "STAGED", "ACTIVATING", "ACTIVE" ] | The current status of the campaign. | [required]
**Status** | **Enum** [ "STAGED", "ACTIVATING", "ACTIVE" ] | Campaign's current status. | [required]
## Examples

10
docs/tools/sdk/powershell/Reference/Beta/Models/CampaignGeneratedCampaignCampaignOwner.md
View File

@@ -16,17 +16,17 @@ tags: ['SDK', 'Software Development Kit', 'CampaignGeneratedCampaignCampaignOwne
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | The unique ID of the identity. | [required]
**DisplayName** | **String** | The display name of the identity. | [required]
**Email** | **String** | The primary email address of the identity. | [required]
**Id** | **String** | Identity's unique ID. | [required]
**DisplayName** | **String** | Identity's name. | [required]
**Email** | **String** | Identity's primary email address. | [required]
## Examples
- Prepare the resource
```powershell
$CampaignGeneratedCampaignCampaignOwner = Initialize-PSSailpoint.BetaCampaignGeneratedCampaignCampaignOwner -Id 37f080867702c1910177031320c40n27 `
-DisplayName John Snow `
-Email john.snow@example.com
-DisplayName Albert Albertson `
-Email albert.albertson@example.com
```
- Convert the resource to JSON

18
docs/tools/sdk/powershell/Reference/Beta/Models/CertificationDto.md
View File

@@ -18,17 +18,17 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**CampaignRef** | [**CampaignReference**](campaign-reference) | | [required]
**Phase** | [**CertificationPhase**](certification-phase) | | [required]
**Due** | **System.DateTime** | The due date of the certification. | [required]
**Signed** | **System.DateTime** | The date the reviewer signed off on the certification. | [required]
**Due** | **System.DateTime** | Date and time when the certification is due. | [required]
**Signed** | **System.DateTime** | Date and time when the reviewer signed off on the certification. | [required]
**Reviewer** | [**Reviewer**](reviewer) | | [required]
**Reassignment** | [**Reassignment**](reassignment) | | [optional]
**HasErrors** | **Boolean** | Indicates it the certification has any errors. | [required]
**ErrorMessage** | **String** | A message indicating what the error is. | [optional]
**Completed** | **Boolean** | Indicates if all certification decisions have been made. | [required]
**DecisionsMade** | **Int32** | The number of approve/revoke/acknowledge decisions that have been made by the reviewer. | [required]
**DecisionsTotal** | **Int32** | The total number of approve/revoke/acknowledge decisions for the certification. | [required]
**EntitiesCompleted** | **Int32** | The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. | [required]
**EntitiesTotal** | **Int32** | The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. | [required]
**HasErrors** | **Boolean** | Indicates whether the certification has any errors. | [required]
**ErrorMessage** | **String** | Message indicating what the error is. | [optional]
**Completed** | **Boolean** | Indicates whether all certification decisions have been made. | [required]
**DecisionsMade** | **Int32** | Number of approve/revoke/acknowledge decisions the reviewer has made. | [required]
**DecisionsTotal** | **Int32** | Total number of approve/revoke/acknowledge decisions for the certification. | [required]
**EntitiesCompleted** | **Int32** | Number of entities (identities, access profiles, roles, etc.) that are complete and all decisions have been made for. | [required]
**EntitiesTotal** | **Int32** | Total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. | [required]
## Examples

26
docs/tools/sdk/powershell/Reference/Beta/Models/CertificationSignedOffCertification.md
View File

@@ -16,23 +16,23 @@ tags: ['SDK', 'Software Development Kit', 'CertificationSignedOffCertification',
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | Unique ID of the certification. | [required]
**Name** | **String** | The name of the certification. | [required]
**Created** | **System.DateTime** | The date and time the certification was created. | [required]
**Modified** | **System.DateTime** | The date and time the certification was last modified. | [optional]
**Id** | **String** | Certification's unique ID. | [required]
**Name** | **String** | Certification's name. | [required]
**Created** | **System.DateTime** | Date and time when the certification was created. | [required]
**Modified** | **System.DateTime** | Date and time when the certification was last modified. | [optional]
**CampaignRef** | [**CampaignReference**](campaign-reference) | | [required]
**Phase** | [**CertificationPhase**](certification-phase) | | [required]
**Due** | **System.DateTime** | The due date of the certification. | [required]
**Signed** | **System.DateTime** | The date the reviewer signed off on the certification. | [required]
**Due** | **System.DateTime** | Date and time when the certification is due. | [required]
**Signed** | **System.DateTime** | Date and time when the reviewer signed off on the certification. | [required]
**Reviewer** | [**Reviewer**](reviewer) | | [required]
**Reassignment** | [**Reassignment**](reassignment) | | [optional]
**HasErrors** | **Boolean** | Indicates it the certification has any errors. | [required]
**ErrorMessage** | **String** | A message indicating what the error is. | [optional]
**Completed** | **Boolean** | Indicates if all certification decisions have been made. | [required]
**DecisionsMade** | **Int32** | The number of approve/revoke/acknowledge decisions that have been made by the reviewer. | [required]
**DecisionsTotal** | **Int32** | The total number of approve/revoke/acknowledge decisions for the certification. | [required]
**EntitiesCompleted** | **Int32** | The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. | [required]
**EntitiesTotal** | **Int32** | The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. | [required]
**HasErrors** | **Boolean** | Indicates whether the certification has any errors. | [required]
**ErrorMessage** | **String** | Message indicating what the error is. | [optional]
**Completed** | **Boolean** | Indicates whether all certification decisions have been made. | [required]
**DecisionsMade** | **Int32** | Number of approve/revoke/acknowledge decisions the reviewer has made. | [required]
**DecisionsTotal** | **Int32** | Total number of approve/revoke/acknowledge decisions for the certification. | [required]
**EntitiesCompleted** | **Int32** | Number of entities (identities, access profiles, roles, etc.) that are complete and all decisions have been made for. | [required]
**EntitiesTotal** | **Int32** | Total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. | [required]
## Examples

2
docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributesChanged.md
View File

@@ -17,7 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChanged', 'BetaIden
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Identity** | [**IdentityAttributesChangedIdentity**](identity-attributes-changed-identity) | | [required]
**Changes** | [**[]IdentityAttributesChangedChangesInner**](identity-attributes-changed-changes-inner) | A list of one or more identity attributes that changed on the identity. | [required]
**Changes** | [**[]IdentityAttributesChangedChangesInner**](identity-attributes-changed-changes-inner) | List of identity's attributes that changed. | [required]
## Examples

2
docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributesChangedChangesInner.md
View File

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInner
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Attribute** | **String** | The name of the identity attribute that changed. | [required]
**Attribute** | **String** | Identity attribute's name. | [required]
**OldValue** | [**IdentityAttributesChangedChangesInnerOldValue**](identity-attributes-changed-changes-inner-old-value) | | [optional]
**NewValue** | [**IdentityAttributesChangedChangesInnerNewValue**](identity-attributes-changed-changes-inner-new-value) | | [optional]

2
docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributesChangedIdentity.md
View File

@@ -18,7 +18,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "IDENTITY" ] | DTO type of identity whose attributes changed. | [required]
**Id** | **String** | ID of identity whose attributes changed. | [required]
**Name** | **String** | Display name of identity whose attributes changed. | [required]
**Name** | **String** | Name of identity whose attributes changed. | [required]
## Examples

2
docs/tools/sdk/powershell/Reference/Beta/Models/IdentityCreated.md
View File

@@ -17,7 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityCreated', 'BetaIdentityCreate
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Identity** | [**IdentityCreatedIdentity**](identity-created-identity) | | [required]
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes assigned to the identity. Attributes are determined by the identity profile. | [required]
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Attributes assigned to the identity. These attributes are determined by the identity profile. | [required]
## Examples

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

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityCreatedIdentity', 'BetaIdenti
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "IDENTITY" ] | Created identity's DTO type. | [required]
**Id** | **String** | Created identity ID. | [required]
**Name** | **String** | Created identity's display name. | [required]
**Type** | **Enum** [ "IDENTITY" ] | Identity's DTO type. | [required]
**Id** | **String** | Identity's unique ID. | [required]
**Name** | **String** | Identity's name. | [required]
## Examples

2
docs/tools/sdk/powershell/Reference/Beta/Models/IdentityDeleted.md
View File

@@ -17,7 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityDeleted', 'BetaIdentityDelete
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Identity** | [**IdentityDeletedIdentity**](identity-deleted-identity) | | [required]
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes assigned to the identity. Attributes are determined by the identity profile. | [required]
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Identity attributes. The attributes are determined by the identity profile. | [required]
## Examples

2
docs/tools/sdk/powershell/Reference/Beta/Models/IdentityDeletedIdentity.md
View File

@@ -18,7 +18,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "IDENTITY" ] | Deleted identity's DTO type. | [required]
**Id** | **String** | Deleted identity ID. | [required]
**Name** | **String** | Deleted identity's display name. | [required]
**Name** | **String** | Deleted identity's name. | [required]
## Examples

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

@@ -16,14 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCompleted', 'BetaProvisio
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**TrackingNumber** | **String** | The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface. | [required]
**Sources** | **String** | One or more sources that the provisioning transaction(s) were done against. Sources are comma separated. | [required]
**Action** | **String** | Origin of where the provisioning request came from. | [optional]
**Errors** | **[]String** | A list of any accumulated error messages that occurred during provisioning. | [optional]
**Warnings** | **[]String** | A list of any accumulated warning messages that occurred during provisioning. | [optional]
**TrackingNumber** | **String** | Provisioning request's reference number. Useful for tracking status in the 'Account Activity' search interface. | [required]
**Sources** | **String** | Sources the provisioning transactions were performed on. Sources are comma separated. | [required]
**Action** | **String** | Origin of the provisioning request. | [optional]
**Errors** | **[]String** | List of any accumulated error messages that occurred during provisioning. | [optional]
**Warnings** | **[]String** | List of any accumulated warning messages that occurred during provisioning. | [optional]
**Recipient** | [**ProvisioningCompletedRecipient**](provisioning-completed-recipient) | | [required]
**Requester** | [**ProvisioningCompletedRequester**](provisioning-completed-requester) | | [optional]
**AccountRequests** | [**[]ProvisioningCompletedAccountRequestsInner**](provisioning-completed-account-requests-inner) | A list of provisioning instructions to perform on an account-by-account basis. | [required]
**AccountRequests** | [**[]ProvisioningCompletedAccountRequestsInner**](provisioning-completed-account-requests-inner) | List of provisioning instructions to perform on an account-by-account basis. | [required]
## Examples

14
docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInner.md
View File

@@ -17,19 +17,19 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsI
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Source** | [**ProvisioningCompletedAccountRequestsInnerSource**](provisioning-completed-account-requests-inner-source) | | [required]
**AccountId** | **String** | The unique idenfier of the account being provisioned. | [optional]
**AccountOperation** | **String** | The provisioning operation; typically Create, Modify, Enable, Disable, Unlock, or Delete. | [required]
**ProvisioningResult** | **Enum** [ "SUCCESS", "PENDING", "FAILED" ] | The overall result of the provisioning transaction; this could be success, pending, failed, etc. | [required]
**ProvisioningTarget** | **String** | The name of the provisioning channel selected; this could be the same as the source, or could be a Service Desk Integration Module (SDIM). | [required]
**TicketId** | **String** | A reference to a tracking number, if this is sent to a Service Desk Integration Module (SDIM). | [optional]
**AttributeRequests** | [**[]ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner**](provisioning-completed-account-requests-inner-attribute-requests-inner) | A list of attributes as part of the provisioning transaction. | [optional]
**AccountId** | **String** | Unique idenfier of the account being provisioned. | [optional]
**AccountOperation** | **Enum** [ "Create", "Modify", "Enable", "Disable", "Unlock", "Delete" ] | Provisioning operation. | [required]
**ProvisioningResult** | **Enum** [ "SUCCESS", "PENDING", "FAILED" ] | Overall result of the provisioning transaction. | [required]
**ProvisioningTarget** | **String** | Nme of the selected provisioning channel selected. This could be the same as the source, or it could be a Service Desk Integration Module (SDIM). | [required]
**TicketId** | **String** | Reference to a tracking number for if this is sent to a SDIM. | [optional]
**AttributeRequests** | [**[]ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner**](provisioning-completed-account-requests-inner-attribute-requests-inner) | List of attributes to include in the provisioning transaction. | [optional]
## Examples
- Prepare the resource
```powershell
$ProvisioningCompletedAccountRequestsInner = Initialize-PSSailpoint.BetaProvisioningCompletedAccountRequestsInner -Source null `
-AccountId CN=Chewy.Bacca,ou=hardcorefigter,ou=wookies,dc=starwars,dc=com `
-AccountId CN=Rob.Robertson,ou=csm,ou=sales,dc=helpco,dc=com `
-AccountOperation Modify `
-ProvisioningResult SUCCESS `
-ProvisioningTarget Corp AD `

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

@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsI
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AttributeName** | **String** | The name of the attribute being provisioned. | [required]
**AttributeValue** | **String** | The value of the attribute being provisioned. | [optional]
**AttributeName** | **String** | Name of the attribute being provisioned. | [required]
**AttributeValue** | **String** | Value of the attribute being provisioned. | [optional]
**Operation** | **Enum** [ "Add", "Set", "Remove" ] | The operation to handle the attribute. | [required]
## Examples
@@ -25,7 +25,7 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner = Initialize-PSSailpoint.BetaProvisioningCompletedAccountRequestsInnerAttributeRequestsInner -AttributeName memberOf `
-AttributeValue CN=jedi,DC=starwars,DC=com `
-AttributeValue CN=sales,DC=helpco,DC=com `
-Operation Add
```

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

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsI
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | ID of the object to which this reference applies | [required]
**Type** | **Enum** [ "SOURCE" ] | The type of object that is referenced | [required]
**Name** | **String** | Human-readable display name of the object to which this reference applies | [required]
**Id** | **String** | Source ID. | [required]
**Type** | **Enum** [ "SOURCE" ] | Source DTO type. | [required]
**Name** | **String** | Source name. | [required]
## Examples

2
docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCompletedRecipient.md
View File

@@ -18,7 +18,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "IDENTITY" ] | Provisioning recipient DTO type. | [required]
**Id** | **String** | Provisioning recipient's identity ID. | [required]
**Name** | **String** | Provisioning recipient's display name. | [required]
**Name** | **String** | Provisioning recipient's name. | [required]
## Examples

2
docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCompletedRequester.md
View File

@@ -18,7 +18,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "IDENTITY" ] | Provisioning requester's DTO type. | [required]
**Id** | **String** | Provisioning requester's identity ID. | [required]
**Name** | **String** | Provisioning owner's human-readable display name. | [required]
**Name** | **String** | Provisioning requester's name. | [required]
## Examples

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

@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'Reviewer', 'BetaReviewer']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "IDENTITY", "GOVERNANCE_GROUP" ] | The reviewer's DTO type. | [required]
**Id** | **String** | The reviewer's ID. | [required]
**Name** | **String** | The reviewer's display name. | [required]
**Email** | **String** | The reviewing identity's email. Only applicable to `IDENTITY`. | [optional]
**Type** | **Enum** [ "IDENTITY", "GOVERNANCE_GROUP" ] | Reviewer's DTO type. | [required]
**Id** | **String** | Reviewer's ID. | [required]
**Name** | **String** | Reviewer's display name. | [required]
**Email** | **String** | Reviewing identity's email. This is only applicable to reviewers of the `IDENTITY` type. | [optional]
## Examples

10
docs/tools/sdk/powershell/Reference/Beta/Models/SavedSearchComplete.md
View File

@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'SavedSearchComplete', 'BetaSavedSearc
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**FileName** | **String** | A name for the report file. | [required]
**OwnerEmail** | **String** | The email address of the identity that owns the saved search. | [required]
**OwnerName** | **String** | The name of the identity that owns the saved search. | [required]
**Query** | **String** | The search query that was used to generate the report. | [required]
**SearchName** | **String** | The name of the saved search. | [required]
**FileName** | **String** | Report file name. | [required]
**OwnerEmail** | **String** | Email address of the identity who owns the saved search. | [required]
**OwnerName** | **String** | Name of the identity who owns the saved search. | [required]
**Query** | **String** | Search query used to generate the report. | [required]
**SearchName** | **String** | Saved search name. | [required]
**SearchResults** | [**SavedSearchCompleteSearchResults**](saved-search-complete-search-results) | | [required]
**SignedS3Url** | **String** | The Amazon S3 URL to download the report from. | [required]

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

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsAccou
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Count** | **String** | The number of rows in the table. | [required]
**Noun** | **String** | The type of object represented in the table. | [required]
**Preview** | **[]String[]** | A sample of the data in the table. | [required]
**Count** | **String** | Number of rows in the table. | [required]
**Noun** | **String** | Type of object represented in the table. | [required]
**Preview** | **[]String[]** | Sample of table data. | [required]
## Examples

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

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsEntit
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Count** | **String** | The number of rows in the table. | [required]
**Noun** | **String** | The type of object represented in the table. | [required]
**Preview** | **[]String[]** | A sample of the data in the table. | [required]
**Count** | **String** | Number of rows in the table. | [required]
**Noun** | **String** | Type of object represented in the table. | [required]
**Preview** | **[]String[]** | Sample of table data. | [required]
## Examples

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

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsIdent
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Count** | **String** | The number of rows in the table. | [required]
**Noun** | **String** | The type of object represented in the table. | [required]
**Preview** | **[]String[]** | A sample of the data in the table. | [required]
**Count** | **String** | Number of rows in the table. | [required]
**Noun** | **String** | Type of object represented in the table. | [required]
**Preview** | **[]String[]** | Sample of the table data. | [required]
## Examples

14
docs/tools/sdk/powershell/Reference/Beta/Models/SourceAccountCreated.md
View File

@@ -16,14 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'SourceAccountCreated', 'BetaSourceAcc
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Uuid** | **String** | Source unique identifier for the identity. UUID is generated by the source system. | [optional]
**Uuid** | **String** | Identity's universal unique identifier (UUID) on the source. The source system generates the UUID. | [required]
**Id** | **String** | SailPoint generated unique identifier. | [required]
**NativeIdentifier** | **String** | Unique ID of the account on the source. | [required]
**SourceId** | **String** | The ID of the source. | [required]
**SourceName** | **String** | The name of the source. | [required]
**IdentityId** | **String** | The ID of the identity that is correlated with this account. | [required]
**IdentityName** | **String** | The name of the identity that is correlated with this account. | [required]
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes of the account. The contents of attributes depends on the account schema for the source. | [required]
**NativeIdentifier** | **String** | Account's unique ID on the source. | [required]
**SourceId** | **String** | Source ID. | [required]
**SourceName** | **String** | Source name. | [required]
**IdentityId** | **String** | ID of the identity correlated with the account. | [required]
**IdentityName** | **String** | Name of the identity correlated with the account. | [required]
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Account attributes. The attributes' contents depend on the source's account schema. | [required]
## Examples

14
docs/tools/sdk/powershell/Reference/Beta/Models/SourceAccountDeleted.md
View File

@@ -16,14 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'SourceAccountDeleted', 'BetaSourceAcc
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Uuid** | **String** | Source unique identifier for the identity. UUID is generated by the source system. | [optional]
**Uuid** | **String** | Identity's universal unique identifier (UUID) on the source. The source system generates the UUID. | [required]
**Id** | **String** | SailPoint generated unique identifier. | [required]
**NativeIdentifier** | **String** | Unique ID of the account on the source. | [required]
**SourceId** | **String** | The ID of the source. | [required]
**SourceName** | **String** | The name of the source. | [required]
**IdentityId** | **String** | The ID of the identity that is correlated with this account. | [required]
**IdentityName** | **String** | The name of the identity that is correlated with this account. | [required]
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes of the account. The contents of attributes depends on the account schema for the source. | [required]
**NativeIdentifier** | **String** | Account's unique ID on the source. | [required]
**SourceId** | **String** | Source ID. | [required]
**SourceName** | **String** | Source name. | [required]
**IdentityId** | **String** | ID of the identity correlated with the account. | [required]
**IdentityName** | **String** | Name of the identity correlated with the account. | [required]
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Account attributes. The attributes' contents depend on the source's account schema. | [required]
## Examples

14
docs/tools/sdk/powershell/Reference/Beta/Models/SourceAccountUpdated.md
View File

@@ -16,14 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'SourceAccountUpdated', 'BetaSourceAcc
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Uuid** | **String** | Source unique identifier for the identity. UUID is generated by the source system. | [optional]
**Uuid** | **String** | Identity's universal unique identifier (UUID) on the source. The source system generates the UUID. | [required]
**Id** | **String** | SailPoint generated unique identifier. | [required]
**NativeIdentifier** | **String** | Unique ID of the account on the source. | [required]
**SourceId** | **String** | The ID of the source. | [required]
**SourceName** | **String** | The name of the source. | [required]
**IdentityId** | **String** | The ID of the identity that is correlated with this account. | [required]
**IdentityName** | **String** | The name of the identity that is correlated with this account. | [required]
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes of the account. The contents of attributes depends on the account schema for the source. | [required]
**NativeIdentifier** | **String** | Account's unique ID on the source. | [required]
**SourceId** | **String** | Source ID. | [required]
**SourceName** | **String** | Source name. | [required]
**IdentityId** | **String** | ID of the identity correlated with the account. | [required]
**IdentityName** | **String** | Name of the identity correlated with the account. | [required]
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Account attributes. The attributes' contents depend on the source's account schema. | [required]
## Examples

10
docs/tools/sdk/powershell/Reference/Beta/Models/SourceCreated.md
View File

@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'SourceCreated', 'BetaSourceCreated']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | The unique ID of the source. | [required]
**Name** | **String** | Human friendly name of the source. | [required]
**Type** | **String** | The connection type. | [required]
**Created** | **System.DateTime** | The date and time the source was created. | [required]
**Connector** | **String** | The connector type used to connect to the source. | [required]
**Id** | **String** | Source's unique ID. | [required]
**Name** | **String** | Source name. | [required]
**Type** | **String** | Connection type. | [required]
**Created** | **System.DateTime** | Date and time when the source was created. | [required]
**Connector** | **String** | Connector type used to connect to the source. | [required]
**Actor** | [**SourceCreatedActor**](source-created-actor) | | [required]
## Examples

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

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'SourceCreatedActor', 'BetaSourceCreat
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "IDENTITY" ] | DTO type of identity who created the source. | [required]
**Id** | **String** | ID of identity who created the source. | [required]
**Name** | **String** | Display name of identity who created the source. | [required]
**Type** | **Enum** [ "IDENTITY" ] | DTO type of the identity who created the source. | [required]
**Id** | **String** | ID of the identity who created the source. | [required]
**Name** | **String** | Name of the identity who created the source. | [required]
## Examples

10
docs/tools/sdk/powershell/Reference/Beta/Models/SourceDeleted.md
View File

@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'SourceDeleted', 'BetaSourceDeleted']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | The unique ID of the source. | [required]
**Name** | **String** | Human friendly name of the source. | [required]
**Type** | **String** | The connection type. | [required]
**Deleted** | **System.DateTime** | The date and time the source was deleted. | [required]
**Connector** | **String** | The connector type used to connect to the source. | [required]
**Id** | **String** | Source's unique ID. | [required]
**Name** | **String** | Source name. | [required]
**Type** | **String** | Connection type. | [required]
**Deleted** | **System.DateTime** | Date and time when the source was deleted. | [required]
**Connector** | **String** | Connector type used to connect to the source. | [required]
**Actor** | [**SourceDeletedActor**](source-deleted-actor) | | [required]
## Examples

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

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'SourceDeletedActor', 'BetaSourceDelet
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "IDENTITY" ] | DTO type of identity who deleted the source. | [required]
**Id** | **String** | ID of identity who deleted the source. | [required]
**Name** | **String** | Display name of identity who deleted the source. | [required]
**Type** | **Enum** [ "IDENTITY" ] | DTO type of the identity who deleted the source. | [required]
**Id** | **String** | ID of the identity who deleted the source. | [required]
**Name** | **String** | Name of the identity who deleted the source. | [required]
## Examples

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

@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'SourceUpdated', 'BetaSourceUpdated']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | The unique ID of the source. | [required]
**Name** | **String** | The user friendly name of the source. | [required]
**Type** | **String** | The connection type of the source. | [required]
**Modified** | **System.DateTime** | The date and time the source was modified. | [required]
**Connector** | **String** | The connector type used to connect to the source. | [required]
**Id** | **String** | Source's unique ID. | [required]
**Name** | **String** | Source name. | [required]
**Type** | **String** | Connection type. | [required]
**Modified** | **System.DateTime** | Date and time when the source was modified. | [required]
**Connector** | **String** | Connector type used to connect to the source. | [required]
**Actor** | [**SourceUpdatedActor**](source-updated-actor) | | [required]
## Examples
@@ -28,7 +28,7 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$SourceUpdated = Initialize-PSSailpoint.BetaSourceUpdated -Id 2c9180866166b5b0016167c32ef31a66 `
-Name Corporate Active Directory `
-Name Test source `
-Type DIRECT_CONNECT `
-Modified 2021-03-29T22:01:50.474Z `
-Connector active-directory `

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

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'SourceUpdatedActor', 'BetaSourceUpdat
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "IDENTITY" ] | DTO type of identity who updated the source. | [required]
**Id** | **String** | ID of identity who updated the source. | [optional]
**Name** | **String** | Display name of identity who updated the source. | [required]
**Type** | **Enum** [ "IDENTITY" ] | DTO type of the identity who updated the source. | [required]
**Id** | **String** | ID of the identity who updated the source. | [required]
**Name** | **String** | Name of the identity who updated the source. | [required]
## Examples

64
docs/tools/sdk/powershell/Reference/Beta/Models/TriggerExampleInput.md
View File

@@ -16,52 +16,52 @@ tags: ['SDK', 'Software Development Kit', 'TriggerExampleInput', 'BetaTriggerExa
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessRequestId** | **String** | The unique ID of the access request. | [required]
**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required]
**RequestedItems** | [**[]AccessRequestPreApprovalRequestedItemsInner**](access-request-pre-approval-requested-items-inner) | Details of the access items being requested. | [required]
**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required]
**RequestedItemsStatus** | [**[]AccessRequestPostApprovalRequestedItemsStatusInner**](access-request-post-approval-requested-items-status-inner) | Details on the outcome of each access item. | [required]
**AccessRequestId** | **String** | Access request's unique ID. | [required]
**RequestedFor** | [**[]AccessItemRequestedForDto1**](access-item-requested-for-dto1) | Identities whom access was requested for. | [required]
**RequestedItems** | [**[]AccessRequestPreApprovalRequestedItemsInner**](access-request-pre-approval-requested-items-inner) | Details about each requested access item. | [required]
**RequestedBy** | [**AccessItemRequesterDto1**](access-item-requester-dto1) | | [required]
**RequestedItemsStatus** | [**[]AccessRequestPostApprovalRequestedItemsStatusInner**](access-request-post-approval-requested-items-status-inner) | Details about the outcome of each requested access item. | [required]
**Source** | [**AccountUncorrelatedSource**](account-uncorrelated-source) | | [required]
**Status** | **Enum** [ "Success", "Failed", "Terminated" ] | The overall status of the collection. | [required]
**Started** | **System.DateTime** | The date and time when the account collection started. | [required]
**Completed** | **System.DateTime** | The date and time when the account collection finished. | [required]
**Errors** | **[]String** | A list of any accumulated error messages that occurred during provisioning. | [required]
**Warnings** | **[]String** | A list of any accumulated warning messages that occurred during provisioning. | [required]
**Errors** | **[]String** | List of any accumulated error messages that occurred during provisioning. | [required]
**Warnings** | **[]String** | List of any accumulated warning messages that occurred during provisioning. | [required]
**Stats** | [**AccountsCollectedForAggregationStats**](accounts-collected-for-aggregation-stats) | | [required]
**Identity** | [**IdentityDeletedIdentity**](identity-deleted-identity) | | [required]
**Account** | [**AccountUncorrelatedAccount**](account-uncorrelated-account) | | [required]
**Changes** | [**[]IdentityAttributesChangedChangesInner**](identity-attributes-changed-changes-inner) | A list of one or more identity attributes that changed on the identity. | [required]
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes of the account. The contents of attributes depends on the account schema for the source. | [required]
**Changes** | [**[]IdentityAttributesChangedChangesInner**](identity-attributes-changed-changes-inner) | List of identity's attributes that changed. | [required]
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Account attributes. The attributes' contents depend on the source's account schema. | [required]
**EntitlementCount** | **Int32** | The number of entitlements associated with this account. | [optional]
**Campaign** | [**CampaignGeneratedCampaign**](campaign-generated-campaign) | | [required]
**Certification** | [**CertificationSignedOffCertification**](certification-signed-off-certification) | | [required]
**TrackingNumber** | **String** | The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface. | [required]
**Sources** | **String** | One or more sources that the provisioning transaction(s) were done against. Sources are comma separated. | [required]
**Action** | **String** | Origin of where the provisioning request came from. | [optional]
**TrackingNumber** | **String** | Provisioning request's reference number. Useful for tracking status in the 'Account Activity' search interface. | [required]
**Sources** | **String** | Sources the provisioning transactions were performed on. Sources are comma separated. | [required]
**Action** | **String** | Origin of the provisioning request. | [optional]
**Recipient** | [**ProvisioningCompletedRecipient**](provisioning-completed-recipient) | | [required]
**Requester** | [**ProvisioningCompletedRequester**](provisioning-completed-requester) | | [optional]
**AccountRequests** | [**[]ProvisioningCompletedAccountRequestsInner**](provisioning-completed-account-requests-inner) | A list of provisioning instructions to perform on an account-by-account basis. | [required]
**FileName** | **String** | A name for the report file. | [required]
**OwnerEmail** | **String** | The email address of the identity that owns the saved search. | [required]
**OwnerName** | **String** | The name of the identity that owns the saved search. | [required]
**Query** | **String** | The search query that was used to generate the report. | [required]
**SearchName** | **String** | The name of the saved search. | [required]
**AccountRequests** | [**[]ProvisioningCompletedAccountRequestsInner**](provisioning-completed-account-requests-inner) | List of provisioning instructions to perform on an account-by-account basis. | [required]
**FileName** | **String** | Report file name. | [required]
**OwnerEmail** | **String** | Email address of the identity who owns the saved search. | [required]
**OwnerName** | **String** | Name of the identity who owns the saved search. | [required]
**Query** | **String** | Search query used to generate the report. | [required]
**SearchName** | **String** | Saved search name. | [required]
**SearchResults** | [**SavedSearchCompleteSearchResults**](saved-search-complete-search-results) | | [required]
**SignedS3Url** | **String** | The Amazon S3 URL to download the report from. | [required]
**Uuid** | **String** | Source unique identifier for the identity. UUID is generated by the source system. | [optional]
**Id** | **String** | The unique ID of the source. | [required]
**NativeIdentifier** | **String** | Unique ID of the account on the source. | [required]
**SourceId** | **String** | The ID of the source. | [required]
**SourceName** | **String** | The name of the source. | [required]
**IdentityId** | **String** | The ID of the identity that is correlated with this account. | [required]
**IdentityName** | **String** | The name of the identity that is correlated with this account. | [required]
**Name** | **String** | The user friendly name of the source. | [required]
**Type** | **String** | The connection type of the source. | [required]
**Created** | **System.DateTime** | The date and time the status change occurred. | [required]
**Connector** | **String** | The connector type used to connect to the source. | [required]
**Uuid** | **String** | Identity's universal unique identifier (UUID) on the source. The source system generates the UUID. | [required]
**Id** | **String** | Source's unique ID. | [required]
**NativeIdentifier** | **String** | Account's unique ID on the source. | [required]
**SourceId** | **String** | Source ID. | [required]
**SourceName** | **String** | Source name. | [required]
**IdentityId** | **String** | ID of the identity correlated with the account. | [required]
**IdentityName** | **String** | Name of the identity correlated with the account. | [required]
**Name** | **String** | Source name. | [required]
**Type** | **String** | Connection type. | [required]
**Created** | **System.DateTime** | Date and time when the status change occurred. | [required]
**Connector** | **String** | Connector type used to connect to the source. | [required]
**Actor** | [**SourceUpdatedActor**](source-updated-actor) | | [required]
**Deleted** | **System.DateTime** | The date and time the source was deleted. | [required]
**Modified** | **System.DateTime** | The date and time the source was modified. | [required]
**Deleted** | **System.DateTime** | Date and time when the source was deleted. | [required]
**Modified** | **System.DateTime** | Date and time when the source was modified. | [required]
**Application** | [**VAClusterStatusChangeEventApplication**](va-cluster-status-change-event-application) | | [required]
**HealthCheckResult** | [**VAClusterStatusChangeEventHealthCheckResult**](va-cluster-status-change-event-health-check-result) | | [required]
**PreviousHealthCheckResult** | [**VAClusterStatusChangeEventPreviousHealthCheckResult**](va-cluster-status-change-event-previous-health-check-result) | | [required]
@@ -109,7 +109,7 @@ $TriggerExampleInput = Initialize-PSSailpoint.BetaTriggerExampleInput -AccessRe
-SourceName Active Directory `
-IdentityId ee769173319b41d19ccec6c235423237b `
-IdentityName john.doe `
-Name Corporate Active Directory `
-Name Test source `
-Type DIRECT_CONNECT `
-Created 2020-06-29T22:01:50.474Z `
-Connector active-directory `

4
docs/tools/sdk/powershell/Reference/Beta/Models/VAClusterStatusChangeEvent.md
View File

@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEvent', 'BetaVAC
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Created** | **System.DateTime** | The date and time the status change occurred. | [required]
**Type** | **Enum** [ "SOURCE", "CLUSTER" ] | The type of the object that initiated this event. | [required]
**Created** | **System.DateTime** | Date and time when the status change occurred. | [required]
**Type** | **Enum** [ "SOURCE", "CLUSTER" ] | Type of the object that initiated the event. | [required]
**Application** | [**VAClusterStatusChangeEventApplication**](va-cluster-status-change-event-application) | | [required]
**HealthCheckResult** | [**VAClusterStatusChangeEventHealthCheckResult**](va-cluster-status-change-event-health-check-result) | | [required]
**PreviousHealthCheckResult** | [**VAClusterStatusChangeEventPreviousHealthCheckResult**](va-cluster-status-change-event-previous-health-check-result) | | [required]

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

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventApplication
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | The GUID of the application | [required]
**Name** | **String** | The name of the application | [required]
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Custom map of attributes for a source. This will only be populated if type is `SOURCE` and the source has a proxy. | [required]
**Id** | **String** | Application's globally unique identifier (GUID). | [required]
**Name** | **String** | Application name. | [required]
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Custom map of attributes for a source. Attributes only populate if the type is `SOURCE` and the source has a proxy. | [required]
## Examples

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

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventHealthCheck
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Message** | **String** | Detailed message of the result of the health check. | [required]
**ResultType** | **String** | The type of the health check result. | [required]
**Status** | **Enum** [ "Succeeded", "Failed" ] | The status of the health check. | [required]
**Message** | **String** | Detailed message of the health check result.. | [required]
**ResultType** | **String** | Health check result type. | [required]
**Status** | **Enum** [ "Succeeded", "Failed" ] | Health check status. | [required]
## Examples

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

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventPreviousHea
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Message** | **String** | Detailed message of the result of the health check. | [required]
**ResultType** | **String** | The type of the health check result. | [required]
**Status** | **Enum** [ "Succeeded", "Failed" ] | The status of the health check. | [required]
**Message** | **String** | Detailed message of the health check result. | [required]
**ResultType** | **String** | Health check result type. | [required]
**Status** | **Enum** [ "Succeeded", "Failed" ] | Health check status. | [required]
## Examples