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

adding powershell sdk docs back

Browse Source
This commit is contained in:
darrell-thobe-sp
2025-01-28 13:29:29 -05:00
parent 248e4afe6b
commit c69a78b807
2822 changed files with 201703 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -0,0 +1,39 @@
---
id: beta-access-constraint
title: AccessConstraint
pagination_label: AccessConstraint
sidebar_label: AccessConstraint
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessConstraint', 'BetaAccessConstraint']
slug: /tools/sdk/powershell/beta/models/access-constraint
tags: ['SDK', 'Software Development Kit', 'AccessConstraint', 'BetaAccessConstraint']
---
# AccessConstraint
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "ENTITLEMENT", "ACCESS_PROFILE", "ROLE" ] | Type of Access | [required]
**Ids** | Pointer to **[]String** | Must be set only if operator is SELECTED. | [optional]
**Operator** | **Enum** [ "ALL", "SELECTED" ] | Used to determine whether the scope of the campaign should be reduced for selected ids or all. | [required]
## Examples
- Prepare the resource
```powershell
$AccessConstraint = Initialize-PSSailpoint.BetaAccessConstraint -Type ENTITLEMENT `
-Ids [2c90ad2a70ace7d50170acf22ca90010] `
-Operator SELECTED
```
- Convert the resource to JSON
```powershell
$AccessConstraint | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/Beta/Models/AccessCriteria.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: beta-access-criteria
title: AccessCriteria
pagination_label: AccessCriteria
sidebar_label: AccessCriteria
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessCriteria', 'BetaAccessCriteria']
slug: /tools/sdk/powershell/beta/models/access-criteria
tags: ['SDK', 'Software Development Kit', 'AccessCriteria', 'BetaAccessCriteria']
---
# AccessCriteria
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Name** | Pointer to **String** | Business name for the access construct list | [optional]
**CriteriaList** | Pointer to [**[]AccessCriteriaCriteriaListInner**](access-criteria-criteria-list-inner) | List of criteria. There is a min of 1 and max of 50 items in the list. | [optional]
## Examples
- Prepare the resource
```powershell
$AccessCriteria = Initialize-PSSailpoint.BetaAccessCriteria -Name money-in `
-CriteriaList [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}]
```
- Convert the resource to JSON
```powershell
$AccessCriteria | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -0,0 +1,39 @@
---
id: beta-access-criteria-criteria-list-inner
title: AccessCriteriaCriteriaListInner
pagination_label: AccessCriteriaCriteriaListInner
sidebar_label: AccessCriteriaCriteriaListInner
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessCriteriaCriteriaListInner', 'BetaAccessCriteriaCriteriaListInner']
slug: /tools/sdk/powershell/beta/models/access-criteria-criteria-list-inner
tags: ['SDK', 'Software Development Kit', 'AccessCriteriaCriteriaListInner', 'BetaAccessCriteriaCriteriaListInner']
---
# AccessCriteriaCriteriaListInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | DTO type | [optional]
**Id** | Pointer to **String** | ID of the object to which this reference applies to | [optional]
**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies to | [optional]
## Examples
- Prepare the resource
```powershell
$AccessCriteriaCriteriaListInner = Initialize-PSSailpoint.BetaAccessCriteriaCriteriaListInner -Type ENTITLEMENT `
-Id 2c91808568c529c60168cca6f90c1313 `
-Name Administrator
```
- Convert the resource to JSON
```powershell
$AccessCriteriaCriteriaListInner | ConvertTo-JSON
```
[[Back to top]](#)

57
docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAccessProfileResponse.md Normal file
View File

@@ -0,0 +1,57 @@
---
id: beta-access-item-access-profile-response
title: AccessItemAccessProfileResponse
pagination_label: AccessItemAccessProfileResponse
sidebar_label: AccessItemAccessProfileResponse
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemAccessProfileResponse', 'BetaAccessItemAccessProfileResponse']
slug: /tools/sdk/powershell/beta/models/access-item-access-profile-response
tags: ['SDK', 'Software Development Kit', 'AccessItemAccessProfileResponse', 'BetaAccessItemAccessProfileResponse']
---
# AccessItemAccessProfileResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessType** | Pointer to **String** | the access item type. accessProfile in this case | [optional]
**Id** | Pointer to **String** | the access item id | [optional]
**Name** | Pointer to **String** | the access profile name | [optional]
**SourceName** | Pointer to **String** | the name of the source | [optional]
**SourceId** | Pointer to **String** | the id of the source | [optional]
**Description** | Pointer to **String** | the description for the access profile | [optional]
**DisplayName** | Pointer to **String** | the display name of the identity | [optional]
**EntitlementCount** | Pointer to **String** | the number of entitlements the access profile will create | [optional]
**AppDisplayName** | Pointer to **String** | the name of | [optional]
**RemoveDate** | Pointer to **String** | the date the access profile is no longer assigned to the specified identity | [optional]
**Standalone** | **Boolean** | indicates whether the access profile is standalone | [required]
**Revocable** | **Boolean** | indicates whether the access profile is | [required]
## Examples
- Prepare the resource
```powershell
$AccessItemAccessProfileResponse = Initialize-PSSailpoint.BetaAccessItemAccessProfileResponse -AccessType accessProfile `
-Id 2c918087763e69d901763e72e97f006f `
-Name sample `
-SourceName DataScienceDataset `
-SourceId 2793o32dwd `
-Description AccessProfile - Workday/Citizenship access `
-DisplayName Dr. Arden Rogahn MD `
-EntitlementCount 12 `
-AppDisplayName AppName `
-RemoveDate 2024-07-01T06:00:00.00Z `
-Standalone false `
-Revocable true
```
- Convert the resource to JSON
```powershell
$AccessItemAccessProfileResponse | ConvertTo-JSON
```
[[Back to top]](#)

47
docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAccountResponse.md Normal file
View File

@@ -0,0 +1,47 @@
---
id: beta-access-item-account-response
title: AccessItemAccountResponse
pagination_label: AccessItemAccountResponse
sidebar_label: AccessItemAccountResponse
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemAccountResponse', 'BetaAccessItemAccountResponse']
slug: /tools/sdk/powershell/beta/models/access-item-account-response
tags: ['SDK', 'Software Development Kit', 'AccessItemAccountResponse', 'BetaAccessItemAccountResponse']
---
# AccessItemAccountResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessType** | Pointer to **String** | the access item type. account in this case | [optional]
**Id** | Pointer to **String** | the access item id | [optional]
**NativeIdentity** | Pointer to **String** | the native identifier used to uniquely identify an acccount | [optional]
**SourceName** | Pointer to **String** | the name of the source | [optional]
**SourceId** | Pointer to **String** | the id of the source | [optional]
**EntitlementCount** | Pointer to **String** | the number of entitlements the account will create | [optional]
**DisplayName** | Pointer to **String** | the display name of the identity | [optional]
## Examples
- Prepare the resource
```powershell
$AccessItemAccountResponse = Initialize-PSSailpoint.BetaAccessItemAccountResponse -AccessType account `
-Id 2c918087763e69d901763e72e97f006f `
-NativeIdentity dr.arden.ogahn.d `
-SourceName DataScienceDataset `
-SourceId 2793o32dwd `
-EntitlementCount 12 `
-DisplayName Dr. Arden Rogahn MD
```
- Convert the resource to JSON
```powershell
$AccessItemAccountResponse | ConvertTo-JSON
```
[[Back to top]](#)

43
docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAppResponse.md Normal file
View File

@@ -0,0 +1,43 @@
---
id: beta-access-item-app-response
title: AccessItemAppResponse
pagination_label: AccessItemAppResponse
sidebar_label: AccessItemAppResponse
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemAppResponse', 'BetaAccessItemAppResponse']
slug: /tools/sdk/powershell/beta/models/access-item-app-response
tags: ['SDK', 'Software Development Kit', 'AccessItemAppResponse', 'BetaAccessItemAppResponse']
---
# AccessItemAppResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessType** | Pointer to **String** | the access item type. entitlement in this case | [optional]
**Id** | Pointer to **String** | the access item id | [optional]
**DisplayName** | Pointer to **String** | the access item display name | [optional]
**SourceName** | Pointer to **String** | the associated source name if it exists | [optional]
**AppRoleId** | Pointer to **String** | the app role id | [optional]
## Examples
- Prepare the resource
```powershell
$AccessItemAppResponse = Initialize-PSSailpoint.BetaAccessItemAppResponse -AccessType app `
-Id 2c918087763e69d901763e72e97f006f `
-DisplayName Display Name `
-SourceName appName `
-AppRoleId 2c918087763e69d901763e72e97f006f
```
- Convert the resource to JSON
```powershell
$AccessItemAppResponse | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -0,0 +1,39 @@
---
id: beta-access-item-approver-dto
title: AccessItemApproverDto
pagination_label: AccessItemApproverDto
sidebar_label: AccessItemApproverDto
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemApproverDto', 'BetaAccessItemApproverDto']
slug: /tools/sdk/powershell/beta/models/access-item-approver-dto
tags: ['SDK', 'Software Development Kit', 'AccessItemApproverDto', 'BetaAccessItemApproverDto']
---
# AccessItemApproverDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | Pointer to **Enum** [ "IDENTITY" ] | DTO type of identity who approved the access item request. | [optional]
**Id** | Pointer to **String** | ID of identity who approved the access item request. | [optional]
**Name** | Pointer to **String** | Human-readable display name of identity who approved the access item request. | [optional]
## Examples
- Prepare the resource
```powershell
$AccessItemApproverDto = Initialize-PSSailpoint.BetaAccessItemApproverDto -Type IDENTITY `
-Id 2c3780a46faadee4016fb4e018c20652 `
-Name Allen Albertson
```
- Convert the resource to JSON
```powershell
$AccessItemApproverDto | ConvertTo-JSON
```
[[Back to top]](#)

43
docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAssociated.md Normal file
View File

@@ -0,0 +1,43 @@
---
id: beta-access-item-associated
title: AccessItemAssociated
pagination_label: AccessItemAssociated
sidebar_label: AccessItemAssociated
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemAssociated', 'BetaAccessItemAssociated']
slug: /tools/sdk/powershell/beta/models/access-item-associated
tags: ['SDK', 'Software Development Kit', 'AccessItemAssociated', 'BetaAccessItemAssociated']
---
# AccessItemAssociated
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessItem** | Pointer to [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional]
**IdentityId** | Pointer to **String** | the identity id | [optional]
**EventType** | Pointer to **String** | the event type | [optional]
**Dt** | Pointer to **String** | the date of event | [optional]
**GovernanceEvent** | Pointer to [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional]
## Examples
- Prepare the resource
```powershell
$AccessItemAssociated = Initialize-PSSailpoint.BetaAccessItemAssociated -AccessItem null `
-IdentityId 8c190e6787aa4ed9a90bd9d5344523fb `
-EventType AccessItemAssociated `
-Dt 2019-03-08T22:37:33.901Z `
-GovernanceEvent null
```
- Convert the resource to JSON
```powershell
$AccessItemAssociated | ConvertTo-JSON
```
[[Back to top]](#)

71
docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAssociatedAccessItem.md Normal file
View File

@@ -0,0 +1,71 @@
---
id: beta-access-item-associated-access-item
title: AccessItemAssociatedAccessItem
pagination_label: AccessItemAssociatedAccessItem
sidebar_label: AccessItemAssociatedAccessItem
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemAssociatedAccessItem', 'BetaAccessItemAssociatedAccessItem']
slug: /tools/sdk/powershell/beta/models/access-item-associated-access-item
tags: ['SDK', 'Software Development Kit', 'AccessItemAssociatedAccessItem', 'BetaAccessItemAssociatedAccessItem']
---
# AccessItemAssociatedAccessItem
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessType** | Pointer to **String** | the access item type. role in this case | [optional]
**Id** | Pointer to **String** | the access item id | [optional]
**Name** | Pointer to **String** | the access profile name | [optional]
**SourceName** | Pointer to **String** | the associated source name if it exists | [optional]
**SourceId** | Pointer to **String** | the id of the source | [optional]
**Description** | Pointer to **String** | the description for the role | [optional]
**DisplayName** | Pointer to **String** | the role display name | [optional]
**EntitlementCount** | Pointer to **String** | the number of entitlements the account will create | [optional]
**AppDisplayName** | Pointer to **String** | the name of | [optional]
**RemoveDate** | Pointer to **String** | the date the role is no longer assigned to the specified identity | [optional]
**Standalone** | **Boolean** | indicates whether the entitlement is standalone | [required]
**Revocable** | **Boolean** | indicates whether the role is revocable | [required]
**NativeIdentity** | Pointer to **String** | the native identifier used to uniquely identify an acccount | [optional]
**AppRoleId** | Pointer to **String** | the app role id | [optional]
**Attribute** | Pointer to **String** | the entitlement attribute | [optional]
**Value** | Pointer to **String** | the associated value | [optional]
**EntitlementType** | Pointer to **String** | the type of entitlement | [optional]
**Privileged** | **Boolean** | indicates whether the entitlement is privileged | [required]
**CloudGoverned** | **Boolean** | indicates whether the entitlement is cloud governed | [required]
## Examples
- Prepare the resource
```powershell
$AccessItemAssociatedAccessItem = Initialize-PSSailpoint.BetaAccessItemAssociatedAccessItem -AccessType role `
-Id 2c918087763e69d901763e72e97f006f `
-Name sample `
-SourceName Source Name `
-SourceId 2793o32dwd `
-Description Role - Workday/Citizenship access `
-DisplayName sample `
-EntitlementCount 12 `
-AppDisplayName AppName `
-RemoveDate 2024-07-01T06:00:00.00Z `
-Standalone true `
-Revocable true `
-NativeIdentity dr.arden.ogahn.d `
-AppRoleId 2c918087763e69d901763e72e97f006f `
-Attribute groups `
-Value Upward mobility access `
-EntitlementType entitlement `
-Privileged false `
-CloudGoverned true
```
- Convert the resource to JSON
```powershell
$AccessItemAssociatedAccessItem | ConvertTo-JSON
```
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemDiff.md Normal file
View File

@@ -0,0 +1,41 @@
---
id: beta-access-item-diff
title: AccessItemDiff
pagination_label: AccessItemDiff
sidebar_label: AccessItemDiff
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemDiff', 'BetaAccessItemDiff']
slug: /tools/sdk/powershell/beta/models/access-item-diff
tags: ['SDK', 'Software Development Kit', 'AccessItemDiff', 'BetaAccessItemDiff']
---
# AccessItemDiff
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | the id of the access item | [optional]
**EventType** | Pointer to **Enum** [ "ADD", "REMOVE" ] | | [optional]
**DisplayName** | Pointer to **String** | the display name of the access item | [optional]
**SourceName** | Pointer to **String** | the source name of the access item | [optional]
## Examples
- Prepare the resource
```powershell
$AccessItemDiff = Initialize-PSSailpoint.BetaAccessItemDiff -Id null `
-EventType null `
-DisplayName null `
-SourceName null
```
- Convert the resource to JSON
```powershell
$AccessItemDiff | ConvertTo-JSON
```
[[Back to top]](#)

57
docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemEntitlementResponse.md Normal file
View File

@@ -0,0 +1,57 @@
---
id: beta-access-item-entitlement-response
title: AccessItemEntitlementResponse
pagination_label: AccessItemEntitlementResponse
sidebar_label: AccessItemEntitlementResponse
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemEntitlementResponse', 'BetaAccessItemEntitlementResponse']
slug: /tools/sdk/powershell/beta/models/access-item-entitlement-response
tags: ['SDK', 'Software Development Kit', 'AccessItemEntitlementResponse', 'BetaAccessItemEntitlementResponse']
---
# AccessItemEntitlementResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessType** | Pointer to **String** | the access item type. entitlement in this case | [optional]
**Id** | Pointer to **String** | the access item id | [optional]
**Attribute** | Pointer to **String** | the entitlement attribute | [optional]
**Value** | Pointer to **String** | the associated value | [optional]
**EntitlementType** | Pointer to **String** | the type of entitlement | [optional]
**SourceName** | Pointer to **String** | the name of the source | [optional]
**SourceId** | Pointer to **String** | the id of the source | [optional]
**Description** | Pointer to **String** | the description for the entitlment | [optional]
**DisplayName** | Pointer to **String** | the display name of the identity | [optional]
**Standalone** | **Boolean** | indicates whether the entitlement is standalone | [required]
**Privileged** | **Boolean** | indicates whether the entitlement is privileged | [required]
**CloudGoverned** | **Boolean** | indicates whether the entitlement is cloud governed | [required]
## Examples
- Prepare the resource
```powershell
$AccessItemEntitlementResponse = Initialize-PSSailpoint.BetaAccessItemEntitlementResponse -AccessType entitlement `
-Id 2c918087763e69d901763e72e97f006f `
-Attribute groups `
-Value Upward mobility access `
-EntitlementType entitlement `
-SourceName DataScienceDataset `
-SourceId 2793o32dwd `
-Description Entitlement - Workday/Citizenship access `
-DisplayName Dr. Arden Rogahn MD `
-Standalone true `
-Privileged false `
-CloudGoverned true
```
- Convert the resource to JSON
```powershell
$AccessItemEntitlementResponse | ConvertTo-JSON
```
[[Back to top]](#)

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

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

37
docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemRef.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: beta-access-item-ref
title: AccessItemRef
pagination_label: AccessItemRef
sidebar_label: AccessItemRef
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemRef', 'BetaAccessItemRef']
slug: /tools/sdk/powershell/beta/models/access-item-ref
tags: ['SDK', 'Software Development Kit', 'AccessItemRef', 'BetaAccessItemRef']
---
# AccessItemRef
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | ID of the access item to retrieve the recommendation for. | [optional]
**Type** | Pointer to **Enum** [ "ENTITLEMENT", "ACCESS_PROFILE", "ROLE" ] | Access item's type. | [optional]
## Examples
- Prepare the resource
```powershell
$AccessItemRef = Initialize-PSSailpoint.BetaAccessItemRef -Id 2c938083633d259901633d2623ec0375 `
-Type ENTITLEMENT
```
- Convert the resource to JSON
```powershell
$AccessItemRef | ConvertTo-JSON
```
[[Back to top]](#)

43
docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemRemoved.md Normal file
View File

@@ -0,0 +1,43 @@
---
id: beta-access-item-removed
title: AccessItemRemoved
pagination_label: AccessItemRemoved
sidebar_label: AccessItemRemoved
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemRemoved', 'BetaAccessItemRemoved']
slug: /tools/sdk/powershell/beta/models/access-item-removed
tags: ['SDK', 'Software Development Kit', 'AccessItemRemoved', 'BetaAccessItemRemoved']
---
# AccessItemRemoved
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessItem** | Pointer to [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional]
**IdentityId** | Pointer to **String** | the identity id | [optional]
**EventType** | Pointer to **String** | the event type | [optional]
**Dt** | Pointer to **String** | the date of event | [optional]
**GovernanceEvent** | Pointer to [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional]
## Examples
- Prepare the resource
```powershell
$AccessItemRemoved = Initialize-PSSailpoint.BetaAccessItemRemoved -AccessItem null `
-IdentityId 8c190e6787aa4ed9a90bd9d5344523fb `
-EventType AccessItemRemoved `
-Dt 2019-03-08T22:37:33.901Z `
-GovernanceEvent null
```
- Convert the resource to JSON
```powershell
$AccessItemRemoved | ConvertTo-JSON
```
[[Back to top]](#)

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

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

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

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

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

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

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

@@ -0,0 +1,39 @@
---
id: beta-access-item-reviewed-by
title: AccessItemReviewedBy
pagination_label: AccessItemReviewedBy
sidebar_label: AccessItemReviewedBy
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemReviewedBy', 'BetaAccessItemReviewedBy']
slug: /tools/sdk/powershell/beta/models/access-item-reviewed-by
tags: ['SDK', 'Software Development Kit', 'AccessItemReviewedBy', 'BetaAccessItemReviewedBy']
---
# AccessItemReviewedBy
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | Pointer to **Enum** [ "IDENTITY" ] | DTO type of identity who reviewed the access item request. | [optional]
**Id** | Pointer to **String** | ID of identity who reviewed the access item request. | [optional]
**Name** | Pointer to **String** | Human-readable display name of identity who reviewed the access item request. | [optional]
## Examples
- Prepare the resource
```powershell
$AccessItemReviewedBy = Initialize-PSSailpoint.BetaAccessItemReviewedBy -Type IDENTITY `
-Id 2c3780a46faadee4016fb4e018c20652 `
-Name Allen Albertson
```
- Convert the resource to JSON
```powershell
$AccessItemReviewedBy | ConvertTo-JSON
```
[[Back to top]](#)

47
docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemRoleResponse.md Normal file
View File

@@ -0,0 +1,47 @@
---
id: beta-access-item-role-response
title: AccessItemRoleResponse
pagination_label: AccessItemRoleResponse
sidebar_label: AccessItemRoleResponse
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemRoleResponse', 'BetaAccessItemRoleResponse']
slug: /tools/sdk/powershell/beta/models/access-item-role-response
tags: ['SDK', 'Software Development Kit', 'AccessItemRoleResponse', 'BetaAccessItemRoleResponse']
---
# AccessItemRoleResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessType** | Pointer to **String** | the access item type. role in this case | [optional]
**Id** | Pointer to **String** | the access item id | [optional]
**DisplayName** | Pointer to **String** | the role display name | [optional]
**Description** | Pointer to **String** | the description for the role | [optional]
**SourceName** | Pointer to **String** | the associated source name if it exists | [optional]
**RemoveDate** | Pointer to **String** | the date the role is no longer assigned to the specified identity | [optional]
**Revocable** | **Boolean** | indicates whether the role is revocable | [required]
## Examples
- Prepare the resource
```powershell
$AccessItemRoleResponse = Initialize-PSSailpoint.BetaAccessItemRoleResponse -AccessType role `
-Id 2c918087763e69d901763e72e97f006f `
-DisplayName sample `
-Description Role - Workday/Citizenship access `
-SourceName Source Name `
-RemoveDate 2024-07-01T06:00:00.00Z `
-Revocable true
```
- Convert the resource to JSON
```powershell
$AccessItemRoleResponse | ConvertTo-JSON
```
[[Back to top]](#)

61
docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfile.md Normal file
View File

@@ -0,0 +1,61 @@
---
id: beta-access-profile
title: AccessProfile
pagination_label: AccessProfile
sidebar_label: AccessProfile
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfile', 'BetaAccessProfile']
slug: /tools/sdk/powershell/beta/models/access-profile
tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'BetaAccessProfile']
---
# AccessProfile
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | The ID of the Access Profile | [optional] [readonly]
**Name** | **String** | Name of the Access Profile | [required]
**Description** | Pointer to **String** | Information about the Access Profile | [optional]
**Created** | Pointer to **System.DateTime** | Date the Access Profile was created | [optional] [readonly]
**Modified** | Pointer to **System.DateTime** | Date the Access Profile was last modified. | [optional] [readonly]
**Enabled** | Pointer to **Boolean** | Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. | [optional] [default to $true]
**Owner** | [**OwnerReference**](owner-reference) | | [required]
**Source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | [required]
**Entitlements** | Pointer to [**[]EntitlementRef**](entitlement-ref) | A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. | [optional]
**Requestable** | Pointer to **Boolean** | Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. | [optional] [default to $true]
**AccessRequestConfig** | Pointer to [**Requestability**](requestability) | | [optional]
**RevocationRequestConfig** | Pointer to [**Revocability**](revocability) | | [optional]
**Segments** | Pointer to **[]String** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional]
**ProvisioningCriteria** | Pointer to [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional]
## Examples
- Prepare the resource
```powershell
$AccessProfile = Initialize-PSSailpoint.BetaAccessProfile -Id 2c91808a7190d06e01719938fcd20792 `
-Name Employee-database-read-write `
-Description Collection of entitlements to read/write the employee database `
-Created 2021-03-01T22:32:58.104Z `
-Modified 2021-03-02T20:22:28.104Z `
-Enabled true `
-Owner null `
-Source null `
-Entitlements null `
-Requestable true `
-AccessRequestConfig null `
-RevocationRequestConfig null `
-Segments [f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a] `
-ProvisioningCriteria null
```
- Convert the resource to JSON
```powershell
$AccessProfile | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfileApprovalScheme.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: beta-access-profile-approval-scheme
title: AccessProfileApprovalScheme
pagination_label: AccessProfileApprovalScheme
sidebar_label: AccessProfileApprovalScheme
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileApprovalScheme', 'BetaAccessProfileApprovalScheme']
slug: /tools/sdk/powershell/beta/models/access-profile-approval-scheme
tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'BetaAccessProfileApprovalScheme']
---
# AccessProfileApprovalScheme
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ApproverType** | Pointer to **Enum** [ "APP_OWNER", "OWNER", "SOURCE_OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional]
**ApproverId** | Pointer to **String** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional]
## Examples
- Prepare the resource
```powershell
$AccessProfileApprovalScheme = Initialize-PSSailpoint.BetaAccessProfileApprovalScheme -ApproverType GOVERNANCE_GROUP `
-ApproverId 46c79819-a69f-49a2-becb-12c971ae66c6
```
- Convert the resource to JSON
```powershell
$AccessProfileApprovalScheme | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfileBulkDeleteRequest.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: beta-access-profile-bulk-delete-request
title: AccessProfileBulkDeleteRequest
pagination_label: AccessProfileBulkDeleteRequest
sidebar_label: AccessProfileBulkDeleteRequest
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileBulkDeleteRequest', 'BetaAccessProfileBulkDeleteRequest']
slug: /tools/sdk/powershell/beta/models/access-profile-bulk-delete-request
tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteRequest', 'BetaAccessProfileBulkDeleteRequest']
---
# AccessProfileBulkDeleteRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessProfileIds** | Pointer to **[]String** | List of IDs of Access Profiles to be deleted. | [optional]
**BestEffortOnly** | Pointer to **Boolean** | If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use. | [optional]
## Examples
- Prepare the resource
```powershell
$AccessProfileBulkDeleteRequest = Initialize-PSSailpoint.BetaAccessProfileBulkDeleteRequest -AccessProfileIds [2c9180847812e0b1017817051919ecca, 2c9180887812e0b201781e129f151816] `
-BestEffortOnly true
```
- Convert the resource to JSON
```powershell
$AccessProfileBulkDeleteRequest | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -0,0 +1,39 @@
---
id: beta-access-profile-bulk-delete-response
title: AccessProfileBulkDeleteResponse
pagination_label: AccessProfileBulkDeleteResponse
sidebar_label: AccessProfileBulkDeleteResponse
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileBulkDeleteResponse', 'BetaAccessProfileBulkDeleteResponse']
slug: /tools/sdk/powershell/beta/models/access-profile-bulk-delete-response
tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteResponse', 'BetaAccessProfileBulkDeleteResponse']
---
# AccessProfileBulkDeleteResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**TaskId** | Pointer to **String** | ID of the task which is executing the bulk deletion. This can be passed to the **/task-status** API to track status. | [optional]
**Pending** | Pointer to **[]String** | List of IDs of Access Profiles which are pending deletion. | [optional]
**InUse** | Pointer to [**[]AccessProfileUsage**](access-profile-usage) | List of usages of Access Profiles targeted for deletion. | [optional]
## Examples
- Prepare the resource
```powershell
$AccessProfileBulkDeleteResponse = Initialize-PSSailpoint.BetaAccessProfileBulkDeleteResponse -TaskId 2c9180867817ac4d017817c491119a20 `
-Pending [2c91808876438bbb017668c21919ecca, 2c91808876438bb201766e129f151816] `
-InUse null
```
- Convert the resource to JSON
```powershell
$AccessProfileBulkDeleteResponse | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfileBulkUpdateRequestInner.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: beta-access-profile-bulk-update-request-inner
title: AccessProfileBulkUpdateRequestInner
pagination_label: AccessProfileBulkUpdateRequestInner
sidebar_label: AccessProfileBulkUpdateRequestInner
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileBulkUpdateRequestInner', 'BetaAccessProfileBulkUpdateRequestInner']
slug: /tools/sdk/powershell/beta/models/access-profile-bulk-update-request-inner
tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkUpdateRequestInner', 'BetaAccessProfileBulkUpdateRequestInner']
---
# AccessProfileBulkUpdateRequestInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | Access Profile ID. | [optional]
**Requestable** | Pointer to **Boolean** | Access Profile is requestable or not. | [optional]
## Examples
- Prepare the resource
```powershell
$AccessProfileBulkUpdateRequestInner = Initialize-PSSailpoint.BetaAccessProfileBulkUpdateRequestInner -Id 464ae7bf-791e-49fd-b746-06a2e4a8 `
-Requestable false
```
- Convert the resource to JSON
```powershell
$AccessProfileBulkUpdateRequestInner | ConvertTo-JSON
```
[[Back to top]](#)

79
docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfileDetails.md Normal file
View File

@@ -0,0 +1,79 @@
---
id: beta-access-profile-details
title: AccessProfileDetails
pagination_label: AccessProfileDetails
sidebar_label: AccessProfileDetails
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileDetails', 'BetaAccessProfileDetails']
slug: /tools/sdk/powershell/beta/models/access-profile-details
tags: ['SDK', 'Software Development Kit', 'AccessProfileDetails', 'BetaAccessProfileDetails']
---
# AccessProfileDetails
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | The ID of the Access Profile | [optional]
**Name** | Pointer to **String** | Name of the Access Profile | [optional]
**Description** | Pointer to **String** | Information about the Access Profile | [optional]
**Created** | Pointer to **System.DateTime** | Date the Access Profile was created | [optional]
**Modified** | Pointer to **System.DateTime** | Date the Access Profile was last modified. | [optional]
**Disabled** | Pointer to **Boolean** | Whether the Access Profile is enabled. | [optional] [default to $true]
**Requestable** | Pointer to **Boolean** | Whether the Access Profile is requestable via access request. | [optional] [default to $false]
**Protected** | Pointer to **Boolean** | Whether the Access Profile is protected. | [optional] [default to $false]
**OwnerId** | Pointer to **String** | The owner ID of the Access Profile | [optional]
**SourceId** | Pointer to **Int64** | The source ID of the Access Profile | [optional]
**SourceName** | Pointer to **String** | The source name of the Access Profile | [optional]
**AppId** | Pointer to **Int64** | The source app ID of the Access Profile | [optional]
**AppName** | Pointer to **String** | The source app name of the Access Profile | [optional]
**ApplicationId** | Pointer to **String** | The id of the application | [optional]
**Type** | Pointer to **String** | The type of the access profile | [optional]
**Entitlements** | Pointer to **[]String** | List of IDs of entitlements | [optional]
**EntitlementCount** | Pointer to **Int32** | The number of entitlements in the access profile | [optional]
**Segments** | Pointer to **[]String** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional]
**ApprovalSchemes** | Pointer to **String** | Comma-separated list of approval schemes. Each approval scheme is one of - manager - appOwner - sourceOwner - accessProfileOwner - workgroup:<workgroupId> | [optional]
**RevokeRequestApprovalSchemes** | Pointer to **String** | Comma-separated list of revoke request approval schemes. Each approval scheme is one of - manager - sourceOwner - accessProfileOwner - workgroup:<workgroupId> | [optional]
**RequestCommentsRequired** | Pointer to **Boolean** | Whether the access profile require request comment for access request. | [optional] [default to $false]
**DeniedCommentsRequired** | Pointer to **Boolean** | Whether denied comment is required when access request is denied. | [optional] [default to $false]
**AccountSelector** | Pointer to [**AccessProfileDetailsAccountSelector**](access-profile-details-account-selector) | | [optional]
## Examples
- Prepare the resource
```powershell
$AccessProfileDetails = Initialize-PSSailpoint.BetaAccessProfileDetails -Id 2c91808a7190d06e01719938fcd20792 `
-Name Employee-database-read-write `
-Description Collection of entitlements to read/write the employee database `
-Created 2021-03-01T22:32:58.104Z `
-Modified 2021-03-02T20:22:28.104Z `
-Disabled true `
-Requestable true `
-Protected false `
-OwnerId 9870808a7190d06e01719938fcd20792 `
-SourceId 10360661 `
-SourceName AD Source `
-AppId 10360661 `
-AppName mail app `
-ApplicationId edcb0951812949d085b60cd8bf35bc78 `
-Type source `
-Entitlements [2c9180857725c14301772a93bb77242d, c9dc28e148a24d65b3ccb5fb8ca5ddd9] `
-EntitlementCount 12 `
-Segments [f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a] `
-ApprovalSchemes accessProfileOwner `
-RevokeRequestApprovalSchemes accessProfileOwner `
-RequestCommentsRequired true `
-DeniedCommentsRequired true `
-AccountSelector null
```
- Convert the resource to JSON
```powershell
$AccessProfileDetails | ConvertTo-JSON
```
[[Back to top]](#)

35
docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfileDetailsAccountSelector.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: beta-access-profile-details-account-selector
title: AccessProfileDetailsAccountSelector
pagination_label: AccessProfileDetailsAccountSelector
sidebar_label: AccessProfileDetailsAccountSelector
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileDetailsAccountSelector', 'BetaAccessProfileDetailsAccountSelector']
slug: /tools/sdk/powershell/beta/models/access-profile-details-account-selector
tags: ['SDK', 'Software Development Kit', 'AccessProfileDetailsAccountSelector', 'BetaAccessProfileDetailsAccountSelector']
---
# AccessProfileDetailsAccountSelector
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Selectors** | Pointer to [**[]Selector**](selector) | | [optional]
## Examples
- Prepare the resource
```powershell
$AccessProfileDetailsAccountSelector = Initialize-PSSailpoint.BetaAccessProfileDetailsAccountSelector -Selectors null
```
- Convert the resource to JSON
```powershell
$AccessProfileDetailsAccountSelector | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -0,0 +1,39 @@
---
id: beta-access-profile-ref
title: AccessProfileRef
pagination_label: AccessProfileRef
sidebar_label: AccessProfileRef
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileRef', 'BetaAccessProfileRef']
slug: /tools/sdk/powershell/beta/models/access-profile-ref
tags: ['SDK', 'Software Development Kit', 'AccessProfileRef', 'BetaAccessProfileRef']
---
# AccessProfileRef
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | ID of the Access Profile | [optional]
**Type** | Pointer to **Enum** [ "ACCESS_PROFILE" ] | Type of requested object. This field must be either left null or set to 'ACCESS_PROFILE' when creating an Access Profile, otherwise a 400 Bad Request error will result. | [optional]
**Name** | Pointer to **String** | Human-readable display name of the Access Profile. This field is ignored on input. | [optional]
## Examples
- Prepare the resource
```powershell
$AccessProfileRef = Initialize-PSSailpoint.BetaAccessProfileRef -Id ff808081751e6e129f1518161919ecca `
-Type ACCESS_PROFILE `
-Name Access Profile 2567
```
- Convert the resource to JSON
```powershell
$AccessProfileRef | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -0,0 +1,39 @@
---
id: beta-access-profile-source-ref
title: AccessProfileSourceRef
pagination_label: AccessProfileSourceRef
sidebar_label: AccessProfileSourceRef
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileSourceRef', 'BetaAccessProfileSourceRef']
slug: /tools/sdk/powershell/beta/models/access-profile-source-ref
tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'BetaAccessProfileSourceRef']
---
# AccessProfileSourceRef
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | The ID of the Source with with which the Access Profile is associated | [optional]
**Type** | Pointer to **Enum** [ "SOURCE" ] | The type of the Source, will always be SOURCE | [optional]
**Name** | Pointer to **String** | The display name of the associated Source | [optional]
## Examples
- Prepare the resource
```powershell
$AccessProfileSourceRef = Initialize-PSSailpoint.BetaAccessProfileSourceRef -Id 2c91809773dee3610173fdb0b6061ef4 `
-Type SOURCE `
-Name ODS-AD-SOURCE
```
- Convert the resource to JSON
```powershell
$AccessProfileSourceRef | ConvertTo-JSON
```
[[Back to top]](#)

45
docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfileUpdateItem.md Normal file
View File

@@ -0,0 +1,45 @@
---
id: beta-access-profile-update-item
title: AccessProfileUpdateItem
pagination_label: AccessProfileUpdateItem
sidebar_label: AccessProfileUpdateItem
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileUpdateItem', 'BetaAccessProfileUpdateItem']
slug: /tools/sdk/powershell/beta/models/access-profile-update-item
tags: ['SDK', 'Software Development Kit', 'AccessProfileUpdateItem', 'BetaAccessProfileUpdateItem']
---
# AccessProfileUpdateItem
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | Identifier of Access Profile in bulk update request. | [required]
**Requestable** | **Boolean** | Access Profile requestable or not. | [required]
**Status** | **String** | The HTTP response status code returned for an individual Access Profile that is requested for update during a bulk update operation. > 201 - Access profile is updated successfully. > 404 - Access profile not found. | [required]
**Description** | Pointer to **String** | Human readable status description and containing additional context information about success or failures etc. | [optional]
## Examples
- Prepare the resource
```powershell
$AccessProfileUpdateItem = Initialize-PSSailpoint.BetaAccessProfileUpdateItem -Id 2c7180a46faadee4016fb4e018c20642 `
-Requestable false `
-Status 201 `
-Description
> Access profile is updated successfully.
> Referenced Access profile with Id "2c7180a46faadee4016fb4e018c20642" was not found.
```
- Convert the resource to JSON
```powershell
$AccessProfileUpdateItem | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfileUsage.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: beta-access-profile-usage
title: AccessProfileUsage
pagination_label: AccessProfileUsage
sidebar_label: AccessProfileUsage
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileUsage', 'BetaAccessProfileUsage']
slug: /tools/sdk/powershell/beta/models/access-profile-usage
tags: ['SDK', 'Software Development Kit', 'AccessProfileUsage', 'BetaAccessProfileUsage']
---
# AccessProfileUsage
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessProfileId** | Pointer to **String** | ID of the Access Profile that is in use | [optional]
**UsedBy** | Pointer to [**[]AccessProfileUsageUsedByInner**](access-profile-usage-used-by-inner) | List of references to objects which are using the indicated Access Profile | [optional]
## Examples
- Prepare the resource
```powershell
$AccessProfileUsage = Initialize-PSSailpoint.BetaAccessProfileUsage -AccessProfileId 2c91808876438bbb017668c21919ecca `
-UsedBy null
```
- Convert the resource to JSON
```powershell
$AccessProfileUsage | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -0,0 +1,39 @@
---
id: beta-access-profile-usage-used-by-inner
title: AccessProfileUsageUsedByInner
pagination_label: AccessProfileUsageUsedByInner
sidebar_label: AccessProfileUsageUsedByInner
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileUsageUsedByInner', 'BetaAccessProfileUsageUsedByInner']
slug: /tools/sdk/powershell/beta/models/access-profile-usage-used-by-inner
tags: ['SDK', 'Software Development Kit', 'AccessProfileUsageUsedByInner', 'BetaAccessProfileUsageUsedByInner']
---
# AccessProfileUsageUsedByInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | Pointer to **Enum** [ "ROLE" ] | DTO type of role using the access profile. | [optional]
**Id** | Pointer to **String** | ID of role using the access profile. | [optional]
**Name** | Pointer to **String** | Display name of role using the access profile. | [optional]
## Examples
- Prepare the resource
```powershell
$AccessProfileUsageUsedByInner = Initialize-PSSailpoint.BetaAccessProfileUsageUsedByInner -Type ROLE `
-Id 2c8180857a9b3da0017aa03418480f9d `
-Name Manager Role
```
- Convert the resource to JSON
```powershell
$AccessProfileUsageUsedByInner | ConvertTo-JSON
```
[[Back to top]](#)

35
docs/tools/sdk/powershell/Reference/Beta/Models/AccessRecommendationMessage.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: beta-access-recommendation-message
title: AccessRecommendationMessage
pagination_label: AccessRecommendationMessage
sidebar_label: AccessRecommendationMessage
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRecommendationMessage', 'BetaAccessRecommendationMessage']
slug: /tools/sdk/powershell/beta/models/access-recommendation-message
tags: ['SDK', 'Software Development Kit', 'AccessRecommendationMessage', 'BetaAccessRecommendationMessage']
---
# AccessRecommendationMessage
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Interpretation** | Pointer to **String** | Information about why the access item was recommended. | [optional]
## Examples
- Prepare the resource
```powershell
$AccessRecommendationMessage = Initialize-PSSailpoint.BetaAccessRecommendationMessage -Interpretation 95% of your peers have this access.
```
- Convert the resource to JSON
```powershell
$AccessRecommendationMessage | ConvertTo-JSON
```
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequest.md Normal file
View File

@@ -0,0 +1,41 @@
---
id: beta-access-request
title: AccessRequest
pagination_label: AccessRequest
sidebar_label: AccessRequest
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequest', 'BetaAccessRequest']
slug: /tools/sdk/powershell/beta/models/access-request
tags: ['SDK', 'Software Development Kit', 'AccessRequest', 'BetaAccessRequest']
---
# AccessRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**RequestedFor** | **[]String** | A list of Identity IDs for whom the Access is requested. If it's a Revoke request, there can only be one Identity ID. | [required]
**RequestType** | Pointer to [**AccessRequestType**](access-request-type) | | [optional]
**RequestedItems** | [**[]AccessRequestItem**](access-request-item) | | [required]
**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional]
## Examples
- Prepare the resource
```powershell
$AccessRequest = Initialize-PSSailpoint.BetaAccessRequest -RequestedFor null `
-RequestType null `
-RequestedItems null `
-ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app}
```
- Convert the resource to JSON
```powershell
$AccessRequest | ConvertTo-JSON
```
[[Back to top]](#)

45
docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestConfig.md Normal file
View File

@@ -0,0 +1,45 @@
---
id: beta-access-request-config
title: AccessRequestConfig
pagination_label: AccessRequestConfig
sidebar_label: AccessRequestConfig
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestConfig', 'BetaAccessRequestConfig']
slug: /tools/sdk/powershell/beta/models/access-request-config
tags: ['SDK', 'Software Development Kit', 'AccessRequestConfig', 'BetaAccessRequestConfig']
---
# AccessRequestConfig
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ApprovalsMustBeExternal** | Pointer to **Boolean** | If this is true, approvals must be processed by an external system. Also, if this is true, it blocks Request Center access requests and returns an error for any user who isn't an org admin. | [optional] [default to $false]
**AutoApprovalEnabled** | Pointer to **Boolean** | If this is true and the requester and reviewer are the same, the request is automatically approved. | [optional] [default to $false]
**ReauthorizationEnabled** | Pointer to **Boolean** | If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state. | [optional] [default to $false]
**RequestOnBehalfOfConfig** | Pointer to [**RequestOnBehalfOfConfig**](request-on-behalf-of-config) | | [optional]
**ApprovalReminderAndEscalationConfig** | Pointer to [**ApprovalReminderAndEscalationConfig**](approval-reminder-and-escalation-config) | | [optional]
**EntitlementRequestConfig** | Pointer to [**EntitlementRequestConfig1**](entitlement-request-config1) | | [optional]
## Examples
- Prepare the resource
```powershell
$AccessRequestConfig = Initialize-PSSailpoint.BetaAccessRequestConfig -ApprovalsMustBeExternal true `
-AutoApprovalEnabled true `
-ReauthorizationEnabled true `
-RequestOnBehalfOfConfig null `
-ApprovalReminderAndEscalationConfig null `
-EntitlementRequestConfig null
```
- Convert the resource to JSON
```powershell
$AccessRequestConfig | ConvertTo-JSON
```
[[Back to top]](#)

35
docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestContext.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: beta-access-request-context
title: AccessRequestContext
pagination_label: AccessRequestContext
sidebar_label: AccessRequestContext
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestContext', 'BetaAccessRequestContext']
slug: /tools/sdk/powershell/beta/models/access-request-context
tags: ['SDK', 'Software Development Kit', 'AccessRequestContext', 'BetaAccessRequestContext']
---
# AccessRequestContext
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ContextAttributes** | Pointer to [**[]ContextAttributeDto**](context-attribute-dto) | | [optional]
## Examples
- Prepare the resource
```powershell
$AccessRequestContext = Initialize-PSSailpoint.BetaAccessRequestContext -ContextAttributes null
```
- Convert the resource to JSON
```powershell
$AccessRequestContext | ConvertTo-JSON
```
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestDynamicApprover.md Normal file
View File

@@ -0,0 +1,41 @@
---
id: beta-access-request-dynamic-approver
title: AccessRequestDynamicApprover
pagination_label: AccessRequestDynamicApprover
sidebar_label: AccessRequestDynamicApprover
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestDynamicApprover', 'BetaAccessRequestDynamicApprover']
slug: /tools/sdk/powershell/beta/models/access-request-dynamic-approver
tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApprover', 'BetaAccessRequestDynamicApprover']
---
# AccessRequestDynamicApprover
## Properties
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]
## Examples
- Prepare the resource
```powershell
$AccessRequestDynamicApprover = Initialize-PSSailpoint.BetaAccessRequestDynamicApprover -AccessRequestId 4b4d982dddff4267ab12f0f1e72b5a6d `
-RequestedFor null `
-RequestedItems null `
-RequestedBy null
```
- Convert the resource to JSON
```powershell
$AccessRequestDynamicApprover | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -0,0 +1,39 @@
---
id: beta-access-request-dynamic-approver1
title: AccessRequestDynamicApprover1
pagination_label: AccessRequestDynamicApprover1
sidebar_label: AccessRequestDynamicApprover1
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestDynamicApprover1', 'BetaAccessRequestDynamicApprover1']
slug: /tools/sdk/powershell/beta/models/access-request-dynamic-approver1
tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApprover1', 'BetaAccessRequestDynamicApprover1']
---
# AccessRequestDynamicApprover1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | The unique ID of the identity to add to the approver list for the access request. | [required]
**Name** | **String** | The name of the identity to add to the approver list for the access request. | [required]
**Type** | **Enum** [ "IDENTITY", "GOVERNANCE_GROUP" ] | The type of object being referenced. | [required]
## Examples
- Prepare the resource
```powershell
$AccessRequestDynamicApprover1 = Initialize-PSSailpoint.BetaAccessRequestDynamicApprover1 -Id 2c91808b6ef1d43e016efba0ce470906 `
-Name Adam Adams `
-Type IDENTITY
```
- Convert the resource to JSON
```powershell
$AccessRequestDynamicApprover1 | ConvertTo-JSON
```
[[Back to top]](#)

45
docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestDynamicApproverRequestedItemsInner.md Normal file
View File

@@ -0,0 +1,45 @@
---
id: beta-access-request-dynamic-approver-requested-items-inner
title: AccessRequestDynamicApproverRequestedItemsInner
pagination_label: AccessRequestDynamicApproverRequestedItemsInner
sidebar_label: AccessRequestDynamicApproverRequestedItemsInner
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestDynamicApproverRequestedItemsInner', 'BetaAccessRequestDynamicApproverRequestedItemsInner']
slug: /tools/sdk/powershell/beta/models/access-request-dynamic-approver-requested-items-inner
tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApproverRequestedItemsInner', 'BetaAccessRequestDynamicApproverRequestedItemsInner']
---
# AccessRequestDynamicApproverRequestedItemsInner
## Properties
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** | Pointer to **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** | Pointer to **String** | A comment from the requestor on why the access is needed. | [optional]
## Examples
- Prepare the resource
```powershell
$AccessRequestDynamicApproverRequestedItemsInner = Initialize-PSSailpoint.BetaAccessRequestDynamicApproverRequestedItemsInner -Id 2c91808b6ef1d43e016efba0ce470904 `
-Name Engineering Access `
-Description Engineering Access `
-Type ACCESS_PROFILE `
-Operation Add `
-Comment William needs this access for his day to day job activities.
```
- Convert the resource to JSON
```powershell
$AccessRequestDynamicApproverRequestedItemsInner | ConvertTo-JSON
```
[[Back to top]](#)

43
docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestItem.md Normal file
View File

@@ -0,0 +1,43 @@
---
id: beta-access-request-item
title: AccessRequestItem
pagination_label: AccessRequestItem
sidebar_label: AccessRequestItem
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestItem', 'BetaAccessRequestItem']
slug: /tools/sdk/powershell/beta/models/access-request-item
tags: ['SDK', 'Software Development Kit', 'AccessRequestItem', 'BetaAccessRequestItem']
---
# AccessRequestItem
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of the item being requested. | [required]
**Id** | **String** | ID of Role, Access Profile or Entitlement being requested. | [required]
**Comment** | Pointer to **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional]
**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional]
**RemoveDate** | Pointer to **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional]
## Examples
- Prepare the resource
```powershell
$AccessRequestItem = Initialize-PSSailpoint.BetaAccessRequestItem -Type ACCESS_PROFILE `
-Id 2c9180835d2e5168015d32f890ca1581 `
-Comment Requesting access profile for John Doe `
-ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} `
-RemoveDate 2020-07-11T21:23:15Z
```
- Convert the resource to JSON
```powershell
$AccessRequestItem | ConvertTo-JSON
```
[[Back to top]](#)

49
docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestItemResponse.md Normal file
View File

@@ -0,0 +1,49 @@
---
id: beta-access-request-item-response
title: AccessRequestItemResponse
pagination_label: AccessRequestItemResponse
sidebar_label: AccessRequestItemResponse
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestItemResponse', 'BetaAccessRequestItemResponse']
slug: /tools/sdk/powershell/beta/models/access-request-item-response
tags: ['SDK', 'Software Development Kit', 'AccessRequestItemResponse', 'BetaAccessRequestItemResponse']
---
# AccessRequestItemResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Operation** | Pointer to **String** | the access request item operation | [optional]
**AccessItemType** | Pointer to **String** | the access item type | [optional]
**Name** | Pointer to **String** | the name of access request item | [optional]
**Decision** | Pointer to **Enum** [ "APPROVED", "REJECTED" ] | the final decision for the access request | [optional]
**Description** | Pointer to **String** | the description of access request item | [optional]
**SourceId** | Pointer to **String** | the source id | [optional]
**SourceName** | Pointer to **String** | the source Name | [optional]
**ApprovalInfos** | Pointer to [**[]ApprovalInfoResponse**](approval-info-response) | | [optional]
## Examples
- Prepare the resource
```powershell
$AccessRequestItemResponse = Initialize-PSSailpoint.BetaAccessRequestItemResponse -Operation Add `
-AccessItemType role `
-Name Role-1 `
-Decision APPROVED `
-Description The role descrition `
-SourceId 8a80828f643d484f01643e14202e206f `
-SourceName Source1 `
-ApprovalInfos [{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}]
```
- Convert the resource to JSON
```powershell
$AccessRequestItemResponse | ConvertTo-JSON
```
[[Back to top]](#)

45
docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestPhases.md Normal file
View File

@@ -0,0 +1,45 @@
---
id: beta-access-request-phases
title: AccessRequestPhases
pagination_label: AccessRequestPhases
sidebar_label: AccessRequestPhases
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPhases', 'BetaAccessRequestPhases']
slug: /tools/sdk/powershell/beta/models/access-request-phases
tags: ['SDK', 'Software Development Kit', 'AccessRequestPhases', 'BetaAccessRequestPhases']
---
# AccessRequestPhases
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Started** | Pointer to **System.DateTime** | The time that this phase started. | [optional]
**Finished** | Pointer to **System.DateTime** | The time that this phase finished. | [optional]
**Name** | Pointer to **String** | The name of this phase. | [optional]
**State** | Pointer to **Enum** [ "PENDING", "EXECUTING", "COMPLETED", "CANCELLED", "NOT_EXECUTED" ] | The state of this phase. | [optional]
**Result** | Pointer to **Enum** [ "SUCCESSFUL", "FAILED" ] | The state of this phase. | [optional]
**PhaseReference** | Pointer to **String** | A reference to another object on the RequestedItemStatus that contains more details about the phase. Note that for the Provisioning phase, this will be empty if there are no manual work items. | [optional]
## Examples
- Prepare the resource
```powershell
$AccessRequestPhases = Initialize-PSSailpoint.BetaAccessRequestPhases -Started 2020-07-11T00:00Z `
-Finished 2020-07-12T00:00Z `
-Name APPROVAL_PHASE `
-State COMPLETED `
-Result SUCCESSFUL `
-PhaseReference approvalDetails
```
- Convert the resource to JSON
```powershell
$AccessRequestPhases | ConvertTo-JSON
```
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestPostApproval.md Normal file
View File

@@ -0,0 +1,41 @@
---
id: beta-access-request-post-approval
title: AccessRequestPostApproval
pagination_label: AccessRequestPostApproval
sidebar_label: AccessRequestPostApproval
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPostApproval', 'BetaAccessRequestPostApproval']
slug: /tools/sdk/powershell/beta/models/access-request-post-approval
tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApproval', 'BetaAccessRequestPostApproval']
---
# AccessRequestPostApproval
## Properties
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]
## Examples
- Prepare the resource
```powershell
$AccessRequestPostApproval = Initialize-PSSailpoint.BetaAccessRequestPostApproval -AccessRequestId 2c91808b6ef1d43e016efba0ce470904 `
-RequestedFor null `
-RequestedItemsStatus null `
-RequestedBy null
```
- Convert the resource to JSON
```powershell
$AccessRequestPostApproval | ConvertTo-JSON
```
[[Back to top]](#)

49
docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md Normal file
View File

@@ -0,0 +1,49 @@
---
id: beta-access-request-post-approval-requested-items-status-inner
title: AccessRequestPostApprovalRequestedItemsStatusInner
pagination_label: AccessRequestPostApprovalRequestedItemsStatusInner
sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInner
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInner', 'BetaAccessRequestPostApprovalRequestedItemsStatusInner']
slug: /tools/sdk/powershell/beta/models/access-request-post-approval-requested-items-status-inner
tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInner', 'BetaAccessRequestPostApprovalRequestedItemsStatusInner']
---
# AccessRequestPostApprovalRequestedItemsStatusInner
## Properties
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** | Pointer to **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** | Pointer to **String** | A comment from the identity requesting the access. | [optional]
**ClientMetadata** | Pointer to [**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]
## Examples
- Prepare the resource
```powershell
$AccessRequestPostApprovalRequestedItemsStatusInner = Initialize-PSSailpoint.BetaAccessRequestPostApprovalRequestedItemsStatusInner -Id 2c91808b6ef1d43e016efba0ce470904 `
-Name Engineering Access `
-Description Access to engineering database `
-Type ACCESS_PROFILE `
-Operation Add `
-Comment William needs this access to do his job. `
-ClientMetadata {applicationName=My application} `
-ApprovalInfo null
```
- Convert the resource to JSON
```powershell
$AccessRequestPostApprovalRequestedItemsStatusInner | ConvertTo-JSON
```
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner.md Normal file
View File

@@ -0,0 +1,41 @@
---
id: beta-access-request-post-approval-requested-items-status-inner-approval-info-inner
title: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner
pagination_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner
sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner', 'BetaAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner']
slug: /tools/sdk/powershell/beta/models/access-request-post-approval-requested-items-status-inner-approval-info-inner
tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner', 'BetaAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner']
---
# AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ApprovalComment** | Pointer to **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]
## Examples
- Prepare the resource
```powershell
$AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner = Initialize-PSSailpoint.BetaAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner -ApprovalComment This access looks good. Approved. `
-ApprovalDecision APPROVED `
-ApproverName Stephen.Austin `
-Approver null
```
- Convert the resource to JSON
```powershell
$AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -0,0 +1,39 @@
---
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]](#)

41
docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestPreApproval.md Normal file
View File

@@ -0,0 +1,41 @@
---
id: beta-access-request-pre-approval
title: AccessRequestPreApproval
pagination_label: AccessRequestPreApproval
sidebar_label: AccessRequestPreApproval
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPreApproval', 'BetaAccessRequestPreApproval']
slug: /tools/sdk/powershell/beta/models/access-request-pre-approval
tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApproval', 'BetaAccessRequestPreApproval']
---
# AccessRequestPreApproval
## Properties
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]
## Examples
- Prepare the resource
```powershell
$AccessRequestPreApproval = Initialize-PSSailpoint.BetaAccessRequestPreApproval -AccessRequestId 2c91808b6ef1d43e016efba0ce470904 `
-RequestedFor null `
-RequestedItems null `
-RequestedBy null
```
- Convert the resource to JSON
```powershell
$AccessRequestPreApproval | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -0,0 +1,39 @@
---
id: beta-access-request-pre-approval1
title: AccessRequestPreApproval1
pagination_label: AccessRequestPreApproval1
sidebar_label: AccessRequestPreApproval1
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPreApproval1', 'BetaAccessRequestPreApproval1']
slug: /tools/sdk/powershell/beta/models/access-request-pre-approval1
tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApproval1', 'BetaAccessRequestPreApproval1']
---
# AccessRequestPreApproval1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Approved** | **Boolean** | Whether or not to approve the access request. | [required]
**Comment** | **String** | A comment about the decision to approve or deny the request. | [required]
**Approver** | **String** | The name of the entity that approved or denied the request. | [required]
## Examples
- Prepare the resource
```powershell
$AccessRequestPreApproval1 = Initialize-PSSailpoint.BetaAccessRequestPreApproval1 -Approved false `
-Comment This access should be denied, because this will cause an SOD violation. `
-Approver AcmeCorpExternalIntegration
```
- Convert the resource to JSON
```powershell
$AccessRequestPreApproval1 | ConvertTo-JSON
```
[[Back to top]](#)

45
docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestPreApprovalRequestedItemsInner.md Normal file
View File

@@ -0,0 +1,45 @@
---
id: beta-access-request-pre-approval-requested-items-inner
title: AccessRequestPreApprovalRequestedItemsInner
pagination_label: AccessRequestPreApprovalRequestedItemsInner
sidebar_label: AccessRequestPreApprovalRequestedItemsInner
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPreApprovalRequestedItemsInner', 'BetaAccessRequestPreApprovalRequestedItemsInner']
slug: /tools/sdk/powershell/beta/models/access-request-pre-approval-requested-items-inner
tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApprovalRequestedItemsInner', 'BetaAccessRequestPreApprovalRequestedItemsInner']
---
# AccessRequestPreApprovalRequestedItemsInner
## Properties
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** | Pointer to **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** | Pointer to **String** | A comment from the identity requesting the access. | [optional]
## Examples
- Prepare the resource
```powershell
$AccessRequestPreApprovalRequestedItemsInner = Initialize-PSSailpoint.BetaAccessRequestPreApprovalRequestedItemsInner -Id 2c91808b6ef1d43e016efba0ce470904 `
-Name Engineering Access `
-Description Access to engineering database `
-Type ACCESS_PROFILE `
-Operation Add `
-Comment William needs this access to do his job.
```
- Convert the resource to JSON
```powershell
$AccessRequestPreApprovalRequestedItemsInner | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestRecommendationActionItemDto.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: beta-access-request-recommendation-action-item-dto
title: AccessRequestRecommendationActionItemDto
pagination_label: AccessRequestRecommendationActionItemDto
sidebar_label: AccessRequestRecommendationActionItemDto
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationActionItemDto', 'BetaAccessRequestRecommendationActionItemDto']
slug: /tools/sdk/powershell/beta/models/access-request-recommendation-action-item-dto
tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationActionItemDto', 'BetaAccessRequestRecommendationActionItemDto']
---
# AccessRequestRecommendationActionItemDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**IdentityId** | **String** | The identity ID taking the action. | [required]
**Access** | [**AccessRequestRecommendationItem**](access-request-recommendation-item) | | [required]
## Examples
- Prepare the resource
```powershell
$AccessRequestRecommendationActionItemDto = Initialize-PSSailpoint.BetaAccessRequestRecommendationActionItemDto -IdentityId 2c91808570313110017040b06f344ec9 `
-Access null
```
- Convert the resource to JSON
```powershell
$AccessRequestRecommendationActionItemDto | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -0,0 +1,39 @@
---
id: beta-access-request-recommendation-action-item-response-dto
title: AccessRequestRecommendationActionItemResponseDto
pagination_label: AccessRequestRecommendationActionItemResponseDto
sidebar_label: AccessRequestRecommendationActionItemResponseDto
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationActionItemResponseDto', 'BetaAccessRequestRecommendationActionItemResponseDto']
slug: /tools/sdk/powershell/beta/models/access-request-recommendation-action-item-response-dto
tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationActionItemResponseDto', 'BetaAccessRequestRecommendationActionItemResponseDto']
---
# AccessRequestRecommendationActionItemResponseDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**IdentityId** | Pointer to **String** | The identity ID taking the action. | [optional]
**Access** | Pointer to [**AccessRequestRecommendationItem**](access-request-recommendation-item) | | [optional]
**Timestamp** | Pointer to **System.DateTime** | | [optional]
## Examples
- Prepare the resource
```powershell
$AccessRequestRecommendationActionItemResponseDto = Initialize-PSSailpoint.BetaAccessRequestRecommendationActionItemResponseDto -IdentityId 2c91808570313110017040b06f344ec9 `
-Access null `
-Timestamp 2017-07-11T18:45:37.098Z
```
- Convert the resource to JSON
```powershell
$AccessRequestRecommendationActionItemResponseDto | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestRecommendationItem.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: beta-access-request-recommendation-item
title: AccessRequestRecommendationItem
pagination_label: AccessRequestRecommendationItem
sidebar_label: AccessRequestRecommendationItem
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationItem', 'BetaAccessRequestRecommendationItem']
slug: /tools/sdk/powershell/beta/models/access-request-recommendation-item
tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItem', 'BetaAccessRequestRecommendationItem']
---
# AccessRequestRecommendationItem
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | ID of access item being recommended. | [optional]
**Type** | Pointer to [**AccessRequestRecommendationItemType**](access-request-recommendation-item-type) | | [optional]
## Examples
- Prepare the resource
```powershell
$AccessRequestRecommendationItem = Initialize-PSSailpoint.BetaAccessRequestRecommendationItem -Id 2c9180835d2e5168015d32f890ca1581 `
-Type null
```
- Convert the resource to JSON
```powershell
$AccessRequestRecommendationItem | ConvertTo-JSON
```
[[Back to top]](#)

47
docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestRecommendationItemDetail.md Normal file
View File

@@ -0,0 +1,47 @@
---
id: beta-access-request-recommendation-item-detail
title: AccessRequestRecommendationItemDetail
pagination_label: AccessRequestRecommendationItemDetail
sidebar_label: AccessRequestRecommendationItemDetail
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationItemDetail', 'BetaAccessRequestRecommendationItemDetail']
slug: /tools/sdk/powershell/beta/models/access-request-recommendation-item-detail
tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemDetail', 'BetaAccessRequestRecommendationItemDetail']
---
# AccessRequestRecommendationItemDetail
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**IdentityId** | Pointer to **String** | Identity ID for the recommendation | [optional]
**Access** | Pointer to [**AccessRequestRecommendationItemDetailAccess**](access-request-recommendation-item-detail-access) | | [optional]
**Ignored** | Pointer to **Boolean** | Whether or not the identity has already chosen to ignore this recommendation. | [optional]
**Requested** | Pointer to **Boolean** | Whether or not the identity has already chosen to request this recommendation. | [optional]
**Viewed** | Pointer to **Boolean** | Whether or not the identity reportedly viewed this recommendation. | [optional]
**Messages** | Pointer to [**[]AccessRecommendationMessage**](access-recommendation-message) | | [optional]
**TranslationMessages** | Pointer to [**[]TranslationMessage**](translation-message) | The list of translation messages | [optional]
## Examples
- Prepare the resource
```powershell
$AccessRequestRecommendationItemDetail = Initialize-PSSailpoint.BetaAccessRequestRecommendationItemDetail -IdentityId 2c91808570313110017040b06f344ec9 `
-Access null `
-Ignored true `
-Requested true `
-Viewed true `
-Messages null `
-TranslationMessages [{key=recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH, values=[75, department]}]
```
- Convert the resource to JSON
```powershell
$AccessRequestRecommendationItemDetail | ConvertTo-JSON
```
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestRecommendationItemDetailAccess.md Normal file
View File

@@ -0,0 +1,41 @@
---
id: beta-access-request-recommendation-item-detail-access
title: AccessRequestRecommendationItemDetailAccess
pagination_label: AccessRequestRecommendationItemDetailAccess
sidebar_label: AccessRequestRecommendationItemDetailAccess
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationItemDetailAccess', 'BetaAccessRequestRecommendationItemDetailAccess']
slug: /tools/sdk/powershell/beta/models/access-request-recommendation-item-detail-access
tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemDetailAccess', 'BetaAccessRequestRecommendationItemDetailAccess']
---
# AccessRequestRecommendationItemDetailAccess
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | ID of access item being recommended. | [optional]
**Type** | Pointer to [**AccessRequestRecommendationItemType**](access-request-recommendation-item-type) | | [optional]
**Name** | Pointer to **String** | Name of the access item | [optional]
**Description** | Pointer to **String** | Description of the access item | [optional]
## Examples
- Prepare the resource
```powershell
$AccessRequestRecommendationItemDetailAccess = Initialize-PSSailpoint.BetaAccessRequestRecommendationItemDetailAccess -Id 2c9180835d2e5168015d32f890ca1581 `
-Type null `
-Name Employee-database-read-write `
-Description This item grants an employee read and write access to the database
```
- Convert the resource to JSON
```powershell
$AccessRequestRecommendationItemDetailAccess | ConvertTo-JSON
```
[[Back to top]](#)

24
docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestRecommendationItemType.md Normal file
View File

@@ -0,0 +1,24 @@
---
id: beta-access-request-recommendation-item-type
title: AccessRequestRecommendationItemType
pagination_label: AccessRequestRecommendationItemType
sidebar_label: AccessRequestRecommendationItemType
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationItemType', 'BetaAccessRequestRecommendationItemType']
slug: /tools/sdk/powershell/beta/models/access-request-recommendation-item-type
tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemType', 'BetaAccessRequestRecommendationItemType']
---
# AccessRequestRecommendationItemType
## Enum
* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`)
* `ROLE` (value: `"ROLE"`)
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestResponse.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: beta-access-request-response
title: AccessRequestResponse
pagination_label: AccessRequestResponse
sidebar_label: AccessRequestResponse
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestResponse', 'BetaAccessRequestResponse']
slug: /tools/sdk/powershell/beta/models/access-request-response
tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse', 'BetaAccessRequestResponse']
---
# AccessRequestResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**NewRequests** | Pointer to [**[]AccessRequestTracking**](access-request-tracking) | A list of new access request tracking data mapped to the values requested. | [optional]
**ExistingRequests** | Pointer to [**[]AccessRequestTracking**](access-request-tracking) | A list of existing access request tracking data mapped to the values requested. This indicates access has already been requested for this item. | [optional]
## Examples
- Prepare the resource
```powershell
$AccessRequestResponse = Initialize-PSSailpoint.BetaAccessRequestResponse -NewRequests [{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ENTITLEMENT, id=779c6fd7171540bba1184e5946112c28}], attributesHash=-1928438224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdb]}] `
-ExistingRequests [{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ROLE, id=779c6fd7171540bbc1184e5946112c28}], attributesHash=2843118224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdc]}]
```
- Convert the resource to JSON
```powershell
$AccessRequestResponse | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -0,0 +1,39 @@
---
id: beta-access-request-response1
title: AccessRequestResponse1
pagination_label: AccessRequestResponse1
sidebar_label: AccessRequestResponse1
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestResponse1', 'BetaAccessRequestResponse1']
slug: /tools/sdk/powershell/beta/models/access-request-response1
tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse1', 'BetaAccessRequestResponse1']
---
# AccessRequestResponse1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**RequesterId** | Pointer to **String** | the requester Id | [optional]
**RequesterName** | Pointer to **String** | the requesterName | [optional]
**Items** | Pointer to [**[]AccessRequestItemResponse**](access-request-item-response) | | [optional]
## Examples
- Prepare the resource
```powershell
$AccessRequestResponse1 = Initialize-PSSailpoint.BetaAccessRequestResponse1 -RequesterId 2c91808a77ff216301782327a50f09bf `
-RequesterName Bing C `
-Items [{operation=Add, accessItemType=role, name=Role-1, decision=APPROVED, description=The role descrition, sourceId=8a80828f643d484f01643e14202e206f, sourceName=Source1, approvalInfos=[{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}]}]
```
- Convert the resource to JSON
```powershell
$AccessRequestResponse1 | ConvertTo-JSON
```
[[Back to top]](#)

44
docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestTracking.md Normal file
View File

@@ -0,0 +1,44 @@
---
id: beta-access-request-tracking
title: AccessRequestTracking
pagination_label: AccessRequestTracking
sidebar_label: AccessRequestTracking
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestTracking', 'BetaAccessRequestTracking']
slug: /tools/sdk/powershell/beta/models/access-request-tracking
tags: ['SDK', 'Software Development Kit', 'AccessRequestTracking', 'BetaAccessRequestTracking']
---
# AccessRequestTracking
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**RequestedFor** | Pointer to **String** | The identity id in which the access request is for. | [optional]
**RequestedItemsDetails** | Pointer to [**[]RequestedItemDetails**](requested-item-details) | The details of the item requested. | [optional]
**AttributesHash** | Pointer to **String** | a hash representation of the access requested, useful for longer term tracking client side. | [optional]
**AccessRequestIds** | Pointer to **[]String** | a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids. | [optional]
## Examples
- Prepare the resource
```powershell
$AccessRequestTracking = Initialize-PSSailpoint.BetaAccessRequestTracking -RequestedFor 2c918084660f45d6016617daa9210584 `
-RequestedItemsDetails {
"type": "ENTITLEMENT",
"id": "779c6fd7171540bba1184e5946112c28"
} `
-AttributesHash -1928438224 `
-AccessRequestIds [5d3118c518a44ec7805450d53479ccdb]
```
- Convert the resource to JSON
```powershell
$AccessRequestTracking | ConvertTo-JSON
```
[[Back to top]](#)

24
docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestType.md Normal file
View File

@@ -0,0 +1,24 @@
---
id: beta-access-request-type
title: AccessRequestType
pagination_label: AccessRequestType
sidebar_label: AccessRequestType
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestType', 'BetaAccessRequestType']
slug: /tools/sdk/powershell/beta/models/access-request-type
tags: ['SDK', 'Software Development Kit', 'AccessRequestType', 'BetaAccessRequestType']
---
# AccessRequestType
## Enum
* `GRANT_ACCESS` (value: `"GRANT_ACCESS"`)
* `REVOKE_ACCESS` (value: `"REVOKE_ACCESS"`)
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequested.md Normal file
View File

@@ -0,0 +1,41 @@
---
id: beta-access-requested
title: AccessRequested
pagination_label: AccessRequested
sidebar_label: AccessRequested
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequested', 'BetaAccessRequested']
slug: /tools/sdk/powershell/beta/models/access-requested
tags: ['SDK', 'Software Development Kit', 'AccessRequested', 'BetaAccessRequested']
---
# AccessRequested
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessRequest** | Pointer to [**AccessRequestResponse1**](access-request-response1) | | [optional]
**IdentityId** | Pointer to **String** | the identity id | [optional]
**EventType** | Pointer to **String** | the event type | [optional]
**Dt** | Pointer to **String** | the date of event | [optional]
## Examples
- Prepare the resource
```powershell
$AccessRequested = Initialize-PSSailpoint.BetaAccessRequested -AccessRequest null `
-IdentityId 8a80828f643d484f01643e14202e206f `
-EventType AccessRequested `
-Dt 2019-03-08T22:37:33.901Z
```
- Convert the resource to JSON
```powershell
$AccessRequested | ConvertTo-JSON
```
[[Back to top]](#)

24
docs/tools/sdk/powershell/Reference/Beta/Models/AccessType.md Normal file
View File

@@ -0,0 +1,24 @@
---
id: beta-access-type
title: AccessType
pagination_label: AccessType
sidebar_label: AccessType
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessType', 'BetaAccessType']
slug: /tools/sdk/powershell/beta/models/access-type
tags: ['SDK', 'Software Development Kit', 'AccessType', 'BetaAccessType']
---
# AccessType
## Enum
* `ONLINE` (value: `"ONLINE"`)
* `OFFLINE` (value: `"OFFLINE"`)
[[Back to top]](#)

89
docs/tools/sdk/powershell/Reference/Beta/Models/Account.md Normal file
View File

@@ -0,0 +1,89 @@
---
id: beta-account
title: Account
pagination_label: Account
sidebar_label: Account
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'Account', 'BetaAccount']
slug: /tools/sdk/powershell/beta/models/account
tags: ['SDK', 'Software Development Kit', 'Account', 'BetaAccount']
---
# Account
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | System-generated unique ID of the Object | [optional] [readonly]
**Name** | **String** | Name of the Object | [required]
**Created** | Pointer to **System.DateTime** | Creation date of the Object | [optional] [readonly]
**Modified** | Pointer to **System.DateTime** | Last modification date of the Object | [optional] [readonly]
**SourceId** | **String** | The unique ID of the source this account belongs to | [required]
**SourceName** | **String** | The display name of the source this account belongs to | [required]
**IdentityId** | Pointer to **String** | The unique ID of the identity this account is correlated to | [optional]
**CloudLifecycleState** | Pointer to **String** | The lifecycle state of the identity this account is correlated to | [optional]
**IdentityState** | Pointer to **String** | The identity state of the identity this account is correlated to | [optional]
**ConnectionType** | Pointer to **String** | The connection type of the source this account is from | [optional]
**IsMachine** | Pointer to **Boolean** | Indicates if the account is of machine type | [optional] [default to $false]
**Recommendation** | Pointer to [**Recommendation**](recommendation) | | [optional]
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The account attributes that are aggregated | [required]
**Authoritative** | **Boolean** | Indicates if this account is from an authoritative source | [required]
**Description** | Pointer to **String** | A description of the account | [optional]
**Disabled** | **Boolean** | Indicates if the account is currently disabled | [required]
**Locked** | **Boolean** | Indicates if the account is currently locked | [required]
**NativeIdentity** | **String** | The unique ID of the account generated by the source system | [required]
**SystemAccount** | **Boolean** | If true, this is a user account within IdentityNow. If false, this is an account from a source system. | [required]
**Uncorrelated** | **Boolean** | Indicates if this account is not correlated to an identity | [required]
**Uuid** | Pointer to **String** | The unique ID of the account as determined by the account schema | [optional]
**ManuallyCorrelated** | **Boolean** | Indicates if the account has been manually correlated to an identity | [required]
**HasEntitlements** | **Boolean** | Indicates if the account has entitlements | [required]
**Identity** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional]
**SourceOwner** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional]
**Features** | Pointer to **String** | A string list containing the owning source's features | [optional]
**Origin** | Pointer to **Enum** [ "AGGREGATED", "PROVISIONED" ] | The origin of the account either aggregated or provisioned | [optional]
**OwnerIdentity** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional]
## Examples
- Prepare the resource
```powershell
$Account = Initialize-PSSailpoint.BetaAccount -Id id12345 `
-Name aName `
-Created 2023-01-03T21:16:22.432Z `
-Modified 2023-01-03T21:16:22.432Z `
-SourceId 2c9180835d2e5168015d32f890ca1581 `
-SourceName Employees `
-IdentityId 2c9180835d2e5168015d32f890ca1581 `
-CloudLifecycleState active `
-IdentityState ACTIVE `
-ConnectionType direct `
-IsMachine true `
-Recommendation null `
-Attributes {firstName=SailPoint, lastName=Support, displayName=SailPoint Support} `
-Authoritative false `
-Description null `
-Disabled false `
-Locked false `
-NativeIdentity 552775 `
-SystemAccount false `
-Uncorrelated false `
-Uuid {b0dce506-d6d4-44d2-8a32-d9a5b21fb175} `
-ManuallyCorrelated false `
-HasEntitlements true `
-Identity null `
-SourceOwner null `
-Features ENABLE `
-Origin AGGREGATED `
-OwnerIdentity null
```
- Convert the resource to JSON
```powershell
$Account | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/Beta/Models/AccountAction.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: beta-account-action
title: AccountAction
pagination_label: AccountAction
sidebar_label: AccountAction
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAction', 'BetaAccountAction']
slug: /tools/sdk/powershell/beta/models/account-action
tags: ['SDK', 'Software Development Kit', 'AccountAction', 'BetaAccountAction']
---
# AccountAction
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Action** | Pointer to **Enum** [ "ENABLE", "DISABLE" ] | Describes if action will be enabled or disabled | [optional]
**SourceIds** | Pointer to **[]String** | List of source IDs. The sources must have the ENABLE feature or flat file source. See ""/sources"" endpoint for source features. | [optional]
## Examples
- Prepare the resource
```powershell
$AccountAction = Initialize-PSSailpoint.BetaAccountAction -Action ENABLE `
-SourceIds [2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500]
```
- Convert the resource to JSON
```powershell
$AccountAction | ConvertTo-JSON
```
[[Back to top]](#)

32
docs/tools/sdk/powershell/Reference/Beta/Models/AccountActivityApprovalStatus.md Normal file
View File

@@ -0,0 +1,32 @@
---
id: beta-account-activity-approval-status
title: AccountActivityApprovalStatus
pagination_label: AccountActivityApprovalStatus
sidebar_label: AccountActivityApprovalStatus
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivityApprovalStatus', 'BetaAccountActivityApprovalStatus']
slug: /tools/sdk/powershell/beta/models/account-activity-approval-status
tags: ['SDK', 'Software Development Kit', 'AccountActivityApprovalStatus', 'BetaAccountActivityApprovalStatus']
---
# AccountActivityApprovalStatus
## Enum
* `FINISHED` (value: `"FINISHED"`)
* `REJECTED` (value: `"REJECTED"`)
* `RETURNED` (value: `"RETURNED"`)
* `EXPIRED` (value: `"EXPIRED"`)
* `PENDING` (value: `"PENDING"`)
* `CANCELED` (value: `"CANCELED"`)
[[Back to top]](#)

65
docs/tools/sdk/powershell/Reference/Beta/Models/AccountActivityItem.md Normal file
View File

@@ -0,0 +1,65 @@
---
id: beta-account-activity-item
title: AccountActivityItem
pagination_label: AccountActivityItem
sidebar_label: AccountActivityItem
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivityItem', 'BetaAccountActivityItem']
slug: /tools/sdk/powershell/beta/models/account-activity-item
tags: ['SDK', 'Software Development Kit', 'AccountActivityItem', 'BetaAccountActivityItem']
---
# AccountActivityItem
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | Item id | [optional]
**Name** | Pointer to **String** | Human-readable display name of item | [optional]
**Requested** | Pointer to **System.DateTime** | Date and time item was requested | [optional]
**ApprovalStatus** | Pointer to [**AccountActivityApprovalStatus**](account-activity-approval-status) | | [optional]
**ProvisioningStatus** | Pointer to [**ProvisioningState**](provisioning-state) | | [optional]
**RequesterComment** | Pointer to [**Comment**](comment) | | [optional]
**ReviewerIdentitySummary** | Pointer to [**IdentitySummary**](identity-summary) | | [optional]
**ReviewerComment** | Pointer to [**Comment**](comment) | | [optional]
**Operation** | Pointer to [**AccountActivityItemOperation**](account-activity-item-operation) | | [optional]
**Attribute** | Pointer to **String** | Attribute to which account activity applies | [optional]
**Value** | Pointer to **String** | Value of attribute | [optional]
**NativeIdentity** | Pointer to **String** | Native identity in the target system to which the account activity applies | [optional]
**SourceId** | Pointer to **String** | Id of Source to which account activity applies | [optional]
**AccountRequestInfo** | Pointer to [**AccountRequestInfo**](account-request-info) | | [optional]
**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs, if any were included in the corresponding access request item | [optional]
**RemoveDate** | Pointer to **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional]
## Examples
- Prepare the resource
```powershell
$AccountActivityItem = Initialize-PSSailpoint.BetaAccountActivityItem -Id 48c545831b264409a81befcabb0e3c5a `
-Name 48c545831b264409a81befcabb0e3c5a `
-Requested 2017-07-11T18:45:37.098Z `
-ApprovalStatus null `
-ProvisioningStatus null `
-RequesterComment null `
-ReviewerIdentitySummary null `
-ReviewerComment null `
-Operation null `
-Attribute detectedRoles `
-Value Treasury Analyst [AccessProfile-1529010191212] `
-NativeIdentity Sandie.Camero `
-SourceId 2c91808363ef85290164000587130c0c `
-AccountRequestInfo null `
-ClientMetadata {customKey1=custom value 1, customKey2=custom value 2} `
-RemoveDate 2020-07-11T00:00Z
```
- Convert the resource to JSON
```powershell
$AccountActivityItem | ConvertTo-JSON
```
[[Back to top]](#)

40
docs/tools/sdk/powershell/Reference/Beta/Models/AccountActivityItemOperation.md Normal file
View File

@@ -0,0 +1,40 @@
---
id: beta-account-activity-item-operation
title: AccountActivityItemOperation
pagination_label: AccountActivityItemOperation
sidebar_label: AccountActivityItemOperation
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivityItemOperation', 'BetaAccountActivityItemOperation']
slug: /tools/sdk/powershell/beta/models/account-activity-item-operation
tags: ['SDK', 'Software Development Kit', 'AccountActivityItemOperation', 'BetaAccountActivityItemOperation']
---
# AccountActivityItemOperation
## Enum
* `ADD` (value: `"ADD"`)
* `CREATE` (value: `"CREATE"`)
* `MODIFY` (value: `"MODIFY"`)
* `DELETE` (value: `"DELETE"`)
* `DISABLE` (value: `"DISABLE"`)
* `ENABLE` (value: `"ENABLE"`)
* `UNLOCK` (value: `"UNLOCK"`)
* `LOCK` (value: `"LOCK"`)
* `REMOVE` (value: `"REMOVE"`)
* `SET` (value: `"SET"`)
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/Beta/Models/AccountAggregation.md Normal file
View File

@@ -0,0 +1,41 @@
---
id: beta-account-aggregation
title: AccountAggregation
pagination_label: AccountAggregation
sidebar_label: AccountAggregation
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAggregation', 'BetaAccountAggregation']
slug: /tools/sdk/powershell/beta/models/account-aggregation
tags: ['SDK', 'Software Development Kit', 'AccountAggregation', 'BetaAccountAggregation']
---
# AccountAggregation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Start** | Pointer to **System.DateTime** | When the aggregation started. | [optional]
**Status** | Pointer to **Enum** [ "STARTED", "ACCOUNTS_COLLECTED", "COMPLETED", "CANCELLED", "RETRIED", "TERMINATED" ] | STARTED - Aggregation started, but source account iteration has not completed. ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed. COMPLETED - Aggregation completed (*possibly with errors*). CANCELLED - Aggregation cancelled by user. RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance. TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance. | [optional]
**TotalAccounts** | Pointer to **Int32** | The total number of *NEW, CHANGED and DELETED* accounts that need to be processed for this aggregation. This does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no new, changed or deleted accounts since the previous aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
**ProcessedAccounts** | Pointer to **Int32** | The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
## Examples
- Prepare the resource
```powershell
$AccountAggregation = Initialize-PSSailpoint.BetaAccountAggregation -Start 2021-01-31T14:30:05.104Z `
-Status ACCOUNTS_COLLECTED `
-TotalAccounts 520 `
-ProcessedAccounts 150
```
- Convert the resource to JSON
```powershell
$AccountAggregation | ConvertTo-JSON
```
[[Back to top]](#)

47
docs/tools/sdk/powershell/Reference/Beta/Models/AccountAggregationCompleted.md Normal file
View File

@@ -0,0 +1,47 @@
---
id: beta-account-aggregation-completed
title: AccountAggregationCompleted
pagination_label: AccountAggregationCompleted
sidebar_label: AccountAggregationCompleted
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAggregationCompleted', 'BetaAccountAggregationCompleted']
slug: /tools/sdk/powershell/beta/models/account-aggregation-completed
tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompleted', 'BetaAccountAggregationCompleted']
---
# AccountAggregationCompleted
## Properties
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]
**Stats** | [**AccountAggregationCompletedStats**](account-aggregation-completed-stats) | | [required]
## Examples
- Prepare the resource
```powershell
$AccountAggregationCompleted = Initialize-PSSailpoint.BetaAccountAggregationCompleted -Source null `
-Status Success `
-Started 2020-06-29T22:01:50.474Z `
-Completed 2020-06-29T22:02:04.090Z `
-Errors null `
-Warnings null `
-Stats null
```
- Convert the resource to JSON
```powershell
$AccountAggregationCompleted | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -0,0 +1,39 @@
---
id: beta-account-aggregation-completed-source
title: AccountAggregationCompletedSource
pagination_label: AccountAggregationCompletedSource
sidebar_label: AccountAggregationCompletedSource
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAggregationCompletedSource', 'BetaAccountAggregationCompletedSource']
slug: /tools/sdk/powershell/beta/models/account-aggregation-completed-source
tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompletedSource', 'BetaAccountAggregationCompletedSource']
---
# AccountAggregationCompletedSource
## Properties
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]
## Examples
- Prepare the resource
```powershell
$AccountAggregationCompletedSource = Initialize-PSSailpoint.BetaAccountAggregationCompletedSource -Type SOURCE `
-Id 2c9180835d191a86015d28455b4b232a `
-Name HR Active Directory
```
- Convert the resource to JSON
```powershell
$AccountAggregationCompletedSource | ConvertTo-JSON
```
[[Back to top]](#)

43
docs/tools/sdk/powershell/Reference/Beta/Models/AccountAggregationCompletedStats.md Normal file
View File

@@ -0,0 +1,43 @@
---
id: beta-account-aggregation-completed-stats
title: AccountAggregationCompletedStats
pagination_label: AccountAggregationCompletedStats
sidebar_label: AccountAggregationCompletedStats
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAggregationCompletedStats', 'BetaAccountAggregationCompletedStats']
slug: /tools/sdk/powershell/beta/models/account-aggregation-completed-stats
tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompletedStats', 'BetaAccountAggregationCompletedStats']
---
# AccountAggregationCompletedStats
## Properties
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]
## Examples
- Prepare the resource
```powershell
$AccountAggregationCompletedStats = Initialize-PSSailpoint.BetaAccountAggregationCompletedStats -Scanned 200 `
-Unchanged 190 `
-Changed 6 `
-Added 4 `
-Removed 3
```
- Convert the resource to JSON
```powershell
$AccountAggregationCompletedStats | ConvertTo-JSON
```
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/Beta/Models/AccountAggregationStatus.md Normal file
View File

@@ -0,0 +1,41 @@
---
id: beta-account-aggregation-status
title: AccountAggregationStatus
pagination_label: AccountAggregationStatus
sidebar_label: AccountAggregationStatus
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAggregationStatus', 'BetaAccountAggregationStatus']
slug: /tools/sdk/powershell/beta/models/account-aggregation-status
tags: ['SDK', 'Software Development Kit', 'AccountAggregationStatus', 'BetaAccountAggregationStatus']
---
# AccountAggregationStatus
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Start** | Pointer to **System.DateTime** | When the aggregation started. | [optional]
**Status** | Pointer to **Enum** [ "STARTED", "ACCOUNTS_COLLECTED", "COMPLETED", "CANCELLED", "RETRIED", "TERMINATED" ] | STARTED - Aggregation started, but source account iteration has not completed. ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed. COMPLETED - Aggregation completed (*possibly with errors*). CANCELLED - Aggregation cancelled by user. RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance. TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance. | [optional]
**TotalAccounts** | Pointer to **Int32** | The total number of *NEW, CHANGED and DELETED* accounts that need to be processed for this aggregation. This does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no new, changed or deleted accounts since the previous aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
**ProcessedAccounts** | Pointer to **Int32** | The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
## Examples
- Prepare the resource
```powershell
$AccountAggregationStatus = Initialize-PSSailpoint.BetaAccountAggregationStatus -Start 2021-01-31T14:30:05.104Z `
-Status ACCOUNTS_COLLECTED `
-TotalAccounts 520 `
-ProcessedAccounts 150
```
- Convert the resource to JSON
```powershell
$AccountAggregationStatus | ConvertTo-JSON
```
[[Back to top]](#)

51
docs/tools/sdk/powershell/Reference/Beta/Models/AccountAttribute.md Normal file
View File

@@ -0,0 +1,51 @@
---
id: beta-account-attribute
title: AccountAttribute
pagination_label: AccountAttribute
sidebar_label: AccountAttribute
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttribute', 'BetaAccountAttribute']
slug: /tools/sdk/powershell/beta/models/account-attribute
tags: ['SDK', 'Software Development Kit', 'AccountAttribute', 'BetaAccountAttribute']
---
# AccountAttribute
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**SourceName** | **String** | A reference to the source to search for the account | [required]
**AttributeName** | **String** | The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema. | [required]
**AccountSortAttribute** | Pointer to **String** | The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries | [optional] [default to "created"]
**AccountSortDescending** | Pointer to **Boolean** | The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order) | [optional] [default to $false]
**AccountReturnFirstLink** | Pointer to **Boolean** | The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false | [optional] [default to $false]
**AccountFilter** | Pointer to **String** | This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements | [optional]
**AccountPropertyFilter** | Pointer to **String** | This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. All account attributes are available for filtering as this operation is performed in memory. | [optional]
**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false]
**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional]
## Examples
- Prepare the resource
```powershell
$AccountAttribute = Initialize-PSSailpoint.BetaAccountAttribute -SourceName Workday `
-AttributeName DEPARTMENT `
-AccountSortAttribute created `
-AccountSortDescending false `
-AccountReturnFirstLink false `
-AccountFilter !(nativeIdentity.startsWith("*DELETED*")) `
-AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') `
-RequiresPeriodicRefresh false `
-VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}}
```
- Convert the resource to JSON
```powershell
$AccountAttribute | ConvertTo-JSON
```
[[Back to top]](#)

35
docs/tools/sdk/powershell/Reference/Beta/Models/AccountAttributes.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: beta-account-attributes
title: AccountAttributes
pagination_label: AccountAttributes
sidebar_label: AccountAttributes
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributes', 'BetaAccountAttributes']
slug: /tools/sdk/powershell/beta/models/account-attributes
tags: ['SDK', 'Software Development Kit', 'AccountAttributes', 'BetaAccountAttributes']
---
# AccountAttributes
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Attributes** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The schema attribute values for the account | [required]
## Examples
- Prepare the resource
```powershell
$AccountAttributes = Initialize-PSSailpoint.BetaAccountAttributes -Attributes {city=Austin, displayName=John Doe, userName=jdoe, sAMAccountName=jDoe, mail=john.doe@sailpoint.com}
```
- Convert the resource to JSON
```powershell
$AccountAttributes | ConvertTo-JSON
```
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/Beta/Models/AccountAttributesChanged.md Normal file
View File

@@ -0,0 +1,41 @@
---
id: beta-account-attributes-changed
title: AccountAttributesChanged
pagination_label: AccountAttributesChanged
sidebar_label: AccountAttributesChanged
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesChanged', 'BetaAccountAttributesChanged']
slug: /tools/sdk/powershell/beta/models/account-attributes-changed
tags: ['SDK', 'Software Development Kit', 'AccountAttributesChanged', 'BetaAccountAttributesChanged']
---
# AccountAttributesChanged
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Identity** | [**AccountAttributesChangedIdentity**](account-attributes-changed-identity) | | [required]
**Source** | [**AccountAttributesChangedSource**](account-attributes-changed-source) | | [required]
**Account** | [**AccountAttributesChangedAccount**](account-attributes-changed-account) | | [required]
**Changes** | [**[]AccountAttributesChangedChangesInner**](account-attributes-changed-changes-inner) | A list of attributes that changed. | [required]
## Examples
- Prepare the resource
```powershell
$AccountAttributesChanged = Initialize-PSSailpoint.BetaAccountAttributesChanged -Identity null `
-Source null `
-Account null `
-Changes null
```
- Convert the resource to JSON
```powershell
$AccountAttributesChanged | ConvertTo-JSON
```
[[Back to top]](#)

43
docs/tools/sdk/powershell/Reference/Beta/Models/AccountAttributesChangedAccount.md Normal file
View File

@@ -0,0 +1,43 @@
---
id: beta-account-attributes-changed-account
title: AccountAttributesChangedAccount
pagination_label: AccountAttributesChangedAccount
sidebar_label: AccountAttributesChangedAccount
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesChangedAccount', 'BetaAccountAttributesChangedAccount']
slug: /tools/sdk/powershell/beta/models/account-attributes-changed-account
tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedAccount', 'BetaAccountAttributesChangedAccount']
---
# AccountAttributesChangedAccount
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | SailPoint generated unique identifier. | [required]
**Uuid** | **String** | The source's unique identifier for the account. UUID is generated by the source system. | [required]
**Name** | **String** | Name of the account. | [required]
**NativeIdentity** | **String** | Unique ID of the account on the source. | [required]
**Type** | **Enum** [ "ACCOUNT" ] | The type of the account | [required]
## Examples
- Prepare the resource
```powershell
$AccountAttributesChangedAccount = Initialize-PSSailpoint.BetaAccountAttributesChangedAccount -Id 52170a74-ca89-11ea-87d0-0242ac130003 `
-Uuid 1cb1f07d-3e5a-4431-becd-234fa4306108 `
-Name john.doe `
-NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com `
-Type ACCOUNT
```
- Convert the resource to JSON
```powershell
$AccountAttributesChangedAccount | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -0,0 +1,39 @@
---
id: beta-account-attributes-changed-changes-inner
title: AccountAttributesChangedChangesInner
pagination_label: AccountAttributesChangedChangesInner
sidebar_label: AccountAttributesChangedChangesInner
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesChangedChangesInner', 'BetaAccountAttributesChangedChangesInner']
slug: /tools/sdk/powershell/beta/models/account-attributes-changed-changes-inner
tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInner', 'BetaAccountAttributesChangedChangesInner']
---
# AccountAttributesChangedChangesInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Attribute** | **String** | The name of the attribute. | [required]
**OldValue** | [**AccountAttributesChangedChangesInnerOldValue**](account-attributes-changed-changes-inner-old-value) | | [required]
**NewValue** | [**AccountAttributesChangedChangesInnerNewValue**](account-attributes-changed-changes-inner-new-value) | | [required]
## Examples
- Prepare the resource
```powershell
$AccountAttributesChangedChangesInner = Initialize-PSSailpoint.BetaAccountAttributesChangedChangesInner -Attribute sn `
-OldValue null `
-NewValue null
```
- Convert the resource to JSON
```powershell
$AccountAttributesChangedChangesInner | ConvertTo-JSON
```
[[Back to top]](#)

34
docs/tools/sdk/powershell/Reference/Beta/Models/AccountAttributesChangedChangesInnerNewValue.md Normal file
View File

@@ -0,0 +1,34 @@
---
id: beta-account-attributes-changed-changes-inner-new-value
title: AccountAttributesChangedChangesInnerNewValue
pagination_label: AccountAttributesChangedChangesInnerNewValue
sidebar_label: AccountAttributesChangedChangesInnerNewValue
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesChangedChangesInnerNewValue', 'BetaAccountAttributesChangedChangesInnerNewValue']
slug: /tools/sdk/powershell/beta/models/account-attributes-changed-changes-inner-new-value
tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInnerNewValue', 'BetaAccountAttributesChangedChangesInnerNewValue']
---
# AccountAttributesChangedChangesInnerNewValue
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
## Examples
- Prepare the resource
```powershell
$AccountAttributesChangedChangesInnerNewValue = Initialize-PSSailpoint.BetaAccountAttributesChangedChangesInnerNewValue
```
- Convert the resource to JSON
```powershell
$AccountAttributesChangedChangesInnerNewValue | ConvertTo-JSON
```
[[Back to top]](#)

34
docs/tools/sdk/powershell/Reference/Beta/Models/AccountAttributesChangedChangesInnerOldValue.md Normal file
View File

@@ -0,0 +1,34 @@
---
id: beta-account-attributes-changed-changes-inner-old-value
title: AccountAttributesChangedChangesInnerOldValue
pagination_label: AccountAttributesChangedChangesInnerOldValue
sidebar_label: AccountAttributesChangedChangesInnerOldValue
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesChangedChangesInnerOldValue', 'BetaAccountAttributesChangedChangesInnerOldValue']
slug: /tools/sdk/powershell/beta/models/account-attributes-changed-changes-inner-old-value
tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInnerOldValue', 'BetaAccountAttributesChangedChangesInnerOldValue']
---
# AccountAttributesChangedChangesInnerOldValue
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
## Examples
- Prepare the resource
```powershell
$AccountAttributesChangedChangesInnerOldValue = Initialize-PSSailpoint.BetaAccountAttributesChangedChangesInnerOldValue
```
- Convert the resource to JSON
```powershell
$AccountAttributesChangedChangesInnerOldValue | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -0,0 +1,39 @@
---
id: beta-account-attributes-changed-identity
title: AccountAttributesChangedIdentity
pagination_label: AccountAttributesChangedIdentity
sidebar_label: AccountAttributesChangedIdentity
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesChangedIdentity', 'BetaAccountAttributesChangedIdentity']
slug: /tools/sdk/powershell/beta/models/account-attributes-changed-identity
tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedIdentity', 'BetaAccountAttributesChangedIdentity']
---
# AccountAttributesChangedIdentity
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "IDENTITY" ] | DTO type of the identity whose account attributes were updated. | [required]
**Id** | **String** | ID of the identity whose account attributes were updated. | [required]
**Name** | **String** | Display name of the identity whose account attributes were updated. | [required]
## Examples
- Prepare the resource
```powershell
$AccountAttributesChangedIdentity = Initialize-PSSailpoint.BetaAccountAttributesChangedIdentity -Type IDENTITY `
-Id 2c7180a46faadee4016fb4e018c20642 `
-Name Michael Michaels
```
- Convert the resource to JSON
```powershell
$AccountAttributesChangedIdentity | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -0,0 +1,39 @@
---
id: beta-account-attributes-changed-source
title: AccountAttributesChangedSource
pagination_label: AccountAttributesChangedSource
sidebar_label: AccountAttributesChangedSource
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesChangedSource', 'BetaAccountAttributesChangedSource']
slug: /tools/sdk/powershell/beta/models/account-attributes-changed-source
tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedSource', 'BetaAccountAttributesChangedSource']
---
# AccountAttributesChangedSource
## Properties
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]
## Examples
- Prepare the resource
```powershell
$AccountAttributesChangedSource = Initialize-PSSailpoint.BetaAccountAttributesChangedSource -Id 4e4d982dddff4267ab12f0f1e72b5a6d `
-Type SOURCE `
-Name Corporate Active Directory
```
- Convert the resource to JSON
```powershell
$AccountAttributesChangedSource | ConvertTo-JSON
```
[[Back to top]](#)

35
docs/tools/sdk/powershell/Reference/Beta/Models/AccountAttributesCreate.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: beta-account-attributes-create
title: AccountAttributesCreate
pagination_label: AccountAttributesCreate
sidebar_label: AccountAttributesCreate
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesCreate', 'BetaAccountAttributesCreate']
slug: /tools/sdk/powershell/beta/models/account-attributes-create
tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreate', 'BetaAccountAttributesCreate']
---
# AccountAttributesCreate
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Attributes** | [**AccountAttributesCreateAttributes**](account-attributes-create-attributes) | | [required]
## Examples
- Prepare the resource
```powershell
$AccountAttributesCreate = Initialize-PSSailpoint.BetaAccountAttributesCreate -Attributes null
```
- Convert the resource to JSON
```powershell
$AccountAttributesCreate | ConvertTo-JSON
```
[[Back to top]](#)

35
docs/tools/sdk/powershell/Reference/Beta/Models/AccountAttributesCreateAttributes.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: beta-account-attributes-create-attributes
title: AccountAttributesCreateAttributes
pagination_label: AccountAttributesCreateAttributes
sidebar_label: AccountAttributesCreateAttributes
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesCreateAttributes', 'BetaAccountAttributesCreateAttributes']
slug: /tools/sdk/powershell/beta/models/account-attributes-create-attributes
tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreateAttributes', 'BetaAccountAttributesCreateAttributes']
---
# AccountAttributesCreateAttributes
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**SourceId** | **String** | Target source to create an account | [required]
## Examples
- Prepare the resource
```powershell
$AccountAttributesCreateAttributes = Initialize-PSSailpoint.BetaAccountAttributesCreateAttributes -SourceId 34bfcbe116c9407464af37acbaf7a4dc
```
- Convert the resource to JSON
```powershell
$AccountAttributesCreateAttributes | ConvertTo-JSON
```
[[Back to top]](#)

43
docs/tools/sdk/powershell/Reference/Beta/Models/AccountCorrelated.md Normal file
View File

@@ -0,0 +1,43 @@
---
id: beta-account-correlated
title: AccountCorrelated
pagination_label: AccountCorrelated
sidebar_label: AccountCorrelated
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountCorrelated', 'BetaAccountCorrelated']
slug: /tools/sdk/powershell/beta/models/account-correlated
tags: ['SDK', 'Software Development Kit', 'AccountCorrelated', 'BetaAccountCorrelated']
---
# AccountCorrelated
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Identity** | [**AccountCorrelatedIdentity**](account-correlated-identity) | | [required]
**Source** | [**AccountCorrelatedSource**](account-correlated-source) | | [required]
**Account** | [**AccountCorrelatedAccount**](account-correlated-account) | | [required]
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes associated with the account. Attributes are unique per source. | [required]
**EntitlementCount** | Pointer to **Int32** | The number of entitlements associated with this account. | [optional]
## Examples
- Prepare the resource
```powershell
$AccountCorrelated = Initialize-PSSailpoint.BetaAccountCorrelated -Identity null `
-Source null `
-Account null `
-Attributes {sn=doe, givenName=john, memberOf=[cn=g1,ou=groups,dc=acme,dc=com, cn=g2,ou=groups,dc=acme,dc=com, cn=g3,ou=groups,dc=acme,dc=com]} `
-EntitlementCount 0
```
- Convert the resource to JSON
```powershell
$AccountCorrelated | ConvertTo-JSON
```
[[Back to top]](#)

43
docs/tools/sdk/powershell/Reference/Beta/Models/AccountCorrelatedAccount.md Normal file
View File

@@ -0,0 +1,43 @@
---
id: beta-account-correlated-account
title: AccountCorrelatedAccount
pagination_label: AccountCorrelatedAccount
sidebar_label: AccountCorrelatedAccount
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountCorrelatedAccount', 'BetaAccountCorrelatedAccount']
slug: /tools/sdk/powershell/beta/models/account-correlated-account
tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedAccount', 'BetaAccountCorrelatedAccount']
---
# AccountCorrelatedAccount
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "ACCOUNT" ] | The correlated account's DTO type. | [required]
**Id** | **String** | The correlated account's ID. | [required]
**Name** | **String** | The correlated account's display name. | [required]
**NativeIdentity** | **String** | Unique ID of the account on the source. | [required]
**Uuid** | Pointer to **String** | The source's unique identifier for the account. UUID is generated by the source system. | [optional]
## Examples
- Prepare the resource
```powershell
$AccountCorrelatedAccount = Initialize-PSSailpoint.BetaAccountCorrelatedAccount -Type ACCOUNT `
-Id 98da47c31df444558c211f9b205184f6 `
-Name Brian Mendoza `
-NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com `
-Uuid 1cb1f07d-3e5a-4431-becd-234fa4306108
```
- Convert the resource to JSON
```powershell
$AccountCorrelatedAccount | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -0,0 +1,39 @@
---
id: beta-account-correlated-identity
title: AccountCorrelatedIdentity
pagination_label: AccountCorrelatedIdentity
sidebar_label: AccountCorrelatedIdentity
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountCorrelatedIdentity', 'BetaAccountCorrelatedIdentity']
slug: /tools/sdk/powershell/beta/models/account-correlated-identity
tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedIdentity', 'BetaAccountCorrelatedIdentity']
---
# AccountCorrelatedIdentity
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "IDENTITY" ] | DTO type of the identity the account is correlated with. | [required]
**Id** | **String** | ID of the identity the account is correlated with. | [required]
**Name** | **String** | Display name of the identity the account is correlated with. | [required]
## Examples
- Prepare the resource
```powershell
$AccountCorrelatedIdentity = Initialize-PSSailpoint.BetaAccountCorrelatedIdentity -Type IDENTITY `
-Id 2c7180a46faadee4016fb4e018c20642 `
-Name Michael Michaels
```
- Convert the resource to JSON
```powershell
$AccountCorrelatedIdentity | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -0,0 +1,39 @@
---
id: beta-account-correlated-source
title: AccountCorrelatedSource
pagination_label: AccountCorrelatedSource
sidebar_label: AccountCorrelatedSource
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountCorrelatedSource', 'BetaAccountCorrelatedSource']
slug: /tools/sdk/powershell/beta/models/account-correlated-source
tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedSource', 'BetaAccountCorrelatedSource']
---
# AccountCorrelatedSource
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "SOURCE" ] | The DTO type of the source the accounts are being correlated from. | [required]
**Id** | **String** | The ID of the source the accounts are being correlated from. | [required]
**Name** | **String** | Display name of the source the accounts are being correlated from. | [required]
## Examples
- Prepare the resource
```powershell
$AccountCorrelatedSource = Initialize-PSSailpoint.BetaAccountCorrelatedSource -Type SOURCE `
-Id 2c9180835d191a86015d28455b4b232a `
-Name HR Active Directory
```
- Convert the resource to JSON
```powershell
$AccountCorrelatedSource | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -0,0 +1,39 @@
---
id: beta-account-info-dto
title: AccountInfoDto
pagination_label: AccountInfoDto
sidebar_label: AccountInfoDto
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountInfoDto', 'BetaAccountInfoDto']
slug: /tools/sdk/powershell/beta/models/account-info-dto
tags: ['SDK', 'Software Development Kit', 'AccountInfoDto', 'BetaAccountInfoDto']
---
# AccountInfoDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**NativeIdentity** | Pointer to **String** | The unique ID of the account generated by the source system | [optional]
**DisplayName** | Pointer to **String** | Display name for this account | [optional]
**Uuid** | Pointer to **String** | UUID associated with this account | [optional]
## Examples
- Prepare the resource
```powershell
$AccountInfoDto = Initialize-PSSailpoint.BetaAccountInfoDto -NativeIdentity CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com `
-DisplayName Abby.Smith `
-Uuid {ad9fc391-246d-40af-b248-b6556a2b7c01}
```
- Convert the resource to JSON
```powershell
$AccountInfoDto | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -0,0 +1,39 @@
---
id: beta-account-request-info
title: AccountRequestInfo
pagination_label: AccountRequestInfo
sidebar_label: AccountRequestInfo
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountRequestInfo', 'BetaAccountRequestInfo']
slug: /tools/sdk/powershell/beta/models/account-request-info
tags: ['SDK', 'Software Development Kit', 'AccountRequestInfo', 'BetaAccountRequestInfo']
---
# AccountRequestInfo
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**RequestedObjectId** | Pointer to **String** | Id of requested object | [optional]
**RequestedObjectName** | Pointer to **String** | Human-readable name of requested object | [optional]
**RequestedObjectType** | Pointer to [**RequestableObjectType**](requestable-object-type) | | [optional]
## Examples
- Prepare the resource
```powershell
$AccountRequestInfo = Initialize-PSSailpoint.BetaAccountRequestInfo -RequestedObjectId 2c91808563ef85690164001c31140c0c `
-RequestedObjectName Treasury Analyst `
-RequestedObjectType null
```
- Convert the resource to JSON
```powershell
$AccountRequestInfo | ConvertTo-JSON
```
[[Back to top]](#)

43
docs/tools/sdk/powershell/Reference/Beta/Models/AccountStatusChanged.md Normal file
View File

@@ -0,0 +1,43 @@
---
id: beta-account-status-changed
title: AccountStatusChanged
pagination_label: AccountStatusChanged
sidebar_label: AccountStatusChanged
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountStatusChanged', 'BetaAccountStatusChanged']
slug: /tools/sdk/powershell/beta/models/account-status-changed
tags: ['SDK', 'Software Development Kit', 'AccountStatusChanged', 'BetaAccountStatusChanged']
---
# AccountStatusChanged
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**EventType** | Pointer to **String** | the event type | [optional]
**IdentityId** | Pointer to **String** | the identity id | [optional]
**Dt** | Pointer to **String** | the date of event | [optional]
**Account** | Pointer to [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional]
**StatusChange** | Pointer to [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [optional]
## Examples
- Prepare the resource
```powershell
$AccountStatusChanged = Initialize-PSSailpoint.BetaAccountStatusChanged -EventType null `
-IdentityId null `
-Dt null `
-Account null `
-StatusChange null
```
- Convert the resource to JSON
```powershell
$AccountStatusChanged | ConvertTo-JSON
```
[[Back to top]](#)

47
docs/tools/sdk/powershell/Reference/Beta/Models/AccountStatusChangedAccount.md Normal file
View File

@@ -0,0 +1,47 @@
---
id: beta-account-status-changed-account
title: AccountStatusChangedAccount
pagination_label: AccountStatusChangedAccount
sidebar_label: AccountStatusChangedAccount
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountStatusChangedAccount', 'BetaAccountStatusChangedAccount']
slug: /tools/sdk/powershell/beta/models/account-status-changed-account
tags: ['SDK', 'Software Development Kit', 'AccountStatusChangedAccount', 'BetaAccountStatusChangedAccount']
---
# AccountStatusChangedAccount
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | the ID of the account in the database | [optional]
**NativeIdentity** | Pointer to **String** | the native identifier of the account | [optional]
**DisplayName** | Pointer to **String** | the display name of the account | [optional]
**SourceId** | Pointer to **String** | the ID of the source for this account | [optional]
**SourceName** | Pointer to **String** | the name of the source for this account | [optional]
**EntitlementCount** | Pointer to **Int32** | the number of entitlements on this account | [optional]
**AccessType** | Pointer to **String** | this value is always ""account"" | [optional]
## Examples
- Prepare the resource
```powershell
$AccountStatusChangedAccount = Initialize-PSSailpoint.BetaAccountStatusChangedAccount -Id null `
-NativeIdentity null `
-DisplayName null `
-SourceId null `
-SourceName null `
-EntitlementCount null `
-AccessType null
```
- Convert the resource to JSON
```powershell
$AccountStatusChangedAccount | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/Beta/Models/AccountStatusChangedStatusChange.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: beta-account-status-changed-status-change
title: AccountStatusChangedStatusChange
pagination_label: AccountStatusChangedStatusChange
sidebar_label: AccountStatusChangedStatusChange
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountStatusChangedStatusChange', 'BetaAccountStatusChangedStatusChange']
slug: /tools/sdk/powershell/beta/models/account-status-changed-status-change
tags: ['SDK', 'Software Development Kit', 'AccountStatusChangedStatusChange', 'BetaAccountStatusChangedStatusChange']
---
# AccountStatusChangedStatusChange
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**PreviousStatus** | Pointer to **Enum** [ "enabled", "disabled", "locked" ] | the previous status of the account | [optional]
**NewStatus** | Pointer to **Enum** [ "enabled", "disabled", "locked" ] | the new status of the account | [optional]
## Examples
- Prepare the resource
```powershell
$AccountStatusChangedStatusChange = Initialize-PSSailpoint.BetaAccountStatusChangedStatusChange -PreviousStatus null `
-NewStatus null
```
- Convert the resource to JSON
```powershell
$AccountStatusChangedStatusChange | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/Beta/Models/AccountToggleRequest.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: beta-account-toggle-request
title: AccountToggleRequest
pagination_label: AccountToggleRequest
sidebar_label: AccountToggleRequest
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountToggleRequest', 'BetaAccountToggleRequest']
slug: /tools/sdk/powershell/beta/models/account-toggle-request
tags: ['SDK', 'Software Development Kit', 'AccountToggleRequest', 'BetaAccountToggleRequest']
---
# AccountToggleRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ExternalVerificationId** | Pointer to **String** | If set, an external process validates that the user wants to proceed with this request. | [optional]
**ForceProvisioning** | Pointer to **Boolean** | If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. | [optional]
## Examples
- Prepare the resource
```powershell
$AccountToggleRequest = Initialize-PSSailpoint.BetaAccountToggleRequest -ExternalVerificationId 3f9180835d2e5168015d32f890ca1581 `
-ForceProvisioning false
```
- Convert the resource to JSON
```powershell
$AccountToggleRequest | ConvertTo-JSON
```
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/Beta/Models/AccountUncorrelated.md Normal file
View File

@@ -0,0 +1,41 @@
---
id: beta-account-uncorrelated
title: AccountUncorrelated
pagination_label: AccountUncorrelated
sidebar_label: AccountUncorrelated
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUncorrelated', 'BetaAccountUncorrelated']
slug: /tools/sdk/powershell/beta/models/account-uncorrelated
tags: ['SDK', 'Software Development Kit', 'AccountUncorrelated', 'BetaAccountUncorrelated']
---
# AccountUncorrelated
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Identity** | [**AccountUncorrelatedIdentity**](account-uncorrelated-identity) | | [required]
**Source** | [**AccountUncorrelatedSource**](account-uncorrelated-source) | | [required]
**Account** | [**AccountUncorrelatedAccount**](account-uncorrelated-account) | | [required]
**EntitlementCount** | Pointer to **Int32** | The number of entitlements associated with this account. | [optional]
## Examples
- Prepare the resource
```powershell
$AccountUncorrelated = Initialize-PSSailpoint.BetaAccountUncorrelated -Identity null `
-Source null `
-Account null `
-EntitlementCount 0
```
- Convert the resource to JSON
```powershell
$AccountUncorrelated | ConvertTo-JSON
```
[[Back to top]](#)

43
docs/tools/sdk/powershell/Reference/Beta/Models/AccountUncorrelatedAccount.md Normal file
View File

@@ -0,0 +1,43 @@
---
id: beta-account-uncorrelated-account
title: AccountUncorrelatedAccount
pagination_label: AccountUncorrelatedAccount
sidebar_label: AccountUncorrelatedAccount
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUncorrelatedAccount', 'BetaAccountUncorrelatedAccount']
slug: /tools/sdk/powershell/beta/models/account-uncorrelated-account
tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedAccount', 'BetaAccountUncorrelatedAccount']
---
# AccountUncorrelatedAccount
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "ACCOUNT" ] | Uncorrelated account's DTO type. | [required]
**Id** | **String** | Uncorrelated account's ID. | [required]
**Name** | **String** | Uncorrelated account's display name. | [required]
**NativeIdentity** | **String** | Unique ID of the account on the source. | [required]
**Uuid** | Pointer to **String** | The source's unique identifier for the account. UUID is generated by the source system. | [optional]
## Examples
- Prepare the resource
```powershell
$AccountUncorrelatedAccount = Initialize-PSSailpoint.BetaAccountUncorrelatedAccount -Type ACCOUNT `
-Id 4dd497e3723e439991cb6d0e478375dd `
-Name Sadie Jensen `
-NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com `
-Uuid 1cb1f07d-3e5a-4431-becd-234fa4306108
```
- Convert the resource to JSON
```powershell
$AccountUncorrelatedAccount | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -0,0 +1,39 @@
---
id: beta-account-uncorrelated-identity
title: AccountUncorrelatedIdentity
pagination_label: AccountUncorrelatedIdentity
sidebar_label: AccountUncorrelatedIdentity
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUncorrelatedIdentity', 'BetaAccountUncorrelatedIdentity']
slug: /tools/sdk/powershell/beta/models/account-uncorrelated-identity
tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedIdentity', 'BetaAccountUncorrelatedIdentity']
---
# AccountUncorrelatedIdentity
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "IDENTITY" ] | DTO type of the identity the account is uncorrelated with. | [required]
**Id** | **String** | ID of the identity the account is uncorrelated with. | [required]
**Name** | **String** | Display name of the identity the account is uncorrelated with. | [required]
## Examples
- Prepare the resource
```powershell
$AccountUncorrelatedIdentity = Initialize-PSSailpoint.BetaAccountUncorrelatedIdentity -Type IDENTITY `
-Id 2c3780a46faadee4016fb4e018c20652 `
-Name Allen Albertson
```
- Convert the resource to JSON
```powershell
$AccountUncorrelatedIdentity | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -0,0 +1,39 @@
---
id: beta-account-uncorrelated-source
title: AccountUncorrelatedSource
pagination_label: AccountUncorrelatedSource
sidebar_label: AccountUncorrelatedSource
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUncorrelatedSource', 'BetaAccountUncorrelatedSource']
slug: /tools/sdk/powershell/beta/models/account-uncorrelated-source
tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedSource', 'BetaAccountUncorrelatedSource']
---
# AccountUncorrelatedSource
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "SOURCE" ] | The DTO type of the source the accounts are uncorrelated from. | [required]
**Id** | **String** | The ID of the source the accounts are uncorrelated from. | [required]
**Name** | **String** | Display name of the source the accounts are uncorrelated from. | [required]
## Examples
- Prepare the resource
```powershell
$AccountUncorrelatedSource = Initialize-PSSailpoint.BetaAccountUncorrelatedSource -Type SOURCE `
-Id 2c6180835d191a86015d28455b4b231b `
-Name Corporate Directory
```
- Convert the resource to JSON
```powershell
$AccountUncorrelatedSource | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -0,0 +1,39 @@
---
id: beta-account-unlock-request
title: AccountUnlockRequest
pagination_label: AccountUnlockRequest
sidebar_label: AccountUnlockRequest
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUnlockRequest', 'BetaAccountUnlockRequest']
slug: /tools/sdk/powershell/beta/models/account-unlock-request
tags: ['SDK', 'Software Development Kit', 'AccountUnlockRequest', 'BetaAccountUnlockRequest']
---
# AccountUnlockRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ExternalVerificationId** | Pointer to **String** | If set, an external process validates that the user wants to proceed with this request. | [optional]
**UnlockIDNAccount** | Pointer to **Boolean** | If set, the IDN account is unlocked after the workflow completes. | [optional]
**ForceProvisioning** | Pointer to **Boolean** | If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. | [optional]
## Examples
- Prepare the resource
```powershell
$AccountUnlockRequest = Initialize-PSSailpoint.BetaAccountUnlockRequest -ExternalVerificationId 3f9180835d2e5168015d32f890ca1581 `
-UnlockIDNAccount false `
-ForceProvisioning false
```
- Convert the resource to JSON
```powershell
$AccountUnlockRequest | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: beta-account-usage
title: AccountUsage
pagination_label: AccountUsage
sidebar_label: AccountUsage
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUsage', 'BetaAccountUsage']
slug: /tools/sdk/powershell/beta/models/account-usage
tags: ['SDK', 'Software Development Kit', 'AccountUsage', 'BetaAccountUsage']
---
# AccountUsage
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Date** | Pointer to **System.DateTime** | The first day of the month for which activity is aggregated. | [optional]
**Count** | Pointer to **Int64** | The number of days within the month that the account was active in a source. | [optional]
## Examples
- Prepare the resource
```powershell
$AccountUsage = Initialize-PSSailpoint.BetaAccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 `
-Count 10
```
- Convert the resource to JSON
```powershell
$AccountUsage | ConvertTo-JSON
```
[[Back to top]](#)

35
docs/tools/sdk/powershell/Reference/Beta/Models/AccountsAsyncResult.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: beta-accounts-async-result
title: AccountsAsyncResult
pagination_label: AccountsAsyncResult
sidebar_label: AccountsAsyncResult
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountsAsyncResult', 'BetaAccountsAsyncResult']
slug: /tools/sdk/powershell/beta/models/accounts-async-result
tags: ['SDK', 'Software Development Kit', 'AccountsAsyncResult', 'BetaAccountsAsyncResult']
---
# AccountsAsyncResult
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | id of the task | [required]
## Examples
- Prepare the resource
```powershell
$AccountsAsyncResult = Initialize-PSSailpoint.BetaAccountsAsyncResult -Id 2c91808474683da6017468693c260195
```
- Convert the resource to JSON
```powershell
$AccountsAsyncResult | ConvertTo-JSON
```
[[Back to top]](#)

47
docs/tools/sdk/powershell/Reference/Beta/Models/AccountsCollectedForAggregation.md Normal file
View File

@@ -0,0 +1,47 @@
---
id: beta-accounts-collected-for-aggregation
title: AccountsCollectedForAggregation
pagination_label: AccountsCollectedForAggregation
sidebar_label: AccountsCollectedForAggregation
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountsCollectedForAggregation', 'BetaAccountsCollectedForAggregation']
slug: /tools/sdk/powershell/beta/models/accounts-collected-for-aggregation
tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregation', 'BetaAccountsCollectedForAggregation']
---
# AccountsCollectedForAggregation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Source** | [**AccountsCollectedForAggregationSource**](accounts-collected-for-aggregation-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 errors that occurred during the collection. | [required]
**Warnings** | **[]String** | A list of warnings that occurred during the collection. | [required]
**Stats** | [**AccountsCollectedForAggregationStats**](accounts-collected-for-aggregation-stats) | | [required]
## Examples
- Prepare the resource
```powershell
$AccountsCollectedForAggregation = Initialize-PSSailpoint.BetaAccountsCollectedForAggregation -Source null `
-Status Success `
-Started 2020-06-29T22:01:50.474Z `
-Completed 2020-06-29T22:02:04.090Z `
-Errors null `
-Warnings null `
-Stats null
```
- Convert the resource to JSON
```powershell
$AccountsCollectedForAggregation | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -0,0 +1,39 @@
---
id: beta-accounts-collected-for-aggregation-source
title: AccountsCollectedForAggregationSource
pagination_label: AccountsCollectedForAggregationSource
sidebar_label: AccountsCollectedForAggregationSource
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountsCollectedForAggregationSource', 'BetaAccountsCollectedForAggregationSource']
slug: /tools/sdk/powershell/beta/models/accounts-collected-for-aggregation-source
tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregationSource', 'BetaAccountsCollectedForAggregationSource']
---
# AccountsCollectedForAggregationSource
## Properties
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]
## Examples
- Prepare the resource
```powershell
$AccountsCollectedForAggregationSource = Initialize-PSSailpoint.BetaAccountsCollectedForAggregationSource -Id 4e4d982dddff4267ab12f0f1e72b5a6d `
-Type SOURCE `
-Name Corporate Active Directory
```
- Convert the resource to JSON
```powershell
$AccountsCollectedForAggregationSource | ConvertTo-JSON
```
[[Back to top]](#)

Some files were not shown because too many files have changed in this diff Show More