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

removing all the files that were added in the wrong locations

Browse Source
This commit is contained in:
darrell-thobe-sp
2025-02-03 13:35:16 -05:00
parent 611622805c
commit 870b5b29b0
2822 changed files with 0 additions and 199787 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
docs/tools/sdk/powershell/Reference/V3/Models/Models/Access.md
View File

@@ -1,43 +0,0 @@
---
id: access
title: Access
pagination_label: Access
sidebar_label: Access
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'Access', 'Access']
slug: /tools/sdk/powershell/v3/models/access
tags: ['SDK', 'Software Development Kit', 'Access', 'Access']
---
# Access
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | The unique ID of the referenced object. | [optional]
**Name** | Pointer to **String** | The human readable name of the referenced object. | [optional]
**DisplayName** | Pointer to **String** | | [optional]
**Type** | Pointer to [**DtoType**](dto-type) | | [optional]
**Description** | Pointer to **String** | | [optional]
## Examples
- Prepare the resource
```powershell
$Access = Initialize-PSSailpoint.V3Access -Id 2c91808568c529c60168cca6f90c1313 `
-Name John Doe `
-DisplayName John Q. Doe `
-Type null `
-Description null
```
- Convert the resource to JSON
```powershell
$Access | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccessConstraint.md
View File

@@ -1,39 +0,0 @@
---
id: access-constraint
title: AccessConstraint
pagination_label: AccessConstraint
sidebar_label: AccessConstraint
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessConstraint', 'AccessConstraint']
slug: /tools/sdk/powershell/v3/models/access-constraint
tags: ['SDK', 'Software Development Kit', 'AccessConstraint', 'AccessConstraint']
---
# 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.V3AccessConstraint -Type ENTITLEMENT `
-Ids [2c90ad2a70ace7d50170acf22ca90010] `
-Operator SELECTED
```
- Convert the resource to JSON
```powershell
$AccessConstraint | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccessCriteria.md
View File

@@ -1,37 +0,0 @@
---
id: access-criteria
title: AccessCriteria
pagination_label: AccessCriteria
sidebar_label: AccessCriteria
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessCriteria', 'AccessCriteria']
slug: /tools/sdk/powershell/v3/models/access-criteria
tags: ['SDK', 'Software Development Kit', 'AccessCriteria', 'AccessCriteria']
---
# 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.V3AccessCriteria -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/V3/Models/Models/AccessCriteriaCriteriaListInner.md
View File

@@ -1,39 +0,0 @@
---
id: access-criteria-criteria-list-inner
title: AccessCriteriaCriteriaListInner
pagination_label: AccessCriteriaCriteriaListInner
sidebar_label: AccessCriteriaCriteriaListInner
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessCriteriaCriteriaListInner', 'AccessCriteriaCriteriaListInner']
slug: /tools/sdk/powershell/v3/models/access-criteria-criteria-list-inner
tags: ['SDK', 'Software Development Kit', 'AccessCriteriaCriteriaListInner', 'AccessCriteriaCriteriaListInner']
---
# AccessCriteriaCriteriaListInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | Type of the propery to which this reference applies to | [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.V3AccessCriteriaCriteriaListInner -Type ENTITLEMENT `
-Id 2c91808568c529c60168cca6f90c1313 `
-Name Administrator
```
- Convert the resource to JSON
```powershell
$AccessCriteriaCriteriaListInner | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccessItemRequestedFor.md
View File

@@ -1,39 +0,0 @@
---
id: access-item-requested-for
title: AccessItemRequestedFor
pagination_label: AccessItemRequestedFor
sidebar_label: AccessItemRequestedFor
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemRequestedFor', 'AccessItemRequestedFor']
slug: /tools/sdk/powershell/v3/models/access-item-requested-for
tags: ['SDK', 'Software Development Kit', 'AccessItemRequestedFor', 'AccessItemRequestedFor']
---
# AccessItemRequestedFor
## 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
$AccessItemRequestedFor = Initialize-PSSailpoint.V3AccessItemRequestedFor -Type IDENTITY `
-Id 2c4180a46faadee4016fb4e018c20626 `
-Name Robert Robinson
```
- Convert the resource to JSON
```powershell
$AccessItemRequestedFor | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccessItemRequester.md
View File

@@ -1,39 +0,0 @@
---
id: access-item-requester
title: AccessItemRequester
pagination_label: AccessItemRequester
sidebar_label: AccessItemRequester
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemRequester', 'AccessItemRequester']
slug: /tools/sdk/powershell/v3/models/access-item-requester
tags: ['SDK', 'Software Development Kit', 'AccessItemRequester', 'AccessItemRequester']
---
# 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.V3AccessItemRequester -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/V3/Models/Models/AccessItemReviewedBy.md
View File

@@ -1,39 +0,0 @@
---
id: access-item-reviewed-by
title: AccessItemReviewedBy
pagination_label: AccessItemReviewedBy
sidebar_label: AccessItemReviewedBy
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemReviewedBy', 'AccessItemReviewedBy']
slug: /tools/sdk/powershell/v3/models/access-item-reviewed-by
tags: ['SDK', 'Software Development Kit', 'AccessItemReviewedBy', 'AccessItemReviewedBy']
---
# 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.V3AccessItemReviewedBy -Type IDENTITY `
-Id 2c3780a46faadee4016fb4e018c20652 `
-Name Allen Albertson
```
- Convert the resource to JSON
```powershell
$AccessItemReviewedBy | ConvertTo-JSON
```
[[Back to top]](#)

61
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccessProfile.md
View File

@@ -1,61 +0,0 @@
---
id: access-profile
title: AccessProfile
pagination_label: AccessProfile
sidebar_label: AccessProfile
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfile', 'AccessProfile']
slug: /tools/sdk/powershell/v3/models/access-profile
tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'AccessProfile']
---
# 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.V3AccessProfile -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/V3/Models/Models/AccessProfileApprovalScheme.md
View File

@@ -1,37 +0,0 @@
---
id: access-profile-approval-scheme
title: AccessProfileApprovalScheme
pagination_label: AccessProfileApprovalScheme
sidebar_label: AccessProfileApprovalScheme
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileApprovalScheme', 'AccessProfileApprovalScheme']
slug: /tools/sdk/powershell/v3/models/access-profile-approval-scheme
tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'AccessProfileApprovalScheme']
---
# 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.V3AccessProfileApprovalScheme -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/V3/Models/Models/AccessProfileBulkDeleteRequest.md
View File

@@ -1,37 +0,0 @@
---
id: access-profile-bulk-delete-request
title: AccessProfileBulkDeleteRequest
pagination_label: AccessProfileBulkDeleteRequest
sidebar_label: AccessProfileBulkDeleteRequest
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileBulkDeleteRequest', 'AccessProfileBulkDeleteRequest']
slug: /tools/sdk/powershell/v3/models/access-profile-bulk-delete-request
tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteRequest', 'AccessProfileBulkDeleteRequest']
---
# 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.V3AccessProfileBulkDeleteRequest -AccessProfileIds [2c9180847812e0b1017817051919ecca, 2c9180887812e0b201781e129f151816] `
-BestEffortOnly true
```
- Convert the resource to JSON
```powershell
$AccessProfileBulkDeleteRequest | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccessProfileBulkDeleteResponse.md
View File

@@ -1,39 +0,0 @@
---
id: access-profile-bulk-delete-response
title: AccessProfileBulkDeleteResponse
pagination_label: AccessProfileBulkDeleteResponse
sidebar_label: AccessProfileBulkDeleteResponse
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileBulkDeleteResponse', 'AccessProfileBulkDeleteResponse']
slug: /tools/sdk/powershell/v3/models/access-profile-bulk-delete-response
tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteResponse', 'AccessProfileBulkDeleteResponse']
---
# 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.V3AccessProfileBulkDeleteResponse -TaskId 2c9180867817ac4d017817c491119a20 `
-Pending [2c91808876438bbb017668c21919ecca, 2c91808876438bb201766e129f151816] `
-InUse null
```
- Convert the resource to JSON
```powershell
$AccessProfileBulkDeleteResponse | ConvertTo-JSON
```
[[Back to top]](#)

63
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccessProfileDocument.md
View File

@@ -1,63 +0,0 @@
---
id: access-profile-document
title: AccessProfileDocument
pagination_label: AccessProfileDocument
sidebar_label: AccessProfileDocument
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileDocument', 'AccessProfileDocument']
slug: /tools/sdk/powershell/v3/models/access-profile-document
tags: ['SDK', 'Software Development Kit', 'AccessProfileDocument', 'AccessProfileDocument']
---
# AccessProfileDocument
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | Access profile's ID. | [required]
**Name** | **String** | Access profile's name. | [required]
**Description** | Pointer to **String** | Access item's description. | [optional]
**Created** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**Modified** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
**Synced** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional]
**Enabled** | Pointer to **Boolean** | Indicates whether the access item is currently enabled. | [optional] [default to $false]
**Requestable** | Pointer to **Boolean** | Indicates whether the access item can be requested. | [optional] [default to $true]
**RequestCommentsRequired** | Pointer to **Boolean** | Indicates whether comments are required for requests to access the item. | [optional] [default to $false]
**Owner** | Pointer to [**BaseAccessAllOfOwner**](base-access-all-of-owner) | | [optional]
**Type** | **Enum** [ "accessprofile", "accountactivity", "account", "aggregation", "entitlement", "event", "identity", "role" ] | Access profile's document type. This enum represents the currently supported document types. Additional values may be added in the future without notice. | [required]
**Source** | Pointer to [**AccessProfileDocumentAllOfSource**](access-profile-document-all-of-source) | | [optional]
**Entitlements** | Pointer to [**[]BaseEntitlement**](base-entitlement) | Entitlements the access profile has access to. | [optional]
**EntitlementCount** | Pointer to **Int32** | Number of entitlements. | [optional]
**Tags** | Pointer to **[]String** | Tags that have been applied to the object. | [optional]
## Examples
- Prepare the resource
```powershell
$AccessProfileDocument = Initialize-PSSailpoint.V3AccessProfileDocument -Id 2c9180825a6c1adc015a71c9023f0818 `
-Name Cloud Eng `
-Description The admin role `
-Created 2018-06-25T20:22:28.104Z `
-Modified 2018-06-25T20:22:28.104Z `
-Synced 2018-06-25T20:22:33.104Z `
-Enabled true `
-Requestable true `
-RequestCommentsRequired false `
-Owner null `
-Type accessprofile `
-Source null `
-Entitlements null `
-EntitlementCount 5 `
-Tags [TAG_1, TAG_2]
```
- Convert the resource to JSON
```powershell
$AccessProfileDocument | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccessProfileDocumentAllOfSource.md
View File

@@ -1,37 +0,0 @@
---
id: access-profile-document-all-of-source
title: AccessProfileDocumentAllOfSource
pagination_label: AccessProfileDocumentAllOfSource
sidebar_label: AccessProfileDocumentAllOfSource
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileDocumentAllOfSource', 'AccessProfileDocumentAllOfSource']
slug: /tools/sdk/powershell/v3/models/access-profile-document-all-of-source
tags: ['SDK', 'Software Development Kit', 'AccessProfileDocumentAllOfSource', 'AccessProfileDocumentAllOfSource']
---
# AccessProfileDocumentAllOfSource
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | Source's ID. | [optional]
**Name** | Pointer to **String** | Source's name. | [optional]
## Examples
- Prepare the resource
```powershell
$AccessProfileDocumentAllOfSource = Initialize-PSSailpoint.V3AccessProfileDocumentAllOfSource -Id ff8081815757d4fb0157588f3d9d008f `
-Name Employees
```
- Convert the resource to JSON
```powershell
$AccessProfileDocumentAllOfSource | ConvertTo-JSON
```
[[Back to top]](#)

53
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccessProfileEntitlement.md
View File

@@ -1,53 +0,0 @@
---
id: access-profile-entitlement
title: AccessProfileEntitlement
pagination_label: AccessProfileEntitlement
sidebar_label: AccessProfileEntitlement
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileEntitlement', 'AccessProfileEntitlement']
slug: /tools/sdk/powershell/v3/models/access-profile-entitlement
tags: ['SDK', 'Software Development Kit', 'AccessProfileEntitlement', 'AccessProfileEntitlement']
---
# AccessProfileEntitlement
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | The unique ID of the referenced object. | [optional]
**Name** | Pointer to **String** | The human readable name of the referenced object. | [optional]
**DisplayName** | Pointer to **String** | | [optional]
**Type** | Pointer to [**DtoType**](dto-type) | | [optional]
**Description** | Pointer to **String** | | [optional]
**Source** | Pointer to [**Reference1**](reference1) | | [optional]
**Privileged** | Pointer to **Boolean** | | [optional]
**Attribute** | Pointer to **String** | | [optional]
**Value** | Pointer to **String** | | [optional]
**Standalone** | Pointer to **Boolean** | | [optional]
## Examples
- Prepare the resource
```powershell
$AccessProfileEntitlement = Initialize-PSSailpoint.V3AccessProfileEntitlement -Id 2c91808568c529c60168cca6f90c1313 `
-Name John Doe `
-DisplayName John Q. Doe `
-Type null `
-Description null `
-Source null `
-Privileged false `
-Attribute memberOf `
-Value CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com `
-Standalone false
```
- Convert the resource to JSON
```powershell
$AccessProfileEntitlement | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccessProfileRef.md
View File

@@ -1,39 +0,0 @@
---
id: access-profile-ref
title: AccessProfileRef
pagination_label: AccessProfileRef
sidebar_label: AccessProfileRef
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileRef', 'AccessProfileRef']
slug: /tools/sdk/powershell/v3/models/access-profile-ref
tags: ['SDK', 'Software Development Kit', 'AccessProfileRef', 'AccessProfileRef']
---
# 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.V3AccessProfileRef -Id ff808081751e6e129f1518161919ecca `
-Type ACCESS_PROFILE `
-Name Access Profile 2567
```
- Convert the resource to JSON
```powershell
$AccessProfileRef | ConvertTo-JSON
```
[[Back to top]](#)

49
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccessProfileRole.md
View File

@@ -1,49 +0,0 @@
---
id: access-profile-role
title: AccessProfileRole
pagination_label: AccessProfileRole
sidebar_label: AccessProfileRole
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileRole', 'AccessProfileRole']
slug: /tools/sdk/powershell/v3/models/access-profile-role
tags: ['SDK', 'Software Development Kit', 'AccessProfileRole', 'AccessProfileRole']
---
# AccessProfileRole
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | The unique ID of the referenced object. | [optional]
**Name** | Pointer to **String** | The human readable name of the referenced object. | [optional]
**DisplayName** | Pointer to **String** | | [optional]
**Type** | Pointer to [**DtoType**](dto-type) | | [optional]
**Description** | Pointer to **String** | | [optional]
**Owner** | Pointer to [**DisplayReference**](display-reference) | | [optional]
**Disabled** | Pointer to **Boolean** | | [optional]
**Revocable** | Pointer to **Boolean** | | [optional]
## Examples
- Prepare the resource
```powershell
$AccessProfileRole = Initialize-PSSailpoint.V3AccessProfileRole -Id 2c91808568c529c60168cca6f90c1313 `
-Name John Doe `
-DisplayName John Q. Doe `
-Type null `
-Description null `
-Owner null `
-Disabled null `
-Revocable null
```
- Convert the resource to JSON
```powershell
$AccessProfileRole | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccessProfileSourceRef.md
View File

@@ -1,39 +0,0 @@
---
id: access-profile-source-ref
title: AccessProfileSourceRef
pagination_label: AccessProfileSourceRef
sidebar_label: AccessProfileSourceRef
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileSourceRef', 'AccessProfileSourceRef']
slug: /tools/sdk/powershell/v3/models/access-profile-source-ref
tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'AccessProfileSourceRef']
---
# 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.V3AccessProfileSourceRef -Id 2c91809773dee3610173fdb0b6061ef4 `
-Type SOURCE `
-Name ODS-AD-SOURCE
```
- Convert the resource to JSON
```powershell
$AccessProfileSourceRef | ConvertTo-JSON
```
[[Back to top]](#)

49
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccessProfileSummary.md
View File

@@ -1,49 +0,0 @@
---
id: access-profile-summary
title: AccessProfileSummary
pagination_label: AccessProfileSummary
sidebar_label: AccessProfileSummary
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileSummary', 'AccessProfileSummary']
slug: /tools/sdk/powershell/v3/models/access-profile-summary
tags: ['SDK', 'Software Development Kit', 'AccessProfileSummary', 'AccessProfileSummary']
---
# AccessProfileSummary
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | The unique ID of the referenced object. | [optional]
**Name** | Pointer to **String** | The human readable name of the referenced object. | [optional]
**DisplayName** | Pointer to **String** | | [optional]
**Type** | Pointer to [**DtoType**](dto-type) | | [optional]
**Description** | Pointer to **String** | | [optional]
**Source** | Pointer to [**Reference1**](reference1) | | [optional]
**Owner** | Pointer to [**DisplayReference**](display-reference) | | [optional]
**Revocable** | Pointer to **Boolean** | | [optional]
## Examples
- Prepare the resource
```powershell
$AccessProfileSummary = Initialize-PSSailpoint.V3AccessProfileSummary -Id 2c91808568c529c60168cca6f90c1313 `
-Name John Doe `
-DisplayName John Q. Doe `
-Type null `
-Description null `
-Source null `
-Owner null `
-Revocable true
```
- Convert the resource to JSON
```powershell
$AccessProfileSummary | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccessProfileUsage.md
View File

@@ -1,37 +0,0 @@
---
id: access-profile-usage
title: AccessProfileUsage
pagination_label: AccessProfileUsage
sidebar_label: AccessProfileUsage
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileUsage', 'AccessProfileUsage']
slug: /tools/sdk/powershell/v3/models/access-profile-usage
tags: ['SDK', 'Software Development Kit', 'AccessProfileUsage', 'AccessProfileUsage']
---
# 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.V3AccessProfileUsage -AccessProfileId 2c91808876438bbb017668c21919ecca `
-UsedBy null
```
- Convert the resource to JSON
```powershell
$AccessProfileUsage | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccessProfileUsageUsedByInner.md
View File

@@ -1,39 +0,0 @@
---
id: access-profile-usage-used-by-inner
title: AccessProfileUsageUsedByInner
pagination_label: AccessProfileUsageUsedByInner
sidebar_label: AccessProfileUsageUsedByInner
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileUsageUsedByInner', 'AccessProfileUsageUsedByInner']
slug: /tools/sdk/powershell/v3/models/access-profile-usage-used-by-inner
tags: ['SDK', 'Software Development Kit', 'AccessProfileUsageUsedByInner', 'AccessProfileUsageUsedByInner']
---
# 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.V3AccessProfileUsageUsedByInner -Type ROLE `
-Id 2c8180857a9b3da0017aa03418480f9d `
-Name Manager Role
```
- Convert the resource to JSON
```powershell
$AccessProfileUsageUsedByInner | ConvertTo-JSON
```
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccessRequest.md
View File

@@ -1,41 +0,0 @@
---
id: access-request
title: AccessRequest
pagination_label: AccessRequest
sidebar_label: AccessRequest
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequest', 'AccessRequest']
slug: /tools/sdk/powershell/v3/models/access-request
tags: ['SDK', 'Software Development Kit', 'AccessRequest', 'AccessRequest']
---
# 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.V3AccessRequest -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/V3/Models/Models/AccessRequestConfig.md
View File

@@ -1,45 +0,0 @@
---
id: access-request-config
title: AccessRequestConfig
pagination_label: AccessRequestConfig
sidebar_label: AccessRequestConfig
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestConfig', 'AccessRequestConfig']
slug: /tools/sdk/powershell/v3/models/access-request-config
tags: ['SDK', 'Software Development Kit', 'AccessRequestConfig', 'AccessRequestConfig']
---
# 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 [**EntitlementRequestConfig**](entitlement-request-config) | | [optional]
## Examples
- Prepare the resource
```powershell
$AccessRequestConfig = Initialize-PSSailpoint.V3AccessRequestConfig -ApprovalsMustBeExternal true `
-AutoApprovalEnabled true `
-ReauthorizationEnabled true `
-RequestOnBehalfOfConfig null `
-ApprovalReminderAndEscalationConfig null `
-EntitlementRequestConfig null
```
- Convert the resource to JSON
```powershell
$AccessRequestConfig | ConvertTo-JSON
```
[[Back to top]](#)

43
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccessRequestItem.md
View File

@@ -1,43 +0,0 @@
---
id: access-request-item
title: AccessRequestItem
pagination_label: AccessRequestItem
sidebar_label: AccessRequestItem
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestItem', 'AccessRequestItem']
slug: /tools/sdk/powershell/v3/models/access-request-item
tags: ['SDK', 'Software Development Kit', 'AccessRequestItem', 'AccessRequestItem']
---
# 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.V3AccessRequestItem -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]](#)

45
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccessRequestPhases.md
View File

@@ -1,45 +0,0 @@
---
id: access-request-phases
title: AccessRequestPhases
pagination_label: AccessRequestPhases
sidebar_label: AccessRequestPhases
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPhases', 'AccessRequestPhases']
slug: /tools/sdk/powershell/v3/models/access-request-phases
tags: ['SDK', 'Software Development Kit', 'AccessRequestPhases', 'AccessRequestPhases']
---
# 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.V3AccessRequestPhases -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]](#)

37
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccessRequestResponse.md
View File

@@ -1,37 +0,0 @@
---
id: access-request-response
title: AccessRequestResponse
pagination_label: AccessRequestResponse
sidebar_label: AccessRequestResponse
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestResponse', 'AccessRequestResponse']
slug: /tools/sdk/powershell/v3/models/access-request-response
tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse', 'AccessRequestResponse']
---
# 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.V3AccessRequestResponse -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]](#)

44
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccessRequestTracking.md
View File

@@ -1,44 +0,0 @@
---
id: access-request-tracking
title: AccessRequestTracking
pagination_label: AccessRequestTracking
sidebar_label: AccessRequestTracking
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestTracking', 'AccessRequestTracking']
slug: /tools/sdk/powershell/v3/models/access-request-tracking
tags: ['SDK', 'Software Development Kit', 'AccessRequestTracking', 'AccessRequestTracking']
---
# 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.V3AccessRequestTracking -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/V3/Models/Models/AccessRequestType.md
View File

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

47
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccessReviewItem.md
View File

@@ -1,47 +0,0 @@
---
id: access-review-item
title: AccessReviewItem
pagination_label: AccessReviewItem
sidebar_label: AccessReviewItem
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessReviewItem', 'AccessReviewItem']
slug: /tools/sdk/powershell/v3/models/access-review-item
tags: ['SDK', 'Software Development Kit', 'AccessReviewItem', 'AccessReviewItem']
---
# AccessReviewItem
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessSummary** | Pointer to [**AccessSummary**](access-summary) | | [optional]
**IdentitySummary** | Pointer to [**CertificationIdentitySummary**](certification-identity-summary) | | [optional]
**Id** | Pointer to **String** | The review item's id | [optional]
**Completed** | Pointer to **Boolean** | Whether the review item is complete | [optional]
**NewAccess** | Pointer to **Boolean** | Indicates whether the review item is for new access to a source | [optional]
**Decision** | Pointer to [**CertificationDecision**](certification-decision) | | [optional]
**Comments** | Pointer to **String** | Comments for this review item | [optional]
## Examples
- Prepare the resource
```powershell
$AccessReviewItem = Initialize-PSSailpoint.V3AccessReviewItem -AccessSummary null `
-IdentitySummary null `
-Id ef38f94347e94562b5bb8424a56397d8 `
-Completed false `
-NewAccess false `
-Decision null `
-Comments This user still needs access to this source
```
- Convert the resource to JSON
```powershell
$AccessReviewItem | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccessReviewReassignment.md
View File

@@ -1,39 +0,0 @@
---
id: access-review-reassignment
title: AccessReviewReassignment
pagination_label: AccessReviewReassignment
sidebar_label: AccessReviewReassignment
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessReviewReassignment', 'AccessReviewReassignment']
slug: /tools/sdk/powershell/v3/models/access-review-reassignment
tags: ['SDK', 'Software Development Kit', 'AccessReviewReassignment', 'AccessReviewReassignment']
---
# AccessReviewReassignment
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Reassign** | [**[]ReassignReference**](reassign-reference) | | [required]
**ReassignTo** | **String** | The ID of the identity to which the certification is reassigned | [required]
**Reason** | **String** | The reason comment for why the reassign was made | [required]
## Examples
- Prepare the resource
```powershell
$AccessReviewReassignment = Initialize-PSSailpoint.V3AccessReviewReassignment -Reassign null `
-ReassignTo ef38f94347e94562b5bb8424a56397d8 `
-Reason reassigned for some reason
```
- Convert the resource to JSON
```powershell
$AccessReviewReassignment | ConvertTo-JSON
```
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccessSummary.md
View File

@@ -1,41 +0,0 @@
---
id: access-summary
title: AccessSummary
pagination_label: AccessSummary
sidebar_label: AccessSummary
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessSummary', 'AccessSummary']
slug: /tools/sdk/powershell/v3/models/access-summary
tags: ['SDK', 'Software Development Kit', 'AccessSummary', 'AccessSummary']
---
# AccessSummary
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Access** | Pointer to [**AccessSummaryAccess**](access-summary-access) | | [optional]
**Entitlement** | Pointer to [**ReviewableEntitlement**](reviewable-entitlement) | | [optional]
**AccessProfile** | Pointer to [**ReviewableAccessProfile**](reviewable-access-profile) | | [optional]
**Role** | Pointer to [**ReviewableRole**](reviewable-role) | | [optional]
## Examples
- Prepare the resource
```powershell
$AccessSummary = Initialize-PSSailpoint.V3AccessSummary -Access null `
-Entitlement null `
-AccessProfile null `
-Role null
```
- Convert the resource to JSON
```powershell
$AccessSummary | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccessSummaryAccess.md
View File

@@ -1,39 +0,0 @@
---
id: access-summary-access
title: AccessSummaryAccess
pagination_label: AccessSummaryAccess
sidebar_label: AccessSummaryAccess
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessSummaryAccess', 'AccessSummaryAccess']
slug: /tools/sdk/powershell/v3/models/access-summary-access
tags: ['SDK', 'Software Development Kit', 'AccessSummaryAccess', 'AccessSummaryAccess']
---
# AccessSummaryAccess
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | Pointer to [**DtoType**](dto-type) | | [optional]
**Id** | Pointer to **String** | The ID of the item being certified | [optional]
**Name** | Pointer to **String** | The name of the item being certified | [optional]
## Examples
- Prepare the resource
```powershell
$AccessSummaryAccess = Initialize-PSSailpoint.V3AccessSummaryAccess -Type null `
-Id 2c9180867160846801719932c5153fb7 `
-Name Entitlement for Company Database
```
- Convert the resource to JSON
```powershell
$AccessSummaryAccess | ConvertTo-JSON
```
[[Back to top]](#)

24
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccessType.md
View File

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

89
docs/tools/sdk/powershell/Reference/V3/Models/Models/Account.md
View File

@@ -1,89 +0,0 @@
---
id: account
title: Account
pagination_label: Account
sidebar_label: Account
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'Account', 'Account']
slug: /tools/sdk/powershell/v3/models/account
tags: ['SDK', 'Software Development Kit', 'Account', 'Account']
---
# 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.V3Account -Id id12345 `
-Name aName `
-Created 2015-05-28T14:07:17Z `
-Modified 2015-05-28T14:07:17Z `
-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/V3/Models/Models/AccountAction.md
View File

@@ -1,37 +0,0 @@
---
id: account-action
title: AccountAction
pagination_label: AccountAction
sidebar_label: AccountAction
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAction', 'AccountAction']
slug: /tools/sdk/powershell/v3/models/account-action
tags: ['SDK', 'Software Development Kit', 'AccountAction', 'AccountAction']
---
# 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 unique 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.V3AccountAction -Action ENABLE `
-SourceIds [2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500]
```
- Convert the resource to JSON
```powershell
$AccountAction | ConvertTo-JSON
```
[[Back to top]](#)

61
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccountActivity.md
View File

@@ -1,61 +0,0 @@
---
id: account-activity
title: AccountActivity
pagination_label: AccountActivity
sidebar_label: AccountActivity
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivity', 'AccountActivity']
slug: /tools/sdk/powershell/v3/models/account-activity
tags: ['SDK', 'Software Development Kit', 'AccountActivity', 'AccountActivity']
---
# AccountActivity
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | Id of the account activity | [optional]
**Name** | Pointer to **String** | The name of the activity | [optional]
**Created** | Pointer to **System.DateTime** | When the activity was first created | [optional]
**Modified** | Pointer to **System.DateTime** | When the activity was last modified | [optional]
**Completed** | Pointer to **System.DateTime** | When the activity was completed | [optional]
**CompletionStatus** | Pointer to [**CompletionStatus**](completion-status) | | [optional]
**Type** | Pointer to **String** | The type of action the activity performed. Please see the following list of types. This list may grow over time. - CloudAutomated - IdentityAttributeUpdate - appRequest - LifecycleStateChange - AccountStateUpdate - AccountAttributeUpdate - CloudPasswordRequest - Attribute Synchronization Refresh - Certification - Identity Refresh - Lifecycle Change Refresh [Learn more here](https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data). | [optional]
**RequesterIdentitySummary** | Pointer to [**IdentitySummary**](identity-summary) | | [optional]
**TargetIdentitySummary** | Pointer to [**IdentitySummary**](identity-summary) | | [optional]
**Errors** | Pointer to **[]String** | A list of error messages, if any, that were encountered. | [optional]
**Warnings** | Pointer to **[]String** | A list of warning messages, if any, that were encountered. | [optional]
**Items** | Pointer to [**[]AccountActivityItem**](account-activity-item) | Individual actions performed as part of this account activity | [optional]
**ExecutionStatus** | Pointer to [**ExecutionStatus**](execution-status) | | [optional]
**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional]
## Examples
- Prepare the resource
```powershell
$AccountActivity = Initialize-PSSailpoint.V3AccountActivity -Id 2c9180835d2e5168015d32f890ca1581 `
-Name 2c9180835d2e5168015d32f890ca1581 `
-Created 2017-07-11T18:45:37.098Z `
-Modified 2018-06-25T20:22:28.104Z `
-Completed 2018-10-19T13:49:37.385Z `
-CompletionStatus null `
-Type appRequest `
-RequesterIdentitySummary null `
-TargetIdentitySummary null `
-Errors [sailpoint.connector.ConnectorException: java.lang.InterruptedException: Timeout waiting for response to message 0 from client 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds.] `
-Warnings [Some warning, another warning] `
-Items null `
-ExecutionStatus null `
-ClientMetadata {customKey1=custom value 1, customKey2=custom value 2}
```
- Convert the resource to JSON
```powershell
$AccountActivity | ConvertTo-JSON
```
[[Back to top]](#)

32
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccountActivityApprovalStatus.md
View File

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

71
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccountActivityDocument.md
View File

@@ -1,71 +0,0 @@
---
id: account-activity-document
title: AccountActivityDocument
pagination_label: AccountActivityDocument
sidebar_label: AccountActivityDocument
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivityDocument', 'AccountActivityDocument']
slug: /tools/sdk/powershell/v3/models/account-activity-document
tags: ['SDK', 'Software Development Kit', 'AccountActivityDocument', 'AccountActivityDocument']
---
# AccountActivityDocument
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | | [required]
**Name** | **String** | | [required]
**Type** | [**DocumentType**](document-type) | | [required]
**Action** | Pointer to **String** | Type of action performed in the activity. | [optional]
**Created** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**Modified** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
**Stage** | Pointer to **String** | Activity's current stage. | [optional]
**Origin** | Pointer to **String** | Activity's origin. | [optional]
**Status** | Pointer to **String** | Activity's current status. | [optional]
**Requester** | Pointer to [**AccountSource**](account-source) | | [optional]
**Recipient** | Pointer to [**AccountSource**](account-source) | | [optional]
**TrackingNumber** | Pointer to **String** | Account activity's tracking number. | [optional]
**Errors** | Pointer to **[]String** | Errors provided by the source while completing account actions. | [optional]
**Warnings** | Pointer to **[]String** | Warnings provided by the source while completing account actions. | [optional]
**Approvals** | Pointer to [**[]Approval**](approval) | Approvals performed on an item during activity. | [optional]
**OriginalRequests** | Pointer to [**[]OriginalRequest**](original-request) | Original actions that triggered all individual source actions related to the account action. | [optional]
**ExpansionItems** | Pointer to [**[]ExpansionItem**](expansion-item) | Controls that translated the attribute requests into actual provisioning actions on the source. | [optional]
**AccountRequests** | Pointer to [**[]AccountRequest**](account-request) | Account data for each individual source action triggered by the original requests. | [optional]
**Sources** | Pointer to **String** | Sources involved in the account activity. | [optional]
## Examples
- Prepare the resource
```powershell
$AccountActivityDocument = Initialize-PSSailpoint.V3AccountActivityDocument -Id 2c91808375d8e80a0175e1f88a575222 `
-Name john.doe `
-Type null `
-Action Identity Refresh. `
-Created 2018-06-25T20:22:28.104Z `
-Modified 2018-06-25T20:22:28.104Z `
-Stage Completed `
-Origin null `
-Status Complete `
-Requester null `
-Recipient null `
-TrackingNumber 61aad0c9e8134eca89e76a35e0cabe3f `
-Errors null `
-Warnings null `
-Approvals null `
-OriginalRequests null `
-ExpansionItems null `
-AccountRequests null `
-Sources smartsheet-test, airtable-v4, IdentityNow
```
- Convert the resource to JSON
```powershell
$AccountActivityDocument | ConvertTo-JSON
```
[[Back to top]](#)

65
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccountActivityItem.md
View File

@@ -1,65 +0,0 @@
---
id: account-activity-item
title: AccountActivityItem
pagination_label: AccountActivityItem
sidebar_label: AccountActivityItem
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivityItem', 'AccountActivityItem']
slug: /tools/sdk/powershell/v3/models/account-activity-item
tags: ['SDK', 'Software Development Kit', 'AccountActivityItem', 'AccountActivityItem']
---
# 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.V3AccountActivityItem -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/V3/Models/Models/AccountActivityItemOperation.md
View File

@@ -1,40 +0,0 @@
---
id: account-activity-item-operation
title: AccountActivityItemOperation
pagination_label: AccountActivityItemOperation
sidebar_label: AccountActivityItemOperation
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivityItemOperation', 'AccountActivityItemOperation']
slug: /tools/sdk/powershell/v3/models/account-activity-item-operation
tags: ['SDK', 'Software Development Kit', 'AccountActivityItemOperation', 'AccountActivityItemOperation']
---
# 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]](#)

71
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccountActivitySearchedItem.md
View File

@@ -1,71 +0,0 @@
---
id: account-activity-searched-item
title: AccountActivitySearchedItem
pagination_label: AccountActivitySearchedItem
sidebar_label: AccountActivitySearchedItem
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivitySearchedItem', 'AccountActivitySearchedItem']
slug: /tools/sdk/powershell/v3/models/account-activity-searched-item
tags: ['SDK', 'Software Development Kit', 'AccountActivitySearchedItem', 'AccountActivitySearchedItem']
---
# AccountActivitySearchedItem
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | | [required]
**Name** | **String** | | [required]
**Type** | [**DocumentType**](document-type) | | [required]
**Action** | Pointer to **String** | Type of action performed in the activity. | [optional]
**Created** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**Modified** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
**Stage** | Pointer to **String** | Activity's current stage. | [optional]
**Origin** | Pointer to **String** | Activity's origin. | [optional]
**Status** | Pointer to **String** | Activity's current status. | [optional]
**Requester** | Pointer to [**AccountSource**](account-source) | | [optional]
**Recipient** | Pointer to [**AccountSource**](account-source) | | [optional]
**TrackingNumber** | Pointer to **String** | Account activity's tracking number. | [optional]
**Errors** | Pointer to **[]String** | Errors provided by the source while completing account actions. | [optional]
**Warnings** | Pointer to **[]String** | Warnings provided by the source while completing account actions. | [optional]
**Approvals** | Pointer to [**[]Approval**](approval) | Approvals performed on an item during activity. | [optional]
**OriginalRequests** | Pointer to [**[]OriginalRequest**](original-request) | Original actions that triggered all individual source actions related to the account action. | [optional]
**ExpansionItems** | Pointer to [**[]ExpansionItem**](expansion-item) | Controls that translated the attribute requests into actual provisioning actions on the source. | [optional]
**AccountRequests** | Pointer to [**[]AccountRequest**](account-request) | Account data for each individual source action triggered by the original requests. | [optional]
**Sources** | Pointer to **String** | Sources involved in the account activity. | [optional]
## Examples
- Prepare the resource
```powershell
$AccountActivitySearchedItem = Initialize-PSSailpoint.V3AccountActivitySearchedItem -Id 2c91808375d8e80a0175e1f88a575222 `
-Name john.doe `
-Type null `
-Action Identity Refresh. `
-Created 2018-06-25T20:22:28.104Z `
-Modified 2018-06-25T20:22:28.104Z `
-Stage Completed `
-Origin null `
-Status Complete `
-Requester null `
-Recipient null `
-TrackingNumber 61aad0c9e8134eca89e76a35e0cabe3f `
-Errors null `
-Warnings null `
-Approvals null `
-OriginalRequests null `
-ExpansionItems null `
-AccountRequests null `
-Sources smartsheet-test, airtable-v4, IdentityNow
```
- Convert the resource to JSON
```powershell
$AccountActivitySearchedItem | ConvertTo-JSON
```
[[Back to top]](#)

51
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccountAttribute.md
View File

@@ -1,51 +0,0 @@
---
id: account-attribute
title: AccountAttribute
pagination_label: AccountAttribute
sidebar_label: AccountAttribute
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttribute', 'AccountAttribute']
slug: /tools/sdk/powershell/v3/models/account-attribute
tags: ['SDK', 'Software Development Kit', 'AccountAttribute', 'AccountAttribute']
---
# 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.V3AccountAttribute -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/V3/Models/Models/AccountAttributes.md
View File

@@ -1,35 +0,0 @@
---
id: account-attributes
title: AccountAttributes
pagination_label: AccountAttributes
sidebar_label: AccountAttributes
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributes', 'AccountAttributes']
slug: /tools/sdk/powershell/v3/models/account-attributes
tags: ['SDK', 'Software Development Kit', 'AccountAttributes', 'AccountAttributes']
---
# AccountAttributes
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The schema attribute values for the account | [required]
## Examples
- Prepare the resource
```powershell
$AccountAttributes = Initialize-PSSailpoint.V3AccountAttributes -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]](#)

35
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccountAttributesCreate.md
View File

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

35
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccountAttributesCreateAttributes.md
View File

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

45
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccountRequest.md
View File

@@ -1,45 +0,0 @@
---
id: account-request
title: AccountRequest
pagination_label: AccountRequest
sidebar_label: AccountRequest
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountRequest', 'AccountRequest']
slug: /tools/sdk/powershell/v3/models/account-request
tags: ['SDK', 'Software Development Kit', 'AccountRequest', 'AccountRequest']
---
# AccountRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccountId** | Pointer to **String** | Unique ID of the account | [optional]
**AttributeRequests** | Pointer to [**[]AttributeRequest**](attribute-request) | | [optional]
**Op** | Pointer to **String** | The operation that was performed | [optional]
**ProvisioningTarget** | Pointer to [**AccountSource**](account-source) | | [optional]
**Result** | Pointer to [**AccountRequestResult**](account-request-result) | | [optional]
**Source** | Pointer to [**AccountSource**](account-source) | | [optional]
## Examples
- Prepare the resource
```powershell
$AccountRequest = Initialize-PSSailpoint.V3AccountRequest -AccountId John.Doe `
-AttributeRequests null `
-Op Modify `
-ProvisioningTarget null `
-Result null `
-Source null
```
- Convert the resource to JSON
```powershell
$AccountRequest | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccountRequestInfo.md
View File

@@ -1,39 +0,0 @@
---
id: account-request-info
title: AccountRequestInfo
pagination_label: AccountRequestInfo
sidebar_label: AccountRequestInfo
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountRequestInfo', 'AccountRequestInfo']
slug: /tools/sdk/powershell/v3/models/account-request-info
tags: ['SDK', 'Software Development Kit', 'AccountRequestInfo', 'AccountRequestInfo']
---
# 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.V3AccountRequestInfo -RequestedObjectId 2c91808563ef85690164001c31140c0c `
-RequestedObjectName Treasury Analyst `
-RequestedObjectType null
```
- Convert the resource to JSON
```powershell
$AccountRequestInfo | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccountRequestResult.md
View File

@@ -1,39 +0,0 @@
---
id: account-request-result
title: AccountRequestResult
pagination_label: AccountRequestResult
sidebar_label: AccountRequestResult
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountRequestResult', 'AccountRequestResult']
slug: /tools/sdk/powershell/v3/models/account-request-result
tags: ['SDK', 'Software Development Kit', 'AccountRequestResult', 'AccountRequestResult']
---
# AccountRequestResult
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Errors** | Pointer to **[]String** | | [optional]
**Status** | Pointer to **String** | The status of the account request | [optional]
**TicketId** | Pointer to **String** | | [optional]
## Examples
- Prepare the resource
```powershell
$AccountRequestResult = Initialize-PSSailpoint.V3AccountRequestResult -Errors null `
-Status failed `
-TicketId null
```
- Convert the resource to JSON
```powershell
$AccountRequestResult | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccountSource.md
View File

@@ -1,39 +0,0 @@
---
id: account-source
title: AccountSource
pagination_label: AccountSource
sidebar_label: AccountSource
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountSource', 'AccountSource']
slug: /tools/sdk/powershell/v3/models/account-source
tags: ['SDK', 'Software Development Kit', 'AccountSource', 'AccountSource']
---
# AccountSource
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | The unique ID of the referenced object. | [optional]
**Name** | Pointer to **String** | The human readable name of the referenced object. | [optional]
**Type** | Pointer to **String** | Type of source returned. | [optional]
## Examples
- Prepare the resource
```powershell
$AccountSource = Initialize-PSSailpoint.V3AccountSource -Id 2c91808568c529c60168cca6f90c1313 `
-Name John Doe `
-Type Delimited File
```
- Convert the resource to JSON
```powershell
$AccountSource | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccountToggleRequest.md
View File

@@ -1,37 +0,0 @@
---
id: account-toggle-request
title: AccountToggleRequest
pagination_label: AccountToggleRequest
sidebar_label: AccountToggleRequest
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountToggleRequest', 'AccountToggleRequest']
slug: /tools/sdk/powershell/v3/models/account-toggle-request
tags: ['SDK', 'Software Development Kit', 'AccountToggleRequest', 'AccountToggleRequest']
---
# 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. Providing 'true' for an unlocked account will add and process 'Unlock' operation by the workflow. | [optional]
## Examples
- Prepare the resource
```powershell
$AccountToggleRequest = Initialize-PSSailpoint.V3AccountToggleRequest -ExternalVerificationId 3f9180835d2e5168015d32f890ca1581 `
-ForceProvisioning false
```
- Convert the resource to JSON
```powershell
$AccountToggleRequest | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccountUnlockRequest.md
View File

@@ -1,39 +0,0 @@
---
id: account-unlock-request
title: AccountUnlockRequest
pagination_label: AccountUnlockRequest
sidebar_label: AccountUnlockRequest
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUnlockRequest', 'AccountUnlockRequest']
slug: /tools/sdk/powershell/v3/models/account-unlock-request
tags: ['SDK', 'Software Development Kit', 'AccountUnlockRequest', 'AccountUnlockRequest']
---
# 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.V3AccountUnlockRequest -ExternalVerificationId 3f9180835d2e5168015d32f890ca1581 `
-UnlockIDNAccount false `
-ForceProvisioning false
```
- Convert the resource to JSON
```powershell
$AccountUnlockRequest | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccountUsage.md
View File

@@ -1,37 +0,0 @@
---
id: account-usage
title: AccountUsage
pagination_label: AccountUsage
sidebar_label: AccountUsage
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUsage', 'AccountUsage']
slug: /tools/sdk/powershell/v3/models/account-usage
tags: ['SDK', 'Software Development Kit', 'AccountUsage', 'AccountUsage']
---
# 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.V3AccountUsage -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/V3/Models/Models/AccountsAsyncResult.md
View File

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

37
docs/tools/sdk/powershell/Reference/V3/Models/Models/AccountsExportReportArguments.md
View File

@@ -1,37 +0,0 @@
---
id: accounts-export-report-arguments
title: AccountsExportReportArguments
pagination_label: AccountsExportReportArguments
sidebar_label: AccountsExportReportArguments
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountsExportReportArguments', 'AccountsExportReportArguments']
slug: /tools/sdk/powershell/v3/models/accounts-export-report-arguments
tags: ['SDK', 'Software Development Kit', 'AccountsExportReportArguments', 'AccountsExportReportArguments']
---
# AccountsExportReportArguments
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Application** | **String** | Source ID. | [required]
**SourceName** | **String** | Source name. | [required]
## Examples
- Prepare the resource
```powershell
$AccountsExportReportArguments = Initialize-PSSailpoint.V3AccountsExportReportArguments -Application 2c9180897eSourceIde781782f705b9 `
-SourceName Active Directory
```
- Convert the resource to JSON
```powershell
$AccountsExportReportArguments | ConvertTo-JSON
```
[[Back to top]](#)

35
docs/tools/sdk/powershell/Reference/V3/Models/Models/ActivateCampaignOptions.md
View File

@@ -1,35 +0,0 @@
---
id: activate-campaign-options
title: ActivateCampaignOptions
pagination_label: ActivateCampaignOptions
sidebar_label: ActivateCampaignOptions
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ActivateCampaignOptions', 'ActivateCampaignOptions']
slug: /tools/sdk/powershell/v3/models/activate-campaign-options
tags: ['SDK', 'Software Development Kit', 'ActivateCampaignOptions', 'ActivateCampaignOptions']
---
# ActivateCampaignOptions
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**TimeZone** | Pointer to **String** | The timezone must be in a valid ISO 8601 format. Timezones in ISO 8601 are represented as UTC (represented as 'Z') or as an offset from UTC. The offset format can be +/-hh:mm, +/-hhmm, or +/-hh. | [optional] [default to "Z"]
## Examples
- Prepare the resource
```powershell
$ActivateCampaignOptions = Initialize-PSSailpoint.V3ActivateCampaignOptions -TimeZone -05:00
```
- Convert the resource to JSON
```powershell
$ActivateCampaignOptions | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V3/Models/Models/ActivityInsights.md
View File

@@ -1,39 +0,0 @@
---
id: activity-insights
title: ActivityInsights
pagination_label: ActivityInsights
sidebar_label: ActivityInsights
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ActivityInsights', 'ActivityInsights']
slug: /tools/sdk/powershell/v3/models/activity-insights
tags: ['SDK', 'Software Development Kit', 'ActivityInsights', 'ActivityInsights']
---
# ActivityInsights
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccountID** | Pointer to **String** | UUID of the account | [optional]
**UsageDays** | Pointer to **Int32** | The number of days of activity | [optional]
**UsageDaysState** | Pointer to **Enum** [ "COMPLETE", "UNKNOWN" ] | Status indicating if the activity is complete or unknown | [optional]
## Examples
- Prepare the resource
```powershell
$ActivityInsights = Initialize-PSSailpoint.V3ActivityInsights -AccountID c4ddd5421d8549f0abd309162cafd3b1 `
-UsageDays 45 `
-UsageDaysState COMPLETE
```
- Convert the resource to JSON
```powershell
$ActivityInsights | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V3/Models/Models/AdminReviewReassign.md
View File

@@ -1,39 +0,0 @@
---
id: admin-review-reassign
title: AdminReviewReassign
pagination_label: AdminReviewReassign
sidebar_label: AdminReviewReassign
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AdminReviewReassign', 'AdminReviewReassign']
slug: /tools/sdk/powershell/v3/models/admin-review-reassign
tags: ['SDK', 'Software Development Kit', 'AdminReviewReassign', 'AdminReviewReassign']
---
# AdminReviewReassign
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**CertificationIds** | Pointer to **[]String** | List of certification IDs to reassign | [optional]
**ReassignTo** | Pointer to [**AdminReviewReassignReassignTo**](admin-review-reassign-reassign-to) | | [optional]
**Reason** | Pointer to **String** | Comment to explain why the certification was reassigned | [optional]
## Examples
- Prepare the resource
```powershell
$AdminReviewReassign = Initialize-PSSailpoint.V3AdminReviewReassign -CertificationIds [af3859464779471211bb8424a563abc1, af3859464779471211bb8424a563abc2, af3859464779471211bb8424a563abc3] `
-ReassignTo null `
-Reason reassigned for some reason
```
- Convert the resource to JSON
```powershell
$AdminReviewReassign | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V3/Models/Models/AdminReviewReassignReassignTo.md
View File

@@ -1,37 +0,0 @@
---
id: admin-review-reassign-reassign-to
title: AdminReviewReassignReassignTo
pagination_label: AdminReviewReassignReassignTo
sidebar_label: AdminReviewReassignReassignTo
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AdminReviewReassignReassignTo', 'AdminReviewReassignReassignTo']
slug: /tools/sdk/powershell/v3/models/admin-review-reassign-reassign-to
tags: ['SDK', 'Software Development Kit', 'AdminReviewReassignReassignTo', 'AdminReviewReassignReassignTo']
---
# AdminReviewReassignReassignTo
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | The identity ID to which the review is being assigned. | [optional]
**Type** | Pointer to **Enum** [ "IDENTITY" ] | The type of the ID provided. | [optional]
## Examples
- Prepare the resource
```powershell
$AdminReviewReassignReassignTo = Initialize-PSSailpoint.V3AdminReviewReassignReassignTo -Id ef38f94347e94562b5bb8424a56397d8 `
-Type IDENTITY
```
- Convert the resource to JSON
```powershell
$AdminReviewReassignReassignTo | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V3/Models/Models/AggregationResult.md
View File

@@ -1,37 +0,0 @@
---
id: aggregation-result
title: AggregationResult
pagination_label: AggregationResult
sidebar_label: AggregationResult
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AggregationResult', 'AggregationResult']
slug: /tools/sdk/powershell/v3/models/aggregation-result
tags: ['SDK', 'Software Development Kit', 'AggregationResult', 'AggregationResult']
---
# AggregationResult
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Aggregations** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The document containing the results of the aggregation. This document is controlled by Elasticsearch and depends on the type of aggregation query that is run. See Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) documentation for information. | [optional]
**Hits** | Pointer to [**[]SearchDocument**](search-document) | The results of the aggregation search query. | [optional]
## Examples
- Prepare the resource
```powershell
$AggregationResult = Initialize-PSSailpoint.V3AggregationResult -Aggregations {Identity Locations={buckets=[{key=Austin, doc_count=109}, {key=London, doc_count=64}, {key=San Jose, doc_count=27}, {key=Brussels, doc_count=26}, {key=Sao Paulo, doc_count=24}, {key=Munich, doc_count=23}, {key=Singapore, doc_count=22}, {key=Tokyo, doc_count=20}, {key=Taipei, doc_count=16}]}} `
-Hits null
```
- Convert the resource to JSON
```powershell
$AggregationResult | ConvertTo-JSON
```
[[Back to top]](#)

24
docs/tools/sdk/powershell/Reference/V3/Models/Models/AggregationType.md
View File

@@ -1,24 +0,0 @@
---
id: aggregation-type
title: AggregationType
pagination_label: AggregationType
sidebar_label: AggregationType
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AggregationType', 'AggregationType']
slug: /tools/sdk/powershell/v3/models/aggregation-type
tags: ['SDK', 'Software Development Kit', 'AggregationType', 'AggregationType']
---
# AggregationType
## Enum
* `DSL` (value: `"DSL"`)
* `SAILPOINT` (value: `"SAILPOINT"`)
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/V3/Models/Models/Aggregations.md
View File

@@ -1,41 +0,0 @@
---
id: aggregations
title: Aggregations
pagination_label: Aggregations
sidebar_label: Aggregations
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'Aggregations', 'Aggregations']
slug: /tools/sdk/powershell/v3/models/aggregations
tags: ['SDK', 'Software Development Kit', 'Aggregations', 'Aggregations']
---
# Aggregations
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Nested** | Pointer to [**NestedAggregation**](nested-aggregation) | | [optional]
**Metric** | Pointer to [**MetricAggregation**](metric-aggregation) | | [optional]
**VarFilter** | Pointer to [**FilterAggregation**](filter-aggregation) | | [optional]
**Bucket** | Pointer to [**BucketAggregation**](bucket-aggregation) | | [optional]
## Examples
- Prepare the resource
```powershell
$Aggregations = Initialize-PSSailpoint.V3Aggregations -Nested null `
-Metric null `
-VarFilter null `
-Bucket null
```
- Convert the resource to JSON
```powershell
$Aggregations | ConvertTo-JSON
```
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/V3/Models/Models/App.md
View File

@@ -1,41 +0,0 @@
---
id: app
title: App
pagination_label: App
sidebar_label: App
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'App', 'App']
slug: /tools/sdk/powershell/v3/models/app
tags: ['SDK', 'Software Development Kit', 'App', 'App']
---
# App
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | The unique ID of the referenced object. | [optional]
**Name** | Pointer to **String** | The human readable name of the referenced object. | [optional]
**Source** | Pointer to [**Reference1**](reference1) | | [optional]
**Account** | Pointer to [**AppAllOfAccount**](app-all-of-account) | | [optional]
## Examples
- Prepare the resource
```powershell
$App = Initialize-PSSailpoint.V3App -Id 2c91808568c529c60168cca6f90c1313 `
-Name John Doe `
-Source null `
-Account null
```
- Convert the resource to JSON
```powershell
$App | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V3/Models/Models/AppAllOfAccount.md
View File

@@ -1,37 +0,0 @@
---
id: app-all-of-account
title: AppAllOfAccount
pagination_label: AppAllOfAccount
sidebar_label: AppAllOfAccount
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AppAllOfAccount', 'AppAllOfAccount']
slug: /tools/sdk/powershell/v3/models/app-all-of-account
tags: ['SDK', 'Software Development Kit', 'AppAllOfAccount', 'AppAllOfAccount']
---
# AppAllOfAccount
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | The SailPoint generated unique ID | [optional]
**AccountId** | Pointer to **String** | The account ID generated by the source | [optional]
## Examples
- Prepare the resource
```powershell
$AppAllOfAccount = Initialize-PSSailpoint.V3AppAllOfAccount -Id 2c9180837dfe6949017e21f3d8cd6d49 `
-AccountId CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com
```
- Convert the resource to JSON
```powershell
$AppAllOfAccount | ConvertTo-JSON
```
[[Back to top]](#)

45
docs/tools/sdk/powershell/Reference/V3/Models/Models/Approval.md
View File

@@ -1,45 +0,0 @@
---
id: approval
title: Approval
pagination_label: Approval
sidebar_label: Approval
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'Approval', 'Approval']
slug: /tools/sdk/powershell/v3/models/approval
tags: ['SDK', 'Software Development Kit', 'Approval', 'Approval']
---
# Approval
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Comments** | Pointer to [**[]ApprovalComment**](approval-comment) | | [optional]
**Created** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional]
**Modified** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional]
**Owner** | Pointer to [**AccountSource**](account-source) | | [optional]
**Result** | Pointer to **String** | The result of the approval | [optional]
**Type** | Pointer to **String** | | [optional]
## Examples
- Prepare the resource
```powershell
$Approval = Initialize-PSSailpoint.V3Approval -Comments null `
-Created 2018-06-25T20:22:28.104Z `
-Modified 2018-06-25T20:22:28.104Z `
-Owner null `
-Result Finished `
-Type null
```
- Convert the resource to JSON
```powershell
$Approval | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V3/Models/Models/ApprovalComment.md
View File

@@ -1,39 +0,0 @@
---
id: approval-comment
title: ApprovalComment
pagination_label: ApprovalComment
sidebar_label: ApprovalComment
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalComment', 'ApprovalComment']
slug: /tools/sdk/powershell/v3/models/approval-comment
tags: ['SDK', 'Software Development Kit', 'ApprovalComment', 'ApprovalComment']
---
# ApprovalComment
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Comment** | Pointer to **String** | The comment text | [optional]
**Commenter** | Pointer to **String** | The name of the commenter | [optional]
**Date** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional]
## Examples
- Prepare the resource
```powershell
$ApprovalComment = Initialize-PSSailpoint.V3ApprovalComment -Comment This request was autoapproved by our automated ETS subscriber. `
-Commenter Automated AR Approval `
-Date 2018-06-25T20:22:28.104Z
```
- Convert the resource to JSON
```powershell
$ApprovalComment | ConvertTo-JSON
```
[[Back to top]](#)

45
docs/tools/sdk/powershell/Reference/V3/Models/Models/ApprovalForwardHistory.md
View File

@@ -1,45 +0,0 @@
---
id: approval-forward-history
title: ApprovalForwardHistory
pagination_label: ApprovalForwardHistory
sidebar_label: ApprovalForwardHistory
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalForwardHistory', 'ApprovalForwardHistory']
slug: /tools/sdk/powershell/v3/models/approval-forward-history
tags: ['SDK', 'Software Development Kit', 'ApprovalForwardHistory', 'ApprovalForwardHistory']
---
# ApprovalForwardHistory
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**OldApproverName** | Pointer to **String** | Display name of approver from whom the approval was forwarded. | [optional]
**NewApproverName** | Pointer to **String** | Display name of approver to whom the approval was forwarded. | [optional]
**Comment** | Pointer to **String** | Comment made while forwarding. | [optional]
**Modified** | Pointer to **System.DateTime** | Time at which approval was forwarded. | [optional]
**ForwarderName** | Pointer to **String** | Display name of forwarder who forwarded the approval. | [optional]
**ReassignmentType** | Pointer to [**ReassignmentType**](reassignment-type) | | [optional]
## Examples
- Prepare the resource
```powershell
$ApprovalForwardHistory = Initialize-PSSailpoint.V3ApprovalForwardHistory -OldApproverName Frank Mir `
-NewApproverName Al Volta `
-Comment Forwarding from Frank to Al `
-Modified 2019-08-23T18:52:57.398Z `
-ForwarderName William Wilson `
-ReassignmentType null
```
- Convert the resource to JSON
```powershell
$ApprovalForwardHistory | ConvertTo-JSON
```
[[Back to top]](#)

47
docs/tools/sdk/powershell/Reference/V3/Models/Models/ApprovalItemDetails.md
View File

@@ -1,47 +0,0 @@
---
id: approval-item-details
title: ApprovalItemDetails
pagination_label: ApprovalItemDetails
sidebar_label: ApprovalItemDetails
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalItemDetails', 'ApprovalItemDetails']
slug: /tools/sdk/powershell/v3/models/approval-item-details
tags: ['SDK', 'Software Development Kit', 'ApprovalItemDetails', 'ApprovalItemDetails']
---
# ApprovalItemDetails
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | The approval item's ID | [optional]
**Account** | Pointer to **String** | The account referenced by the approval item | [optional]
**Application** | Pointer to **String** | The name of the application/source | [optional]
**Name** | Pointer to **String** | The attribute's name | [optional]
**Operation** | Pointer to **String** | The attribute's operation | [optional]
**Value** | Pointer to **String** | The attribute's value | [optional]
**State** | Pointer to [**WorkItemState**](work-item-state) | | [optional]
## Examples
- Prepare the resource
```powershell
$ApprovalItemDetails = Initialize-PSSailpoint.V3ApprovalItemDetails -Id 2c9180835d2e5168015d32f890ca1581 `
-Account john.smith `
-Application Active Directory `
-Name emailAddress `
-Operation update `
-Value a@b.com `
-State null
```
- Convert the resource to JSON
```powershell
$ApprovalItemDetails | ConvertTo-JSON
```
[[Back to top]](#)

47
docs/tools/sdk/powershell/Reference/V3/Models/Models/ApprovalItems.md
View File

@@ -1,47 +0,0 @@
---
id: approval-items
title: ApprovalItems
pagination_label: ApprovalItems
sidebar_label: ApprovalItems
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalItems', 'ApprovalItems']
slug: /tools/sdk/powershell/v3/models/approval-items
tags: ['SDK', 'Software Development Kit', 'ApprovalItems', 'ApprovalItems']
---
# ApprovalItems
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | The approval item's ID | [optional]
**Account** | Pointer to **String** | The account referenced by the approval item | [optional]
**Application** | Pointer to **String** | The name of the application/source | [optional]
**Name** | Pointer to **String** | The attribute's name | [optional]
**Operation** | Pointer to **String** | The attribute's operation | [optional]
**Value** | Pointer to **String** | The attribute's value | [optional]
**State** | Pointer to [**WorkItemState**](work-item-state) | | [optional]
## Examples
- Prepare the resource
```powershell
$ApprovalItems = Initialize-PSSailpoint.V3ApprovalItems -Id 2c9180835d2e5168015d32f890ca1581 `
-Account john.smith `
-Application Active Directory `
-Name emailAddress `
-Operation update `
-Value a@b.com `
-State null
```
- Convert the resource to JSON
```powershell
$ApprovalItems | ConvertTo-JSON
```
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/V3/Models/Models/ApprovalReminderAndEscalationConfig.md
View File

@@ -1,41 +0,0 @@
---
id: approval-reminder-and-escalation-config
title: ApprovalReminderAndEscalationConfig
pagination_label: ApprovalReminderAndEscalationConfig
sidebar_label: ApprovalReminderAndEscalationConfig
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalReminderAndEscalationConfig', 'ApprovalReminderAndEscalationConfig']
slug: /tools/sdk/powershell/v3/models/approval-reminder-and-escalation-config
tags: ['SDK', 'Software Development Kit', 'ApprovalReminderAndEscalationConfig', 'ApprovalReminderAndEscalationConfig']
---
# ApprovalReminderAndEscalationConfig
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**DaysUntilEscalation** | Pointer to **Int32** | Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation. | [optional]
**DaysBetweenReminders** | Pointer to **Int32** | Number of days to wait between reminder notifications. | [optional]
**MaxReminders** | Pointer to **Int32** | Maximum number of reminder notification to send to the reviewer before approval escalation. | [optional]
**FallbackApproverRef** | Pointer to [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional]
## Examples
- Prepare the resource
```powershell
$ApprovalReminderAndEscalationConfig = Initialize-PSSailpoint.V3ApprovalReminderAndEscalationConfig -DaysUntilEscalation 0 `
-DaysBetweenReminders 0 `
-MaxReminders 1 `
-FallbackApproverRef null
```
- Convert the resource to JSON
```powershell
$ApprovalReminderAndEscalationConfig | ConvertTo-JSON
```
[[Back to top]](#)

34
docs/tools/sdk/powershell/Reference/V3/Models/Models/ApprovalScheme.md
View File

@@ -1,34 +0,0 @@
---
id: approval-scheme
title: ApprovalScheme
pagination_label: ApprovalScheme
sidebar_label: ApprovalScheme
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalScheme', 'ApprovalScheme']
slug: /tools/sdk/powershell/v3/models/approval-scheme
tags: ['SDK', 'Software Development Kit', 'ApprovalScheme', 'ApprovalScheme']
---
# ApprovalScheme
## Enum
* `APP_OWNER` (value: `"APP_OWNER"`)
* `SOURCE_OWNER` (value: `"SOURCE_OWNER"`)
* `MANAGER` (value: `"MANAGER"`)
* `ROLE_OWNER` (value: `"ROLE_OWNER"`)
* `ACCESS_PROFILE_OWNER` (value: `"ACCESS_PROFILE_OWNER"`)
* `ENTITLEMENT_OWNER` (value: `"ENTITLEMENT_OWNER"`)
* `GOVERNANCE_GROUP` (value: `"GOVERNANCE_GROUP"`)
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V3/Models/Models/ApprovalSchemeForRole.md
View File

@@ -1,37 +0,0 @@
---
id: approval-scheme-for-role
title: ApprovalSchemeForRole
pagination_label: ApprovalSchemeForRole
sidebar_label: ApprovalSchemeForRole
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalSchemeForRole', 'ApprovalSchemeForRole']
slug: /tools/sdk/powershell/v3/models/approval-scheme-for-role
tags: ['SDK', 'Software Development Kit', 'ApprovalSchemeForRole', 'ApprovalSchemeForRole']
---
# ApprovalSchemeForRole
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ApproverType** | Pointer to **Enum** [ "OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **OWNER**: Owner of the associated Role **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
$ApprovalSchemeForRole = Initialize-PSSailpoint.V3ApprovalSchemeForRole -ApproverType GOVERNANCE_GROUP `
-ApproverId 46c79819-a69f-49a2-becb-12c971ae66c6
```
- Convert the resource to JSON
```powershell
$ApprovalSchemeForRole | ConvertTo-JSON
```
[[Back to top]](#)

30
docs/tools/sdk/powershell/Reference/V3/Models/Models/ApprovalStatus.md
View File

@@ -1,30 +0,0 @@
---
id: approval-status
title: ApprovalStatus
pagination_label: ApprovalStatus
sidebar_label: ApprovalStatus
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalStatus', 'ApprovalStatus']
slug: /tools/sdk/powershell/v3/models/approval-status
tags: ['SDK', 'Software Development Kit', 'ApprovalStatus', 'ApprovalStatus']
---
# ApprovalStatus
## Enum
* `APPROVED` (value: `"APPROVED"`)
* `REJECTED` (value: `"REJECTED"`)
* `PENDING` (value: `"PENDING"`)
* `NOT_READY` (value: `"NOT_READY"`)
* `CANCELLED` (value: `"CANCELLED"`)
[[Back to top]](#)

53
docs/tools/sdk/powershell/Reference/V3/Models/Models/ApprovalStatusDto.md
View File

@@ -1,53 +0,0 @@
---
id: approval-status-dto
title: ApprovalStatusDto
pagination_label: ApprovalStatusDto
sidebar_label: ApprovalStatusDto
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalStatusDto', 'ApprovalStatusDto']
slug: /tools/sdk/powershell/v3/models/approval-status-dto
tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDto', 'ApprovalStatusDto']
---
# ApprovalStatusDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ApprovalId** | Pointer to **String** | Unique identifier for the approval. | [optional]
**Forwarded** | Pointer to **Boolean** | True if the request for this item was forwarded from one owner to another. | [optional] [default to $false]
**OriginalOwner** | Pointer to [**ApprovalStatusDtoOriginalOwner**](approval-status-dto-original-owner) | | [optional]
**CurrentOwner** | Pointer to [**ApprovalStatusDtoCurrentOwner**](approval-status-dto-current-owner) | | [optional]
**Modified** | Pointer to **System.DateTime** | Time at which item was modified. | [optional]
**Status** | Pointer to [**ManualWorkItemState**](manual-work-item-state) | | [optional]
**Scheme** | Pointer to [**ApprovalScheme**](approval-scheme) | | [optional]
**ErrorMessages** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | If the request failed, includes any error messages that were generated. | [optional]
**Comment** | Pointer to **String** | Comment, if any, provided by the approver. | [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
$ApprovalStatusDto = Initialize-PSSailpoint.V3ApprovalStatusDto -ApprovalId 2c9180877b2b6ea4017b2c545f971429 `
-Forwarded false `
-OriginalOwner null `
-CurrentOwner null `
-Modified 2019-08-23T18:52:57.398Z `
-Status null `
-Scheme null `
-ErrorMessages null `
-Comment I approve this request `
-RemoveDate 2020-07-11T00:00Z
```
- Convert the resource to JSON
```powershell
$ApprovalStatusDto | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V3/Models/Models/ApprovalStatusDtoCurrentOwner.md
View File

@@ -1,39 +0,0 @@
---
id: approval-status-dto-current-owner
title: ApprovalStatusDtoCurrentOwner
pagination_label: ApprovalStatusDtoCurrentOwner
sidebar_label: ApprovalStatusDtoCurrentOwner
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalStatusDtoCurrentOwner', 'ApprovalStatusDtoCurrentOwner']
slug: /tools/sdk/powershell/v3/models/approval-status-dto-current-owner
tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDtoCurrentOwner', 'ApprovalStatusDtoCurrentOwner']
---
# ApprovalStatusDtoCurrentOwner
## 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
$ApprovalStatusDtoCurrentOwner = Initialize-PSSailpoint.V3ApprovalStatusDtoCurrentOwner -Type IDENTITY `
-Id 2c3780a46faadee4016fb4e018c20652 `
-Name Allen Albertson
```
- Convert the resource to JSON
```powershell
$ApprovalStatusDtoCurrentOwner | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V3/Models/Models/ApprovalStatusDtoOriginalOwner.md
View File

@@ -1,39 +0,0 @@
---
id: approval-status-dto-original-owner
title: ApprovalStatusDtoOriginalOwner
pagination_label: ApprovalStatusDtoOriginalOwner
sidebar_label: ApprovalStatusDtoOriginalOwner
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalStatusDtoOriginalOwner', 'ApprovalStatusDtoOriginalOwner']
slug: /tools/sdk/powershell/v3/models/approval-status-dto-original-owner
tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDtoOriginalOwner', 'ApprovalStatusDtoOriginalOwner']
---
# ApprovalStatusDtoOriginalOwner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | Pointer to **Enum** [ "GOVERNANCE_GROUP", "IDENTITY" ] | DTO type of original approval owner's identity. | [optional]
**Id** | Pointer to **String** | ID of original approval owner's identity. | [optional]
**Name** | Pointer to **String** | Display name of original approval owner. | [optional]
## Examples
- Prepare the resource
```powershell
$ApprovalStatusDtoOriginalOwner = Initialize-PSSailpoint.V3ApprovalStatusDtoOriginalOwner -Type IDENTITY `
-Id 2c7180a46faadee4016fb4e018c20642 `
-Name Michael Michaels
```
- Convert the resource to JSON
```powershell
$ApprovalStatusDtoOriginalOwner | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V3/Models/Models/ApprovalSummary.md
View File

@@ -1,39 +0,0 @@
---
id: approval-summary
title: ApprovalSummary
pagination_label: ApprovalSummary
sidebar_label: ApprovalSummary
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalSummary', 'ApprovalSummary']
slug: /tools/sdk/powershell/v3/models/approval-summary
tags: ['SDK', 'Software Development Kit', 'ApprovalSummary', 'ApprovalSummary']
---
# ApprovalSummary
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Pending** | Pointer to **Int32** | The number of pending access requests approvals. | [optional]
**Approved** | Pointer to **Int32** | The number of approved access requests approvals. | [optional]
**Rejected** | Pointer to **Int32** | The number of rejected access requests approvals. | [optional]
## Examples
- Prepare the resource
```powershell
$ApprovalSummary = Initialize-PSSailpoint.V3ApprovalSummary -Pending 0 `
-Approved 0 `
-Rejected 0
```
- Convert the resource to JSON
```powershell
$ApprovalSummary | ConvertTo-JSON
```
[[Back to top]](#)

34
docs/tools/sdk/powershell/Reference/V3/Models/Models/ArrayInner.md
View File

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

49
docs/tools/sdk/powershell/Reference/V3/Models/Models/AttributeDTO.md
View File

@@ -1,49 +0,0 @@
---
id: attribute-dto
title: AttributeDTO
pagination_label: AttributeDTO
sidebar_label: AttributeDTO
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDTO', 'AttributeDTO']
slug: /tools/sdk/powershell/v3/models/attribute-dto
tags: ['SDK', 'Software Development Kit', 'AttributeDTO', 'AttributeDTO']
---
# AttributeDTO
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Key** | Pointer to **String** | Technical name of the Attribute. This is unique and cannot be changed after creation. | [optional]
**Name** | Pointer to **String** | The display name of the key. | [optional]
**Multiselect** | Pointer to **Boolean** | Indicates whether the attribute can have multiple values. | [optional] [default to $false]
**Status** | Pointer to **String** | The status of the Attribute. | [optional]
**Type** | Pointer to **String** | The type of the Attribute. This can be either ""custom"" or ""governance"". | [optional]
**ObjectTypes** | Pointer to **[]String** | An array of object types this attributes values can be applied to. Possible values are ""all"" or ""entitlement"". Value ""all"" means this attribute can be used with all object types that are supported. | [optional]
**Description** | Pointer to **String** | The description of the Attribute. | [optional]
**Values** | Pointer to [**[]AttributeValueDTO**](attribute-value-dto) | | [optional]
## Examples
- Prepare the resource
```powershell
$AttributeDTO = Initialize-PSSailpoint.V3AttributeDTO -Key iscPrivacy `
-Name Privacy `
-Multiselect false `
-Status active `
-Type governance `
-ObjectTypes [entitlement] `
-Description Specifies the level of privacy associated with an access item. `
-Values null
```
- Convert the resource to JSON
```powershell
$AttributeDTO | ConvertTo-JSON
```
[[Back to top]](#)

35
docs/tools/sdk/powershell/Reference/V3/Models/Models/AttributeDTOList.md
View File

@@ -1,35 +0,0 @@
---
id: attribute-dto-list
title: AttributeDTOList
pagination_label: AttributeDTOList
sidebar_label: AttributeDTOList
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDTOList', 'AttributeDTOList']
slug: /tools/sdk/powershell/v3/models/attribute-dto-list
tags: ['SDK', 'Software Development Kit', 'AttributeDTOList', 'AttributeDTOList']
---
# AttributeDTOList
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Attributes** | Pointer to [**[]AttributeDTO**](attribute-dto) | | [optional]
## Examples
- Prepare the resource
```powershell
$AttributeDTOList = Initialize-PSSailpoint.V3AttributeDTOList -Attributes [{key=iscPrivacy, name=Privacy, multiselect=false, status=active, type=governance, objectTypes=[all], description=Specifies the level of privacy associated with an access item., values=[{value=public, name=Public, status=active}]}]
```
- Convert the resource to JSON
```powershell
$AttributeDTOList | ConvertTo-JSON
```
[[Back to top]](#)

47
docs/tools/sdk/powershell/Reference/V3/Models/Models/AttributeDefinition.md
View File

@@ -1,47 +0,0 @@
---
id: attribute-definition
title: AttributeDefinition
pagination_label: AttributeDefinition
sidebar_label: AttributeDefinition
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDefinition', 'AttributeDefinition']
slug: /tools/sdk/powershell/v3/models/attribute-definition
tags: ['SDK', 'Software Development Kit', 'AttributeDefinition', 'AttributeDefinition']
---
# AttributeDefinition
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Name** | Pointer to **String** | The name of the attribute. | [optional]
**Type** | Pointer to [**AttributeDefinitionType**](attribute-definition-type) | | [optional]
**Schema** | Pointer to [**AttributeDefinitionSchema**](attribute-definition-schema) | | [optional]
**Description** | Pointer to **String** | A human-readable description of the attribute. | [optional]
**IsMulti** | Pointer to **Boolean** | Flag indicating whether or not the attribute is multi-valued. | [optional] [default to $false]
**IsEntitlement** | Pointer to **Boolean** | Flag indicating whether or not the attribute is an entitlement. | [optional] [default to $false]
**IsGroup** | Pointer to **Boolean** | Flag indicating whether or not the attribute represents a group. This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. | [optional] [default to $false]
## Examples
- Prepare the resource
```powershell
$AttributeDefinition = Initialize-PSSailpoint.V3AttributeDefinition -Name sAMAccountName `
-Type null `
-Schema null `
-Description SAM Account Name `
-IsMulti false `
-IsEntitlement false `
-IsGroup false
```
- Convert the resource to JSON
```powershell
$AttributeDefinition | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V3/Models/Models/AttributeDefinitionSchema.md
View File

@@ -1,39 +0,0 @@
---
id: attribute-definition-schema
title: AttributeDefinitionSchema
pagination_label: AttributeDefinitionSchema
sidebar_label: AttributeDefinitionSchema
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDefinitionSchema', 'AttributeDefinitionSchema']
slug: /tools/sdk/powershell/v3/models/attribute-definition-schema
tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionSchema', 'AttributeDefinitionSchema']
---
# AttributeDefinitionSchema
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | Pointer to **Enum** [ "CONNECTOR_SCHEMA" ] | The type of object being referenced | [optional]
**Id** | Pointer to **String** | The object ID this reference applies to. | [optional]
**Name** | Pointer to **String** | The human-readable display name of the object. | [optional]
## Examples
- Prepare the resource
```powershell
$AttributeDefinitionSchema = Initialize-PSSailpoint.V3AttributeDefinitionSchema -Type CONNECTOR_SCHEMA `
-Id 2c91808568c529c60168cca6f90c1313 `
-Name group
```
- Convert the resource to JSON
```powershell
$AttributeDefinitionSchema | ConvertTo-JSON
```
[[Back to top]](#)

28
docs/tools/sdk/powershell/Reference/V3/Models/Models/AttributeDefinitionType.md
View File

@@ -1,28 +0,0 @@
---
id: attribute-definition-type
title: AttributeDefinitionType
pagination_label: AttributeDefinitionType
sidebar_label: AttributeDefinitionType
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDefinitionType', 'AttributeDefinitionType']
slug: /tools/sdk/powershell/v3/models/attribute-definition-type
tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionType', 'AttributeDefinitionType']
---
# AttributeDefinitionType
## Enum
* `STRING` (value: `"STRING"`)
* `LONG` (value: `"LONG"`)
* `INT` (value: `"INT"`)
* `BOOLEAN` (value: `"BOOLEAN"`)
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V3/Models/Models/AttributeRequest.md
View File

@@ -1,39 +0,0 @@
---
id: attribute-request
title: AttributeRequest
pagination_label: AttributeRequest
sidebar_label: AttributeRequest
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeRequest', 'AttributeRequest']
slug: /tools/sdk/powershell/v3/models/attribute-request
tags: ['SDK', 'Software Development Kit', 'AttributeRequest', 'AttributeRequest']
---
# AttributeRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Name** | Pointer to **String** | Attribute name. | [optional]
**Op** | Pointer to **String** | Operation to perform on attribute. | [optional]
**Value** | Pointer to **String** | Value of attribute. | [optional]
## Examples
- Prepare the resource
```powershell
$AttributeRequest = Initialize-PSSailpoint.V3AttributeRequest -Name groups `
-Op Add `
-Value 3203537556531076
```
- Convert the resource to JSON
```powershell
$AttributeRequest | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V3/Models/Models/AttributeValueDTO.md
View File

@@ -1,39 +0,0 @@
---
id: attribute-value-dto
title: AttributeValueDTO
pagination_label: AttributeValueDTO
sidebar_label: AttributeValueDTO
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeValueDTO', 'AttributeValueDTO']
slug: /tools/sdk/powershell/v3/models/attribute-value-dto
tags: ['SDK', 'Software Development Kit', 'AttributeValueDTO', 'AttributeValueDTO']
---
# AttributeValueDTO
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Value** | Pointer to **String** | Technical name of the Attribute value. This is unique and cannot be changed after creation. | [optional]
**Name** | Pointer to **String** | The display name of the Attribute value. | [optional]
**Status** | Pointer to **String** | The status of the Attribute value. | [optional]
## Examples
- Prepare the resource
```powershell
$AttributeValueDTO = Initialize-PSSailpoint.V3AttributeValueDTO -Value public `
-Name Public `
-Status active
```
- Convert the resource to JSON
```powershell
$AttributeValueDTO | ConvertTo-JSON
```
[[Back to top]](#)

67
docs/tools/sdk/powershell/Reference/V3/Models/Models/AuthUser.md
View File

@@ -1,67 +0,0 @@
---
id: auth-user
title: AuthUser
pagination_label: AuthUser
sidebar_label: AuthUser
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AuthUser', 'AuthUser']
slug: /tools/sdk/powershell/v3/models/auth-user
tags: ['SDK', 'Software Development Kit', 'AuthUser', 'AuthUser']
---
# AuthUser
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Tenant** | Pointer to **String** | Tenant name. | [optional]
**Id** | Pointer to **String** | Identity ID. | [optional]
**Uid** | Pointer to **String** | Identity's unique identitifier. | [optional]
**VarProfile** | Pointer to **String** | ID of the auth profile associated with the auth user. | [optional]
**IdentificationNumber** | Pointer to **String** | Auth user's employee number. | [optional]
**Email** | Pointer to **String** | Auth user's email. | [optional]
**Phone** | Pointer to **String** | Auth user's phone number. | [optional]
**WorkPhone** | Pointer to **String** | Auth user's work phone number. | [optional]
**PersonalEmail** | Pointer to **String** | Auth user's personal email. | [optional]
**Firstname** | Pointer to **String** | Auth user's first name. | [optional]
**Lastname** | Pointer to **String** | Auth user's last name. | [optional]
**DisplayName** | Pointer to **String** | Auth user's name in displayed format. | [optional]
**Alias** | Pointer to **String** | Auth user's alias. | [optional]
**LastPasswordChangeDate** | Pointer to **String** | Date of last password change. | [optional]
**LastLoginTimestamp** | Pointer to **Int64** | Timestamp of the last login (long type value). | [optional]
**CurrentLoginTimestamp** | Pointer to **Int64** | Timestamp of the current login (long type value). | [optional]
**Capabilities** | Pointer to **[]String** | Array of the auth user's capabilities. | [optional]
## Examples
- Prepare the resource
```powershell
$AuthUser = Initialize-PSSailpoint.V3AuthUser -Tenant test-tenant `
-Id 2c91808458ae7a4f0158b1bbf8af0628 `
-Uid will.smith `
-VarProfile 2c91808458ae7a4f0158b1bbf8af0756 `
-IdentificationNumber 19-5588452 `
-Email william.smith@example.com `
-Phone 5555555555 `
-WorkPhone 5555555555 `
-PersonalEmail william.smith@example.com `
-Firstname Will `
-Lastname Smith `
-DisplayName Will Smith `
-Alias will.smith `
-LastPasswordChangeDate 2021-03-08T22:37:33.901Z `
-LastLoginTimestamp 1656327185832 `
-CurrentLoginTimestamp 1656327185832 `
-Capabilities null
```
- Convert the resource to JSON
```powershell
$AuthUser | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V3/Models/Models/BackupOptions.md
View File

@@ -1,37 +0,0 @@
---
id: backup-options
title: BackupOptions
pagination_label: BackupOptions
sidebar_label: BackupOptions
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'BackupOptions', 'BackupOptions']
slug: /tools/sdk/powershell/v3/models/backup-options
tags: ['SDK', 'Software Development Kit', 'BackupOptions', 'BackupOptions']
---
# BackupOptions
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**IncludeTypes** | Pointer to **[]String** | Object type names to be included in a Configuration Hub backup command. | [optional]
**ObjectOptions** | Pointer to [**map[string]ObjectExportImportNames**](object-export-import-names) | Additional options targeting specific objects related to each item in the includeTypes field. | [optional]
## Examples
- Prepare the resource
```powershell
$BackupOptions = Initialize-PSSailpoint.V3BackupOptions -IncludeTypes null `
-ObjectOptions {TRIGGER_SUBSCRIPTION={includedNames=[Trigger Subscription name]}}
```
- Convert the resource to JSON
```powershell
$BackupOptions | ConvertTo-JSON
```
[[Back to top]](#)

67
docs/tools/sdk/powershell/Reference/V3/Models/Models/BackupResponse.md
View File

@@ -1,67 +0,0 @@
---
id: backup-response
title: BackupResponse
pagination_label: BackupResponse
sidebar_label: BackupResponse
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'BackupResponse', 'BackupResponse']
slug: /tools/sdk/powershell/v3/models/backup-response
tags: ['SDK', 'Software Development Kit', 'BackupResponse', 'BackupResponse']
---
# BackupResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**JobId** | Pointer to **String** | Unique id assigned to this backup. | [optional]
**Status** | Pointer to **Enum** [ "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "CANCELLED", "FAILED" ] | Status of the backup. | [optional]
**Type** | Pointer to **Enum** [ "BACKUP" ] | Type of the job, will always be BACKUP for this type of job. | [optional]
**Tenant** | Pointer to **String** | The name of the tenant performing the upload | [optional]
**RequesterName** | Pointer to **String** | The name of the requester. | [optional]
**FileExists** | Pointer to **Boolean** | Whether or not a file was created and stored for this backup. | [optional] [default to $true]
**Created** | Pointer to **System.DateTime** | The time the job was started. | [optional]
**Modified** | Pointer to **System.DateTime** | The time of the last update to the job. | [optional]
**Completed** | Pointer to **System.DateTime** | The time the job was completed. | [optional]
**Name** | Pointer to **String** | The name assigned to the upload file in the request body. | [optional]
**UserCanDelete** | Pointer to **Boolean** | Whether this backup can be deleted by a regular user. | [optional] [default to $true]
**IsPartial** | Pointer to **Boolean** | Whether this backup contains all supported object types or only some of them. | [optional] [default to $false]
**BackupType** | Pointer to **Enum** [ "UPLOADED", "AUTOMATED", "MANUAL" ] | Denotes how this backup was created. - MANUAL - The backup was created by a user. - AUTOMATED - The backup was created by devops. - AUTOMATED_DRAFT - The backup was created during a draft process. - UPLOADED - The backup was created by uploading an existing configuration file. | [optional]
**Options** | Pointer to [**BackupOptions**](backup-options) | | [optional]
**HydrationStatus** | Pointer to **Enum** [ "HYDRATED", "NOT_HYDRATED" ] | Whether the object details of this backup are ready. | [optional]
**TotalObjectCount** | Pointer to **Int64** | Number of objects contained in this backup. | [optional]
**CloudStorageStatus** | Pointer to **Enum** [ "SYNCED", "NOT_SYNCED", "SYNC_FAILED" ] | Whether this backup has been transferred to a customer storage location. | [optional]
## Examples
- Prepare the resource
```powershell
$BackupResponse = Initialize-PSSailpoint.V3BackupResponse -JobId 3469b87d-48ca-439a-868f-2160001da8c1 `
-Status COMPLETE `
-Type BACKUP `
-Tenant tenant-name `
-RequesterName Requester Name `
-FileExists true `
-Created 2021-05-11T22:23:16Z `
-Modified 2021-05-11T22:23:16Z `
-Completed 2021-05-11T22:23:16Z `
-Name Backup Name `
-UserCanDelete false `
-IsPartial false `
-BackupType MANUAL `
-Options null `
-HydrationStatus NOT_HYDRATED `
-TotalObjectCount 10 `
-CloudStorageStatus SYNCED
```
- Convert the resource to JSON
```powershell
$BackupResponse | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V3/Models/Models/Base64Decode.md
View File

@@ -1,37 +0,0 @@
---
id: base64-decode
title: Base64Decode
pagination_label: Base64Decode
sidebar_label: Base64Decode
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'Base64Decode', 'Base64Decode']
slug: /tools/sdk/powershell/v3/models/base64-decode
tags: ['SDK', 'Software Development Kit', 'Base64Decode', 'Base64Decode']
---
# Base64Decode
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**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
$Base64Decode = Initialize-PSSailpoint.V3Base64Decode -RequiresPeriodicRefresh false `
-VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}}
```
- Convert the resource to JSON
```powershell
$Base64Decode | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V3/Models/Models/Base64Encode.md
View File

@@ -1,37 +0,0 @@
---
id: base64-encode
title: Base64Encode
pagination_label: Base64Encode
sidebar_label: Base64Encode
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'Base64Encode', 'Base64Encode']
slug: /tools/sdk/powershell/v3/models/base64-encode
tags: ['SDK', 'Software Development Kit', 'Base64Encode', 'Base64Encode']
---
# Base64Encode
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**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
$Base64Encode = Initialize-PSSailpoint.V3Base64Encode -RequiresPeriodicRefresh false `
-VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}}
```
- Convert the resource to JSON
```powershell
$Base64Encode | ConvertTo-JSON
```
[[Back to top]](#)

53
docs/tools/sdk/powershell/Reference/V3/Models/Models/BaseAccess.md
View File

@@ -1,53 +0,0 @@
---
id: base-access
title: BaseAccess
pagination_label: BaseAccess
sidebar_label: BaseAccess
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'BaseAccess', 'BaseAccess']
slug: /tools/sdk/powershell/v3/models/base-access
tags: ['SDK', 'Software Development Kit', 'BaseAccess', 'BaseAccess']
---
# BaseAccess
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | The unique ID of the referenced object. | [optional]
**Name** | Pointer to **String** | The human readable name of the referenced object. | [optional]
**Description** | Pointer to **String** | Access item's description. | [optional]
**Created** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**Modified** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
**Synced** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional]
**Enabled** | Pointer to **Boolean** | Indicates whether the access item is currently enabled. | [optional] [default to $false]
**Requestable** | Pointer to **Boolean** | Indicates whether the access item can be requested. | [optional] [default to $true]
**RequestCommentsRequired** | Pointer to **Boolean** | Indicates whether comments are required for requests to access the item. | [optional] [default to $false]
**Owner** | Pointer to [**BaseAccessAllOfOwner**](base-access-all-of-owner) | | [optional]
## Examples
- Prepare the resource
```powershell
$BaseAccess = Initialize-PSSailpoint.V3BaseAccess -Id 2c91808568c529c60168cca6f90c1313 `
-Name John Doe `
-Description The admin role `
-Created 2018-06-25T20:22:28.104Z `
-Modified 2018-06-25T20:22:28.104Z `
-Synced 2018-06-25T20:22:33.104Z `
-Enabled true `
-Requestable true `
-RequestCommentsRequired false `
-Owner null
```
- Convert the resource to JSON
```powershell
$BaseAccess | ConvertTo-JSON
```
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/V3/Models/Models/BaseAccessAllOfOwner.md
View File

@@ -1,41 +0,0 @@
---
id: base-access-all-of-owner
title: BaseAccessAllOfOwner
pagination_label: BaseAccessAllOfOwner
sidebar_label: BaseAccessAllOfOwner
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'BaseAccessAllOfOwner', 'BaseAccessAllOfOwner']
slug: /tools/sdk/powershell/v3/models/base-access-all-of-owner
tags: ['SDK', 'Software Development Kit', 'BaseAccessAllOfOwner', 'BaseAccessAllOfOwner']
---
# BaseAccessAllOfOwner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | Pointer to **Enum** [ "IDENTITY" ] | Owner's DTO type. | [optional]
**Id** | Pointer to **String** | Owner's identity ID. | [optional]
**Name** | Pointer to **String** | Owner's display name. | [optional]
**Email** | Pointer to **String** | Owner's email. | [optional]
## Examples
- Prepare the resource
```powershell
$BaseAccessAllOfOwner = Initialize-PSSailpoint.V3BaseAccessAllOfOwner -Type IDENTITY `
-Id 2c9180a46faadee4016fb4e018c20639 `
-Name Support `
-Email cloud-support@sailpoint.com
```
- Convert the resource to JSON
```powershell
$BaseAccessAllOfOwner | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V3/Models/Models/BaseAccessProfile.md
View File

@@ -1,37 +0,0 @@
---
id: base-access-profile
title: BaseAccessProfile
pagination_label: BaseAccessProfile
sidebar_label: BaseAccessProfile
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'BaseAccessProfile', 'BaseAccessProfile']
slug: /tools/sdk/powershell/v3/models/base-access-profile
tags: ['SDK', 'Software Development Kit', 'BaseAccessProfile', 'BaseAccessProfile']
---
# BaseAccessProfile
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | Access profile's unique ID. | [optional]
**Name** | Pointer to **String** | Access profile's display name. | [optional]
## Examples
- Prepare the resource
```powershell
$BaseAccessProfile = Initialize-PSSailpoint.V3BaseAccessProfile -Id 2c91809c6faade77016fb4f0b63407ae `
-Name Admin Access
```
- Convert the resource to JSON
```powershell
$BaseAccessProfile | ConvertTo-JSON
```
[[Back to top]](#)

55
docs/tools/sdk/powershell/Reference/V3/Models/Models/BaseAccount.md
View File

@@ -1,55 +0,0 @@
---
id: base-account
title: BaseAccount
pagination_label: BaseAccount
sidebar_label: BaseAccount
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'BaseAccount', 'BaseAccount']
slug: /tools/sdk/powershell/v3/models/base-account
tags: ['SDK', 'Software Development Kit', 'BaseAccount', 'BaseAccount']
---
# BaseAccount
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | The unique ID of the referenced object. | [optional]
**Name** | Pointer to **String** | The human readable name of the referenced object. | [optional]
**AccountId** | Pointer to **String** | Account ID. | [optional]
**Source** | Pointer to [**AccountSource**](account-source) | | [optional]
**Disabled** | Pointer to **Boolean** | Indicates whether the account is disabled. | [optional] [default to $false]
**Locked** | Pointer to **Boolean** | Indicates whether the account is locked. | [optional] [default to $false]
**Privileged** | Pointer to **Boolean** | Indicates whether the account is privileged. | [optional] [default to $false]
**ManuallyCorrelated** | Pointer to **Boolean** | Indicates whether the account has been manually correlated to an identity. | [optional] [default to $false]
**PasswordLastSet** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional]
**EntitlementAttributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Map or dictionary of key/value pairs. | [optional]
**Created** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
## Examples
- Prepare the resource
```powershell
$BaseAccount = Initialize-PSSailpoint.V3BaseAccount -Id 2c91808568c529c60168cca6f90c1313 `
-Name John Doe `
-AccountId John.Doe `
-Source null `
-Disabled false `
-Locked false `
-Privileged false `
-ManuallyCorrelated false `
-PasswordLastSet 2018-06-25T20:22:28.104Z `
-EntitlementAttributes {moderator=true, admin=true, trust_level=4} `
-Created 2018-06-25T20:22:28.104Z
```
- Convert the resource to JSON
```powershell
$BaseAccount | ConvertTo-JSON
```
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/V3/Models/Models/BaseCommonDto.md
View File

@@ -1,41 +0,0 @@
---
id: base-common-dto
title: BaseCommonDto
pagination_label: BaseCommonDto
sidebar_label: BaseCommonDto
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'BaseCommonDto', 'BaseCommonDto']
slug: /tools/sdk/powershell/v3/models/base-common-dto
tags: ['SDK', 'Software Development Kit', 'BaseCommonDto', 'BaseCommonDto']
---
# BaseCommonDto
## 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]
## Examples
- Prepare the resource
```powershell
$BaseCommonDto = Initialize-PSSailpoint.V3BaseCommonDto -Id id12345 `
-Name aName `
-Created 2015-05-28T14:07:17Z `
-Modified 2015-05-28T14:07:17Z
```
- Convert the resource to JSON
```powershell
$BaseCommonDto | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V3/Models/Models/BaseDocument.md
View File

@@ -1,39 +0,0 @@
---
id: base-document
title: BaseDocument
pagination_label: BaseDocument
sidebar_label: BaseDocument
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'BaseDocument', 'BaseDocument']
slug: /tools/sdk/powershell/v3/models/base-document
tags: ['SDK', 'Software Development Kit', 'BaseDocument', 'BaseDocument']
---
# BaseDocument
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | | [required]
**Name** | **String** | | [required]
**Type** | [**DocumentType**](document-type) | | [required]
## Examples
- Prepare the resource
```powershell
$BaseDocument = Initialize-PSSailpoint.V3BaseDocument -Id 2c91808375d8e80a0175e1f88a575222 `
-Name john.doe `
-Type null
```
- Convert the resource to JSON
```powershell
$BaseDocument | ConvertTo-JSON
```
[[Back to top]](#)

49
docs/tools/sdk/powershell/Reference/V3/Models/Models/BaseEntitlement.md
View File

@@ -1,49 +0,0 @@
---
id: base-entitlement
title: BaseEntitlement
pagination_label: BaseEntitlement
sidebar_label: BaseEntitlement
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'BaseEntitlement', 'BaseEntitlement']
slug: /tools/sdk/powershell/v3/models/base-entitlement
tags: ['SDK', 'Software Development Kit', 'BaseEntitlement', 'BaseEntitlement']
---
# BaseEntitlement
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**HasPermissions** | Pointer to **Boolean** | Indicates whether the entitlement has permissions. | [optional] [default to $false]
**Description** | Pointer to **String** | Entitlement's description. | [optional]
**Attribute** | Pointer to **String** | Entitlement attribute's name. | [optional]
**Value** | Pointer to **String** | Entitlement's value. | [optional]
**Schema** | Pointer to **String** | Entitlement's schema. | [optional]
**Privileged** | Pointer to **Boolean** | Indicates whether the entitlement is privileged. | [optional] [default to $false]
**Id** | Pointer to **String** | Entitlement's ID. | [optional]
**Name** | Pointer to **String** | Entitlement's name. | [optional]
## Examples
- Prepare the resource
```powershell
$BaseEntitlement = Initialize-PSSailpoint.V3BaseEntitlement -HasPermissions false `
-Description Cloud engineering `
-Attribute memberOf `
-Value CN=Cloud Engineering,DC=sailpoint,DC=COM `
-Schema group `
-Privileged false `
-Id 2c918084575812550157589064f33b89 `
-Name CN=Cloud Engineering,DC=sailpoint,DC=COM
```
- Convert the resource to JSON
```powershell
$BaseEntitlement | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V3/Models/Models/BaseReferenceDto.md
View File

@@ -1,39 +0,0 @@
---
id: base-reference-dto
title: BaseReferenceDto
pagination_label: BaseReferenceDto
sidebar_label: BaseReferenceDto
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'BaseReferenceDto', 'BaseReferenceDto']
slug: /tools/sdk/powershell/v3/models/base-reference-dto
tags: ['SDK', 'Software Development Kit', 'BaseReferenceDto', 'BaseReferenceDto']
---
# BaseReferenceDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | Pointer to [**DtoType**](dto-type) | | [optional]
**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional]
**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional]
## Examples
- Prepare the resource
```powershell
$BaseReferenceDto = Initialize-PSSailpoint.V3BaseReferenceDto -Type null `
-Id 2c91808568c529c60168cca6f90c1313 `
-Name William Wilson
```
- Convert the resource to JSON
```powershell
$BaseReferenceDto | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V3/Models/Models/BaseSegment.md
View File

@@ -1,37 +0,0 @@
---
id: base-segment
title: BaseSegment
pagination_label: BaseSegment
sidebar_label: BaseSegment
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'BaseSegment', 'BaseSegment']
slug: /tools/sdk/powershell/v3/models/base-segment
tags: ['SDK', 'Software Development Kit', 'BaseSegment', 'BaseSegment']
---
# BaseSegment
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | Segment's unique ID. | [optional]
**Name** | Pointer to **String** | Segment's display name. | [optional]
## Examples
- Prepare the resource
```powershell
$BaseSegment = Initialize-PSSailpoint.V3BaseSegment -Id b009b6e3-b56d-41d9-8735-cb532ea0b017 `
-Name Test Segment
```
- Convert the resource to JSON
```powershell
$BaseSegment | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V3/Models/Models/BeforeProvisioningRuleDto.md
View File

@@ -1,39 +0,0 @@
---
id: before-provisioning-rule-dto
title: BeforeProvisioningRuleDto
pagination_label: BeforeProvisioningRuleDto
sidebar_label: BeforeProvisioningRuleDto
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'BeforeProvisioningRuleDto', 'BeforeProvisioningRuleDto']
slug: /tools/sdk/powershell/v3/models/before-provisioning-rule-dto
tags: ['SDK', 'Software Development Kit', 'BeforeProvisioningRuleDto', 'BeforeProvisioningRuleDto']
---
# BeforeProvisioningRuleDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | Pointer to **Enum** [ "RULE" ] | Before Provisioning Rule DTO type. | [optional]
**Id** | Pointer to **String** | Before Provisioning Rule ID. | [optional]
**Name** | Pointer to **String** | Rule display name. | [optional]
## Examples
- Prepare the resource
```powershell
$BeforeProvisioningRuleDto = Initialize-PSSailpoint.V3BeforeProvisioningRuleDto -Type RULE `
-Id 048eb3d55c5a4758bd07dccb87741c78 `
-Name Before Provisioning Airtable Rule
```
- Convert the resource to JSON
```powershell
$BeforeProvisioningRuleDto | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V3/Models/Models/Bound.md
View File

@@ -1,37 +0,0 @@
---
id: bound
title: Bound
pagination_label: Bound
sidebar_label: Bound
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'Bound', 'Bound']
slug: /tools/sdk/powershell/v3/models/bound
tags: ['SDK', 'Software Development Kit', 'Bound', 'Bound']
---
# Bound
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Value** | **String** | The value of the range's endpoint. | [required]
**Inclusive** | Pointer to **Boolean** | Indicates if the endpoint is included in the range. | [optional] [default to $false]
## Examples
- Prepare the resource
```powershell
$Bound = Initialize-PSSailpoint.V3Bound -Value 1 `
-Inclusive false
```
- Convert the resource to JSON
```powershell
$Bound | ConvertTo-JSON
```
[[Back to top]](#)

49
docs/tools/sdk/powershell/Reference/V3/Models/Models/BrandingItem.md
View File

@@ -1,49 +0,0 @@
---
id: branding-item
title: BrandingItem
pagination_label: BrandingItem
sidebar_label: BrandingItem
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'BrandingItem', 'BrandingItem']
slug: /tools/sdk/powershell/v3/models/branding-item
tags: ['SDK', 'Software Development Kit', 'BrandingItem', 'BrandingItem']
---
# BrandingItem
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Name** | Pointer to **String** | name of branding item | [optional]
**ProductName** | Pointer to **String** | product name | [optional]
**ActionButtonColor** | Pointer to **String** | hex value of color for action button | [optional]
**ActiveLinkColor** | Pointer to **String** | hex value of color for link | [optional]
**NavigationColor** | Pointer to **String** | hex value of color for navigation bar | [optional]
**EmailFromAddress** | Pointer to **String** | email from address | [optional]
**StandardLogoURL** | Pointer to **String** | url to standard logo | [optional]
**LoginInformationalMessage** | Pointer to **String** | login information message | [optional]
## Examples
- Prepare the resource
```powershell
$BrandingItem = Initialize-PSSailpoint.V3BrandingItem -Name default `
-ProductName product name `
-ActionButtonColor 0074D9 `
-ActiveLinkColor 011E69 `
-NavigationColor 011E69 `
-EmailFromAddress no-reply@sailpoint.com `
-StandardLogoURL `
-LoginInformationalMessage
```
- Convert the resource to JSON
```powershell
$BrandingItem | ConvertTo-JSON
```
[[Back to top]](#)

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