diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Access.md b/docs/tools/sdk/powershell/reference/v3/Models/Access.md deleted file mode 100644 index 335a89f09..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Access.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: access -title: Access -pagination_label: Access -sidebar_label: Access -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Access'] -slug: /tools/sdk/powershell/v3/models/access -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessConstraint.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessConstraint.md deleted file mode 100644 index 180dcf190..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessConstraint.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: access-constraint -title: AccessConstraint -pagination_label: AccessConstraint -sidebar_label: AccessConstraint -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessConstraint'] -slug: /tools/sdk/powershell/v3/models/access-constraint -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessCriteria.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessCriteria.md deleted file mode 100644 index 5a59c0f11..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessCriteria.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: access-criteria -title: AccessCriteria -pagination_label: AccessCriteria -sidebar_label: AccessCriteria -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessCriteria'] -slug: /tools/sdk/powershell/v3/models/access-criteria -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessCriteriaCriteriaListInner.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessCriteriaCriteriaListInner.md deleted file mode 100644 index db83a7c87..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessCriteriaCriteriaListInner.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/access-criteria-criteria-list-inner -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessItemRequestedFor.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessItemRequestedFor.md deleted file mode 100644 index ae7ccbaf3..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessItemRequestedFor.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/access-item-requested-for -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessItemRequester.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessItemRequester.md deleted file mode 100644 index e476965f0..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessItemRequester.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/access-item-requester -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessItemReviewedBy.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessItemReviewedBy.md deleted file mode 100644 index 829bb671d..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessItemReviewedBy.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/access-item-reviewed-by -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessProfile.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessProfile.md deleted file mode 100644 index 8c1b75783..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessProfile.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -id: access-profile -title: AccessProfile -pagination_label: AccessProfile -sidebar_label: AccessProfile -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfile'] -slug: /tools/sdk/powershell/v3/models/access-profile -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileApprovalScheme.md deleted file mode 100644 index 2818173e4..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileApprovalScheme.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/access-profile-approval-scheme -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileBulkDeleteRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileBulkDeleteRequest.md deleted file mode 100644 index 12468dd44..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileBulkDeleteRequest.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/access-profile-bulk-delete-request -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileBulkDeleteResponse.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileBulkDeleteResponse.md deleted file mode 100644 index 18aad7782..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileBulkDeleteResponse.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/access-profile-bulk-delete-response -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileDocument.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileDocument.md deleted file mode 100644 index 8fcddd6f7..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileDocument.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/access-profile-document -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileDocumentAllOfSource.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileDocumentAllOfSource.md deleted file mode 100644 index 550dddbc6..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileDocumentAllOfSource.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/access-profile-document-all-of-source -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileEntitlement.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileEntitlement.md deleted file mode 100644 index bc4109e38..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileEntitlement.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/access-profile-entitlement -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileRef.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileRef.md deleted file mode 100644 index 256dfb2a6..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileRef.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/access-profile-ref -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileRole.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileRole.md deleted file mode 100644 index 8ec01585f..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileRole.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/access-profile-role -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileSourceRef.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileSourceRef.md deleted file mode 100644 index bb324a54b..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileSourceRef.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/access-profile-source-ref -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileSummary.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileSummary.md deleted file mode 100644 index e422ef534..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileSummary.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/access-profile-summary -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileUsage.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileUsage.md deleted file mode 100644 index 238d55ffc..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileUsage.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/access-profile-usage -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileUsageUsedByInner.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileUsageUsedByInner.md deleted file mode 100644 index a04327fc3..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessProfileUsageUsedByInner.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/access-profile-usage-used-by-inner -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessRequest.md deleted file mode 100644 index 9d9e9521b..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessRequest.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: access-request -title: AccessRequest -pagination_label: AccessRequest -sidebar_label: AccessRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequest'] -slug: /tools/sdk/powershell/v3/models/access-request -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessRequestConfig.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessRequestConfig.md deleted file mode 100644 index 7d85ef3c2..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessRequestConfig.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/access-request-config -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessRequestItem.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessRequestItem.md deleted file mode 100644 index e225a9438..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessRequestItem.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/access-request-item -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessRequestPhases.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessRequestPhases.md deleted file mode 100644 index 61a6f22bc..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessRequestPhases.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/access-request-phases -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessRequestResponse.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessRequestResponse.md deleted file mode 100644 index e27d0ef3e..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessRequestResponse.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/access-request-response -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessRequestTracking.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessRequestTracking.md deleted file mode 100644 index 0ced26662..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessRequestTracking.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/access-request-tracking -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessRequestType.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessRequestType.md deleted file mode 100644 index 3b158b3d6..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessRequestType.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/access-request-type -tags: ['SDK', 'Software Development Kit', 'AccessRequestType'] ---- - - -# AccessRequestType - -## Enum - - -* `GRANT_ACCESS` (value: `"GRANT_ACCESS"`) - -* `REVOKE_ACCESS` (value: `"REVOKE_ACCESS"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessReviewItem.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessReviewItem.md deleted file mode 100644 index f5ddb80d2..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessReviewItem.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/access-review-item -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessReviewReassignment.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessReviewReassignment.md deleted file mode 100644 index 722682260..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessReviewReassignment.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/access-review-reassignment -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessSummary.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessSummary.md deleted file mode 100644 index 6bab7d6d0..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessSummary.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: access-summary -title: AccessSummary -pagination_label: AccessSummary -sidebar_label: AccessSummary -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessSummary'] -slug: /tools/sdk/powershell/v3/models/access-summary -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessSummaryAccess.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessSummaryAccess.md deleted file mode 100644 index 9f0c1f4ab..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessSummaryAccess.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/access-summary-access -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccessType.md b/docs/tools/sdk/powershell/reference/v3/Models/AccessType.md deleted file mode 100644 index a9e97ab78..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccessType.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: access-type -title: AccessType -pagination_label: AccessType -sidebar_label: AccessType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessType'] -slug: /tools/sdk/powershell/v3/models/access-type -tags: ['SDK', 'Software Development Kit', 'AccessType'] ---- - - -# AccessType - -## Enum - - -* `ONLINE` (value: `"ONLINE"`) - -* `OFFLINE` (value: `"OFFLINE"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Account.md b/docs/tools/sdk/powershell/reference/v3/Models/Account.md deleted file mode 100644 index 58d20ee97..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Account.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -id: account -title: Account -pagination_label: Account -sidebar_label: Account -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Account'] -slug: /tools/sdk/powershell/v3/models/account -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccountAction.md b/docs/tools/sdk/powershell/reference/v3/Models/AccountAction.md deleted file mode 100644 index 9ebcc0b52..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccountAction.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: account-action -title: AccountAction -pagination_label: AccountAction -sidebar_label: AccountAction -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAction'] -slug: /tools/sdk/powershell/v3/models/account-action -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccountActivity.md b/docs/tools/sdk/powershell/reference/v3/Models/AccountActivity.md deleted file mode 100644 index 55f274b9e..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccountActivity.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -id: account-activity -title: AccountActivity -pagination_label: AccountActivity -sidebar_label: AccountActivity -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivity'] -slug: /tools/sdk/powershell/v3/models/account-activity -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccountActivityApprovalStatus.md b/docs/tools/sdk/powershell/reference/v3/Models/AccountActivityApprovalStatus.md deleted file mode 100644 index 41aecaee0..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccountActivityApprovalStatus.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/account-activity-approval-status -tags: ['SDK', 'Software Development Kit', 'AccountActivityApprovalStatus'] ---- - - -# AccountActivityApprovalStatus - -## Enum - - -* `FINISHED` (value: `"FINISHED"`) - -* `REJECTED` (value: `"REJECTED"`) - -* `RETURNED` (value: `"RETURNED"`) - -* `EXPIRED` (value: `"EXPIRED"`) - -* `PENDING` (value: `"PENDING"`) - -* `CANCELED` (value: `"CANCELED"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccountActivityDocument.md b/docs/tools/sdk/powershell/reference/v3/Models/AccountActivityDocument.md deleted file mode 100644 index 2d66af5d8..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccountActivityDocument.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/account-activity-document -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccountActivityItem.md b/docs/tools/sdk/powershell/reference/v3/Models/AccountActivityItem.md deleted file mode 100644 index b8a56eaca..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccountActivityItem.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/account-activity-item -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccountActivityItemOperation.md b/docs/tools/sdk/powershell/reference/v3/Models/AccountActivityItemOperation.md deleted file mode 100644 index be87f3a9a..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccountActivityItemOperation.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/account-activity-item-operation -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccountActivitySearchedItem.md b/docs/tools/sdk/powershell/reference/v3/Models/AccountActivitySearchedItem.md deleted file mode 100644 index db5a5bb3b..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccountActivitySearchedItem.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/account-activity-searched-item -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccountAttribute.md b/docs/tools/sdk/powershell/reference/v3/Models/AccountAttribute.md deleted file mode 100644 index 0721d82a9..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccountAttribute.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: account-attribute -title: AccountAttribute -pagination_label: AccountAttribute -sidebar_label: AccountAttribute -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttribute'] -slug: /tools/sdk/powershell/v3/models/account-attribute -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccountAttributes.md b/docs/tools/sdk/powershell/reference/v3/Models/AccountAttributes.md deleted file mode 100644 index f1f6e47d1..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccountAttributes.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: account-attributes -title: AccountAttributes -pagination_label: AccountAttributes -sidebar_label: AccountAttributes -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributes'] -slug: /tools/sdk/powershell/v3/models/account-attributes -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccountAttributesCreate.md b/docs/tools/sdk/powershell/reference/v3/Models/AccountAttributesCreate.md deleted file mode 100644 index f2284bd5e..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccountAttributesCreate.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/account-attributes-create -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccountAttributesCreateAttributes.md b/docs/tools/sdk/powershell/reference/v3/Models/AccountAttributesCreateAttributes.md deleted file mode 100644 index f9e195e11..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccountAttributesCreateAttributes.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/account-attributes-create-attributes -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccountRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/AccountRequest.md deleted file mode 100644 index 75f7578e1..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccountRequest.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: account-request -title: AccountRequest -pagination_label: AccountRequest -sidebar_label: AccountRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountRequest'] -slug: /tools/sdk/powershell/v3/models/account-request -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccountRequestInfo.md b/docs/tools/sdk/powershell/reference/v3/Models/AccountRequestInfo.md deleted file mode 100644 index 9aa40f2ac..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccountRequestInfo.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/account-request-info -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccountRequestResult.md b/docs/tools/sdk/powershell/reference/v3/Models/AccountRequestResult.md deleted file mode 100644 index 53533e3e1..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccountRequestResult.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/account-request-result -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccountSource.md b/docs/tools/sdk/powershell/reference/v3/Models/AccountSource.md deleted file mode 100644 index fac21f4b4..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccountSource.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: account-source -title: AccountSource -pagination_label: AccountSource -sidebar_label: AccountSource -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountSource'] -slug: /tools/sdk/powershell/v3/models/account-source -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccountToggleRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/AccountToggleRequest.md deleted file mode 100644 index 9ddb42824..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccountToggleRequest.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/account-toggle-request -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccountUnlockRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/AccountUnlockRequest.md deleted file mode 100644 index 8d018282a..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccountUnlockRequest.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/account-unlock-request -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccountUsage.md b/docs/tools/sdk/powershell/reference/v3/Models/AccountUsage.md deleted file mode 100644 index f8a63d819..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccountUsage.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: account-usage -title: AccountUsage -pagination_label: AccountUsage -sidebar_label: AccountUsage -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUsage'] -slug: /tools/sdk/powershell/v3/models/account-usage -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccountsAsyncResult.md b/docs/tools/sdk/powershell/reference/v3/Models/AccountsAsyncResult.md deleted file mode 100644 index 32e657f78..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccountsAsyncResult.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/accounts-async-result -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AccountsExportReportArguments.md b/docs/tools/sdk/powershell/reference/v3/Models/AccountsExportReportArguments.md deleted file mode 100644 index e3939cefa..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AccountsExportReportArguments.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/accounts-export-report-arguments -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ActivateCampaignOptions.md b/docs/tools/sdk/powershell/reference/v3/Models/ActivateCampaignOptions.md deleted file mode 100644 index 38d0c57fa..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ActivateCampaignOptions.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/activate-campaign-options -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ActivityInsights.md b/docs/tools/sdk/powershell/reference/v3/Models/ActivityInsights.md deleted file mode 100644 index 1dd0bad41..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ActivityInsights.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: activity-insights -title: ActivityInsights -pagination_label: ActivityInsights -sidebar_label: ActivityInsights -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ActivityInsights'] -slug: /tools/sdk/powershell/v3/models/activity-insights -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AdminReviewReassign.md b/docs/tools/sdk/powershell/reference/v3/Models/AdminReviewReassign.md deleted file mode 100644 index 6e2d22c42..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AdminReviewReassign.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/admin-review-reassign -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AdminReviewReassignReassignTo.md b/docs/tools/sdk/powershell/reference/v3/Models/AdminReviewReassignReassignTo.md deleted file mode 100644 index 48d9dda5a..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AdminReviewReassignReassignTo.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/admin-review-reassign-reassign-to -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AggregationResult.md b/docs/tools/sdk/powershell/reference/v3/Models/AggregationResult.md deleted file mode 100644 index bc24603ed..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AggregationResult.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: aggregation-result -title: AggregationResult -pagination_label: AggregationResult -sidebar_label: AggregationResult -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AggregationResult'] -slug: /tools/sdk/powershell/v3/models/aggregation-result -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AggregationType.md b/docs/tools/sdk/powershell/reference/v3/Models/AggregationType.md deleted file mode 100644 index 14e542287..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AggregationType.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: aggregation-type -title: AggregationType -pagination_label: AggregationType -sidebar_label: AggregationType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AggregationType'] -slug: /tools/sdk/powershell/v3/models/aggregation-type -tags: ['SDK', 'Software Development Kit', 'AggregationType'] ---- - - -# AggregationType - -## Enum - - -* `DSL` (value: `"DSL"`) - -* `SAILPOINT` (value: `"SAILPOINT"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Aggregations.md b/docs/tools/sdk/powershell/reference/v3/Models/Aggregations.md deleted file mode 100644 index 7910496b2..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Aggregations.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: aggregations -title: Aggregations -pagination_label: Aggregations -sidebar_label: Aggregations -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Aggregations'] -slug: /tools/sdk/powershell/v3/models/aggregations -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/App.md b/docs/tools/sdk/powershell/reference/v3/Models/App.md deleted file mode 100644 index d86cae37b..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/App.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: app -title: App -pagination_label: App -sidebar_label: App -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'App'] -slug: /tools/sdk/powershell/v3/models/app -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AppAllOfAccount.md b/docs/tools/sdk/powershell/reference/v3/Models/AppAllOfAccount.md deleted file mode 100644 index 735ede818..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AppAllOfAccount.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/app-all-of-account -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Approval.md b/docs/tools/sdk/powershell/reference/v3/Models/Approval.md deleted file mode 100644 index 0a09f649e..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Approval.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: approval -title: Approval -pagination_label: Approval -sidebar_label: Approval -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Approval'] -slug: /tools/sdk/powershell/v3/models/approval -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ApprovalComment.md b/docs/tools/sdk/powershell/reference/v3/Models/ApprovalComment.md deleted file mode 100644 index 0be484e9b..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ApprovalComment.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: approval-comment -title: ApprovalComment -pagination_label: ApprovalComment -sidebar_label: ApprovalComment -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalComment'] -slug: /tools/sdk/powershell/v3/models/approval-comment -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ApprovalForwardHistory.md b/docs/tools/sdk/powershell/reference/v3/Models/ApprovalForwardHistory.md deleted file mode 100644 index ceb048998..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ApprovalForwardHistory.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/approval-forward-history -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ApprovalItemDetails.md b/docs/tools/sdk/powershell/reference/v3/Models/ApprovalItemDetails.md deleted file mode 100644 index a5124daa8..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ApprovalItemDetails.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/approval-item-details -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ApprovalItems.md b/docs/tools/sdk/powershell/reference/v3/Models/ApprovalItems.md deleted file mode 100644 index d4bda92fc..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ApprovalItems.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: approval-items -title: ApprovalItems -pagination_label: ApprovalItems -sidebar_label: ApprovalItems -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalItems'] -slug: /tools/sdk/powershell/v3/models/approval-items -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ApprovalReminderAndEscalationConfig.md b/docs/tools/sdk/powershell/reference/v3/Models/ApprovalReminderAndEscalationConfig.md deleted file mode 100644 index e1d80c194..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ApprovalReminderAndEscalationConfig.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/approval-reminder-and-escalation-config -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ApprovalScheme.md b/docs/tools/sdk/powershell/reference/v3/Models/ApprovalScheme.md deleted file mode 100644 index af3e2e838..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ApprovalScheme.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: approval-scheme -title: ApprovalScheme -pagination_label: ApprovalScheme -sidebar_label: ApprovalScheme -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalScheme'] -slug: /tools/sdk/powershell/v3/models/approval-scheme -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ApprovalSchemeForRole.md b/docs/tools/sdk/powershell/reference/v3/Models/ApprovalSchemeForRole.md deleted file mode 100644 index 31a83cbc3..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ApprovalSchemeForRole.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/approval-scheme-for-role -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ApprovalStatus.md b/docs/tools/sdk/powershell/reference/v3/Models/ApprovalStatus.md deleted file mode 100644 index 81c5629f5..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ApprovalStatus.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: approval-status -title: ApprovalStatus -pagination_label: ApprovalStatus -sidebar_label: ApprovalStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalStatus'] -slug: /tools/sdk/powershell/v3/models/approval-status -tags: ['SDK', 'Software Development Kit', 'ApprovalStatus'] ---- - - -# ApprovalStatus - -## Enum - - -* `APPROVED` (value: `"APPROVED"`) - -* `REJECTED` (value: `"REJECTED"`) - -* `PENDING` (value: `"PENDING"`) - -* `NOT_READY` (value: `"NOT_READY"`) - -* `CANCELLED` (value: `"CANCELLED"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ApprovalStatusDto.md b/docs/tools/sdk/powershell/reference/v3/Models/ApprovalStatusDto.md deleted file mode 100644 index 4a248b09c..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ApprovalStatusDto.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/approval-status-dto -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ApprovalStatusDtoCurrentOwner.md b/docs/tools/sdk/powershell/reference/v3/Models/ApprovalStatusDtoCurrentOwner.md deleted file mode 100644 index 95a4daa60..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ApprovalStatusDtoCurrentOwner.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/approval-status-dto-current-owner -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ApprovalStatusDtoOriginalOwner.md b/docs/tools/sdk/powershell/reference/v3/Models/ApprovalStatusDtoOriginalOwner.md deleted file mode 100644 index ffbc828c1..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ApprovalStatusDtoOriginalOwner.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/approval-status-dto-original-owner -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ApprovalSummary.md b/docs/tools/sdk/powershell/reference/v3/Models/ApprovalSummary.md deleted file mode 100644 index 6786aabbb..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ApprovalSummary.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: approval-summary -title: ApprovalSummary -pagination_label: ApprovalSummary -sidebar_label: ApprovalSummary -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalSummary'] -slug: /tools/sdk/powershell/v3/models/approval-summary -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ArrayInner.md b/docs/tools/sdk/powershell/reference/v3/Models/ArrayInner.md deleted file mode 100644 index 2385d34e4..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ArrayInner.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: array-inner -title: ArrayInner -pagination_label: ArrayInner -sidebar_label: ArrayInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ArrayInner'] -slug: /tools/sdk/powershell/v3/models/array-inner -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AttributeDTO.md b/docs/tools/sdk/powershell/reference/v3/Models/AttributeDTO.md deleted file mode 100644 index 620486297..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AttributeDTO.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: attribute-dto -title: AttributeDTO -pagination_label: AttributeDTO -sidebar_label: AttributeDTO -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDTO'] -slug: /tools/sdk/powershell/v3/models/attribute-dto -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AttributeDTOList.md b/docs/tools/sdk/powershell/reference/v3/Models/AttributeDTOList.md deleted file mode 100644 index 9cf05b45d..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AttributeDTOList.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/attribute-dto-list -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AttributeDefinition.md b/docs/tools/sdk/powershell/reference/v3/Models/AttributeDefinition.md deleted file mode 100644 index 87bdbf69d..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AttributeDefinition.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: attribute-definition -title: AttributeDefinition -pagination_label: AttributeDefinition -sidebar_label: AttributeDefinition -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDefinition'] -slug: /tools/sdk/powershell/v3/models/attribute-definition -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AttributeDefinitionSchema.md b/docs/tools/sdk/powershell/reference/v3/Models/AttributeDefinitionSchema.md deleted file mode 100644 index 5f35c280e..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AttributeDefinitionSchema.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/attribute-definition-schema -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AttributeDefinitionType.md b/docs/tools/sdk/powershell/reference/v3/Models/AttributeDefinitionType.md deleted file mode 100644 index 2dc46cd0a..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AttributeDefinitionType.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/attribute-definition-type -tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionType'] ---- - - -# AttributeDefinitionType - -## Enum - - -* `STRING` (value: `"STRING"`) - -* `LONG` (value: `"LONG"`) - -* `INT` (value: `"INT"`) - -* `BOOLEAN` (value: `"BOOLEAN"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AttributeRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/AttributeRequest.md deleted file mode 100644 index 6681e4ba2..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AttributeRequest.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: attribute-request -title: AttributeRequest -pagination_label: AttributeRequest -sidebar_label: AttributeRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeRequest'] -slug: /tools/sdk/powershell/v3/models/attribute-request -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AttributeValueDTO.md b/docs/tools/sdk/powershell/reference/v3/Models/AttributeValueDTO.md deleted file mode 100644 index f7ba50543..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AttributeValueDTO.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/attribute-value-dto -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/AuthUser.md b/docs/tools/sdk/powershell/reference/v3/Models/AuthUser.md deleted file mode 100644 index 779ce6cf0..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/AuthUser.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -id: auth-user -title: AuthUser -pagination_label: AuthUser -sidebar_label: AuthUser -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AuthUser'] -slug: /tools/sdk/powershell/v3/models/auth-user -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/BackupOptions.md b/docs/tools/sdk/powershell/reference/v3/Models/BackupOptions.md deleted file mode 100644 index b7d8e1489..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/BackupOptions.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: backup-options -title: BackupOptions -pagination_label: BackupOptions -sidebar_label: BackupOptions -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'BackupOptions'] -slug: /tools/sdk/powershell/v3/models/backup-options -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/BackupResponse.md b/docs/tools/sdk/powershell/reference/v3/Models/BackupResponse.md deleted file mode 100644 index 2f6880ed7..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/BackupResponse.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -id: backup-response -title: BackupResponse -pagination_label: BackupResponse -sidebar_label: BackupResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'BackupResponse'] -slug: /tools/sdk/powershell/v3/models/backup-response -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Base64Decode.md b/docs/tools/sdk/powershell/reference/v3/Models/Base64Decode.md deleted file mode 100644 index 47c4b93b9..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Base64Decode.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: base64-decode -title: Base64Decode -pagination_label: Base64Decode -sidebar_label: Base64Decode -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Base64Decode'] -slug: /tools/sdk/powershell/v3/models/base64-decode -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Base64Encode.md b/docs/tools/sdk/powershell/reference/v3/Models/Base64Encode.md deleted file mode 100644 index 604a78ff9..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Base64Encode.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: base64-encode -title: Base64Encode -pagination_label: Base64Encode -sidebar_label: Base64Encode -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Base64Encode'] -slug: /tools/sdk/powershell/v3/models/base64-encode -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/BaseAccess.md b/docs/tools/sdk/powershell/reference/v3/Models/BaseAccess.md deleted file mode 100644 index 4ad6306a6..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/BaseAccess.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: base-access -title: BaseAccess -pagination_label: BaseAccess -sidebar_label: BaseAccess -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'BaseAccess'] -slug: /tools/sdk/powershell/v3/models/base-access -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/BaseAccessAllOfOwner.md b/docs/tools/sdk/powershell/reference/v3/Models/BaseAccessAllOfOwner.md deleted file mode 100644 index f1f065323..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/BaseAccessAllOfOwner.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/base-access-all-of-owner -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/BaseAccessProfile.md b/docs/tools/sdk/powershell/reference/v3/Models/BaseAccessProfile.md deleted file mode 100644 index 3ddf3b707..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/BaseAccessProfile.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/base-access-profile -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/BaseAccount.md b/docs/tools/sdk/powershell/reference/v3/Models/BaseAccount.md deleted file mode 100644 index 986ba9885..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/BaseAccount.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -id: base-account -title: BaseAccount -pagination_label: BaseAccount -sidebar_label: BaseAccount -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'BaseAccount'] -slug: /tools/sdk/powershell/v3/models/base-account -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/BaseCommonDto.md b/docs/tools/sdk/powershell/reference/v3/Models/BaseCommonDto.md deleted file mode 100644 index ae996d6b6..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/BaseCommonDto.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/base-common-dto -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/BaseDocument.md b/docs/tools/sdk/powershell/reference/v3/Models/BaseDocument.md deleted file mode 100644 index 941415b73..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/BaseDocument.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: base-document -title: BaseDocument -pagination_label: BaseDocument -sidebar_label: BaseDocument -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'BaseDocument'] -slug: /tools/sdk/powershell/v3/models/base-document -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/BaseEntitlement.md b/docs/tools/sdk/powershell/reference/v3/Models/BaseEntitlement.md deleted file mode 100644 index 00eed87bf..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/BaseEntitlement.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: base-entitlement -title: BaseEntitlement -pagination_label: BaseEntitlement -sidebar_label: BaseEntitlement -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'BaseEntitlement'] -slug: /tools/sdk/powershell/v3/models/base-entitlement -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/BaseReferenceDto.md b/docs/tools/sdk/powershell/reference/v3/Models/BaseReferenceDto.md deleted file mode 100644 index 0be1ca48b..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/BaseReferenceDto.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/base-reference-dto -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/BaseSegment.md b/docs/tools/sdk/powershell/reference/v3/Models/BaseSegment.md deleted file mode 100644 index b6b8d0523..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/BaseSegment.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: base-segment -title: BaseSegment -pagination_label: BaseSegment -sidebar_label: BaseSegment -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'BaseSegment'] -slug: /tools/sdk/powershell/v3/models/base-segment -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/BeforeProvisioningRuleDto.md b/docs/tools/sdk/powershell/reference/v3/Models/BeforeProvisioningRuleDto.md deleted file mode 100644 index 4ecdef081..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/BeforeProvisioningRuleDto.md +++ /dev/null @@ -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'] -slug: /tools/sdk/powershell/v3/models/before-provisioning-rule-dto -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Bound.md b/docs/tools/sdk/powershell/reference/v3/Models/Bound.md deleted file mode 100644 index d569145d4..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Bound.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: bound -title: Bound -pagination_label: Bound -sidebar_label: Bound -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Bound'] -slug: /tools/sdk/powershell/v3/models/bound -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/BrandingItem.md b/docs/tools/sdk/powershell/reference/v3/Models/BrandingItem.md deleted file mode 100644 index 1eb1767f9..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/BrandingItem.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: branding-item -title: BrandingItem -pagination_label: BrandingItem -sidebar_label: BrandingItem -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'BrandingItem'] -slug: /tools/sdk/powershell/v3/models/branding-item -tags: ['SDK', 'Software Development Kit', '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]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/BrandingItemCreate.md b/docs/tools/sdk/powershell/reference/v3/Models/BrandingItemCreate.md deleted file mode 100644 index 6b6103f52..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/BrandingItemCreate.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: branding-item-create -title: BrandingItemCreate -pagination_label: BrandingItemCreate -sidebar_label: BrandingItemCreate -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'BrandingItemCreate'] -slug: /tools/sdk/powershell/v3/models/branding-item-create -tags: ['SDK', 'Software Development Kit', 'BrandingItemCreate'] ---- - - -# BrandingItemCreate - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | name of branding item | [required] -**ProductName** | **String** | product name | [required] -**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] -**LoginInformationalMessage** | Pointer to **String** | login information message | [optional] -**FileStandard** | Pointer to **System.IO.FileInfo** | png file with logo | [optional] - -## Examples - -- Prepare the resource -```powershell -$BrandingItemCreate = Initialize-PSSailpoint.V3BrandingItemCreate -Name custom-branding-item ` - -ProductName product name ` - -ActionButtonColor 0074D9 ` - -ActiveLinkColor 011E69 ` - -NavigationColor 011E69 ` - -EmailFromAddress no-reply@sailpoint.com ` - -LoginInformationalMessage ` - -FileStandard \x00\x00\x00\x02 -``` - -- Convert the resource to JSON -```powershell -$BrandingItemCreate | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/BucketAggregation.md b/docs/tools/sdk/powershell/reference/v3/Models/BucketAggregation.md deleted file mode 100644 index 6576982fa..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/BucketAggregation.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: bucket-aggregation -title: BucketAggregation -pagination_label: BucketAggregation -sidebar_label: BucketAggregation -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'BucketAggregation'] -slug: /tools/sdk/powershell/v3/models/bucket-aggregation -tags: ['SDK', 'Software Development Kit', 'BucketAggregation'] ---- - - -# BucketAggregation - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | The name of the bucket aggregate to be included in the result. | [required] -**Type** | Pointer to [**BucketType**](bucket-type) | | [optional] -**Field** | **String** | The field to bucket on. Prefix the field name with '@' to reference a nested object. | [required] -**Size** | Pointer to **Int32** | Maximum number of buckets to include. | [optional] -**MinDocCount** | Pointer to **Int32** | Minimum number of documents a bucket should have. | [optional] - -## Examples - -- Prepare the resource -```powershell -$BucketAggregation = Initialize-PSSailpoint.V3BucketAggregation -Name Identity Locations ` - -Type null ` - -Field attributes.city ` - -Size 100 ` - -MinDocCount 2 -``` - -- Convert the resource to JSON -```powershell -$BucketAggregation | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/BucketType.md b/docs/tools/sdk/powershell/reference/v3/Models/BucketType.md deleted file mode 100644 index 3da69ee3f..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/BucketType.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: bucket-type -title: BucketType -pagination_label: BucketType -sidebar_label: BucketType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'BucketType'] -slug: /tools/sdk/powershell/v3/models/bucket-type -tags: ['SDK', 'Software Development Kit', 'BucketType'] ---- - - -# BucketType - -## Enum - - -* `TERMS` (value: `"TERMS"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/BulkAddTaggedObject.md b/docs/tools/sdk/powershell/reference/v3/Models/BulkAddTaggedObject.md deleted file mode 100644 index 9cda03fe8..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/BulkAddTaggedObject.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: bulk-add-tagged-object -title: BulkAddTaggedObject -pagination_label: BulkAddTaggedObject -sidebar_label: BulkAddTaggedObject -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'BulkAddTaggedObject'] -slug: /tools/sdk/powershell/v3/models/bulk-add-tagged-object -tags: ['SDK', 'Software Development Kit', 'BulkAddTaggedObject'] ---- - - -# BulkAddTaggedObject - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ObjectRefs** | Pointer to [**[]TaggedObjectDto**](tagged-object-dto) | | [optional] -**Tags** | Pointer to **[]String** | Label to be applied to an Object | [optional] -**Operation** | Pointer to **Enum** [ "APPEND", "MERGE" ] | If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored. | [optional] [default to "APPEND"] - -## Examples - -- Prepare the resource -```powershell -$BulkAddTaggedObject = Initialize-PSSailpoint.V3BulkAddTaggedObject -ObjectRefs null ` - -Tags [BU_FINANCE, PCI] ` - -Operation MERGE -``` - -- Convert the resource to JSON -```powershell -$BulkAddTaggedObject | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/BulkRemoveTaggedObject.md b/docs/tools/sdk/powershell/reference/v3/Models/BulkRemoveTaggedObject.md deleted file mode 100644 index 721a9aabe..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/BulkRemoveTaggedObject.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: bulk-remove-tagged-object -title: BulkRemoveTaggedObject -pagination_label: BulkRemoveTaggedObject -sidebar_label: BulkRemoveTaggedObject -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'BulkRemoveTaggedObject'] -slug: /tools/sdk/powershell/v3/models/bulk-remove-tagged-object -tags: ['SDK', 'Software Development Kit', 'BulkRemoveTaggedObject'] ---- - - -# BulkRemoveTaggedObject - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ObjectRefs** | Pointer to [**[]TaggedObjectDto**](tagged-object-dto) | | [optional] -**Tags** | Pointer to **[]String** | Label to be applied to an Object | [optional] - -## Examples - -- Prepare the resource -```powershell -$BulkRemoveTaggedObject = Initialize-PSSailpoint.V3BulkRemoveTaggedObject -ObjectRefs null ` - -Tags [BU_FINANCE, PCI] -``` - -- Convert the resource to JSON -```powershell -$BulkRemoveTaggedObject | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/BulkTaggedObjectResponse.md b/docs/tools/sdk/powershell/reference/v3/Models/BulkTaggedObjectResponse.md deleted file mode 100644 index ea74d7f95..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/BulkTaggedObjectResponse.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: bulk-tagged-object-response -title: BulkTaggedObjectResponse -pagination_label: BulkTaggedObjectResponse -sidebar_label: BulkTaggedObjectResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'BulkTaggedObjectResponse'] -slug: /tools/sdk/powershell/v3/models/bulk-tagged-object-response -tags: ['SDK', 'Software Development Kit', 'BulkTaggedObjectResponse'] ---- - - -# BulkTaggedObjectResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ObjectRefs** | Pointer to [**[]TaggedObjectDto**](tagged-object-dto) | | [optional] -**Tags** | Pointer to **[]String** | Label to be applied to an Object | [optional] - -## Examples - -- Prepare the resource -```powershell -$BulkTaggedObjectResponse = Initialize-PSSailpoint.V3BulkTaggedObjectResponse -ObjectRefs null ` - -Tags [BU_FINANCE, PCI] -``` - -- Convert the resource to JSON -```powershell -$BulkTaggedObjectResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Campaign.md b/docs/tools/sdk/powershell/reference/v3/Models/Campaign.md deleted file mode 100644 index 3ed5cc343..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Campaign.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -id: campaign -title: Campaign -pagination_label: Campaign -sidebar_label: Campaign -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Campaign'] -slug: /tools/sdk/powershell/v3/models/campaign -tags: ['SDK', 'Software Development Kit', 'Campaign'] ---- - - -# Campaign - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Id of the campaign | [optional] [readonly] -**Name** | **String** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] -**Description** | **String** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] -**Deadline** | Pointer to **System.DateTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] -**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION", "MACHINE_ACCOUNT" ] | The type of campaign. Could be extended in the future. | [required] -**EmailNotificationEnabled** | Pointer to **Boolean** | Enables email notification for this campaign | [optional] [default to $false] -**AutoRevokeAllowed** | Pointer to **Boolean** | Allows auto revoke for this campaign | [optional] [default to $false] -**RecommendationsEnabled** | Pointer to **Boolean** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to $false] -**Status** | Pointer to **Enum** [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ] | The campaign's current status. | [optional] [readonly] -**CorrelatedStatus** | Pointer to **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] -**Created** | Pointer to **System.DateTime** | Created time of the campaign | [optional] [readonly] -**TotalCertifications** | Pointer to **Int32** | The total number of certifications in this campaign. | [optional] [readonly] -**CompletedCertifications** | Pointer to **Int32** | The number of completed certifications in this campaign. | [optional] [readonly] -**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] -**Modified** | Pointer to **System.DateTime** | Modified time of the campaign | [optional] [readonly] -**VarFilter** | Pointer to [**CampaignAllOfFilter**](campaign-all-of-filter) | | [optional] -**SunsetCommentsRequired** | Pointer to **Boolean** | Determines if comments on sunset date changes are required. | [optional] [default to $true] -**SourceOwnerCampaignInfo** | Pointer to [**CampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] -**SearchCampaignInfo** | Pointer to [**CampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] -**RoleCompositionCampaignInfo** | Pointer to [**CampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] -**MachineAccountCampaignInfo** | Pointer to [**CampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] -**SourcesWithOrphanEntitlements** | Pointer to [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \""orphan entitlements\"" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] -**MandatoryCommentRequirement** | Pointer to **Enum** [ "ALL_DECISIONS", "REVOKE_ONLY_DECISIONS", "NO_DECISIONS" ] | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Campaign = Initialize-PSSailpoint.V3Campaign -Id 2c9079b270a266a60170a2779fcb0007 ` - -Name Manager Campaign ` - -Description Everyone needs to be reviewed by their manager ` - -Deadline 2020-03-15T10:00:01.456Z ` - -Type MANAGER ` - -EmailNotificationEnabled false ` - -AutoRevokeAllowed false ` - -RecommendationsEnabled true ` - -Status ACTIVE ` - -CorrelatedStatus CORRELATED ` - -Created 2020-03-03T22:15:13.611Z ` - -TotalCertifications 100 ` - -CompletedCertifications 10 ` - -Alerts null ` - -Modified 2020-03-03T22:20:12.674Z ` - -VarFilter null ` - -SunsetCommentsRequired true ` - -SourceOwnerCampaignInfo null ` - -SearchCampaignInfo null ` - -RoleCompositionCampaignInfo null ` - -MachineAccountCampaignInfo null ` - -SourcesWithOrphanEntitlements null ` - -MandatoryCommentRequirement NO_DECISIONS -``` - -- Convert the resource to JSON -```powershell -$Campaign | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CampaignAlert.md b/docs/tools/sdk/powershell/reference/v3/Models/CampaignAlert.md deleted file mode 100644 index d5d735465..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CampaignAlert.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: campaign-alert -title: CampaignAlert -pagination_label: CampaignAlert -sidebar_label: CampaignAlert -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAlert'] -slug: /tools/sdk/powershell/v3/models/campaign-alert -tags: ['SDK', 'Software Development Kit', 'CampaignAlert'] ---- - - -# CampaignAlert - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Level** | Pointer to **Enum** [ "ERROR", "WARN", "INFO" ] | Denotes the level of the message | [optional] -**Localizations** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$CampaignAlert = Initialize-PSSailpoint.V3CampaignAlert -Level ERROR ` - -Localizations null -``` - -- Convert the resource to JSON -```powershell -$CampaignAlert | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CampaignAllOfFilter.md b/docs/tools/sdk/powershell/reference/v3/Models/CampaignAllOfFilter.md deleted file mode 100644 index b3bd21b69..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CampaignAllOfFilter.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: campaign-all-of-filter -title: CampaignAllOfFilter -pagination_label: CampaignAllOfFilter -sidebar_label: CampaignAllOfFilter -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAllOfFilter'] -slug: /tools/sdk/powershell/v3/models/campaign-all-of-filter -tags: ['SDK', 'Software Development Kit', 'CampaignAllOfFilter'] ---- - - -# CampaignAllOfFilter - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The ID of whatever type of filter is being used. | [optional] -**Type** | Pointer to **Enum** [ "CAMPAIGN_FILTER", "RULE" ] | Type of the filter | [optional] -**Name** | Pointer to **String** | Name of the filter | [optional] - -## Examples - -- Prepare the resource -```powershell -$CampaignAllOfFilter = Initialize-PSSailpoint.V3CampaignAllOfFilter -Id 0fbe863c063c4c88a35fd7f17e8a3df5 ` - -Type CAMPAIGN_FILTER ` - -Name Test Filter -``` - -- Convert the resource to JSON -```powershell -$CampaignAllOfFilter | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CampaignAllOfMachineAccountCampaignInfo.md b/docs/tools/sdk/powershell/reference/v3/Models/CampaignAllOfMachineAccountCampaignInfo.md deleted file mode 100644 index 63a7c4059..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CampaignAllOfMachineAccountCampaignInfo.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: campaign-all-of-machine-account-campaign-info -title: CampaignAllOfMachineAccountCampaignInfo -pagination_label: CampaignAllOfMachineAccountCampaignInfo -sidebar_label: CampaignAllOfMachineAccountCampaignInfo -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAllOfMachineAccountCampaignInfo'] -slug: /tools/sdk/powershell/v3/models/campaign-all-of-machine-account-campaign-info -tags: ['SDK', 'Software Development Kit', 'CampaignAllOfMachineAccountCampaignInfo'] ---- - - -# CampaignAllOfMachineAccountCampaignInfo - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**SourceIds** | Pointer to **[]String** | The list of sources to be included in the campaign. | [optional] -**ReviewerType** | Pointer to **Enum** [ "ACCOUNT_OWNER" ] | The reviewer's type. | [optional] - -## Examples - -- Prepare the resource -```powershell -$CampaignAllOfMachineAccountCampaignInfo = Initialize-PSSailpoint.V3CampaignAllOfMachineAccountCampaignInfo -SourceIds [0fbe863c063c4c88a35fd7f17e8a3df5] ` - -ReviewerType ACCOUNT_OWNER -``` - -- Convert the resource to JSON -```powershell -$CampaignAllOfMachineAccountCampaignInfo | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CampaignAllOfRoleCompositionCampaignInfo.md b/docs/tools/sdk/powershell/reference/v3/Models/CampaignAllOfRoleCompositionCampaignInfo.md deleted file mode 100644 index aa5f56af9..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CampaignAllOfRoleCompositionCampaignInfo.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: campaign-all-of-role-composition-campaign-info -title: CampaignAllOfRoleCompositionCampaignInfo -pagination_label: CampaignAllOfRoleCompositionCampaignInfo -sidebar_label: CampaignAllOfRoleCompositionCampaignInfo -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAllOfRoleCompositionCampaignInfo'] -slug: /tools/sdk/powershell/v3/models/campaign-all-of-role-composition-campaign-info -tags: ['SDK', 'Software Development Kit', 'CampaignAllOfRoleCompositionCampaignInfo'] ---- - - -# CampaignAllOfRoleCompositionCampaignInfo - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Reviewer** | Pointer to [**CampaignAllOfSearchCampaignInfoReviewer**](campaign-all-of-search-campaign-info-reviewer) | | [optional] -**RoleIds** | Pointer to **[]String** | Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. | [optional] -**RemediatorRef** | [**CampaignAllOfRoleCompositionCampaignInfoRemediatorRef**](campaign-all-of-role-composition-campaign-info-remediator-ref) | | [required] -**Query** | Pointer to **String** | Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. | [optional] -**Description** | Pointer to **String** | Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available. | [optional] - -## Examples - -- Prepare the resource -```powershell -$CampaignAllOfRoleCompositionCampaignInfo = Initialize-PSSailpoint.V3CampaignAllOfRoleCompositionCampaignInfo -Reviewer null ` - -RoleIds [2c90ad2a70ace7d50170acf22ca90010] ` - -RemediatorRef null ` - -Query Search Query ` - -Description Role Composition Description -``` - -- Convert the resource to JSON -```powershell -$CampaignAllOfRoleCompositionCampaignInfo | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md b/docs/tools/sdk/powershell/reference/v3/Models/CampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md deleted file mode 100644 index 08a46401d..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: campaign-all-of-role-composition-campaign-info-remediator-ref -title: CampaignAllOfRoleCompositionCampaignInfoRemediatorRef -pagination_label: CampaignAllOfRoleCompositionCampaignInfoRemediatorRef -sidebar_label: CampaignAllOfRoleCompositionCampaignInfoRemediatorRef -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAllOfRoleCompositionCampaignInfoRemediatorRef'] -slug: /tools/sdk/powershell/v3/models/campaign-all-of-role-composition-campaign-info-remediator-ref -tags: ['SDK', 'Software Development Kit', 'CampaignAllOfRoleCompositionCampaignInfoRemediatorRef'] ---- - - -# CampaignAllOfRoleCompositionCampaignInfoRemediatorRef - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY" ] | Legal Remediator Type | [required] -**Id** | **String** | The ID of the remediator. | [required] -**Name** | Pointer to **String** | The name of the remediator. | [optional] [readonly] - -## Examples - -- Prepare the resource -```powershell -$CampaignAllOfRoleCompositionCampaignInfoRemediatorRef = Initialize-PSSailpoint.V3CampaignAllOfRoleCompositionCampaignInfoRemediatorRef -Type IDENTITY ` - -Id 2c90ad2a70ace7d50170acf22ca90010 ` - -Name Role Admin -``` - -- Convert the resource to JSON -```powershell -$CampaignAllOfRoleCompositionCampaignInfoRemediatorRef | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CampaignAllOfSearchCampaignInfo.md b/docs/tools/sdk/powershell/reference/v3/Models/CampaignAllOfSearchCampaignInfo.md deleted file mode 100644 index 1ea717aae..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CampaignAllOfSearchCampaignInfo.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: campaign-all-of-search-campaign-info -title: CampaignAllOfSearchCampaignInfo -pagination_label: CampaignAllOfSearchCampaignInfo -sidebar_label: CampaignAllOfSearchCampaignInfo -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAllOfSearchCampaignInfo'] -slug: /tools/sdk/powershell/v3/models/campaign-all-of-search-campaign-info -tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSearchCampaignInfo'] ---- - - -# CampaignAllOfSearchCampaignInfo - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY", "ACCESS" ] | The type of search campaign represented. | [required] -**Description** | Pointer to **String** | Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available. | [optional] -**Reviewer** | Pointer to [**CampaignAllOfSearchCampaignInfoReviewer**](campaign-all-of-search-campaign-info-reviewer) | | [optional] -**Query** | Pointer to **String** | The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set. | [optional] -**IdentityIds** | Pointer to **[]String** | A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set. | [optional] -**AccessConstraints** | Pointer to [**[]AccessConstraint**](access-constraint) | Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. | [optional] - -## Examples - -- Prepare the resource -```powershell -$CampaignAllOfSearchCampaignInfo = Initialize-PSSailpoint.V3CampaignAllOfSearchCampaignInfo -Type ACCESS ` - -Description Search Campaign description ` - -Reviewer null ` - -Query Search Campaign query description ` - -IdentityIds [0fbe863c063c4c88a35fd7f17e8a3df5] ` - -AccessConstraints null -``` - -- Convert the resource to JSON -```powershell -$CampaignAllOfSearchCampaignInfo | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CampaignAllOfSearchCampaignInfoReviewer.md b/docs/tools/sdk/powershell/reference/v3/Models/CampaignAllOfSearchCampaignInfoReviewer.md deleted file mode 100644 index edd79f86e..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CampaignAllOfSearchCampaignInfoReviewer.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: campaign-all-of-search-campaign-info-reviewer -title: CampaignAllOfSearchCampaignInfoReviewer -pagination_label: CampaignAllOfSearchCampaignInfoReviewer -sidebar_label: CampaignAllOfSearchCampaignInfoReviewer -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAllOfSearchCampaignInfoReviewer'] -slug: /tools/sdk/powershell/v3/models/campaign-all-of-search-campaign-info-reviewer -tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSearchCampaignInfoReviewer'] ---- - - -# CampaignAllOfSearchCampaignInfoReviewer - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "GOVERNANCE_GROUP", "IDENTITY" ] | The reviewer's DTO type. | [optional] -**Id** | Pointer to **String** | The reviewer's ID. | [optional] -**Name** | Pointer to **String** | The reviewer's name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$CampaignAllOfSearchCampaignInfoReviewer = Initialize-PSSailpoint.V3CampaignAllOfSearchCampaignInfoReviewer -Type IDENTITY ` - -Id 2c91808568c529c60168cca6f90c1313 ` - -Name William Wilson -``` - -- Convert the resource to JSON -```powershell -$CampaignAllOfSearchCampaignInfoReviewer | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CampaignAllOfSourceOwnerCampaignInfo.md b/docs/tools/sdk/powershell/reference/v3/Models/CampaignAllOfSourceOwnerCampaignInfo.md deleted file mode 100644 index a2f2b9e8a..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CampaignAllOfSourceOwnerCampaignInfo.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: campaign-all-of-source-owner-campaign-info -title: CampaignAllOfSourceOwnerCampaignInfo -pagination_label: CampaignAllOfSourceOwnerCampaignInfo -sidebar_label: CampaignAllOfSourceOwnerCampaignInfo -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAllOfSourceOwnerCampaignInfo'] -slug: /tools/sdk/powershell/v3/models/campaign-all-of-source-owner-campaign-info -tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSourceOwnerCampaignInfo'] ---- - - -# CampaignAllOfSourceOwnerCampaignInfo - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**SourceIds** | Pointer to **[]String** | The list of sources to be included in the campaign. | [optional] - -## Examples - -- Prepare the resource -```powershell -$CampaignAllOfSourceOwnerCampaignInfo = Initialize-PSSailpoint.V3CampaignAllOfSourceOwnerCampaignInfo -SourceIds [0fbe863c063c4c88a35fd7f17e8a3df5] -``` - -- Convert the resource to JSON -```powershell -$CampaignAllOfSourceOwnerCampaignInfo | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CampaignAllOfSourcesWithOrphanEntitlements.md b/docs/tools/sdk/powershell/reference/v3/Models/CampaignAllOfSourcesWithOrphanEntitlements.md deleted file mode 100644 index eb28e4a5c..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CampaignAllOfSourcesWithOrphanEntitlements.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: campaign-all-of-sources-with-orphan-entitlements -title: CampaignAllOfSourcesWithOrphanEntitlements -pagination_label: CampaignAllOfSourcesWithOrphanEntitlements -sidebar_label: CampaignAllOfSourcesWithOrphanEntitlements -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAllOfSourcesWithOrphanEntitlements'] -slug: /tools/sdk/powershell/v3/models/campaign-all-of-sources-with-orphan-entitlements -tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSourcesWithOrphanEntitlements'] ---- - - -# CampaignAllOfSourcesWithOrphanEntitlements - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Id of the source | [optional] -**Type** | Pointer to **Enum** [ "SOURCE" ] | Type | [optional] -**Name** | Pointer to **String** | Name of the source | [optional] - -## Examples - -- Prepare the resource -```powershell -$CampaignAllOfSourcesWithOrphanEntitlements = Initialize-PSSailpoint.V3CampaignAllOfSourcesWithOrphanEntitlements -Id 2c90ad2a70ace7d50170acf22ca90010 ` - -Type SOURCE ` - -Name Source with orphan entitlements -``` - -- Convert the resource to JSON -```powershell -$CampaignAllOfSourcesWithOrphanEntitlements | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CampaignCompleteOptions.md b/docs/tools/sdk/powershell/reference/v3/Models/CampaignCompleteOptions.md deleted file mode 100644 index c6ca93cb9..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CampaignCompleteOptions.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: campaign-complete-options -title: CampaignCompleteOptions -pagination_label: CampaignCompleteOptions -sidebar_label: CampaignCompleteOptions -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignCompleteOptions'] -slug: /tools/sdk/powershell/v3/models/campaign-complete-options -tags: ['SDK', 'Software Development Kit', 'CampaignCompleteOptions'] ---- - - -# CampaignCompleteOptions - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AutoCompleteAction** | Pointer to **Enum** [ "APPROVE", "REVOKE" ] | Determines whether to auto-approve(APPROVE) or auto-revoke(REVOKE) upon campaign completion. | [optional] [default to "APPROVE"] - -## Examples - -- Prepare the resource -```powershell -$CampaignCompleteOptions = Initialize-PSSailpoint.V3CampaignCompleteOptions -AutoCompleteAction REVOKE -``` - -- Convert the resource to JSON -```powershell -$CampaignCompleteOptions | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CampaignFilterDetails.md b/docs/tools/sdk/powershell/reference/v3/Models/CampaignFilterDetails.md deleted file mode 100644 index 5dbdeb625..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CampaignFilterDetails.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: campaign-filter-details -title: CampaignFilterDetails -pagination_label: CampaignFilterDetails -sidebar_label: CampaignFilterDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignFilterDetails'] -slug: /tools/sdk/powershell/v3/models/campaign-filter-details -tags: ['SDK', 'Software Development Kit', 'CampaignFilterDetails'] ---- - - -# CampaignFilterDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The unique ID of the campaign filter | [required] -**Name** | **String** | Campaign filter name. | [required] -**Description** | Pointer to **String** | Campaign filter description. | [optional] -**Owner** | **String** | Owner of the filter. This field automatically populates at creation time with the current user. | [required] -**Mode** | **Enum** [ "INCLUSION", "EXCLUSION" ] | Mode/type of filter, either the INCLUSION or EXCLUSION type. The INCLUSION type includes the data in generated campaigns as per specified in the criteria, whereas the EXCLUSION type excludes the data in generated campaigns as per specified in criteria. | [required] -**CriteriaList** | Pointer to [**[]CampaignFilterDetailsCriteriaListInner**](campaign-filter-details-criteria-list-inner) | List of criteria. | [optional] -**IsSystemFilter** | **Boolean** | If true, the filter is created by the system. If false, the filter is created by a user. | [required][default to $false] - -## Examples - -- Prepare the resource -```powershell -$CampaignFilterDetails = Initialize-PSSailpoint.V3CampaignFilterDetails -Id 5ec18cef39020d6fd7a60ad3970aba61 ` - -Name Identity Attribute Campaign Filter ` - -Description Campaign filter to certify data based on an identity attribute's specified property. ` - -Owner SailPoint Support ` - -Mode INCLUSION ` - -CriteriaList [{type=IDENTITY_ATTRIBUTE, property=displayName, value=support, operation=CONTAINS, negateResult=false, shortCircuit=false, recordChildMatches=false, id=null, suppressMatchedItems=false, children=null}] ` - -IsSystemFilter false -``` - -- Convert the resource to JSON -```powershell -$CampaignFilterDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CampaignFilterDetailsCriteriaListInner.md b/docs/tools/sdk/powershell/reference/v3/Models/CampaignFilterDetailsCriteriaListInner.md deleted file mode 100644 index 5809b443f..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CampaignFilterDetailsCriteriaListInner.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: campaign-filter-details-criteria-list-inner -title: CampaignFilterDetailsCriteriaListInner -pagination_label: CampaignFilterDetailsCriteriaListInner -sidebar_label: CampaignFilterDetailsCriteriaListInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignFilterDetailsCriteriaListInner'] -slug: /tools/sdk/powershell/v3/models/campaign-filter-details-criteria-list-inner -tags: ['SDK', 'Software Development Kit', 'CampaignFilterDetailsCriteriaListInner'] ---- - - -# CampaignFilterDetailsCriteriaListInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | [**CriteriaType**](criteria-type) | | [required] -**Operation** | [**Operation**](operation) | | [required] -**Property** | **String** | Specified key from the type of criteria. | [required] -**Value** | **String** | Value for the specified key from the type of criteria. | [required] - -## Examples - -- Prepare the resource -```powershell -$CampaignFilterDetailsCriteriaListInner = Initialize-PSSailpoint.V3CampaignFilterDetailsCriteriaListInner -Type null ` - -Operation null ` - -Property displayName ` - -Value Allie -``` - -- Convert the resource to JSON -```powershell -$CampaignFilterDetailsCriteriaListInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CampaignReference.md b/docs/tools/sdk/powershell/reference/v3/Models/CampaignReference.md deleted file mode 100644 index 99e15dde2..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CampaignReference.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: campaign-reference -title: CampaignReference -pagination_label: CampaignReference -sidebar_label: CampaignReference -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignReference'] -slug: /tools/sdk/powershell/v3/models/campaign-reference -tags: ['SDK', 'Software Development Kit', 'CampaignReference'] ---- - - -# CampaignReference - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The unique ID of the campaign. | [required] -**Name** | **String** | The name of the campaign. | [required] -**Type** | **Enum** [ "CAMPAIGN" ] | The type of object that is being referenced. | [required] -**CampaignType** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH" ] | The type of the campaign. | [required] -**Description** | **String** | The description of the campaign set by the admin who created it. | [required] -**CorrelatedStatus** | **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [required] -**MandatoryCommentRequirement** | **Enum** [ "ALL_DECISIONS", "REVOKE_ONLY_DECISIONS", "NO_DECISIONS" ] | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [required] - -## Examples - -- Prepare the resource -```powershell -$CampaignReference = Initialize-PSSailpoint.V3CampaignReference -Id ef38f94347e94562b5bb8424a56397d8 ` - -Name Campaign Name ` - -Type CAMPAIGN ` - -CampaignType MANAGER ` - -Description A description of the campaign ` - -CorrelatedStatus CORRELATED ` - -MandatoryCommentRequirement NO_DECISIONS -``` - -- Convert the resource to JSON -```powershell -$CampaignReference | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CampaignReport.md b/docs/tools/sdk/powershell/reference/v3/Models/CampaignReport.md deleted file mode 100644 index ed021c5ed..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CampaignReport.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: campaign-report -title: CampaignReport -pagination_label: CampaignReport -sidebar_label: CampaignReport -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignReport'] -slug: /tools/sdk/powershell/v3/models/campaign-report -tags: ['SDK', 'Software Development Kit', 'CampaignReport'] ---- - - -# CampaignReport - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "REPORT_RESULT" ] | SOD policy violation report result DTO type. | [optional] -**Id** | Pointer to **String** | SOD policy violation report result ID. | [optional] -**Name** | Pointer to **String** | Human-readable name of the SOD policy violation report result. | [optional] -**Status** | Pointer to **Enum** [ "SUCCESS", "WARNING", "ERROR", "TERMINATED", "TEMP_ERROR", "PENDING" ] | Status of a SOD policy violation report. | [optional] -**ReportType** | [**ReportType**](report-type) | | [required] -**LastRunAt** | Pointer to **System.DateTime** | The most recent date and time this report was run | [optional] [readonly] - -## Examples - -- Prepare the resource -```powershell -$CampaignReport = Initialize-PSSailpoint.V3CampaignReport -Type REPORT_RESULT ` - -Id 2c9180835d191a86015d28455b4b232a ` - -Name SOD Policy 1 Violation ` - -Status PENDING ` - -ReportType null ` - -LastRunAt null -``` - -- Convert the resource to JSON -```powershell -$CampaignReport | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CampaignReportsConfig.md b/docs/tools/sdk/powershell/reference/v3/Models/CampaignReportsConfig.md deleted file mode 100644 index ee80e6337..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CampaignReportsConfig.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: campaign-reports-config -title: CampaignReportsConfig -pagination_label: CampaignReportsConfig -sidebar_label: CampaignReportsConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignReportsConfig'] -slug: /tools/sdk/powershell/v3/models/campaign-reports-config -tags: ['SDK', 'Software Development Kit', 'CampaignReportsConfig'] ---- - - -# CampaignReportsConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IdentityAttributeColumns** | Pointer to **[]String** | list of identity attribute columns | [optional] - -## Examples - -- Prepare the resource -```powershell -$CampaignReportsConfig = Initialize-PSSailpoint.V3CampaignReportsConfig -IdentityAttributeColumns [firstname, lastname] -``` - -- Convert the resource to JSON -```powershell -$CampaignReportsConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CampaignTemplate.md b/docs/tools/sdk/powershell/reference/v3/Models/CampaignTemplate.md deleted file mode 100644 index 7d6f9b7b0..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CampaignTemplate.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: campaign-template -title: CampaignTemplate -pagination_label: CampaignTemplate -sidebar_label: CampaignTemplate -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignTemplate'] -slug: /tools/sdk/powershell/v3/models/campaign-template -tags: ['SDK', 'Software Development Kit', 'CampaignTemplate'] ---- - - -# CampaignTemplate - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Id of the campaign template | [optional] -**Name** | **String** | This template's name. Has no bearing on generated campaigns' names. | [required] -**Description** | **String** | This template's description. Has no bearing on generated campaigns' descriptions. | [required] -**Created** | **System.DateTime** | Creation date of Campaign Template | [required][readonly] -**Modified** | **System.DateTime** | Modification date of Campaign Template | [required][readonly] -**Scheduled** | Pointer to **Boolean** | Indicates if this campaign template has been scheduled. | [optional] [readonly] [default to $false] -**OwnerRef** | Pointer to [**CampaignTemplateOwnerRef**](campaign-template-owner-ref) | | [optional] -**DeadlineDuration** | Pointer to **String** | The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign's deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was ""P2W"" (two weeks), the resulting campaign's deadline would be 2020-01-15 (the current date plus 14 days). | [optional] -**Campaign** | [**Campaign**](campaign) | | [required] - -## Examples - -- Prepare the resource -```powershell -$CampaignTemplate = Initialize-PSSailpoint.V3CampaignTemplate -Id 2c9079b270a266a60170a277bb960008 ` - -Name Manager Campaign Template ` - -Description Template for the annual manager campaign. ` - -Created 2020-03-05T22:44:00.364Z ` - -Modified 2020-03-05T22:52:09.969Z ` - -Scheduled false ` - -OwnerRef null ` - -DeadlineDuration P2W ` - -Campaign null -``` - -- Convert the resource to JSON -```powershell -$CampaignTemplate | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CampaignTemplateOwnerRef.md b/docs/tools/sdk/powershell/reference/v3/Models/CampaignTemplateOwnerRef.md deleted file mode 100644 index cac9e82a6..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CampaignTemplateOwnerRef.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: campaign-template-owner-ref -title: CampaignTemplateOwnerRef -pagination_label: CampaignTemplateOwnerRef -sidebar_label: CampaignTemplateOwnerRef -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignTemplateOwnerRef'] -slug: /tools/sdk/powershell/v3/models/campaign-template-owner-ref -tags: ['SDK', 'Software Development Kit', 'CampaignTemplateOwnerRef'] ---- - - -# CampaignTemplateOwnerRef - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Id of the owner | [optional] -**Type** | Pointer to **Enum** [ "IDENTITY" ] | Type of the owner | [optional] -**Name** | Pointer to **String** | Name of the owner | [optional] -**Email** | Pointer to **String** | Email of the owner | [optional] - -## Examples - -- Prepare the resource -```powershell -$CampaignTemplateOwnerRef = Initialize-PSSailpoint.V3CampaignTemplateOwnerRef -Id 2c918086676d3e0601677611dbde220f ` - -Type IDENTITY ` - -Name Mister Manager ` - -Email mr.manager@example.com -``` - -- Convert the resource to JSON -```powershell -$CampaignTemplateOwnerRef | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CampaignsDeleteRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/CampaignsDeleteRequest.md deleted file mode 100644 index a3aa0407a..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CampaignsDeleteRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: campaigns-delete-request -title: CampaignsDeleteRequest -pagination_label: CampaignsDeleteRequest -sidebar_label: CampaignsDeleteRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignsDeleteRequest'] -slug: /tools/sdk/powershell/v3/models/campaigns-delete-request -tags: ['SDK', 'Software Development Kit', 'CampaignsDeleteRequest'] ---- - - -# CampaignsDeleteRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Ids** | Pointer to **[]String** | The ids of the campaigns to delete | [optional] - -## Examples - -- Prepare the resource -```powershell -$CampaignsDeleteRequest = Initialize-PSSailpoint.V3CampaignsDeleteRequest -Ids [2c9180887335cee10173490db1776c26, 2c9180836a712436016a7125a90c0021] -``` - -- Convert the resource to JSON -```powershell -$CampaignsDeleteRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CancelAccessRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/CancelAccessRequest.md deleted file mode 100644 index ee9a887d9..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CancelAccessRequest.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: cancel-access-request -title: CancelAccessRequest -pagination_label: CancelAccessRequest -sidebar_label: CancelAccessRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CancelAccessRequest'] -slug: /tools/sdk/powershell/v3/models/cancel-access-request -tags: ['SDK', 'Software Development Kit', 'CancelAccessRequest'] ---- - - -# CancelAccessRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccountActivityId** | **String** | This refers to the identityRequestId. To successfully cancel an access request, you must provide the identityRequestId. | [required] -**Comment** | **String** | Reason for cancelling the pending access request. | [required] - -## Examples - -- Prepare the resource -```powershell -$CancelAccessRequest = Initialize-PSSailpoint.V3CancelAccessRequest -AccountActivityId 2c9180835d2e5168015d32f890ca1581 ` - -Comment I requested this role by mistake. -``` - -- Convert the resource to JSON -```powershell -$CancelAccessRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CancelledRequestDetails.md b/docs/tools/sdk/powershell/reference/v3/Models/CancelledRequestDetails.md deleted file mode 100644 index 91b8467e2..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CancelledRequestDetails.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: cancelled-request-details -title: CancelledRequestDetails -pagination_label: CancelledRequestDetails -sidebar_label: CancelledRequestDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CancelledRequestDetails'] -slug: /tools/sdk/powershell/v3/models/cancelled-request-details -tags: ['SDK', 'Software Development Kit', 'CancelledRequestDetails'] ---- - - -# CancelledRequestDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Comment** | Pointer to **String** | Comment made by the owner when cancelling the associated request. | [optional] -**Owner** | Pointer to [**OwnerDto**](owner-dto) | | [optional] -**Modified** | Pointer to **System.DateTime** | Date comment was added by the owner when cancelling the associated request. | [optional] - -## Examples - -- Prepare the resource -```powershell -$CancelledRequestDetails = Initialize-PSSailpoint.V3CancelledRequestDetails -Comment This request must be cancelled. ` - -Owner null ` - -Modified 2019-12-20T09:17:12.192Z -``` - -- Convert the resource to JSON -```powershell -$CancelledRequestDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Certification.md b/docs/tools/sdk/powershell/reference/v3/Models/Certification.md deleted file mode 100644 index f9e9624c7..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Certification.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -id: certification -title: Certification -pagination_label: Certification -sidebar_label: Certification -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Certification'] -slug: /tools/sdk/powershell/v3/models/certification -tags: ['SDK', 'Software Development Kit', 'Certification'] ---- - - -# Certification - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | id of the certification | [optional] -**Name** | Pointer to **String** | name of the certification | [optional] -**Campaign** | Pointer to [**CampaignReference**](campaign-reference) | | [optional] -**Completed** | Pointer to **Boolean** | Have all decisions been made? | [optional] -**IdentitiesCompleted** | Pointer to **Int32** | The number of identities for whom all decisions have been made and are complete. | [optional] -**IdentitiesTotal** | Pointer to **Int32** | The total number of identities in the Certification, both complete and incomplete. | [optional] -**Created** | Pointer to **System.DateTime** | created date | [optional] -**Modified** | Pointer to **System.DateTime** | modified date | [optional] -**DecisionsMade** | Pointer to **Int32** | The number of approve/revoke/acknowledge decisions that have been made. | [optional] -**DecisionsTotal** | Pointer to **Int32** | The total number of approve/revoke/acknowledge decisions. | [optional] -**Due** | Pointer to **System.DateTime** | The due date of the certification. | [optional] -**Signed** | Pointer to **System.DateTime** | The date the reviewer signed off on the Certification. | [optional] -**Reviewer** | Pointer to [**Reviewer**](reviewer) | | [optional] -**Reassignment** | Pointer to [**Reassignment**](reassignment) | | [optional] -**HasErrors** | Pointer to **Boolean** | Identifies if the certification has an error | [optional] -**ErrorMessage** | Pointer to **String** | Description of the certification error | [optional] -**Phase** | Pointer to [**CertificationPhase**](certification-phase) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$Certification = Initialize-PSSailpoint.V3Certification -Id 2c9180835d2e5168015d32f890ca1581 ` - -Name Source Owner Access Review for Employees [source] ` - -Campaign null ` - -Completed true ` - -IdentitiesCompleted 5 ` - -IdentitiesTotal 10 ` - -Created 2018-06-25T20:22:28.104Z ` - -Modified 2018-06-25T20:22:28.104Z ` - -DecisionsMade 20 ` - -DecisionsTotal 40 ` - -Due 2018-10-19T13:49:37.385Z ` - -Signed 2018-10-19T13:49:37.385Z ` - -Reviewer null ` - -Reassignment null ` - -HasErrors false ` - -ErrorMessage The certification has an error ` - -Phase null -``` - -- Convert the resource to JSON -```powershell -$Certification | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CertificationDecision.md b/docs/tools/sdk/powershell/reference/v3/Models/CertificationDecision.md deleted file mode 100644 index 56410d081..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CertificationDecision.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: certification-decision -title: CertificationDecision -pagination_label: CertificationDecision -sidebar_label: CertificationDecision -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationDecision'] -slug: /tools/sdk/powershell/v3/models/certification-decision -tags: ['SDK', 'Software Development Kit', 'CertificationDecision'] ---- - - -# CertificationDecision - -## Enum - - -* `APPROVE` (value: `"APPROVE"`) - -* `REVOKE` (value: `"REVOKE"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CertificationIdentitySummary.md b/docs/tools/sdk/powershell/reference/v3/Models/CertificationIdentitySummary.md deleted file mode 100644 index 3ca693d61..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CertificationIdentitySummary.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: certification-identity-summary -title: CertificationIdentitySummary -pagination_label: CertificationIdentitySummary -sidebar_label: CertificationIdentitySummary -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationIdentitySummary'] -slug: /tools/sdk/powershell/v3/models/certification-identity-summary -tags: ['SDK', 'Software Development Kit', 'CertificationIdentitySummary'] ---- - - -# CertificationIdentitySummary - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The ID of the identity summary | [optional] -**Name** | Pointer to **String** | Name of the linked identity | [optional] -**IdentityId** | Pointer to **String** | The ID of the identity being certified | [optional] -**Completed** | Pointer to **Boolean** | Indicates whether the review items for the linked identity's certification have been completed | [optional] - -## Examples - -- Prepare the resource -```powershell -$CertificationIdentitySummary = Initialize-PSSailpoint.V3CertificationIdentitySummary -Id 2c91808772a504f50172a9540e501ba7 ` - -Name Alison Ferguso ` - -IdentityId 2c9180857182306001719937377a33de ` - -Completed true -``` - -- Convert the resource to JSON -```powershell -$CertificationIdentitySummary | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CertificationPhase.md b/docs/tools/sdk/powershell/reference/v3/Models/CertificationPhase.md deleted file mode 100644 index 173745c45..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CertificationPhase.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: certification-phase -title: CertificationPhase -pagination_label: CertificationPhase -sidebar_label: CertificationPhase -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationPhase'] -slug: /tools/sdk/powershell/v3/models/certification-phase -tags: ['SDK', 'Software Development Kit', 'CertificationPhase'] ---- - - -# CertificationPhase - -## Enum - - -* `STAGED` (value: `"STAGED"`) - -* `ACTIVE` (value: `"ACTIVE"`) - -* `SIGNED` (value: `"SIGNED"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CertificationReference.md b/docs/tools/sdk/powershell/reference/v3/Models/CertificationReference.md deleted file mode 100644 index 330f7f617..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CertificationReference.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: certification-reference -title: CertificationReference -pagination_label: CertificationReference -sidebar_label: CertificationReference -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationReference'] -slug: /tools/sdk/powershell/v3/models/certification-reference -tags: ['SDK', 'Software Development Kit', 'CertificationReference'] ---- - - -# CertificationReference - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The id of the certification. | [optional] -**Name** | Pointer to **String** | The name of the certification. | [optional] -**Type** | Pointer to **Enum** [ "CERTIFICATION" ] | | [optional] -**Reviewer** | Pointer to [**Reviewer**](reviewer) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$CertificationReference = Initialize-PSSailpoint.V3CertificationReference -Id ef38f94347e94562b5bb8424a56397d8 ` - -Name Certification Name ` - -Type CERTIFICATION ` - -Reviewer null -``` - -- Convert the resource to JSON -```powershell -$CertificationReference | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CertificationTask.md b/docs/tools/sdk/powershell/reference/v3/Models/CertificationTask.md deleted file mode 100644 index ff872b214..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CertificationTask.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: certification-task -title: CertificationTask -pagination_label: CertificationTask -sidebar_label: CertificationTask -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationTask'] -slug: /tools/sdk/powershell/v3/models/certification-task -tags: ['SDK', 'Software Development Kit', 'CertificationTask'] ---- - - -# CertificationTask - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The ID of the certification task. | [optional] -**Type** | Pointer to **Enum** [ "REASSIGN", "ADMIN_REASSIGN", "COMPLETE_CERTIFICATION", "FINISH_CERTIFICATION", "COMPLETE_CAMPAIGN", "ACTIVATE_CAMPAIGN", "CAMPAIGN_CREATE", "CAMPAIGN_DELETE" ] | The type of the certification task. More values may be added in the future. | [optional] -**TargetType** | Pointer to **Enum** [ "CERTIFICATION", "CAMPAIGN" ] | The type of item that is being operated on by this task whose ID is stored in the targetId field. | [optional] -**TargetId** | Pointer to **String** | The ID of the item being operated on by this task. | [optional] -**Status** | Pointer to **Enum** [ "QUEUED", "IN_PROGRESS", "SUCCESS", "ERROR" ] | The status of the task. | [optional] -**Errors** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | | [optional] -**ReassignmentTrailDTOs** | Pointer to [**[]ReassignmentTrailDTO**](reassignment-trail-dto) | Reassignment trails that lead to self certification identity | [optional] -**Created** | Pointer to **System.DateTime** | The date and time on which this task was created. | [optional] - -## Examples - -- Prepare the resource -```powershell -$CertificationTask = Initialize-PSSailpoint.V3CertificationTask -Id 2c918086719eec070171a7e3355a360a ` - -Type ADMIN_REASSIGN ` - -TargetType CAMPAIGN ` - -TargetId 2c918086719eec070171a7e3355a834c ` - -Status QUEUED ` - -Errors null ` - -ReassignmentTrailDTOs {previousOwner=ef38f94347e94562b5bb8424a56397d8, newOwner=ef38f94347e94562b5bb8424a56397a3, reassignmentType=AUTOMATIC_REASSIGNMENT} ` - -Created 2020-09-24T18:10:47.693Z -``` - -- Convert the resource to JSON -```powershell -$CertificationTask | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ClientLogConfiguration.md b/docs/tools/sdk/powershell/reference/v3/Models/ClientLogConfiguration.md deleted file mode 100644 index 6047d50a3..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ClientLogConfiguration.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: client-log-configuration -title: ClientLogConfiguration -pagination_label: ClientLogConfiguration -sidebar_label: ClientLogConfiguration -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ClientLogConfiguration'] -slug: /tools/sdk/powershell/v3/models/client-log-configuration -tags: ['SDK', 'Software Development Kit', 'ClientLogConfiguration'] ---- - - -# ClientLogConfiguration - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ClientId** | Pointer to **String** | Log configuration's client ID | [optional] -**DurationMinutes** | Pointer to **Int32** | Duration in minutes for log configuration to remain in effect before resetting to defaults. | [optional] [default to 240] -**Expiration** | Pointer to **System.DateTime** | Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. | [optional] -**RootLevel** | [**StandardLevel**](standard-level) | | [required] -**LogLevels** | Pointer to [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] - -## Examples - -- Prepare the resource -```powershell -$ClientLogConfiguration = Initialize-PSSailpoint.V3ClientLogConfiguration -ClientId 3a38a51992e8445ab51a549c0a70ee66 ` - -DurationMinutes 120 ` - -Expiration 2024-11-06T01:31:08.013164Z ` - -RootLevel null ` - -LogLevels INFO -``` - -- Convert the resource to JSON -```powershell -$ClientLogConfiguration | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ClientLogConfigurationDurationMinutes.md b/docs/tools/sdk/powershell/reference/v3/Models/ClientLogConfigurationDurationMinutes.md deleted file mode 100644 index 7f57db251..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ClientLogConfigurationDurationMinutes.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: client-log-configuration-duration-minutes -title: ClientLogConfigurationDurationMinutes -pagination_label: ClientLogConfigurationDurationMinutes -sidebar_label: ClientLogConfigurationDurationMinutes -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ClientLogConfigurationDurationMinutes'] -slug: /tools/sdk/powershell/v3/models/client-log-configuration-duration-minutes -tags: ['SDK', 'Software Development Kit', 'ClientLogConfigurationDurationMinutes'] ---- - - -# ClientLogConfigurationDurationMinutes - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ClientId** | Pointer to **String** | Log configuration's client ID | [optional] -**DurationMinutes** | Pointer to **Int32** | Duration in minutes for log configuration to remain in effect before resetting to defaults. | [optional] [default to 240] -**RootLevel** | [**StandardLevel**](standard-level) | | [required] -**LogLevels** | Pointer to [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] - -## Examples - -- Prepare the resource -```powershell -$ClientLogConfigurationDurationMinutes = Initialize-PSSailpoint.V3ClientLogConfigurationDurationMinutes -ClientId 3a38a51992e8445ab51a549c0a70ee66 ` - -DurationMinutes 120 ` - -RootLevel null ` - -LogLevels INFO -``` - -- Convert the resource to JSON -```powershell -$ClientLogConfigurationDurationMinutes | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ClientLogConfigurationExpiration.md b/docs/tools/sdk/powershell/reference/v3/Models/ClientLogConfigurationExpiration.md deleted file mode 100644 index 5e089b778..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ClientLogConfigurationExpiration.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: client-log-configuration-expiration -title: ClientLogConfigurationExpiration -pagination_label: ClientLogConfigurationExpiration -sidebar_label: ClientLogConfigurationExpiration -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ClientLogConfigurationExpiration'] -slug: /tools/sdk/powershell/v3/models/client-log-configuration-expiration -tags: ['SDK', 'Software Development Kit', 'ClientLogConfigurationExpiration'] ---- - - -# ClientLogConfigurationExpiration - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ClientId** | Pointer to **String** | Log configuration's client ID | [optional] -**Expiration** | Pointer to **System.DateTime** | Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. | [optional] -**RootLevel** | [**StandardLevel**](standard-level) | | [required] -**LogLevels** | Pointer to [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] - -## Examples - -- Prepare the resource -```powershell -$ClientLogConfigurationExpiration = Initialize-PSSailpoint.V3ClientLogConfigurationExpiration -ClientId 3a38a51992e8445ab51a549c0a70ee66 ` - -Expiration 2024-11-06T01:31:08.013164Z ` - -RootLevel null ` - -LogLevels INFO -``` - -- Convert the resource to JSON -```powershell -$ClientLogConfigurationExpiration | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ClientType.md b/docs/tools/sdk/powershell/reference/v3/Models/ClientType.md deleted file mode 100644 index d4487d37e..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ClientType.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: client-type -title: ClientType -pagination_label: ClientType -sidebar_label: ClientType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ClientType'] -slug: /tools/sdk/powershell/v3/models/client-type -tags: ['SDK', 'Software Development Kit', 'ClientType'] ---- - - -# ClientType - -## Enum - - -* `CONFIDENTIAL` (value: `"CONFIDENTIAL"`) - -* `PUBLIC` (value: `"PUBLIC"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Column.md b/docs/tools/sdk/powershell/reference/v3/Models/Column.md deleted file mode 100644 index 2ceb90587..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Column.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: column -title: Column -pagination_label: Column -sidebar_label: Column -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Column'] -slug: /tools/sdk/powershell/v3/models/column -tags: ['SDK', 'Software Development Kit', 'Column'] ---- - - -# Column - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Field** | **String** | The name of the field. | [required] -**Header** | Pointer to **String** | The value of the header. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Column = Initialize-PSSailpoint.V3Column -Field email ` - -Header Work Email -``` - -- Convert the resource to JSON -```powershell -$Column | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Comment.md b/docs/tools/sdk/powershell/reference/v3/Models/Comment.md deleted file mode 100644 index 53590a384..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Comment.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: comment -title: Comment -pagination_label: Comment -sidebar_label: Comment -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Comment'] -slug: /tools/sdk/powershell/v3/models/comment -tags: ['SDK', 'Software Development Kit', 'Comment'] ---- - - -# Comment - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CommenterId** | Pointer to **String** | Id of the identity making the comment | [optional] -**CommenterName** | Pointer to **String** | Human-readable display name of the identity making the comment | [optional] -**Body** | Pointer to **String** | Content of the comment | [optional] -**Date** | Pointer to **System.DateTime** | Date and time comment was made | [optional] - -## Examples - -- Prepare the resource -```powershell -$Comment = Initialize-PSSailpoint.V3Comment -CommenterId 2c918084660f45d6016617daa9210584 ` - -CommenterName Adam Kennedy ` - -Body Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat. ` - -Date 2017-07-11T18:45:37.098Z -``` - -- Convert the resource to JSON -```powershell -$Comment | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CommentDto.md b/docs/tools/sdk/powershell/reference/v3/Models/CommentDto.md deleted file mode 100644 index d74b2664b..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CommentDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: comment-dto -title: CommentDto -pagination_label: CommentDto -sidebar_label: CommentDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CommentDto'] -slug: /tools/sdk/powershell/v3/models/comment-dto -tags: ['SDK', 'Software Development Kit', 'CommentDto'] ---- - - -# CommentDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Comment** | Pointer to **String** | Comment content. | [optional] -**Created** | Pointer to **System.DateTime** | Date and time comment was created. | [optional] -**Author** | Pointer to [**CommentDtoAuthor**](comment-dto-author) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$CommentDto = Initialize-PSSailpoint.V3CommentDto -Comment This is a comment. ` - -Created 2017-07-11T18:45:37.098Z ` - -Author null -``` - -- Convert the resource to JSON -```powershell -$CommentDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CommentDtoAuthor.md b/docs/tools/sdk/powershell/reference/v3/Models/CommentDtoAuthor.md deleted file mode 100644 index 69b8f2d7b..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CommentDtoAuthor.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: comment-dto-author -title: CommentDtoAuthor -pagination_label: CommentDtoAuthor -sidebar_label: CommentDtoAuthor -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CommentDtoAuthor'] -slug: /tools/sdk/powershell/v3/models/comment-dto-author -tags: ['SDK', 'Software Development Kit', 'CommentDtoAuthor'] ---- - - -# CommentDtoAuthor - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | The type of object | [optional] -**Id** | Pointer to **String** | The unique ID of the object | [optional] -**Name** | Pointer to **String** | The display name of the object | [optional] - -## Examples - -- Prepare the resource -```powershell -$CommentDtoAuthor = Initialize-PSSailpoint.V3CommentDtoAuthor -Type IDENTITY ` - -Id 2c9180847e25f377017e2ae8cae4650b ` - -Name john.doe -``` - -- Convert the resource to JSON -```powershell -$CommentDtoAuthor | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CompletedApproval.md b/docs/tools/sdk/powershell/reference/v3/Models/CompletedApproval.md deleted file mode 100644 index 687f5d9e3..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CompletedApproval.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -id: completed-approval -title: CompletedApproval -pagination_label: CompletedApproval -sidebar_label: CompletedApproval -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CompletedApproval'] -slug: /tools/sdk/powershell/v3/models/completed-approval -tags: ['SDK', 'Software Development Kit', 'CompletedApproval'] ---- - - -# CompletedApproval - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The approval id. | [optional] -**Name** | Pointer to **String** | The name of the approval. | [optional] -**Created** | Pointer to **System.DateTime** | When the approval was created. | [optional] -**Modified** | Pointer to **System.DateTime** | When the approval was modified last time. | [optional] -**RequestCreated** | Pointer to **System.DateTime** | When the access-request was created. | [optional] -**RequestType** | Pointer to [**AccessRequestType**](access-request-type) | | [optional] -**Requester** | Pointer to [**AccessItemRequester**](access-item-requester) | | [optional] -**RequestedFor** | Pointer to [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional] -**ReviewedBy** | Pointer to [**AccessItemReviewedBy**](access-item-reviewed-by) | | [optional] -**Owner** | Pointer to [**OwnerDto**](owner-dto) | | [optional] -**RequestedObject** | Pointer to [**RequestableObjectReference**](requestable-object-reference) | | [optional] -**RequesterComment** | Pointer to [**CompletedApprovalRequesterComment**](completed-approval-requester-comment) | | [optional] -**ReviewerComment** | Pointer to [**CompletedApprovalReviewerComment**](completed-approval-reviewer-comment) | | [optional] -**PreviousReviewersComments** | Pointer to [**[]CommentDto**](comment-dto) | The history of the previous reviewers comments. | [optional] -**ForwardHistory** | Pointer to [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] -**CommentRequiredWhenRejected** | Pointer to **Boolean** | When true the rejector has to provide comments when rejecting | [optional] [default to $false] -**State** | Pointer to [**CompletedApprovalState**](completed-approval-state) | | [optional] -**RemoveDate** | Pointer to **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] -**RemoveDateUpdateRequested** | Pointer to **Boolean** | If true, then the request was to change the remove date or sunset date. | [optional] [default to $false] -**CurrentRemoveDate** | Pointer to **System.DateTime** | The remove date or sunset date that was assigned at the time of the request. | [optional] -**SodViolationContext** | Pointer to [**SodViolationContextCheckCompleted**](sod-violation-context-check-completed) | | [optional] -**PreApprovalTriggerResult** | Pointer to [**CompletedApprovalPreApprovalTriggerResult**](completed-approval-pre-approval-trigger-result) | | [optional] -**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs provided during the request. | [optional] - -## Examples - -- Prepare the resource -```powershell -$CompletedApproval = Initialize-PSSailpoint.V3CompletedApproval -Id id12345 ` - -Name aName ` - -Created 2017-07-11T18:45:37.098Z ` - -Modified 2018-07-25T20:22:28.104Z ` - -RequestCreated 2017-07-11T18:45:35.098Z ` - -RequestType null ` - -Requester null ` - -RequestedFor null ` - -ReviewedBy null ` - -Owner null ` - -RequestedObject null ` - -RequesterComment null ` - -ReviewerComment null ` - -PreviousReviewersComments null ` - -ForwardHistory null ` - -CommentRequiredWhenRejected true ` - -State null ` - -RemoveDate 2020-07-11T00:00Z ` - -RemoveDateUpdateRequested true ` - -CurrentRemoveDate 2020-07-11T00:00Z ` - -SodViolationContext null ` - -PreApprovalTriggerResult null ` - -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} -``` - -- Convert the resource to JSON -```powershell -$CompletedApproval | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CompletedApprovalPreApprovalTriggerResult.md b/docs/tools/sdk/powershell/reference/v3/Models/CompletedApprovalPreApprovalTriggerResult.md deleted file mode 100644 index 1707f0061..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CompletedApprovalPreApprovalTriggerResult.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: completed-approval-pre-approval-trigger-result -title: CompletedApprovalPreApprovalTriggerResult -pagination_label: CompletedApprovalPreApprovalTriggerResult -sidebar_label: CompletedApprovalPreApprovalTriggerResult -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CompletedApprovalPreApprovalTriggerResult'] -slug: /tools/sdk/powershell/v3/models/completed-approval-pre-approval-trigger-result -tags: ['SDK', 'Software Development Kit', 'CompletedApprovalPreApprovalTriggerResult'] ---- - - -# CompletedApprovalPreApprovalTriggerResult - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Comment** | Pointer to **String** | The comment from the trigger | [optional] -**Decision** | Pointer to [**CompletedApprovalState**](completed-approval-state) | | [optional] -**Reviewer** | Pointer to **String** | The name of the approver | [optional] -**Date** | Pointer to **System.DateTime** | The date and time the trigger decided on the request | [optional] - -## Examples - -- Prepare the resource -```powershell -$CompletedApprovalPreApprovalTriggerResult = Initialize-PSSailpoint.V3CompletedApprovalPreApprovalTriggerResult -Comment This request was autoapproved by our automated ETS subscriber ` - -Decision null ` - -Reviewer Automated AR Approval ` - -Date 2022-06-07T19:18:40.748Z -``` - -- Convert the resource to JSON -```powershell -$CompletedApprovalPreApprovalTriggerResult | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CompletedApprovalRequesterComment.md b/docs/tools/sdk/powershell/reference/v3/Models/CompletedApprovalRequesterComment.md deleted file mode 100644 index 57c6da5a9..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CompletedApprovalRequesterComment.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: completed-approval-requester-comment -title: CompletedApprovalRequesterComment -pagination_label: CompletedApprovalRequesterComment -sidebar_label: CompletedApprovalRequesterComment -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CompletedApprovalRequesterComment'] -slug: /tools/sdk/powershell/v3/models/completed-approval-requester-comment -tags: ['SDK', 'Software Development Kit', 'CompletedApprovalRequesterComment'] ---- - - -# CompletedApprovalRequesterComment - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Comment** | Pointer to **String** | Comment content. | [optional] -**Created** | Pointer to **System.DateTime** | Date and time comment was created. | [optional] -**Author** | Pointer to [**CommentDtoAuthor**](comment-dto-author) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$CompletedApprovalRequesterComment = Initialize-PSSailpoint.V3CompletedApprovalRequesterComment -Comment This is a comment. ` - -Created 2017-07-11T18:45:37.098Z ` - -Author null -``` - -- Convert the resource to JSON -```powershell -$CompletedApprovalRequesterComment | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CompletedApprovalReviewerComment.md b/docs/tools/sdk/powershell/reference/v3/Models/CompletedApprovalReviewerComment.md deleted file mode 100644 index e6088293a..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CompletedApprovalReviewerComment.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: completed-approval-reviewer-comment -title: CompletedApprovalReviewerComment -pagination_label: CompletedApprovalReviewerComment -sidebar_label: CompletedApprovalReviewerComment -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CompletedApprovalReviewerComment'] -slug: /tools/sdk/powershell/v3/models/completed-approval-reviewer-comment -tags: ['SDK', 'Software Development Kit', 'CompletedApprovalReviewerComment'] ---- - - -# CompletedApprovalReviewerComment - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Comment** | Pointer to **String** | Comment content. | [optional] -**Created** | Pointer to **System.DateTime** | Date and time comment was created. | [optional] -**Author** | Pointer to [**CommentDtoAuthor**](comment-dto-author) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$CompletedApprovalReviewerComment = Initialize-PSSailpoint.V3CompletedApprovalReviewerComment -Comment This is a comment. ` - -Created 2017-07-11T18:45:37.098Z ` - -Author null -``` - -- Convert the resource to JSON -```powershell -$CompletedApprovalReviewerComment | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CompletedApprovalState.md b/docs/tools/sdk/powershell/reference/v3/Models/CompletedApprovalState.md deleted file mode 100644 index bf338ddd6..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CompletedApprovalState.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: completed-approval-state -title: CompletedApprovalState -pagination_label: CompletedApprovalState -sidebar_label: CompletedApprovalState -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CompletedApprovalState'] -slug: /tools/sdk/powershell/v3/models/completed-approval-state -tags: ['SDK', 'Software Development Kit', 'CompletedApprovalState'] ---- - - -# CompletedApprovalState - -## Enum - - -* `APPROVED` (value: `"APPROVED"`) - -* `REJECTED` (value: `"REJECTED"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CompletionStatus.md b/docs/tools/sdk/powershell/reference/v3/Models/CompletionStatus.md deleted file mode 100644 index 2c3f39abf..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CompletionStatus.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: completion-status -title: CompletionStatus -pagination_label: CompletionStatus -sidebar_label: CompletionStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CompletionStatus'] -slug: /tools/sdk/powershell/v3/models/completion-status -tags: ['SDK', 'Software Development Kit', 'CompletionStatus'] ---- - - -# CompletionStatus - -## Enum - - -* `SUCCESS` (value: `"SUCCESS"`) - -* `FAILURE` (value: `"FAILURE"`) - -* `INCOMPLETE` (value: `"INCOMPLETE"`) - -* `PENDING` (value: `"PENDING"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Concatenation.md b/docs/tools/sdk/powershell/reference/v3/Models/Concatenation.md deleted file mode 100644 index 1ee90e387..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Concatenation.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: concatenation -title: Concatenation -pagination_label: Concatenation -sidebar_label: Concatenation -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Concatenation'] -slug: /tools/sdk/powershell/v3/models/concatenation -tags: ['SDK', 'Software Development Kit', 'Concatenation'] ---- - - -# Concatenation - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Values** | [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | An array of items to join together | [required] -**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 -$Concatenation = Initialize-PSSailpoint.V3Concatenation -Values [John, , Smith] ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$Concatenation | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Conditional.md b/docs/tools/sdk/powershell/reference/v3/Models/Conditional.md deleted file mode 100644 index c54e5b5b7..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Conditional.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: conditional -title: Conditional -pagination_label: Conditional -sidebar_label: Conditional -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Conditional'] -slug: /tools/sdk/powershell/v3/models/conditional -tags: ['SDK', 'Software Development Kit', 'Conditional'] ---- - - -# Conditional - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Expression** | **String** | A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. The `eq` operator is the only valid comparison | [required] -**PositiveCondition** | **String** | The output of the transform if the expression evalutes to true | [required] -**NegativeCondition** | **String** | The output of the transform if the expression evalutes to false | [required] -**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 -$Conditional = Initialize-PSSailpoint.V3Conditional -Expression ValueA eq ValueB ` - -PositiveCondition true ` - -NegativeCondition false ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$Conditional | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ConflictingAccessCriteria.md b/docs/tools/sdk/powershell/reference/v3/Models/ConflictingAccessCriteria.md deleted file mode 100644 index c256a242f..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ConflictingAccessCriteria.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: conflicting-access-criteria -title: ConflictingAccessCriteria -pagination_label: ConflictingAccessCriteria -sidebar_label: ConflictingAccessCriteria -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ConflictingAccessCriteria'] -slug: /tools/sdk/powershell/v3/models/conflicting-access-criteria -tags: ['SDK', 'Software Development Kit', 'ConflictingAccessCriteria'] ---- - - -# ConflictingAccessCriteria - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**LeftCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] -**RightCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ConflictingAccessCriteria = Initialize-PSSailpoint.V3ConflictingAccessCriteria -LeftCriteria null ` - -RightCriteria null -``` - -- Convert the resource to JSON -```powershell -$ConflictingAccessCriteria | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ConnectorDetail.md b/docs/tools/sdk/powershell/reference/v3/Models/ConnectorDetail.md deleted file mode 100644 index 18dcbc965..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ConnectorDetail.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -id: connector-detail -title: ConnectorDetail -pagination_label: ConnectorDetail -sidebar_label: ConnectorDetail -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorDetail'] -slug: /tools/sdk/powershell/v3/models/connector-detail -tags: ['SDK', 'Software Development Kit', 'ConnectorDetail'] ---- - - -# ConnectorDetail - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | The connector name | [optional] -**Type** | Pointer to **String** | The connector type | [optional] -**ClassName** | Pointer to **String** | The connector class name | [optional] -**ScriptName** | Pointer to **String** | The connector script name | [optional] -**ApplicationXml** | Pointer to **String** | The connector application xml | [optional] -**CorrelationConfigXml** | Pointer to **String** | The connector correlation config xml | [optional] -**SourceConfigXml** | Pointer to **String** | The connector source config xml | [optional] -**SourceConfig** | Pointer to **String** | The connector source config | [optional] -**SourceConfigFrom** | Pointer to **String** | The connector source config origin | [optional] -**S3Location** | Pointer to **String** | storage path key for this connector | [optional] -**UploadedFiles** | Pointer to **[]String** | The list of uploaded files supported by the connector. If there was any executable files uploaded to thee connector. Typically this be empty as the executable be uploaded at source creation. | [optional] -**FileUpload** | Pointer to **Boolean** | true if the source is file upload | [optional] [default to $false] -**DirectConnect** | Pointer to **Boolean** | true if the source is a direct connect source | [optional] [default to $false] -**TranslationProperties** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A map containing translation attributes by loacale key | [optional] -**ConnectorMetadata** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A map containing metadata pertinent to the UI to be used | [optional] -**Status** | Pointer to **Enum** [ "DEPRECATED", "DEVELOPMENT", "DEMO", "RELEASED" ] | The connector status | [optional] - -## Examples - -- Prepare the resource -```powershell -$ConnectorDetail = Initialize-PSSailpoint.V3ConnectorDetail -Name name ` - -Type ServiceNow ` - -ClassName class name ` - -ScriptName servicenow ` - -ApplicationXml <?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE Application PUBLIC "sailpoint.dtd" "sailpoint.dtd"> -<Application connector="sailpoint.connector.OpenConnectorAdapter" name="custom Atlassian Suite - Cloud" type="custom Atlassian Suite - Cloud"/> - ` - -CorrelationConfigXml <?xml version='1.0' encoding='UTF-8'?> -<!-- Copyright (C) 2021 SailPoint Technologies, Inc. All rights reserved. --> - -<!DOCTYPE CorrelationConfig PUBLIC "sailpoint.dtd" "sailpoint.dtd"> - -<CorrelationConfig name="custom Atlassian Suite - Cloud Account Correlation Config"> - <AttributeAssignments> - <Filter operation="EQ" property="email" value="mail"/> - <Filter operation="EQ" property="empId" value="employeeNumber"/> - <Filter operation="EQ" property="displayName" value="cn"/> - </AttributeAssignments> -</CorrelationConfig> - ` - -SourceConfigXml <?xml version="1.0" encoding="UTF-8" standalone="no"?><!-- Copyright (C) 2023 SailPoint Technologies, Inc. All rights reserved. --><Form xmlns="http://www.sailpoint.com/xsd/sailpoint_form_2_0.xsd" connectorName="custom Atlassian Suite - Cloud" directConnect="true" fileUpload="true" name="Custom Atlassian Suite - Cloud" status="released" type="SourceConfig"> - <BaseConfig> - <Field maxFiles="10" maxSize="300" name="fileUpload" supportedExtensions="jar" type="fileupload" validateJSON="false"/> - </BaseConfig> - - - -</Form> ` - -SourceConfig <?xml version="1.0" encoding="UTF-8" standalone="no"?><!-- Copyright (C) 2023 SailPoint Technologies, Inc. All rights reserved. --><Form xmlns="http://www.sailpoint.com/xsd/sailpoint_form_2_0.xsd" connectorName="custom Atlassian Suite - Cloud" directConnect="true" fileUpload="true" name="Custom Atlassian Suite - Cloud" status="released" type="SourceConfig"> - <BaseConfig> - <Field maxFiles="10" maxSize="300" name="fileUpload" supportedExtensions="jar" type="fileupload" validateJSON="false"/> - </BaseConfig> - - - -</Form> ` - -SourceConfigFrom sp-connect ` - -S3Location custom-connector/scriptname ` - -UploadedFiles [pod/org/connectorFiles/testconnector/test1.jar] ` - -FileUpload true ` - -DirectConnect true ` - -TranslationProperties {de=# Copyright (C) 2024 SailPoint Technologies, Inc. All rights reserved. -# DO NOT EDIT. This file is generated by "sailpointTranslate" command. -menuLabel_ConnectionSettings=Verbindungseinstellungen -menuLabel_AggregationSettings=Aggregationseinstellungen -sectionLabel_AuthenticationSettings=Verbindungseinstellungen -sectionLabel_AggregationSettings=Aggregationseinstellungen -sectionInfo_AuthenticationSettings=Konfigurieren Sie eine direkte Verbindung zwischen der Quelle Delinea Secret Server On-Premise und IdentityNow.<br><br>Geben Sie bei <strong>Zeit\u00fcberschreitung bei Verbindung</strong> die maximal erlaubte Zeitdauer (in Minuten) f\u00fcr die Verbindung von IdentityNow mit der Quelle ein.<br><br>Geben Sie die <strong>Host-URL</strong> der Delinea-SCIM-Serverquelle ein.<br><br>Geben Sie den <strong>API-Token</strong> der Quelle zur Authentifizierung ein. -sectionInfo_AggregationSettings=Geben Sie die Einstellungen f\u00fcr Ihre Aggregation an.<br><br>Geben Sie in das Feld <strong>Seitengr\u00f6\u00dfe</strong> die Anzahl an Kontoeintr\u00e4gen ein, die auf einer einzelnen Seite aggregiert werden sollen, wenn gro\u00dfe Datens\u00e4tze durchlaufen werden.<br>\n<br>Geben Sie im <strong>Kontofilter</strong> die Bedingungen f\u00fcr den Kontofilter an. Beispiel: userName sw "S"<br><br>Geben Sie im <strong>Gruppenfilter</strong> die Gruppenfilterbedingungen an. Beispiel: displayName sw "S". -placeHolder_accAggregation=userName sw "S" -placeHolder_grpAggregation=displayName sw "S" -placeHolder_host=https://{Delinea_SCIM_Server_host}/v2 -docLinkLabel_AuthenticationSettings=Mehr \u00fcber Verbindungseinstellungen -docLinkLabel_Filters=Mehr \u00fcber Konto- und Gruppenfilter -HostURL=Host-URL -ConnectionTimeout=Zeit\u00fcberschreitung bei Verbindung -API_TOKEN=API-Token -JSONPathMapping=JSON-Path-Attribut-Mapping -FilterConditionForAccounts=Kontofilter -FilterConditionForGroups=Gruppenfilter -Page_Size=Seitengr\u00f6\u00dfe -SchemaAttribute=Schema-Attribut -JSONpath=JSON-Pfad -ShortDesc=Das Integrationsmodul IdentityNow f\u00fcr Delinea Secret Server On-Premise bietet die M\u00f6glichkeit einer tiefen Governance f\u00fcr Konten und Gruppen. Es unterst\u00fctzt au\u00dferdem das End-to-End-Lebenszyklus-Management.} ` - -ConnectorMetadata {supportedUI=EXTJS, platform=ccg, shortDesc=connector description} ` - -Status RELEASED -``` - -- Convert the resource to JSON -```powershell -$ConnectorDetail | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CreateExternalExecuteWorkflow200Response.md b/docs/tools/sdk/powershell/reference/v3/Models/CreateExternalExecuteWorkflow200Response.md deleted file mode 100644 index b31fe4d85..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CreateExternalExecuteWorkflow200Response.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: create-external-execute-workflow200-response -title: CreateExternalExecuteWorkflow200Response -pagination_label: CreateExternalExecuteWorkflow200Response -sidebar_label: CreateExternalExecuteWorkflow200Response -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CreateExternalExecuteWorkflow200Response'] -slug: /tools/sdk/powershell/v3/models/create-external-execute-workflow200-response -tags: ['SDK', 'Software Development Kit', 'CreateExternalExecuteWorkflow200Response'] ---- - - -# CreateExternalExecuteWorkflow200Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**WorkflowExecutionId** | Pointer to **String** | The workflow execution id | [optional] -**Message** | Pointer to **String** | An error message if any errors occurred | [optional] - -## Examples - -- Prepare the resource -```powershell -$CreateExternalExecuteWorkflow200Response = Initialize-PSSailpoint.V3CreateExternalExecuteWorkflow200Response -WorkflowExecutionId 0e11cefa-96e7-4b67-90d0-065bc1da5753 ` - -Message Workflow was not executed externally. Check enabled flag on workflow definition -``` - -- Convert the resource to JSON -```powershell -$CreateExternalExecuteWorkflow200Response | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CreateExternalExecuteWorkflowRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/CreateExternalExecuteWorkflowRequest.md deleted file mode 100644 index b452ef4ef..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CreateExternalExecuteWorkflowRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: create-external-execute-workflow-request -title: CreateExternalExecuteWorkflowRequest -pagination_label: CreateExternalExecuteWorkflowRequest -sidebar_label: CreateExternalExecuteWorkflowRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CreateExternalExecuteWorkflowRequest'] -slug: /tools/sdk/powershell/v3/models/create-external-execute-workflow-request -tags: ['SDK', 'Software Development Kit', 'CreateExternalExecuteWorkflowRequest'] ---- - - -# CreateExternalExecuteWorkflowRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**VarInput** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The input for the workflow | [optional] - -## Examples - -- Prepare the resource -```powershell -$CreateExternalExecuteWorkflowRequest = Initialize-PSSailpoint.V3CreateExternalExecuteWorkflowRequest -VarInput {customAttribute1=value1, customAttribute2=value2} -``` - -- Convert the resource to JSON -```powershell -$CreateExternalExecuteWorkflowRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CreateOAuthClientRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/CreateOAuthClientRequest.md deleted file mode 100644 index c41751f36..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CreateOAuthClientRequest.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -id: create-o-auth-client-request -title: CreateOAuthClientRequest -pagination_label: CreateOAuthClientRequest -sidebar_label: CreateOAuthClientRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CreateOAuthClientRequest'] -slug: /tools/sdk/powershell/v3/models/create-o-auth-client-request -tags: ['SDK', 'Software Development Kit', 'CreateOAuthClientRequest'] ---- - - -# CreateOAuthClientRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**BusinessName** | Pointer to **String** | The name of the business the API Client should belong to | [optional] -**HomepageUrl** | Pointer to **String** | The homepage URL associated with the owner of the API Client | [optional] -**Name** | **String** | A human-readable name for the API Client | [required] -**Description** | **String** | A description of the API Client | [required] -**AccessTokenValiditySeconds** | **Int32** | The number of seconds an access token generated for this API Client is valid for | [required] -**RefreshTokenValiditySeconds** | Pointer to **Int32** | The number of seconds a refresh token generated for this API Client is valid for | [optional] -**RedirectUris** | Pointer to **[]String** | A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client. | [optional] -**GrantTypes** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | [required] -**AccessType** | [**AccessType**](access-type) | | [required] -**Type** | Pointer to [**ClientType**](client-type) | | [optional] -**Internal** | Pointer to **Boolean** | An indicator of whether the API Client can be used for requests internal within the product. | [optional] -**Enabled** | **Boolean** | An indicator of whether the API Client is enabled for use | [required] -**StrongAuthSupported** | Pointer to **Boolean** | An indicator of whether the API Client supports strong authentication | [optional] -**ClaimsSupported** | Pointer to **Boolean** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [optional] -**Scope** | Pointer to **[]String** | Scopes of the API Client. If no scope is specified, the client will be created with the default scope ""sp:scopes:all"". This means the API Client will have all the rights of the owner who created it. | [optional] - -## Examples - -- Prepare the resource -```powershell -$CreateOAuthClientRequest = Initialize-PSSailpoint.V3CreateOAuthClientRequest -BusinessName Acme-Solar ` - -HomepageUrl http://localhost:12345 ` - -Name Demo API Client ` - -Description An API client used for the authorization_code, refresh_token, and client_credentials flows ` - -AccessTokenValiditySeconds 750 ` - -RefreshTokenValiditySeconds 86400 ` - -RedirectUris [http://localhost:12345] ` - -GrantTypes [AUTHORIZATION_CODE, CLIENT_CREDENTIALS, REFRESH_TOKEN] ` - -AccessType null ` - -Type null ` - -Internal false ` - -Enabled true ` - -StrongAuthSupported false ` - -ClaimsSupported false ` - -Scope [demo:api-client-scope:first, demo:api-client-scope:second] -``` - -- Convert the resource to JSON -```powershell -$CreateOAuthClientRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CreateOAuthClientResponse.md b/docs/tools/sdk/powershell/reference/v3/Models/CreateOAuthClientResponse.md deleted file mode 100644 index 38899d410..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CreateOAuthClientResponse.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: create-o-auth-client-response -title: CreateOAuthClientResponse -pagination_label: CreateOAuthClientResponse -sidebar_label: CreateOAuthClientResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CreateOAuthClientResponse'] -slug: /tools/sdk/powershell/v3/models/create-o-auth-client-response -tags: ['SDK', 'Software Development Kit', 'CreateOAuthClientResponse'] ---- - - -# CreateOAuthClientResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | ID of the OAuth client | [required] -**Secret** | **String** | Secret of the OAuth client (This field is only returned on the intial create call.) | [required] -**BusinessName** | **String** | The name of the business the API Client should belong to | [required] -**HomepageUrl** | **String** | The homepage URL associated with the owner of the API Client | [required] -**Name** | **String** | A human-readable name for the API Client | [required] -**Description** | **String** | A description of the API Client | [required] -**AccessTokenValiditySeconds** | **Int32** | The number of seconds an access token generated for this API Client is valid for | [required] -**RefreshTokenValiditySeconds** | **Int32** | The number of seconds a refresh token generated for this API Client is valid for | [required] -**RedirectUris** | **[]String** | A list of the approved redirect URIs used with the authorization_code flow | [required] -**GrantTypes** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | [required] -**AccessType** | [**AccessType**](access-type) | | [required] -**Type** | [**ClientType**](client-type) | | [required] -**Internal** | **Boolean** | An indicator of whether the API Client can be used for requests internal to IDN | [required] -**Enabled** | **Boolean** | An indicator of whether the API Client is enabled for use | [required] -**StrongAuthSupported** | **Boolean** | An indicator of whether the API Client supports strong authentication | [required] -**ClaimsSupported** | **Boolean** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [required] -**Created** | **System.DateTime** | The date and time, down to the millisecond, when the API Client was created | [required] -**Modified** | **System.DateTime** | The date and time, down to the millisecond, when the API Client was last updated | [required] -**Scope** | **[]String** | Scopes of the API Client. | [required] - -## Examples - -- Prepare the resource -```powershell -$CreateOAuthClientResponse = Initialize-PSSailpoint.V3CreateOAuthClientResponse -Id 2c9180835d2e5168015d32f890ca1581 ` - -Secret 5c32dd9b21adb51c77794d46e71de117a1d0ddb36a7ff941fa28014ab7de2cf3 ` - -BusinessName Acme-Solar ` - -HomepageUrl http://localhost:12345 ` - -Name Demo API Client ` - -Description An API client used for the authorization_code, refresh_token, and client_credentials flows ` - -AccessTokenValiditySeconds 750 ` - -RefreshTokenValiditySeconds 86400 ` - -RedirectUris [http://localhost:12345] ` - -GrantTypes [AUTHORIZATION_CODE, CLIENT_CREDENTIALS, REFRESH_TOKEN] ` - -AccessType null ` - -Type null ` - -Internal false ` - -Enabled true ` - -StrongAuthSupported false ` - -ClaimsSupported false ` - -Created 2017-07-11T18:45:37.098Z ` - -Modified 2018-06-25T20:22:28.104Z ` - -Scope [demo:api-client-scope:first, demo:api-client-scope:second] -``` - -- Convert the resource to JSON -```powershell -$CreateOAuthClientResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CreatePersonalAccessTokenRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/CreatePersonalAccessTokenRequest.md deleted file mode 100644 index 9898dcf8b..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CreatePersonalAccessTokenRequest.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: create-personal-access-token-request -title: CreatePersonalAccessTokenRequest -pagination_label: CreatePersonalAccessTokenRequest -sidebar_label: CreatePersonalAccessTokenRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CreatePersonalAccessTokenRequest'] -slug: /tools/sdk/powershell/v3/models/create-personal-access-token-request -tags: ['SDK', 'Software Development Kit', 'CreatePersonalAccessTokenRequest'] ---- - - -# CreatePersonalAccessTokenRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. | [required] -**Scope** | Pointer to **[]String** | Scopes of the personal access token. If no scope is specified, the token will be created with the default scope ""sp:scopes:all"". This means the personal access token will have all the rights of the owner who created it. | [optional] -**AccessTokenValiditySeconds** | Pointer to **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [optional] - -## Examples - -- Prepare the resource -```powershell -$CreatePersonalAccessTokenRequest = Initialize-PSSailpoint.V3CreatePersonalAccessTokenRequest -Name NodeJS Integration ` - -Scope [demo:personal-access-token-scope:first, demo:personal-access-token-scope:second] ` - -AccessTokenValiditySeconds 36900 -``` - -- Convert the resource to JSON -```powershell -$CreatePersonalAccessTokenRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CreatePersonalAccessTokenResponse.md b/docs/tools/sdk/powershell/reference/v3/Models/CreatePersonalAccessTokenResponse.md deleted file mode 100644 index 13dfaa4aa..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CreatePersonalAccessTokenResponse.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: create-personal-access-token-response -title: CreatePersonalAccessTokenResponse -pagination_label: CreatePersonalAccessTokenResponse -sidebar_label: CreatePersonalAccessTokenResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CreatePersonalAccessTokenResponse'] -slug: /tools/sdk/powershell/v3/models/create-personal-access-token-response -tags: ['SDK', 'Software Development Kit', 'CreatePersonalAccessTokenResponse'] ---- - - -# CreatePersonalAccessTokenResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The ID of the personal access token (to be used as the username for Basic Auth). | [required] -**Secret** | **String** | The secret of the personal access token (to be used as the password for Basic Auth). | [required] -**Scope** | **[]String** | Scopes of the personal access token. | [required] -**Name** | **String** | The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. | [required] -**Owner** | [**PatOwner**](pat-owner) | | [required] -**Created** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was created. | [required] -**AccessTokenValiditySeconds** | **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [required] - -## Examples - -- Prepare the resource -```powershell -$CreatePersonalAccessTokenResponse = Initialize-PSSailpoint.V3CreatePersonalAccessTokenResponse -Id 86f1dc6fe8f54414950454cbb11278fa ` - -Secret 1d1bef2b9f426383447f64f69349fc7cac176042578d205c256ba3f37c59adb9 ` - -Scope [demo:personal-access-token-scope:first, demo:personal-access-token-scope:second] ` - -Name NodeJS Integration ` - -Owner null ` - -Created 2017-07-11T18:45:37.098Z ` - -AccessTokenValiditySeconds 36900 -``` - -- Convert the resource to JSON -```powershell -$CreatePersonalAccessTokenResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CreateSavedSearchRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/CreateSavedSearchRequest.md deleted file mode 100644 index b5f6f7420..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CreateSavedSearchRequest.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -id: create-saved-search-request -title: CreateSavedSearchRequest -pagination_label: CreateSavedSearchRequest -sidebar_label: CreateSavedSearchRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CreateSavedSearchRequest'] -slug: /tools/sdk/powershell/v3/models/create-saved-search-request -tags: ['SDK', 'Software Development Kit', 'CreateSavedSearchRequest'] ---- - - -# CreateSavedSearchRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | The name of the saved search. | [optional] -**Description** | Pointer to **String** | The description of the saved search. | [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] -**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required] -**Columns** | Pointer to [**map[string]Column[]**](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_arrays?view=powershell-7.4) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional] -**Query** | **String** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [required] -**Fields** | Pointer to **[]String** | The fields to be searched against in a multi-field query. | [optional] -**OrderBy** | Pointer to **map[string]String[]** | Sort by index. This takes precedence over the `sort` property. | [optional] -**Sort** | Pointer to **[]String** | The fields to be used to sort the search results. | [optional] -**Filters** | Pointer to [**SavedSearchDetailFilters**](saved-search-detail-filters) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$CreateSavedSearchRequest = Initialize-PSSailpoint.V3CreateSavedSearchRequest -Name Disabled accounts ` - -Description Disabled accounts ` - -Created 2018-06-25T20:22:28.104Z ` - -Modified 2018-06-25T20:22:28.104Z ` - -Indices [identities] ` - -Columns {identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]} ` - -Query @accounts(disabled:true) ` - -Fields [disabled] ` - -OrderBy {identity=[lastName, firstName], role=[name]} ` - -Sort [displayName] ` - -Filters null -``` - -- Convert the resource to JSON -```powershell -$CreateSavedSearchRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CreateScheduledSearchRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/CreateScheduledSearchRequest.md deleted file mode 100644 index 15712ffc7..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CreateScheduledSearchRequest.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: create-scheduled-search-request -title: CreateScheduledSearchRequest -pagination_label: CreateScheduledSearchRequest -sidebar_label: CreateScheduledSearchRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CreateScheduledSearchRequest'] -slug: /tools/sdk/powershell/v3/models/create-scheduled-search-request -tags: ['SDK', 'Software Development Kit', 'CreateScheduledSearchRequest'] ---- - - -# CreateScheduledSearchRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | The name of the scheduled search. | [optional] -**Description** | Pointer to **String** | The description of the scheduled search. | [optional] -**SavedSearchId** | **String** | The ID of the saved search that will be executed. | [required] -**Created** | Pointer to **System.DateTime** | The date the scheduled search was initially created. | [optional] [readonly] -**Modified** | Pointer to **System.DateTime** | The last date the scheduled search was modified. | [optional] [readonly] -**Schedule** | [**Schedule1**](schedule1) | | [required] -**Recipients** | [**[]SearchScheduleRecipientsInner**](search-schedule-recipients-inner) | A list of identities that should receive the scheduled search report via email. | [required] -**Enabled** | Pointer to **Boolean** | Indicates if the scheduled search is enabled. | [optional] [default to $false] -**EmailEmptyResults** | Pointer to **Boolean** | Indicates if email generation should occur when search returns no results. | [optional] [default to $false] -**DisplayQueryDetails** | Pointer to **Boolean** | Indicates if the generated email should include the query and search results preview (which could include PII). | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$CreateScheduledSearchRequest = Initialize-PSSailpoint.V3CreateScheduledSearchRequest -Name Daily disabled accounts ` - -Description Daily disabled accounts ` - -SavedSearchId 554f1511-f0a1-4744-ab14-599514d3e57c ` - -Created 2018-06-25T20:22:28.104Z ` - -Modified 2018-06-25T20:22:28.104Z ` - -Schedule null ` - -Recipients null ` - -Enabled false ` - -EmailEmptyResults false ` - -DisplayQueryDetails false -``` - -- Convert the resource to JSON -```powershell -$CreateScheduledSearchRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CreateUploadedConfigurationRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/CreateUploadedConfigurationRequest.md deleted file mode 100644 index b8cf2bae3..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CreateUploadedConfigurationRequest.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: create-uploaded-configuration-request -title: CreateUploadedConfigurationRequest -pagination_label: CreateUploadedConfigurationRequest -sidebar_label: CreateUploadedConfigurationRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CreateUploadedConfigurationRequest'] -slug: /tools/sdk/powershell/v3/models/create-uploaded-configuration-request -tags: ['SDK', 'Software Development Kit', 'CreateUploadedConfigurationRequest'] ---- - - -# CreateUploadedConfigurationRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**VarData** | **System.IO.FileInfo** | JSON file containing the objects to be imported. | [required] -**Name** | **String** | Name that will be assigned to the uploaded configuration file. | [required] - -## Examples - -- Prepare the resource -```powershell -$CreateUploadedConfigurationRequest = Initialize-PSSailpoint.V3CreateUploadedConfigurationRequest -VarData null ` - -Name null -``` - -- Convert the resource to JSON -```powershell -$CreateUploadedConfigurationRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CreateWorkflowRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/CreateWorkflowRequest.md deleted file mode 100644 index b0a225ba3..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CreateWorkflowRequest.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: create-workflow-request -title: CreateWorkflowRequest -pagination_label: CreateWorkflowRequest -sidebar_label: CreateWorkflowRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CreateWorkflowRequest'] -slug: /tools/sdk/powershell/v3/models/create-workflow-request -tags: ['SDK', 'Software Development Kit', 'CreateWorkflowRequest'] ---- - - -# CreateWorkflowRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | The name of the workflow | [required] -**Owner** | Pointer to [**WorkflowBodyOwner**](workflow-body-owner) | | [optional] -**Description** | Pointer to **String** | Description of what the workflow accomplishes | [optional] -**Definition** | Pointer to [**WorkflowDefinition**](workflow-definition) | | [optional] -**Enabled** | Pointer to **Boolean** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to $false] -**Trigger** | Pointer to [**WorkflowTrigger**](workflow-trigger) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$CreateWorkflowRequest = Initialize-PSSailpoint.V3CreateWorkflowRequest -Name Send Email ` - -Owner null ` - -Description Send an email to the identity who's attributes changed. ` - -Definition null ` - -Enabled false ` - -Trigger null -``` - -- Convert the resource to JSON -```powershell -$CreateWorkflowRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/CriteriaType.md b/docs/tools/sdk/powershell/reference/v3/Models/CriteriaType.md deleted file mode 100644 index 2683bcdb3..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/CriteriaType.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -id: criteria-type -title: CriteriaType -pagination_label: CriteriaType -sidebar_label: CriteriaType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CriteriaType'] -slug: /tools/sdk/powershell/v3/models/criteria-type -tags: ['SDK', 'Software Development Kit', 'CriteriaType'] ---- - - -# CriteriaType - -## Enum - - -* `COMPOSITE` (value: `"COMPOSITE"`) - -* `ROLE` (value: `"ROLE"`) - -* `IDENTITY` (value: `"IDENTITY"`) - -* `IDENTITY_ATTRIBUTE` (value: `"IDENTITY_ATTRIBUTE"`) - -* `ENTITLEMENT` (value: `"ENTITLEMENT"`) - -* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) - -* `SOURCE` (value: `"SOURCE"`) - -* `ACCOUNT` (value: `"ACCOUNT"`) - -* `AGGREGATED_ENTITLEMENT` (value: `"AGGREGATED_ENTITLEMENT"`) - -* `INVALID_CERTIFIABLE_ENTITY` (value: `"INVALID_CERTIFIABLE_ENTITY"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/DataAccess.md b/docs/tools/sdk/powershell/reference/v3/Models/DataAccess.md deleted file mode 100644 index b55bfdeec..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/DataAccess.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: data-access -title: DataAccess -pagination_label: DataAccess -sidebar_label: DataAccess -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DataAccess'] -slug: /tools/sdk/powershell/v3/models/data-access -tags: ['SDK', 'Software Development Kit', 'DataAccess'] ---- - - -# DataAccess - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Policies** | Pointer to [**[]DataAccessPoliciesInner**](data-access-policies-inner) | List of classification policies that apply to resources the entitlement \ groups has access to | [optional] -**Categories** | Pointer to [**[]DataAccessCategoriesInner**](data-access-categories-inner) | List of classification categories that apply to resources the entitlement \ groups has access to | [optional] -**ImpactScore** | Pointer to [**DataAccessImpactScore**](data-access-impact-score) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$DataAccess = Initialize-PSSailpoint.V3DataAccess -Policies null ` - -Categories null ` - -ImpactScore null -``` - -- Convert the resource to JSON -```powershell -$DataAccess | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/DataAccessCategoriesInner.md b/docs/tools/sdk/powershell/reference/v3/Models/DataAccessCategoriesInner.md deleted file mode 100644 index 4b0af2ab4..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/DataAccessCategoriesInner.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: data-access-categories-inner -title: DataAccessCategoriesInner -pagination_label: DataAccessCategoriesInner -sidebar_label: DataAccessCategoriesInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DataAccessCategoriesInner'] -slug: /tools/sdk/powershell/v3/models/data-access-categories-inner -tags: ['SDK', 'Software Development Kit', 'DataAccessCategoriesInner'] ---- - - -# DataAccessCategoriesInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Value** | Pointer to **String** | Value of the category | [optional] -**MatchCount** | Pointer to **Int32** | Number of matched for each category | [optional] - -## Examples - -- Prepare the resource -```powershell -$DataAccessCategoriesInner = Initialize-PSSailpoint.V3DataAccessCategoriesInner -Value email-7 ` - -MatchCount 10 -``` - -- Convert the resource to JSON -```powershell -$DataAccessCategoriesInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/DataAccessImpactScore.md b/docs/tools/sdk/powershell/reference/v3/Models/DataAccessImpactScore.md deleted file mode 100644 index 8948870bb..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/DataAccessImpactScore.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: data-access-impact-score -title: DataAccessImpactScore -pagination_label: DataAccessImpactScore -sidebar_label: DataAccessImpactScore -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DataAccessImpactScore'] -slug: /tools/sdk/powershell/v3/models/data-access-impact-score -tags: ['SDK', 'Software Development Kit', 'DataAccessImpactScore'] ---- - - -# DataAccessImpactScore - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Value** | Pointer to **String** | Impact Score for this data | [optional] - -## Examples - -- Prepare the resource -```powershell -$DataAccessImpactScore = Initialize-PSSailpoint.V3DataAccessImpactScore -Value Medium -``` - -- Convert the resource to JSON -```powershell -$DataAccessImpactScore | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/DataAccessPoliciesInner.md b/docs/tools/sdk/powershell/reference/v3/Models/DataAccessPoliciesInner.md deleted file mode 100644 index 5398ec4df..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/DataAccessPoliciesInner.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: data-access-policies-inner -title: DataAccessPoliciesInner -pagination_label: DataAccessPoliciesInner -sidebar_label: DataAccessPoliciesInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DataAccessPoliciesInner'] -slug: /tools/sdk/powershell/v3/models/data-access-policies-inner -tags: ['SDK', 'Software Development Kit', 'DataAccessPoliciesInner'] ---- - - -# DataAccessPoliciesInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Value** | Pointer to **String** | Value of the policy | [optional] - -## Examples - -- Prepare the resource -```powershell -$DataAccessPoliciesInner = Initialize-PSSailpoint.V3DataAccessPoliciesInner -Value GDPR-20 -``` - -- Convert the resource to JSON -```powershell -$DataAccessPoliciesInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/DateCompare.md b/docs/tools/sdk/powershell/reference/v3/Models/DateCompare.md deleted file mode 100644 index 07da502d5..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/DateCompare.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: date-compare -title: DateCompare -pagination_label: DateCompare -sidebar_label: DateCompare -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DateCompare'] -slug: /tools/sdk/powershell/v3/models/date-compare -tags: ['SDK', 'Software Development Kit', 'DateCompare'] ---- - - -# DateCompare - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**FirstDate** | [**DateCompareFirstDate**](date-compare-first-date) | | [required] -**SecondDate** | [**DateCompareSecondDate**](date-compare-second-date) | | [required] -**Operator** | **Enum** [ "LT", "LTE", "GT", "GTE" ] | This is the comparison to perform. | Operation | Description | | --------- | ------- | | LT | Strictly less than: `firstDate < secondDate` | | LTE | Less than or equal to: `firstDate <= secondDate` | | GT | Strictly greater than: `firstDate > secondDate` | | GTE | Greater than or equal to: `firstDate >= secondDate` | | [required] -**PositiveCondition** | **String** | The output of the transform if the expression evalutes to true | [required] -**NegativeCondition** | **String** | The output of the transform if the expression evalutes to false | [required] -**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 -$DateCompare = Initialize-PSSailpoint.V3DateCompare -FirstDate null ` - -SecondDate null ` - -Operator LT ` - -PositiveCondition true ` - -NegativeCondition false ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$DateCompare | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/DateCompareFirstDate.md b/docs/tools/sdk/powershell/reference/v3/Models/DateCompareFirstDate.md deleted file mode 100644 index aae37fa49..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/DateCompareFirstDate.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -id: date-compare-first-date -title: DateCompareFirstDate -pagination_label: DateCompareFirstDate -sidebar_label: DateCompareFirstDate -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DateCompareFirstDate'] -slug: /tools/sdk/powershell/v3/models/date-compare-first-date -tags: ['SDK', 'Software Development Kit', 'DateCompareFirstDate'] ---- - - -# DateCompareFirstDate - -## 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] -**InputFormat** | Pointer to [**DateFormatInputFormat**](date-format-input-format) | | [optional] -**OutputFormat** | Pointer to [**DateFormatOutputFormat**](date-format-output-format) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$DateCompareFirstDate = Initialize-PSSailpoint.V3DateCompareFirstDate -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}} ` - -InputFormat null ` - -OutputFormat null -``` - -- Convert the resource to JSON -```powershell -$DateCompareFirstDate | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/DateCompareSecondDate.md b/docs/tools/sdk/powershell/reference/v3/Models/DateCompareSecondDate.md deleted file mode 100644 index d899b3b88..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/DateCompareSecondDate.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -id: date-compare-second-date -title: DateCompareSecondDate -pagination_label: DateCompareSecondDate -sidebar_label: DateCompareSecondDate -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DateCompareSecondDate'] -slug: /tools/sdk/powershell/v3/models/date-compare-second-date -tags: ['SDK', 'Software Development Kit', 'DateCompareSecondDate'] ---- - - -# DateCompareSecondDate - -## 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] -**InputFormat** | Pointer to [**DateFormatInputFormat**](date-format-input-format) | | [optional] -**OutputFormat** | Pointer to [**DateFormatOutputFormat**](date-format-output-format) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$DateCompareSecondDate = Initialize-PSSailpoint.V3DateCompareSecondDate -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}} ` - -InputFormat null ` - -OutputFormat null -``` - -- Convert the resource to JSON -```powershell -$DateCompareSecondDate | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/DateFormat.md b/docs/tools/sdk/powershell/reference/v3/Models/DateFormat.md deleted file mode 100644 index a8a9c13bd..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/DateFormat.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: date-format -title: DateFormat -pagination_label: DateFormat -sidebar_label: DateFormat -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DateFormat'] -slug: /tools/sdk/powershell/v3/models/date-format -tags: ['SDK', 'Software Development Kit', 'DateFormat'] ---- - - -# DateFormat - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**InputFormat** | Pointer to [**DateFormatInputFormat**](date-format-input-format) | | [optional] -**OutputFormat** | Pointer to [**DateFormatOutputFormat**](date-format-output-format) | | [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 -$DateFormat = Initialize-PSSailpoint.V3DateFormat -InputFormat null ` - -OutputFormat null ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$DateFormat | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/DateFormatInputFormat.md b/docs/tools/sdk/powershell/reference/v3/Models/DateFormatInputFormat.md deleted file mode 100644 index 95dbf1d07..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/DateFormatInputFormat.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: date-format-input-format -title: DateFormatInputFormat -pagination_label: DateFormatInputFormat -sidebar_label: DateFormatInputFormat -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DateFormatInputFormat'] -slug: /tools/sdk/powershell/v3/models/date-format-input-format -tags: ['SDK', 'Software Development Kit', 'DateFormatInputFormat'] ---- - - -# DateFormatInputFormat - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -## Examples - -- Prepare the resource -```powershell -$DateFormatInputFormat = Initialize-PSSailpoint.V3DateFormatInputFormat -``` - -- Convert the resource to JSON -```powershell -$DateFormatInputFormat | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/DateFormatOutputFormat.md b/docs/tools/sdk/powershell/reference/v3/Models/DateFormatOutputFormat.md deleted file mode 100644 index ba2f05d2c..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/DateFormatOutputFormat.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: date-format-output-format -title: DateFormatOutputFormat -pagination_label: DateFormatOutputFormat -sidebar_label: DateFormatOutputFormat -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DateFormatOutputFormat'] -slug: /tools/sdk/powershell/v3/models/date-format-output-format -tags: ['SDK', 'Software Development Kit', 'DateFormatOutputFormat'] ---- - - -# DateFormatOutputFormat - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -## Examples - -- Prepare the resource -```powershell -$DateFormatOutputFormat = Initialize-PSSailpoint.V3DateFormatOutputFormat -``` - -- Convert the resource to JSON -```powershell -$DateFormatOutputFormat | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/DateMath.md b/docs/tools/sdk/powershell/reference/v3/Models/DateMath.md deleted file mode 100644 index 6aaf164fd..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/DateMath.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: date-math -title: DateMath -pagination_label: DateMath -sidebar_label: DateMath -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DateMath'] -slug: /tools/sdk/powershell/v3/models/date-math -tags: ['SDK', 'Software Development Kit', 'DateMath'] ---- - - -# DateMath - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Expression** | **String** | A string value of the date and time components to operation on, along with the math operations to execute. | [required] -**RoundUp** | Pointer to **Boolean** | A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. If not provided, the transform will default to `false` `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) | [optional] [default to $false] -**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 -$DateMath = Initialize-PSSailpoint.V3DateMath -Expression now+1w ` - -RoundUp false ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$DateMath | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/DecomposeDiacriticalMarks.md b/docs/tools/sdk/powershell/reference/v3/Models/DecomposeDiacriticalMarks.md deleted file mode 100644 index 5da36d7de..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/DecomposeDiacriticalMarks.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: decompose-diacritical-marks -title: DecomposeDiacriticalMarks -pagination_label: DecomposeDiacriticalMarks -sidebar_label: DecomposeDiacriticalMarks -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DecomposeDiacriticalMarks'] -slug: /tools/sdk/powershell/v3/models/decompose-diacritical-marks -tags: ['SDK', 'Software Development Kit', 'DecomposeDiacriticalMarks'] ---- - - -# DecomposeDiacriticalMarks - -## 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 -$DecomposeDiacriticalMarks = Initialize-PSSailpoint.V3DecomposeDiacriticalMarks -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$DecomposeDiacriticalMarks | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/DeleteNonEmployeeRecordsInBulkRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/DeleteNonEmployeeRecordsInBulkRequest.md deleted file mode 100644 index 4ed7eea81..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/DeleteNonEmployeeRecordsInBulkRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: delete-non-employee-records-in-bulk-request -title: DeleteNonEmployeeRecordsInBulkRequest -pagination_label: DeleteNonEmployeeRecordsInBulkRequest -sidebar_label: DeleteNonEmployeeRecordsInBulkRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DeleteNonEmployeeRecordsInBulkRequest'] -slug: /tools/sdk/powershell/v3/models/delete-non-employee-records-in-bulk-request -tags: ['SDK', 'Software Development Kit', 'DeleteNonEmployeeRecordsInBulkRequest'] ---- - - -# DeleteNonEmployeeRecordsInBulkRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Ids** | **[]String** | List of non-employee ids. | [required] - -## Examples - -- Prepare the resource -```powershell -$DeleteNonEmployeeRecordsInBulkRequest = Initialize-PSSailpoint.V3DeleteNonEmployeeRecordsInBulkRequest -Ids [2b838de9-db9b-abcf-e646-d4f274ad4238, 2d838de9-db9b-abcf-e646-d4f274ad4238] -``` - -- Convert the resource to JSON -```powershell -$DeleteNonEmployeeRecordsInBulkRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/DeleteSource202Response.md b/docs/tools/sdk/powershell/reference/v3/Models/DeleteSource202Response.md deleted file mode 100644 index ee740ba4a..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/DeleteSource202Response.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: delete-source202-response -title: DeleteSource202Response -pagination_label: DeleteSource202Response -sidebar_label: DeleteSource202Response -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DeleteSource202Response'] -slug: /tools/sdk/powershell/v3/models/delete-source202-response -tags: ['SDK', 'Software Development Kit', 'DeleteSource202Response'] ---- - - -# DeleteSource202Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "TASK_RESULT" ] | Type of object being referenced. | [optional] -**Id** | Pointer to **String** | Task result ID. | [optional] -**Name** | Pointer to **String** | Task result's human-readable display name (this should be null/empty). | [optional] - -## Examples - -- Prepare the resource -```powershell -$DeleteSource202Response = Initialize-PSSailpoint.V3DeleteSource202Response -Type TASK_RESULT ` - -Id 2c91808779ecf55b0179f720942f181a ` - -Name null -``` - -- Convert the resource to JSON -```powershell -$DeleteSource202Response | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/DeleteVendorConnectorMapping200Response.md b/docs/tools/sdk/powershell/reference/v3/Models/DeleteVendorConnectorMapping200Response.md deleted file mode 100644 index 76ee36fbd..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/DeleteVendorConnectorMapping200Response.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: delete-vendor-connector-mapping200-response -title: DeleteVendorConnectorMapping200Response -pagination_label: DeleteVendorConnectorMapping200Response -sidebar_label: DeleteVendorConnectorMapping200Response -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DeleteVendorConnectorMapping200Response'] -slug: /tools/sdk/powershell/v3/models/delete-vendor-connector-mapping200-response -tags: ['SDK', 'Software Development Kit', 'DeleteVendorConnectorMapping200Response'] ---- - - -# DeleteVendorConnectorMapping200Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Count** | Pointer to **Int32** | The number of vendor connector mappings successfully deleted. | [optional] - -## Examples - -- Prepare the resource -```powershell -$DeleteVendorConnectorMapping200Response = Initialize-PSSailpoint.V3DeleteVendorConnectorMapping200Response -Count 1 -``` - -- Convert the resource to JSON -```powershell -$DeleteVendorConnectorMapping200Response | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/DependantAppConnections.md b/docs/tools/sdk/powershell/reference/v3/Models/DependantAppConnections.md deleted file mode 100644 index 6d1613f41..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/DependantAppConnections.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: dependant-app-connections -title: DependantAppConnections -pagination_label: DependantAppConnections -sidebar_label: DependantAppConnections -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DependantAppConnections'] -slug: /tools/sdk/powershell/v3/models/dependant-app-connections -tags: ['SDK', 'Software Development Kit', 'DependantAppConnections'] ---- - - -# DependantAppConnections - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CloudAppId** | Pointer to **String** | Id of the connected Application | [optional] -**Description** | Pointer to **String** | Description of the connected Application | [optional] -**Enabled** | Pointer to **Boolean** | Is the Application enabled | [optional] [default to $true] -**ProvisionRequestEnabled** | Pointer to **Boolean** | Is Provisioning enabled for connected Application | [optional] [default to $true] -**AccountSource** | Pointer to [**DependantAppConnectionsAccountSource**](dependant-app-connections-account-source) | | [optional] -**LauncherCount** | Pointer to **Int64** | The amount of launchers for connected Application (long type) | [optional] -**MatchAllAccount** | Pointer to **Boolean** | Is Provisioning enabled for connected Application | [optional] [default to $false] -**Owner** | Pointer to [**[]BaseReferenceDto**](base-reference-dto) | The owner of the connected Application | [optional] -**AppCenterEnabled** | Pointer to **Boolean** | Is App Center enabled for connected Application | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$DependantAppConnections = Initialize-PSSailpoint.V3DependantAppConnections -CloudAppId 9e3cdd80edf84f119327df8bbd5bb5ac ` - -Description This is a Sailpoint application ` - -Enabled true ` - -ProvisionRequestEnabled true ` - -AccountSource null ` - -LauncherCount 100 ` - -MatchAllAccount true ` - -Owner null ` - -AppCenterEnabled false -``` - -- Convert the resource to JSON -```powershell -$DependantAppConnections | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/DependantAppConnectionsAccountSource.md b/docs/tools/sdk/powershell/reference/v3/Models/DependantAppConnectionsAccountSource.md deleted file mode 100644 index db10349ec..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/DependantAppConnectionsAccountSource.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: dependant-app-connections-account-source -title: DependantAppConnectionsAccountSource -pagination_label: DependantAppConnectionsAccountSource -sidebar_label: DependantAppConnectionsAccountSource -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DependantAppConnectionsAccountSource'] -slug: /tools/sdk/powershell/v3/models/dependant-app-connections-account-source -tags: ['SDK', 'Software Development Kit', 'DependantAppConnectionsAccountSource'] ---- - - -# DependantAppConnectionsAccountSource - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**UseForPasswordManagement** | Pointer to **Boolean** | Use this Account Source for password management | [optional] [default to $false] -**PasswordPolicies** | Pointer to [**[]DependantAppConnectionsAccountSourcePasswordPoliciesInner**](dependant-app-connections-account-source-password-policies-inner) | A list of Password Policies for this Account Source | [optional] - -## Examples - -- Prepare the resource -```powershell -$DependantAppConnectionsAccountSource = Initialize-PSSailpoint.V3DependantAppConnectionsAccountSource -UseForPasswordManagement false ` - -PasswordPolicies null -``` - -- Convert the resource to JSON -```powershell -$DependantAppConnectionsAccountSource | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/DependantAppConnectionsAccountSourcePasswordPoliciesInner.md b/docs/tools/sdk/powershell/reference/v3/Models/DependantAppConnectionsAccountSourcePasswordPoliciesInner.md deleted file mode 100644 index bb72b3ce7..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/DependantAppConnectionsAccountSourcePasswordPoliciesInner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: dependant-app-connections-account-source-password-policies-inner -title: DependantAppConnectionsAccountSourcePasswordPoliciesInner -pagination_label: DependantAppConnectionsAccountSourcePasswordPoliciesInner -sidebar_label: DependantAppConnectionsAccountSourcePasswordPoliciesInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DependantAppConnectionsAccountSourcePasswordPoliciesInner'] -slug: /tools/sdk/powershell/v3/models/dependant-app-connections-account-source-password-policies-inner -tags: ['SDK', 'Software Development Kit', 'DependantAppConnectionsAccountSourcePasswordPoliciesInner'] ---- - - -# DependantAppConnectionsAccountSourcePasswordPoliciesInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **String** | 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 -$DependantAppConnectionsAccountSourcePasswordPoliciesInner = Initialize-PSSailpoint.V3DependantAppConnectionsAccountSourcePasswordPoliciesInner -Type PASSWORD_POLICY ` - -Id 2c91808568c529c60168cca6f90c1313 ` - -Name Policy ODS -``` - -- Convert the resource to JSON -```powershell -$DependantAppConnectionsAccountSourcePasswordPoliciesInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/DependantConnectionsMissingDto.md b/docs/tools/sdk/powershell/reference/v3/Models/DependantConnectionsMissingDto.md deleted file mode 100644 index 6e4aa3b9b..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/DependantConnectionsMissingDto.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: dependant-connections-missing-dto -title: DependantConnectionsMissingDto -pagination_label: DependantConnectionsMissingDto -sidebar_label: DependantConnectionsMissingDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DependantConnectionsMissingDto'] -slug: /tools/sdk/powershell/v3/models/dependant-connections-missing-dto -tags: ['SDK', 'Software Development Kit', 'DependantConnectionsMissingDto'] ---- - - -# DependantConnectionsMissingDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DependencyType** | Pointer to **Enum** [ "identityProfiles", "credentialProfiles", "mappingProfiles", "sourceAttributes", "dependantCustomTransforms", "dependantApps" ] | The type of dependency type that is missing in the SourceConnections | [optional] -**Reason** | Pointer to **String** | The reason why this dependency is missing | [optional] - -## Examples - -- Prepare the resource -```powershell -$DependantConnectionsMissingDto = Initialize-PSSailpoint.V3DependantConnectionsMissingDto -DependencyType dependantApps ` - -Reason If there was an error retrieving any dependencies, it would lbe listed here -``` - -- Convert the resource to JSON -```powershell -$DependantConnectionsMissingDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/DimensionRef.md b/docs/tools/sdk/powershell/reference/v3/Models/DimensionRef.md deleted file mode 100644 index d747c2194..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/DimensionRef.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: dimension-ref -title: DimensionRef -pagination_label: DimensionRef -sidebar_label: DimensionRef -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DimensionRef'] -slug: /tools/sdk/powershell/v3/models/dimension-ref -tags: ['SDK', 'Software Development Kit', 'DimensionRef'] ---- - - -# DimensionRef - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "DIMENSION" ] | The type of the object to which this reference applies | [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 -$DimensionRef = Initialize-PSSailpoint.V3DimensionRef -Type DIMENSION ` - -Id 2c91808568c529c60168cca6f90c1313 ` - -Name Role 2 -``` - -- Convert the resource to JSON -```powershell -$DimensionRef | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/DisplayReference.md b/docs/tools/sdk/powershell/reference/v3/Models/DisplayReference.md deleted file mode 100644 index 09c62bd38..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/DisplayReference.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: display-reference -title: DisplayReference -pagination_label: DisplayReference -sidebar_label: DisplayReference -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DisplayReference'] -slug: /tools/sdk/powershell/v3/models/display-reference -tags: ['SDK', 'Software Development Kit', 'DisplayReference'] ---- - - -# DisplayReference - -## 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] - -## Examples - -- Prepare the resource -```powershell -$DisplayReference = Initialize-PSSailpoint.V3DisplayReference -Id 2c91808568c529c60168cca6f90c1313 ` - -Name John Doe ` - -DisplayName John Q. Doe -``` - -- Convert the resource to JSON -```powershell -$DisplayReference | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/DocumentType.md b/docs/tools/sdk/powershell/reference/v3/Models/DocumentType.md deleted file mode 100644 index fc34dd94c..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/DocumentType.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -id: document-type -title: DocumentType -pagination_label: DocumentType -sidebar_label: DocumentType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DocumentType'] -slug: /tools/sdk/powershell/v3/models/document-type -tags: ['SDK', 'Software Development Kit', 'DocumentType'] ---- - - -# DocumentType - -## Enum - - -* `accessprofile` (value: `"accessprofile"`) - -* `accountactivity` (value: `"accountactivity"`) - -* `account` (value: `"account"`) - -* `aggregation` (value: `"aggregation"`) - -* `entitlement` (value: `"entitlement"`) - -* `event` (value: `"event"`) - -* `identity` (value: `"identity"`) - -* `role` (value: `"role"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/DtoType.md b/docs/tools/sdk/powershell/reference/v3/Models/DtoType.md deleted file mode 100644 index f7e32035c..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/DtoType.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -id: dto-type -title: DtoType -pagination_label: DtoType -sidebar_label: DtoType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DtoType'] -slug: /tools/sdk/powershell/v3/models/dto-type -tags: ['SDK', 'Software Development Kit', 'DtoType'] ---- - - -# DtoType - -## Enum - - -* `ACCOUNT_CORRELATION_CONFIG` (value: `"ACCOUNT_CORRELATION_CONFIG"`) - -* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) - -* `ACCESS_REQUEST_APPROVAL` (value: `"ACCESS_REQUEST_APPROVAL"`) - -* `ACCOUNT` (value: `"ACCOUNT"`) - -* `APPLICATION` (value: `"APPLICATION"`) - -* `CAMPAIGN` (value: `"CAMPAIGN"`) - -* `CAMPAIGN_FILTER` (value: `"CAMPAIGN_FILTER"`) - -* `CERTIFICATION` (value: `"CERTIFICATION"`) - -* `CLUSTER` (value: `"CLUSTER"`) - -* `CONNECTOR_SCHEMA` (value: `"CONNECTOR_SCHEMA"`) - -* `ENTITLEMENT` (value: `"ENTITLEMENT"`) - -* `GOVERNANCE_GROUP` (value: `"GOVERNANCE_GROUP"`) - -* `IDENTITY` (value: `"IDENTITY"`) - -* `IDENTITY_PROFILE` (value: `"IDENTITY_PROFILE"`) - -* `IDENTITY_REQUEST` (value: `"IDENTITY_REQUEST"`) - -* `MACHINE_IDENTITY` (value: `"MACHINE_IDENTITY"`) - -* `LIFECYCLE_STATE` (value: `"LIFECYCLE_STATE"`) - -* `PASSWORD_POLICY` (value: `"PASSWORD_POLICY"`) - -* `ROLE` (value: `"ROLE"`) - -* `RULE` (value: `"RULE"`) - -* `SOD_POLICY` (value: `"SOD_POLICY"`) - -* `SOURCE` (value: `"SOURCE"`) - -* `TAG` (value: `"TAG"`) - -* `TAG_CATEGORY` (value: `"TAG_CATEGORY"`) - -* `TASK_RESULT` (value: `"TASK_RESULT"`) - -* `REPORT_RESULT` (value: `"REPORT_RESULT"`) - -* `SOD_VIOLATION` (value: `"SOD_VIOLATION"`) - -* `ACCOUNT_ACTIVITY` (value: `"ACCOUNT_ACTIVITY"`) - -* `WORKGROUP` (value: `"WORKGROUP"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/DuoVerificationRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/DuoVerificationRequest.md deleted file mode 100644 index 9b5630460..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/DuoVerificationRequest.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: duo-verification-request -title: DuoVerificationRequest -pagination_label: DuoVerificationRequest -sidebar_label: DuoVerificationRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DuoVerificationRequest'] -slug: /tools/sdk/powershell/v3/models/duo-verification-request -tags: ['SDK', 'Software Development Kit', 'DuoVerificationRequest'] ---- - - -# DuoVerificationRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**UserId** | **String** | User id for Verification request. | [required] -**SignedResponse** | **String** | User id for Verification request. | [required] - -## Examples - -- Prepare the resource -```powershell -$DuoVerificationRequest = Initialize-PSSailpoint.V3DuoVerificationRequest -UserId 2c9180947f0ef465017f215cbcfd004b ` - -SignedResponse AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2 -``` - -- Convert the resource to JSON -```powershell -$DuoVerificationRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/E164phone.md b/docs/tools/sdk/powershell/reference/v3/Models/E164phone.md deleted file mode 100644 index 10a1ae0b9..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/E164phone.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: e164phone -title: E164phone -pagination_label: E164phone -sidebar_label: E164phone -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'E164phone'] -slug: /tools/sdk/powershell/v3/models/e164phone -tags: ['SDK', 'Software Development Kit', 'E164phone'] ---- - - -# E164phone - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DefaultRegion** | Pointer to **String** | This is an optional attribute that can be used to define the region of the phone number to format into. If defaultRegion is not provided, it will take US as the default country. The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) | [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 -$E164phone = Initialize-PSSailpoint.V3E164phone -DefaultRegion US ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$E164phone | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/EmailNotificationOption.md b/docs/tools/sdk/powershell/reference/v3/Models/EmailNotificationOption.md deleted file mode 100644 index 178c7e86c..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/EmailNotificationOption.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: email-notification-option -title: EmailNotificationOption -pagination_label: EmailNotificationOption -sidebar_label: EmailNotificationOption -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EmailNotificationOption'] -slug: /tools/sdk/powershell/v3/models/email-notification-option -tags: ['SDK', 'Software Development Kit', 'EmailNotificationOption'] ---- - - -# EmailNotificationOption - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**NotifyManagers** | Pointer to **Boolean** | If true, then the manager is notified of the lifecycle state change. | [optional] [default to $false] -**NotifyAllAdmins** | Pointer to **Boolean** | If true, then all the admins are notified of the lifecycle state change. | [optional] [default to $false] -**NotifySpecificUsers** | Pointer to **Boolean** | If true, then the users specified in ""emailAddressList"" below are notified of lifecycle state change. | [optional] [default to $false] -**EmailAddressList** | Pointer to **[]String** | List of user email addresses. If ""notifySpecificUsers"" option is true, then these users are notified of lifecycle state change. | [optional] - -## Examples - -- Prepare the resource -```powershell -$EmailNotificationOption = Initialize-PSSailpoint.V3EmailNotificationOption -NotifyManagers true ` - -NotifyAllAdmins true ` - -NotifySpecificUsers true ` - -EmailAddressList [test@test.com, test2@test.com] -``` - -- Convert the resource to JSON -```powershell -$EmailNotificationOption | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Entitlement.md b/docs/tools/sdk/powershell/reference/v3/Models/Entitlement.md deleted file mode 100644 index b0ff2e08a..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Entitlement.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -id: entitlement -title: Entitlement -pagination_label: Entitlement -sidebar_label: Entitlement -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Entitlement'] -slug: /tools/sdk/powershell/v3/models/entitlement -tags: ['SDK', 'Software Development Kit', 'Entitlement'] ---- - - -# Entitlement - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The entitlement id | [optional] -**Name** | Pointer to **String** | The entitlement name | [optional] -**Attribute** | Pointer to **String** | The entitlement attribute name | [optional] -**Value** | Pointer to **String** | The value of the entitlement | [optional] -**SourceSchemaObjectType** | Pointer to **String** | The object type of the entitlement from the source schema | [optional] -**Description** | Pointer to **String** | The description of the entitlement | [optional] -**Privileged** | Pointer to **Boolean** | True if the entitlement is privileged | [optional] -**CloudGoverned** | Pointer to **Boolean** | True if the entitlement is cloud governed | [optional] -**Created** | Pointer to **System.DateTime** | Time when the entitlement was created | [optional] -**Modified** | Pointer to **System.DateTime** | Time when the entitlement was last modified | [optional] -**Source** | Pointer to [**EntitlementSource**](entitlement-source) | | [optional] -**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A map of free-form key-value pairs from the source system | [optional] -**Segments** | Pointer to **[]String** | List of IDs of segments, if any, to which this Entitlement is assigned. | [optional] -**DirectPermissions** | Pointer to [**[]PermissionDto**](permission-dto) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$Entitlement = Initialize-PSSailpoint.V3Entitlement -Id 2c91808874ff91550175097daaec161c ` - -Name LauncherTest2 ` - -Attribute memberOf ` - -Value CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` - -SourceSchemaObjectType group ` - -Description CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` - -Privileged true ` - -CloudGoverned true ` - -Created 2020-10-08T18:33:52.029Z ` - -Modified 2020-10-08T18:33:52.029Z ` - -Source null ` - -Attributes {fieldName=fieldValue} ` - -Segments [f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a] ` - -DirectPermissions null -``` - -- Convert the resource to JSON -```powershell -$Entitlement | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/EntitlementDocument.md b/docs/tools/sdk/powershell/reference/v3/Models/EntitlementDocument.md deleted file mode 100644 index 5f3805ed0..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/EntitlementDocument.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -id: entitlement-document -title: EntitlementDocument -pagination_label: EntitlementDocument -sidebar_label: EntitlementDocument -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementDocument'] -slug: /tools/sdk/powershell/v3/models/entitlement-document -tags: ['SDK', 'Software Development Kit', 'EntitlementDocument'] ---- - - -# EntitlementDocument - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | | [required] -**Name** | **String** | | [required] -**Type** | [**DocumentType**](document-type) | | [required] -**Modified** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] -**Synced** | Pointer to **String** | 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] -**DisplayName** | Pointer to **String** | Entitlement's display name. | [optional] -**Source** | Pointer to [**EntitlementDocumentAllOfSource**](entitlement-document-all-of-source) | | [optional] -**Segments** | Pointer to [**[]BaseSegment**](base-segment) | Segments with the role. | [optional] -**SegmentCount** | Pointer to **Int32** | Number of segments with the role. | [optional] -**Requestable** | Pointer to **Boolean** | Indicates whether the entitlement is requestable. | [optional] [default to $false] -**CloudGoverned** | Pointer to **Boolean** | Indicates whether the entitlement is cloud governed. | [optional] [default to $false] -**Created** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] -**Privileged** | Pointer to **Boolean** | Indicates whether the entitlement is privileged. | [optional] [default to $false] -**IdentityCount** | Pointer to **Int32** | Number of identities who have access to the entitlement. | [optional] -**Tags** | Pointer to **[]String** | Tags that have been applied to the object. | [optional] - -## Examples - -- Prepare the resource -```powershell -$EntitlementDocument = Initialize-PSSailpoint.V3EntitlementDocument -Id 2c91808375d8e80a0175e1f88a575222 ` - -Name john.doe ` - -Type null ` - -Modified 2018-06-25T20:22:28.104Z ` - -Synced null ` - -DisplayName Admin ` - -Source null ` - -Segments null ` - -SegmentCount 1 ` - -Requestable false ` - -CloudGoverned false ` - -Created 2018-06-25T20:22:28.104Z ` - -Privileged false ` - -IdentityCount 3 ` - -Tags [TAG_1, TAG_2] -``` - -- Convert the resource to JSON -```powershell -$EntitlementDocument | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/EntitlementDocumentAllOfSource.md b/docs/tools/sdk/powershell/reference/v3/Models/EntitlementDocumentAllOfSource.md deleted file mode 100644 index 7417b666a..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/EntitlementDocumentAllOfSource.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: entitlement-document-all-of-source -title: EntitlementDocumentAllOfSource -pagination_label: EntitlementDocumentAllOfSource -sidebar_label: EntitlementDocumentAllOfSource -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementDocumentAllOfSource'] -slug: /tools/sdk/powershell/v3/models/entitlement-document-all-of-source -tags: ['SDK', 'Software Development Kit', 'EntitlementDocumentAllOfSource'] ---- - - -# EntitlementDocumentAllOfSource - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | ID of entitlement's source. | [optional] -**Name** | Pointer to **String** | Display name of entitlement's source. | [optional] - -## Examples - -- Prepare the resource -```powershell -$EntitlementDocumentAllOfSource = Initialize-PSSailpoint.V3EntitlementDocumentAllOfSource -Id 2c91808b6e9e6fb8016eec1a2b6f7b5f ` - -Name ODS-HR-Employees -``` - -- Convert the resource to JSON -```powershell -$EntitlementDocumentAllOfSource | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/EntitlementDto.md b/docs/tools/sdk/powershell/reference/v3/Models/EntitlementDto.md deleted file mode 100644 index 5304cbc93..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/EntitlementDto.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -id: entitlement-dto -title: EntitlementDto -pagination_label: EntitlementDto -sidebar_label: EntitlementDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementDto'] -slug: /tools/sdk/powershell/v3/models/entitlement-dto -tags: ['SDK', 'Software Development Kit', 'EntitlementDto'] ---- - - -# EntitlementDto - -## 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] -**Attribute** | Pointer to **String** | Name of the entitlement attribute | [optional] -**Value** | Pointer to **String** | Raw value of the entitlement | [optional] -**Description** | Pointer to **String** | Entitlment description | [optional] -**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Entitlement attributes | [optional] -**SourceSchemaObjectType** | Pointer to **String** | Schema objectType on the given application that maps to an Account Group | [optional] -**Privileged** | Pointer to **Boolean** | Determines if this Entitlement is privileged. | [optional] -**CloudGoverned** | Pointer to **Boolean** | Determines if this Entitlement is goverened in the cloud. | [optional] -**Source** | Pointer to [**EntitlementSource**](entitlement-source) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$EntitlementDto = Initialize-PSSailpoint.V3EntitlementDto -Id id12345 ` - -Name aName ` - -Created 2015-05-28T14:07:17Z ` - -Modified 2015-05-28T14:07:17Z ` - -Attribute authorizationType ` - -Value CN=Users,dc=sailpoint,dc=com ` - -Description Active Directory DC ` - -Attributes {GroupType=Security, sAMAccountName=Buyer} ` - -SourceSchemaObjectType group ` - -Privileged false ` - -CloudGoverned false ` - -Source null -``` - -- Convert the resource to JSON -```powershell -$EntitlementDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/EntitlementRef.md b/docs/tools/sdk/powershell/reference/v3/Models/EntitlementRef.md deleted file mode 100644 index 09b938008..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/EntitlementRef.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: entitlement-ref -title: EntitlementRef -pagination_label: EntitlementRef -sidebar_label: EntitlementRef -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementRef'] -slug: /tools/sdk/powershell/v3/models/entitlement-ref -tags: ['SDK', 'Software Development Kit', 'EntitlementRef'] ---- - - -# EntitlementRef - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | Entitlement's DTO type. | [optional] -**Id** | Pointer to **String** | Entitlement's ID. | [optional] -**Name** | Pointer to **String** | Entitlement's display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$EntitlementRef = Initialize-PSSailpoint.V3EntitlementRef -Type ENTITLEMENT ` - -Id 2c91809773dee32014e13e122092014e ` - -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local -``` - -- Convert the resource to JSON -```powershell -$EntitlementRef | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/EntitlementRef1.md b/docs/tools/sdk/powershell/reference/v3/Models/EntitlementRef1.md deleted file mode 100644 index bd4b51bc7..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/EntitlementRef1.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: entitlement-ref1 -title: EntitlementRef1 -pagination_label: EntitlementRef1 -sidebar_label: EntitlementRef1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementRef1'] -slug: /tools/sdk/powershell/v3/models/entitlement-ref1 -tags: ['SDK', 'Software Development Kit', 'EntitlementRef1'] ---- - - -# EntitlementRef1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | Entitlement's DTO type. | [optional] -**Id** | Pointer to **String** | Entitlement's ID. | [optional] -**Name** | Pointer to **String** | Entitlement's display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$EntitlementRef1 = Initialize-PSSailpoint.V3EntitlementRef1 -Type ENTITLEMENT ` - -Id 2c91809773dee32014e13e122092014e ` - -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local -``` - -- Convert the resource to JSON -```powershell -$EntitlementRef1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/EntitlementRequestConfig.md b/docs/tools/sdk/powershell/reference/v3/Models/EntitlementRequestConfig.md deleted file mode 100644 index 5c2844ba9..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/EntitlementRequestConfig.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: entitlement-request-config -title: EntitlementRequestConfig -pagination_label: EntitlementRequestConfig -sidebar_label: EntitlementRequestConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementRequestConfig'] -slug: /tools/sdk/powershell/v3/models/entitlement-request-config -tags: ['SDK', 'Software Development Kit', 'EntitlementRequestConfig'] ---- - - -# EntitlementRequestConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AllowEntitlementRequest** | Pointer to **Boolean** | If this is true, entitlement requests are allowed. | [optional] [default to $false] -**RequestCommentsRequired** | Pointer to **Boolean** | If this is true, comments are required to submit entitlement requests. | [optional] [default to $false] -**DeniedCommentsRequired** | Pointer to **Boolean** | If this is true, comments are required to reject entitlement requests. | [optional] [default to $false] -**GrantRequestApprovalSchemes** | Pointer to **String** | Approval schemes for granting entitlement request. This can be empty if no approval is needed. Multiple schemes must be comma-separated. The valid schemes are ""entitlementOwner"", ""sourceOwner"", ""manager"" and ""`workgroup:{id}`"". You can use multiple governance groups (workgroups). | [optional] [default to "sourceOwner"] - -## Examples - -- Prepare the resource -```powershell -$EntitlementRequestConfig = Initialize-PSSailpoint.V3EntitlementRequestConfig -AllowEntitlementRequest true ` - -RequestCommentsRequired false ` - -DeniedCommentsRequired false ` - -GrantRequestApprovalSchemes entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584 -``` - -- Convert the resource to JSON -```powershell -$EntitlementRequestConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/EntitlementSource.md b/docs/tools/sdk/powershell/reference/v3/Models/EntitlementSource.md deleted file mode 100644 index d8bcf8af8..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/EntitlementSource.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: entitlement-source -title: EntitlementSource -pagination_label: EntitlementSource -sidebar_label: EntitlementSource -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementSource'] -slug: /tools/sdk/powershell/v3/models/entitlement-source -tags: ['SDK', 'Software Development Kit', 'EntitlementSource'] ---- - - -# EntitlementSource - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The source ID | [optional] -**Type** | Pointer to **String** | The source type, will always be ""SOURCE"" | [optional] -**Name** | Pointer to **String** | The source name | [optional] - -## Examples - -- Prepare the resource -```powershell -$EntitlementSource = Initialize-PSSailpoint.V3EntitlementSource -Id 2c9180827ca885d7017ca8ce28a000eb ` - -Type SOURCE ` - -Name ODS-AD-Source -``` - -- Convert the resource to JSON -```powershell -$EntitlementSource | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/EntitlementSummary.md b/docs/tools/sdk/powershell/reference/v3/Models/EntitlementSummary.md deleted file mode 100644 index 609d54268..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/EntitlementSummary.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: entitlement-summary -title: EntitlementSummary -pagination_label: EntitlementSummary -sidebar_label: EntitlementSummary -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementSummary'] -slug: /tools/sdk/powershell/v3/models/entitlement-summary -tags: ['SDK', 'Software Development Kit', 'EntitlementSummary'] ---- - - -# EntitlementSummary - -## 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 -$EntitlementSummary = Initialize-PSSailpoint.V3EntitlementSummary -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 -$EntitlementSummary | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ErrorMessageDto.md b/docs/tools/sdk/powershell/reference/v3/Models/ErrorMessageDto.md deleted file mode 100644 index cafb9b498..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ErrorMessageDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: error-message-dto -title: ErrorMessageDto -pagination_label: ErrorMessageDto -sidebar_label: ErrorMessageDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ErrorMessageDto'] -slug: /tools/sdk/powershell/v3/models/error-message-dto -tags: ['SDK', 'Software Development Kit', 'ErrorMessageDto'] ---- - - -# ErrorMessageDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Locale** | Pointer to **String** | The locale for the message text, a BCP 47 language tag. | [optional] -**LocaleOrigin** | Pointer to [**LocaleOrigin**](locale-origin) | | [optional] -**Text** | Pointer to **String** | Actual text of the error message in the indicated locale. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ErrorMessageDto = Initialize-PSSailpoint.V3ErrorMessageDto -Locale en-US ` - -LocaleOrigin null ` - -Text The request was syntactically correct but its content is semantically invalid. -``` - -- Convert the resource to JSON -```powershell -$ErrorMessageDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ErrorResponseDto.md b/docs/tools/sdk/powershell/reference/v3/Models/ErrorResponseDto.md deleted file mode 100644 index f08b6b31b..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ErrorResponseDto.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: error-response-dto -title: ErrorResponseDto -pagination_label: ErrorResponseDto -sidebar_label: ErrorResponseDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ErrorResponseDto'] -slug: /tools/sdk/powershell/v3/models/error-response-dto -tags: ['SDK', 'Software Development Kit', 'ErrorResponseDto'] ---- - - -# ErrorResponseDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DetailCode** | Pointer to **String** | Fine-grained error code providing more detail of the error. | [optional] -**TrackingId** | Pointer to **String** | Unique tracking id for the error. | [optional] -**Messages** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | Generic localized reason for error | [optional] -**Causes** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [optional] - -## Examples - -- Prepare the resource -```powershell -$ErrorResponseDto = Initialize-PSSailpoint.V3ErrorResponseDto -DetailCode 400.1 Bad Request Content ` - -TrackingId e7eab60924f64aa284175b9fa3309599 ` - -Messages null ` - -Causes null -``` - -- Convert the resource to JSON -```powershell -$ErrorResponseDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Event.md b/docs/tools/sdk/powershell/reference/v3/Models/Event.md deleted file mode 100644 index d749c5516..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Event.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -id: model-event -title: ModelEvent -pagination_label: ModelEvent -sidebar_label: ModelEvent -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ModelEvent'] -slug: /tools/sdk/powershell/v3/models/model-event -tags: ['SDK', 'Software Development Kit', 'ModelEvent'] ---- - - -# ModelEvent - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | | [required] -**Name** | **String** | | [required] -**Type** | [**DocumentType**](document-type) | | [required] -**Created** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] -**Synced** | Pointer to **String** | 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] -**Action** | Pointer to **String** | Name of the event as it's displayed in audit reports. | [optional] -**Type** | Pointer to **String** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional] -**Actor** | Pointer to **String** | Name of the actor that generated the event. | [optional] -**Target** | Pointer to **String** | Name of the target, or recipient, of the event. | [optional] -**Stack** | Pointer to **String** | The event's stack. | [optional] -**TrackingNumber** | Pointer to **String** | ID of the group of events. | [optional] -**IpAddress** | Pointer to **String** | Target system's IP address. | [optional] -**Details** | Pointer to **String** | ID of event's details. | [optional] -**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Attributes involved in the event. | [optional] -**Objects** | Pointer to **[]String** | Objects the event is happening to. | [optional] -**Operation** | Pointer to **String** | Operation, or action, performed during the event. | [optional] -**Status** | Pointer to **String** | Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. | [optional] -**TechnicalName** | Pointer to **String** | Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ModelEvent = Initialize-PSSailpoint.V3ModelEvent -Id 2c91808375d8e80a0175e1f88a575222 ` - -Name john.doe ` - -Type null ` - -Created 2018-06-25T20:22:28.104Z ` - -Synced null ` - -Action update ` - -Type SYSTEM_CONFIG ` - -Actor System ` - -Target Carol.Adams ` - -Stack tpe ` - -TrackingNumber 63f891e0735f4cc8bf1968144a1e7440 ` - -IpAddress 52.52.97.85 ` - -Details 73b65dfbed1842548c207432a18c84b0 ` - -Attributes {pod=stg03-useast1, org=acme, sourceName=SailPoint} ` - -Objects null ` - -Operation REQUEST ` - -Status PASSED ` - -TechnicalName AUTHENTICATION_REQUEST_PASSED -``` - -- Convert the resource to JSON -```powershell -$ModelEvent | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/EventAttributes.md b/docs/tools/sdk/powershell/reference/v3/Models/EventAttributes.md deleted file mode 100644 index 358bf753b..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/EventAttributes.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: event-attributes -title: EventAttributes -pagination_label: EventAttributes -sidebar_label: EventAttributes -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EventAttributes'] -slug: /tools/sdk/powershell/v3/models/event-attributes -tags: ['SDK', 'Software Development Kit', 'EventAttributes'] ---- - - -# EventAttributes - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The unique ID of the trigger | [required] -**VarFilter** | Pointer to **String** | JSON path expression that will limit which events the trigger will fire on | [optional] -**Description** | Pointer to **String** | Description of the event trigger | [optional] -**AttributeToFilter** | Pointer to **String** | The attribute to filter on | [optional] - -## Examples - -- Prepare the resource -```powershell -$EventAttributes = Initialize-PSSailpoint.V3EventAttributes -Id idn:identity-attributes-changed ` - -VarFilter $.changes[?(@.attribute == 'manager')] ` - -Description Triggered when an identity's manager attribute changes ` - -AttributeToFilter LifecycleState -``` - -- Convert the resource to JSON -```powershell -$EventAttributes | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/EventDocument.md b/docs/tools/sdk/powershell/reference/v3/Models/EventDocument.md deleted file mode 100644 index 34339991e..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/EventDocument.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -id: event-document -title: EventDocument -pagination_label: EventDocument -sidebar_label: EventDocument -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EventDocument'] -slug: /tools/sdk/powershell/v3/models/event-document -tags: ['SDK', 'Software Development Kit', 'EventDocument'] ---- - - -# EventDocument - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | | [required] -**Name** | **String** | | [required] -**Type** | [**DocumentType**](document-type) | | [required] -**Created** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] -**Synced** | Pointer to **String** | 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] -**Action** | Pointer to **String** | Name of the event as it's displayed in audit reports. | [optional] -**Type** | Pointer to **String** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional] -**Actor** | Pointer to **String** | Name of the actor that generated the event. | [optional] -**Target** | Pointer to **String** | Name of the target, or recipient, of the event. | [optional] -**Stack** | Pointer to **String** | The event's stack. | [optional] -**TrackingNumber** | Pointer to **String** | ID of the group of events. | [optional] -**IpAddress** | Pointer to **String** | Target system's IP address. | [optional] -**Details** | Pointer to **String** | ID of event's details. | [optional] -**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Attributes involved in the event. | [optional] -**Objects** | Pointer to **[]String** | Objects the event is happening to. | [optional] -**Operation** | Pointer to **String** | Operation, or action, performed during the event. | [optional] -**Status** | Pointer to **String** | Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. | [optional] -**TechnicalName** | Pointer to **String** | Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. | [optional] - -## Examples - -- Prepare the resource -```powershell -$EventDocument = Initialize-PSSailpoint.V3EventDocument -Id 2c91808375d8e80a0175e1f88a575222 ` - -Name john.doe ` - -Type null ` - -Created 2018-06-25T20:22:28.104Z ` - -Synced null ` - -Action update ` - -Type SYSTEM_CONFIG ` - -Actor System ` - -Target Carol.Adams ` - -Stack tpe ` - -TrackingNumber 63f891e0735f4cc8bf1968144a1e7440 ` - -IpAddress 52.52.97.85 ` - -Details 73b65dfbed1842548c207432a18c84b0 ` - -Attributes {pod=stg03-useast1, org=acme, sourceName=SailPoint} ` - -Objects null ` - -Operation REQUEST ` - -Status PASSED ` - -TechnicalName AUTHENTICATION_REQUEST_PASSED -``` - -- Convert the resource to JSON -```powershell -$EventDocument | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ExceptionAccessCriteria.md b/docs/tools/sdk/powershell/reference/v3/Models/ExceptionAccessCriteria.md deleted file mode 100644 index 0f86bc549..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ExceptionAccessCriteria.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: exception-access-criteria -title: ExceptionAccessCriteria -pagination_label: ExceptionAccessCriteria -sidebar_label: ExceptionAccessCriteria -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ExceptionAccessCriteria'] -slug: /tools/sdk/powershell/v3/models/exception-access-criteria -tags: ['SDK', 'Software Development Kit', 'ExceptionAccessCriteria'] ---- - - -# ExceptionAccessCriteria - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**LeftCriteria** | Pointer to [**ExceptionCriteria**](exception-criteria) | | [optional] -**RightCriteria** | Pointer to [**ExceptionCriteria**](exception-criteria) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ExceptionAccessCriteria = Initialize-PSSailpoint.V3ExceptionAccessCriteria -LeftCriteria null ` - -RightCriteria null -``` - -- Convert the resource to JSON -```powershell -$ExceptionAccessCriteria | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ExceptionCriteria.md b/docs/tools/sdk/powershell/reference/v3/Models/ExceptionCriteria.md deleted file mode 100644 index dbb095e63..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ExceptionCriteria.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: exception-criteria -title: ExceptionCriteria -pagination_label: ExceptionCriteria -sidebar_label: ExceptionCriteria -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ExceptionCriteria'] -slug: /tools/sdk/powershell/v3/models/exception-criteria -tags: ['SDK', 'Software Development Kit', 'ExceptionCriteria'] ---- - - -# ExceptionCriteria - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CriteriaList** | Pointer to [**[]ExceptionCriteriaCriteriaListInner**](exception-criteria-criteria-list-inner) | List of exception criteria. There is a min of 1 and max of 50 items in the list. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ExceptionCriteria = Initialize-PSSailpoint.V3ExceptionCriteria -CriteriaList [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, existing=true}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, existing=false}] -``` - -- Convert the resource to JSON -```powershell -$ExceptionCriteria | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ExceptionCriteriaAccess.md b/docs/tools/sdk/powershell/reference/v3/Models/ExceptionCriteriaAccess.md deleted file mode 100644 index a4ab616e4..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ExceptionCriteriaAccess.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: exception-criteria-access -title: ExceptionCriteriaAccess -pagination_label: ExceptionCriteriaAccess -sidebar_label: ExceptionCriteriaAccess -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ExceptionCriteriaAccess'] -slug: /tools/sdk/powershell/v3/models/exception-criteria-access -tags: ['SDK', 'Software Development Kit', 'ExceptionCriteriaAccess'] ---- - - -# ExceptionCriteriaAccess - -## 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] -**Existing** | Pointer to **Boolean** | Whether the subject identity already had that access or not | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$ExceptionCriteriaAccess = Initialize-PSSailpoint.V3ExceptionCriteriaAccess -Type null ` - -Id 2c91808568c529c60168cca6f90c1313 ` - -Name CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local ` - -Existing true -``` - -- Convert the resource to JSON -```powershell -$ExceptionCriteriaAccess | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ExceptionCriteriaCriteriaListInner.md b/docs/tools/sdk/powershell/reference/v3/Models/ExceptionCriteriaCriteriaListInner.md deleted file mode 100644 index 553ded777..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ExceptionCriteriaCriteriaListInner.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: exception-criteria-criteria-list-inner -title: ExceptionCriteriaCriteriaListInner -pagination_label: ExceptionCriteriaCriteriaListInner -sidebar_label: ExceptionCriteriaCriteriaListInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ExceptionCriteriaCriteriaListInner'] -slug: /tools/sdk/powershell/v3/models/exception-criteria-criteria-list-inner -tags: ['SDK', 'Software Development Kit', 'ExceptionCriteriaCriteriaListInner'] ---- - - -# ExceptionCriteriaCriteriaListInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | The type of object that is referenced | [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] -**Existing** | Pointer to **Boolean** | Whether the subject identity already had that access or not | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$ExceptionCriteriaCriteriaListInner = Initialize-PSSailpoint.V3ExceptionCriteriaCriteriaListInner -Type ENTITLEMENT ` - -Id 2c91808568c529c60168cca6f90c1313 ` - -Name CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local ` - -Existing true -``` - -- Convert the resource to JSON -```powershell -$ExceptionCriteriaCriteriaListInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ExecutionStatus.md b/docs/tools/sdk/powershell/reference/v3/Models/ExecutionStatus.md deleted file mode 100644 index 52a1afba4..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ExecutionStatus.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: execution-status -title: ExecutionStatus -pagination_label: ExecutionStatus -sidebar_label: ExecutionStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ExecutionStatus'] -slug: /tools/sdk/powershell/v3/models/execution-status -tags: ['SDK', 'Software Development Kit', 'ExecutionStatus'] ---- - - -# ExecutionStatus - -## Enum - - -* `EXECUTING` (value: `"EXECUTING"`) - -* `VERIFYING` (value: `"VERIFYING"`) - -* `TERMINATED` (value: `"TERMINATED"`) - -* `COMPLETED` (value: `"COMPLETED"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ExpansionItem.md b/docs/tools/sdk/powershell/reference/v3/Models/ExpansionItem.md deleted file mode 100644 index 7ad151e8f..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ExpansionItem.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: expansion-item -title: ExpansionItem -pagination_label: ExpansionItem -sidebar_label: ExpansionItem -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ExpansionItem'] -slug: /tools/sdk/powershell/v3/models/expansion-item -tags: ['SDK', 'Software Development Kit', 'ExpansionItem'] ---- - - -# ExpansionItem - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccountId** | Pointer to **String** | The ID of the account | [optional] -**Cause** | Pointer to **String** | | [optional] -**Name** | Pointer to **String** | The name of the item | [optional] -**AttributeRequests** | Pointer to [**[]AttributeRequest**](attribute-request) | | [optional] -**Source** | Pointer to [**AccountSource**](account-source) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ExpansionItem = Initialize-PSSailpoint.V3ExpansionItem -AccountId 2c91808981f58ea601821c3e93482e6f ` - -Cause Role ` - -Name smartsheet-role ` - -AttributeRequests null ` - -Source null -``` - -- Convert the resource to JSON -```powershell -$ExpansionItem | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Expression.md b/docs/tools/sdk/powershell/reference/v3/Models/Expression.md deleted file mode 100644 index f719038cd..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Expression.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: expression -title: Expression -pagination_label: Expression -sidebar_label: Expression -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Expression'] -slug: /tools/sdk/powershell/v3/models/expression -tags: ['SDK', 'Software Development Kit', 'Expression'] ---- - - -# Expression - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operator** | Pointer to **Enum** [ "AND", "EQUALS" ] | Operator for the expression | [optional] -**Attribute** | Pointer to **String** | Name for the attribute | [optional] -**Value** | Pointer to [**Value**](value) | | [optional] -**Children** | Pointer to [**[]ExpressionChildrenInner**](expression-children-inner) | List of expressions | [optional] - -## Examples - -- Prepare the resource -```powershell -$Expression = Initialize-PSSailpoint.V3Expression -Operator EQUALS ` - -Attribute location ` - -Value null ` - -Children [] -``` - -- Convert the resource to JSON -```powershell -$Expression | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ExpressionChildrenInner.md b/docs/tools/sdk/powershell/reference/v3/Models/ExpressionChildrenInner.md deleted file mode 100644 index cda64a242..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ExpressionChildrenInner.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: expression-children-inner -title: ExpressionChildrenInner -pagination_label: ExpressionChildrenInner -sidebar_label: ExpressionChildrenInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ExpressionChildrenInner'] -slug: /tools/sdk/powershell/v3/models/expression-children-inner -tags: ['SDK', 'Software Development Kit', 'ExpressionChildrenInner'] ---- - - -# ExpressionChildrenInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operator** | Pointer to **Enum** [ "AND", "EQUALS" ] | Operator for the expression | [optional] -**Attribute** | Pointer to **String** | Name for the attribute | [optional] -**Value** | Pointer to [**Value**](value) | | [optional] -**Children** | Pointer to **String** | There cannot be anymore nested children. This will always be null. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ExpressionChildrenInner = Initialize-PSSailpoint.V3ExpressionChildrenInner -Operator EQUALS ` - -Attribute location ` - -Value null ` - -Children null -``` - -- Convert the resource to JSON -```powershell -$ExpressionChildrenInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ExternalAttributes.md b/docs/tools/sdk/powershell/reference/v3/Models/ExternalAttributes.md deleted file mode 100644 index fb3855505..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ExternalAttributes.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: external-attributes -title: ExternalAttributes -pagination_label: ExternalAttributes -sidebar_label: ExternalAttributes -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ExternalAttributes'] -slug: /tools/sdk/powershell/v3/models/external-attributes -tags: ['SDK', 'Software Development Kit', 'ExternalAttributes'] ---- - - -# ExternalAttributes - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | A unique name for the external trigger | [optional] -**Description** | Pointer to **String** | Additonal context about the external trigger | [optional] -**ClientId** | Pointer to **String** | OAuth Client ID to authenticate with this trigger | [optional] -**Url** | Pointer to **String** | URL to invoke this workflow | [optional] - -## Examples - -- Prepare the resource -```powershell -$ExternalAttributes = Initialize-PSSailpoint.V3ExternalAttributes -Name search-and-notify ` - -Description Run a search and notify the results ` - -ClientId 87e239b2-b85b-4bde-b9a7-55bf304ddcdc ` - -Url https://tenant.api.identitynow.com/beta/workflows/execute/external/c79e0079-562c-4df5-aa73-60a9e25c916d -``` - -- Convert the resource to JSON -```powershell -$ExternalAttributes | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/FederationProtocolDetails.md b/docs/tools/sdk/powershell/reference/v3/Models/FederationProtocolDetails.md deleted file mode 100644 index d8214483c..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/FederationProtocolDetails.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: federation-protocol-details -title: FederationProtocolDetails -pagination_label: FederationProtocolDetails -sidebar_label: FederationProtocolDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FederationProtocolDetails'] -slug: /tools/sdk/powershell/v3/models/federation-protocol-details -tags: ['SDK', 'Software Development Kit', 'FederationProtocolDetails'] ---- - - -# FederationProtocolDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Role** | Pointer to **Enum** [ "SAML_IDP", "SAML_SP" ] | Federation protocol role | [optional] -**EntityId** | Pointer to **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] - -## Examples - -- Prepare the resource -```powershell -$FederationProtocolDetails = Initialize-PSSailpoint.V3FederationProtocolDetails -Role SAML_IDP ` - -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 -``` - -- Convert the resource to JSON -```powershell -$FederationProtocolDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/FieldDetailsDto.md b/docs/tools/sdk/powershell/reference/v3/Models/FieldDetailsDto.md deleted file mode 100644 index 1d66c30db..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/FieldDetailsDto.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: field-details-dto -title: FieldDetailsDto -pagination_label: FieldDetailsDto -sidebar_label: FieldDetailsDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FieldDetailsDto'] -slug: /tools/sdk/powershell/v3/models/field-details-dto -tags: ['SDK', 'Software Development Kit', 'FieldDetailsDto'] ---- - - -# FieldDetailsDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | The name of the attribute. | [optional] -**Transform** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The transform to apply to the field | [optional] -**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Attributes required for the transform | [optional] -**IsRequired** | Pointer to **Boolean** | Flag indicating whether or not the attribute is required. | [optional] [readonly] [default to $false] -**Type** | Pointer to **String** | The type of the attribute. | [optional] -**IsMultiValued** | Pointer to **Boolean** | Flag indicating whether or not the attribute is multi-valued. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$FieldDetailsDto = Initialize-PSSailpoint.V3FieldDetailsDto -Name userName ` - -Transform {type=rule, attributes={name=Create Unique LDAP Attribute}} ` - -Attributes {template=${firstname}.${lastname}${uniqueCounter}, cloudMaxUniqueChecks=50, cloudMaxSize=20, cloudRequired=true} ` - -IsRequired false ` - -Type string ` - -IsMultiValued false -``` - -- Convert the resource to JSON -```powershell -$FieldDetailsDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Filter.md b/docs/tools/sdk/powershell/reference/v3/Models/Filter.md deleted file mode 100644 index bdbaeb888..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Filter.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: model-filter -title: ModelFilter -pagination_label: ModelFilter -sidebar_label: ModelFilter -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ModelFilter'] -slug: /tools/sdk/powershell/v3/models/model-filter -tags: ['SDK', 'Software Development Kit', 'ModelFilter'] ---- - - -# ModelFilter - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to [**FilterType**](filter-type) | | [optional] -**Range** | Pointer to [**Range**](range) | | [optional] -**Terms** | Pointer to **[]String** | The terms to be filtered. | [optional] -**Exclude** | Pointer to **Boolean** | Indicates if the filter excludes results. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$ModelFilter = Initialize-PSSailpoint.V3ModelFilter -Type null ` - -Range null ` - -Terms null ` - -Exclude false -``` - -- Convert the resource to JSON -```powershell -$ModelFilter | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/FilterAggregation.md b/docs/tools/sdk/powershell/reference/v3/Models/FilterAggregation.md deleted file mode 100644 index ad4b7ab82..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/FilterAggregation.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: filter-aggregation -title: FilterAggregation -pagination_label: FilterAggregation -sidebar_label: FilterAggregation -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FilterAggregation'] -slug: /tools/sdk/powershell/v3/models/filter-aggregation -tags: ['SDK', 'Software Development Kit', 'FilterAggregation'] ---- - - -# FilterAggregation - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | The name of the filter aggregate to be included in the result. | [required] -**Type** | Pointer to [**SearchFilterType**](search-filter-type) | | [optional] -**Field** | **String** | The search field to apply the filter to. Prefix the field name with '@' to reference a nested object. | [required] -**Value** | **String** | The value to filter on. | [required] - -## Examples - -- Prepare the resource -```powershell -$FilterAggregation = Initialize-PSSailpoint.V3FilterAggregation -Name Entitlements ` - -Type null ` - -Field access.type ` - -Value ENTITLEMENT -``` - -- Convert the resource to JSON -```powershell -$FilterAggregation | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/FilterType.md b/docs/tools/sdk/powershell/reference/v3/Models/FilterType.md deleted file mode 100644 index d786d2886..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/FilterType.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: filter-type -title: FilterType -pagination_label: FilterType -sidebar_label: FilterType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FilterType'] -slug: /tools/sdk/powershell/v3/models/filter-type -tags: ['SDK', 'Software Development Kit', 'FilterType'] ---- - - -# FilterType - -## Enum - - -* `EXISTS` (value: `"EXISTS"`) - -* `RANGE` (value: `"RANGE"`) - -* `TERMS` (value: `"TERMS"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/FirstValid.md b/docs/tools/sdk/powershell/reference/v3/Models/FirstValid.md deleted file mode 100644 index 4d4a697d2..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/FirstValid.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: first-valid -title: FirstValid -pagination_label: FirstValid -sidebar_label: FirstValid -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FirstValid'] -slug: /tools/sdk/powershell/v3/models/first-valid -tags: ['SDK', 'Software Development Kit', 'FirstValid'] ---- - - -# FirstValid - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Values** | [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | An array of attributes to evaluate for existence. | [required] -**IgnoreErrors** | Pointer to **Boolean** | a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. | [optional] [default to $false] -**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] - -## Examples - -- Prepare the resource -```powershell -$FirstValid = Initialize-PSSailpoint.V3FirstValid -Values [{attributes={sourceName=Active Directory, attributeName=sAMAccountName}, type=accountAttribute}, {attributes={sourceName=Okta, attributeName=login}, type=accountAttribute}, {attributes={sourceName=HR Source, attributeName=employeeID}, type=accountAttribute}] ` - -IgnoreErrors false ` - -RequiresPeriodicRefresh false -``` - -- Convert the resource to JSON -```powershell -$FirstValid | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/FormDetails.md b/docs/tools/sdk/powershell/reference/v3/Models/FormDetails.md deleted file mode 100644 index 3c8c3e774..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/FormDetails.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: form-details -title: FormDetails -pagination_label: FormDetails -sidebar_label: FormDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FormDetails'] -slug: /tools/sdk/powershell/v3/models/form-details -tags: ['SDK', 'Software Development Kit', 'FormDetails'] ---- - - -# FormDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | ID of the form | [optional] -**Name** | Pointer to **String** | Name of the form | [optional] -**Title** | Pointer to **String** | The form title | [optional] -**Subtitle** | Pointer to **String** | The form subtitle. | [optional] -**TargetUser** | Pointer to **String** | The name of the user that should be shown this form | [optional] -**Sections** | Pointer to [**[]SectionDetails**](section-details) | Sections of the form | [optional] - -## Examples - -- Prepare the resource -```powershell -$FormDetails = Initialize-PSSailpoint.V3FormDetails -Id 2c9180835d2e5168015d32f890ca1581 ` - -Name AccountSelection Form ` - -Title Account Selection for John.Doe ` - -Subtitle Please select from the following ` - -TargetUser Jane.Doe ` - -Sections null -``` - -- Convert the resource to JSON -```powershell -$FormDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/FormItemDetails.md b/docs/tools/sdk/powershell/reference/v3/Models/FormItemDetails.md deleted file mode 100644 index ecf895bf6..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/FormItemDetails.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: form-item-details -title: FormItemDetails -pagination_label: FormItemDetails -sidebar_label: FormItemDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FormItemDetails'] -slug: /tools/sdk/powershell/v3/models/form-item-details -tags: ['SDK', 'Software Development Kit', 'FormItemDetails'] ---- - - -# FormItemDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | Name of the FormItem | [optional] - -## Examples - -- Prepare the resource -```powershell -$FormItemDetails = Initialize-PSSailpoint.V3FormItemDetails -Name Field1 -``` - -- Convert the resource to JSON -```powershell -$FormItemDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ForwardApprovalDto.md b/docs/tools/sdk/powershell/reference/v3/Models/ForwardApprovalDto.md deleted file mode 100644 index 12894d01a..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ForwardApprovalDto.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: forward-approval-dto -title: ForwardApprovalDto -pagination_label: ForwardApprovalDto -sidebar_label: ForwardApprovalDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ForwardApprovalDto'] -slug: /tools/sdk/powershell/v3/models/forward-approval-dto -tags: ['SDK', 'Software Development Kit', 'ForwardApprovalDto'] ---- - - -# ForwardApprovalDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**NewOwnerId** | **String** | The Id of the new owner | [required] -**Comment** | **String** | The comment provided by the forwarder | [required] - -## Examples - -- Prepare the resource -```powershell -$ForwardApprovalDto = Initialize-PSSailpoint.V3ForwardApprovalDto -NewOwnerId 2c91808568c529c60168cca6f90c1314 ` - -Comment 2c91808568c529c60168cca6f90c1313 -``` - -- Convert the resource to JSON -```powershell -$ForwardApprovalDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/FullDiscoveredApplications.md b/docs/tools/sdk/powershell/reference/v3/Models/FullDiscoveredApplications.md deleted file mode 100644 index 243b13ae4..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/FullDiscoveredApplications.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: full-discovered-applications -title: FullDiscoveredApplications -pagination_label: FullDiscoveredApplications -sidebar_label: FullDiscoveredApplications -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FullDiscoveredApplications'] -slug: /tools/sdk/powershell/v3/models/full-discovered-applications -tags: ['SDK', 'Software Development Kit', 'FullDiscoveredApplications'] ---- - - -# FullDiscoveredApplications - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Unique identifier for the discovered application. | [optional] -**Name** | Pointer to **String** | Name of the discovered application. | [optional] -**DiscoverySource** | Pointer to **String** | Source from which the application was discovered. | [optional] -**DiscoveredVendor** | Pointer to **String** | The vendor associated with the discovered application. | [optional] -**Description** | Pointer to **String** | A brief description of the discovered application. | [optional] -**RecommendedConnectors** | Pointer to **[]String** | List of recommended connectors for the application. | [optional] -**DiscoveredAt** | Pointer to **System.DateTime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] -**CreatedAt** | Pointer to **System.DateTime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] -**Status** | Pointer to **String** | The status of an application within the discovery source. By default this field is set to ""ACTIVE"" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to ""INACTIVE"". | [optional] -**AssociatedSources** | Pointer to **[]String** | List of associated sources related to this discovered application. | [optional] - -## Examples - -- Prepare the resource -```powershell -$FullDiscoveredApplications = Initialize-PSSailpoint.V3FullDiscoveredApplications -Id null ` - -Name ExampleApp ` - -DiscoverySource csv ` - -DiscoveredVendor ExampleVendor ` - -Description An application for managing examples. ` - -RecommendedConnectors [ConnectorA, ConnectorB] ` - -DiscoveredAt 2023-01-01T12:00Z ` - -CreatedAt 2023-01-01T12:00Z ` - -Status ACTIVE ` - -AssociatedSources [e0cc5d7d-bf7f-4f81-b2af-8885b09d9923, a0303682-5e4a-44f7-bdc2-6ce6112549c1] -``` - -- Convert the resource to JSON -```powershell -$FullDiscoveredApplications | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/GenerateRandomString.md b/docs/tools/sdk/powershell/reference/v3/Models/GenerateRandomString.md deleted file mode 100644 index 6d3eea13e..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/GenerateRandomString.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: generate-random-string -title: GenerateRandomString -pagination_label: GenerateRandomString -sidebar_label: GenerateRandomString -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'GenerateRandomString'] -slug: /tools/sdk/powershell/v3/models/generate-random-string -tags: ['SDK', 'Software Development Kit', 'GenerateRandomString'] ---- - - -# GenerateRandomString - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | This must always be set to ""Cloud Services Deployment Utility"" | [required] -**Operation** | **String** | The operation to perform `generateRandomString` | [required] -**IncludeNumbers** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include numbers | [required] -**IncludeSpecialChars** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include special characters | [required] -**Length** | **String** | This specifies how long the randomly generated string needs to be >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters | [required] -**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] - -## Examples - -- Prepare the resource -```powershell -$GenerateRandomString = Initialize-PSSailpoint.V3GenerateRandomString -Name Cloud Services Deployment Utility ` - -Operation generateRandomString ` - -IncludeNumbers true ` - -IncludeSpecialChars true ` - -Length 10 ` - -RequiresPeriodicRefresh false -``` - -- Convert the resource to JSON -```powershell -$GenerateRandomString | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/GetActiveCampaigns200ResponseInner.md b/docs/tools/sdk/powershell/reference/v3/Models/GetActiveCampaigns200ResponseInner.md deleted file mode 100644 index 4c9b151b2..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/GetActiveCampaigns200ResponseInner.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -id: get-active-campaigns200-response-inner -title: GetActiveCampaigns200ResponseInner -pagination_label: GetActiveCampaigns200ResponseInner -sidebar_label: GetActiveCampaigns200ResponseInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'GetActiveCampaigns200ResponseInner'] -slug: /tools/sdk/powershell/v3/models/get-active-campaigns200-response-inner -tags: ['SDK', 'Software Development Kit', 'GetActiveCampaigns200ResponseInner'] ---- - - -# GetActiveCampaigns200ResponseInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Id of the campaign | [optional] [readonly] -**Name** | **String** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] -**Description** | **String** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] -**Deadline** | Pointer to **System.DateTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] -**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION", "MACHINE_ACCOUNT" ] | The type of campaign. Could be extended in the future. | [required] -**EmailNotificationEnabled** | Pointer to **Boolean** | Enables email notification for this campaign | [optional] [default to $false] -**AutoRevokeAllowed** | Pointer to **Boolean** | Allows auto revoke for this campaign | [optional] [default to $false] -**RecommendationsEnabled** | Pointer to **Boolean** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to $false] -**Status** | Pointer to **Enum** [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ] | The campaign's current status. | [optional] [readonly] -**CorrelatedStatus** | Pointer to **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] -**Created** | Pointer to **System.DateTime** | Created time of the campaign | [optional] [readonly] -**TotalCertifications** | Pointer to **Int32** | The total number of certifications in this campaign. | [optional] [readonly] -**CompletedCertifications** | Pointer to **Int32** | The number of completed certifications in this campaign. | [optional] [readonly] -**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] -**Modified** | Pointer to **System.DateTime** | Modified time of the campaign | [optional] [readonly] -**VarFilter** | Pointer to [**CampaignAllOfFilter**](campaign-all-of-filter) | | [optional] -**SunsetCommentsRequired** | Pointer to **Boolean** | Determines if comments on sunset date changes are required. | [optional] [default to $true] -**SourceOwnerCampaignInfo** | Pointer to [**CampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] -**SearchCampaignInfo** | Pointer to [**CampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] -**RoleCompositionCampaignInfo** | Pointer to [**CampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] -**MachineAccountCampaignInfo** | Pointer to [**CampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] -**SourcesWithOrphanEntitlements** | Pointer to [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \""orphan entitlements\"" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] -**MandatoryCommentRequirement** | Pointer to **Enum** [ "ALL_DECISIONS", "REVOKE_ONLY_DECISIONS", "NO_DECISIONS" ] | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] - -## Examples - -- Prepare the resource -```powershell -$GetActiveCampaigns200ResponseInner = Initialize-PSSailpoint.V3GetActiveCampaigns200ResponseInner -Id 2c9079b270a266a60170a2779fcb0007 ` - -Name Manager Campaign ` - -Description Everyone needs to be reviewed by their manager ` - -Deadline 2020-03-15T10:00:01.456Z ` - -Type MANAGER ` - -EmailNotificationEnabled false ` - -AutoRevokeAllowed false ` - -RecommendationsEnabled true ` - -Status ACTIVE ` - -CorrelatedStatus CORRELATED ` - -Created 2020-03-03T22:15:13.611Z ` - -TotalCertifications 100 ` - -CompletedCertifications 10 ` - -Alerts null ` - -Modified 2020-03-03T22:20:12.674Z ` - -VarFilter null ` - -SunsetCommentsRequired true ` - -SourceOwnerCampaignInfo null ` - -SearchCampaignInfo null ` - -RoleCompositionCampaignInfo null ` - -MachineAccountCampaignInfo null ` - -SourcesWithOrphanEntitlements null ` - -MandatoryCommentRequirement NO_DECISIONS -``` - -- Convert the resource to JSON -```powershell -$GetActiveCampaigns200ResponseInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/GetDiscoveredApplications200ResponseInner.md b/docs/tools/sdk/powershell/reference/v3/Models/GetDiscoveredApplications200ResponseInner.md deleted file mode 100644 index 37b8b7907..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/GetDiscoveredApplications200ResponseInner.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: get-discovered-applications200-response-inner -title: GetDiscoveredApplications200ResponseInner -pagination_label: GetDiscoveredApplications200ResponseInner -sidebar_label: GetDiscoveredApplications200ResponseInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'GetDiscoveredApplications200ResponseInner'] -slug: /tools/sdk/powershell/v3/models/get-discovered-applications200-response-inner -tags: ['SDK', 'Software Development Kit', 'GetDiscoveredApplications200ResponseInner'] ---- - - -# GetDiscoveredApplications200ResponseInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Unique identifier for the discovered application. | [optional] -**Name** | Pointer to **String** | Name of the discovered application. | [optional] -**DiscoverySource** | Pointer to **String** | Source from which the application was discovered. | [optional] -**DiscoveredVendor** | Pointer to **String** | The vendor associated with the discovered application. | [optional] -**Description** | Pointer to **String** | A brief description of the discovered application. | [optional] -**RecommendedConnectors** | Pointer to **[]String** | List of recommended connectors for the application. | [optional] -**DiscoveredAt** | Pointer to **System.DateTime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] -**CreatedAt** | Pointer to **System.DateTime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] -**Status** | Pointer to **String** | The status of an application within the discovery source. By default this field is set to ""ACTIVE"" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to ""INACTIVE"". | [optional] -**AssociatedSources** | Pointer to **[]String** | List of associated sources related to this discovered application. | [optional] - -## Examples - -- Prepare the resource -```powershell -$GetDiscoveredApplications200ResponseInner = Initialize-PSSailpoint.V3GetDiscoveredApplications200ResponseInner -Id null ` - -Name ExampleApp ` - -DiscoverySource csv ` - -DiscoveredVendor ExampleVendor ` - -Description An application for managing examples. ` - -RecommendedConnectors [ConnectorA, ConnectorB] ` - -DiscoveredAt 2023-01-01T12:00Z ` - -CreatedAt 2023-01-01T12:00Z ` - -Status ACTIVE ` - -AssociatedSources [e0cc5d7d-bf7f-4f81-b2af-8885b09d9923, a0303682-5e4a-44f7-bdc2-6ce6112549c1] -``` - -- Convert the resource to JSON -```powershell -$GetDiscoveredApplications200ResponseInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/GetOAuthClientResponse.md b/docs/tools/sdk/powershell/reference/v3/Models/GetOAuthClientResponse.md deleted file mode 100644 index cd8d9a2d2..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/GetOAuthClientResponse.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -id: get-o-auth-client-response -title: GetOAuthClientResponse -pagination_label: GetOAuthClientResponse -sidebar_label: GetOAuthClientResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'GetOAuthClientResponse'] -slug: /tools/sdk/powershell/v3/models/get-o-auth-client-response -tags: ['SDK', 'Software Development Kit', 'GetOAuthClientResponse'] ---- - - -# GetOAuthClientResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | ID of the OAuth client | [required] -**BusinessName** | **String** | The name of the business the API Client should belong to | [required] -**HomepageUrl** | **String** | The homepage URL associated with the owner of the API Client | [required] -**Name** | **String** | A human-readable name for the API Client | [required] -**Description** | **String** | A description of the API Client | [required] -**AccessTokenValiditySeconds** | **Int32** | The number of seconds an access token generated for this API Client is valid for | [required] -**RefreshTokenValiditySeconds** | **Int32** | The number of seconds a refresh token generated for this API Client is valid for | [required] -**RedirectUris** | **[]String** | A list of the approved redirect URIs used with the authorization_code flow | [required] -**GrantTypes** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | [required] -**AccessType** | [**AccessType**](access-type) | | [required] -**Type** | [**ClientType**](client-type) | | [required] -**Internal** | **Boolean** | An indicator of whether the API Client can be used for requests internal to IDN | [required] -**Enabled** | **Boolean** | An indicator of whether the API Client is enabled for use | [required] -**StrongAuthSupported** | **Boolean** | An indicator of whether the API Client supports strong authentication | [required] -**ClaimsSupported** | **Boolean** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [required] -**Created** | **System.DateTime** | The date and time, down to the millisecond, when the API Client was created | [required] -**Modified** | **System.DateTime** | The date and time, down to the millisecond, when the API Client was last updated | [required] -**Secret** | Pointer to **String** | | [optional] -**Metadata** | Pointer to **String** | | [optional] -**LastUsed** | Pointer to **System.DateTime** | The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed. | [optional] -**Scope** | **[]String** | Scopes of the API Client. | [required] - -## Examples - -- Prepare the resource -```powershell -$GetOAuthClientResponse = Initialize-PSSailpoint.V3GetOAuthClientResponse -Id 2c9180835d2e5168015d32f890ca1581 ` - -BusinessName Acme-Solar ` - -HomepageUrl http://localhost:12345 ` - -Name Demo API Client ` - -Description An API client used for the authorization_code, refresh_token, and client_credentials flows ` - -AccessTokenValiditySeconds 750 ` - -RefreshTokenValiditySeconds 86400 ` - -RedirectUris [http://localhost:12345] ` - -GrantTypes [AUTHORIZATION_CODE, CLIENT_CREDENTIALS, REFRESH_TOKEN] ` - -AccessType null ` - -Type null ` - -Internal false ` - -Enabled true ` - -StrongAuthSupported false ` - -ClaimsSupported false ` - -Created 2017-07-11T18:45:37.098Z ` - -Modified 2018-06-25T20:22:28.104Z ` - -Secret null ` - -Metadata null ` - -LastUsed 2017-07-11T18:45:37.098Z ` - -Scope [demo:api-client-scope:first, demo:api-client-scope:second] -``` - -- Convert the resource to JSON -```powershell -$GetOAuthClientResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/GetPersonalAccessTokenResponse.md b/docs/tools/sdk/powershell/reference/v3/Models/GetPersonalAccessTokenResponse.md deleted file mode 100644 index ac7da59f1..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/GetPersonalAccessTokenResponse.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: get-personal-access-token-response -title: GetPersonalAccessTokenResponse -pagination_label: GetPersonalAccessTokenResponse -sidebar_label: GetPersonalAccessTokenResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'GetPersonalAccessTokenResponse'] -slug: /tools/sdk/powershell/v3/models/get-personal-access-token-response -tags: ['SDK', 'Software Development Kit', 'GetPersonalAccessTokenResponse'] ---- - - -# GetPersonalAccessTokenResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The ID of the personal access token (to be used as the username for Basic Auth). | [required] -**Name** | **String** | The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. | [required] -**Scope** | **[]String** | Scopes of the personal access token. | [required] -**Owner** | [**PatOwner**](pat-owner) | | [required] -**Created** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was created. | [required] -**LastUsed** | Pointer to **System.DateTime** | The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. | [optional] -**Managed** | Pointer to **Boolean** | If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$GetPersonalAccessTokenResponse = Initialize-PSSailpoint.V3GetPersonalAccessTokenResponse -Id 86f1dc6fe8f54414950454cbb11278fa ` - -Name NodeJS Integration ` - -Scope [demo:personal-access-token-scope:first, demo:personal-access-token-scope:second] ` - -Owner null ` - -Created 2017-07-11T18:45:37.098Z ` - -LastUsed 2017-07-11T18:45:37.098Z ` - -Managed false -``` - -- Convert the resource to JSON -```powershell -$GetPersonalAccessTokenResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/GetReferenceIdentityAttribute.md b/docs/tools/sdk/powershell/reference/v3/Models/GetReferenceIdentityAttribute.md deleted file mode 100644 index baecb0560..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/GetReferenceIdentityAttribute.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: get-reference-identity-attribute -title: GetReferenceIdentityAttribute -pagination_label: GetReferenceIdentityAttribute -sidebar_label: GetReferenceIdentityAttribute -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'GetReferenceIdentityAttribute'] -slug: /tools/sdk/powershell/v3/models/get-reference-identity-attribute -tags: ['SDK', 'Software Development Kit', 'GetReferenceIdentityAttribute'] ---- - - -# GetReferenceIdentityAttribute - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | This must always be set to ""Cloud Services Deployment Utility"" | [required] -**Operation** | **String** | The operation to perform `getReferenceIdentityAttribute` | [required] -**Uid** | **String** | This is the SailPoint User Name (uid) value of the identity whose attribute is desired As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. | [required] -**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] - -## Examples - -- Prepare the resource -```powershell -$GetReferenceIdentityAttribute = Initialize-PSSailpoint.V3GetReferenceIdentityAttribute -Name Cloud Services Deployment Utility ` - -Operation getReferenceIdentityAttribute ` - -Uid 2c91808570313110017040b06f344ec9 ` - -RequiresPeriodicRefresh false -``` - -- Convert the resource to JSON -```powershell -$GetReferenceIdentityAttribute | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/GetVendorConnectorMappings405Response.md b/docs/tools/sdk/powershell/reference/v3/Models/GetVendorConnectorMappings405Response.md deleted file mode 100644 index fd7510af8..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/GetVendorConnectorMappings405Response.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: get-vendor-connector-mappings405-response -title: GetVendorConnectorMappings405Response -pagination_label: GetVendorConnectorMappings405Response -sidebar_label: GetVendorConnectorMappings405Response -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'GetVendorConnectorMappings405Response'] -slug: /tools/sdk/powershell/v3/models/get-vendor-connector-mappings405-response -tags: ['SDK', 'Software Development Kit', 'GetVendorConnectorMappings405Response'] ---- - - -# GetVendorConnectorMappings405Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ErrorName** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A message describing the error | [optional] -**ErrorMessage** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Description of the error | [optional] -**TrackingId** | Pointer to **String** | Unique tracking id for the error. | [optional] - -## Examples - -- Prepare the resource -```powershell -$GetVendorConnectorMappings405Response = Initialize-PSSailpoint.V3GetVendorConnectorMappings405Response -ErrorName NotSupportedException ` - -ErrorMessage Cannot consume content type ` - -TrackingId e7eab60924f64aa284175b9fa3309599 -``` - -- Convert the resource to JSON -```powershell -$GetVendorConnectorMappings405Response | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/GrantType.md b/docs/tools/sdk/powershell/reference/v3/Models/GrantType.md deleted file mode 100644 index fa43cbfea..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/GrantType.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: grant-type -title: GrantType -pagination_label: GrantType -sidebar_label: GrantType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'GrantType'] -slug: /tools/sdk/powershell/v3/models/grant-type -tags: ['SDK', 'Software Development Kit', 'GrantType'] ---- - - -# GrantType - -## Enum - - -* `CLIENT_CREDENTIALS` (value: `"CLIENT_CREDENTIALS"`) - -* `AUTHORIZATION_CODE` (value: `"AUTHORIZATION_CODE"`) - -* `REFRESH_TOKEN` (value: `"REFRESH_TOKEN"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ISO3166.md b/docs/tools/sdk/powershell/reference/v3/Models/ISO3166.md deleted file mode 100644 index cd2b8c583..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ISO3166.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: iso3166 -title: ISO3166 -pagination_label: ISO3166 -sidebar_label: ISO3166 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ISO3166'] -slug: /tools/sdk/powershell/v3/models/iso3166 -tags: ['SDK', 'Software Development Kit', 'ISO3166'] ---- - - -# ISO3166 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Format** | Pointer to **String** | An optional value to denote which ISO 3166 format to return. Valid values are: `alpha2` - Two-character country code (e.g., ""US""); this is the default value if no format is supplied `alpha3` - Three-character country code (e.g., ""USA"") `numeric` - The numeric country code (e.g., ""840"") | [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 -$ISO3166 = Initialize-PSSailpoint.V3ISO3166 -Format alpha2 ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$ISO3166 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentitiesDetailsReportArguments.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentitiesDetailsReportArguments.md deleted file mode 100644 index ef8b8e52d..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentitiesDetailsReportArguments.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: identities-details-report-arguments -title: IdentitiesDetailsReportArguments -pagination_label: IdentitiesDetailsReportArguments -sidebar_label: IdentitiesDetailsReportArguments -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentitiesDetailsReportArguments'] -slug: /tools/sdk/powershell/v3/models/identities-details-report-arguments -tags: ['SDK', 'Software Development Kit', 'IdentitiesDetailsReportArguments'] ---- - - -# IdentitiesDetailsReportArguments - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CorrelatedOnly** | **Boolean** | Flag to specify if only correlated identities are included in report. | [required][default to $false] - -## Examples - -- Prepare the resource -```powershell -$IdentitiesDetailsReportArguments = Initialize-PSSailpoint.V3IdentitiesDetailsReportArguments -CorrelatedOnly true -``` - -- Convert the resource to JSON -```powershell -$IdentitiesDetailsReportArguments | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentitiesReportArguments.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentitiesReportArguments.md deleted file mode 100644 index 8a6944333..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentitiesReportArguments.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: identities-report-arguments -title: IdentitiesReportArguments -pagination_label: IdentitiesReportArguments -sidebar_label: IdentitiesReportArguments -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentitiesReportArguments'] -slug: /tools/sdk/powershell/v3/models/identities-report-arguments -tags: ['SDK', 'Software Development Kit', 'IdentitiesReportArguments'] ---- - - -# IdentitiesReportArguments - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CorrelatedOnly** | Pointer to **Boolean** | Flag to specify if only correlated identities are included in report. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$IdentitiesReportArguments = Initialize-PSSailpoint.V3IdentitiesReportArguments -CorrelatedOnly true -``` - -- Convert the resource to JSON -```powershell -$IdentitiesReportArguments | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentityAccess.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentityAccess.md deleted file mode 100644 index 032175665..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentityAccess.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -id: identity-access -title: IdentityAccess -pagination_label: IdentityAccess -sidebar_label: IdentityAccess -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAccess'] -slug: /tools/sdk/powershell/v3/models/identity-access -tags: ['SDK', 'Software Development Kit', 'IdentityAccess'] ---- - - -# IdentityAccess - -## 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] -**Privileged** | Pointer to **Boolean** | | [optional] -**Attribute** | Pointer to **String** | | [optional] -**Value** | Pointer to **String** | | [optional] -**Standalone** | Pointer to **Boolean** | | [optional] -**Disabled** | Pointer to **Boolean** | | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityAccess = Initialize-PSSailpoint.V3IdentityAccess -Id 2c91808568c529c60168cca6f90c1313 ` - -Name John Doe ` - -DisplayName John Q. Doe ` - -Type null ` - -Description null ` - -Source null ` - -Owner null ` - -Revocable null ` - -Privileged false ` - -Attribute memberOf ` - -Value CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com ` - -Standalone false ` - -Disabled null -``` - -- Convert the resource to JSON -```powershell -$IdentityAccess | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentityAttribute.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentityAttribute.md deleted file mode 100644 index 1bc32befd..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentityAttribute.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: identity-attribute -title: IdentityAttribute -pagination_label: IdentityAttribute -sidebar_label: IdentityAttribute -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttribute'] -slug: /tools/sdk/powershell/v3/models/identity-attribute -tags: ['SDK', 'Software Development Kit', 'IdentityAttribute'] ---- - - -# IdentityAttribute - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | The system (camel-cased) name of the identity attribute to bring in | [required] -**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 -$IdentityAttribute = Initialize-PSSailpoint.V3IdentityAttribute -Name email ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$IdentityAttribute | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentityAttributeConfig.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentityAttributeConfig.md deleted file mode 100644 index 7a9255a2e..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentityAttributeConfig.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: identity-attribute-config -title: IdentityAttributeConfig -pagination_label: IdentityAttributeConfig -sidebar_label: IdentityAttributeConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributeConfig'] -slug: /tools/sdk/powershell/v3/models/identity-attribute-config -tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig'] ---- - - -# IdentityAttributeConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Enabled** | Pointer to **Boolean** | The backend will only promote values if the profile/mapping is enabled. | [optional] [default to $false] -**AttributeTransforms** | Pointer to [**[]IdentityAttributeTransform**](identity-attribute-transform) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityAttributeConfig = Initialize-PSSailpoint.V3IdentityAttributeConfig -Enabled true ` - -AttributeTransforms null -``` - -- Convert the resource to JSON -```powershell -$IdentityAttributeConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentityAttributePreview.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentityAttributePreview.md deleted file mode 100644 index aa3d01807..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentityAttributePreview.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: identity-attribute-preview -title: IdentityAttributePreview -pagination_label: IdentityAttributePreview -sidebar_label: IdentityAttributePreview -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributePreview'] -slug: /tools/sdk/powershell/v3/models/identity-attribute-preview -tags: ['SDK', 'Software Development Kit', 'IdentityAttributePreview'] ---- - - -# IdentityAttributePreview - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | Name of the attribute that is being previewed. | [optional] -**Value** | Pointer to **String** | Value that was derived during the preview. | [optional] -**PreviousValue** | Pointer to **String** | The value of the attribute before the preview. | [optional] -**ErrorMessages** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityAttributePreview = Initialize-PSSailpoint.V3IdentityAttributePreview -Name email ` - -Value email@mail.com ` - -PreviousValue oldEmail@mail.com ` - -ErrorMessages null -``` - -- Convert the resource to JSON -```powershell -$IdentityAttributePreview | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentityAttributeTransform.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentityAttributeTransform.md deleted file mode 100644 index e99c31001..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentityAttributeTransform.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: identity-attribute-transform -title: IdentityAttributeTransform -pagination_label: IdentityAttributeTransform -sidebar_label: IdentityAttributeTransform -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributeTransform'] -slug: /tools/sdk/powershell/v3/models/identity-attribute-transform -tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform'] ---- - - -# IdentityAttributeTransform - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IdentityAttributeName** | Pointer to **String** | Name of the identity attribute. | [optional] -**TransformDefinition** | Pointer to [**TransformDefinition**](transform-definition) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityAttributeTransform = Initialize-PSSailpoint.V3IdentityAttributeTransform -IdentityAttributeName email ` - -TransformDefinition null -``` - -- Convert the resource to JSON -```powershell -$IdentityAttributeTransform | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentityCertDecisionSummary.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentityCertDecisionSummary.md deleted file mode 100644 index 61e3b7f1c..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentityCertDecisionSummary.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -id: identity-cert-decision-summary -title: IdentityCertDecisionSummary -pagination_label: IdentityCertDecisionSummary -sidebar_label: IdentityCertDecisionSummary -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityCertDecisionSummary'] -slug: /tools/sdk/powershell/v3/models/identity-cert-decision-summary -tags: ['SDK', 'Software Development Kit', 'IdentityCertDecisionSummary'] ---- - - -# IdentityCertDecisionSummary - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**EntitlementDecisionsMade** | Pointer to **Int32** | Number of entitlement decisions that have been made | [optional] -**AccessProfileDecisionsMade** | Pointer to **Int32** | Number of access profile decisions that have been made | [optional] -**RoleDecisionsMade** | Pointer to **Int32** | Number of role decisions that have been made | [optional] -**AccountDecisionsMade** | Pointer to **Int32** | Number of account decisions that have been made | [optional] -**EntitlementDecisionsTotal** | Pointer to **Int32** | The total number of entitlement decisions on the certification, both complete and incomplete | [optional] -**AccessProfileDecisionsTotal** | Pointer to **Int32** | The total number of access profile decisions on the certification, both complete and incomplete | [optional] -**RoleDecisionsTotal** | Pointer to **Int32** | The total number of role decisions on the certification, both complete and incomplete | [optional] -**AccountDecisionsTotal** | Pointer to **Int32** | The total number of account decisions on the certification, both complete and incomplete | [optional] -**EntitlementsApproved** | Pointer to **Int32** | The number of entitlement decisions that have been made which were approved | [optional] -**EntitlementsRevoked** | Pointer to **Int32** | The number of entitlement decisions that have been made which were revoked | [optional] -**AccessProfilesApproved** | Pointer to **Int32** | The number of access profile decisions that have been made which were approved | [optional] -**AccessProfilesRevoked** | Pointer to **Int32** | The number of access profile decisions that have been made which were revoked | [optional] -**RolesApproved** | Pointer to **Int32** | The number of role decisions that have been made which were approved | [optional] -**RolesRevoked** | Pointer to **Int32** | The number of role decisions that have been made which were revoked | [optional] -**AccountsApproved** | Pointer to **Int32** | The number of account decisions that have been made which were approved | [optional] -**AccountsRevoked** | Pointer to **Int32** | The number of account decisions that have been made which were revoked | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityCertDecisionSummary = Initialize-PSSailpoint.V3IdentityCertDecisionSummary -EntitlementDecisionsMade 3 ` - -AccessProfileDecisionsMade 5 ` - -RoleDecisionsMade 2 ` - -AccountDecisionsMade 4 ` - -EntitlementDecisionsTotal 6 ` - -AccessProfileDecisionsTotal 10 ` - -RoleDecisionsTotal 4 ` - -AccountDecisionsTotal 8 ` - -EntitlementsApproved 2 ` - -EntitlementsRevoked 1 ` - -AccessProfilesApproved 3 ` - -AccessProfilesRevoked 2 ` - -RolesApproved 2 ` - -RolesRevoked 0 ` - -AccountsApproved 1 ` - -AccountsRevoked 3 -``` - -- Convert the resource to JSON -```powershell -$IdentityCertDecisionSummary | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentityCertificationDto.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentityCertificationDto.md deleted file mode 100644 index 654b445c5..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentityCertificationDto.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -id: identity-certification-dto -title: IdentityCertificationDto -pagination_label: IdentityCertificationDto -sidebar_label: IdentityCertificationDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityCertificationDto'] -slug: /tools/sdk/powershell/v3/models/identity-certification-dto -tags: ['SDK', 'Software Development Kit', 'IdentityCertificationDto'] ---- - - -# IdentityCertificationDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | id of the certification | [optional] -**Name** | Pointer to **String** | name of the certification | [optional] -**Campaign** | Pointer to [**CampaignReference**](campaign-reference) | | [optional] -**Completed** | Pointer to **Boolean** | Have all decisions been made? | [optional] -**IdentitiesCompleted** | Pointer to **Int32** | The number of identities for whom all decisions have been made and are complete. | [optional] -**IdentitiesTotal** | Pointer to **Int32** | The total number of identities in the Certification, both complete and incomplete. | [optional] -**Created** | Pointer to **System.DateTime** | created date | [optional] -**Modified** | Pointer to **System.DateTime** | modified date | [optional] -**DecisionsMade** | Pointer to **Int32** | The number of approve/revoke/acknowledge decisions that have been made. | [optional] -**DecisionsTotal** | Pointer to **Int32** | The total number of approve/revoke/acknowledge decisions. | [optional] -**Due** | Pointer to **System.DateTime** | The due date of the certification. | [optional] -**Signed** | Pointer to **System.DateTime** | The date the reviewer signed off on the Certification. | [optional] -**Reviewer** | Pointer to [**Reviewer**](reviewer) | | [optional] -**Reassignment** | Pointer to [**Reassignment**](reassignment) | | [optional] -**HasErrors** | Pointer to **Boolean** | Identifies if the certification has an error | [optional] -**ErrorMessage** | Pointer to **String** | Description of the certification error | [optional] -**Phase** | Pointer to [**CertificationPhase**](certification-phase) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityCertificationDto = Initialize-PSSailpoint.V3IdentityCertificationDto -Id 2c9180835d2e5168015d32f890ca1581 ` - -Name Source Owner Access Review for Employees [source] ` - -Campaign null ` - -Completed true ` - -IdentitiesCompleted 5 ` - -IdentitiesTotal 10 ` - -Created 2018-06-25T20:22:28.104Z ` - -Modified 2018-06-25T20:22:28.104Z ` - -DecisionsMade 20 ` - -DecisionsTotal 40 ` - -Due 2018-10-19T13:49:37.385Z ` - -Signed 2018-10-19T13:49:37.385Z ` - -Reviewer null ` - -Reassignment null ` - -HasErrors false ` - -ErrorMessage The certification has an error ` - -Phase null -``` - -- Convert the resource to JSON -```powershell -$IdentityCertificationDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentityDocument.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentityDocument.md deleted file mode 100644 index ca11cfa45..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentityDocument.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -id: identity-document -title: IdentityDocument -pagination_label: IdentityDocument -sidebar_label: IdentityDocument -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityDocument'] -slug: /tools/sdk/powershell/v3/models/identity-document -tags: ['SDK', 'Software Development Kit', 'IdentityDocument'] ---- - - -# IdentityDocument - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The unique ID of the referenced object. | [required] -**Name** | **String** | The human readable name of the referenced object. | [required] -**Type** | [**DocumentType**](document-type) | | [required] -**DisplayName** | Pointer to **String** | Identity's display name. | [optional] -**FirstName** | Pointer to **String** | Identity's first name. | [optional] -**LastName** | Pointer to **String** | Identity's last name. | [optional] -**Email** | Pointer to **String** | Identity's primary email address. | [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] -**Phone** | Pointer to **String** | Identity's phone number. | [optional] -**Synced** | Pointer to **String** | 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] -**Inactive** | Pointer to **Boolean** | Indicates whether the identity is inactive. | [optional] [default to $false] -**Protected** | Pointer to **Boolean** | Indicates whether the identity is protected. | [optional] [default to $false] -**Status** | Pointer to **String** | Identity's status in SailPoint. | [optional] -**EmployeeNumber** | Pointer to **String** | Identity's employee number. | [optional] -**Manager** | Pointer to [**IdentityDocumentAllOfManager**](identity-document-all-of-manager) | | [optional] -**IsManager** | Pointer to **Boolean** | Indicates whether the identity is a manager of other identities. | [optional] -**IdentityProfile** | Pointer to [**IdentityDocumentAllOfIdentityProfile**](identity-document-all-of-identity-profile) | | [optional] -**Source** | Pointer to [**IdentityDocumentAllOfSource**](identity-document-all-of-source) | | [optional] -**Attributes** | 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] -**ProcessingState** | Pointer to **String** | Identity's processing state. | [optional] -**ProcessingDetails** | Pointer to [**ProcessingDetails**](processing-details) | | [optional] -**Accounts** | Pointer to [**[]BaseAccount**](base-account) | List of accounts associated with the identity. | [optional] -**AccountCount** | Pointer to **Int32** | Number of accounts associated with the identity. | [optional] -**Apps** | Pointer to [**[]App**](app) | List of applications the identity has access to. | [optional] -**AppCount** | Pointer to **Int32** | Number of applications the identity has access to. | [optional] -**Access** | Pointer to [**[]IdentityAccess**](identity-access) | List of access items assigned to the identity. | [optional] -**AccessCount** | Pointer to **Int32** | Number of access items assigned to the identity. | [optional] -**EntitlementCount** | Pointer to **Int32** | Number of entitlements assigned to the identity. | [optional] -**RoleCount** | Pointer to **Int32** | Number of roles assigned to the identity. | [optional] -**AccessProfileCount** | Pointer to **Int32** | Number of access profiles assigned to the identity. | [optional] -**Owns** | Pointer to [**[]Owns**](owns) | Access items the identity owns. | [optional] -**OwnsCount** | Pointer to **Int32** | Number of access items the identity owns. | [optional] -**Tags** | Pointer to **[]String** | Tags that have been applied to the object. | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityDocument = Initialize-PSSailpoint.V3IdentityDocument -Id 2c91808568c529c60168cca6f90c1313 ` - -Name John Doe ` - -Type null ` - -DisplayName Carol.Adams ` - -FirstName Carol ` - -LastName Adams ` - -Email Carol.Adams@sailpointdemo.com ` - -Created 2018-06-25T20:22:28.104Z ` - -Modified 2018-06-25T20:22:28.104Z ` - -Phone +1 440-527-3672 ` - -Synced null ` - -Inactive false ` - -Protected false ` - -Status UNREGISTERED ` - -EmployeeNumber 1a2a3d4e ` - -Manager null ` - -IsManager false ` - -IdentityProfile null ` - -Source null ` - -Attributes {country=US, firstname=Carol, cloudStatus=UNREGISTERED} ` - -ProcessingState null ` - -ProcessingDetails null ` - -Accounts null ` - -AccountCount 3 ` - -Apps null ` - -AppCount 2 ` - -Access null ` - -AccessCount 5 ` - -EntitlementCount 10 ` - -RoleCount 1 ` - -AccessProfileCount 1 ` - -Owns null ` - -OwnsCount 5 ` - -Tags [TAG_1, TAG_2] -``` - -- Convert the resource to JSON -```powershell -$IdentityDocument | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentityDocumentAllOfIdentityProfile.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentityDocumentAllOfIdentityProfile.md deleted file mode 100644 index 90d23f7b2..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentityDocumentAllOfIdentityProfile.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: identity-document-all-of-identity-profile -title: IdentityDocumentAllOfIdentityProfile -pagination_label: IdentityDocumentAllOfIdentityProfile -sidebar_label: IdentityDocumentAllOfIdentityProfile -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityDocumentAllOfIdentityProfile'] -slug: /tools/sdk/powershell/v3/models/identity-document-all-of-identity-profile -tags: ['SDK', 'Software Development Kit', 'IdentityDocumentAllOfIdentityProfile'] ---- - - -# IdentityDocumentAllOfIdentityProfile - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Identity profile's ID. | [optional] -**Name** | Pointer to **String** | Identity profile's name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityDocumentAllOfIdentityProfile = Initialize-PSSailpoint.V3IdentityDocumentAllOfIdentityProfile -Id 3bc8ad26b8664945866b31339d1ff7d2 ` - -Name HR Employees -``` - -- Convert the resource to JSON -```powershell -$IdentityDocumentAllOfIdentityProfile | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentityDocumentAllOfManager.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentityDocumentAllOfManager.md deleted file mode 100644 index 2eb1b2049..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentityDocumentAllOfManager.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: identity-document-all-of-manager -title: IdentityDocumentAllOfManager -pagination_label: IdentityDocumentAllOfManager -sidebar_label: IdentityDocumentAllOfManager -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityDocumentAllOfManager'] -slug: /tools/sdk/powershell/v3/models/identity-document-all-of-manager -tags: ['SDK', 'Software Development Kit', 'IdentityDocumentAllOfManager'] ---- - - -# IdentityDocumentAllOfManager - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | ID of identity's manager. | [optional] -**Name** | Pointer to **String** | Name of identity's manager. | [optional] -**DisplayName** | Pointer to **String** | Display name of identity's manager. | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityDocumentAllOfManager = Initialize-PSSailpoint.V3IdentityDocumentAllOfManager -Id 2c9180867dfe694b017e208e27c05799 ` - -Name Amanda.Ross ` - -DisplayName Amanda.Ross -``` - -- Convert the resource to JSON -```powershell -$IdentityDocumentAllOfManager | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentityDocumentAllOfSource.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentityDocumentAllOfSource.md deleted file mode 100644 index 63cd829b4..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentityDocumentAllOfSource.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: identity-document-all-of-source -title: IdentityDocumentAllOfSource -pagination_label: IdentityDocumentAllOfSource -sidebar_label: IdentityDocumentAllOfSource -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityDocumentAllOfSource'] -slug: /tools/sdk/powershell/v3/models/identity-document-all-of-source -tags: ['SDK', 'Software Development Kit', 'IdentityDocumentAllOfSource'] ---- - - -# IdentityDocumentAllOfSource - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | ID of identity's source. | [optional] -**Name** | Pointer to **String** | Display name of identity's source. | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityDocumentAllOfSource = Initialize-PSSailpoint.V3IdentityDocumentAllOfSource -Id 2c91808b6e9e6fb8016eec1a2b6f7b5f ` - -Name ODS-HR-Employees -``` - -- Convert the resource to JSON -```powershell -$IdentityDocumentAllOfSource | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentityExceptionReportReference.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentityExceptionReportReference.md deleted file mode 100644 index 23ccfa548..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentityExceptionReportReference.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: identity-exception-report-reference -title: IdentityExceptionReportReference -pagination_label: IdentityExceptionReportReference -sidebar_label: IdentityExceptionReportReference -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityExceptionReportReference'] -slug: /tools/sdk/powershell/v3/models/identity-exception-report-reference -tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference'] ---- - - -# IdentityExceptionReportReference - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**TaskResultId** | Pointer to **String** | The id of the task result. | [optional] -**ReportName** | Pointer to **String** | The name of the report. | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityExceptionReportReference = Initialize-PSSailpoint.V3IdentityExceptionReportReference -TaskResultId 2b838de9-db9b-abcf-e646-d4f274ad4238 ` - -ReportName My annual report -``` - -- Convert the resource to JSON -```powershell -$IdentityExceptionReportReference | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentityPreviewRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentityPreviewRequest.md deleted file mode 100644 index da2bb7986..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentityPreviewRequest.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: identity-preview-request -title: IdentityPreviewRequest -pagination_label: IdentityPreviewRequest -sidebar_label: IdentityPreviewRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityPreviewRequest'] -slug: /tools/sdk/powershell/v3/models/identity-preview-request -tags: ['SDK', 'Software Development Kit', 'IdentityPreviewRequest'] ---- - - -# IdentityPreviewRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IdentityId** | Pointer to **String** | The Identity id | [optional] -**IdentityAttributeConfig** | Pointer to [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityPreviewRequest = Initialize-PSSailpoint.V3IdentityPreviewRequest -IdentityId null ` - -IdentityAttributeConfig null -``` - -- Convert the resource to JSON -```powershell -$IdentityPreviewRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentityPreviewResponse.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentityPreviewResponse.md deleted file mode 100644 index bef69a705..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentityPreviewResponse.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: identity-preview-response -title: IdentityPreviewResponse -pagination_label: IdentityPreviewResponse -sidebar_label: IdentityPreviewResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityPreviewResponse'] -slug: /tools/sdk/powershell/v3/models/identity-preview-response -tags: ['SDK', 'Software Development Kit', 'IdentityPreviewResponse'] ---- - - -# IdentityPreviewResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Identity** | Pointer to [**IdentityPreviewResponseIdentity**](identity-preview-response-identity) | | [optional] -**PreviewAttributes** | Pointer to [**[]IdentityAttributePreview**](identity-attribute-preview) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityPreviewResponse = Initialize-PSSailpoint.V3IdentityPreviewResponse -Identity null ` - -PreviewAttributes null -``` - -- Convert the resource to JSON -```powershell -$IdentityPreviewResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentityPreviewResponseIdentity.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentityPreviewResponseIdentity.md deleted file mode 100644 index 7c9a98be5..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentityPreviewResponseIdentity.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: identity-preview-response-identity -title: IdentityPreviewResponseIdentity -pagination_label: IdentityPreviewResponseIdentity -sidebar_label: IdentityPreviewResponseIdentity -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityPreviewResponseIdentity'] -slug: /tools/sdk/powershell/v3/models/identity-preview-response-identity -tags: ['SDK', 'Software Development Kit', 'IdentityPreviewResponseIdentity'] ---- - - -# IdentityPreviewResponseIdentity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | Identity's DTO type. | [optional] -**Id** | Pointer to **String** | Identity ID. | [optional] -**Name** | Pointer to **String** | Identity's display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityPreviewResponseIdentity = Initialize-PSSailpoint.V3IdentityPreviewResponseIdentity -Type IDENTITY ` - -Id 2c7180a46faadee4016fb4e018c20642 ` - -Name Michael Michaels -``` - -- Convert the resource to JSON -```powershell -$IdentityPreviewResponseIdentity | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentityProfile.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentityProfile.md deleted file mode 100644 index 57771b2d1..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentityProfile.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -id: identity-profile -title: IdentityProfile -pagination_label: IdentityProfile -sidebar_label: IdentityProfile -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfile'] -slug: /tools/sdk/powershell/v3/models/identity-profile -tags: ['SDK', 'Software Development Kit', 'IdentityProfile'] ---- - - -# IdentityProfile - -## 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] -**Description** | Pointer to **String** | The description of the Identity Profile. | [optional] -**Owner** | Pointer to [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional] -**Priority** | Pointer to **Int64** | The priority for an Identity Profile. | [optional] -**AuthoritativeSource** | [**IdentityProfileAllOfAuthoritativeSource**](identity-profile-all-of-authoritative-source) | | [required] -**IdentityRefreshRequired** | Pointer to **Boolean** | True if a identity refresh is needed. Typically triggered when a change on the source has been made. | [optional] [default to $false] -**IdentityCount** | Pointer to **Int32** | The number of identities that belong to the Identity Profile. | [optional] -**IdentityAttributeConfig** | Pointer to [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] -**IdentityExceptionReportReference** | Pointer to [**IdentityExceptionReportReference**](identity-exception-report-reference) | | [optional] -**HasTimeBasedAttr** | Pointer to **Boolean** | Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$IdentityProfile = Initialize-PSSailpoint.V3IdentityProfile -Id id12345 ` - -Name aName ` - -Created 2015-05-28T14:07:17Z ` - -Modified 2015-05-28T14:07:17Z ` - -Description My custom flat file profile ` - -Owner null ` - -Priority 10 ` - -AuthoritativeSource null ` - -IdentityRefreshRequired true ` - -IdentityCount 8 ` - -IdentityAttributeConfig null ` - -IdentityExceptionReportReference null ` - -HasTimeBasedAttr true -``` - -- Convert the resource to JSON -```powershell -$IdentityProfile | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentityProfileAllOfAuthoritativeSource.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentityProfileAllOfAuthoritativeSource.md deleted file mode 100644 index d77e18952..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentityProfileAllOfAuthoritativeSource.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: identity-profile-all-of-authoritative-source -title: IdentityProfileAllOfAuthoritativeSource -pagination_label: IdentityProfileAllOfAuthoritativeSource -sidebar_label: IdentityProfileAllOfAuthoritativeSource -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfileAllOfAuthoritativeSource'] -slug: /tools/sdk/powershell/v3/models/identity-profile-all-of-authoritative-source -tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfAuthoritativeSource'] ---- - - -# IdentityProfileAllOfAuthoritativeSource - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "SOURCE" ] | Type of the object to which this reference applies | [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 -$IdentityProfileAllOfAuthoritativeSource = Initialize-PSSailpoint.V3IdentityProfileAllOfAuthoritativeSource -Type SOURCE ` - -Id 2c9180835d191a86015d28455b4b232a ` - -Name HR Active Directory -``` - -- Convert the resource to JSON -```powershell -$IdentityProfileAllOfAuthoritativeSource | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentityProfileAllOfOwner.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentityProfileAllOfOwner.md deleted file mode 100644 index d7a15f0f6..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentityProfileAllOfOwner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: identity-profile-all-of-owner -title: IdentityProfileAllOfOwner -pagination_label: IdentityProfileAllOfOwner -sidebar_label: IdentityProfileAllOfOwner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfileAllOfOwner'] -slug: /tools/sdk/powershell/v3/models/identity-profile-all-of-owner -tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfOwner'] ---- - - -# IdentityProfileAllOfOwner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | Type of the object to which this reference applies | [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 -$IdentityProfileAllOfOwner = Initialize-PSSailpoint.V3IdentityProfileAllOfOwner -Type IDENTITY ` - -Id 2c9180835d191a86015d28455b4b232a ` - -Name William Wilson -``` - -- Convert the resource to JSON -```powershell -$IdentityProfileAllOfOwner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentityProfileExportedObject.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentityProfileExportedObject.md deleted file mode 100644 index 4fd8af496..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentityProfileExportedObject.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: identity-profile-exported-object -title: IdentityProfileExportedObject -pagination_label: IdentityProfileExportedObject -sidebar_label: IdentityProfileExportedObject -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfileExportedObject'] -slug: /tools/sdk/powershell/v3/models/identity-profile-exported-object -tags: ['SDK', 'Software Development Kit', 'IdentityProfileExportedObject'] ---- - - -# IdentityProfileExportedObject - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | Pointer to **Int32** | Version or object from the target service. | [optional] -**Self** | Pointer to [**IdentityProfileExportedObjectSelf**](identity-profile-exported-object-self) | | [optional] -**Object** | Pointer to [**IdentityProfile**](identity-profile) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityProfileExportedObject = Initialize-PSSailpoint.V3IdentityProfileExportedObject -Version 1 ` - -Self null ` - -Object null -``` - -- Convert the resource to JSON -```powershell -$IdentityProfileExportedObject | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentityProfileExportedObjectSelf.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentityProfileExportedObjectSelf.md deleted file mode 100644 index 635f17d45..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentityProfileExportedObjectSelf.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: identity-profile-exported-object-self -title: IdentityProfileExportedObjectSelf -pagination_label: IdentityProfileExportedObjectSelf -sidebar_label: IdentityProfileExportedObjectSelf -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfileExportedObjectSelf'] -slug: /tools/sdk/powershell/v3/models/identity-profile-exported-object-self -tags: ['SDK', 'Software Development Kit', 'IdentityProfileExportedObjectSelf'] ---- - - -# IdentityProfileExportedObjectSelf - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "ACCESS_REQUEST_CONFIG", "ATTR_SYNC_SOURCE_CONFIG", "AUTH_ORG", "CAMPAIGN_FILTER", "FORM_DEFINITION", "GOVERNANCE_GROUP", "IDENTITY_OBJECT_CONFIG", "IDENTITY_PROFILE", "LIFECYCLE_STATE", "NOTIFICATION_TEMPLATE", "PASSWORD_POLICY", "PASSWORD_SYNC_GROUP", "PUBLIC_IDENTITIES_CONFIG", "ROLE", "RULE", "SEGMENT", "SERVICE_DESK_INTEGRATION", "SOD_POLICY", "SOURCE", "TAG", "TRANSFORM", "TRIGGER_SUBSCRIPTION", "WORKFLOW" ] | Exported object's DTO type. | [optional] -**Id** | Pointer to **String** | Exported object's ID. | [optional] -**Name** | Pointer to **String** | Exported object's display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityProfileExportedObjectSelf = Initialize-PSSailpoint.V3IdentityProfileExportedObjectSelf -Type SOURCE ` - -Id 2c9180835d191a86015d28455b4b232a ` - -Name HR Active Directory -``` - -- Convert the resource to JSON -```powershell -$IdentityProfileExportedObjectSelf | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentityProfileIdentityErrorReportArguments.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentityProfileIdentityErrorReportArguments.md deleted file mode 100644 index 19224c139..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentityProfileIdentityErrorReportArguments.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: identity-profile-identity-error-report-arguments -title: IdentityProfileIdentityErrorReportArguments -pagination_label: IdentityProfileIdentityErrorReportArguments -sidebar_label: IdentityProfileIdentityErrorReportArguments -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfileIdentityErrorReportArguments'] -slug: /tools/sdk/powershell/v3/models/identity-profile-identity-error-report-arguments -tags: ['SDK', 'Software Development Kit', 'IdentityProfileIdentityErrorReportArguments'] ---- - - -# IdentityProfileIdentityErrorReportArguments - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AuthoritativeSource** | **String** | Source ID. | [required] - -## Examples - -- Prepare the resource -```powershell -$IdentityProfileIdentityErrorReportArguments = Initialize-PSSailpoint.V3IdentityProfileIdentityErrorReportArguments -AuthoritativeSource 1234sourceId5678902 -``` - -- Convert the resource to JSON -```powershell -$IdentityProfileIdentityErrorReportArguments | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentityProfilesConnections.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentityProfilesConnections.md deleted file mode 100644 index 585173c52..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentityProfilesConnections.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: identity-profiles-connections -title: IdentityProfilesConnections -pagination_label: IdentityProfilesConnections -sidebar_label: IdentityProfilesConnections -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfilesConnections'] -slug: /tools/sdk/powershell/v3/models/identity-profiles-connections -tags: ['SDK', 'Software Development Kit', 'IdentityProfilesConnections'] ---- - - -# IdentityProfilesConnections - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | ID of the IdentityProfile this reference applies | [optional] -**Name** | Pointer to **String** | Human-readable display name of the IdentityProfile to which this reference applies | [optional] -**IdentityCount** | Pointer to **Int64** | The Number of Identities managed by this IdentityProfile | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityProfilesConnections = Initialize-PSSailpoint.V3IdentityProfilesConnections -Id 76cfddb62818416f816bc494410f46c4 ` - -Name ODS-Identity-Profile ` - -IdentityCount 100 -``` - -- Convert the resource to JSON -```powershell -$IdentityProfilesConnections | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentityReference.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentityReference.md deleted file mode 100644 index f3c0fa773..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentityReference.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: identity-reference -title: IdentityReference -pagination_label: IdentityReference -sidebar_label: IdentityReference -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityReference'] -slug: /tools/sdk/powershell/v3/models/identity-reference -tags: ['SDK', 'Software Development Kit', 'IdentityReference'] ---- - - -# IdentityReference - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to [**DtoType**](dto-type) | | [optional] -**Id** | Pointer to **String** | Identity id | [optional] -**Name** | Pointer to **String** | Human-readable display name of identity. | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityReference = Initialize-PSSailpoint.V3IdentityReference -Type null ` - -Id 2c9180a46faadee4016fb4e018c20639 ` - -Name Thomas Edison -``` - -- Convert the resource to JSON -```powershell -$IdentityReference | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentityReferenceWithNameAndEmail.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentityReferenceWithNameAndEmail.md deleted file mode 100644 index cff949489..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentityReferenceWithNameAndEmail.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: identity-reference-with-name-and-email -title: IdentityReferenceWithNameAndEmail -pagination_label: IdentityReferenceWithNameAndEmail -sidebar_label: IdentityReferenceWithNameAndEmail -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityReferenceWithNameAndEmail'] -slug: /tools/sdk/powershell/v3/models/identity-reference-with-name-and-email -tags: ['SDK', 'Software Development Kit', 'IdentityReferenceWithNameAndEmail'] ---- - - -# IdentityReferenceWithNameAndEmail - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **String** | The type can only be IDENTITY. This is read-only. | [optional] -**Id** | Pointer to **String** | Identity ID. | [optional] -**Name** | Pointer to **String** | Identity's human-readable display name. This is read-only. | [optional] -**Email** | Pointer to **String** | Identity's email address. This is read-only. | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityReferenceWithNameAndEmail = Initialize-PSSailpoint.V3IdentityReferenceWithNameAndEmail -Type IDENTITY ` - -Id 5168015d32f890ca15812c9180835d2e ` - -Name Alison Ferguso ` - -Email alison.ferguso@identitysoon.com -``` - -- Convert the resource to JSON -```powershell -$IdentityReferenceWithNameAndEmail | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentitySummary.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentitySummary.md deleted file mode 100644 index e17303d84..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentitySummary.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: identity-summary -title: IdentitySummary -pagination_label: IdentitySummary -sidebar_label: IdentitySummary -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentitySummary'] -slug: /tools/sdk/powershell/v3/models/identity-summary -tags: ['SDK', 'Software Development Kit', 'IdentitySummary'] ---- - - -# IdentitySummary - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | ID of this identity summary | [optional] -**Name** | Pointer to **String** | Human-readable display name of identity | [optional] -**IdentityId** | Pointer to **String** | ID of the identity that this summary represents | [optional] -**Completed** | Pointer to **Boolean** | Indicates if all access items for this summary have been decided on | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$IdentitySummary = Initialize-PSSailpoint.V3IdentitySummary -Id ff80818155fe8c080155fe8d925b0316 ` - -Name SailPoint Services ` - -IdentityId c15b9f5cca5a4e9599eaa0e64fa921bd ` - -Completed true -``` - -- Convert the resource to JSON -```powershell -$IdentitySummary | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentityWithNewAccess.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentityWithNewAccess.md deleted file mode 100644 index 575250056..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentityWithNewAccess.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: identity-with-new-access -title: IdentityWithNewAccess -pagination_label: IdentityWithNewAccess -sidebar_label: IdentityWithNewAccess -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityWithNewAccess'] -slug: /tools/sdk/powershell/v3/models/identity-with-new-access -tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccess'] ---- - - -# IdentityWithNewAccess - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IdentityId** | **String** | Identity id to be checked. | [required] -**AccessRefs** | [**[]IdentityWithNewAccessAccessRefsInner**](identity-with-new-access-access-refs-inner) | The list of entitlements to consider for possible violations in a preventive check. | [required] - -## Examples - -- Prepare the resource -```powershell -$IdentityWithNewAccess = Initialize-PSSailpoint.V3IdentityWithNewAccess -IdentityId 2c91808568c529c60168cca6f90c1313 ` - -AccessRefs [{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}] -``` - -- Convert the resource to JSON -```powershell -$IdentityWithNewAccess | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentityWithNewAccess1.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentityWithNewAccess1.md deleted file mode 100644 index 895c1e7e4..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentityWithNewAccess1.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: identity-with-new-access1 -title: IdentityWithNewAccess1 -pagination_label: IdentityWithNewAccess1 -sidebar_label: IdentityWithNewAccess1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityWithNewAccess1'] -slug: /tools/sdk/powershell/v3/models/identity-with-new-access1 -tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccess1'] ---- - - -# IdentityWithNewAccess1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IdentityId** | **String** | Set of identity IDs to be checked. | [required] -**AccessRefs** | [**[]EntitlementRef1**](entitlement-ref1) | The bundle of access profiles to be added to the identities specified. All references must be ENTITLEMENT type. | [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 completion of the violation check. | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityWithNewAccess1 = Initialize-PSSailpoint.V3IdentityWithNewAccess1 -IdentityId 2c91809050db617d0150e0bf3215385e ` - -AccessRefs null ` - -ClientMetadata {clientName=client1, clientId=2c91808f7892918f0178b78da4a305a1} -``` - -- Convert the resource to JSON -```powershell -$IdentityWithNewAccess1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdentityWithNewAccessAccessRefsInner.md b/docs/tools/sdk/powershell/reference/v3/Models/IdentityWithNewAccessAccessRefsInner.md deleted file mode 100644 index ab9244243..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdentityWithNewAccessAccessRefsInner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: identity-with-new-access-access-refs-inner -title: IdentityWithNewAccessAccessRefsInner -pagination_label: IdentityWithNewAccessAccessRefsInner -sidebar_label: IdentityWithNewAccessAccessRefsInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityWithNewAccessAccessRefsInner'] -slug: /tools/sdk/powershell/v3/models/identity-with-new-access-access-refs-inner -tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccessAccessRefsInner'] ---- - - -# IdentityWithNewAccessAccessRefsInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | Entitlement's DTO type. | [optional] -**Id** | Pointer to **String** | Entitlement's ID. | [optional] -**Name** | Pointer to **String** | Entitlement's display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityWithNewAccessAccessRefsInner = Initialize-PSSailpoint.V3IdentityWithNewAccessAccessRefsInner -Type ENTITLEMENT ` - -Id 2c91809773dee32014e13e122092014e ` - -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local -``` - -- Convert the resource to JSON -```powershell -$IdentityWithNewAccessAccessRefsInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IdpDetails.md b/docs/tools/sdk/powershell/reference/v3/Models/IdpDetails.md deleted file mode 100644 index aa3b5b3f5..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IdpDetails.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -id: idp-details -title: IdpDetails -pagination_label: IdpDetails -sidebar_label: IdpDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdpDetails'] -slug: /tools/sdk/powershell/v3/models/idp-details -tags: ['SDK', 'Software Development Kit', 'IdpDetails'] ---- - - -# IdpDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Role** | Pointer to **Enum** [ "SAML_IDP" ] | Federation protocol role | [optional] -**EntityId** | Pointer to **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] -**Binding** | Pointer to **String** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] -**AuthContext** | Pointer to **String** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] -**LogoutUrl** | Pointer to **String** | The IDP logout URL. Used with IDP configurations. | [optional] -**IncludeAuthContext** | Pointer to **Boolean** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to $false] -**NameId** | Pointer to **String** | The name id format to use. Used with IDP configurations. | [optional] -**JitConfiguration** | Pointer to [**JITConfiguration**](jit-configuration) | | [optional] -**Cert** | Pointer to **String** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] -**LoginUrlPost** | Pointer to **String** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] -**LoginUrlRedirect** | Pointer to **String** | The IDP Redirect URL. Used with IDP configurations. | [optional] -**MappingAttribute** | Pointer to **String** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [optional] -**CertificateExpirationDate** | Pointer to **String** | The expiration date extracted from the certificate. | [optional] -**CertificateName** | Pointer to **String** | The name extracted from the certificate. | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdpDetails = Initialize-PSSailpoint.V3IdpDetails -Role SAML_IDP ` - -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 ` - -Binding urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST ` - -AuthContext urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport ` - -LogoutUrl https://dev-206445.oktapreview.com/login/signout ` - -IncludeAuthContext false ` - -NameId urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress ` - -JitConfiguration null ` - -Cert -----BEGIN CERTIFICATE-----****-----END CERTIFICATE----- ` - -LoginUrlPost https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml ` - -LoginUrlRedirect https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml ` - -MappingAttribute email ` - -CertificateExpirationDate Fri Mar 08 08:54:24 UTC 2013 ` - -CertificateName OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL -``` - -- Convert the resource to JSON -```powershell -$IdpDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ImportNonEmployeeRecordsInBulkRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/ImportNonEmployeeRecordsInBulkRequest.md deleted file mode 100644 index cb827ec07..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ImportNonEmployeeRecordsInBulkRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: import-non-employee-records-in-bulk-request -title: ImportNonEmployeeRecordsInBulkRequest -pagination_label: ImportNonEmployeeRecordsInBulkRequest -sidebar_label: ImportNonEmployeeRecordsInBulkRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ImportNonEmployeeRecordsInBulkRequest'] -slug: /tools/sdk/powershell/v3/models/import-non-employee-records-in-bulk-request -tags: ['SDK', 'Software Development Kit', 'ImportNonEmployeeRecordsInBulkRequest'] ---- - - -# ImportNonEmployeeRecordsInBulkRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**VarData** | **System.IO.FileInfo** | | [required] - -## Examples - -- Prepare the resource -```powershell -$ImportNonEmployeeRecordsInBulkRequest = Initialize-PSSailpoint.V3ImportNonEmployeeRecordsInBulkRequest -VarData null -``` - -- Convert the resource to JSON -```powershell -$ImportNonEmployeeRecordsInBulkRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ImportObject.md b/docs/tools/sdk/powershell/reference/v3/Models/ImportObject.md deleted file mode 100644 index dc01d2bc7..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ImportObject.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: import-object -title: ImportObject -pagination_label: ImportObject -sidebar_label: ImportObject -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ImportObject'] -slug: /tools/sdk/powershell/v3/models/import-object -tags: ['SDK', 'Software Development Kit', 'ImportObject'] ---- - - -# ImportObject - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY_OBJECT_CONFIG", "IDENTITY_PROFILE", "RULE", "SOURCE", "TRANSFORM", "TRIGGER_SUBSCRIPTION" ] | DTO type of object created or updated by import. | [optional] -**Id** | Pointer to **String** | ID of object created or updated by import. | [optional] -**Name** | Pointer to **String** | Display name of object created or updated by import. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ImportObject = Initialize-PSSailpoint.V3ImportObject -Type SOURCE ` - -Id 2c9180835d191a86015d28455b4b232a ` - -Name HR Active Directory -``` - -- Convert the resource to JSON -```powershell -$ImportObject | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/IndexOf.md b/docs/tools/sdk/powershell/reference/v3/Models/IndexOf.md deleted file mode 100644 index c2ff6eee5..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/IndexOf.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: index-of -title: IndexOf -pagination_label: IndexOf -sidebar_label: IndexOf -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IndexOf'] -slug: /tools/sdk/powershell/v3/models/index-of -tags: ['SDK', 'Software Development Kit', 'IndexOf'] ---- - - -# IndexOf - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Substring** | **String** | A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring. | [required] -**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 -$IndexOf = Initialize-PSSailpoint.V3IndexOf -Substring admin_ ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$IndexOf | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/InnerHit.md b/docs/tools/sdk/powershell/reference/v3/Models/InnerHit.md deleted file mode 100644 index 7c2457b84..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/InnerHit.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: inner-hit -title: InnerHit -pagination_label: InnerHit -sidebar_label: InnerHit -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'InnerHit'] -slug: /tools/sdk/powershell/v3/models/inner-hit -tags: ['SDK', 'Software Development Kit', 'InnerHit'] ---- - - -# InnerHit - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Query** | **String** | The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | [required] -**Type** | **String** | The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document ""nested"" within another document. For example, an identity can have nested documents for access, accounts, and apps. | [required] - -## Examples - -- Prepare the resource -```powershell -$InnerHit = Initialize-PSSailpoint.V3InnerHit -Query source.name:\"Active Directory\" ` - -Type access -``` - -- Convert the resource to JSON -```powershell -$InnerHit | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/JITConfiguration.md b/docs/tools/sdk/powershell/reference/v3/Models/JITConfiguration.md deleted file mode 100644 index fff02f223..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/JITConfiguration.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: jit-configuration -title: JITConfiguration -pagination_label: JITConfiguration -sidebar_label: JITConfiguration -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'JITConfiguration'] -slug: /tools/sdk/powershell/v3/models/jit-configuration -tags: ['SDK', 'Software Development Kit', 'JITConfiguration'] ---- - - -# JITConfiguration - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Enabled** | Pointer to **Boolean** | The indicator for just-in-time provisioning enabled | [optional] [default to $false] -**SourceId** | Pointer to **String** | the sourceId that mapped to just-in-time provisioning configuration | [optional] -**SourceAttributeMappings** | Pointer to **map[string]String** | A mapping of identity profile attribute names to SAML assertion attribute names | [optional] - -## Examples - -- Prepare the resource -```powershell -$JITConfiguration = Initialize-PSSailpoint.V3JITConfiguration -Enabled false ` - -SourceId 2c9180857377ed2901739c12a2da5ac8 ` - -SourceAttributeMappings {firstName=okta.firstName, lastName=okta.lastName, email=okta.email} -``` - -- Convert the resource to JSON -```powershell -$JITConfiguration | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/JsonPatchOperation.md b/docs/tools/sdk/powershell/reference/v3/Models/JsonPatchOperation.md deleted file mode 100644 index ce0db3964..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/JsonPatchOperation.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: json-patch-operation -title: JsonPatchOperation -pagination_label: JsonPatchOperation -sidebar_label: JsonPatchOperation -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'JsonPatchOperation'] -slug: /tools/sdk/powershell/v3/models/json-patch-operation -tags: ['SDK', 'Software Development Kit', 'JsonPatchOperation'] ---- - - -# JsonPatchOperation - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Op** | **Enum** [ "add", "remove", "replace", "move", "copy", "test" ] | The operation to be performed | [required] -**Path** | **String** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required] -**Value** | Pointer to [**JsonPatchOperationValue**](json-patch-operation-value) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$JsonPatchOperation = Initialize-PSSailpoint.V3JsonPatchOperation -Op replace ` - -Path /description ` - -Value null -``` - -- Convert the resource to JSON -```powershell -$JsonPatchOperation | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/JsonPatchOperationValue.md b/docs/tools/sdk/powershell/reference/v3/Models/JsonPatchOperationValue.md deleted file mode 100644 index 6024522d3..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/JsonPatchOperationValue.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: json-patch-operation-value -title: JsonPatchOperationValue -pagination_label: JsonPatchOperationValue -sidebar_label: JsonPatchOperationValue -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'JsonPatchOperationValue'] -slug: /tools/sdk/powershell/v3/models/json-patch-operation-value -tags: ['SDK', 'Software Development Kit', 'JsonPatchOperationValue'] ---- - - -# JsonPatchOperationValue - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -## Examples - -- Prepare the resource -```powershell -$JsonPatchOperationValue = Initialize-PSSailpoint.V3JsonPatchOperationValue -``` - -- Convert the resource to JSON -```powershell -$JsonPatchOperationValue | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/KbaAnswerRequestItem.md b/docs/tools/sdk/powershell/reference/v3/Models/KbaAnswerRequestItem.md deleted file mode 100644 index 411f679dd..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/KbaAnswerRequestItem.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: kba-answer-request-item -title: KbaAnswerRequestItem -pagination_label: KbaAnswerRequestItem -sidebar_label: KbaAnswerRequestItem -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'KbaAnswerRequestItem'] -slug: /tools/sdk/powershell/v3/models/kba-answer-request-item -tags: ['SDK', 'Software Development Kit', 'KbaAnswerRequestItem'] ---- - - -# KbaAnswerRequestItem - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | Question Id | [required] -**Answer** | **String** | An answer for the KBA question | [required] - -## Examples - -- Prepare the resource -```powershell -$KbaAnswerRequestItem = Initialize-PSSailpoint.V3KbaAnswerRequestItem -Id c54fee53-2d63-4fc5-9259-3e93b9994135 ` - -Answer Your answer -``` - -- Convert the resource to JSON -```powershell -$KbaAnswerRequestItem | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/KbaAnswerResponseItem.md b/docs/tools/sdk/powershell/reference/v3/Models/KbaAnswerResponseItem.md deleted file mode 100644 index 09bb118f5..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/KbaAnswerResponseItem.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: kba-answer-response-item -title: KbaAnswerResponseItem -pagination_label: KbaAnswerResponseItem -sidebar_label: KbaAnswerResponseItem -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'KbaAnswerResponseItem'] -slug: /tools/sdk/powershell/v3/models/kba-answer-response-item -tags: ['SDK', 'Software Development Kit', 'KbaAnswerResponseItem'] ---- - - -# KbaAnswerResponseItem - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | Question Id | [required] -**Question** | **String** | Question description | [required] -**HasAnswer** | **Boolean** | Denotes whether the KBA question has an answer configured for the current user | [required] - -## Examples - -- Prepare the resource -```powershell -$KbaAnswerResponseItem = Initialize-PSSailpoint.V3KbaAnswerResponseItem -Id c54fee53-2d63-4fc5-9259-3e93b9994135 ` - -Question [{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}] ` - -HasAnswer true -``` - -- Convert the resource to JSON -```powershell -$KbaAnswerResponseItem | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/KbaAuthResponse.md b/docs/tools/sdk/powershell/reference/v3/Models/KbaAuthResponse.md deleted file mode 100644 index 2e1f594ea..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/KbaAuthResponse.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: kba-auth-response -title: KbaAuthResponse -pagination_label: KbaAuthResponse -sidebar_label: KbaAuthResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'KbaAuthResponse'] -slug: /tools/sdk/powershell/v3/models/kba-auth-response -tags: ['SDK', 'Software Development Kit', 'KbaAuthResponse'] ---- - - -# KbaAuthResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**KbaAuthResponseItems** | Pointer to [**[]KbaAuthResponseItem**](kba-auth-response-item) | | [optional] -**Status** | Pointer to **Enum** [ "PENDING", "SUCCESS", "FAILED", "LOCKOUT", "NOT_ENOUGH_DATA" ] | MFA Authentication status | [optional] - -## Examples - -- Prepare the resource -```powershell -$KbaAuthResponse = Initialize-PSSailpoint.V3KbaAuthResponse -KbaAuthResponseItems [{questionId=089899f13a8f4da7824996191587bab9, isVerified=false}] ` - -Status PENDING -``` - -- Convert the resource to JSON -```powershell -$KbaAuthResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/KbaAuthResponseItem.md b/docs/tools/sdk/powershell/reference/v3/Models/KbaAuthResponseItem.md deleted file mode 100644 index 1527581cb..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/KbaAuthResponseItem.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: kba-auth-response-item -title: KbaAuthResponseItem -pagination_label: KbaAuthResponseItem -sidebar_label: KbaAuthResponseItem -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'KbaAuthResponseItem'] -slug: /tools/sdk/powershell/v3/models/kba-auth-response-item -tags: ['SDK', 'Software Development Kit', 'KbaAuthResponseItem'] ---- - - -# KbaAuthResponseItem - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**QuestionId** | Pointer to **String** | The KBA question id | [optional] -**IsVerified** | Pointer to **Boolean** | Return true if verified | [optional] - -## Examples - -- Prepare the resource -```powershell -$KbaAuthResponseItem = Initialize-PSSailpoint.V3KbaAuthResponseItem -QuestionId 089899f13a8f4da7824996191587bab9 ` - -IsVerified true -``` - -- Convert the resource to JSON -```powershell -$KbaAuthResponseItem | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/KbaQuestion.md b/docs/tools/sdk/powershell/reference/v3/Models/KbaQuestion.md deleted file mode 100644 index c58847c1b..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/KbaQuestion.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: kba-question -title: KbaQuestion -pagination_label: KbaQuestion -sidebar_label: KbaQuestion -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'KbaQuestion'] -slug: /tools/sdk/powershell/v3/models/kba-question -tags: ['SDK', 'Software Development Kit', 'KbaQuestion'] ---- - - -# KbaQuestion - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | KBA Question Id | [required] -**Text** | **String** | KBA Question description | [required] -**HasAnswer** | **Boolean** | Denotes whether the KBA question has an answer configured for any user in the tenant | [required] -**NumAnswers** | **Int32** | Denotes the number of KBA configurations for this question | [required] - -## Examples - -- Prepare the resource -```powershell -$KbaQuestion = Initialize-PSSailpoint.V3KbaQuestion -Id 143cfd3b-c23f-426b-ae5f-d3db06fa5919 ` - -Text [{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}] ` - -HasAnswer true ` - -NumAnswers 5 -``` - -- Convert the resource to JSON -```powershell -$KbaQuestion | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/LeftPad.md b/docs/tools/sdk/powershell/reference/v3/Models/LeftPad.md deleted file mode 100644 index 19fee4a4a..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/LeftPad.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: left-pad -title: LeftPad -pagination_label: LeftPad -sidebar_label: LeftPad -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'LeftPad'] -slug: /tools/sdk/powershell/v3/models/left-pad -tags: ['SDK', 'Software Development Kit', 'LeftPad'] ---- - - -# LeftPad - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Length** | **String** | An integer value for the desired length of the final output string | [required] -**Padding** | Pointer to **String** | A string value representing the character that the incoming data should be padded with to get to the desired length If not provided, the transform will default to a single space ("" "") character for padding | [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 -$LeftPad = Initialize-PSSailpoint.V3LeftPad -Length 4 ` - -Padding 0 ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$LeftPad | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/LifecycleState.md b/docs/tools/sdk/powershell/reference/v3/Models/LifecycleState.md deleted file mode 100644 index bfcb0ec7f..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/LifecycleState.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -id: lifecycle-state -title: LifecycleState -pagination_label: LifecycleState -sidebar_label: LifecycleState -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'LifecycleState'] -slug: /tools/sdk/powershell/v3/models/lifecycle-state -tags: ['SDK', 'Software Development Kit', 'LifecycleState'] ---- - - -# LifecycleState - -## 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] -**Enabled** | Pointer to **Boolean** | Indicates whether the lifecycle state is enabled or disabled. | [optional] [default to $false] -**TechnicalName** | **String** | The lifecycle state's technical name. This is for internal use. | [required] -**Description** | Pointer to **String** | Lifecycle state's description. | [optional] -**IdentityCount** | Pointer to **Int32** | Number of identities that have the lifecycle state. | [optional] [readonly] -**EmailNotificationOption** | Pointer to [**EmailNotificationOption**](email-notification-option) | | [optional] -**AccountActions** | Pointer to [**[]AccountAction**](account-action) | | [optional] -**AccessProfileIds** | Pointer to **[]String** | List of unique access-profile IDs that are associated with the lifecycle state. | [optional] -**IdentityState** | Pointer to **String** | The lifecycle state's associated identity state. This field is generally 'null'. | [optional] - -## Examples - -- Prepare the resource -```powershell -$LifecycleState = Initialize-PSSailpoint.V3LifecycleState -Id id12345 ` - -Name aName ` - -Created 2015-05-28T14:07:17Z ` - -Modified 2015-05-28T14:07:17Z ` - -Enabled true ` - -TechnicalName Technical Name ` - -Description Lifecycle description ` - -IdentityCount 42 ` - -EmailNotificationOption null ` - -AccountActions null ` - -AccessProfileIds [2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500] ` - -IdentityState null -``` - -- Convert the resource to JSON -```powershell -$LifecycleState | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/LifecyclestateDeleted.md b/docs/tools/sdk/powershell/reference/v3/Models/LifecyclestateDeleted.md deleted file mode 100644 index 1cef9021c..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/LifecyclestateDeleted.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: lifecyclestate-deleted -title: LifecyclestateDeleted -pagination_label: LifecyclestateDeleted -sidebar_label: LifecyclestateDeleted -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'LifecyclestateDeleted'] -slug: /tools/sdk/powershell/v3/models/lifecyclestate-deleted -tags: ['SDK', 'Software Development Kit', 'LifecyclestateDeleted'] ---- - - -# LifecyclestateDeleted - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "LIFECYCLE_STATE" ] | Deleted lifecycle state's DTO type. | [optional] -**Id** | Pointer to **String** | Deleted lifecycle state ID. | [optional] -**Name** | Pointer to **String** | Deleted lifecycle state's display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$LifecyclestateDeleted = Initialize-PSSailpoint.V3LifecyclestateDeleted -Type LIFECYCLE_STATE ` - -Id 12345 ` - -Name Contractor Lifecycle -``` - -- Convert the resource to JSON -```powershell -$LifecyclestateDeleted | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ListAccessProfiles401Response.md b/docs/tools/sdk/powershell/reference/v3/Models/ListAccessProfiles401Response.md deleted file mode 100644 index 980b80b0b..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ListAccessProfiles401Response.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: list-access-profiles401-response -title: ListAccessProfiles401Response -pagination_label: ListAccessProfiles401Response -sidebar_label: ListAccessProfiles401Response -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ListAccessProfiles401Response'] -slug: /tools/sdk/powershell/v3/models/list-access-profiles401-response -tags: ['SDK', 'Software Development Kit', 'ListAccessProfiles401Response'] ---- - - -# ListAccessProfiles401Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**VarError** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A message describing the error | [optional] - -## Examples - -- Prepare the resource -```powershell -$ListAccessProfiles401Response = Initialize-PSSailpoint.V3ListAccessProfiles401Response -VarError JWT validation failed: JWT is expired -``` - -- Convert the resource to JSON -```powershell -$ListAccessProfiles401Response | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ListAccessProfiles429Response.md b/docs/tools/sdk/powershell/reference/v3/Models/ListAccessProfiles429Response.md deleted file mode 100644 index 49c191169..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ListAccessProfiles429Response.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: list-access-profiles429-response -title: ListAccessProfiles429Response -pagination_label: ListAccessProfiles429Response -sidebar_label: ListAccessProfiles429Response -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ListAccessProfiles429Response'] -slug: /tools/sdk/powershell/v3/models/list-access-profiles429-response -tags: ['SDK', 'Software Development Kit', 'ListAccessProfiles429Response'] ---- - - -# ListAccessProfiles429Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Message** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A message describing the error | [optional] - -## Examples - -- Prepare the resource -```powershell -$ListAccessProfiles429Response = Initialize-PSSailpoint.V3ListAccessProfiles429Response -Message Rate Limit Exceeded -``` - -- Convert the resource to JSON -```powershell -$ListAccessProfiles429Response | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ListCampaignFilters200Response.md b/docs/tools/sdk/powershell/reference/v3/Models/ListCampaignFilters200Response.md deleted file mode 100644 index 91297d0f3..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ListCampaignFilters200Response.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: list-campaign-filters200-response -title: ListCampaignFilters200Response -pagination_label: ListCampaignFilters200Response -sidebar_label: ListCampaignFilters200Response -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ListCampaignFilters200Response'] -slug: /tools/sdk/powershell/v3/models/list-campaign-filters200-response -tags: ['SDK', 'Software Development Kit', 'ListCampaignFilters200Response'] ---- - - -# ListCampaignFilters200Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Items** | Pointer to [**[]CampaignFilterDetails**](campaign-filter-details) | List of campaign filters. | [optional] -**Count** | Pointer to **Int32** | Number of filters returned. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ListCampaignFilters200Response = Initialize-PSSailpoint.V3ListCampaignFilters200Response -Items null ` - -Count 2 -``` - -- Convert the resource to JSON -```powershell -$ListCampaignFilters200Response | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ListCompleteWorkflowLibrary200ResponseInner.md b/docs/tools/sdk/powershell/reference/v3/Models/ListCompleteWorkflowLibrary200ResponseInner.md deleted file mode 100644 index ec4da32cc..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ListCompleteWorkflowLibrary200ResponseInner.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -id: list-complete-workflow-library200-response-inner -title: ListCompleteWorkflowLibrary200ResponseInner -pagination_label: ListCompleteWorkflowLibrary200ResponseInner -sidebar_label: ListCompleteWorkflowLibrary200ResponseInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ListCompleteWorkflowLibrary200ResponseInner'] -slug: /tools/sdk/powershell/v3/models/list-complete-workflow-library200-response-inner -tags: ['SDK', 'Software Development Kit', 'ListCompleteWorkflowLibrary200ResponseInner'] ---- - - -# ListCompleteWorkflowLibrary200ResponseInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Operator ID. | [optional] -**Name** | Pointer to **String** | Operator friendly name | [optional] -**Type** | Pointer to **String** | Operator type | [optional] -**Description** | Pointer to **String** | Description of the operator | [optional] -**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the operator accepts | [optional] -**ExampleOutput** | Pointer to [**WorkflowLibraryActionExampleOutput**](workflow-library-action-example-output) | | [optional] -**Deprecated** | Pointer to **Boolean** | | [optional] -**DeprecatedBy** | Pointer to **System.DateTime** | | [optional] -**VersionNumber** | Pointer to **Int32** | Version number | [optional] -**IsSimulationEnabled** | Pointer to **Boolean** | | [optional] -**IsDynamicSchema** | Pointer to **Boolean** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] -**OutputSchema** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Example output schema | [optional] -**InputExample** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Example trigger payload if applicable | [optional] - -## Examples - -- Prepare the resource -```powershell -$ListCompleteWorkflowLibrary200ResponseInner = Initialize-PSSailpoint.V3ListCompleteWorkflowLibrary200ResponseInner -Id sp:compare-boolean ` - -Name Compare Boolean Values ` - -Type OPERATOR ` - -Description Compare two boolean values and decide what happens based on the result. ` - -FormFields [{description=Enter the JSONPath to a value from the input to compare to Variable B., helpText=, label=Variable A, name=variableA.$, required=true, type=text}, {helpText=Select an operation., label=Operation, name=operator, options=[{label=Equals, value=BooleanEquals}], required=true, type=select}, {description=Enter the JSONPath to a value from the input to compare to Variable A., helpText=, label=Variable B, name=variableB.$, required=false, type=text}, {description=Enter True or False., helpText=, label=Variable B, name=variableB, required=false, type=text}] ` - -ExampleOutput null ` - -Deprecated null ` - -DeprecatedBy null ` - -VersionNumber null ` - -IsSimulationEnabled null ` - -IsDynamicSchema false ` - -OutputSchema null ` - -InputExample {changes=[{attribute=department, newValue=marketing, oldValue=sales}, {attribute=manager, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}}, {attribute=email, newValue=john.doe@gmail.com, oldValue=john.doe@hotmail.com}], identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}} -``` - -- Convert the resource to JSON -```powershell -$ListCompleteWorkflowLibrary200ResponseInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/LocaleOrigin.md b/docs/tools/sdk/powershell/reference/v3/Models/LocaleOrigin.md deleted file mode 100644 index beb8c18bc..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/LocaleOrigin.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: locale-origin -title: LocaleOrigin -pagination_label: LocaleOrigin -sidebar_label: LocaleOrigin -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'LocaleOrigin'] -slug: /tools/sdk/powershell/v3/models/locale-origin -tags: ['SDK', 'Software Development Kit', 'LocaleOrigin'] ---- - - -# LocaleOrigin - -## Enum - - -* `DEFAULT` (value: `"DEFAULT"`) - -* `REQUEST` (value: `"REQUEST"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/LockoutConfiguration.md b/docs/tools/sdk/powershell/reference/v3/Models/LockoutConfiguration.md deleted file mode 100644 index a4fbc9b93..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/LockoutConfiguration.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: lockout-configuration -title: LockoutConfiguration -pagination_label: LockoutConfiguration -sidebar_label: LockoutConfiguration -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'LockoutConfiguration'] -slug: /tools/sdk/powershell/v3/models/lockout-configuration -tags: ['SDK', 'Software Development Kit', 'LockoutConfiguration'] ---- - - -# LockoutConfiguration - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**MaximumAttempts** | Pointer to **Int32** | The maximum attempts allowed before lockout occurs. | [optional] -**LockoutDuration** | Pointer to **Int32** | The total time in minutes a user will be locked out. | [optional] -**LockoutWindow** | Pointer to **Int32** | A rolling window where authentication attempts in a series count towards the maximum before lockout occurs. | [optional] - -## Examples - -- Prepare the resource -```powershell -$LockoutConfiguration = Initialize-PSSailpoint.V3LockoutConfiguration -MaximumAttempts 5 ` - -LockoutDuration 15 ` - -LockoutWindow 5 -``` - -- Convert the resource to JSON -```powershell -$LockoutConfiguration | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Lookup.md b/docs/tools/sdk/powershell/reference/v3/Models/Lookup.md deleted file mode 100644 index b7a74e5b9..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Lookup.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: lookup -title: Lookup -pagination_label: Lookup -sidebar_label: Lookup -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Lookup'] -slug: /tools/sdk/powershell/v3/models/lookup -tags: ['SDK', 'Software Development Kit', 'Lookup'] ---- - - -# Lookup - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Table** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return ""Unknown Region"" for the attribute that is mapped to this transform. | [required] -**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 -$Lookup = Initialize-PSSailpoint.V3Lookup -Table {USA=Americas, FRA=EMEA, AUS=APAC, default=Unknown Region} ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$Lookup | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Lower.md b/docs/tools/sdk/powershell/reference/v3/Models/Lower.md deleted file mode 100644 index cfae7fc10..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Lower.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: lower -title: Lower -pagination_label: Lower -sidebar_label: Lower -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Lower'] -slug: /tools/sdk/powershell/v3/models/lower -tags: ['SDK', 'Software Development Kit', 'Lower'] ---- - - -# Lower - -## 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 -$Lower = Initialize-PSSailpoint.V3Lower -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$Lower | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ManagedClient.md b/docs/tools/sdk/powershell/reference/v3/Models/ManagedClient.md deleted file mode 100644 index 62f384c63..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ManagedClient.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -id: managed-client -title: ManagedClient -pagination_label: ManagedClient -sidebar_label: ManagedClient -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClient'] -slug: /tools/sdk/powershell/v3/models/managed-client -tags: ['SDK', 'Software Development Kit', 'ManagedClient'] ---- - - -# ManagedClient - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | ManagedClient ID | [optional] [readonly] -**AlertKey** | Pointer to **String** | ManagedClient alert key | [optional] [readonly] -**ApiGatewayBaseUrl** | Pointer to **String** | | [optional] -**Cookbook** | Pointer to **String** | | [optional] -**CcId** | Pointer to **Int64** | Previous CC ID to be used in data migration. (This field will be deleted after CC migration!) | [optional] -**ClientId** | **String** | The client ID used in API management | [required] -**ClusterId** | **String** | Cluster ID that the ManagedClient is linked to | [required] -**Description** | **String** | ManagedClient description | [required][default to ""] -**IpAddress** | Pointer to **String** | The public IP address of the ManagedClient | [optional] [readonly] -**LastSeen** | Pointer to **System.DateTime** | When the ManagedClient was last seen by the server | [optional] [readonly] -**Name** | Pointer to **String** | ManagedClient name | [optional] [default to "VA-$clientId"] -**SinceLastSeen** | Pointer to **String** | Milliseconds since the ManagedClient has polled the server | [optional] [readonly] -**Status** | Pointer to **Enum** [ "NORMAL", "UNDEFINED", "NOT_CONFIGURED", "CONFIGURING", "WARNING", "ERROR", "FAILED" ] | Status of the ManagedClient | [optional] [readonly] -**Type** | **String** | Type of the ManagedClient (VA, CCG) | [required] -**ClusterType** | Pointer to **Enum** [ "idn", "iai", "spConnectCluster", "sqsCluster", "das-rc", "das-pc", "das-dc" ] | Cluster Type of the ManagedClient | [optional] [readonly] -**VaDownloadUrl** | Pointer to **String** | ManagedClient VA download URL | [optional] [readonly] -**VaVersion** | Pointer to **String** | Version that the ManagedClient's VA is running | [optional] [readonly] -**Secret** | Pointer to **String** | Client's apiKey | [optional] -**CreatedAt** | Pointer to **System.DateTime** | The date/time this ManagedClient was created | [optional] -**UpdatedAt** | Pointer to **System.DateTime** | The date/time this ManagedClient was last updated | [optional] -**ProvisionStatus** | Pointer to **Enum** [ "PROVISIONED", "DRAFT" ] | The provisioning status of the ManagedClient | [optional] [readonly] - -## Examples - -- Prepare the resource -```powershell -$ManagedClient = Initialize-PSSailpoint.V3ManagedClient -Id 2c9180878eaf4204018eb019c3570003 ` - -AlertKey CLIENT_STATUS_NOT_CONFIGURED ` - -ApiGatewayBaseUrl null ` - -Cookbook null ` - -CcId 2248 ` - -ClientId 00be54a2-bb6d-402f-9159-beb2d5319347 ` - -ClusterId e1ff7bb24c934240bbf55e1aa39e41c5 ` - -Description A short description of the ManagedClient ` - -IpAddress 123.456.78.90 ` - -LastSeen 2020-01-01T00:00Z ` - -Name aName ` - -SinceLastSeen 15000 ` - -Status NORMAL ` - -Type VA ` - -ClusterType idn ` - -VaDownloadUrl aUrl ` - -VaVersion va-megapod-useast1-610-1621372012 ` - -Secret ef878e15eaa8c8d3e2fa52f41125e2a0eeadadc6a14f931a33ad3e1b62d56381 ` - -CreatedAt 2023-08-04T20:48:01.865Z ` - -UpdatedAt 2023-08-04T20:48:01.865Z ` - -ProvisionStatus PROVISIONED -``` - -- Convert the resource to JSON -```powershell -$ManagedClient | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ManagedClientRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/ManagedClientRequest.md deleted file mode 100644 index 54ed0a70e..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ManagedClientRequest.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: managed-client-request -title: ManagedClientRequest -pagination_label: ManagedClientRequest -sidebar_label: ManagedClientRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClientRequest'] -slug: /tools/sdk/powershell/v3/models/managed-client-request -tags: ['SDK', 'Software Development Kit', 'ManagedClientRequest'] ---- - - -# ManagedClientRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ClusterId** | **String** | Cluster ID that the ManagedClient is linked to | [required] -**Description** | Pointer to **String** | description for the ManagedClient to create | [optional] -**Name** | Pointer to **String** | name for the ManagedClient to create | [optional] -**Type** | Pointer to **String** | Type of the ManagedClient (VA, CCG) to create | [optional] - -## Examples - -- Prepare the resource -```powershell -$ManagedClientRequest = Initialize-PSSailpoint.V3ManagedClientRequest -ClusterId aClusterId ` - -Description A short description of the ManagedClient ` - -Name aName ` - -Type VA -``` - -- Convert the resource to JSON -```powershell -$ManagedClientRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ManagedClientStatus.md b/docs/tools/sdk/powershell/reference/v3/Models/ManagedClientStatus.md deleted file mode 100644 index 679340167..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ManagedClientStatus.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: managed-client-status -title: ManagedClientStatus -pagination_label: ManagedClientStatus -sidebar_label: ManagedClientStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClientStatus'] -slug: /tools/sdk/powershell/v3/models/managed-client-status -tags: ['SDK', 'Software Development Kit', 'ManagedClientStatus'] ---- - - -# ManagedClientStatus - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Body** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | ManagedClientStatus body information | [required] -**Status** | [**ManagedClientStatusCode**](managed-client-status-code) | | [required] -**Type** | [**ManagedClientType**](managed-client-type) | | [required] -**Timestamp** | **System.DateTime** | timestamp on the Client Status update | [required] - -## Examples - -- Prepare the resource -```powershell -$ManagedClientStatus = Initialize-PSSailpoint.V3ManagedClientStatus -Body {alertKey=, id=5678, clusterId=1234, ccg_etag=ccg_etag123xyz456, ccg_pin=NONE, cookbook_etag=20210420125956-20210511144538, hostname=megapod-useast1-secret-hostname.sailpoint.com, internal_ip=127.0.0.1, lastSeen=1620843964604, sinceSeen=14708, sinceSeenMillis=14708, localDev=false, stacktrace=, state=null, status=NORMAL, uuid=null, product=idn, va_version=null, platform_version=2, os_version=2345.3.1, os_type=flatcar, hypervisor=unknown} ` - -Status null ` - -Type null ` - -Timestamp 2020-01-01T00:00Z -``` - -- Convert the resource to JSON -```powershell -$ManagedClientStatus | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ManagedClientStatusCode.md b/docs/tools/sdk/powershell/reference/v3/Models/ManagedClientStatusCode.md deleted file mode 100644 index df6667bca..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ManagedClientStatusCode.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: managed-client-status-code -title: ManagedClientStatusCode -pagination_label: ManagedClientStatusCode -sidebar_label: ManagedClientStatusCode -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClientStatusCode'] -slug: /tools/sdk/powershell/v3/models/managed-client-status-code -tags: ['SDK', 'Software Development Kit', 'ManagedClientStatusCode'] ---- - - -# ManagedClientStatusCode - -## Enum - - -* `NORMAL` (value: `"NORMAL"`) - -* `UNDEFINED` (value: `"UNDEFINED"`) - -* `NOT_CONFIGURED` (value: `"NOT_CONFIGURED"`) - -* `CONFIGURING` (value: `"CONFIGURING"`) - -* `WARNING` (value: `"WARNING"`) - -* `ERROR` (value: `"ERROR"`) - -* `FAILED` (value: `"FAILED"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ManagedClientType.md b/docs/tools/sdk/powershell/reference/v3/Models/ManagedClientType.md deleted file mode 100644 index 652989b40..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ManagedClientType.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: managed-client-type -title: ManagedClientType -pagination_label: ManagedClientType -sidebar_label: ManagedClientType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClientType'] -slug: /tools/sdk/powershell/v3/models/managed-client-type -tags: ['SDK', 'Software Development Kit', 'ManagedClientType'] ---- - - -# ManagedClientType - -## Enum - - -* `CCG` (value: `"CCG"`) - -* `VA` (value: `"VA"`) - -* `INTERNAL` (value: `"INTERNAL"`) - -* `IIQ_HARVESTER` (value: `"IIQ_HARVESTER"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ManagedCluster.md b/docs/tools/sdk/powershell/reference/v3/Models/ManagedCluster.md deleted file mode 100644 index 361f16df5..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ManagedCluster.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -id: managed-cluster -title: ManagedCluster -pagination_label: ManagedCluster -sidebar_label: ManagedCluster -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedCluster'] -slug: /tools/sdk/powershell/v3/models/managed-cluster -tags: ['SDK', 'Software Development Kit', 'ManagedCluster'] ---- - - -# ManagedCluster - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | ManagedCluster ID | [required] -**Name** | Pointer to **String** | ManagedCluster name | [optional] -**Pod** | Pointer to **String** | ManagedCluster pod | [optional] -**Org** | Pointer to **String** | ManagedCluster org | [optional] -**Type** | Pointer to [**ManagedClusterTypes**](managed-cluster-types) | | [optional] -**Configuration** | Pointer to **map[string]String** | ManagedProcess configuration map | [optional] -**KeyPair** | Pointer to [**ManagedClusterKeyPair**](managed-cluster-key-pair) | | [optional] -**Attributes** | Pointer to [**ManagedClusterAttributes**](managed-cluster-attributes) | | [optional] -**Description** | Pointer to **String** | ManagedCluster description | [optional] [default to "q"] -**Redis** | Pointer to [**ManagedClusterRedis**](managed-cluster-redis) | | [optional] -**ClientType** | [**ManagedClientType**](managed-client-type) | | [required] -**CcgVersion** | **String** | CCG version used by the ManagedCluster | [required] -**PinnedConfig** | Pointer to **Boolean** | boolean flag indiacting whether or not the cluster configuration is pinned | [optional] [default to $false] -**LogConfiguration** | Pointer to [**ClientLogConfiguration**](client-log-configuration) | | [optional] -**Operational** | Pointer to **Boolean** | Whether or not the cluster is operational or not | [optional] [default to $false] -**Status** | Pointer to **String** | Cluster status | [optional] -**PublicKeyCertificate** | Pointer to **String** | Public key certificate | [optional] -**PublicKeyThumbprint** | Pointer to **String** | Public key thumbprint | [optional] -**PublicKey** | Pointer to **String** | Public key | [optional] -**AlertKey** | Pointer to **String** | Key describing any immediate cluster alerts | [optional] -**ClientIds** | Pointer to **[]String** | List of clients in a cluster | [optional] -**ServiceCount** | Pointer to **Int32** | Number of services bound to a cluster | [optional] [default to 0] -**CcId** | Pointer to **String** | CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished | [optional] [default to "0"] -**CreatedAt** | Pointer to **System.DateTime** | The date/time this cluster was created | [optional] -**UpdatedAt** | Pointer to **System.DateTime** | The date/time this cluster was last updated | [optional] - -## Examples - -- Prepare the resource -```powershell -$ManagedCluster = Initialize-PSSailpoint.V3ManagedCluster -Id e1ff7bb24c934240bbf55e1aa39e41c5 ` - -Name Managed Cluster Name ` - -Pod megapod-useast1 ` - -Org denali ` - -Type null ` - -Configuration {clusterExternalId=e1ff7bb24c934240bbf55e1aa39e41c5, clusterType=sqsCluster, gmtOffset=-5} ` - -KeyPair null ` - -Attributes null ` - -Description A short description of the managed cluster. ` - -Redis null ` - -ClientType null ` - -CcgVersion v01 ` - -PinnedConfig false ` - -LogConfiguration null ` - -Operational false ` - -Status NORMAL ` - -PublicKeyCertificate -----BEGIN CERTIFICATE-----TCCAb2gAwIBAgIBADANBgkqhkiG9w0BAQsFADAuMQ0wCwYDVQQD-----END CERTIFICATE----- ` - -PublicKeyThumbprint obc6pLiulGbtZ ` - -PublicKey -----BEGIN PUBLIC KEY-----jANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3WgnsxP52MDgBTfHR+5n4-----END PUBLIC KEY----- ` - -AlertKey LIMITED_RESOURCES ` - -ClientIds [1244, 1245] ` - -ServiceCount 6 ` - -CcId 1533 ` - -CreatedAt 2023-08-04T20:48:01.865Z ` - -UpdatedAt 2023-08-04T20:48:01.865Z -``` - -- Convert the resource to JSON -```powershell -$ManagedCluster | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ManagedClusterAttributes.md b/docs/tools/sdk/powershell/reference/v3/Models/ManagedClusterAttributes.md deleted file mode 100644 index 5875aed06..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ManagedClusterAttributes.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: managed-cluster-attributes -title: ManagedClusterAttributes -pagination_label: ManagedClusterAttributes -sidebar_label: ManagedClusterAttributes -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterAttributes'] -slug: /tools/sdk/powershell/v3/models/managed-cluster-attributes -tags: ['SDK', 'Software Development Kit', 'ManagedClusterAttributes'] ---- - - -# ManagedClusterAttributes - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Queue** | Pointer to [**ManagedClusterQueue**](managed-cluster-queue) | | [optional] -**Keystore** | Pointer to **String** | ManagedCluster keystore for spConnectCluster type | [optional] - -## Examples - -- Prepare the resource -```powershell -$ManagedClusterAttributes = Initialize-PSSailpoint.V3ManagedClusterAttributes -Queue null ` - -Keystore /u3+7QAAAAIAAAABAAAAAQAvL3Byb3h5LWNsdXN0ZXIvMmM5MTgwODc3Yjg3MW -``` - -- Convert the resource to JSON -```powershell -$ManagedClusterAttributes | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ManagedClusterKeyPair.md b/docs/tools/sdk/powershell/reference/v3/Models/ManagedClusterKeyPair.md deleted file mode 100644 index dff595d56..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ManagedClusterKeyPair.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: managed-cluster-key-pair -title: ManagedClusterKeyPair -pagination_label: ManagedClusterKeyPair -sidebar_label: ManagedClusterKeyPair -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterKeyPair'] -slug: /tools/sdk/powershell/v3/models/managed-cluster-key-pair -tags: ['SDK', 'Software Development Kit', 'ManagedClusterKeyPair'] ---- - - -# ManagedClusterKeyPair - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**PublicKey** | Pointer to **String** | ManagedCluster publicKey | [optional] -**PublicKeyThumbprint** | Pointer to **String** | ManagedCluster publicKeyThumbprint | [optional] -**PublicKeyCertificate** | Pointer to **String** | ManagedCluster publicKeyCertificate | [optional] - -## Examples - -- Prepare the resource -```powershell -$ManagedClusterKeyPair = Initialize-PSSailpoint.V3ManagedClusterKeyPair -PublicKey -----BEGIN PUBLIC KEY-----******-----END PUBLIC KEY----- ` - -PublicKeyThumbprint 6CMlaJIV44-xJxcB3CJBjDUUn54 ` - -PublicKeyCertificate -----BEGIN CERTIFICATE-----****-----END CERTIFICATE----- -``` - -- Convert the resource to JSON -```powershell -$ManagedClusterKeyPair | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ManagedClusterQueue.md b/docs/tools/sdk/powershell/reference/v3/Models/ManagedClusterQueue.md deleted file mode 100644 index 84a0a7ea7..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ManagedClusterQueue.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: managed-cluster-queue -title: ManagedClusterQueue -pagination_label: ManagedClusterQueue -sidebar_label: ManagedClusterQueue -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterQueue'] -slug: /tools/sdk/powershell/v3/models/managed-cluster-queue -tags: ['SDK', 'Software Development Kit', 'ManagedClusterQueue'] ---- - - -# ManagedClusterQueue - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | ManagedCluster queue name | [optional] -**Region** | Pointer to **String** | ManagedCluster queue aws region | [optional] - -## Examples - -- Prepare the resource -```powershell -$ManagedClusterQueue = Initialize-PSSailpoint.V3ManagedClusterQueue -Name megapod-useast1-denali-lwt-cluster-1533 ` - -Region us-east-1 -``` - -- Convert the resource to JSON -```powershell -$ManagedClusterQueue | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ManagedClusterRedis.md b/docs/tools/sdk/powershell/reference/v3/Models/ManagedClusterRedis.md deleted file mode 100644 index 57dfd99ad..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ManagedClusterRedis.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: managed-cluster-redis -title: ManagedClusterRedis -pagination_label: ManagedClusterRedis -sidebar_label: ManagedClusterRedis -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterRedis'] -slug: /tools/sdk/powershell/v3/models/managed-cluster-redis -tags: ['SDK', 'Software Development Kit', 'ManagedClusterRedis'] ---- - - -# ManagedClusterRedis - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RedisHost** | Pointer to **String** | ManagedCluster redisHost | [optional] -**RedisPort** | Pointer to **Int32** | ManagedCluster redisPort | [optional] - -## Examples - -- Prepare the resource -```powershell -$ManagedClusterRedis = Initialize-PSSailpoint.V3ManagedClusterRedis -RedisHost megapod-useast1-shared-redis.cloud.sailpoint.com ` - -RedisPort 6379 -``` - -- Convert the resource to JSON -```powershell -$ManagedClusterRedis | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ManagedClusterRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/ManagedClusterRequest.md deleted file mode 100644 index f5e6b4863..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ManagedClusterRequest.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: managed-cluster-request -title: ManagedClusterRequest -pagination_label: ManagedClusterRequest -sidebar_label: ManagedClusterRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterRequest'] -slug: /tools/sdk/powershell/v3/models/managed-cluster-request -tags: ['SDK', 'Software Development Kit', 'ManagedClusterRequest'] ---- - - -# ManagedClusterRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | ManagedCluster name | [required] -**Type** | Pointer to [**ManagedClusterTypes**](managed-cluster-types) | | [optional] -**Configuration** | Pointer to **map[string]String** | ManagedProcess configuration map | [optional] -**Description** | Pointer to **String** | ManagedCluster description | [optional] - -## Examples - -- Prepare the resource -```powershell -$ManagedClusterRequest = Initialize-PSSailpoint.V3ManagedClusterRequest -Name Managed Cluster Name ` - -Type null ` - -Configuration {clusterExternalId=externalId, ccgVersion=77.0.0} ` - -Description A short description of the managed cluster. -``` - -- Convert the resource to JSON -```powershell -$ManagedClusterRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ManagedClusterTypes.md b/docs/tools/sdk/powershell/reference/v3/Models/ManagedClusterTypes.md deleted file mode 100644 index de5083c25..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ManagedClusterTypes.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: managed-cluster-types -title: ManagedClusterTypes -pagination_label: ManagedClusterTypes -sidebar_label: ManagedClusterTypes -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterTypes'] -slug: /tools/sdk/powershell/v3/models/managed-cluster-types -tags: ['SDK', 'Software Development Kit', 'ManagedClusterTypes'] ---- - - -# ManagedClusterTypes - -## Enum - - -* `idn` (value: `"idn"`) - -* `iai` (value: `"iai"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ManagerCorrelationMapping.md b/docs/tools/sdk/powershell/reference/v3/Models/ManagerCorrelationMapping.md deleted file mode 100644 index b9ba9f736..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ManagerCorrelationMapping.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: manager-correlation-mapping -title: ManagerCorrelationMapping -pagination_label: ManagerCorrelationMapping -sidebar_label: ManagerCorrelationMapping -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManagerCorrelationMapping'] -slug: /tools/sdk/powershell/v3/models/manager-correlation-mapping -tags: ['SDK', 'Software Development Kit', 'ManagerCorrelationMapping'] ---- - - -# ManagerCorrelationMapping - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccountAttributeName** | Pointer to **String** | Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. | [optional] -**IdentityAttributeName** | Pointer to **String** | Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ManagerCorrelationMapping = Initialize-PSSailpoint.V3ManagerCorrelationMapping -AccountAttributeName manager ` - -IdentityAttributeName manager -``` - -- Convert the resource to JSON -```powershell -$ManagerCorrelationMapping | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ManualDiscoverApplications.md b/docs/tools/sdk/powershell/reference/v3/Models/ManualDiscoverApplications.md deleted file mode 100644 index a5b9dc32c..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ManualDiscoverApplications.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: manual-discover-applications -title: ManualDiscoverApplications -pagination_label: ManualDiscoverApplications -sidebar_label: ManualDiscoverApplications -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManualDiscoverApplications'] -slug: /tools/sdk/powershell/v3/models/manual-discover-applications -tags: ['SDK', 'Software Development Kit', 'ManualDiscoverApplications'] ---- - - -# ManualDiscoverApplications - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**File** | **System.IO.FileInfo** | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. | [required] - -## Examples - -- Prepare the resource -```powershell -$ManualDiscoverApplications = Initialize-PSSailpoint.V3ManualDiscoverApplications -File application_name,description -"Sample App","This is a sample description for Sample App." -"Another App","Description for Another App." -``` - -- Convert the resource to JSON -```powershell -$ManualDiscoverApplications | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ManualDiscoverApplicationsTemplate.md b/docs/tools/sdk/powershell/reference/v3/Models/ManualDiscoverApplicationsTemplate.md deleted file mode 100644 index df50c0d99..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ManualDiscoverApplicationsTemplate.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: manual-discover-applications-template -title: ManualDiscoverApplicationsTemplate -pagination_label: ManualDiscoverApplicationsTemplate -sidebar_label: ManualDiscoverApplicationsTemplate -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManualDiscoverApplicationsTemplate'] -slug: /tools/sdk/powershell/v3/models/manual-discover-applications-template -tags: ['SDK', 'Software Development Kit', 'ManualDiscoverApplicationsTemplate'] ---- - - -# ManualDiscoverApplicationsTemplate - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ApplicationName** | Pointer to **String** | Name of the application. | [optional] -**Description** | Pointer to **String** | Description of the application. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ManualDiscoverApplicationsTemplate = Initialize-PSSailpoint.V3ManualDiscoverApplicationsTemplate -ApplicationName Example Application ` - -Description Example Description -``` - -- Convert the resource to JSON -```powershell -$ManualDiscoverApplicationsTemplate | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ManualWorkItemDetails.md b/docs/tools/sdk/powershell/reference/v3/Models/ManualWorkItemDetails.md deleted file mode 100644 index 4207f8b38..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ManualWorkItemDetails.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: manual-work-item-details -title: ManualWorkItemDetails -pagination_label: ManualWorkItemDetails -sidebar_label: ManualWorkItemDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManualWorkItemDetails'] -slug: /tools/sdk/powershell/v3/models/manual-work-item-details -tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetails'] ---- - - -# ManualWorkItemDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**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 [**ManualWorkItemDetailsOriginalOwner**](manual-work-item-details-original-owner) | | [optional] -**CurrentOwner** | Pointer to [**ManualWorkItemDetailsCurrentOwner**](manual-work-item-details-current-owner) | | [optional] -**Modified** | Pointer to **System.DateTime** | Time at which item was modified. | [optional] -**Status** | Pointer to [**ManualWorkItemState**](manual-work-item-state) | | [optional] -**ForwardHistory** | Pointer to [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ManualWorkItemDetails = Initialize-PSSailpoint.V3ManualWorkItemDetails -Forwarded true ` - -OriginalOwner null ` - -CurrentOwner null ` - -Modified 2019-08-23T18:52:57.398Z ` - -Status null ` - -ForwardHistory null -``` - -- Convert the resource to JSON -```powershell -$ManualWorkItemDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ManualWorkItemDetailsCurrentOwner.md b/docs/tools/sdk/powershell/reference/v3/Models/ManualWorkItemDetailsCurrentOwner.md deleted file mode 100644 index 72138908f..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ManualWorkItemDetailsCurrentOwner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: manual-work-item-details-current-owner -title: ManualWorkItemDetailsCurrentOwner -pagination_label: ManualWorkItemDetailsCurrentOwner -sidebar_label: ManualWorkItemDetailsCurrentOwner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManualWorkItemDetailsCurrentOwner'] -slug: /tools/sdk/powershell/v3/models/manual-work-item-details-current-owner -tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetailsCurrentOwner'] ---- - - -# ManualWorkItemDetailsCurrentOwner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "GOVERNANCE_GROUP", "IDENTITY" ] | DTO type of current work item owner's identity. | [optional] -**Id** | Pointer to **String** | ID of current work item owner's identity. | [optional] -**Name** | Pointer to **String** | Display name of current work item owner. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ManualWorkItemDetailsCurrentOwner = Initialize-PSSailpoint.V3ManualWorkItemDetailsCurrentOwner -Type IDENTITY ` - -Id 2c3780a46faadee4016fb4e018c20652 ` - -Name Allen Albertson -``` - -- Convert the resource to JSON -```powershell -$ManualWorkItemDetailsCurrentOwner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ManualWorkItemDetailsOriginalOwner.md b/docs/tools/sdk/powershell/reference/v3/Models/ManualWorkItemDetailsOriginalOwner.md deleted file mode 100644 index 1a25754f4..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ManualWorkItemDetailsOriginalOwner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: manual-work-item-details-original-owner -title: ManualWorkItemDetailsOriginalOwner -pagination_label: ManualWorkItemDetailsOriginalOwner -sidebar_label: ManualWorkItemDetailsOriginalOwner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManualWorkItemDetailsOriginalOwner'] -slug: /tools/sdk/powershell/v3/models/manual-work-item-details-original-owner -tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetailsOriginalOwner'] ---- - - -# ManualWorkItemDetailsOriginalOwner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "GOVERNANCE_GROUP", "IDENTITY" ] | DTO type of original work item owner's identity. | [optional] -**Id** | Pointer to **String** | ID of original work item owner's identity. | [optional] -**Name** | Pointer to **String** | Display name of original work item owner. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ManualWorkItemDetailsOriginalOwner = Initialize-PSSailpoint.V3ManualWorkItemDetailsOriginalOwner -Type IDENTITY ` - -Id 2c7180a46faadee4016fb4e018c20642 ` - -Name Michael Michaels -``` - -- Convert the resource to JSON -```powershell -$ManualWorkItemDetailsOriginalOwner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ManualWorkItemState.md b/docs/tools/sdk/powershell/reference/v3/Models/ManualWorkItemState.md deleted file mode 100644 index 050e77aff..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ManualWorkItemState.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -id: manual-work-item-state -title: ManualWorkItemState -pagination_label: ManualWorkItemState -sidebar_label: ManualWorkItemState -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManualWorkItemState'] -slug: /tools/sdk/powershell/v3/models/manual-work-item-state -tags: ['SDK', 'Software Development Kit', 'ManualWorkItemState'] ---- - - -# ManualWorkItemState - -## Enum - - -* `PENDING` (value: `"PENDING"`) - -* `APPROVED` (value: `"APPROVED"`) - -* `REJECTED` (value: `"REJECTED"`) - -* `EXPIRED` (value: `"EXPIRED"`) - -* `CANCELLED` (value: `"CANCELLED"`) - -* `ARCHIVED` (value: `"ARCHIVED"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/MetricAggregation.md b/docs/tools/sdk/powershell/reference/v3/Models/MetricAggregation.md deleted file mode 100644 index 17edf77ca..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/MetricAggregation.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: metric-aggregation -title: MetricAggregation -pagination_label: MetricAggregation -sidebar_label: MetricAggregation -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MetricAggregation'] -slug: /tools/sdk/powershell/v3/models/metric-aggregation -tags: ['SDK', 'Software Development Kit', 'MetricAggregation'] ---- - - -# MetricAggregation - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | The name of the metric aggregate to be included in the result. If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. | [required] -**Type** | Pointer to [**MetricType**](metric-type) | | [optional] -**Field** | **String** | The field the calculation is performed on. Prefix the field name with '@' to reference a nested object. | [required] - -## Examples - -- Prepare the resource -```powershell -$MetricAggregation = Initialize-PSSailpoint.V3MetricAggregation -Name Access Name Count ` - -Type null ` - -Field @access.name -``` - -- Convert the resource to JSON -```powershell -$MetricAggregation | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/MetricType.md b/docs/tools/sdk/powershell/reference/v3/Models/MetricType.md deleted file mode 100644 index 3fbf2d412..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/MetricType.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: metric-type -title: MetricType -pagination_label: MetricType -sidebar_label: MetricType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MetricType'] -slug: /tools/sdk/powershell/v3/models/metric-type -tags: ['SDK', 'Software Development Kit', 'MetricType'] ---- - - -# MetricType - -## Enum - - -* `COUNT` (value: `"COUNT"`) - -* `UNIQUE_COUNT` (value: `"UNIQUE_COUNT"`) - -* `AVG` (value: `"AVG"`) - -* `SUM` (value: `"SUM"`) - -* `MEDIAN` (value: `"MEDIAN"`) - -* `MIN` (value: `"MIN"`) - -* `MAX` (value: `"MAX"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/MfaConfigTestResponse.md b/docs/tools/sdk/powershell/reference/v3/Models/MfaConfigTestResponse.md deleted file mode 100644 index e97d79853..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/MfaConfigTestResponse.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: mfa-config-test-response -title: MfaConfigTestResponse -pagination_label: MfaConfigTestResponse -sidebar_label: MfaConfigTestResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MfaConfigTestResponse'] -slug: /tools/sdk/powershell/v3/models/mfa-config-test-response -tags: ['SDK', 'Software Development Kit', 'MfaConfigTestResponse'] ---- - - -# MfaConfigTestResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**State** | Pointer to **Enum** [ "SUCCESS", "FAILED" ] | The configuration test result. | [optional] [readonly] -**VarError** | Pointer to **String** | The error message to indicate the failure of configuration test. | [optional] [readonly] - -## Examples - -- Prepare the resource -```powershell -$MfaConfigTestResponse = Initialize-PSSailpoint.V3MfaConfigTestResponse -State SUCCESS ` - -VarError MFA Method is disabled. -``` - -- Convert the resource to JSON -```powershell -$MfaConfigTestResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/MfaDuoConfig.md b/docs/tools/sdk/powershell/reference/v3/Models/MfaDuoConfig.md deleted file mode 100644 index 29b8fcad1..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/MfaDuoConfig.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: mfa-duo-config -title: MfaDuoConfig -pagination_label: MfaDuoConfig -sidebar_label: MfaDuoConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MfaDuoConfig'] -slug: /tools/sdk/powershell/v3/models/mfa-duo-config -tags: ['SDK', 'Software Development Kit', 'MfaDuoConfig'] ---- - - -# MfaDuoConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**MfaMethod** | Pointer to **String** | Mfa method name | [optional] -**Enabled** | Pointer to **Boolean** | If MFA method is enabled. | [optional] [default to $false] -**VarHost** | Pointer to **String** | The server host name or IP address of the MFA provider. | [optional] -**AccessKey** | Pointer to **String** | The secret key for authenticating requests to the MFA provider. | [optional] -**IdentityAttribute** | Pointer to **String** | Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. | [optional] -**ConfigProperties** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A map with additional config properties for the given MFA method - duo-web. | [optional] - -## Examples - -- Prepare the resource -```powershell -$MfaDuoConfig = Initialize-PSSailpoint.V3MfaDuoConfig -MfaMethod duo-web ` - -Enabled true ` - -VarHost example.com ` - -AccessKey qw123Y3QlA5UqocYpdU3rEkzrK2D497y ` - -IdentityAttribute email ` - -ConfigProperties {skey=qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x, ikey=Q123WE45R6TY7890ZXCV} -``` - -- Convert the resource to JSON -```powershell -$MfaDuoConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/MfaOktaConfig.md b/docs/tools/sdk/powershell/reference/v3/Models/MfaOktaConfig.md deleted file mode 100644 index 426d2d242..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/MfaOktaConfig.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: mfa-okta-config -title: MfaOktaConfig -pagination_label: MfaOktaConfig -sidebar_label: MfaOktaConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MfaOktaConfig'] -slug: /tools/sdk/powershell/v3/models/mfa-okta-config -tags: ['SDK', 'Software Development Kit', 'MfaOktaConfig'] ---- - - -# MfaOktaConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**MfaMethod** | Pointer to **String** | Mfa method name | [optional] -**Enabled** | Pointer to **Boolean** | If MFA method is enabled. | [optional] [default to $false] -**VarHost** | Pointer to **String** | The server host name or IP address of the MFA provider. | [optional] -**AccessKey** | Pointer to **String** | The secret key for authenticating requests to the MFA provider. | [optional] -**IdentityAttribute** | Pointer to **String** | Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. | [optional] - -## Examples - -- Prepare the resource -```powershell -$MfaOktaConfig = Initialize-PSSailpoint.V3MfaOktaConfig -MfaMethod okta-verify ` - -Enabled true ` - -VarHost example.com ` - -AccessKey qw123Y3QlA5UqocYpdU3rEkzrK2D497y ` - -IdentityAttribute email -``` - -- Convert the resource to JSON -```powershell -$MfaOktaConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/MultiPolicyRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/MultiPolicyRequest.md deleted file mode 100644 index e0e18f56a..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/MultiPolicyRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: multi-policy-request -title: MultiPolicyRequest -pagination_label: MultiPolicyRequest -sidebar_label: MultiPolicyRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MultiPolicyRequest'] -slug: /tools/sdk/powershell/v3/models/multi-policy-request -tags: ['SDK', 'Software Development Kit', 'MultiPolicyRequest'] ---- - - -# MultiPolicyRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**FilteredPolicyList** | Pointer to **[]String** | Multi-policy report will be run for this list of ids | [optional] - -## Examples - -- Prepare the resource -```powershell -$MultiPolicyRequest = Initialize-PSSailpoint.V3MultiPolicyRequest -FilteredPolicyList null -``` - -- Convert the resource to JSON -```powershell -$MultiPolicyRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NameNormalizer.md b/docs/tools/sdk/powershell/reference/v3/Models/NameNormalizer.md deleted file mode 100644 index 2a8fe8db3..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NameNormalizer.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: name-normalizer -title: NameNormalizer -pagination_label: NameNormalizer -sidebar_label: NameNormalizer -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NameNormalizer'] -slug: /tools/sdk/powershell/v3/models/name-normalizer -tags: ['SDK', 'Software Development Kit', 'NameNormalizer'] ---- - - -# NameNormalizer - -## 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 -$NameNormalizer = Initialize-PSSailpoint.V3NameNormalizer -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$NameNormalizer | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NamedConstructs.md b/docs/tools/sdk/powershell/reference/v3/Models/NamedConstructs.md deleted file mode 100644 index ef8915543..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NamedConstructs.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: named-constructs -title: NamedConstructs -pagination_label: NamedConstructs -sidebar_label: NamedConstructs -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NamedConstructs'] -slug: /tools/sdk/powershell/v3/models/named-constructs -tags: ['SDK', 'Software Development Kit', 'NamedConstructs'] ---- - - -# NamedConstructs - -## Enum - - -* `ISO8601` (value: `"ISO8601"`) - -* `LDAP` (value: `"LDAP"`) - -* `PEOPLE_SOFT` (value: `"PEOPLE_SOFT"`) - -* `EPOCH_TIME_JAVA` (value: `"EPOCH_TIME_JAVA"`) - -* `EPOCH_TIME_WIN32` (value: `"EPOCH_TIME_WIN32"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NestedAggregation.md b/docs/tools/sdk/powershell/reference/v3/Models/NestedAggregation.md deleted file mode 100644 index 6fb4ee8d3..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NestedAggregation.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: nested-aggregation -title: NestedAggregation -pagination_label: NestedAggregation -sidebar_label: NestedAggregation -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NestedAggregation'] -slug: /tools/sdk/powershell/v3/models/nested-aggregation -tags: ['SDK', 'Software Development Kit', 'NestedAggregation'] ---- - - -# NestedAggregation - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | The name of the nested aggregate to be included in the result. | [required] -**Type** | **String** | The type of the nested object. | [required] - -## Examples - -- Prepare the resource -```powershell -$NestedAggregation = Initialize-PSSailpoint.V3NestedAggregation -Name id ` - -Type access -``` - -- Convert the resource to JSON -```powershell -$NestedAggregation | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NetworkConfiguration.md b/docs/tools/sdk/powershell/reference/v3/Models/NetworkConfiguration.md deleted file mode 100644 index 9272d9633..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NetworkConfiguration.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: network-configuration -title: NetworkConfiguration -pagination_label: NetworkConfiguration -sidebar_label: NetworkConfiguration -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NetworkConfiguration'] -slug: /tools/sdk/powershell/v3/models/network-configuration -tags: ['SDK', 'Software Development Kit', 'NetworkConfiguration'] ---- - - -# NetworkConfiguration - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Range** | Pointer to **[]String** | The collection of ip ranges. | [optional] -**Geolocation** | Pointer to **[]String** | The collection of country codes. | [optional] -**Whitelisted** | Pointer to **Boolean** | Denotes whether the provided lists are whitelisted or blacklisted for geo location. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$NetworkConfiguration = Initialize-PSSailpoint.V3NetworkConfiguration -Range [1.3.7.2, 255.255.255.252/30] ` - -Geolocation [CA, FR, HT] ` - -Whitelisted true -``` - -- Convert the resource to JSON -```powershell -$NetworkConfiguration | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeApprovalDecision.md b/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeApprovalDecision.md deleted file mode 100644 index 7b2b72dc9..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeApprovalDecision.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: non-employee-approval-decision -title: NonEmployeeApprovalDecision -pagination_label: NonEmployeeApprovalDecision -sidebar_label: NonEmployeeApprovalDecision -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeApprovalDecision'] -slug: /tools/sdk/powershell/v3/models/non-employee-approval-decision -tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalDecision'] ---- - - -# NonEmployeeApprovalDecision - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Comment** | Pointer to **String** | Comment on the approval item. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeApprovalDecision = Initialize-PSSailpoint.V3NonEmployeeApprovalDecision -Comment Approved by manager -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeApprovalDecision | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeApprovalItem.md b/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeApprovalItem.md deleted file mode 100644 index 24cc18804..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeApprovalItem.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: non-employee-approval-item -title: NonEmployeeApprovalItem -pagination_label: NonEmployeeApprovalItem -sidebar_label: NonEmployeeApprovalItem -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeApprovalItem'] -slug: /tools/sdk/powershell/v3/models/non-employee-approval-item -tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItem'] ---- - - -# NonEmployeeApprovalItem - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Non-Employee approval item id | [optional] -**Approver** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] -**AccountName** | Pointer to **String** | Requested identity account name | [optional] -**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] -**ApprovalOrder** | Pointer to **Double** | Approval order | [optional] -**Comment** | Pointer to **String** | comment of approver | [optional] -**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] -**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] -**NonEmployeeRequest** | Pointer to [**NonEmployeeRequestLite**](non-employee-request-lite) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeApprovalItem = Initialize-PSSailpoint.V3NonEmployeeApprovalItem -Id 2c1e388b-1e55-4b0a-ab5c-897f1204159c ` - -Approver null ` - -AccountName test.account ` - -ApprovalStatus null ` - -ApprovalOrder 1 ` - -Comment I approve ` - -Modified 2019-08-23T18:52:59.162Z ` - -Created 2019-08-23T18:40:35.772Z ` - -NonEmployeeRequest null -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeApprovalItem | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeApprovalItemBase.md b/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeApprovalItemBase.md deleted file mode 100644 index baa0d965a..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeApprovalItemBase.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: non-employee-approval-item-base -title: NonEmployeeApprovalItemBase -pagination_label: NonEmployeeApprovalItemBase -sidebar_label: NonEmployeeApprovalItemBase -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeApprovalItemBase'] -slug: /tools/sdk/powershell/v3/models/non-employee-approval-item-base -tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItemBase'] ---- - - -# NonEmployeeApprovalItemBase - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Non-Employee approval item id | [optional] -**Approver** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] -**AccountName** | Pointer to **String** | Requested identity account name | [optional] -**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] -**ApprovalOrder** | Pointer to **Double** | Approval order | [optional] -**Comment** | Pointer to **String** | comment of approver | [optional] -**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] -**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeApprovalItemBase = Initialize-PSSailpoint.V3NonEmployeeApprovalItemBase -Id 2c1e388b-1e55-4b0a-ab5c-897f1204159c ` - -Approver null ` - -AccountName test.account ` - -ApprovalStatus null ` - -ApprovalOrder 1 ` - -Comment I approve ` - -Modified 2019-08-23T18:52:59.162Z ` - -Created 2019-08-23T18:40:35.772Z -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeApprovalItemBase | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeApprovalItemDetail.md b/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeApprovalItemDetail.md deleted file mode 100644 index c81f731da..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeApprovalItemDetail.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: non-employee-approval-item-detail -title: NonEmployeeApprovalItemDetail -pagination_label: NonEmployeeApprovalItemDetail -sidebar_label: NonEmployeeApprovalItemDetail -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeApprovalItemDetail'] -slug: /tools/sdk/powershell/v3/models/non-employee-approval-item-detail -tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItemDetail'] ---- - - -# NonEmployeeApprovalItemDetail - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Non-Employee approval item id | [optional] -**Approver** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] -**AccountName** | Pointer to **String** | Requested identity account name | [optional] -**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] -**ApprovalOrder** | Pointer to **Double** | Approval order | [optional] -**Comment** | Pointer to **String** | comment of approver | [optional] -**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] -**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] -**NonEmployeeRequest** | Pointer to [**NonEmployeeRequestWithoutApprovalItem**](non-employee-request-without-approval-item) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeApprovalItemDetail = Initialize-PSSailpoint.V3NonEmployeeApprovalItemDetail -Id 2c1e388b-1e55-4b0a-ab5c-897f1204159c ` - -Approver null ` - -AccountName test.account ` - -ApprovalStatus null ` - -ApprovalOrder 1 ` - -Comment I approve ` - -Modified 2019-08-23T18:52:59.162Z ` - -Created 2019-08-23T18:40:35.772Z ` - -NonEmployeeRequest null -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeApprovalItemDetail | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeApprovalSummary.md b/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeApprovalSummary.md deleted file mode 100644 index 02e06229f..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeApprovalSummary.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: non-employee-approval-summary -title: NonEmployeeApprovalSummary -pagination_label: NonEmployeeApprovalSummary -sidebar_label: NonEmployeeApprovalSummary -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeApprovalSummary'] -slug: /tools/sdk/powershell/v3/models/non-employee-approval-summary -tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalSummary'] ---- - - -# NonEmployeeApprovalSummary - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Approved** | Pointer to **Int32** | The number of approved non-employee approval requests. | [optional] -**Pending** | Pointer to **Int32** | The number of pending non-employee approval requests. | [optional] -**Rejected** | Pointer to **Int32** | The number of rejected non-employee approval requests. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeApprovalSummary = Initialize-PSSailpoint.V3NonEmployeeApprovalSummary -Approved 2 ` - -Pending 2 ` - -Rejected 2 -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeApprovalSummary | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeBulkUploadJob.md b/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeBulkUploadJob.md deleted file mode 100644 index 3c729268f..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeBulkUploadJob.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: non-employee-bulk-upload-job -title: NonEmployeeBulkUploadJob -pagination_label: NonEmployeeBulkUploadJob -sidebar_label: NonEmployeeBulkUploadJob -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeBulkUploadJob'] -slug: /tools/sdk/powershell/v3/models/non-employee-bulk-upload-job -tags: ['SDK', 'Software Development Kit', 'NonEmployeeBulkUploadJob'] ---- - - -# NonEmployeeBulkUploadJob - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The bulk upload job's ID. (UUID) | [optional] -**SourceId** | Pointer to **String** | The ID of the source to bulk-upload non-employees to. (UUID) | [optional] -**Created** | Pointer to **System.DateTime** | The date-time the job was submitted. | [optional] -**Modified** | Pointer to **System.DateTime** | The date-time that the job was last updated. | [optional] -**Status** | Pointer to **Enum** [ "PENDING", "IN_PROGRESS", "COMPLETED", "ERROR" ] | Returns the following values indicating the progress or result of the bulk upload job. ""PENDING"" means the job is queued and waiting to be processed. ""IN_PROGRESS"" means the job is currently being processed. ""COMPLETED"" means the job has been completed without any errors. ""ERROR"" means the job failed to process with errors. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeBulkUploadJob = Initialize-PSSailpoint.V3NonEmployeeBulkUploadJob -Id 2c91808568c529c60168cca6f90cffff ` - -SourceId 2c91808568c529c60168cca6f90c1313 ` - -Created 2019-08-23T18:52:59.162Z ` - -Modified 2019-08-23T18:52:59.162Z ` - -Status PENDING -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeBulkUploadJob | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeBulkUploadStatus.md b/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeBulkUploadStatus.md deleted file mode 100644 index 6ee2e4e3c..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeBulkUploadStatus.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: non-employee-bulk-upload-status -title: NonEmployeeBulkUploadStatus -pagination_label: NonEmployeeBulkUploadStatus -sidebar_label: NonEmployeeBulkUploadStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeBulkUploadStatus'] -slug: /tools/sdk/powershell/v3/models/non-employee-bulk-upload-status -tags: ['SDK', 'Software Development Kit', 'NonEmployeeBulkUploadStatus'] ---- - - -# NonEmployeeBulkUploadStatus - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Status** | Pointer to **Enum** [ "PENDING", "IN_PROGRESS", "COMPLETED", "ERROR" ] | Returns the following values indicating the progress or result of the bulk upload job. ""PENDING"" means the job is queued and waiting to be processed. ""IN_PROGRESS"" means the job is currently being processed. ""COMPLETED"" means the job has been completed without any errors. ""ERROR"" means the job failed to process with errors. null means job has been submitted to the source. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeBulkUploadStatus = Initialize-PSSailpoint.V3NonEmployeeBulkUploadStatus -Status PENDING -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeBulkUploadStatus | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeIdentityDtoType.md b/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeIdentityDtoType.md deleted file mode 100644 index 48a62dabd..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeIdentityDtoType.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: non-employee-identity-dto-type -title: NonEmployeeIdentityDtoType -pagination_label: NonEmployeeIdentityDtoType -sidebar_label: NonEmployeeIdentityDtoType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeIdentityDtoType'] -slug: /tools/sdk/powershell/v3/models/non-employee-identity-dto-type -tags: ['SDK', 'Software Development Kit', 'NonEmployeeIdentityDtoType'] ---- - - -# NonEmployeeIdentityDtoType - -## Enum - - -* `GOVERNANCE_GROUP` (value: `"GOVERNANCE_GROUP"`) - -* `IDENTITY` (value: `"IDENTITY"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeIdentityReferenceWithId.md b/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeIdentityReferenceWithId.md deleted file mode 100644 index c4452b00e..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeIdentityReferenceWithId.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: non-employee-identity-reference-with-id -title: NonEmployeeIdentityReferenceWithId -pagination_label: NonEmployeeIdentityReferenceWithId -sidebar_label: NonEmployeeIdentityReferenceWithId -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeIdentityReferenceWithId'] -slug: /tools/sdk/powershell/v3/models/non-employee-identity-reference-with-id -tags: ['SDK', 'Software Development Kit', 'NonEmployeeIdentityReferenceWithId'] ---- - - -# NonEmployeeIdentityReferenceWithId - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to [**NonEmployeeIdentityDtoType**](non-employee-identity-dto-type) | | [optional] -**Id** | Pointer to **String** | Identity id | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeIdentityReferenceWithId = Initialize-PSSailpoint.V3NonEmployeeIdentityReferenceWithId -Type null ` - -Id 5168015d32f890ca15812c9180835d2e -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeIdentityReferenceWithId | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeIdnUserRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeIdnUserRequest.md deleted file mode 100644 index 0057af9b3..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeIdnUserRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: non-employee-idn-user-request -title: NonEmployeeIdnUserRequest -pagination_label: NonEmployeeIdnUserRequest -sidebar_label: NonEmployeeIdnUserRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeIdnUserRequest'] -slug: /tools/sdk/powershell/v3/models/non-employee-idn-user-request -tags: ['SDK', 'Software Development Kit', 'NonEmployeeIdnUserRequest'] ---- - - -# NonEmployeeIdnUserRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | Identity id. | [required] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeIdnUserRequest = Initialize-PSSailpoint.V3NonEmployeeIdnUserRequest -Id 2c91808570313110017040b06f344ec9 -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeIdnUserRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeRecord.md b/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeRecord.md deleted file mode 100644 index 7d175d500..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeRecord.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -id: non-employee-record -title: NonEmployeeRecord -pagination_label: NonEmployeeRecord -sidebar_label: NonEmployeeRecord -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRecord'] -slug: /tools/sdk/powershell/v3/models/non-employee-record -tags: ['SDK', 'Software Development Kit', 'NonEmployeeRecord'] ---- - - -# NonEmployeeRecord - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Non-Employee record id. | [optional] -**AccountName** | Pointer to **String** | Requested identity account name. | [optional] -**FirstName** | Pointer to **String** | Non-Employee's first name. | [optional] -**LastName** | Pointer to **String** | Non-Employee's last name. | [optional] -**Email** | Pointer to **String** | Non-Employee's email. | [optional] -**Phone** | Pointer to **String** | Non-Employee's phone. | [optional] -**Manager** | Pointer to **String** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] -**SourceId** | Pointer to **String** | Non-Employee's source id. | [optional] -**VarData** | Pointer to **map[string]String** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] -**StartDate** | Pointer to **System.DateTime** | Non-Employee employment start date. | [optional] -**EndDate** | Pointer to **System.DateTime** | Non-Employee employment end date. | [optional] -**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] -**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeRecord = Initialize-PSSailpoint.V3NonEmployeeRecord -Id ef38f94347e94562b5bb8424a56397d8 ` - -AccountName Abby.Smith ` - -FirstName William ` - -LastName Smith ` - -Email william.smith@example.com ` - -Phone 5125555555 ` - -Manager jane.doe ` - -SourceId 2c91808568c529c60168cca6f90c1313 ` - -VarData {description=Auditing} ` - -StartDate 2019-08-23T18:52:59.162Z ` - -EndDate 2020-08-23T18:52:59.162Z ` - -Modified 2019-08-23T18:52:59.162Z ` - -Created 2019-08-23T18:40:35.772Z -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeRecord | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeRejectApprovalDecision.md b/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeRejectApprovalDecision.md deleted file mode 100644 index 9f38b9155..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeRejectApprovalDecision.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: non-employee-reject-approval-decision -title: NonEmployeeRejectApprovalDecision -pagination_label: NonEmployeeRejectApprovalDecision -sidebar_label: NonEmployeeRejectApprovalDecision -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRejectApprovalDecision'] -slug: /tools/sdk/powershell/v3/models/non-employee-reject-approval-decision -tags: ['SDK', 'Software Development Kit', 'NonEmployeeRejectApprovalDecision'] ---- - - -# NonEmployeeRejectApprovalDecision - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Comment** | **String** | Comment on the approval item. | [required] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeRejectApprovalDecision = Initialize-PSSailpoint.V3NonEmployeeRejectApprovalDecision -Comment approved -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeRejectApprovalDecision | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeRequest.md deleted file mode 100644 index 923b979cf..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeRequest.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -id: non-employee-request -title: NonEmployeeRequest -pagination_label: NonEmployeeRequest -sidebar_label: NonEmployeeRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRequest'] -slug: /tools/sdk/powershell/v3/models/non-employee-request -tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequest'] ---- - - -# NonEmployeeRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Non-Employee source id. | [optional] -**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] -**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] -**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] -**AccountName** | Pointer to **String** | Requested identity account name. | [optional] -**FirstName** | Pointer to **String** | Non-Employee's first name. | [optional] -**LastName** | Pointer to **String** | Non-Employee's last name. | [optional] -**Email** | Pointer to **String** | Non-Employee's email. | [optional] -**Phone** | Pointer to **String** | Non-Employee's phone. | [optional] -**Manager** | Pointer to **String** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] -**NonEmployeeSource** | Pointer to [**NonEmployeeSourceLite**](non-employee-source-lite) | | [optional] -**VarData** | Pointer to **map[string]String** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] -**ApprovalItems** | Pointer to [**[]NonEmployeeApprovalItemBase**](non-employee-approval-item-base) | List of approval item for the request | [optional] -**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] -**Comment** | Pointer to **String** | Comment of requester | [optional] -**CompletionDate** | Pointer to **System.DateTime** | When the request was completely approved. | [optional] -**StartDate** | Pointer to **System.DateTime** | Non-Employee employment start date. | [optional] -**EndDate** | Pointer to **System.DateTime** | Non-Employee employment end date. | [optional] -**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] -**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeRequest = Initialize-PSSailpoint.V3NonEmployeeRequest -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` - -SourceId 2c91808568c529c60168cca6f90c1313 ` - -Name Retail ` - -Description Source description ` - -AccountName william.smith ` - -FirstName William ` - -LastName Smith ` - -Email william.smith@example.com ` - -Phone 5125555555 ` - -Manager jane.doe ` - -NonEmployeeSource null ` - -VarData {description=Auditing} ` - -ApprovalItems null ` - -ApprovalStatus null ` - -Comment approved ` - -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate 2020-03-24T00:00-05:00 ` - -EndDate 2021-03-25T00:00-05:00 ` - -Modified 2020-03-24T11:11:41.139-05:00 ` - -Created 2020-03-24T11:11:41.139-05:00 -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeRequestBody.md b/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeRequestBody.md deleted file mode 100644 index d5b23004d..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeRequestBody.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: non-employee-request-body -title: NonEmployeeRequestBody -pagination_label: NonEmployeeRequestBody -sidebar_label: NonEmployeeRequestBody -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRequestBody'] -slug: /tools/sdk/powershell/v3/models/non-employee-request-body -tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestBody'] ---- - - -# NonEmployeeRequestBody - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccountName** | **String** | Requested identity account name. | [required] -**FirstName** | **String** | Non-Employee's first name. | [required] -**LastName** | **String** | Non-Employee's last name. | [required] -**Email** | **String** | Non-Employee's email. | [required] -**Phone** | **String** | Non-Employee's phone. | [required] -**Manager** | **String** | The account ID of a valid identity to serve as this non-employee's manager. | [required] -**SourceId** | **String** | Non-Employee's source id. | [required] -**VarData** | Pointer to **map[string]String** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] -**StartDate** | **System.DateTime** | Non-Employee employment start date. | [required] -**EndDate** | **System.DateTime** | Non-Employee employment end date. | [required] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeRequestBody = Initialize-PSSailpoint.V3NonEmployeeRequestBody -AccountName william.smith ` - -FirstName William ` - -LastName Smith ` - -Email william.smith@example.com ` - -Phone 5125555555 ` - -Manager jane.doe ` - -SourceId 2c91808568c529c60168cca6f90c1313 ` - -VarData {description=Auditing} ` - -StartDate 2020-03-24T00:00-05:00 ` - -EndDate 2021-03-25T00:00-05:00 -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeRequestBody | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeRequestLite.md b/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeRequestLite.md deleted file mode 100644 index 578a80706..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeRequestLite.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: non-employee-request-lite -title: NonEmployeeRequestLite -pagination_label: NonEmployeeRequestLite -sidebar_label: NonEmployeeRequestLite -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRequestLite'] -slug: /tools/sdk/powershell/v3/models/non-employee-request-lite -tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestLite'] ---- - - -# NonEmployeeRequestLite - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Non-Employee request id. | [optional] -**Requester** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeRequestLite = Initialize-PSSailpoint.V3NonEmployeeRequestLite -Id ac110005-7156-1150-8171-5b292e3e0084 ` - -Requester null -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeRequestLite | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeRequestSummary.md b/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeRequestSummary.md deleted file mode 100644 index cc33f3cde..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeRequestSummary.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: non-employee-request-summary -title: NonEmployeeRequestSummary -pagination_label: NonEmployeeRequestSummary -sidebar_label: NonEmployeeRequestSummary -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRequestSummary'] -slug: /tools/sdk/powershell/v3/models/non-employee-request-summary -tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestSummary'] ---- - - -# NonEmployeeRequestSummary - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Approved** | Pointer to **Int32** | The number of approved non-employee requests on all sources that *requested-for* user manages. | [optional] -**Rejected** | Pointer to **Int32** | The number of rejected non-employee requests on all sources that *requested-for* user manages. | [optional] -**Pending** | Pointer to **Int32** | The number of pending non-employee requests on all sources that *requested-for* user manages. | [optional] -**NonEmployeeCount** | Pointer to **Int32** | The number of non-employee records on all sources that *requested-for* user manages. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeRequestSummary = Initialize-PSSailpoint.V3NonEmployeeRequestSummary -Approved 2 ` - -Rejected 2 ` - -Pending 2 ` - -NonEmployeeCount 2 -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeRequestSummary | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeRequestWithoutApprovalItem.md deleted file mode 100644 index 7bc4d008c..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeRequestWithoutApprovalItem.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -id: non-employee-request-without-approval-item -title: NonEmployeeRequestWithoutApprovalItem -pagination_label: NonEmployeeRequestWithoutApprovalItem -sidebar_label: NonEmployeeRequestWithoutApprovalItem -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRequestWithoutApprovalItem'] -slug: /tools/sdk/powershell/v3/models/non-employee-request-without-approval-item -tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestWithoutApprovalItem'] ---- - - -# NonEmployeeRequestWithoutApprovalItem - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Non-Employee request id. | [optional] -**Requester** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] -**AccountName** | Pointer to **String** | Requested identity account name. | [optional] -**FirstName** | Pointer to **String** | Non-Employee's first name. | [optional] -**LastName** | Pointer to **String** | Non-Employee's last name. | [optional] -**Email** | Pointer to **String** | Non-Employee's email. | [optional] -**Phone** | Pointer to **String** | Non-Employee's phone. | [optional] -**Manager** | Pointer to **String** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] -**NonEmployeeSource** | Pointer to [**NonEmployeeSourceLiteWithSchemaAttributes**](non-employee-source-lite-with-schema-attributes) | | [optional] -**VarData** | Pointer to **map[string]String** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] -**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] -**Comment** | Pointer to **String** | Comment of requester | [optional] -**CompletionDate** | Pointer to **System.DateTime** | When the request was completely approved. | [optional] -**StartDate** | Pointer to **System.DateTime** | Non-Employee employment start date. | [optional] -**EndDate** | Pointer to **System.DateTime** | Non-Employee employment end date. | [optional] -**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] -**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V3NonEmployeeRequestWithoutApprovalItem -Id ac110005-7156-1150-8171-5b292e3e0084 ` - -Requester null ` - -AccountName william.smith ` - -FirstName William ` - -LastName Smith ` - -Email william.smith@example.com ` - -Phone 5125555555 ` - -Manager jane.doe ` - -NonEmployeeSource null ` - -VarData {description=Auditing} ` - -ApprovalStatus null ` - -Comment approved ` - -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Mon Mar 23 20:00:00 EDT 2020 ` - -EndDate Wed Mar 24 20:00:00 EDT 2021 ` - -Modified 2020-03-24T11:11:41.139-05:00 ` - -Created 2020-03-24T11:11:41.139-05:00 -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeRequestWithoutApprovalItem | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeSchemaAttribute.md b/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeSchemaAttribute.md deleted file mode 100644 index 406db2f2a..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeSchemaAttribute.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: non-employee-schema-attribute -title: NonEmployeeSchemaAttribute -pagination_label: NonEmployeeSchemaAttribute -sidebar_label: NonEmployeeSchemaAttribute -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSchemaAttribute'] -slug: /tools/sdk/powershell/v3/models/non-employee-schema-attribute -tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttribute'] ---- - - -# NonEmployeeSchemaAttribute - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Schema Attribute Id | [optional] -**System** | Pointer to **Boolean** | True if this schema attribute is mandatory on all non-employees sources. | [optional] [default to $false] -**Modified** | Pointer to **System.DateTime** | When the schema attribute was last modified. | [optional] -**Created** | Pointer to **System.DateTime** | When the schema attribute was created. | [optional] -**Type** | [**NonEmployeeSchemaAttributeType**](non-employee-schema-attribute-type) | | [required] -**Label** | **String** | Label displayed on the UI for this schema attribute. | [required] -**TechnicalName** | **String** | The technical name of the attribute. Must be unique per source. | [required] -**HelpText** | Pointer to **String** | help text displayed by UI. | [optional] -**Placeholder** | Pointer to **String** | Hint text that fills UI box. | [optional] -**Required** | Pointer to **Boolean** | If true, the schema attribute is required for all non-employees in the source | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeSchemaAttribute = Initialize-PSSailpoint.V3NonEmployeeSchemaAttribute -Id ac110005-7156-1150-8171-5b292e3e0084 ` - -System true ` - -Modified 2019-08-23T18:52:59.162Z ` - -Created 2019-08-23T18:40:35.772Z ` - -Type null ` - -Label Account Name ` - -TechnicalName account.name ` - -HelpText The unique identifier for the account ` - -Placeholder Enter a unique user name for this account. ` - -Required true -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeSchemaAttribute | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeSchemaAttributeBody.md b/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeSchemaAttributeBody.md deleted file mode 100644 index 0b1b9b494..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeSchemaAttributeBody.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: non-employee-schema-attribute-body -title: NonEmployeeSchemaAttributeBody -pagination_label: NonEmployeeSchemaAttributeBody -sidebar_label: NonEmployeeSchemaAttributeBody -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSchemaAttributeBody'] -slug: /tools/sdk/powershell/v3/models/non-employee-schema-attribute-body -tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttributeBody'] ---- - - -# NonEmployeeSchemaAttributeBody - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **String** | Type of the attribute. Only type 'TEXT' is supported for custom attributes. | [required] -**Label** | **String** | Label displayed on the UI for this schema attribute. | [required] -**TechnicalName** | **String** | The technical name of the attribute. Must be unique per source. | [required] -**HelpText** | Pointer to **String** | help text displayed by UI. | [optional] -**Placeholder** | Pointer to **String** | Hint text that fills UI box. | [optional] -**Required** | Pointer to **Boolean** | If true, the schema attribute is required for all non-employees in the source | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeSchemaAttributeBody = Initialize-PSSailpoint.V3NonEmployeeSchemaAttributeBody -Type TEXT ` - -Label Account Name ` - -TechnicalName account.name ` - -HelpText The unique identifier for the account ` - -Placeholder Enter a unique user name for this account. ` - -Required true -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeSchemaAttributeBody | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeSchemaAttributeType.md b/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeSchemaAttributeType.md deleted file mode 100644 index 66a47bab0..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeSchemaAttributeType.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: non-employee-schema-attribute-type -title: NonEmployeeSchemaAttributeType -pagination_label: NonEmployeeSchemaAttributeType -sidebar_label: NonEmployeeSchemaAttributeType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSchemaAttributeType'] -slug: /tools/sdk/powershell/v3/models/non-employee-schema-attribute-type -tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttributeType'] ---- - - -# NonEmployeeSchemaAttributeType - -## Enum - - -* `TEXT` (value: `"TEXT"`) - -* `DATE` (value: `"DATE"`) - -* `IDENTITY` (value: `"IDENTITY"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeSource.md b/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeSource.md deleted file mode 100644 index e4519688b..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeSource.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: non-employee-source -title: NonEmployeeSource -pagination_label: NonEmployeeSource -sidebar_label: NonEmployeeSource -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSource'] -slug: /tools/sdk/powershell/v3/models/non-employee-source -tags: ['SDK', 'Software Development Kit', 'NonEmployeeSource'] ---- - - -# NonEmployeeSource - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Non-Employee source id. | [optional] -**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] -**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] -**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] -**Approvers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of approvers | [optional] -**AccountManagers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] -**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] -**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeSource = Initialize-PSSailpoint.V3NonEmployeeSource -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` - -SourceId 2c91808568c529c60168cca6f90c1313 ` - -Name Retail ` - -Description Source description ` - -Approvers null ` - -AccountManagers null ` - -Modified 2019-08-23T18:52:59.162Z ` - -Created 2019-08-23T18:40:35.772Z -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeSource | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeSourceLite.md b/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeSourceLite.md deleted file mode 100644 index f692e0964..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeSourceLite.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: non-employee-source-lite -title: NonEmployeeSourceLite -pagination_label: NonEmployeeSourceLite -sidebar_label: NonEmployeeSourceLite -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSourceLite'] -slug: /tools/sdk/powershell/v3/models/non-employee-source-lite -tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceLite'] ---- - - -# NonEmployeeSourceLite - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Non-Employee source id. | [optional] -**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] -**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] -**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeSourceLite = Initialize-PSSailpoint.V3NonEmployeeSourceLite -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` - -SourceId 2c91808568c529c60168cca6f90c1313 ` - -Name Retail ` - -Description Source description -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeSourceLite | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeSourceLiteWithSchemaAttributes.md b/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeSourceLiteWithSchemaAttributes.md deleted file mode 100644 index d686de43a..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeSourceLiteWithSchemaAttributes.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: non-employee-source-lite-with-schema-attributes -title: NonEmployeeSourceLiteWithSchemaAttributes -pagination_label: NonEmployeeSourceLiteWithSchemaAttributes -sidebar_label: NonEmployeeSourceLiteWithSchemaAttributes -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSourceLiteWithSchemaAttributes'] -slug: /tools/sdk/powershell/v3/models/non-employee-source-lite-with-schema-attributes -tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceLiteWithSchemaAttributes'] ---- - - -# NonEmployeeSourceLiteWithSchemaAttributes - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Non-Employee source id. | [optional] -**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] -**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] -**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] -**SchemaAttributes** | Pointer to [**[]NonEmployeeSchemaAttribute**](non-employee-schema-attribute) | List of schema attributes associated with this non-employee source. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeSourceLiteWithSchemaAttributes = Initialize-PSSailpoint.V3NonEmployeeSourceLiteWithSchemaAttributes -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` - -SourceId 2c91808568c529c60168cca6f90c1313 ` - -Name Retail ` - -Description Source description ` - -SchemaAttributes null -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeSourceLiteWithSchemaAttributes | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeSourceRequestBody.md b/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeSourceRequestBody.md deleted file mode 100644 index b73679d6f..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeSourceRequestBody.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: non-employee-source-request-body -title: NonEmployeeSourceRequestBody -pagination_label: NonEmployeeSourceRequestBody -sidebar_label: NonEmployeeSourceRequestBody -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSourceRequestBody'] -slug: /tools/sdk/powershell/v3/models/non-employee-source-request-body -tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceRequestBody'] ---- - - -# NonEmployeeSourceRequestBody - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | Name of non-employee source. | [required] -**Description** | **String** | Description of non-employee source. | [required] -**Owner** | [**NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | | [required] -**ManagementWorkgroup** | Pointer to **String** | The ID for the management workgroup that contains source sub-admins | [optional] -**Approvers** | Pointer to [**[]NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | List of approvers. | [optional] -**AccountManagers** | Pointer to [**[]NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | List of account managers. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeSourceRequestBody = Initialize-PSSailpoint.V3NonEmployeeSourceRequestBody -Name Retail ` - -Description Source description ` - -Owner null ` - -ManagementWorkgroup 123299 ` - -Approvers null ` - -AccountManagers null -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeSourceRequestBody | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeSourceWithCloudExternalId.md b/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeSourceWithCloudExternalId.md deleted file mode 100644 index 299d23212..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeSourceWithCloudExternalId.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: non-employee-source-with-cloud-external-id -title: NonEmployeeSourceWithCloudExternalId -pagination_label: NonEmployeeSourceWithCloudExternalId -sidebar_label: NonEmployeeSourceWithCloudExternalId -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSourceWithCloudExternalId'] -slug: /tools/sdk/powershell/v3/models/non-employee-source-with-cloud-external-id -tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceWithCloudExternalId'] ---- - - -# NonEmployeeSourceWithCloudExternalId - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Non-Employee source id. | [optional] -**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] -**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] -**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] -**Approvers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of approvers | [optional] -**AccountManagers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] -**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] -**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] -**CloudExternalId** | Pointer to **String** | Legacy ID used for sources from the V1 API. This attribute will be removed from a future version of the API and will not be considered a breaking change. No clients should rely on this ID always being present. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeSourceWithCloudExternalId = Initialize-PSSailpoint.V3NonEmployeeSourceWithCloudExternalId -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` - -SourceId 2c91808568c529c60168cca6f90c1313 ` - -Name Retail ` - -Description Source description ` - -Approvers null ` - -AccountManagers null ` - -Modified 2019-08-23T18:52:59.162Z ` - -Created 2019-08-23T18:40:35.772Z ` - -CloudExternalId 99999 -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeSourceWithCloudExternalId | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeSourceWithNECount.md b/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeSourceWithNECount.md deleted file mode 100644 index c167171ea..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/NonEmployeeSourceWithNECount.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: non-employee-source-with-ne-count -title: NonEmployeeSourceWithNECount -pagination_label: NonEmployeeSourceWithNECount -sidebar_label: NonEmployeeSourceWithNECount -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSourceWithNECount'] -slug: /tools/sdk/powershell/v3/models/non-employee-source-with-ne-count -tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceWithNECount'] ---- - - -# NonEmployeeSourceWithNECount - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Non-Employee source id. | [optional] -**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] -**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] -**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] -**Approvers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of approvers | [optional] -**AccountManagers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] -**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] -**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] -**NonEmployeeCount** | Pointer to **Int32** | Number of non-employee records associated with this source. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeSourceWithNECount = Initialize-PSSailpoint.V3NonEmployeeSourceWithNECount -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` - -SourceId 2c91808568c529c60168cca6f90c1313 ` - -Name Retail ` - -Description Source description ` - -Approvers null ` - -AccountManagers null ` - -Modified 2019-08-23T18:52:59.162Z ` - -Created 2019-08-23T18:40:35.772Z ` - -NonEmployeeCount 120 -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeSourceWithNECount | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ObjectExportImportNames.md b/docs/tools/sdk/powershell/reference/v3/Models/ObjectExportImportNames.md deleted file mode 100644 index 407e75f1e..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ObjectExportImportNames.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: object-export-import-names -title: ObjectExportImportNames -pagination_label: ObjectExportImportNames -sidebar_label: ObjectExportImportNames -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectExportImportNames'] -slug: /tools/sdk/powershell/v3/models/object-export-import-names -tags: ['SDK', 'Software Development Kit', 'ObjectExportImportNames'] ---- - - -# ObjectExportImportNames - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IncludedNames** | Pointer to **[]String** | Object names to be included in a backup. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ObjectExportImportNames = Initialize-PSSailpoint.V3ObjectExportImportNames -IncludedNames null -``` - -- Convert the resource to JSON -```powershell -$ObjectExportImportNames | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ObjectImportResult.md b/docs/tools/sdk/powershell/reference/v3/Models/ObjectImportResult.md deleted file mode 100644 index 2bdfd115a..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ObjectImportResult.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: object-import-result -title: ObjectImportResult -pagination_label: ObjectImportResult -sidebar_label: ObjectImportResult -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectImportResult'] -slug: /tools/sdk/powershell/v3/models/object-import-result -tags: ['SDK', 'Software Development Kit', 'ObjectImportResult'] ---- - - -# ObjectImportResult - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Infos** | [**[]SpConfigMessage**](sp-config-message) | Informational messages returned from the target service on import. | [required] -**Warnings** | [**[]SpConfigMessage**](sp-config-message) | Warning messages returned from the target service on import. | [required] -**Errors** | [**[]SpConfigMessage**](sp-config-message) | Error messages returned from the target service on import. | [required] -**ImportedObjects** | [**[]ImportObject**](import-object) | References to objects that were created or updated by the import. | [required] - -## Examples - -- Prepare the resource -```powershell -$ObjectImportResult = Initialize-PSSailpoint.V3ObjectImportResult -Infos null ` - -Warnings null ` - -Errors null ` - -ImportedObjects null -``` - -- Convert the resource to JSON -```powershell -$ObjectImportResult | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ObjectMappingBulkCreateRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/ObjectMappingBulkCreateRequest.md deleted file mode 100644 index 65bf9a78d..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ObjectMappingBulkCreateRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: object-mapping-bulk-create-request -title: ObjectMappingBulkCreateRequest -pagination_label: ObjectMappingBulkCreateRequest -sidebar_label: ObjectMappingBulkCreateRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectMappingBulkCreateRequest'] -slug: /tools/sdk/powershell/v3/models/object-mapping-bulk-create-request -tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkCreateRequest'] ---- - - -# ObjectMappingBulkCreateRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**NewObjectsMappings** | [**[]ObjectMappingRequest**](object-mapping-request) | | [required] - -## Examples - -- Prepare the resource -```powershell -$ObjectMappingBulkCreateRequest = Initialize-PSSailpoint.V3ObjectMappingBulkCreateRequest -NewObjectsMappings null -``` - -- Convert the resource to JSON -```powershell -$ObjectMappingBulkCreateRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ObjectMappingBulkCreateResponse.md b/docs/tools/sdk/powershell/reference/v3/Models/ObjectMappingBulkCreateResponse.md deleted file mode 100644 index b7889b936..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ObjectMappingBulkCreateResponse.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: object-mapping-bulk-create-response -title: ObjectMappingBulkCreateResponse -pagination_label: ObjectMappingBulkCreateResponse -sidebar_label: ObjectMappingBulkCreateResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectMappingBulkCreateResponse'] -slug: /tools/sdk/powershell/v3/models/object-mapping-bulk-create-response -tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkCreateResponse'] ---- - - -# ObjectMappingBulkCreateResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AddedObjects** | Pointer to [**[]ObjectMappingResponse**](object-mapping-response) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ObjectMappingBulkCreateResponse = Initialize-PSSailpoint.V3ObjectMappingBulkCreateResponse -AddedObjects null -``` - -- Convert the resource to JSON -```powershell -$ObjectMappingBulkCreateResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ObjectMappingBulkPatchRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/ObjectMappingBulkPatchRequest.md deleted file mode 100644 index 8de767528..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ObjectMappingBulkPatchRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: object-mapping-bulk-patch-request -title: ObjectMappingBulkPatchRequest -pagination_label: ObjectMappingBulkPatchRequest -sidebar_label: ObjectMappingBulkPatchRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectMappingBulkPatchRequest'] -slug: /tools/sdk/powershell/v3/models/object-mapping-bulk-patch-request -tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkPatchRequest'] ---- - - -# ObjectMappingBulkPatchRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Patches** | [**map[string]JsonPatchOperation[]**](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_arrays?view=powershell-7.4) | Map of id of the object mapping to a JsonPatchOperation describing what to patch on that object mapping. | [required] - -## Examples - -- Prepare the resource -```powershell -$ObjectMappingBulkPatchRequest = Initialize-PSSailpoint.V3ObjectMappingBulkPatchRequest -Patches {603b1a61-d03d-4ed1-864f-a508fbd1995d=[{op=replace, path=/enabled, value=true}], 00bece34-f50d-4227-8878-76f620b5a971=[{op=replace, path=/targetValue, value=New Target Value}]} -``` - -- Convert the resource to JSON -```powershell -$ObjectMappingBulkPatchRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ObjectMappingBulkPatchResponse.md b/docs/tools/sdk/powershell/reference/v3/Models/ObjectMappingBulkPatchResponse.md deleted file mode 100644 index 81db80fdb..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ObjectMappingBulkPatchResponse.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: object-mapping-bulk-patch-response -title: ObjectMappingBulkPatchResponse -pagination_label: ObjectMappingBulkPatchResponse -sidebar_label: ObjectMappingBulkPatchResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectMappingBulkPatchResponse'] -slug: /tools/sdk/powershell/v3/models/object-mapping-bulk-patch-response -tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkPatchResponse'] ---- - - -# ObjectMappingBulkPatchResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**PatchedObjects** | Pointer to [**[]ObjectMappingResponse**](object-mapping-response) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ObjectMappingBulkPatchResponse = Initialize-PSSailpoint.V3ObjectMappingBulkPatchResponse -PatchedObjects null -``` - -- Convert the resource to JSON -```powershell -$ObjectMappingBulkPatchResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ObjectMappingRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/ObjectMappingRequest.md deleted file mode 100644 index 72327a1ea..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ObjectMappingRequest.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: object-mapping-request -title: ObjectMappingRequest -pagination_label: ObjectMappingRequest -sidebar_label: ObjectMappingRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectMappingRequest'] -slug: /tools/sdk/powershell/v3/models/object-mapping-request -tags: ['SDK', 'Software Development Kit', 'ObjectMappingRequest'] ---- - - -# ObjectMappingRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ObjectType** | **Enum** [ "ACCESS_PROFILE", "ACCESS_REQUEST_CONFIG", "ATTR_SYNC_SOURCE_CONFIG", "AUTH_ORG", "CAMPAIGN_FILTER", "ENTITLEMENT", "FORM_DEFINITION", "GOVERNANCE_GROUP", "IDENTITY", "IDENTITY_OBJECT_CONFIG", "IDENTITY_PROFILE", "LIFECYCLE_STATE", "NOTIFICATION_TEMPLATE", "PASSWORD_POLICY", "PASSWORD_SYNC_GROUP", "PUBLIC_IDENTITIES_CONFIG", "ROLE", "RULE", "SEGMENT", "SERVICE_DESK_INTEGRATION", "SOD_POLICY", "SOURCE", "TAG", "TRANSFORM", "TRIGGER_SUBSCRIPTION", "WORKFLOW" ] | Type of the object the mapping value applies to, must be one from enum | [required] -**JsonPath** | **String** | JSONPath expression denoting the path within the object where the mapping value should be applied | [required] -**SourceValue** | **String** | Original value at the jsonPath location within the object | [required] -**TargetValue** | **String** | Value to be assigned at the jsonPath location within the object | [required] -**Enabled** | Pointer to **Boolean** | Whether or not this object mapping is enabled | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$ObjectMappingRequest = Initialize-PSSailpoint.V3ObjectMappingRequest -ObjectType IDENTITY ` - -JsonPath $.name ` - -SourceValue My Governance Group Name ` - -TargetValue My New Governance Group Name ` - -Enabled false -``` - -- Convert the resource to JSON -```powershell -$ObjectMappingRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ObjectMappingResponse.md b/docs/tools/sdk/powershell/reference/v3/Models/ObjectMappingResponse.md deleted file mode 100644 index ffc463397..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ObjectMappingResponse.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: object-mapping-response -title: ObjectMappingResponse -pagination_label: ObjectMappingResponse -sidebar_label: ObjectMappingResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectMappingResponse'] -slug: /tools/sdk/powershell/v3/models/object-mapping-response -tags: ['SDK', 'Software Development Kit', 'ObjectMappingResponse'] ---- - - -# ObjectMappingResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ObjectMappingId** | Pointer to **String** | Id of the object mapping | [optional] -**ObjectType** | Pointer to **Enum** [ "ACCESS_PROFILE", "ACCESS_REQUEST_CONFIG", "ATTR_SYNC_SOURCE_CONFIG", "AUTH_ORG", "CAMPAIGN_FILTER", "ENTITLEMENT", "FORM_DEFINITION", "GOVERNANCE_GROUP", "IDENTITY", "IDENTITY_OBJECT_CONFIG", "IDENTITY_PROFILE", "LIFECYCLE_STATE", "NOTIFICATION_TEMPLATE", "PASSWORD_POLICY", "PASSWORD_SYNC_GROUP", "PUBLIC_IDENTITIES_CONFIG", "ROLE", "RULE", "SEGMENT", "SERVICE_DESK_INTEGRATION", "SOD_POLICY", "SOURCE", "TAG", "TRANSFORM", "TRIGGER_SUBSCRIPTION", "WORKFLOW" ] | Type of the object the mapping value applies to | [optional] -**JsonPath** | Pointer to **String** | JSONPath expression denoting the path within the object where the mapping value should be applied | [optional] -**SourceValue** | Pointer to **String** | Original value at the jsonPath location within the object | [optional] -**TargetValue** | Pointer to **String** | Value to be assigned at the jsonPath location within the object | [optional] -**Enabled** | Pointer to **Boolean** | Whether or not this object mapping is enabled | [optional] [default to $false] -**Created** | Pointer to **String** | Object mapping creation timestamp | [optional] -**Modified** | Pointer to **String** | Object mapping latest update timestamp | [optional] - -## Examples - -- Prepare the resource -```powershell -$ObjectMappingResponse = Initialize-PSSailpoint.V3ObjectMappingResponse -ObjectMappingId 3d6e0144-963f-4bd6-8d8d-d77b4e507ce4 ` - -ObjectType IDENTITY ` - -JsonPath $.name ` - -SourceValue My Governance Group Name ` - -TargetValue My New Governance Group Name ` - -Enabled false ` - -Created 2024-03-19T23:18:53.732Z ` - -Modified 2024-03-19T23:18:53.732Z -``` - -- Convert the resource to JSON -```powershell -$ObjectMappingResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/OktaVerificationRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/OktaVerificationRequest.md deleted file mode 100644 index d6f345e2f..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/OktaVerificationRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: okta-verification-request -title: OktaVerificationRequest -pagination_label: OktaVerificationRequest -sidebar_label: OktaVerificationRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'OktaVerificationRequest'] -slug: /tools/sdk/powershell/v3/models/okta-verification-request -tags: ['SDK', 'Software Development Kit', 'OktaVerificationRequest'] ---- - - -# OktaVerificationRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**UserId** | **String** | User identifier for Verification request. The value of the user's attribute. | [required] - -## Examples - -- Prepare the resource -```powershell -$OktaVerificationRequest = Initialize-PSSailpoint.V3OktaVerificationRequest -UserId example@mail.com -``` - -- Convert the resource to JSON -```powershell -$OktaVerificationRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Operation.md b/docs/tools/sdk/powershell/reference/v3/Models/Operation.md deleted file mode 100644 index 9f8200d62..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Operation.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: operation -title: Operation -pagination_label: Operation -sidebar_label: Operation -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Operation'] -slug: /tools/sdk/powershell/v3/models/operation -tags: ['SDK', 'Software Development Kit', 'Operation'] ---- - - -# Operation - -## Enum - - -* `EQUALS` (value: `"EQUALS"`) - -* `NOT_EQUALS` (value: `"NOT_EQUALS"`) - -* `CONTAINS` (value: `"CONTAINS"`) - -* `STARTS_WITH` (value: `"STARTS_WITH"`) - -* `ENDS_WITH` (value: `"ENDS_WITH"`) - -* `AND` (value: `"AND"`) - -* `OR` (value: `"OR"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/OriginalRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/OriginalRequest.md deleted file mode 100644 index d3a1c7e29..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/OriginalRequest.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: original-request -title: OriginalRequest -pagination_label: OriginalRequest -sidebar_label: OriginalRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'OriginalRequest'] -slug: /tools/sdk/powershell/v3/models/original-request -tags: ['SDK', 'Software Development Kit', 'OriginalRequest'] ---- - - -# OriginalRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccountId** | Pointer to **String** | Account ID. | [optional] -**AttributeRequests** | Pointer to [**[]AttributeRequest**](attribute-request) | Attribute changes requested for account. | [optional] -**Op** | Pointer to **String** | Operation used. | [optional] -**Source** | Pointer to [**AccountSource**](account-source) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$OriginalRequest = Initialize-PSSailpoint.V3OriginalRequest -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` - -AttributeRequests null ` - -Op add ` - -Source null -``` - -- Convert the resource to JSON -```powershell -$OriginalRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/OrphanIdentitiesReportArguments.md b/docs/tools/sdk/powershell/reference/v3/Models/OrphanIdentitiesReportArguments.md deleted file mode 100644 index e5c378747..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/OrphanIdentitiesReportArguments.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: orphan-identities-report-arguments -title: OrphanIdentitiesReportArguments -pagination_label: OrphanIdentitiesReportArguments -sidebar_label: OrphanIdentitiesReportArguments -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'OrphanIdentitiesReportArguments'] -slug: /tools/sdk/powershell/v3/models/orphan-identities-report-arguments -tags: ['SDK', 'Software Development Kit', 'OrphanIdentitiesReportArguments'] ---- - - -# OrphanIdentitiesReportArguments - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**SelectedFormats** | Pointer to **[]String** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] - -## Examples - -- Prepare the resource -```powershell -$OrphanIdentitiesReportArguments = Initialize-PSSailpoint.V3OrphanIdentitiesReportArguments -SelectedFormats [CSV] -``` - -- Convert the resource to JSON -```powershell -$OrphanIdentitiesReportArguments | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/OwnerDto.md b/docs/tools/sdk/powershell/reference/v3/Models/OwnerDto.md deleted file mode 100644 index 50125ceed..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/OwnerDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: owner-dto -title: OwnerDto -pagination_label: OwnerDto -sidebar_label: OwnerDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'OwnerDto'] -slug: /tools/sdk/powershell/v3/models/owner-dto -tags: ['SDK', 'Software Development Kit', 'OwnerDto'] ---- - - -# OwnerDto - -## 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 name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$OwnerDto = Initialize-PSSailpoint.V3OwnerDto -Type IDENTITY ` - -Id 2c9180a46faadee4016fb4e018c20639 ` - -Name Support -``` - -- Convert the resource to JSON -```powershell -$OwnerDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/OwnerReference.md b/docs/tools/sdk/powershell/reference/v3/Models/OwnerReference.md deleted file mode 100644 index 44e2ea485..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/OwnerReference.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: owner-reference -title: OwnerReference -pagination_label: OwnerReference -sidebar_label: OwnerReference -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'OwnerReference'] -slug: /tools/sdk/powershell/v3/models/owner-reference -tags: ['SDK', 'Software Development Kit', 'OwnerReference'] ---- - - -# OwnerReference - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] -**Id** | Pointer to **String** | Identity id | [optional] -**Name** | Pointer to **String** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] - -## Examples - -- Prepare the resource -```powershell -$OwnerReference = Initialize-PSSailpoint.V3OwnerReference -Type IDENTITY ` - -Id 2c9180a46faadee4016fb4e018c20639 ` - -Name support -``` - -- Convert the resource to JSON -```powershell -$OwnerReference | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/OwnerReferenceSegments.md b/docs/tools/sdk/powershell/reference/v3/Models/OwnerReferenceSegments.md deleted file mode 100644 index b126ee150..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/OwnerReferenceSegments.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: owner-reference-segments -title: OwnerReferenceSegments -pagination_label: OwnerReferenceSegments -sidebar_label: OwnerReferenceSegments -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'OwnerReferenceSegments'] -slug: /tools/sdk/powershell/v3/models/owner-reference-segments -tags: ['SDK', 'Software Development Kit', 'OwnerReferenceSegments'] ---- - - -# OwnerReferenceSegments - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] -**Id** | Pointer to **String** | Identity id | [optional] -**Name** | Pointer to **String** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] - -## Examples - -- Prepare the resource -```powershell -$OwnerReferenceSegments = Initialize-PSSailpoint.V3OwnerReferenceSegments -Type IDENTITY ` - -Id 2c9180a46faadee4016fb4e018c20639 ` - -Name support -``` - -- Convert the resource to JSON -```powershell -$OwnerReferenceSegments | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Owns.md b/docs/tools/sdk/powershell/reference/v3/Models/Owns.md deleted file mode 100644 index 945033faa..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Owns.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: owns -title: Owns -pagination_label: Owns -sidebar_label: Owns -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Owns'] -slug: /tools/sdk/powershell/v3/models/owns -tags: ['SDK', 'Software Development Kit', 'Owns'] ---- - - -# Owns - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Sources** | Pointer to [**[]Reference1**](reference1) | | [optional] -**Entitlements** | Pointer to [**[]Reference1**](reference1) | | [optional] -**AccessProfiles** | Pointer to [**[]Reference1**](reference1) | | [optional] -**Roles** | Pointer to [**[]Reference1**](reference1) | | [optional] -**Apps** | Pointer to [**[]Reference1**](reference1) | | [optional] -**GovernanceGroups** | Pointer to [**[]Reference1**](reference1) | | [optional] -**FallbackApprover** | Pointer to **Boolean** | | [optional] - -## Examples - -- Prepare the resource -```powershell -$Owns = Initialize-PSSailpoint.V3Owns -Sources null ` - -Entitlements null ` - -AccessProfiles null ` - -Roles null ` - -Apps null ` - -GovernanceGroups null ` - -FallbackApprover false -``` - -- Convert the resource to JSON -```powershell -$Owns | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/PasswordChangeRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/PasswordChangeRequest.md deleted file mode 100644 index 93d4e1fda..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/PasswordChangeRequest.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: password-change-request -title: PasswordChangeRequest -pagination_label: PasswordChangeRequest -sidebar_label: PasswordChangeRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordChangeRequest'] -slug: /tools/sdk/powershell/v3/models/password-change-request -tags: ['SDK', 'Software Development Kit', 'PasswordChangeRequest'] ---- - - -# PasswordChangeRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IdentityId** | Pointer to **String** | The identity ID that requested the password change | [optional] -**EncryptedPassword** | Pointer to **String** | The RSA encrypted password | [optional] -**PublicKeyId** | Pointer to **String** | The encryption key ID | [optional] -**AccountId** | Pointer to **String** | Account ID of the account This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 | [optional] -**SourceId** | Pointer to **String** | The ID of the source for which identity is requesting the password change | [optional] - -## Examples - -- Prepare the resource -```powershell -$PasswordChangeRequest = Initialize-PSSailpoint.V3PasswordChangeRequest -IdentityId 8a807d4c73c545510173c545f0a002ff ` - -EncryptedPassword XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A== ` - -PublicKeyId YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2 ` - -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` - -SourceId 8a807d4c73c545510173c545d4b60246 -``` - -- Convert the resource to JSON -```powershell -$PasswordChangeRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/PasswordChangeResponse.md b/docs/tools/sdk/powershell/reference/v3/Models/PasswordChangeResponse.md deleted file mode 100644 index 9bcb2d065..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/PasswordChangeResponse.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: password-change-response -title: PasswordChangeResponse -pagination_label: PasswordChangeResponse -sidebar_label: PasswordChangeResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordChangeResponse'] -slug: /tools/sdk/powershell/v3/models/password-change-response -tags: ['SDK', 'Software Development Kit', 'PasswordChangeResponse'] ---- - - -# PasswordChangeResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RequestId** | Pointer to **String** | The password change request ID | [optional] -**State** | Pointer to **Enum** [ "IN_PROGRESS", "FINISHED", "FAILED" ] | Password change state | [optional] - -## Examples - -- Prepare the resource -```powershell -$PasswordChangeResponse = Initialize-PSSailpoint.V3PasswordChangeResponse -RequestId 089899f13a8f4da7824996191587bab9 ` - -State IN_PROGRESS -``` - -- Convert the resource to JSON -```powershell -$PasswordChangeResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/PasswordInfo.md b/docs/tools/sdk/powershell/reference/v3/Models/PasswordInfo.md deleted file mode 100644 index f964c7883..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/PasswordInfo.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: password-info -title: PasswordInfo -pagination_label: PasswordInfo -sidebar_label: PasswordInfo -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordInfo'] -slug: /tools/sdk/powershell/v3/models/password-info -tags: ['SDK', 'Software Development Kit', 'PasswordInfo'] ---- - - -# PasswordInfo - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IdentityId** | Pointer to **String** | Identity ID | [optional] -**SourceId** | Pointer to **String** | source ID | [optional] -**PublicKeyId** | Pointer to **String** | public key ID | [optional] -**PublicKey** | Pointer to **String** | User's public key with Base64 encoding | [optional] -**Accounts** | Pointer to [**[]PasswordInfoAccount**](password-info-account) | Account info related to queried identity and source | [optional] -**Policies** | Pointer to **[]String** | Password constraints | [optional] - -## Examples - -- Prepare the resource -```powershell -$PasswordInfo = Initialize-PSSailpoint.V3PasswordInfo -IdentityId 2c918085744fec4301746f9a5bce4605 ` - -SourceId 2c918083746f642c01746f990884012a ` - -PublicKeyId N2M1OTJiMGEtMDJlZS00ZWU3LTkyYTEtNjA5YmI5NWE3ZWVh ` - -PublicKey MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuGFkWi2J75TztpbaPKd36bJnIB3J8gZ6UcoS9oSDYsqBzPpTsfZXYaEf4Y4BKGgJIXmE/lwhwuj7mU1itdZ2qTSNFtnXA8Fn75c3UUkk+h+wdZbkuSmqlsJo3R1OnJkwkJggcAy9Jvk9jlcrNLWorpQ1w9raUvxtvfgkSdq153KxotenQ1HciSyZ0nA/Kw0UaucLnho8xdRowZs11afXGXA9IT9H6D8T6zUdtSxm0nAyH+mluma5LdTfaM50W3l/L8q56Vrqmx2pZIiwdx/0+g3Y++jV70zom0ZBkC1MmSoLMrQYG5OICNjr72f78B2PaGXfarQHqARLjKpMVt9YIQIDAQAB ` - -Accounts null ` - -Policies [passwordRepeatedChar is 3, passwordMinAlpha is 1, passwordMinLength is 5, passwordMinNumeric is 1] -``` - -- Convert the resource to JSON -```powershell -$PasswordInfo | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/PasswordInfoAccount.md b/docs/tools/sdk/powershell/reference/v3/Models/PasswordInfoAccount.md deleted file mode 100644 index 402fa89e1..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/PasswordInfoAccount.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: password-info-account -title: PasswordInfoAccount -pagination_label: PasswordInfoAccount -sidebar_label: PasswordInfoAccount -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordInfoAccount'] -slug: /tools/sdk/powershell/v3/models/password-info-account -tags: ['SDK', 'Software Development Kit', 'PasswordInfoAccount'] ---- - - -# PasswordInfoAccount - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccountId** | Pointer to **String** | Account ID of the account. This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 | [optional] -**AccountName** | Pointer to **String** | Display name of the account. This is specified per account schema in the source configuration. It is used to display name of the account. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-Name-for/ta-p/74008 | [optional] - -## Examples - -- Prepare the resource -```powershell -$PasswordInfoAccount = Initialize-PSSailpoint.V3PasswordInfoAccount -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` - -AccountName Abby.Smith -``` - -- Convert the resource to JSON -```powershell -$PasswordInfoAccount | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/PasswordInfoQueryDTO.md b/docs/tools/sdk/powershell/reference/v3/Models/PasswordInfoQueryDTO.md deleted file mode 100644 index e9fda4786..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/PasswordInfoQueryDTO.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: password-info-query-dto -title: PasswordInfoQueryDTO -pagination_label: PasswordInfoQueryDTO -sidebar_label: PasswordInfoQueryDTO -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordInfoQueryDTO'] -slug: /tools/sdk/powershell/v3/models/password-info-query-dto -tags: ['SDK', 'Software Development Kit', 'PasswordInfoQueryDTO'] ---- - - -# PasswordInfoQueryDTO - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**UserName** | Pointer to **String** | The login name of the user | [optional] -**SourceName** | Pointer to **String** | The display name of the source | [optional] - -## Examples - -- Prepare the resource -```powershell -$PasswordInfoQueryDTO = Initialize-PSSailpoint.V3PasswordInfoQueryDTO -UserName Abby.Smith ` - -SourceName My-AD -``` - -- Convert the resource to JSON -```powershell -$PasswordInfoQueryDTO | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/PasswordOrgConfig.md b/docs/tools/sdk/powershell/reference/v3/Models/PasswordOrgConfig.md deleted file mode 100644 index 54b34f2ec..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/PasswordOrgConfig.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: password-org-config -title: PasswordOrgConfig -pagination_label: PasswordOrgConfig -sidebar_label: PasswordOrgConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordOrgConfig'] -slug: /tools/sdk/powershell/v3/models/password-org-config -tags: ['SDK', 'Software Development Kit', 'PasswordOrgConfig'] ---- - - -# PasswordOrgConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CustomInstructionsEnabled** | Pointer to **Boolean** | Indicator whether custom password instructions feature is enabled. The default value is false. | [optional] [default to $false] -**DigitTokenEnabled** | Pointer to **Boolean** | Indicator whether ""digit token"" feature is enabled. The default value is false. | [optional] [default to $false] -**DigitTokenDurationMinutes** | Pointer to **Int32** | The duration of ""digit token"" in minutes. The default value is 5. | [optional] [default to 5] -**DigitTokenLength** | Pointer to **Int32** | The length of ""digit token"". The default value is 6. | [optional] [default to 6] - -## Examples - -- Prepare the resource -```powershell -$PasswordOrgConfig = Initialize-PSSailpoint.V3PasswordOrgConfig -CustomInstructionsEnabled true ` - -DigitTokenEnabled true ` - -DigitTokenDurationMinutes 10 ` - -DigitTokenLength 9 -``` - -- Convert the resource to JSON -```powershell -$PasswordOrgConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/PasswordPolicyV3Dto.md b/docs/tools/sdk/powershell/reference/v3/Models/PasswordPolicyV3Dto.md deleted file mode 100644 index fadd267a6..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/PasswordPolicyV3Dto.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -id: password-policy-v3-dto -title: PasswordPolicyV3Dto -pagination_label: PasswordPolicyV3Dto -sidebar_label: PasswordPolicyV3Dto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordPolicyV3Dto'] -slug: /tools/sdk/powershell/v3/models/password-policy-v3-dto -tags: ['SDK', 'Software Development Kit', 'PasswordPolicyV3Dto'] ---- - - -# PasswordPolicyV3Dto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The password policy Id. | [optional] -**Description** | Pointer to **String** | Description for current password policy. | [optional] -**Name** | Pointer to **String** | The name of the password policy. | [optional] -**DateCreated** | Pointer to **System.DateTime** | Date the Password Policy was created. | [optional] -**LastUpdated** | Pointer to **System.DateTime** | Date the Password Policy was updated. | [optional] -**FirstExpirationReminder** | Pointer to **Int64** | The number of days before expiration remaninder. | [optional] -**AccountIdMinWordLength** | Pointer to **Int64** | The minimun length of account Id. By default is equals to -1. | [optional] -**AccountNameMinWordLength** | Pointer to **Int64** | The minimun length of account name. By default is equals to -1. | [optional] -**MinAlpha** | Pointer to **Int64** | Maximum alpha. By default is equals to 0. | [optional] -**MinCharacterTypes** | Pointer to **Int64** | MinCharacterTypes. By default is equals to -1. | [optional] -**MaxLength** | Pointer to **Int64** | Maximum length of the password. | [optional] -**MinLength** | Pointer to **Int64** | Minimum length of the password. By default is equals to 0. | [optional] -**MaxRepeatedChars** | Pointer to **Int64** | Maximum repetition of the same character in the password. By default is equals to -1. | [optional] -**MinLower** | Pointer to **Int64** | Minimum amount of lower case character in the password. By default is equals to 0. | [optional] -**MinNumeric** | Pointer to **Int64** | Minimum amount of numeric characters in the password. By default is equals to 0. | [optional] -**MinSpecial** | Pointer to **Int64** | Minimum amount of special symbols in the password. By default is equals to 0. | [optional] -**MinUpper** | Pointer to **Int64** | Minimum amount of upper case symbols in the password. By default is equals to 0. | [optional] -**PasswordExpiration** | Pointer to **Int64** | Number of days before current password expires. By default is equals to 90. | [optional] -**DefaultPolicy** | Pointer to **Boolean** | Defines whether this policy is default or not. Default policy is created automatically when an org is setup. This field is false by default. | [optional] [default to $false] -**EnablePasswdExpiration** | Pointer to **Boolean** | Defines whether this policy is enabled to expire or not. This field is false by default. | [optional] [default to $false] -**RequireStrongAuthn** | Pointer to **Boolean** | Defines whether this policy require strong Auth or not. This field is false by default. | [optional] [default to $false] -**RequireStrongAuthOffNetwork** | Pointer to **Boolean** | Defines whether this policy require strong Auth of network or not. This field is false by default. | [optional] [default to $false] -**RequireStrongAuthUntrustedGeographies** | Pointer to **Boolean** | Defines whether this policy require strong Auth for untrusted geographies. This field is false by default. | [optional] [default to $false] -**UseAccountAttributes** | Pointer to **Boolean** | Defines whether this policy uses account attributes or not. This field is false by default. | [optional] [default to $false] -**UseDictionary** | Pointer to **Boolean** | Defines whether this policy uses dictionary or not. This field is false by default. | [optional] [default to $false] -**UseIdentityAttributes** | Pointer to **Boolean** | Defines whether this policy uses identity attributes or not. This field is false by default. | [optional] [default to $false] -**ValidateAgainstAccountId** | Pointer to **Boolean** | Defines whether this policy validate against account id or not. This field is false by default. | [optional] [default to $false] -**ValidateAgainstAccountName** | Pointer to **Boolean** | Defines whether this policy validate against account name or not. This field is false by default. | [optional] [default to $false] -**Created** | Pointer to **String** | | [optional] -**Modified** | Pointer to **String** | | [optional] -**SourceIds** | Pointer to **[]String** | List of sources IDs managed by this password policy. | [optional] - -## Examples - -- Prepare the resource -```powershell -$PasswordPolicyV3Dto = Initialize-PSSailpoint.V3PasswordPolicyV3Dto -Id 2c91808e7d976f3b017d9f5ceae440c8 ` - -Description Information about the Password Policy ` - -Name PasswordPolicy Example ` - -DateCreated null ` - -LastUpdated null ` - -FirstExpirationReminder 45 ` - -AccountIdMinWordLength 4 ` - -AccountNameMinWordLength 6 ` - -MinAlpha 5 ` - -MinCharacterTypes 5 ` - -MaxLength 25 ` - -MinLength 8 ` - -MaxRepeatedChars 3 ` - -MinLower 8 ` - -MinNumeric 8 ` - -MinSpecial 8 ` - -MinUpper 8 ` - -PasswordExpiration 8 ` - -DefaultPolicy true ` - -EnablePasswdExpiration true ` - -RequireStrongAuthn true ` - -RequireStrongAuthOffNetwork true ` - -RequireStrongAuthUntrustedGeographies true ` - -UseAccountAttributes false ` - -UseDictionary false ` - -UseIdentityAttributes false ` - -ValidateAgainstAccountId false ` - -ValidateAgainstAccountName true ` - -Created null ` - -Modified null ` - -SourceIds [2c91808382ffee0b01830de154f14034, 2f98808382ffee0b01830de154f12134] -``` - -- Convert the resource to JSON -```powershell -$PasswordPolicyV3Dto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/PasswordStatus.md b/docs/tools/sdk/powershell/reference/v3/Models/PasswordStatus.md deleted file mode 100644 index 2a8074195..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/PasswordStatus.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: password-status -title: PasswordStatus -pagination_label: PasswordStatus -sidebar_label: PasswordStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordStatus'] -slug: /tools/sdk/powershell/v3/models/password-status -tags: ['SDK', 'Software Development Kit', 'PasswordStatus'] ---- - - -# PasswordStatus - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RequestId** | Pointer to **String** | The password change request ID | [optional] -**State** | Pointer to **Enum** [ "IN_PROGRESS", "FINISHED", "FAILED" ] | Password change state | [optional] -**Errors** | Pointer to **[]String** | The errors during the password change request | [optional] -**SourceIds** | Pointer to **[]String** | List of source IDs in the password change request | [optional] - -## Examples - -- Prepare the resource -```powershell -$PasswordStatus = Initialize-PSSailpoint.V3PasswordStatus -RequestId 089899f13a8f4da7824996191587bab9 ` - -State IN_PROGRESS ` - -Errors [The password change payload is invalid] ` - -SourceIds [2c918083746f642c01746f990884012a] -``` - -- Convert the resource to JSON -```powershell -$PasswordStatus | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/PasswordSyncGroup.md b/docs/tools/sdk/powershell/reference/v3/Models/PasswordSyncGroup.md deleted file mode 100644 index d17e8a983..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/PasswordSyncGroup.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: password-sync-group -title: PasswordSyncGroup -pagination_label: PasswordSyncGroup -sidebar_label: PasswordSyncGroup -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordSyncGroup'] -slug: /tools/sdk/powershell/v3/models/password-sync-group -tags: ['SDK', 'Software Development Kit', 'PasswordSyncGroup'] ---- - - -# PasswordSyncGroup - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | ID of the sync group | [optional] -**Name** | Pointer to **String** | Name of the sync group | [optional] -**PasswordPolicyId** | Pointer to **String** | ID of the password policy | [optional] -**SourceIds** | Pointer to **[]String** | List of password managed sources IDs | [optional] -**Created** | Pointer to **System.DateTime** | The date and time this sync group was created | [optional] -**Modified** | Pointer to **System.DateTime** | The date and time this sync group was last modified | [optional] - -## Examples - -- Prepare the resource -```powershell -$PasswordSyncGroup = Initialize-PSSailpoint.V3PasswordSyncGroup -Id 6881f631-3bd5-4213-9c75-8e05cc3e35dd ` - -Name Password Sync Group 1 ` - -PasswordPolicyId 2c91808d744ba0ce01746f93b6204501 ` - -SourceIds [2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500] ` - -Created 2023-03-16T04:00Z ` - -Modified 2023-03-16T04:00Z -``` - -- Convert the resource to JSON -```powershell -$PasswordSyncGroup | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/PatOwner.md b/docs/tools/sdk/powershell/reference/v3/Models/PatOwner.md deleted file mode 100644 index 672c3fc3d..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/PatOwner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: pat-owner -title: PatOwner -pagination_label: PatOwner -sidebar_label: PatOwner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PatOwner'] -slug: /tools/sdk/powershell/v3/models/pat-owner -tags: ['SDK', 'Software Development Kit', 'PatOwner'] ---- - - -# PatOwner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | Personal access token owner's DTO type. | [optional] -**Id** | Pointer to **String** | Personal access token owner's identity ID. | [optional] -**Name** | Pointer to **String** | Personal access token owner's human-readable display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$PatOwner = Initialize-PSSailpoint.V3PatOwner -Type IDENTITY ` - -Id 2c9180a46faadee4016fb4e018c20639 ` - -Name Support -``` - -- Convert the resource to JSON -```powershell -$PatOwner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/PatchServiceDeskIntegrationRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/PatchServiceDeskIntegrationRequest.md deleted file mode 100644 index 911a4c4ca..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/PatchServiceDeskIntegrationRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: patch-service-desk-integration-request -title: PatchServiceDeskIntegrationRequest -pagination_label: PatchServiceDeskIntegrationRequest -sidebar_label: PatchServiceDeskIntegrationRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PatchServiceDeskIntegrationRequest'] -slug: /tools/sdk/powershell/v3/models/patch-service-desk-integration-request -tags: ['SDK', 'Software Development Kit', 'PatchServiceDeskIntegrationRequest'] ---- - - -# PatchServiceDeskIntegrationRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operations** | Pointer to [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] - -## Examples - -- Prepare the resource -```powershell -$PatchServiceDeskIntegrationRequest = Initialize-PSSailpoint.V3PatchServiceDeskIntegrationRequest -Operations null -``` - -- Convert the resource to JSON -```powershell -$PatchServiceDeskIntegrationRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/PendingApproval.md b/docs/tools/sdk/powershell/reference/v3/Models/PendingApproval.md deleted file mode 100644 index 02b385256..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/PendingApproval.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: pending-approval -title: PendingApproval -pagination_label: PendingApproval -sidebar_label: PendingApproval -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PendingApproval'] -slug: /tools/sdk/powershell/v3/models/pending-approval -tags: ['SDK', 'Software Development Kit', 'PendingApproval'] ---- - - -# PendingApproval - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The approval id. | [optional] -**Name** | Pointer to **String** | The name of the approval. | [optional] -**Created** | Pointer to **System.DateTime** | When the approval was created. | [optional] -**Modified** | Pointer to **System.DateTime** | When the approval was modified last time. | [optional] -**RequestCreated** | Pointer to **System.DateTime** | When the access-request was created. | [optional] -**RequestType** | Pointer to [**AccessRequestType**](access-request-type) | | [optional] -**Requester** | Pointer to [**AccessItemRequester**](access-item-requester) | | [optional] -**RequestedFor** | Pointer to [**[]AccessItemRequestedFor**](access-item-requested-for) | Identities access was requested for. | [optional] -**Owner** | Pointer to [**PendingApprovalOwner**](pending-approval-owner) | | [optional] -**RequestedObject** | Pointer to [**RequestableObjectReference**](requestable-object-reference) | | [optional] -**RequesterComment** | Pointer to [**CommentDto**](comment-dto) | | [optional] -**PreviousReviewersComments** | Pointer to [**[]CommentDto**](comment-dto) | The history of the previous reviewers comments. | [optional] -**ForwardHistory** | Pointer to [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] -**CommentRequiredWhenRejected** | Pointer to **Boolean** | When true the rejector has to provide comments when rejecting | [optional] [default to $false] -**ActionInProcess** | Pointer to [**PendingApprovalAction**](pending-approval-action) | | [optional] -**RemoveDate** | Pointer to **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] -**RemoveDateUpdateRequested** | Pointer to **Boolean** | If true, then the request is to change the remove date or sunset date. | [optional] [default to $false] -**CurrentRemoveDate** | Pointer to **System.DateTime** | The remove date or sunset date that was assigned at the time of the request. | [optional] -**SodViolationContext** | Pointer to [**SodViolationContextCheckCompleted**](sod-violation-context-check-completed) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$PendingApproval = Initialize-PSSailpoint.V3PendingApproval -Id id12345 ` - -Name aName ` - -Created 2017-07-11T18:45:37.098Z ` - -Modified 2018-07-25T20:22:28.104Z ` - -RequestCreated 2017-07-11T18:45:35.098Z ` - -RequestType null ` - -Requester null ` - -RequestedFor null ` - -Owner null ` - -RequestedObject null ` - -RequesterComment null ` - -PreviousReviewersComments null ` - -ForwardHistory null ` - -CommentRequiredWhenRejected true ` - -ActionInProcess null ` - -RemoveDate 2020-07-11T00:00Z ` - -RemoveDateUpdateRequested true ` - -CurrentRemoveDate 2020-07-11T00:00Z ` - -SodViolationContext null -``` - -- Convert the resource to JSON -```powershell -$PendingApproval | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/PendingApprovalAction.md b/docs/tools/sdk/powershell/reference/v3/Models/PendingApprovalAction.md deleted file mode 100644 index 02fc09bcb..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/PendingApprovalAction.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: pending-approval-action -title: PendingApprovalAction -pagination_label: PendingApprovalAction -sidebar_label: PendingApprovalAction -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PendingApprovalAction'] -slug: /tools/sdk/powershell/v3/models/pending-approval-action -tags: ['SDK', 'Software Development Kit', 'PendingApprovalAction'] ---- - - -# PendingApprovalAction - -## Enum - - -* `APPROVED` (value: `"APPROVED"`) - -* `REJECTED` (value: `"REJECTED"`) - -* `FORWARDED` (value: `"FORWARDED"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/PendingApprovalOwner.md b/docs/tools/sdk/powershell/reference/v3/Models/PendingApprovalOwner.md deleted file mode 100644 index fa7485921..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/PendingApprovalOwner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: pending-approval-owner -title: PendingApprovalOwner -pagination_label: PendingApprovalOwner -sidebar_label: PendingApprovalOwner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PendingApprovalOwner'] -slug: /tools/sdk/powershell/v3/models/pending-approval-owner -tags: ['SDK', 'Software Development Kit', 'PendingApprovalOwner'] ---- - - -# PendingApprovalOwner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | Access item owner's DTO type. | [optional] -**Id** | Pointer to **String** | Access item owner's identity ID. | [optional] -**Name** | Pointer to **String** | Access item owner's human-readable display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$PendingApprovalOwner = Initialize-PSSailpoint.V3PendingApprovalOwner -Type IDENTITY ` - -Id 2c9180a46faadee4016fb4e018c20639 ` - -Name Support -``` - -- Convert the resource to JSON -```powershell -$PendingApprovalOwner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/PermissionDto.md b/docs/tools/sdk/powershell/reference/v3/Models/PermissionDto.md deleted file mode 100644 index 423634c05..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/PermissionDto.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: permission-dto -title: PermissionDto -pagination_label: PermissionDto -sidebar_label: PermissionDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PermissionDto'] -slug: /tools/sdk/powershell/v3/models/permission-dto -tags: ['SDK', 'Software Development Kit', 'PermissionDto'] ---- - - -# PermissionDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Rights** | Pointer to **[]String** | All the rights (e.g. actions) that this permission allows on the target | [optional] [readonly] -**Target** | Pointer to **String** | The target the permission would grants rights on. | [optional] [readonly] - -## Examples - -- Prepare the resource -```powershell -$PermissionDto = Initialize-PSSailpoint.V3PermissionDto -Rights null ` - -Target SYS.GV_$TRANSACTION -``` - -- Convert the resource to JSON -```powershell -$PermissionDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/PreApprovalTriggerDetails.md b/docs/tools/sdk/powershell/reference/v3/Models/PreApprovalTriggerDetails.md deleted file mode 100644 index f3811ea39..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/PreApprovalTriggerDetails.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: pre-approval-trigger-details -title: PreApprovalTriggerDetails -pagination_label: PreApprovalTriggerDetails -sidebar_label: PreApprovalTriggerDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PreApprovalTriggerDetails'] -slug: /tools/sdk/powershell/v3/models/pre-approval-trigger-details -tags: ['SDK', 'Software Development Kit', 'PreApprovalTriggerDetails'] ---- - - -# PreApprovalTriggerDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Comment** | Pointer to **String** | Comment left for the pre-approval decision | [optional] -**Reviewer** | Pointer to **String** | The reviewer of the pre-approval decision | [optional] -**Decision** | Pointer to **Enum** [ "APPROVED", "REJECTED" ] | The decision of the pre-approval trigger | [optional] - -## Examples - -- Prepare the resource -```powershell -$PreApprovalTriggerDetails = Initialize-PSSailpoint.V3PreApprovalTriggerDetails -Comment Access is Approved ` - -Reviewer John Doe ` - -Decision APPROVED -``` - -- Convert the resource to JSON -```powershell -$PreApprovalTriggerDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ProcessingDetails.md b/docs/tools/sdk/powershell/reference/v3/Models/ProcessingDetails.md deleted file mode 100644 index bca3f3cd3..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ProcessingDetails.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: processing-details -title: ProcessingDetails -pagination_label: ProcessingDetails -sidebar_label: ProcessingDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ProcessingDetails'] -slug: /tools/sdk/powershell/v3/models/processing-details -tags: ['SDK', 'Software Development Kit', 'ProcessingDetails'] ---- - - -# ProcessingDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Date** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional] -**Stage** | Pointer to **String** | | [optional] -**RetryCount** | Pointer to **Int32** | | [optional] -**VarStackTrace** | Pointer to **String** | | [optional] -**Message** | Pointer to **String** | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ProcessingDetails = Initialize-PSSailpoint.V3ProcessingDetails -Date 2018-06-25T20:22:28.104Z ` - -Stage In Process ` - -RetryCount 0 ` - -VarStackTrace <stack trace> ` - -Message <message> -``` - -- Convert the resource to JSON -```powershell -$ProcessingDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningConfig.md b/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningConfig.md deleted file mode 100644 index ef2a7a1ca..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningConfig.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: provisioning-config -title: ProvisioningConfig -pagination_label: ProvisioningConfig -sidebar_label: ProvisioningConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningConfig'] -slug: /tools/sdk/powershell/v3/models/provisioning-config -tags: ['SDK', 'Software Development Kit', 'ProvisioningConfig'] ---- - - -# ProvisioningConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**UniversalManager** | Pointer to **Boolean** | Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. | [optional] [readonly] [default to $false] -**ManagedResourceRefs** | Pointer to [**[]ServiceDeskSource**](service-desk-source) | References to sources for the Service Desk integration template. May only be specified if universalManager is false. | [optional] -**PlanInitializerScript** | Pointer to [**ProvisioningConfigPlanInitializerScript**](provisioning-config-plan-initializer-script) | | [optional] -**NoProvisioningRequests** | Pointer to **Boolean** | Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. | [optional] [default to $false] -**ProvisioningRequestExpiration** | Pointer to **Int32** | When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ProvisioningConfig = Initialize-PSSailpoint.V3ProvisioningConfig -UniversalManager true ` - -ManagedResourceRefs [{type=SOURCE, id=2c9180855d191c59015d291ceb051111, name=My Source 1}, {type=SOURCE, id=2c9180855d191c59015d291ceb052222, name=My Source 2}] ` - -PlanInitializerScript null ` - -NoProvisioningRequests true ` - -ProvisioningRequestExpiration 7 -``` - -- Convert the resource to JSON -```powershell -$ProvisioningConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningConfigPlanInitializerScript.md b/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningConfigPlanInitializerScript.md deleted file mode 100644 index 72544f976..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningConfigPlanInitializerScript.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -id: provisioning-config-plan-initializer-script -title: ProvisioningConfigPlanInitializerScript -pagination_label: ProvisioningConfigPlanInitializerScript -sidebar_label: ProvisioningConfigPlanInitializerScript -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningConfigPlanInitializerScript'] -slug: /tools/sdk/powershell/v3/models/provisioning-config-plan-initializer-script -tags: ['SDK', 'Software Development Kit', 'ProvisioningConfigPlanInitializerScript'] ---- - - -# ProvisioningConfigPlanInitializerScript - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Source** | Pointer to **String** | This is a Rule that allows provisioning instruction changes. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ProvisioningConfigPlanInitializerScript = Initialize-PSSailpoint.V3ProvisioningConfigPlanInitializerScript -Source <?xml version='1.0' encoding='UTF-8'?>\r\n<!DOCTYPE Rule PUBLIC \"sailpoint.dtd\" \"sailpoint.dtd\">\r\n<Rule name=\"Example Rule\" type=\"BeforeProvisioning\">\r\n <Description>Before Provisioning Rule which changes disables and enables to a modify.</Description>\r\n <Source><![CDATA[\r\nimport sailpoint.object.*;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest.Operation;\r\nimport sailpoint.object.ProvisioningPlan.AttributeRequest;\r\nimport sailpoint.object.ProvisioningPlan;\r\nimport sailpoint.object.ProvisioningPlan.Operation;\r\n\r\nfor ( AccountRequest accountRequest : plan.getAccountRequests() ) {\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Disable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Enable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n}\r\n\r\n ]]></Source> - -``` - -- Convert the resource to JSON -```powershell -$ProvisioningConfigPlanInitializerScript | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningCriteriaLevel1.md deleted file mode 100644 index cdd5f2135..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningCriteriaLevel1.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: provisioning-criteria-level1 -title: ProvisioningCriteriaLevel1 -pagination_label: ProvisioningCriteriaLevel1 -sidebar_label: ProvisioningCriteriaLevel1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCriteriaLevel1'] -slug: /tools/sdk/powershell/v3/models/provisioning-criteria-level1 -tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1'] ---- - - -# ProvisioningCriteriaLevel1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operation** | Pointer to [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | Pointer to **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | Pointer to **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | Pointer to [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ProvisioningCriteriaLevel1 = Initialize-PSSailpoint.V3ProvisioningCriteriaLevel1 -Operation null ` - -Attribute email ` - -Value carlee.cert1c9f9b6fd@mailinator.com ` - -Children null -``` - -- Convert the resource to JSON -```powershell -$ProvisioningCriteriaLevel1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningCriteriaLevel2.md deleted file mode 100644 index 23a09f3ae..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningCriteriaLevel2.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: provisioning-criteria-level2 -title: ProvisioningCriteriaLevel2 -pagination_label: ProvisioningCriteriaLevel2 -sidebar_label: ProvisioningCriteriaLevel2 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCriteriaLevel2'] -slug: /tools/sdk/powershell/v3/models/provisioning-criteria-level2 -tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2'] ---- - - -# ProvisioningCriteriaLevel2 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operation** | Pointer to [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | Pointer to **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | Pointer to **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | Pointer to [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ProvisioningCriteriaLevel2 = Initialize-PSSailpoint.V3ProvisioningCriteriaLevel2 -Operation null ` - -Attribute email ` - -Value carlee.cert1c9f9b6fd@mailinator.com ` - -Children null -``` - -- Convert the resource to JSON -```powershell -$ProvisioningCriteriaLevel2 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningCriteriaLevel3.md deleted file mode 100644 index 19a3b7d11..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningCriteriaLevel3.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: provisioning-criteria-level3 -title: ProvisioningCriteriaLevel3 -pagination_label: ProvisioningCriteriaLevel3 -sidebar_label: ProvisioningCriteriaLevel3 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCriteriaLevel3'] -slug: /tools/sdk/powershell/v3/models/provisioning-criteria-level3 -tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3'] ---- - - -# ProvisioningCriteriaLevel3 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operation** | Pointer to [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | Pointer to **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | Pointer to **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | Pointer to **String** | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ProvisioningCriteriaLevel3 = Initialize-PSSailpoint.V3ProvisioningCriteriaLevel3 -Operation null ` - -Attribute email ` - -Value carlee.cert1c9f9b6fd@mailinator.com ` - -Children null -``` - -- Convert the resource to JSON -```powershell -$ProvisioningCriteriaLevel3 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningCriteriaOperation.md b/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningCriteriaOperation.md deleted file mode 100644 index 8c419da99..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningCriteriaOperation.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -id: provisioning-criteria-operation -title: ProvisioningCriteriaOperation -pagination_label: ProvisioningCriteriaOperation -sidebar_label: ProvisioningCriteriaOperation -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCriteriaOperation'] -slug: /tools/sdk/powershell/v3/models/provisioning-criteria-operation -tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaOperation'] ---- - - -# ProvisioningCriteriaOperation - -## Enum - - -* `EQUALS` (value: `"EQUALS"`) - -* `NOT_EQUALS` (value: `"NOT_EQUALS"`) - -* `CONTAINS` (value: `"CONTAINS"`) - -* `HAS` (value: `"HAS"`) - -* `AND` (value: `"AND"`) - -* `OR` (value: `"OR"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningDetails.md b/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningDetails.md deleted file mode 100644 index a6d4a7c77..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningDetails.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: provisioning-details -title: ProvisioningDetails -pagination_label: ProvisioningDetails -sidebar_label: ProvisioningDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningDetails'] -slug: /tools/sdk/powershell/v3/models/provisioning-details -tags: ['SDK', 'Software Development Kit', 'ProvisioningDetails'] ---- - - -# ProvisioningDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**OrderedSubPhaseReferences** | Pointer to **String** | Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain ""manualWorkItemDetails"" which indicate that there is further information in that object for this phase. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ProvisioningDetails = Initialize-PSSailpoint.V3ProvisioningDetails -OrderedSubPhaseReferences manualWorkItemDetails -``` - -- Convert the resource to JSON -```powershell -$ProvisioningDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningPolicy.md b/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningPolicy.md deleted file mode 100644 index f6558ad50..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningPolicy.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: provisioning-policy -title: ProvisioningPolicy -pagination_label: ProvisioningPolicy -sidebar_label: ProvisioningPolicy -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningPolicy'] -slug: /tools/sdk/powershell/v3/models/provisioning-policy -tags: ['SDK', 'Software Development Kit', 'ProvisioningPolicy'] ---- - - -# ProvisioningPolicy - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | the provisioning policy name | [required] -**Description** | Pointer to **String** | the description of the provisioning policy | [optional] -**UsageType** | Pointer to [**UsageType**](usage-type) | | [optional] -**Fields** | Pointer to [**[]FieldDetailsDto**](field-details-dto) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ProvisioningPolicy = Initialize-PSSailpoint.V3ProvisioningPolicy -Name example provisioning policy for inactive identities ` - -Description this provisioning policy creates access based on an identity going inactive ` - -UsageType null ` - -Fields null -``` - -- Convert the resource to JSON -```powershell -$ProvisioningPolicy | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningPolicyDto.md b/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningPolicyDto.md deleted file mode 100644 index 106aeb47d..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningPolicyDto.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: provisioning-policy-dto -title: ProvisioningPolicyDto -pagination_label: ProvisioningPolicyDto -sidebar_label: ProvisioningPolicyDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningPolicyDto'] -slug: /tools/sdk/powershell/v3/models/provisioning-policy-dto -tags: ['SDK', 'Software Development Kit', 'ProvisioningPolicyDto'] ---- - - -# ProvisioningPolicyDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | the provisioning policy name | [required] -**Description** | Pointer to **String** | the description of the provisioning policy | [optional] -**UsageType** | Pointer to [**UsageType**](usage-type) | | [optional] -**Fields** | Pointer to [**[]FieldDetailsDto**](field-details-dto) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ProvisioningPolicyDto = Initialize-PSSailpoint.V3ProvisioningPolicyDto -Name example provisioning policy for inactive identities ` - -Description this provisioning policy creates access based on an identity going inactive ` - -UsageType null ` - -Fields null -``` - -- Convert the resource to JSON -```powershell -$ProvisioningPolicyDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningState.md b/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningState.md deleted file mode 100644 index cdc832d1c..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ProvisioningState.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -id: provisioning-state -title: ProvisioningState -pagination_label: ProvisioningState -sidebar_label: ProvisioningState -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningState'] -slug: /tools/sdk/powershell/v3/models/provisioning-state -tags: ['SDK', 'Software Development Kit', 'ProvisioningState'] ---- - - -# ProvisioningState - -## Enum - - -* `PENDING` (value: `"PENDING"`) - -* `FINISHED` (value: `"FINISHED"`) - -* `UNVERIFIABLE` (value: `"UNVERIFIABLE"`) - -* `COMMITED` (value: `"COMMITED"`) - -* `FAILED` (value: `"FAILED"`) - -* `RETRY` (value: `"RETRY"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/PublicIdentity.md b/docs/tools/sdk/powershell/reference/v3/Models/PublicIdentity.md deleted file mode 100644 index e2fda3a2b..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/PublicIdentity.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: public-identity -title: PublicIdentity -pagination_label: PublicIdentity -sidebar_label: PublicIdentity -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PublicIdentity'] -slug: /tools/sdk/powershell/v3/models/public-identity -tags: ['SDK', 'Software Development Kit', 'PublicIdentity'] ---- - - -# PublicIdentity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Identity id | [optional] -**Name** | Pointer to **String** | Human-readable display name of identity. | [optional] -**Alias** | Pointer to **String** | Alternate unique identifier for the identity. | [optional] -**Email** | Pointer to **String** | Email address of identity. | [optional] -**Status** | Pointer to **String** | The lifecycle status for the identity | [optional] -**IdentityState** | Pointer to **Enum** [ "ACTIVE", "INACTIVE_SHORT_TERM", "INACTIVE_LONG_TERM" ] | The current state of the identity, which determines how Identity Security Cloud interacts with the identity. An identity that is Active will be included identity picklists in Request Center, identity processing, and more. Identities that are Inactive will be excluded from these features. | [optional] -**Manager** | Pointer to [**IdentityReference**](identity-reference) | | [optional] -**Attributes** | Pointer to [**[]PublicIdentityAttributesInner**](public-identity-attributes-inner) | The public identity attributes of the identity | [optional] - -## Examples - -- Prepare the resource -```powershell -$PublicIdentity = Initialize-PSSailpoint.V3PublicIdentity -Id 2c9180857182305e0171993735622948 ` - -Name Alison Ferguso ` - -Alias alison.ferguso ` - -Email alison.ferguso@acme-solar.com ` - -Status Active ` - -IdentityState ACTIVE ` - -Manager null ` - -Attributes null -``` - -- Convert the resource to JSON -```powershell -$PublicIdentity | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/PublicIdentityAttributeConfig.md b/docs/tools/sdk/powershell/reference/v3/Models/PublicIdentityAttributeConfig.md deleted file mode 100644 index 18d274935..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/PublicIdentityAttributeConfig.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: public-identity-attribute-config -title: PublicIdentityAttributeConfig -pagination_label: PublicIdentityAttributeConfig -sidebar_label: PublicIdentityAttributeConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PublicIdentityAttributeConfig'] -slug: /tools/sdk/powershell/v3/models/public-identity-attribute-config -tags: ['SDK', 'Software Development Kit', 'PublicIdentityAttributeConfig'] ---- - - -# PublicIdentityAttributeConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Key** | Pointer to **String** | The attribute key | [optional] -**Name** | Pointer to **String** | The attribute display name | [optional] - -## Examples - -- Prepare the resource -```powershell -$PublicIdentityAttributeConfig = Initialize-PSSailpoint.V3PublicIdentityAttributeConfig -Key country ` - -Name Country -``` - -- Convert the resource to JSON -```powershell -$PublicIdentityAttributeConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/PublicIdentityAttributesInner.md b/docs/tools/sdk/powershell/reference/v3/Models/PublicIdentityAttributesInner.md deleted file mode 100644 index 065ed57dc..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/PublicIdentityAttributesInner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: public-identity-attributes-inner -title: PublicIdentityAttributesInner -pagination_label: PublicIdentityAttributesInner -sidebar_label: PublicIdentityAttributesInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PublicIdentityAttributesInner'] -slug: /tools/sdk/powershell/v3/models/public-identity-attributes-inner -tags: ['SDK', 'Software Development Kit', 'PublicIdentityAttributesInner'] ---- - - -# PublicIdentityAttributesInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Key** | Pointer to **String** | The attribute key | [optional] -**Name** | Pointer to **String** | Human-readable display name of the attribute | [optional] -**Value** | Pointer to **String** | The attribute value | [optional] - -## Examples - -- Prepare the resource -```powershell -$PublicIdentityAttributesInner = Initialize-PSSailpoint.V3PublicIdentityAttributesInner -Key country ` - -Name Country ` - -Value US -``` - -- Convert the resource to JSON -```powershell -$PublicIdentityAttributesInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/PublicIdentityConfig.md b/docs/tools/sdk/powershell/reference/v3/Models/PublicIdentityConfig.md deleted file mode 100644 index f8b5ac5a7..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/PublicIdentityConfig.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: public-identity-config -title: PublicIdentityConfig -pagination_label: PublicIdentityConfig -sidebar_label: PublicIdentityConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PublicIdentityConfig'] -slug: /tools/sdk/powershell/v3/models/public-identity-config -tags: ['SDK', 'Software Development Kit', 'PublicIdentityConfig'] ---- - - -# PublicIdentityConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Attributes** | Pointer to [**[]PublicIdentityAttributeConfig**](public-identity-attribute-config) | Up to 5 identity attributes that will be available to everyone in the org for all users in the org. | [optional] -**Modified** | Pointer to **System.DateTime** | When this configuration was last modified. | [optional] -**ModifiedBy** | Pointer to [**IdentityReference**](identity-reference) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$PublicIdentityConfig = Initialize-PSSailpoint.V3PublicIdentityConfig -Attributes null ` - -Modified 2018-06-25T20:22:28.104Z ` - -ModifiedBy null -``` - -- Convert the resource to JSON -```powershell -$PublicIdentityConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/PutClientLogConfigurationRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/PutClientLogConfigurationRequest.md deleted file mode 100644 index 4c6619416..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/PutClientLogConfigurationRequest.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: put-client-log-configuration-request -title: PutClientLogConfigurationRequest -pagination_label: PutClientLogConfigurationRequest -sidebar_label: PutClientLogConfigurationRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PutClientLogConfigurationRequest'] -slug: /tools/sdk/powershell/v3/models/put-client-log-configuration-request -tags: ['SDK', 'Software Development Kit', 'PutClientLogConfigurationRequest'] ---- - - -# PutClientLogConfigurationRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ClientId** | Pointer to **String** | Log configuration's client ID | [optional] -**DurationMinutes** | Pointer to **Int32** | Duration in minutes for log configuration to remain in effect before resetting to defaults. | [optional] [default to 240] -**RootLevel** | [**StandardLevel**](standard-level) | | [required] -**LogLevels** | Pointer to [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] -**Expiration** | Pointer to **System.DateTime** | Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. | [optional] - -## Examples - -- Prepare the resource -```powershell -$PutClientLogConfigurationRequest = Initialize-PSSailpoint.V3PutClientLogConfigurationRequest -ClientId 3a38a51992e8445ab51a549c0a70ee66 ` - -DurationMinutes 120 ` - -RootLevel null ` - -LogLevels INFO ` - -Expiration 2024-11-06T01:31:08.013164Z -``` - -- Convert the resource to JSON -```powershell -$PutClientLogConfigurationRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/PutConnectorSourceConfigRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/PutConnectorSourceConfigRequest.md deleted file mode 100644 index 0aca99f16..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/PutConnectorSourceConfigRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: put-connector-source-config-request -title: PutConnectorSourceConfigRequest -pagination_label: PutConnectorSourceConfigRequest -sidebar_label: PutConnectorSourceConfigRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PutConnectorSourceConfigRequest'] -slug: /tools/sdk/powershell/v3/models/put-connector-source-config-request -tags: ['SDK', 'Software Development Kit', 'PutConnectorSourceConfigRequest'] ---- - - -# PutConnectorSourceConfigRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**File** | **System.IO.FileInfo** | connector source config xml file | [required] - -## Examples - -- Prepare the resource -```powershell -$PutConnectorSourceConfigRequest = Initialize-PSSailpoint.V3PutConnectorSourceConfigRequest -File null -``` - -- Convert the resource to JSON -```powershell -$PutConnectorSourceConfigRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/PutConnectorSourceTemplateRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/PutConnectorSourceTemplateRequest.md deleted file mode 100644 index 68ec3026d..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/PutConnectorSourceTemplateRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: put-connector-source-template-request -title: PutConnectorSourceTemplateRequest -pagination_label: PutConnectorSourceTemplateRequest -sidebar_label: PutConnectorSourceTemplateRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PutConnectorSourceTemplateRequest'] -slug: /tools/sdk/powershell/v3/models/put-connector-source-template-request -tags: ['SDK', 'Software Development Kit', 'PutConnectorSourceTemplateRequest'] ---- - - -# PutConnectorSourceTemplateRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**File** | **System.IO.FileInfo** | connector source template xml file | [required] - -## Examples - -- Prepare the resource -```powershell -$PutConnectorSourceTemplateRequest = Initialize-PSSailpoint.V3PutConnectorSourceTemplateRequest -File null -``` - -- Convert the resource to JSON -```powershell -$PutConnectorSourceTemplateRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/PutPasswordDictionaryRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/PutPasswordDictionaryRequest.md deleted file mode 100644 index e36454229..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/PutPasswordDictionaryRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: put-password-dictionary-request -title: PutPasswordDictionaryRequest -pagination_label: PutPasswordDictionaryRequest -sidebar_label: PutPasswordDictionaryRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PutPasswordDictionaryRequest'] -slug: /tools/sdk/powershell/v3/models/put-password-dictionary-request -tags: ['SDK', 'Software Development Kit', 'PutPasswordDictionaryRequest'] ---- - - -# PutPasswordDictionaryRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**File** | Pointer to **System.IO.FileInfo** | | [optional] - -## Examples - -- Prepare the resource -```powershell -$PutPasswordDictionaryRequest = Initialize-PSSailpoint.V3PutPasswordDictionaryRequest -File null -``` - -- Convert the resource to JSON -```powershell -$PutPasswordDictionaryRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Query.md b/docs/tools/sdk/powershell/reference/v3/Models/Query.md deleted file mode 100644 index adec20aa1..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Query.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: query -title: Query -pagination_label: Query -sidebar_label: Query -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Query'] -slug: /tools/sdk/powershell/v3/models/query -tags: ['SDK', 'Software Development Kit', 'Query'] ---- - - -# Query - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Query** | Pointer to **String** | The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | [optional] -**Fields** | Pointer to **String** | The fields the query will be applied to. Fields provide you with a simple way to add additional fields to search, without making the query too complicated. For example, you can use the fields to specify that you want your query of ""a*"" to be applied to ""name"", ""firstName"", and the ""source.name"". The response will include all results matching the ""a*"" query found in those three fields. A field's availability depends on the indices being searched. For example, if you are searching ""identities"", you can apply your search to the ""firstName"" field, but you couldn't use ""firstName"" with a search on ""access profiles"". Refer to the response schema for the respective lists of available fields. | [optional] -**TimeZone** | Pointer to **String** | The time zone to be applied to any range query related to dates. | [optional] -**InnerHit** | Pointer to [**InnerHit**](inner-hit) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$Query = Initialize-PSSailpoint.V3Query -Query name:a* ` - -Fields [firstName,lastName,email] ` - -TimeZone America/Chicago ` - -InnerHit null -``` - -- Convert the resource to JSON -```powershell -$Query | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/QueryResultFilter.md b/docs/tools/sdk/powershell/reference/v3/Models/QueryResultFilter.md deleted file mode 100644 index 6b745b81f..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/QueryResultFilter.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: query-result-filter -title: QueryResultFilter -pagination_label: QueryResultFilter -sidebar_label: QueryResultFilter -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'QueryResultFilter'] -slug: /tools/sdk/powershell/v3/models/query-result-filter -tags: ['SDK', 'Software Development Kit', 'QueryResultFilter'] ---- - - -# QueryResultFilter - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Includes** | Pointer to **[]String** | The list of field names to include in the result documents. | [optional] -**Excludes** | Pointer to **[]String** | The list of field names to exclude from the result documents. | [optional] - -## Examples - -- Prepare the resource -```powershell -$QueryResultFilter = Initialize-PSSailpoint.V3QueryResultFilter -Includes [name, displayName] ` - -Excludes [stacktrace] -``` - -- Convert the resource to JSON -```powershell -$QueryResultFilter | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/QueryType.md b/docs/tools/sdk/powershell/reference/v3/Models/QueryType.md deleted file mode 100644 index a6943edfd..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/QueryType.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: query-type -title: QueryType -pagination_label: QueryType -sidebar_label: QueryType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'QueryType'] -slug: /tools/sdk/powershell/v3/models/query-type -tags: ['SDK', 'Software Development Kit', 'QueryType'] ---- - - -# QueryType - -## Enum - - -* `DSL` (value: `"DSL"`) - -* `SAILPOINT` (value: `"SAILPOINT"`) - -* `TEXT` (value: `"TEXT"`) - -* `TYPEAHEAD` (value: `"TYPEAHEAD"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/QueuedCheckConfigDetails.md b/docs/tools/sdk/powershell/reference/v3/Models/QueuedCheckConfigDetails.md deleted file mode 100644 index 690e2b01b..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/QueuedCheckConfigDetails.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: queued-check-config-details -title: QueuedCheckConfigDetails -pagination_label: QueuedCheckConfigDetails -sidebar_label: QueuedCheckConfigDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'QueuedCheckConfigDetails'] -slug: /tools/sdk/powershell/v3/models/queued-check-config-details -tags: ['SDK', 'Software Development Kit', 'QueuedCheckConfigDetails'] ---- - - -# QueuedCheckConfigDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ProvisioningStatusCheckIntervalMinutes** | **String** | Interval in minutes between status checks | [required] -**ProvisioningMaxStatusCheckDays** | **String** | Maximum number of days to check | [required] - -## Examples - -- Prepare the resource -```powershell -$QueuedCheckConfigDetails = Initialize-PSSailpoint.V3QueuedCheckConfigDetails -ProvisioningStatusCheckIntervalMinutes 30 ` - -ProvisioningMaxStatusCheckDays 2 -``` - -- Convert the resource to JSON -```powershell -$QueuedCheckConfigDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RandomAlphaNumeric.md b/docs/tools/sdk/powershell/reference/v3/Models/RandomAlphaNumeric.md deleted file mode 100644 index 7b3a7f567..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RandomAlphaNumeric.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: random-alpha-numeric -title: RandomAlphaNumeric -pagination_label: RandomAlphaNumeric -sidebar_label: RandomAlphaNumeric -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RandomAlphaNumeric'] -slug: /tools/sdk/powershell/v3/models/random-alpha-numeric -tags: ['SDK', 'Software Development Kit', 'RandomAlphaNumeric'] ---- - - -# RandomAlphaNumeric - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Length** | Pointer to **String** | This is an integer value specifying the size/number of characters the random string must contain * This value must be a positive number and cannot be blank * If no length is provided, the transform will default to a value of `32` * Due to identity attribute data constraints, the maximum allowable value is `450` characters | [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 -$RandomAlphaNumeric = Initialize-PSSailpoint.V3RandomAlphaNumeric -Length 10 ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$RandomAlphaNumeric | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RandomNumeric.md b/docs/tools/sdk/powershell/reference/v3/Models/RandomNumeric.md deleted file mode 100644 index e7ef63ef7..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RandomNumeric.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: random-numeric -title: RandomNumeric -pagination_label: RandomNumeric -sidebar_label: RandomNumeric -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RandomNumeric'] -slug: /tools/sdk/powershell/v3/models/random-numeric -tags: ['SDK', 'Software Development Kit', 'RandomNumeric'] ---- - - -# RandomNumeric - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Length** | Pointer to **String** | This is an integer value specifying the size/number of characters the random string must contain * This value must be a positive number and cannot be blank * If no length is provided, the transform will default to a value of `32` * Due to identity attribute data constraints, the maximum allowable value is `450` characters | [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 -$RandomNumeric = Initialize-PSSailpoint.V3RandomNumeric -Length 10 ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$RandomNumeric | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Range.md b/docs/tools/sdk/powershell/reference/v3/Models/Range.md deleted file mode 100644 index 701b71bd2..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Range.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: range -title: Range -pagination_label: Range -sidebar_label: Range -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Range'] -slug: /tools/sdk/powershell/v3/models/range -tags: ['SDK', 'Software Development Kit', 'Range'] ---- - - -# Range - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Lower** | Pointer to [**Bound**](bound) | | [optional] -**Upper** | Pointer to [**Bound**](bound) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$Range = Initialize-PSSailpoint.V3Range -Lower null ` - -Upper null -``` - -- Convert the resource to JSON -```powershell -$Range | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ReassignReference.md b/docs/tools/sdk/powershell/reference/v3/Models/ReassignReference.md deleted file mode 100644 index e6ca9dc9d..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ReassignReference.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: reassign-reference -title: ReassignReference -pagination_label: ReassignReference -sidebar_label: ReassignReference -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ReassignReference'] -slug: /tools/sdk/powershell/v3/models/reassign-reference -tags: ['SDK', 'Software Development Kit', 'ReassignReference'] ---- - - -# ReassignReference - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The ID of item or identity being reassigned. | [required] -**Type** | **Enum** [ "TARGET_SUMMARY", "ITEM", "IDENTITY_SUMMARY" ] | The type of item or identity being reassigned. | [required] - -## Examples - -- Prepare the resource -```powershell -$ReassignReference = Initialize-PSSailpoint.V3ReassignReference -Id ef38f94347e94562b5bb8424a56397d8 ` - -Type ITEM -``` - -- Convert the resource to JSON -```powershell -$ReassignReference | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Reassignment.md b/docs/tools/sdk/powershell/reference/v3/Models/Reassignment.md deleted file mode 100644 index 2ac41a121..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Reassignment.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: reassignment -title: Reassignment -pagination_label: Reassignment -sidebar_label: Reassignment -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Reassignment'] -slug: /tools/sdk/powershell/v3/models/reassignment -tags: ['SDK', 'Software Development Kit', 'Reassignment'] ---- - - -# Reassignment - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**VarFrom** | Pointer to [**CertificationReference**](certification-reference) | | [optional] -**Comment** | Pointer to **String** | The comment entered when the Certification was reassigned | [optional] - -## Examples - -- Prepare the resource -```powershell -$Reassignment = Initialize-PSSailpoint.V3Reassignment -VarFrom null ` - -Comment Reassigned for a reason -``` - -- Convert the resource to JSON -```powershell -$Reassignment | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ReassignmentReference.md b/docs/tools/sdk/powershell/reference/v3/Models/ReassignmentReference.md deleted file mode 100644 index 62e385ee3..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ReassignmentReference.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: reassignment-reference -title: ReassignmentReference -pagination_label: ReassignmentReference -sidebar_label: ReassignmentReference -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ReassignmentReference'] -slug: /tools/sdk/powershell/v3/models/reassignment-reference -tags: ['SDK', 'Software Development Kit', 'ReassignmentReference'] ---- - - -# ReassignmentReference - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The ID of item or identity being reassigned. | [required] -**Type** | **Enum** [ "TARGET_SUMMARY", "ITEM", "IDENTITY_SUMMARY" ] | The type of item or identity being reassigned. | [required] - -## Examples - -- Prepare the resource -```powershell -$ReassignmentReference = Initialize-PSSailpoint.V3ReassignmentReference -Id ef38f94347e94562b5bb8424a56397d8 ` - -Type ITEM -``` - -- Convert the resource to JSON -```powershell -$ReassignmentReference | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ReassignmentTrailDTO.md b/docs/tools/sdk/powershell/reference/v3/Models/ReassignmentTrailDTO.md deleted file mode 100644 index 02d6a8df9..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ReassignmentTrailDTO.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: reassignment-trail-dto -title: ReassignmentTrailDTO -pagination_label: ReassignmentTrailDTO -sidebar_label: ReassignmentTrailDTO -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ReassignmentTrailDTO'] -slug: /tools/sdk/powershell/v3/models/reassignment-trail-dto -tags: ['SDK', 'Software Development Kit', 'ReassignmentTrailDTO'] ---- - - -# ReassignmentTrailDTO - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**PreviousOwner** | Pointer to **String** | The ID of previous owner identity. | [optional] -**NewOwner** | Pointer to **String** | The ID of new owner identity. | [optional] -**ReassignmentType** | Pointer to **String** | The type of reassignment. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ReassignmentTrailDTO = Initialize-PSSailpoint.V3ReassignmentTrailDTO -PreviousOwner ef38f94347e94562b5bb8424a56397d8 ` - -NewOwner ef38f94347e94562b5bb8424a56397a3 ` - -ReassignmentType AUTOMATIC_REASSIGNMENT -``` - -- Convert the resource to JSON -```powershell -$ReassignmentTrailDTO | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ReassignmentType.md b/docs/tools/sdk/powershell/reference/v3/Models/ReassignmentType.md deleted file mode 100644 index 12701029a..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ReassignmentType.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: reassignment-type -title: ReassignmentType -pagination_label: ReassignmentType -sidebar_label: ReassignmentType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ReassignmentType'] -slug: /tools/sdk/powershell/v3/models/reassignment-type -tags: ['SDK', 'Software Development Kit', 'ReassignmentType'] ---- - - -# ReassignmentType - -## Enum - - -* `MANUAL_REASSIGNMENT` (value: `"MANUAL_REASSIGNMENT"`) - -* `AUTOMATIC_REASSIGNMENT` (value: `"AUTOMATIC_REASSIGNMENT"`) - -* `AUTO_ESCALATION` (value: `"AUTO_ESCALATION"`) - -* `SELF_REVIEW_DELEGATION` (value: `"SELF_REVIEW_DELEGATION"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Recommendation.md b/docs/tools/sdk/powershell/reference/v3/Models/Recommendation.md deleted file mode 100644 index 9934cd605..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Recommendation.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: recommendation -title: Recommendation -pagination_label: Recommendation -sidebar_label: Recommendation -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Recommendation'] -slug: /tools/sdk/powershell/v3/models/recommendation -tags: ['SDK', 'Software Development Kit', 'Recommendation'] ---- - - -# Recommendation - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "HUMAN", "MACHINE" ] | Recommended type of account. | [required] -**Method** | **Enum** [ "DISCOVERY", "SOURCE", "CRITERIA" ] | Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. | [required] - -## Examples - -- Prepare the resource -```powershell -$Recommendation = Initialize-PSSailpoint.V3Recommendation -Type MACHINE ` - -Method DISCOVERY -``` - -- Convert the resource to JSON -```powershell -$Recommendation | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Reference.md b/docs/tools/sdk/powershell/reference/v3/Models/Reference.md deleted file mode 100644 index 1eff98b7b..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Reference.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: reference -title: Reference -pagination_label: Reference -sidebar_label: Reference -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Reference'] -slug: /tools/sdk/powershell/v3/models/reference -tags: ['SDK', 'Software Development Kit', 'Reference'] ---- - - -# Reference - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | This ID specifies the name of the pre-existing transform which you want to use within your current transform | [required] -**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 -$Reference = Initialize-PSSailpoint.V3Reference -Id Existing Transform ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$Reference | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Reference1.md b/docs/tools/sdk/powershell/reference/v3/Models/Reference1.md deleted file mode 100644 index 65d9ca896..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Reference1.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: reference1 -title: Reference1 -pagination_label: Reference1 -sidebar_label: Reference1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Reference1'] -slug: /tools/sdk/powershell/v3/models/reference1 -tags: ['SDK', 'Software Development Kit', 'Reference1'] ---- - - -# Reference1 - -## 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] - -## Examples - -- Prepare the resource -```powershell -$Reference1 = Initialize-PSSailpoint.V3Reference1 -Id 2c91808568c529c60168cca6f90c1313 ` - -Name John Doe -``` - -- Convert the resource to JSON -```powershell -$Reference1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RemediationItemDetails.md b/docs/tools/sdk/powershell/reference/v3/Models/RemediationItemDetails.md deleted file mode 100644 index 4524a8fa5..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RemediationItemDetails.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: remediation-item-details -title: RemediationItemDetails -pagination_label: RemediationItemDetails -sidebar_label: RemediationItemDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RemediationItemDetails'] -slug: /tools/sdk/powershell/v3/models/remediation-item-details -tags: ['SDK', 'Software Development Kit', 'RemediationItemDetails'] ---- - - -# RemediationItemDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The ID of the certification | [optional] -**TargetId** | Pointer to **String** | The ID of the certification target | [optional] -**TargetName** | Pointer to **String** | The name of the certification target | [optional] -**TargetDisplayName** | Pointer to **String** | The display name of the certification target | [optional] -**ApplicationName** | Pointer to **String** | The name of the application/source | [optional] -**AttributeName** | Pointer to **String** | The name of the attribute being certified | [optional] -**AttributeOperation** | Pointer to **String** | The operation of the certification on the attribute | [optional] -**AttributeValue** | Pointer to **String** | The value of the attribute being certified | [optional] -**NativeIdentity** | Pointer to **String** | The native identity of the target | [optional] - -## Examples - -- Prepare the resource -```powershell -$RemediationItemDetails = Initialize-PSSailpoint.V3RemediationItemDetails -Id 2c9180835d2e5168015d32f890ca1581 ` - -TargetId 2c9180835d2e5168015d32f890ca1581 ` - -TargetName john.smith ` - -TargetDisplayName emailAddress ` - -ApplicationName Active Directory ` - -AttributeName phoneNumber ` - -AttributeOperation update ` - -AttributeValue 512-555-1212 ` - -NativeIdentity jason.smith2 -``` - -- Convert the resource to JSON -```powershell -$RemediationItemDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RemediationItems.md b/docs/tools/sdk/powershell/reference/v3/Models/RemediationItems.md deleted file mode 100644 index e477d81fb..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RemediationItems.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: remediation-items -title: RemediationItems -pagination_label: RemediationItems -sidebar_label: RemediationItems -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RemediationItems'] -slug: /tools/sdk/powershell/v3/models/remediation-items -tags: ['SDK', 'Software Development Kit', 'RemediationItems'] ---- - - -# RemediationItems - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The ID of the certification | [optional] -**TargetId** | Pointer to **String** | The ID of the certification target | [optional] -**TargetName** | Pointer to **String** | The name of the certification target | [optional] -**TargetDisplayName** | Pointer to **String** | The display name of the certification target | [optional] -**ApplicationName** | Pointer to **String** | The name of the application/source | [optional] -**AttributeName** | Pointer to **String** | The name of the attribute being certified | [optional] -**AttributeOperation** | Pointer to **String** | The operation of the certification on the attribute | [optional] -**AttributeValue** | Pointer to **String** | The value of the attribute being certified | [optional] -**NativeIdentity** | Pointer to **String** | The native identity of the target | [optional] - -## Examples - -- Prepare the resource -```powershell -$RemediationItems = Initialize-PSSailpoint.V3RemediationItems -Id 2c9180835d2e5168015d32f890ca1581 ` - -TargetId 2c9180835d2e5168015d32f890ca1581 ` - -TargetName john.smith ` - -TargetDisplayName emailAddress ` - -ApplicationName Active Directory ` - -AttributeName phoneNumber ` - -AttributeOperation update ` - -AttributeValue 512-555-1212 ` - -NativeIdentity jason.smith2 -``` - -- Convert the resource to JSON -```powershell -$RemediationItems | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Replace.md b/docs/tools/sdk/powershell/reference/v3/Models/Replace.md deleted file mode 100644 index 6c8b4de7d..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Replace.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: replace -title: Replace -pagination_label: Replace -sidebar_label: Replace -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Replace'] -slug: /tools/sdk/powershell/v3/models/replace -tags: ['SDK', 'Software Development Kit', 'Replace'] ---- - - -# Replace - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Regex** | **String** | This can be a string or a regex pattern in which you want to replace. | [required] -**Replacement** | **String** | This is the replacement string that should be substituded wherever the string or pattern is found. | [required] -**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 -$Replace = Initialize-PSSailpoint.V3Replace -Regex [^a-zA-Z] ` - -Replacement ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$Replace | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ReplaceAll.md b/docs/tools/sdk/powershell/reference/v3/Models/ReplaceAll.md deleted file mode 100644 index 67a1854d7..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ReplaceAll.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: replace-all -title: ReplaceAll -pagination_label: ReplaceAll -sidebar_label: ReplaceAll -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ReplaceAll'] -slug: /tools/sdk/powershell/v3/models/replace-all -tags: ['SDK', 'Software Development Kit', 'ReplaceAll'] ---- - - -# ReplaceAll - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Table** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value. | [required] -**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 -$ReplaceAll = Initialize-PSSailpoint.V3ReplaceAll -Table {-= , "=', ñ=n} ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$ReplaceAll | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ReportDetails.md b/docs/tools/sdk/powershell/reference/v3/Models/ReportDetails.md deleted file mode 100644 index fdd27a781..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ReportDetails.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: report-details -title: ReportDetails -pagination_label: ReportDetails -sidebar_label: ReportDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ReportDetails'] -slug: /tools/sdk/powershell/v3/models/report-details -tags: ['SDK', 'Software Development Kit', 'ReportDetails'] ---- - - -# ReportDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ReportType** | Pointer to **Enum** [ "ACCOUNTS", "IDENTITIES_DETAILS", "IDENTITIES", "IDENTITY_PROFILE_IDENTITY_ERROR", "ORPHAN_IDENTITIES", "SEARCH_EXPORT", "UNCORRELATED_ACCOUNTS" ] | Use this property to define what report should be processed in the RDE service. | [optional] -**Arguments** | Pointer to [**ReportDetailsArguments**](report-details-arguments) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ReportDetails = Initialize-PSSailpoint.V3ReportDetails -ReportType ACCOUNTS ` - -Arguments null -``` - -- Convert the resource to JSON -```powershell -$ReportDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ReportDetailsArguments.md b/docs/tools/sdk/powershell/reference/v3/Models/ReportDetailsArguments.md deleted file mode 100644 index f64548d5d..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ReportDetailsArguments.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: report-details-arguments -title: ReportDetailsArguments -pagination_label: ReportDetailsArguments -sidebar_label: ReportDetailsArguments -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ReportDetailsArguments'] -slug: /tools/sdk/powershell/v3/models/report-details-arguments -tags: ['SDK', 'Software Development Kit', 'ReportDetailsArguments'] ---- - - -# ReportDetailsArguments - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Application** | **String** | Source ID. | [required] -**SourceName** | **String** | Source name. | [required] -**CorrelatedOnly** | **Boolean** | Flag to specify if only correlated identities are included in report. | [required][default to $false] -**AuthoritativeSource** | **String** | Source ID. | [required] -**SelectedFormats** | Pointer to **[]String** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] -**Indices** | Pointer to [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] -**Query** | **String** | The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | [required] -**Columns** | Pointer to **String** | Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. | [optional] -**Sort** | Pointer to **[]String** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ReportDetailsArguments = Initialize-PSSailpoint.V3ReportDetailsArguments -Application 2c9180897eSourceIde781782f705b9 ` - -SourceName Active Directory ` - -CorrelatedOnly true ` - -AuthoritativeSource 1234sourceId5678902 ` - -SelectedFormats [CSV] ` - -Indices [entitlements] ` - -Query name:a* ` - -Columns displayName,firstName,lastName,email,created,attributes.cloudLifecycleState ` - -Sort [displayName, +id] -``` - -- Convert the resource to JSON -```powershell -$ReportDetailsArguments | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ReportResultReference.md b/docs/tools/sdk/powershell/reference/v3/Models/ReportResultReference.md deleted file mode 100644 index bf3dccd49..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ReportResultReference.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: report-result-reference -title: ReportResultReference -pagination_label: ReportResultReference -sidebar_label: ReportResultReference -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ReportResultReference'] -slug: /tools/sdk/powershell/v3/models/report-result-reference -tags: ['SDK', 'Software Development Kit', 'ReportResultReference'] ---- - - -# ReportResultReference - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "REPORT_RESULT" ] | SOD policy violation report result DTO type. | [optional] -**Id** | Pointer to **String** | SOD policy violation report result ID. | [optional] -**Name** | Pointer to **String** | Human-readable name of the SOD policy violation report result. | [optional] -**Status** | Pointer to **Enum** [ "SUCCESS", "WARNING", "ERROR", "TERMINATED", "TEMP_ERROR", "PENDING" ] | Status of a SOD policy violation report. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ReportResultReference = Initialize-PSSailpoint.V3ReportResultReference -Type REPORT_RESULT ` - -Id 2c9180835d191a86015d28455b4b232a ` - -Name SOD Policy 1 Violation ` - -Status PENDING -``` - -- Convert the resource to JSON -```powershell -$ReportResultReference | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ReportResults.md b/docs/tools/sdk/powershell/reference/v3/Models/ReportResults.md deleted file mode 100644 index cc9e607a1..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ReportResults.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: report-results -title: ReportResults -pagination_label: ReportResults -sidebar_label: ReportResults -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ReportResults'] -slug: /tools/sdk/powershell/v3/models/report-results -tags: ['SDK', 'Software Development Kit', 'ReportResults'] ---- - - -# ReportResults - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ReportType** | Pointer to **Enum** [ "ACCOUNTS", "IDENTITIES_DETAILS", "IDENTITIES", "IDENTITY_PROFILE_IDENTITY_ERROR", "ORPHAN_IDENTITIES", "SEARCH_EXPORT", "UNCORRELATED_ACCOUNTS" ] | Use this property to define what report should be processed in the RDE service. | [optional] -**TaskDefName** | Pointer to **String** | Name of the task definition which is started to process requesting report. Usually the same as report name | [optional] -**Id** | Pointer to **String** | Unique task definition identifier. | [optional] -**Created** | Pointer to **System.DateTime** | Report processing start date | [optional] -**Status** | Pointer to **Enum** [ "SUCCESS", "FAILURE", "WARNING", "TERMINATED" ] | Report current state or result status. | [optional] -**Duration** | Pointer to **Int64** | Report processing time in ms. | [optional] -**Rows** | Pointer to **Int64** | Report size in rows. | [optional] -**AvailableFormats** | Pointer to **[]String** | Output report file formats. This are formats for calling get endpoint as a query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ReportResults = Initialize-PSSailpoint.V3ReportResults -ReportType IDENTITIES_DETAILS ` - -TaskDefName Identities Details Report ` - -Id a248c16fe22222b2bd49615481311111 ` - -Created null ` - -Status SUCCESS ` - -Duration 342 ` - -Rows 37 ` - -AvailableFormats [CSV] -``` - -- Convert the resource to JSON -```powershell -$ReportResults | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ReportType.md b/docs/tools/sdk/powershell/reference/v3/Models/ReportType.md deleted file mode 100644 index 9338bf589..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ReportType.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: report-type -title: ReportType -pagination_label: ReportType -sidebar_label: ReportType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ReportType'] -slug: /tools/sdk/powershell/v3/models/report-type -tags: ['SDK', 'Software Development Kit', 'ReportType'] ---- - - -# ReportType - -## Enum - - -* `CAMPAIGN_COMPOSITION_REPORT` (value: `"CAMPAIGN_COMPOSITION_REPORT"`) - -* `CAMPAIGN_REMEDIATION_STATUS_REPORT` (value: `"CAMPAIGN_REMEDIATION_STATUS_REPORT"`) - -* `CAMPAIGN_STATUS_REPORT` (value: `"CAMPAIGN_STATUS_REPORT"`) - -* `CERTIFICATION_SIGNOFF_REPORT` (value: `"CERTIFICATION_SIGNOFF_REPORT"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RequestOnBehalfOfConfig.md b/docs/tools/sdk/powershell/reference/v3/Models/RequestOnBehalfOfConfig.md deleted file mode 100644 index 8dcc97082..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RequestOnBehalfOfConfig.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: request-on-behalf-of-config -title: RequestOnBehalfOfConfig -pagination_label: RequestOnBehalfOfConfig -sidebar_label: RequestOnBehalfOfConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestOnBehalfOfConfig'] -slug: /tools/sdk/powershell/v3/models/request-on-behalf-of-config -tags: ['SDK', 'Software Development Kit', 'RequestOnBehalfOfConfig'] ---- - - -# RequestOnBehalfOfConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AllowRequestOnBehalfOfAnyoneByAnyone** | Pointer to **Boolean** | If this is true, anyone can request access for anyone. | [optional] [default to $false] -**AllowRequestOnBehalfOfEmployeeByManager** | Pointer to **Boolean** | If this is true, a manager can request access for his or her direct reports. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$RequestOnBehalfOfConfig = Initialize-PSSailpoint.V3RequestOnBehalfOfConfig -AllowRequestOnBehalfOfAnyoneByAnyone true ` - -AllowRequestOnBehalfOfEmployeeByManager true -``` - -- Convert the resource to JSON -```powershell -$RequestOnBehalfOfConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Requestability.md b/docs/tools/sdk/powershell/reference/v3/Models/Requestability.md deleted file mode 100644 index 04183d2bd..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Requestability.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: requestability -title: Requestability -pagination_label: Requestability -sidebar_label: Requestability -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Requestability'] -slug: /tools/sdk/powershell/v3/models/requestability -tags: ['SDK', 'Software Development Kit', 'Requestability'] ---- - - -# Requestability - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CommentsRequired** | Pointer to **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] -**DenialCommentsRequired** | Pointer to **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] -**ApprovalSchemes** | Pointer to [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the request | [optional] - -## Examples - -- Prepare the resource -```powershell -$Requestability = Initialize-PSSailpoint.V3Requestability -CommentsRequired true ` - -DenialCommentsRequired true ` - -ApprovalSchemes null -``` - -- Convert the resource to JSON -```powershell -$Requestability | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RequestabilityForRole.md b/docs/tools/sdk/powershell/reference/v3/Models/RequestabilityForRole.md deleted file mode 100644 index ad874bb74..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RequestabilityForRole.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: requestability-for-role -title: RequestabilityForRole -pagination_label: RequestabilityForRole -sidebar_label: RequestabilityForRole -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestabilityForRole'] -slug: /tools/sdk/powershell/v3/models/requestability-for-role -tags: ['SDK', 'Software Development Kit', 'RequestabilityForRole'] ---- - - -# RequestabilityForRole - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CommentsRequired** | Pointer to **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] -**DenialCommentsRequired** | Pointer to **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] -**ApprovalSchemes** | Pointer to [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] - -## Examples - -- Prepare the resource -```powershell -$RequestabilityForRole = Initialize-PSSailpoint.V3RequestabilityForRole -CommentsRequired true ` - -DenialCommentsRequired true ` - -ApprovalSchemes null -``` - -- Convert the resource to JSON -```powershell -$RequestabilityForRole | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RequestableObject.md b/docs/tools/sdk/powershell/reference/v3/Models/RequestableObject.md deleted file mode 100644 index ad65d2ac4..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RequestableObject.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: requestable-object -title: RequestableObject -pagination_label: RequestableObject -sidebar_label: RequestableObject -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestableObject'] -slug: /tools/sdk/powershell/v3/models/requestable-object -tags: ['SDK', 'Software Development Kit', 'RequestableObject'] ---- - - -# RequestableObject - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Id of the requestable object itself | [optional] -**Name** | Pointer to **String** | Human-readable display name of the requestable object | [optional] -**Created** | Pointer to **System.DateTime** | The time when the requestable object was created | [optional] -**Modified** | Pointer to **System.DateTime** | The time when the requestable object was last modified | [optional] -**Description** | Pointer to **String** | Description of the requestable object. | [optional] -**Type** | Pointer to [**RequestableObjectType**](requestable-object-type) | | [optional] -**RequestStatus** | Pointer to [**RequestableObjectRequestStatus**](requestable-object-request-status) | | [optional] -**IdentityRequestId** | Pointer to **String** | If *requestStatus* is *PENDING*, indicates the id of the associated account activity. | [optional] -**OwnerRef** | Pointer to [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] -**RequestCommentsRequired** | Pointer to **Boolean** | Whether the requester must provide comments when requesting the object. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RequestableObject = Initialize-PSSailpoint.V3RequestableObject -Id 2c9180835d2e5168015d32f890ca1581 ` - -Name Applied Research Access ` - -Created 2017-07-11T18:45:37.098Z ` - -Modified 2018-06-25T20:22:28.104Z ` - -Description Access to research information, lab results, and schematics. ` - -Type null ` - -RequestStatus null ` - -IdentityRequestId null ` - -OwnerRef null ` - -RequestCommentsRequired false -``` - -- Convert the resource to JSON -```powershell -$RequestableObject | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RequestableObjectReference.md b/docs/tools/sdk/powershell/reference/v3/Models/RequestableObjectReference.md deleted file mode 100644 index e4c8a959e..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RequestableObjectReference.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: requestable-object-reference -title: RequestableObjectReference -pagination_label: RequestableObjectReference -sidebar_label: RequestableObjectReference -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestableObjectReference'] -slug: /tools/sdk/powershell/v3/models/requestable-object-reference -tags: ['SDK', 'Software Development Kit', 'RequestableObjectReference'] ---- - - -# RequestableObjectReference - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Id of the object. | [optional] -**Name** | Pointer to **String** | Name of the object. | [optional] -**Description** | Pointer to **String** | Description of the object. | [optional] -**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | Type of the object. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RequestableObjectReference = Initialize-PSSailpoint.V3RequestableObjectReference -Id 2c9180835d2e5168015d32f890ca1581 ` - -Name Applied Research Access ` - -Description Access to research information, lab results, and schematics ` - -Type ROLE -``` - -- Convert the resource to JSON -```powershell -$RequestableObjectReference | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RequestableObjectRequestStatus.md b/docs/tools/sdk/powershell/reference/v3/Models/RequestableObjectRequestStatus.md deleted file mode 100644 index 01e04a690..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RequestableObjectRequestStatus.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: requestable-object-request-status -title: RequestableObjectRequestStatus -pagination_label: RequestableObjectRequestStatus -sidebar_label: RequestableObjectRequestStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestableObjectRequestStatus'] -slug: /tools/sdk/powershell/v3/models/requestable-object-request-status -tags: ['SDK', 'Software Development Kit', 'RequestableObjectRequestStatus'] ---- - - -# RequestableObjectRequestStatus - -## Enum - - -* `AVAILABLE` (value: `"AVAILABLE"`) - -* `PENDING` (value: `"PENDING"`) - -* `ASSIGNED` (value: `"ASSIGNED"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RequestableObjectType.md b/docs/tools/sdk/powershell/reference/v3/Models/RequestableObjectType.md deleted file mode 100644 index 5ac097346..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RequestableObjectType.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: requestable-object-type -title: RequestableObjectType -pagination_label: RequestableObjectType -sidebar_label: RequestableObjectType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestableObjectType'] -slug: /tools/sdk/powershell/v3/models/requestable-object-type -tags: ['SDK', 'Software Development Kit', 'RequestableObjectType'] ---- - - -# RequestableObjectType - -## Enum - - -* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) - -* `ROLE` (value: `"ROLE"`) - -* `ENTITLEMENT` (value: `"ENTITLEMENT"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RequestedItemDetails.md b/docs/tools/sdk/powershell/reference/v3/Models/RequestedItemDetails.md deleted file mode 100644 index 593bf81f5..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RequestedItemDetails.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: requested-item-details -title: RequestedItemDetails -pagination_label: RequestedItemDetails -sidebar_label: RequestedItemDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemDetails'] -slug: /tools/sdk/powershell/v3/models/requested-item-details -tags: ['SDK', 'Software Development Kit', 'RequestedItemDetails'] ---- - - -# RequestedItemDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "ENTITLEMENT", "ROLE" ] | The type of access item requested. | [optional] -**Id** | Pointer to **String** | The id of the access item requested. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RequestedItemDetails = Initialize-PSSailpoint.V3RequestedItemDetails -Type ENTITLEMENT ` - -Id 779c6fd7171540bba1184e5946112c28 -``` - -- Convert the resource to JSON -```powershell -$RequestedItemDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RequestedItemStatus.md b/docs/tools/sdk/powershell/reference/v3/Models/RequestedItemStatus.md deleted file mode 100644 index 853fc5b8c..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RequestedItemStatus.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -id: requested-item-status -title: RequestedItemStatus -pagination_label: RequestedItemStatus -sidebar_label: RequestedItemStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatus'] -slug: /tools/sdk/powershell/v3/models/requested-item-status -tags: ['SDK', 'Software Development Kit', 'RequestedItemStatus'] ---- - - -# RequestedItemStatus - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | Human-readable display name of the item being requested. | [optional] -**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | Type of requested object. | [optional] -**CancelledRequestDetails** | Pointer to [**RequestedItemStatusCancelledRequestDetails**](requested-item-status-cancelled-request-details) | | [optional] -**ErrorMessages** | Pointer to [**[]ErrorMessageDto[]**](error-message-dto) | List of list of localized error messages, if any, encountered during the approval/provisioning process. | [optional] -**State** | Pointer to [**RequestedItemStatusRequestState**](requested-item-status-request-state) | | [optional] -**ApprovalDetails** | Pointer to [**[]ApprovalStatusDto**](approval-status-dto) | Approval details for each item. | [optional] -**ApprovalIds** | Pointer to **[]String** | List of approval IDs associated with the request. | [optional] -**ManualWorkItemDetails** | Pointer to [**[]ManualWorkItemDetails**](manual-work-item-details) | Manual work items created for provisioning the item. | [optional] -**AccountActivityItemId** | Pointer to **String** | Id of associated account activity item. | [optional] -**RequestType** | Pointer to [**AccessRequestType**](access-request-type) | | [optional] -**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] -**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] -**Requester** | Pointer to [**AccessItemRequester**](access-item-requester) | | [optional] -**RequestedFor** | Pointer to [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional] -**RequesterComment** | Pointer to [**RequestedItemStatusRequesterComment**](requested-item-status-requester-comment) | | [optional] -**SodViolationContext** | Pointer to [**RequestedItemStatusSodViolationContext**](requested-item-status-sod-violation-context) | | [optional] -**ProvisioningDetails** | Pointer to [**RequestedItemStatusProvisioningDetails**](requested-item-status-provisioning-details) | | [optional] -**PreApprovalTriggerDetails** | Pointer to [**RequestedItemStatusPreApprovalTriggerDetails**](requested-item-status-pre-approval-trigger-details) | | [optional] -**AccessRequestPhases** | Pointer to [**[]AccessRequestPhases**](access-request-phases) | A list of Phases that the Access Request has gone through in order, to help determine the status of the request. | [optional] -**Description** | Pointer to **String** | Description associated to the requested object. | [optional] -**RemoveDate** | Pointer to **System.DateTime** | When the role access is scheduled for removal. | [optional] -**Cancelable** | Pointer to **Boolean** | True if the request can be canceled. | [optional] [default to $false] -**AccessRequestId** | Pointer to **String** | This is the account activity id. | [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 -$RequestedItemStatus = Initialize-PSSailpoint.V3RequestedItemStatus -Name AccessProfile1 ` - -Type ACCESS_PROFILE ` - -CancelledRequestDetails null ` - -ErrorMessages null ` - -State null ` - -ApprovalDetails null ` - -ApprovalIds [85f0cf482dd44327b593624c07906c21, fa57e1bfa36f41ee85e33ee59fcbeac5] ` - -ManualWorkItemDetails null ` - -AccountActivityItemId 2c9180926cbfbddd016cbfc7c3b10010 ` - -RequestType null ` - -Modified 2019-08-23T18:52:59.162Z ` - -Created 2019-08-23T18:40:35.772Z ` - -Requester null ` - -RequestedFor null ` - -RequesterComment null ` - -SodViolationContext null ` - -ProvisioningDetails null ` - -PreApprovalTriggerDetails null ` - -AccessRequestPhases null ` - -Description This is the Engineering role that engineers are granted. ` - -RemoveDate 2019-10-23T00:00Z ` - -Cancelable true ` - -AccessRequestId 2b838de9-db9b-abcf-e646-d4f274ad4238 ` - -ClientMetadata {key1=value1, key2=value2} -``` - -- Convert the resource to JSON -```powershell -$RequestedItemStatus | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RequestedItemStatusCancelledRequestDetails.md b/docs/tools/sdk/powershell/reference/v3/Models/RequestedItemStatusCancelledRequestDetails.md deleted file mode 100644 index dca79dce9..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RequestedItemStatusCancelledRequestDetails.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: requested-item-status-cancelled-request-details -title: RequestedItemStatusCancelledRequestDetails -pagination_label: RequestedItemStatusCancelledRequestDetails -sidebar_label: RequestedItemStatusCancelledRequestDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusCancelledRequestDetails'] -slug: /tools/sdk/powershell/v3/models/requested-item-status-cancelled-request-details -tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusCancelledRequestDetails'] ---- - - -# RequestedItemStatusCancelledRequestDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Comment** | Pointer to **String** | Comment made by the owner when cancelling the associated request. | [optional] -**Owner** | Pointer to [**OwnerDto**](owner-dto) | | [optional] -**Modified** | Pointer to **System.DateTime** | Date comment was added by the owner when cancelling the associated request. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RequestedItemStatusCancelledRequestDetails = Initialize-PSSailpoint.V3RequestedItemStatusCancelledRequestDetails -Comment This request must be cancelled. ` - -Owner null ` - -Modified 2019-12-20T09:17:12.192Z -``` - -- Convert the resource to JSON -```powershell -$RequestedItemStatusCancelledRequestDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RequestedItemStatusPreApprovalTriggerDetails.md b/docs/tools/sdk/powershell/reference/v3/Models/RequestedItemStatusPreApprovalTriggerDetails.md deleted file mode 100644 index 0e9d8ec6e..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RequestedItemStatusPreApprovalTriggerDetails.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: requested-item-status-pre-approval-trigger-details -title: RequestedItemStatusPreApprovalTriggerDetails -pagination_label: RequestedItemStatusPreApprovalTriggerDetails -sidebar_label: RequestedItemStatusPreApprovalTriggerDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusPreApprovalTriggerDetails'] -slug: /tools/sdk/powershell/v3/models/requested-item-status-pre-approval-trigger-details -tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusPreApprovalTriggerDetails'] ---- - - -# RequestedItemStatusPreApprovalTriggerDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Comment** | Pointer to **String** | Comment left for the pre-approval decision | [optional] -**Reviewer** | Pointer to **String** | The reviewer of the pre-approval decision | [optional] -**Decision** | Pointer to **Enum** [ "APPROVED", "REJECTED" ] | The decision of the pre-approval trigger | [optional] - -## Examples - -- Prepare the resource -```powershell -$RequestedItemStatusPreApprovalTriggerDetails = Initialize-PSSailpoint.V3RequestedItemStatusPreApprovalTriggerDetails -Comment Access is Approved ` - -Reviewer John Doe ` - -Decision APPROVED -``` - -- Convert the resource to JSON -```powershell -$RequestedItemStatusPreApprovalTriggerDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RequestedItemStatusProvisioningDetails.md b/docs/tools/sdk/powershell/reference/v3/Models/RequestedItemStatusProvisioningDetails.md deleted file mode 100644 index 44a0c447d..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RequestedItemStatusProvisioningDetails.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: requested-item-status-provisioning-details -title: RequestedItemStatusProvisioningDetails -pagination_label: RequestedItemStatusProvisioningDetails -sidebar_label: RequestedItemStatusProvisioningDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusProvisioningDetails'] -slug: /tools/sdk/powershell/v3/models/requested-item-status-provisioning-details -tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusProvisioningDetails'] ---- - - -# RequestedItemStatusProvisioningDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**OrderedSubPhaseReferences** | Pointer to **String** | Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain ""manualWorkItemDetails"" which indicate that there is further information in that object for this phase. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RequestedItemStatusProvisioningDetails = Initialize-PSSailpoint.V3RequestedItemStatusProvisioningDetails -OrderedSubPhaseReferences manualWorkItemDetails -``` - -- Convert the resource to JSON -```powershell -$RequestedItemStatusProvisioningDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RequestedItemStatusRequestState.md b/docs/tools/sdk/powershell/reference/v3/Models/RequestedItemStatusRequestState.md deleted file mode 100644 index b41869cd8..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RequestedItemStatusRequestState.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: requested-item-status-request-state -title: RequestedItemStatusRequestState -pagination_label: RequestedItemStatusRequestState -sidebar_label: RequestedItemStatusRequestState -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusRequestState'] -slug: /tools/sdk/powershell/v3/models/requested-item-status-request-state -tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequestState'] ---- - - -# RequestedItemStatusRequestState - -## Enum - - -* `EXECUTING` (value: `"EXECUTING"`) - -* `REQUEST_COMPLETED` (value: `"REQUEST_COMPLETED"`) - -* `CANCELLED` (value: `"CANCELLED"`) - -* `TERMINATED` (value: `"TERMINATED"`) - -* `PROVISIONING_VERIFICATION_PENDING` (value: `"PROVISIONING_VERIFICATION_PENDING"`) - -* `REJECTED` (value: `"REJECTED"`) - -* `PROVISIONING_FAILED` (value: `"PROVISIONING_FAILED"`) - -* `NOT_ALL_ITEMS_PROVISIONED` (value: `"NOT_ALL_ITEMS_PROVISIONED"`) - -* `ERROR` (value: `"ERROR"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RequestedItemStatusRequestedFor.md b/docs/tools/sdk/powershell/reference/v3/Models/RequestedItemStatusRequestedFor.md deleted file mode 100644 index 54ae7b814..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RequestedItemStatusRequestedFor.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: requested-item-status-requested-for -title: RequestedItemStatusRequestedFor -pagination_label: RequestedItemStatusRequestedFor -sidebar_label: RequestedItemStatusRequestedFor -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusRequestedFor'] -slug: /tools/sdk/powershell/v3/models/requested-item-status-requested-for -tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequestedFor'] ---- - - -# RequestedItemStatusRequestedFor - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | Type of the object to which this reference applies | [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 -$RequestedItemStatusRequestedFor = Initialize-PSSailpoint.V3RequestedItemStatusRequestedFor -Type IDENTITY ` - -Id 2c9180835d191a86015d28455b4b232a ` - -Name William Wilson -``` - -- Convert the resource to JSON -```powershell -$RequestedItemStatusRequestedFor | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RequestedItemStatusRequesterComment.md b/docs/tools/sdk/powershell/reference/v3/Models/RequestedItemStatusRequesterComment.md deleted file mode 100644 index 63e54f519..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RequestedItemStatusRequesterComment.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: requested-item-status-requester-comment -title: RequestedItemStatusRequesterComment -pagination_label: RequestedItemStatusRequesterComment -sidebar_label: RequestedItemStatusRequesterComment -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusRequesterComment'] -slug: /tools/sdk/powershell/v3/models/requested-item-status-requester-comment -tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequesterComment'] ---- - - -# RequestedItemStatusRequesterComment - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Comment** | Pointer to **String** | Comment content. | [optional] -**Created** | Pointer to **System.DateTime** | Date and time comment was created. | [optional] -**Author** | Pointer to [**CommentDtoAuthor**](comment-dto-author) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$RequestedItemStatusRequesterComment = Initialize-PSSailpoint.V3RequestedItemStatusRequesterComment -Comment This is a comment. ` - -Created 2017-07-11T18:45:37.098Z ` - -Author null -``` - -- Convert the resource to JSON -```powershell -$RequestedItemStatusRequesterComment | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RequestedItemStatusSodViolationContext.md b/docs/tools/sdk/powershell/reference/v3/Models/RequestedItemStatusSodViolationContext.md deleted file mode 100644 index d3d62f98b..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RequestedItemStatusSodViolationContext.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: requested-item-status-sod-violation-context -title: RequestedItemStatusSodViolationContext -pagination_label: RequestedItemStatusSodViolationContext -sidebar_label: RequestedItemStatusSodViolationContext -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusSodViolationContext'] -slug: /tools/sdk/powershell/v3/models/requested-item-status-sod-violation-context -tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusSodViolationContext'] ---- - - -# RequestedItemStatusSodViolationContext - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**State** | Pointer to **Enum** [ "SUCCESS", "ERROR" ] | The status of SOD violation check | [optional] -**Uuid** | Pointer to **String** | The id of the Violation check event | [optional] -**ViolationCheckResult** | Pointer to [**SodViolationCheckResult**](sod-violation-check-result) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$RequestedItemStatusSodViolationContext = Initialize-PSSailpoint.V3RequestedItemStatusSodViolationContext -State SUCCESS ` - -Uuid f73d16e9-a038-46c5-b217-1246e15fdbdd ` - -ViolationCheckResult null -``` - -- Convert the resource to JSON -```powershell -$RequestedItemStatusSodViolationContext | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ReviewDecision.md b/docs/tools/sdk/powershell/reference/v3/Models/ReviewDecision.md deleted file mode 100644 index dcc5b184f..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ReviewDecision.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: review-decision -title: ReviewDecision -pagination_label: ReviewDecision -sidebar_label: ReviewDecision -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ReviewDecision'] -slug: /tools/sdk/powershell/v3/models/review-decision -tags: ['SDK', 'Software Development Kit', 'ReviewDecision'] ---- - - -# ReviewDecision - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The id of the review decision | [required] -**Decision** | [**CertificationDecision**](certification-decision) | | [required] -**ProposedEndDate** | Pointer to **System.DateTime** | The date at which a user's access should be taken away. Should only be set for `REVOKE` decisions. | [optional] -**Bulk** | **Boolean** | Indicates whether decision should be marked as part of a larger bulk decision | [required] -**Recommendation** | Pointer to [**ReviewRecommendation**](review-recommendation) | | [optional] -**Comments** | Pointer to **String** | Comments recorded when the decision was made | [optional] - -## Examples - -- Prepare the resource -```powershell -$ReviewDecision = Initialize-PSSailpoint.V3ReviewDecision -Id ef38f94347e94562b5bb8424a56397d8 ` - -Decision null ` - -ProposedEndDate 2017-07-11T18:45:37.098Z ` - -Bulk true ` - -Recommendation null ` - -Comments This user no longer needs access to this source -``` - -- Convert the resource to JSON -```powershell -$ReviewDecision | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ReviewReassign.md b/docs/tools/sdk/powershell/reference/v3/Models/ReviewReassign.md deleted file mode 100644 index 589fa3288..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ReviewReassign.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: review-reassign -title: ReviewReassign -pagination_label: ReviewReassign -sidebar_label: ReviewReassign -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ReviewReassign'] -slug: /tools/sdk/powershell/v3/models/review-reassign -tags: ['SDK', 'Software Development Kit', 'ReviewReassign'] ---- - - -# ReviewReassign - -## 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 -$ReviewReassign = Initialize-PSSailpoint.V3ReviewReassign -Reassign null ` - -ReassignTo ef38f94347e94562b5bb8424a56397d8 ` - -Reason reassigned for some reason -``` - -- Convert the resource to JSON -```powershell -$ReviewReassign | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ReviewRecommendation.md b/docs/tools/sdk/powershell/reference/v3/Models/ReviewRecommendation.md deleted file mode 100644 index d04cbfb89..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ReviewRecommendation.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: review-recommendation -title: ReviewRecommendation -pagination_label: ReviewRecommendation -sidebar_label: ReviewRecommendation -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ReviewRecommendation'] -slug: /tools/sdk/powershell/v3/models/review-recommendation -tags: ['SDK', 'Software Development Kit', 'ReviewRecommendation'] ---- - - -# ReviewRecommendation - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Recommendation** | Pointer to **String** | The recommendation from IAI at the time of the decision. This field will be null if no recommendation was made. | [optional] -**Reasons** | Pointer to **[]String** | A list of reasons for the recommendation. | [optional] -**Timestamp** | Pointer to **System.DateTime** | The time at which the recommendation was recorded. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ReviewRecommendation = Initialize-PSSailpoint.V3ReviewRecommendation -Recommendation null ` - -Reasons [Reason 1, Reason 2] ` - -Timestamp 2020-06-01T13:49:37.385Z -``` - -- Convert the resource to JSON -```powershell -$ReviewRecommendation | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ReviewableAccessProfile.md b/docs/tools/sdk/powershell/reference/v3/Models/ReviewableAccessProfile.md deleted file mode 100644 index a03e9c905..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ReviewableAccessProfile.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: reviewable-access-profile -title: ReviewableAccessProfile -pagination_label: ReviewableAccessProfile -sidebar_label: ReviewableAccessProfile -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ReviewableAccessProfile'] -slug: /tools/sdk/powershell/v3/models/reviewable-access-profile -tags: ['SDK', 'Software Development Kit', 'ReviewableAccessProfile'] ---- - - -# ReviewableAccessProfile - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The id of the Access Profile | [optional] -**Name** | Pointer to **String** | Name of the Access Profile | [optional] -**Description** | Pointer to **String** | Information about the Access Profile | [optional] -**Privileged** | Pointer to **Boolean** | Indicates if the entitlement is a privileged entitlement | [optional] -**CloudGoverned** | Pointer to **Boolean** | True if the entitlement is cloud governed | [optional] -**EndDate** | Pointer to **System.DateTime** | The date at which a user's access expires | [optional] -**Owner** | Pointer to [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] -**Entitlements** | Pointer to [**[]ReviewableEntitlement**](reviewable-entitlement) | A list of entitlements associated with this Access Profile | [optional] -**Created** | Pointer to **System.DateTime** | Date the Access Profile was created. | [optional] -**Modified** | Pointer to **System.DateTime** | Date the Access Profile was last modified. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ReviewableAccessProfile = Initialize-PSSailpoint.V3ReviewableAccessProfile -Id 2c91808a7190d06e01719938fcd20792 ` - -Name Employee-database-read-write ` - -Description Collection of entitlements to read/write the employee database ` - -Privileged false ` - -CloudGoverned false ` - -EndDate 2021-12-25T00:00Z ` - -Owner null ` - -Entitlements null ` - -Created 2021-01-01T22:32:58.104Z ` - -Modified 2021-02-01T22:32:58.104Z -``` - -- Convert the resource to JSON -```powershell -$ReviewableAccessProfile | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ReviewableEntitlement.md b/docs/tools/sdk/powershell/reference/v3/Models/ReviewableEntitlement.md deleted file mode 100644 index a5efe4dff..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ReviewableEntitlement.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -id: reviewable-entitlement -title: ReviewableEntitlement -pagination_label: ReviewableEntitlement -sidebar_label: ReviewableEntitlement -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ReviewableEntitlement'] -slug: /tools/sdk/powershell/v3/models/reviewable-entitlement -tags: ['SDK', 'Software Development Kit', 'ReviewableEntitlement'] ---- - - -# ReviewableEntitlement - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The id for the entitlement | [optional] -**Name** | Pointer to **String** | The name of the entitlement | [optional] -**Description** | Pointer to **String** | Information about the entitlement | [optional] -**Privileged** | Pointer to **Boolean** | Indicates if the entitlement is a privileged entitlement | [optional] [default to $false] -**Owner** | Pointer to [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] -**AttributeName** | Pointer to **String** | The name of the attribute on the source | [optional] -**AttributeValue** | Pointer to **String** | The value of the attribute on the source | [optional] -**SourceSchemaObjectType** | Pointer to **String** | The schema object type on the source used to represent the entitlement and its attributes | [optional] -**SourceName** | Pointer to **String** | The name of the source for which this entitlement belongs | [optional] -**SourceType** | Pointer to **String** | The type of the source for which the entitlement belongs | [optional] -**SourceId** | Pointer to **String** | The ID of the source for which the entitlement belongs | [optional] -**HasPermissions** | Pointer to **Boolean** | Indicates if the entitlement has permissions | [optional] [default to $false] -**IsPermission** | Pointer to **Boolean** | Indicates if the entitlement is a representation of an account permission | [optional] [default to $false] -**Revocable** | Pointer to **Boolean** | Indicates whether the entitlement can be revoked | [optional] [default to $false] -**CloudGoverned** | Pointer to **Boolean** | True if the entitlement is cloud governed | [optional] [default to $false] -**ContainsDataAccess** | Pointer to **Boolean** | True if the entitlement has DAS data | [optional] [default to $false] -**DataAccess** | Pointer to [**DataAccess**](data-access) | | [optional] -**Account** | Pointer to [**ReviewableEntitlementAccount**](reviewable-entitlement-account) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ReviewableEntitlement = Initialize-PSSailpoint.V3ReviewableEntitlement -Id 2c918085718230600171993742c63558 ` - -Name CN=entitlement.bbb7c650 ` - -Description Gives read/write access to the company database ` - -Privileged false ` - -Owner null ` - -AttributeName memberOf ` - -AttributeValue CN=entitlement.bbb7c650 ` - -SourceSchemaObjectType groups ` - -SourceName ODS-AD-Source ` - -SourceType Active Directory - Direct ` - -SourceId 78ca6be511cb41fbb86dba2fcca7780c ` - -HasPermissions false ` - -IsPermission false ` - -Revocable true ` - -CloudGoverned false ` - -ContainsDataAccess true ` - -DataAccess null ` - -Account null -``` - -- Convert the resource to JSON -```powershell -$ReviewableEntitlement | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ReviewableEntitlementAccount.md b/docs/tools/sdk/powershell/reference/v3/Models/ReviewableEntitlementAccount.md deleted file mode 100644 index 2d0d3cfc8..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ReviewableEntitlementAccount.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -id: reviewable-entitlement-account -title: ReviewableEntitlementAccount -pagination_label: ReviewableEntitlementAccount -sidebar_label: ReviewableEntitlementAccount -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ReviewableEntitlementAccount'] -slug: /tools/sdk/powershell/v3/models/reviewable-entitlement-account -tags: ['SDK', 'Software Development Kit', 'ReviewableEntitlementAccount'] ---- - - -# ReviewableEntitlementAccount - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**NativeIdentity** | Pointer to **String** | The native identity for this account | [optional] -**Disabled** | Pointer to **Boolean** | Indicates whether this account is currently disabled | [optional] [default to $false] -**Locked** | Pointer to **Boolean** | Indicates whether this account is currently locked | [optional] [default to $false] -**Type** | Pointer to [**DtoType**](dto-type) | | [optional] -**Id** | Pointer to **String** | The id associated with the account | [optional] -**Name** | Pointer to **String** | The account name | [optional] -**Created** | Pointer to **System.DateTime** | When the account was created | [optional] -**Modified** | Pointer to **System.DateTime** | When the account was last modified | [optional] -**ActivityInsights** | Pointer to [**ActivityInsights**](activity-insights) | | [optional] -**Description** | Pointer to **String** | Information about the account | [optional] -**GovernanceGroupId** | Pointer to **String** | The id associated with the machine Account Governance Group | [optional] -**Owner** | Pointer to [**ReviewableEntitlementAccountOwner**](reviewable-entitlement-account-owner) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ReviewableEntitlementAccount = Initialize-PSSailpoint.V3ReviewableEntitlementAccount -NativeIdentity CN=Alison Ferguso ` - -Disabled false ` - -Locked false ` - -Type null ` - -Id 2c9180857182305e0171993737eb29e6 ` - -Name Alison Ferguso ` - -Created 2020-04-20T20:11:05.067Z ` - -Modified 2020-05-20T18:57:16.987Z ` - -ActivityInsights null ` - -Description Account for Read/write to the company database ` - -GovernanceGroupId 2c9180857182305e0171993737eb29e6 ` - -Owner null -``` - -- Convert the resource to JSON -```powershell -$ReviewableEntitlementAccount | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ReviewableEntitlementAccountOwner.md b/docs/tools/sdk/powershell/reference/v3/Models/ReviewableEntitlementAccountOwner.md deleted file mode 100644 index 2708f6ec5..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ReviewableEntitlementAccountOwner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: reviewable-entitlement-account-owner -title: ReviewableEntitlementAccountOwner -pagination_label: ReviewableEntitlementAccountOwner -sidebar_label: ReviewableEntitlementAccountOwner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ReviewableEntitlementAccountOwner'] -slug: /tools/sdk/powershell/v3/models/reviewable-entitlement-account-owner -tags: ['SDK', 'Software Development Kit', 'ReviewableEntitlementAccountOwner'] ---- - - -# ReviewableEntitlementAccountOwner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The id associated with the machine account owner | [optional] -**Type** | Pointer to **Enum** [ "IDENTITY" ] | An enumeration of the types of Owner supported within the IdentityNow infrastructure. | [optional] -**DisplayName** | Pointer to **String** | The machine account owner's display name | [optional] - -## Examples - -- Prepare the resource -```powershell -$ReviewableEntitlementAccountOwner = Initialize-PSSailpoint.V3ReviewableEntitlementAccountOwner -Id 2c9180857182305e0171993737eb29e8 ` - -Type IDENTITY ` - -DisplayName Alison Ferguson -``` - -- Convert the resource to JSON -```powershell -$ReviewableEntitlementAccountOwner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ReviewableRole.md b/docs/tools/sdk/powershell/reference/v3/Models/ReviewableRole.md deleted file mode 100644 index 3327485c6..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ReviewableRole.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: reviewable-role -title: ReviewableRole -pagination_label: ReviewableRole -sidebar_label: ReviewableRole -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ReviewableRole'] -slug: /tools/sdk/powershell/v3/models/reviewable-role -tags: ['SDK', 'Software Development Kit', 'ReviewableRole'] ---- - - -# ReviewableRole - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The id for the Role | [optional] -**Name** | Pointer to **String** | The name of the Role | [optional] -**Description** | Pointer to **String** | Information about the Role | [optional] -**Privileged** | Pointer to **Boolean** | Indicates if the entitlement is a privileged entitlement | [optional] -**Owner** | Pointer to [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] -**Revocable** | Pointer to **Boolean** | Indicates whether the Role can be revoked or requested | [optional] -**EndDate** | Pointer to **System.DateTime** | The date when a user's access expires. | [optional] -**AccessProfiles** | Pointer to [**[]ReviewableAccessProfile**](reviewable-access-profile) | The list of Access Profiles associated with this Role | [optional] -**Entitlements** | Pointer to [**[]ReviewableEntitlement**](reviewable-entitlement) | The list of entitlements associated with this Role | [optional] - -## Examples - -- Prepare the resource -```powershell -$ReviewableRole = Initialize-PSSailpoint.V3ReviewableRole -Id 2c91808a7190d06e0171993907fd0794 ` - -Name Accounting-Employees ` - -Description Role for members of the accounting department with the necessary Access Profiles ` - -Privileged false ` - -Owner null ` - -Revocable false ` - -EndDate 2021-12-25T00:00Z ` - -AccessProfiles null ` - -Entitlements null -``` - -- Convert the resource to JSON -```powershell -$ReviewableRole | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Reviewer.md b/docs/tools/sdk/powershell/reference/v3/Models/Reviewer.md deleted file mode 100644 index 73ff33150..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Reviewer.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: reviewer -title: Reviewer -pagination_label: Reviewer -sidebar_label: Reviewer -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Reviewer'] -slug: /tools/sdk/powershell/v3/models/reviewer -tags: ['SDK', 'Software Development Kit', 'Reviewer'] ---- - - -# Reviewer - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The id of the reviewer. | [optional] -**Name** | Pointer to **String** | The name of the reviewer. | [optional] -**Email** | Pointer to **String** | The email of the reviewing identity. | [optional] -**Type** | Pointer to **Enum** [ "IDENTITY" ] | The type of the reviewing identity. | [optional] -**Created** | Pointer to **System.DateTime** | The created date of the reviewing identity. | [optional] -**Modified** | Pointer to **System.DateTime** | The modified date of the reviewing identity. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Reviewer = Initialize-PSSailpoint.V3Reviewer -Id ef38f94347e94562b5bb8424a56397d8 ` - -Name Reviewer Name ` - -Email reviewer@test.com ` - -Type IDENTITY ` - -Created 2018-06-25T20:22:28.104Z ` - -Modified 2018-06-25T20:22:28.104Z -``` - -- Convert the resource to JSON -```powershell -$Reviewer | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Revocability.md b/docs/tools/sdk/powershell/reference/v3/Models/Revocability.md deleted file mode 100644 index 2c11296a0..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Revocability.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: revocability -title: Revocability -pagination_label: Revocability -sidebar_label: Revocability -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Revocability'] -slug: /tools/sdk/powershell/v3/models/revocability -tags: ['SDK', 'Software Development Kit', 'Revocability'] ---- - - -# Revocability - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ApprovalSchemes** | Pointer to [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the revocation request | [optional] - -## Examples - -- Prepare the resource -```powershell -$Revocability = Initialize-PSSailpoint.V3Revocability -ApprovalSchemes null -``` - -- Convert the resource to JSON -```powershell -$Revocability | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RevocabilityForRole.md b/docs/tools/sdk/powershell/reference/v3/Models/RevocabilityForRole.md deleted file mode 100644 index a8964225f..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RevocabilityForRole.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: revocability-for-role -title: RevocabilityForRole -pagination_label: RevocabilityForRole -sidebar_label: RevocabilityForRole -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RevocabilityForRole'] -slug: /tools/sdk/powershell/v3/models/revocability-for-role -tags: ['SDK', 'Software Development Kit', 'RevocabilityForRole'] ---- - - -# RevocabilityForRole - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CommentsRequired** | Pointer to **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] -**DenialCommentsRequired** | Pointer to **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] -**ApprovalSchemes** | Pointer to [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the revocation request | [optional] - -## Examples - -- Prepare the resource -```powershell -$RevocabilityForRole = Initialize-PSSailpoint.V3RevocabilityForRole -CommentsRequired false ` - -DenialCommentsRequired false ` - -ApprovalSchemes null -``` - -- Convert the resource to JSON -```powershell -$RevocabilityForRole | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RightPad.md b/docs/tools/sdk/powershell/reference/v3/Models/RightPad.md deleted file mode 100644 index a290bfe17..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RightPad.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: right-pad -title: RightPad -pagination_label: RightPad -sidebar_label: RightPad -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RightPad'] -slug: /tools/sdk/powershell/v3/models/right-pad -tags: ['SDK', 'Software Development Kit', 'RightPad'] ---- - - -# RightPad - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Length** | **String** | An integer value for the desired length of the final output string | [required] -**Padding** | Pointer to **String** | A string value representing the character that the incoming data should be padded with to get to the desired length If not provided, the transform will default to a single space ("" "") character for padding | [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 -$RightPad = Initialize-PSSailpoint.V3RightPad -Length 4 ` - -Padding 0 ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$RightPad | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Role.md b/docs/tools/sdk/powershell/reference/v3/Models/Role.md deleted file mode 100644 index 66f938819..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Role.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -id: role -title: Role -pagination_label: Role -sidebar_label: Role -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Role'] -slug: /tools/sdk/powershell/v3/models/role -tags: ['SDK', 'Software Development Kit', 'Role'] ---- - - -# Role - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result. | [optional] -**Name** | **String** | The human-readable display name of the Role | [required] -**Created** | Pointer to **System.DateTime** | Date the Role was created | [optional] [readonly] -**Modified** | Pointer to **System.DateTime** | Date the Role was last modified. | [optional] [readonly] -**Description** | Pointer to **String** | A human-readable description of the Role | [optional] -**Owner** | [**OwnerReference**](owner-reference) | | [required] -**AccessProfiles** | Pointer to [**[]AccessProfileRef**](access-profile-ref) | | [optional] -**Entitlements** | Pointer to [**[]EntitlementRef**](entitlement-ref) | | [optional] -**Membership** | Pointer to [**RoleMembershipSelector**](role-membership-selector) | | [optional] -**LegacyMembershipInfo** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. | [optional] -**Enabled** | Pointer to **Boolean** | Whether the Role is enabled or not. | [optional] [default to $false] -**Requestable** | Pointer to **Boolean** | Whether the Role can be the target of access requests. | [optional] [default to $false] -**AccessRequestConfig** | Pointer to [**RequestabilityForRole**](requestability-for-role) | | [optional] -**RevocationRequestConfig** | Pointer to [**RevocabilityForRole**](revocability-for-role) | | [optional] -**Segments** | Pointer to **[]String** | List of IDs of segments, if any, to which this Role is assigned. | [optional] -**Dimensional** | Pointer to **Boolean** | Whether the Role is dimensional. | [optional] [default to $false] -**DimensionRefs** | Pointer to [**[]DimensionRef**](dimension-ref) | List of references to dimensions to which this Role is assigned. This field is only relevant if the Role is dimensional. | [optional] -**AccessModelMetadata** | Pointer to [**AttributeDTOList**](attribute-dto-list) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$Role = Initialize-PSSailpoint.V3Role -Id 2c918086749d78830174a1a40e121518 ` - -Name Role 2567 ` - -Created 2021-03-01T22:32:58.104Z ` - -Modified 2021-03-02T20:22:28.104Z ` - -Description Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor. ` - -Owner null ` - -AccessProfiles null ` - -Entitlements null ` - -Membership null ` - -LegacyMembershipInfo {type=IDENTITY_LIST} ` - -Enabled true ` - -Requestable true ` - -AccessRequestConfig null ` - -RevocationRequestConfig null ` - -Segments [f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a] ` - -Dimensional null ` - -DimensionRefs null ` - -AccessModelMetadata null -``` - -- Convert the resource to JSON -```powershell -$Role | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RoleAssignmentSourceType.md b/docs/tools/sdk/powershell/reference/v3/Models/RoleAssignmentSourceType.md deleted file mode 100644 index 8c7adfad2..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RoleAssignmentSourceType.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: role-assignment-source-type -title: RoleAssignmentSourceType -pagination_label: RoleAssignmentSourceType -sidebar_label: RoleAssignmentSourceType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleAssignmentSourceType'] -slug: /tools/sdk/powershell/v3/models/role-assignment-source-type -tags: ['SDK', 'Software Development Kit', 'RoleAssignmentSourceType'] ---- - - -# RoleAssignmentSourceType - -## Enum - - -* `ACCESS_REQUEST` (value: `"ACCESS_REQUEST"`) - -* `ROLE_MEMBERSHIP` (value: `"ROLE_MEMBERSHIP"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RoleBulkDeleteRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/RoleBulkDeleteRequest.md deleted file mode 100644 index a1ae852f8..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RoleBulkDeleteRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: role-bulk-delete-request -title: RoleBulkDeleteRequest -pagination_label: RoleBulkDeleteRequest -sidebar_label: RoleBulkDeleteRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleBulkDeleteRequest'] -slug: /tools/sdk/powershell/v3/models/role-bulk-delete-request -tags: ['SDK', 'Software Development Kit', 'RoleBulkDeleteRequest'] ---- - - -# RoleBulkDeleteRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RoleIds** | **[]String** | List of IDs of Roles to be deleted. | [required] - -## Examples - -- Prepare the resource -```powershell -$RoleBulkDeleteRequest = Initialize-PSSailpoint.V3RoleBulkDeleteRequest -RoleIds [2c9180847812e0b1017817051919ecca, 2c9180887812e0b201781e129f151816] -``` - -- Convert the resource to JSON -```powershell -$RoleBulkDeleteRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RoleCriteriaKey.md b/docs/tools/sdk/powershell/reference/v3/Models/RoleCriteriaKey.md deleted file mode 100644 index a141b4064..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RoleCriteriaKey.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: role-criteria-key -title: RoleCriteriaKey -pagination_label: RoleCriteriaKey -sidebar_label: RoleCriteriaKey -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaKey'] -slug: /tools/sdk/powershell/v3/models/role-criteria-key -tags: ['SDK', 'Software Development Kit', 'RoleCriteriaKey'] ---- - - -# RoleCriteriaKey - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | [**RoleCriteriaKeyType**](role-criteria-key-type) | | [required] -**Property** | **String** | The name of the attribute or entitlement to which the associated criteria applies. | [required] -**SourceId** | Pointer to **String** | ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleCriteriaKey = Initialize-PSSailpoint.V3RoleCriteriaKey -Type null ` - -Property attribute.email ` - -SourceId 2c9180867427f3a301745aec18211519 -``` - -- Convert the resource to JSON -```powershell -$RoleCriteriaKey | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RoleCriteriaKeyType.md b/docs/tools/sdk/powershell/reference/v3/Models/RoleCriteriaKeyType.md deleted file mode 100644 index 628acc33a..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RoleCriteriaKeyType.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: role-criteria-key-type -title: RoleCriteriaKeyType -pagination_label: RoleCriteriaKeyType -sidebar_label: RoleCriteriaKeyType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaKeyType'] -slug: /tools/sdk/powershell/v3/models/role-criteria-key-type -tags: ['SDK', 'Software Development Kit', 'RoleCriteriaKeyType'] ---- - - -# RoleCriteriaKeyType - -## Enum - - -* `IDENTITY` (value: `"IDENTITY"`) - -* `ACCOUNT` (value: `"ACCOUNT"`) - -* `ENTITLEMENT` (value: `"ENTITLEMENT"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RoleCriteriaLevel1.md b/docs/tools/sdk/powershell/reference/v3/Models/RoleCriteriaLevel1.md deleted file mode 100644 index edb52f7db..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RoleCriteriaLevel1.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: role-criteria-level1 -title: RoleCriteriaLevel1 -pagination_label: RoleCriteriaLevel1 -sidebar_label: RoleCriteriaLevel1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaLevel1'] -slug: /tools/sdk/powershell/v3/models/role-criteria-level1 -tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel1'] ---- - - -# RoleCriteriaLevel1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operation** | Pointer to [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] -**Key** | Pointer to [**RoleCriteriaKey**](role-criteria-key) | | [optional] -**StringValue** | Pointer to **String** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [optional] -**Children** | Pointer to [**[]RoleCriteriaLevel2**](role-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleCriteriaLevel1 = Initialize-PSSailpoint.V3RoleCriteriaLevel1 -Operation null ` - -Key null ` - -StringValue carlee.cert1c9f9b6fd@mailinator.com ` - -Children null -``` - -- Convert the resource to JSON -```powershell -$RoleCriteriaLevel1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RoleCriteriaLevel2.md b/docs/tools/sdk/powershell/reference/v3/Models/RoleCriteriaLevel2.md deleted file mode 100644 index e87352846..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RoleCriteriaLevel2.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: role-criteria-level2 -title: RoleCriteriaLevel2 -pagination_label: RoleCriteriaLevel2 -sidebar_label: RoleCriteriaLevel2 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaLevel2'] -slug: /tools/sdk/powershell/v3/models/role-criteria-level2 -tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel2'] ---- - - -# RoleCriteriaLevel2 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operation** | Pointer to [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] -**Key** | Pointer to [**RoleCriteriaKey**](role-criteria-key) | | [optional] -**StringValue** | Pointer to **String** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [optional] -**Children** | Pointer to [**[]RoleCriteriaLevel3**](role-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleCriteriaLevel2 = Initialize-PSSailpoint.V3RoleCriteriaLevel2 -Operation null ` - -Key null ` - -StringValue carlee.cert1c9f9b6fd@mailinator.com ` - -Children null -``` - -- Convert the resource to JSON -```powershell -$RoleCriteriaLevel2 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RoleCriteriaLevel3.md b/docs/tools/sdk/powershell/reference/v3/Models/RoleCriteriaLevel3.md deleted file mode 100644 index 13ef86d7a..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RoleCriteriaLevel3.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: role-criteria-level3 -title: RoleCriteriaLevel3 -pagination_label: RoleCriteriaLevel3 -sidebar_label: RoleCriteriaLevel3 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaLevel3'] -slug: /tools/sdk/powershell/v3/models/role-criteria-level3 -tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel3'] ---- - - -# RoleCriteriaLevel3 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operation** | Pointer to [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] -**Key** | Pointer to [**RoleCriteriaKey**](role-criteria-key) | | [optional] -**StringValue** | Pointer to **String** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleCriteriaLevel3 = Initialize-PSSailpoint.V3RoleCriteriaLevel3 -Operation null ` - -Key null ` - -StringValue carlee.cert1c9f9b6fd@mailinator.com -``` - -- Convert the resource to JSON -```powershell -$RoleCriteriaLevel3 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RoleCriteriaOperation.md b/docs/tools/sdk/powershell/reference/v3/Models/RoleCriteriaOperation.md deleted file mode 100644 index 306bf1c1b..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RoleCriteriaOperation.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: role-criteria-operation -title: RoleCriteriaOperation -pagination_label: RoleCriteriaOperation -sidebar_label: RoleCriteriaOperation -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaOperation'] -slug: /tools/sdk/powershell/v3/models/role-criteria-operation -tags: ['SDK', 'Software Development Kit', 'RoleCriteriaOperation'] ---- - - -# RoleCriteriaOperation - -## Enum - - -* `EQUALS` (value: `"EQUALS"`) - -* `NOT_EQUALS` (value: `"NOT_EQUALS"`) - -* `CONTAINS` (value: `"CONTAINS"`) - -* `STARTS_WITH` (value: `"STARTS_WITH"`) - -* `ENDS_WITH` (value: `"ENDS_WITH"`) - -* `AND` (value: `"AND"`) - -* `OR` (value: `"OR"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RoleDocument.md b/docs/tools/sdk/powershell/reference/v3/Models/RoleDocument.md deleted file mode 100644 index e33bff1b3..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RoleDocument.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -id: role-document -title: RoleDocument -pagination_label: RoleDocument -sidebar_label: RoleDocument -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleDocument'] -slug: /tools/sdk/powershell/v3/models/role-document -tags: ['SDK', 'Software Development Kit', 'RoleDocument'] ---- - - -# RoleDocument - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The unique ID of the referenced object. | [required] -**Name** | **String** | The human readable name of the referenced object. | [required] -**Type** | [**DocumentType**](document-type) | | [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] -**AccessProfiles** | Pointer to [**[]BaseAccessProfile**](base-access-profile) | Access profiles included with the role. | [optional] -**AccessProfileCount** | Pointer to **Int32** | Number of access profiles included with the role. | [optional] -**Tags** | Pointer to **[]String** | Tags that have been applied to the object. | [optional] -**Segments** | Pointer to [**[]BaseSegment**](base-segment) | Segments with the role. | [optional] -**SegmentCount** | Pointer to **Int32** | Number of segments with the role. | [optional] -**Entitlements** | Pointer to [**[]BaseEntitlement**](base-entitlement) | Entitlements included with the role. | [optional] -**EntitlementCount** | Pointer to **Int32** | Number of entitlements included with the role. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleDocument = Initialize-PSSailpoint.V3RoleDocument -Id 2c91808568c529c60168cca6f90c1313 ` - -Name John Doe ` - -Type null ` - -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 ` - -AccessProfiles null ` - -AccessProfileCount 1 ` - -Tags [TAG_1, TAG_2] ` - -Segments null ` - -SegmentCount 1 ` - -Entitlements null ` - -EntitlementCount 3 -``` - -- Convert the resource to JSON -```powershell -$RoleDocument | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RoleIdentity.md b/docs/tools/sdk/powershell/reference/v3/Models/RoleIdentity.md deleted file mode 100644 index 9303296f9..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RoleIdentity.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: role-identity -title: RoleIdentity -pagination_label: RoleIdentity -sidebar_label: RoleIdentity -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleIdentity'] -slug: /tools/sdk/powershell/v3/models/role-identity -tags: ['SDK', 'Software Development Kit', 'RoleIdentity'] ---- - - -# RoleIdentity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The ID of the Identity | [optional] -**AliasName** | Pointer to **String** | The alias / username of the Identity | [optional] -**Name** | Pointer to **String** | The human-readable display name of the Identity | [optional] -**Email** | Pointer to **String** | Email address of the Identity | [optional] -**RoleAssignmentSource** | Pointer to [**RoleAssignmentSourceType**](role-assignment-source-type) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleIdentity = Initialize-PSSailpoint.V3RoleIdentity -Id 2c9180a46faadee4016fb4e018c20639 ` - -AliasName t.edison ` - -Name Thomas Edison ` - -Email t.edison@identitynow.com ` - -RoleAssignmentSource null -``` - -- Convert the resource to JSON -```powershell -$RoleIdentity | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RoleMembershipIdentity.md b/docs/tools/sdk/powershell/reference/v3/Models/RoleMembershipIdentity.md deleted file mode 100644 index 8705c0246..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RoleMembershipIdentity.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: role-membership-identity -title: RoleMembershipIdentity -pagination_label: RoleMembershipIdentity -sidebar_label: RoleMembershipIdentity -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMembershipIdentity'] -slug: /tools/sdk/powershell/v3/models/role-membership-identity -tags: ['SDK', 'Software Development Kit', 'RoleMembershipIdentity'] ---- - - -# RoleMembershipIdentity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to [**DtoType**](dto-type) | | [optional] -**Id** | Pointer to **String** | Identity id | [optional] -**Name** | Pointer to **String** | Human-readable display name of the Identity. | [optional] -**AliasName** | Pointer to **String** | User name of the Identity | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleMembershipIdentity = Initialize-PSSailpoint.V3RoleMembershipIdentity -Type null ` - -Id 2c9180a46faadee4016fb4e018c20639 ` - -Name Thomas Edison ` - -AliasName t.edison -``` - -- Convert the resource to JSON -```powershell -$RoleMembershipIdentity | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RoleMembershipSelector.md b/docs/tools/sdk/powershell/reference/v3/Models/RoleMembershipSelector.md deleted file mode 100644 index bc95ab3b6..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RoleMembershipSelector.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: role-membership-selector -title: RoleMembershipSelector -pagination_label: RoleMembershipSelector -sidebar_label: RoleMembershipSelector -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMembershipSelector'] -slug: /tools/sdk/powershell/v3/models/role-membership-selector -tags: ['SDK', 'Software Development Kit', 'RoleMembershipSelector'] ---- - - -# RoleMembershipSelector - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to [**RoleMembershipSelectorType**](role-membership-selector-type) | | [optional] -**Criteria** | Pointer to [**RoleCriteriaLevel1**](role-criteria-level1) | | [optional] -**Identities** | Pointer to [**[]RoleMembershipIdentity**](role-membership-identity) | Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleMembershipSelector = Initialize-PSSailpoint.V3RoleMembershipSelector -Type null ` - -Criteria null ` - -Identities null -``` - -- Convert the resource to JSON -```powershell -$RoleMembershipSelector | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RoleMembershipSelectorType.md b/docs/tools/sdk/powershell/reference/v3/Models/RoleMembershipSelectorType.md deleted file mode 100644 index 928de868b..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RoleMembershipSelectorType.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: role-membership-selector-type -title: RoleMembershipSelectorType -pagination_label: RoleMembershipSelectorType -sidebar_label: RoleMembershipSelectorType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMembershipSelectorType'] -slug: /tools/sdk/powershell/v3/models/role-membership-selector-type -tags: ['SDK', 'Software Development Kit', 'RoleMembershipSelectorType'] ---- - - -# RoleMembershipSelectorType - -## Enum - - -* `STANDARD` (value: `"STANDARD"`) - -* `IDENTITY_LIST` (value: `"IDENTITY_LIST"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/RoleSummary.md b/docs/tools/sdk/powershell/reference/v3/Models/RoleSummary.md deleted file mode 100644 index 41a5d3e73..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/RoleSummary.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: role-summary -title: RoleSummary -pagination_label: RoleSummary -sidebar_label: RoleSummary -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleSummary'] -slug: /tools/sdk/powershell/v3/models/role-summary -tags: ['SDK', 'Software Development Kit', 'RoleSummary'] ---- - - -# RoleSummary - -## 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 -$RoleSummary = Initialize-PSSailpoint.V3RoleSummary -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 -$RoleSummary | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Rule.md b/docs/tools/sdk/powershell/reference/v3/Models/Rule.md deleted file mode 100644 index d43aa4563..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Rule.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: rule -title: Rule -pagination_label: Rule -sidebar_label: Rule -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Rule'] -slug: /tools/sdk/powershell/v3/models/rule -tags: ['SDK', 'Software Development Kit', 'Rule'] ---- - - -# Rule - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | This must always be set to ""Cloud Services Deployment Utility"" | [required] -**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] -**Operation** | **String** | The operation to perform `getReferenceIdentityAttribute` | [required] -**IncludeNumbers** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include numbers | [required] -**IncludeSpecialChars** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include special characters | [required] -**Length** | **String** | This specifies how long the randomly generated string needs to be >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters | [required] -**Uid** | **String** | This is the SailPoint User Name (uid) value of the identity whose attribute is desired As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. | [required] - -## Examples - -- Prepare the resource -```powershell -$Rule = Initialize-PSSailpoint.V3Rule -Name Cloud Services Deployment Utility ` - -RequiresPeriodicRefresh false ` - -Operation getReferenceIdentityAttribute ` - -IncludeNumbers true ` - -IncludeSpecialChars true ` - -Length 10 ` - -Uid 2c91808570313110017040b06f344ec9 -``` - -- Convert the resource to JSON -```powershell -$Rule | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SavedSearch.md b/docs/tools/sdk/powershell/reference/v3/Models/SavedSearch.md deleted file mode 100644 index c5257a6ad..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SavedSearch.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -id: saved-search -title: SavedSearch -pagination_label: SavedSearch -sidebar_label: SavedSearch -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearch'] -slug: /tools/sdk/powershell/v3/models/saved-search -tags: ['SDK', 'Software Development Kit', 'SavedSearch'] ---- - - -# SavedSearch - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | The name of the saved search. | [optional] -**Description** | Pointer to **String** | The description of the saved search. | [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] -**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required] -**Columns** | Pointer to [**map[string]Column[]**](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_arrays?view=powershell-7.4) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional] -**Query** | **String** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [required] -**Fields** | Pointer to **[]String** | The fields to be searched against in a multi-field query. | [optional] -**OrderBy** | Pointer to **map[string]String[]** | Sort by index. This takes precedence over the `sort` property. | [optional] -**Sort** | Pointer to **[]String** | The fields to be used to sort the search results. | [optional] -**Filters** | Pointer to [**SavedSearchDetailFilters**](saved-search-detail-filters) | | [optional] -**Id** | Pointer to **String** | The saved search ID. | [optional] -**Owner** | Pointer to [**TypedReference**](typed-reference) | | [optional] -**OwnerId** | Pointer to **String** | The ID of the identity that owns this saved search. | [optional] -**Public** | Pointer to **Boolean** | Whether this saved search is visible to anyone but the owner. This field will always be false as there is no way to set a saved search as public at this time. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$SavedSearch = Initialize-PSSailpoint.V3SavedSearch -Name Disabled accounts ` - -Description Disabled accounts ` - -Created 2018-06-25T20:22:28.104Z ` - -Modified 2018-06-25T20:22:28.104Z ` - -Indices [identities] ` - -Columns {identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]} ` - -Query @accounts(disabled:true) ` - -Fields [disabled] ` - -OrderBy {identity=[lastName, firstName], role=[name]} ` - -Sort [displayName] ` - -Filters null ` - -Id 0de46054-fe90-434a-b84e-c6b3359d0c64 ` - -Owner null ` - -OwnerId 2c91808568c529c60168cca6f90c1313 ` - -Public false -``` - -- Convert the resource to JSON -```powershell -$SavedSearch | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SavedSearchDetail.md b/docs/tools/sdk/powershell/reference/v3/Models/SavedSearchDetail.md deleted file mode 100644 index 9170940bc..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SavedSearchDetail.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: saved-search-detail -title: SavedSearchDetail -pagination_label: SavedSearchDetail -sidebar_label: SavedSearchDetail -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearchDetail'] -slug: /tools/sdk/powershell/v3/models/saved-search-detail -tags: ['SDK', 'Software Development Kit', 'SavedSearchDetail'] ---- - - -# SavedSearchDetail - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**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] -**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required] -**Columns** | Pointer to [**map[string]Column[]**](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_arrays?view=powershell-7.4) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional] -**Query** | **String** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [required] -**Fields** | Pointer to **[]String** | The fields to be searched against in a multi-field query. | [optional] -**OrderBy** | Pointer to **map[string]String[]** | Sort by index. This takes precedence over the `sort` property. | [optional] -**Sort** | Pointer to **[]String** | The fields to be used to sort the search results. | [optional] -**Filters** | Pointer to [**SavedSearchDetailFilters**](saved-search-detail-filters) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SavedSearchDetail = Initialize-PSSailpoint.V3SavedSearchDetail -Created 2018-06-25T20:22:28.104Z ` - -Modified 2018-06-25T20:22:28.104Z ` - -Indices [identities] ` - -Columns {identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]} ` - -Query @accounts(disabled:true) ` - -Fields [disabled] ` - -OrderBy {identity=[lastName, firstName], role=[name]} ` - -Sort [displayName] ` - -Filters null -``` - -- Convert the resource to JSON -```powershell -$SavedSearchDetail | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SavedSearchDetailFilters.md b/docs/tools/sdk/powershell/reference/v3/Models/SavedSearchDetailFilters.md deleted file mode 100644 index 4d28da1fe..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SavedSearchDetailFilters.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: saved-search-detail-filters -title: SavedSearchDetailFilters -pagination_label: SavedSearchDetailFilters -sidebar_label: SavedSearchDetailFilters -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearchDetailFilters'] -slug: /tools/sdk/powershell/v3/models/saved-search-detail-filters -tags: ['SDK', 'Software Development Kit', 'SavedSearchDetailFilters'] ---- - - -# SavedSearchDetailFilters - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to [**FilterType**](filter-type) | | [optional] -**Range** | Pointer to [**Range**](range) | | [optional] -**Terms** | Pointer to **[]String** | The terms to be filtered. | [optional] -**Exclude** | Pointer to **Boolean** | Indicates if the filter excludes results. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$SavedSearchDetailFilters = Initialize-PSSailpoint.V3SavedSearchDetailFilters -Type null ` - -Range null ` - -Terms null ` - -Exclude false -``` - -- Convert the resource to JSON -```powershell -$SavedSearchDetailFilters | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SavedSearchName.md b/docs/tools/sdk/powershell/reference/v3/Models/SavedSearchName.md deleted file mode 100644 index 4d0fe637b..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SavedSearchName.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: saved-search-name -title: SavedSearchName -pagination_label: SavedSearchName -sidebar_label: SavedSearchName -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearchName'] -slug: /tools/sdk/powershell/v3/models/saved-search-name -tags: ['SDK', 'Software Development Kit', 'SavedSearchName'] ---- - - -# SavedSearchName - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | The name of the saved search. | [optional] -**Description** | Pointer to **String** | The description of the saved search. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SavedSearchName = Initialize-PSSailpoint.V3SavedSearchName -Name Disabled accounts ` - -Description Disabled accounts -``` - -- Convert the resource to JSON -```powershell -$SavedSearchName | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Schedule.md b/docs/tools/sdk/powershell/reference/v3/Models/Schedule.md deleted file mode 100644 index f458ca7cc..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Schedule.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: schedule -title: Schedule -pagination_label: Schedule -sidebar_label: Schedule -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Schedule'] -slug: /tools/sdk/powershell/v3/models/schedule -tags: ['SDK', 'Software Development Kit', 'Schedule'] ---- - - -# Schedule - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "WEEKLY", "MONTHLY", "ANNUALLY", "CALENDAR" ] | Determines the overall schedule cadence. In general, all time period fields smaller than the chosen type can be configured. For example, a DAILY schedule can have 'hours' set, but not 'days'; a WEEKLY schedule can have both 'hours' and 'days' set. | [required] -**Months** | Pointer to [**ScheduleMonths**](schedule-months) | | [optional] -**Days** | Pointer to [**ScheduleDays**](schedule-days) | | [optional] -**Hours** | [**ScheduleHours**](schedule-hours) | | [required] -**Expiration** | Pointer to **System.DateTime** | Specifies the time after which this schedule will no longer occur. | [optional] -**TimeZoneId** | Pointer to **String** | The time zone to use when running the schedule. For instance, if the schedule is scheduled to run at 1AM, and this field is set to ""CST"", the schedule will run at 1AM CST. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Schedule = Initialize-PSSailpoint.V3Schedule -Type WEEKLY ` - -Months null ` - -Days null ` - -Hours null ` - -Expiration null ` - -TimeZoneId CST -``` - -- Convert the resource to JSON -```powershell -$Schedule | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Schedule1.md b/docs/tools/sdk/powershell/reference/v3/Models/Schedule1.md deleted file mode 100644 index 3c1d65783..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Schedule1.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: schedule1 -title: Schedule1 -pagination_label: Schedule1 -sidebar_label: Schedule1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Schedule1'] -slug: /tools/sdk/powershell/v3/models/schedule1 -tags: ['SDK', 'Software Development Kit', 'Schedule1'] ---- - - -# Schedule1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | [**ScheduleType**](schedule-type) | | [required] -**Months** | Pointer to [**Schedule1Months**](schedule1-months) | | [optional] -**Days** | Pointer to [**Schedule1Days**](schedule1-days) | | [optional] -**Hours** | [**Schedule1Hours**](schedule1-hours) | | [required] -**Expiration** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional] -**TimeZoneId** | Pointer to **String** | The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org's default timezone is used. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Schedule1 = Initialize-PSSailpoint.V3Schedule1 -Type null ` - -Months null ` - -Days null ` - -Hours null ` - -Expiration 2018-06-25T20:22:28.104Z ` - -TimeZoneId America/Chicago -``` - -- Convert the resource to JSON -```powershell -$Schedule1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Schedule1Days.md b/docs/tools/sdk/powershell/reference/v3/Models/Schedule1Days.md deleted file mode 100644 index a45729705..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Schedule1Days.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: schedule1-days -title: Schedule1Days -pagination_label: Schedule1Days -sidebar_label: Schedule1Days -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Schedule1Days'] -slug: /tools/sdk/powershell/v3/models/schedule1-days -tags: ['SDK', 'Software Development Kit', 'Schedule1Days'] ---- - - -# Schedule1Days - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | [**SelectorType**](selector-type) | | [required] -**Values** | **[]String** | The selected values. | [required] -**Interval** | Pointer to **Int32** | The selected interval for RANGE selectors. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Schedule1Days = Initialize-PSSailpoint.V3Schedule1Days -Type null ` - -Values [MON, WED] ` - -Interval 3 -``` - -- Convert the resource to JSON -```powershell -$Schedule1Days | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Schedule1Hours.md b/docs/tools/sdk/powershell/reference/v3/Models/Schedule1Hours.md deleted file mode 100644 index 377c935d2..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Schedule1Hours.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: schedule1-hours -title: Schedule1Hours -pagination_label: Schedule1Hours -sidebar_label: Schedule1Hours -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Schedule1Hours'] -slug: /tools/sdk/powershell/v3/models/schedule1-hours -tags: ['SDK', 'Software Development Kit', 'Schedule1Hours'] ---- - - -# Schedule1Hours - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | [**SelectorType**](selector-type) | | [required] -**Values** | **[]String** | The selected values. | [required] -**Interval** | Pointer to **Int32** | The selected interval for RANGE selectors. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Schedule1Hours = Initialize-PSSailpoint.V3Schedule1Hours -Type null ` - -Values [MON, WED] ` - -Interval 3 -``` - -- Convert the resource to JSON -```powershell -$Schedule1Hours | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Schedule1Months.md b/docs/tools/sdk/powershell/reference/v3/Models/Schedule1Months.md deleted file mode 100644 index c50875fdf..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Schedule1Months.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: schedule1-months -title: Schedule1Months -pagination_label: Schedule1Months -sidebar_label: Schedule1Months -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Schedule1Months'] -slug: /tools/sdk/powershell/v3/models/schedule1-months -tags: ['SDK', 'Software Development Kit', 'Schedule1Months'] ---- - - -# Schedule1Months - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | [**SelectorType**](selector-type) | | [required] -**Values** | **[]String** | The selected values. | [required] -**Interval** | Pointer to **Int32** | The selected interval for RANGE selectors. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Schedule1Months = Initialize-PSSailpoint.V3Schedule1Months -Type null ` - -Values [MON, WED] ` - -Interval 3 -``` - -- Convert the resource to JSON -```powershell -$Schedule1Months | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ScheduleDays.md b/docs/tools/sdk/powershell/reference/v3/Models/ScheduleDays.md deleted file mode 100644 index 46ba68517..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ScheduleDays.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: schedule-days -title: ScheduleDays -pagination_label: ScheduleDays -sidebar_label: ScheduleDays -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduleDays'] -slug: /tools/sdk/powershell/v3/models/schedule-days -tags: ['SDK', 'Software Development Kit', 'ScheduleDays'] ---- - - -# ScheduleDays - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "LIST", "RANGE" ] | Enum type to specify days value | [required] -**Values** | **[]String** | Values of the days based on the enum type mentioned above | [required] -**Interval** | Pointer to **Int64** | Interval between the cert generations | [optional] - -## Examples - -- Prepare the resource -```powershell -$ScheduleDays = Initialize-PSSailpoint.V3ScheduleDays -Type LIST ` - -Values [1] ` - -Interval 2 -``` - -- Convert the resource to JSON -```powershell -$ScheduleDays | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ScheduleHours.md b/docs/tools/sdk/powershell/reference/v3/Models/ScheduleHours.md deleted file mode 100644 index 58670f8c8..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ScheduleHours.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: schedule-hours -title: ScheduleHours -pagination_label: ScheduleHours -sidebar_label: ScheduleHours -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduleHours'] -slug: /tools/sdk/powershell/v3/models/schedule-hours -tags: ['SDK', 'Software Development Kit', 'ScheduleHours'] ---- - - -# ScheduleHours - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "LIST", "RANGE" ] | Enum type to specify hours value | [required] -**Values** | **[]String** | Values of the days based on the enum type mentioned above | [required] -**Interval** | Pointer to **Int64** | Interval between the cert generations | [optional] - -## Examples - -- Prepare the resource -```powershell -$ScheduleHours = Initialize-PSSailpoint.V3ScheduleHours -Type LIST ` - -Values [1] ` - -Interval 2 -``` - -- Convert the resource to JSON -```powershell -$ScheduleHours | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ScheduleMonths.md b/docs/tools/sdk/powershell/reference/v3/Models/ScheduleMonths.md deleted file mode 100644 index c976b1966..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ScheduleMonths.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: schedule-months -title: ScheduleMonths -pagination_label: ScheduleMonths -sidebar_label: ScheduleMonths -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduleMonths'] -slug: /tools/sdk/powershell/v3/models/schedule-months -tags: ['SDK', 'Software Development Kit', 'ScheduleMonths'] ---- - - -# ScheduleMonths - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "LIST", "RANGE" ] | Enum type to specify months value | [required] -**Values** | **[]String** | Values of the months based on the enum type mentioned above | [required] -**Interval** | Pointer to **Int64** | Interval between the cert generations | [optional] - -## Examples - -- Prepare the resource -```powershell -$ScheduleMonths = Initialize-PSSailpoint.V3ScheduleMonths -Type LIST ` - -Values [1] ` - -Interval 2 -``` - -- Convert the resource to JSON -```powershell -$ScheduleMonths | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ScheduleType.md b/docs/tools/sdk/powershell/reference/v3/Models/ScheduleType.md deleted file mode 100644 index 1a9ea53e2..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ScheduleType.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: schedule-type -title: ScheduleType -pagination_label: ScheduleType -sidebar_label: ScheduleType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduleType'] -slug: /tools/sdk/powershell/v3/models/schedule-type -tags: ['SDK', 'Software Development Kit', 'ScheduleType'] ---- - - -# ScheduleType - -## Enum - - -* `DAILY` (value: `"DAILY"`) - -* `WEEKLY` (value: `"WEEKLY"`) - -* `MONTHLY` (value: `"MONTHLY"`) - -* `CALENDAR` (value: `"CALENDAR"`) - -* `ANNUALLY` (value: `"ANNUALLY"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ScheduledAttributes.md b/docs/tools/sdk/powershell/reference/v3/Models/ScheduledAttributes.md deleted file mode 100644 index adee2a2db..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ScheduledAttributes.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: scheduled-attributes -title: ScheduledAttributes -pagination_label: ScheduledAttributes -sidebar_label: ScheduledAttributes -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledAttributes'] -slug: /tools/sdk/powershell/v3/models/scheduled-attributes -tags: ['SDK', 'Software Development Kit', 'ScheduledAttributes'] ---- - - -# ScheduledAttributes - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CronString** | Pointer to **String** | A valid CRON expression | [optional] -**Frequency** | **Enum** [ "daily", "weekly", "monthly", "yearly", "cronSchedule" ] | Frequency of execution | [required] -**TimeZone** | Pointer to **String** | Time zone identifier | [optional] -**WeeklyDays** | Pointer to **[]String** | Scheduled days of the week for execution | [optional] -**WeeklyTimes** | Pointer to **[]String** | Scheduled execution times | [optional] - -## Examples - -- Prepare the resource -```powershell -$ScheduledAttributes = Initialize-PSSailpoint.V3ScheduledAttributes -CronString 0 9 * * 1 ` - -Frequency null ` - -TimeZone America/Chicago ` - -WeeklyDays Monday ` - -WeeklyTimes Monday -``` - -- Convert the resource to JSON -```powershell -$ScheduledAttributes | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ScheduledSearch.md b/docs/tools/sdk/powershell/reference/v3/Models/ScheduledSearch.md deleted file mode 100644 index 02715b521..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ScheduledSearch.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -id: scheduled-search -title: ScheduledSearch -pagination_label: ScheduledSearch -sidebar_label: ScheduledSearch -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledSearch'] -slug: /tools/sdk/powershell/v3/models/scheduled-search -tags: ['SDK', 'Software Development Kit', 'ScheduledSearch'] ---- - - -# ScheduledSearch - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | The name of the scheduled search. | [optional] -**Description** | Pointer to **String** | The description of the scheduled search. | [optional] -**SavedSearchId** | **String** | The ID of the saved search that will be executed. | [required] -**Created** | Pointer to **System.DateTime** | The date the scheduled search was initially created. | [optional] [readonly] -**Modified** | Pointer to **System.DateTime** | The last date the scheduled search was modified. | [optional] [readonly] -**Schedule** | [**Schedule1**](schedule1) | | [required] -**Recipients** | [**[]SearchScheduleRecipientsInner**](search-schedule-recipients-inner) | A list of identities that should receive the scheduled search report via email. | [required] -**Enabled** | Pointer to **Boolean** | Indicates if the scheduled search is enabled. | [optional] [default to $false] -**EmailEmptyResults** | Pointer to **Boolean** | Indicates if email generation should occur when search returns no results. | [optional] [default to $false] -**DisplayQueryDetails** | Pointer to **Boolean** | Indicates if the generated email should include the query and search results preview (which could include PII). | [optional] [default to $false] -**Id** | **String** | The scheduled search ID. | [required][readonly] -**Owner** | [**ScheduledSearchAllOfOwner**](scheduled-search-all-of-owner) | | [required] -**OwnerId** | **String** | The ID of the scheduled search owner. Please use the `id` in the `owner` object instead. | [required][readonly] - -## Examples - -- Prepare the resource -```powershell -$ScheduledSearch = Initialize-PSSailpoint.V3ScheduledSearch -Name Daily disabled accounts ` - -Description Daily disabled accounts ` - -SavedSearchId 554f1511-f0a1-4744-ab14-599514d3e57c ` - -Created 2018-06-25T20:22:28.104Z ` - -Modified 2018-06-25T20:22:28.104Z ` - -Schedule null ` - -Recipients null ` - -Enabled false ` - -EmailEmptyResults false ` - -DisplayQueryDetails false ` - -Id 0de46054-fe90-434a-b84e-c6b3359d0c64 ` - -Owner null ` - -OwnerId 2c9180867624cbd7017642d8c8c81f67 -``` - -- Convert the resource to JSON -```powershell -$ScheduledSearch | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ScheduledSearchAllOfOwner.md b/docs/tools/sdk/powershell/reference/v3/Models/ScheduledSearchAllOfOwner.md deleted file mode 100644 index 0324dea5b..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ScheduledSearchAllOfOwner.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: scheduled-search-all-of-owner -title: ScheduledSearchAllOfOwner -pagination_label: ScheduledSearchAllOfOwner -sidebar_label: ScheduledSearchAllOfOwner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledSearchAllOfOwner'] -slug: /tools/sdk/powershell/v3/models/scheduled-search-all-of-owner -tags: ['SDK', 'Software Development Kit', 'ScheduledSearchAllOfOwner'] ---- - - -# ScheduledSearchAllOfOwner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY" ] | The type of object being referenced | [required] -**Id** | **String** | The ID of the referenced object | [required] - -## Examples - -- Prepare the resource -```powershell -$ScheduledSearchAllOfOwner = Initialize-PSSailpoint.V3ScheduledSearchAllOfOwner -Type IDENTITY ` - -Id 2c9180867624cbd7017642d8c8c81f67 -``` - -- Convert the resource to JSON -```powershell -$ScheduledSearchAllOfOwner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ScheduledSearchName.md b/docs/tools/sdk/powershell/reference/v3/Models/ScheduledSearchName.md deleted file mode 100644 index 8926c315d..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ScheduledSearchName.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: scheduled-search-name -title: ScheduledSearchName -pagination_label: ScheduledSearchName -sidebar_label: ScheduledSearchName -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledSearchName'] -slug: /tools/sdk/powershell/v3/models/scheduled-search-name -tags: ['SDK', 'Software Development Kit', 'ScheduledSearchName'] ---- - - -# ScheduledSearchName - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | The name of the scheduled search. | [optional] -**Description** | Pointer to **String** | The description of the scheduled search. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ScheduledSearchName = Initialize-PSSailpoint.V3ScheduledSearchName -Name Daily disabled accounts ` - -Description Daily disabled accounts -``` - -- Convert the resource to JSON -```powershell -$ScheduledSearchName | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Schema.md b/docs/tools/sdk/powershell/reference/v3/Models/Schema.md deleted file mode 100644 index bdee149e1..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Schema.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -id: schema -title: Schema -pagination_label: Schema -sidebar_label: Schema -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Schema'] -slug: /tools/sdk/powershell/v3/models/schema -tags: ['SDK', 'Software Development Kit', 'Schema'] ---- - - -# Schema - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The id of the Schema. | [optional] -**Name** | Pointer to **String** | The name of the Schema. | [optional] -**NativeObjectType** | Pointer to **String** | The name of the object type on the native system that the schema represents. | [optional] -**IdentityAttribute** | Pointer to **String** | The name of the attribute used to calculate the unique identifier for an object in the schema. | [optional] -**DisplayAttribute** | Pointer to **String** | The name of the attribute used to calculate the display value for an object in the schema. | [optional] -**HierarchyAttribute** | Pointer to **String** | The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. | [optional] -**IncludePermissions** | Pointer to **Boolean** | Flag indicating whether or not the include permissions with the object data when aggregating the schema. | [optional] -**Features** | Pointer to **[]String** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] -**Configuration** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Holds any extra configuration data that the schema may require. | [optional] -**Attributes** | Pointer to [**[]AttributeDefinition**](attribute-definition) | The attribute definitions which form the schema. | [optional] -**Created** | Pointer to **System.DateTime** | The date the Schema was created. | [optional] -**Modified** | Pointer to **System.DateTime** | The date the Schema was last modified. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Schema = Initialize-PSSailpoint.V3Schema -Id 2c9180835d191a86015d28455b4a2329 ` - -Name account ` - -NativeObjectType User ` - -IdentityAttribute sAMAccountName ` - -DisplayAttribute distinguishedName ` - -HierarchyAttribute memberOf ` - -IncludePermissions false ` - -Features [PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS] ` - -Configuration {groupMemberAttribute=member} ` - -Attributes [{name=sAMAccountName, type=STRING, isMultiValued=false, isEntitlement=false, isGroup=false}, {name=memberOf, type=STRING, schema={type=CONNECTOR_SCHEMA, id=2c9180887671ff8c01767b4671fc7d60, name=group}, description=Group membership, isMultiValued=true, isEntitlement=true, isGroup=true}] ` - -Created 2019-12-24T22:32:58.104Z ` - -Modified 2019-12-31T20:22:28.104Z -``` - -- Convert the resource to JSON -```powershell -$Schema | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Search.md b/docs/tools/sdk/powershell/reference/v3/Models/Search.md deleted file mode 100644 index 1256e0006..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Search.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -id: search -title: Search -pagination_label: Search -sidebar_label: Search -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Search'] -slug: /tools/sdk/powershell/v3/models/search -tags: ['SDK', 'Software Development Kit', 'Search'] ---- - - -# Search - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Indices** | Pointer to [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] -**QueryType** | Pointer to [**QueryType**](query-type) | | [optional] -**QueryVersion** | Pointer to **String** | | [optional] -**Query** | Pointer to [**Query**](query) | | [optional] -**QueryDsl** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax. | [optional] -**TextQuery** | Pointer to [**TextQuery**](text-query) | | [optional] -**TypeAheadQuery** | Pointer to [**TypeAheadQuery**](type-ahead-query) | | [optional] -**IncludeNested** | Pointer to **Boolean** | Indicates whether nested objects from returned search results should be included. | [optional] [default to $true] -**QueryResultFilter** | Pointer to [**QueryResultFilter**](query-result-filter) | | [optional] -**AggregationType** | Pointer to [**AggregationType**](aggregation-type) | | [optional] -**AggregationsVersion** | Pointer to **String** | | [optional] -**AggregationsDsl** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax. | [optional] -**Aggregations** | Pointer to [**SearchAggregationSpecification**](search-aggregation-specification) | | [optional] -**Sort** | Pointer to **[]String** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional] -**SearchAfter** | Pointer to **[]String** | Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don't get duplicate results while paging. For example, when searching for identities, if you are sorting by displayName you will also want to include ID, for example [""displayName"", ""id""]. If the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is ""John Doe"", then using that displayName and ID will start a new search after this identity. The searchAfter value will look like [""John Doe"",""2c91808375d8e80a0175e1f88a575221""] | [optional] -**Filters** | Pointer to [**map[string]ModelFilter**](model-filter) | The filters to be applied for each filtered field name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Search = Initialize-PSSailpoint.V3Search -Indices [identities] ` - -QueryType null ` - -QueryVersion null ` - -Query null ` - -QueryDsl {match={name=john.doe}} ` - -TextQuery null ` - -TypeAheadQuery null ` - -IncludeNested true ` - -QueryResultFilter null ` - -AggregationType null ` - -AggregationsVersion null ` - -AggregationsDsl {} ` - -Aggregations null ` - -Sort [displayName, +id] ` - -SearchAfter [John Doe, 2c91808375d8e80a0175e1f88a575221] ` - -Filters {} -``` - -- Convert the resource to JSON -```powershell -$Search | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SearchAggregationSpecification.md b/docs/tools/sdk/powershell/reference/v3/Models/SearchAggregationSpecification.md deleted file mode 100644 index 9c0b97142..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SearchAggregationSpecification.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: search-aggregation-specification -title: SearchAggregationSpecification -pagination_label: SearchAggregationSpecification -sidebar_label: SearchAggregationSpecification -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SearchAggregationSpecification'] -slug: /tools/sdk/powershell/v3/models/search-aggregation-specification -tags: ['SDK', 'Software Development Kit', 'SearchAggregationSpecification'] ---- - - -# SearchAggregationSpecification - -## 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] -**SubAggregation** | Pointer to [**SubSearchAggregationSpecification**](sub-search-aggregation-specification) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SearchAggregationSpecification = Initialize-PSSailpoint.V3SearchAggregationSpecification -Nested null ` - -Metric null ` - -VarFilter null ` - -Bucket null ` - -SubAggregation null -``` - -- Convert the resource to JSON -```powershell -$SearchAggregationSpecification | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SearchArguments.md b/docs/tools/sdk/powershell/reference/v3/Models/SearchArguments.md deleted file mode 100644 index 671d69f41..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SearchArguments.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: search-arguments -title: SearchArguments -pagination_label: SearchArguments -sidebar_label: SearchArguments -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SearchArguments'] -slug: /tools/sdk/powershell/v3/models/search-arguments -tags: ['SDK', 'Software Development Kit', 'SearchArguments'] ---- - - -# SearchArguments - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ScheduleId** | Pointer to **String** | The ID of the scheduled search that triggered the saved search execution. | [optional] -**Owner** | Pointer to [**TypedReference**](typed-reference) | The owner of the scheduled search being tested. | [optional] -**Recipients** | Pointer to [**[]TypedReference**](typed-reference) | The email recipients of the scheduled search being tested. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SearchArguments = Initialize-PSSailpoint.V3SearchArguments -ScheduleId 7a724640-0c17-4ce9-a8c3-4a89738459c8 ` - -Owner null ` - -Recipients null -``` - -- Convert the resource to JSON -```powershell -$SearchArguments | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SearchAttributeConfig.md b/docs/tools/sdk/powershell/reference/v3/Models/SearchAttributeConfig.md deleted file mode 100644 index 0f084b210..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SearchAttributeConfig.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: search-attribute-config -title: SearchAttributeConfig -pagination_label: SearchAttributeConfig -sidebar_label: SearchAttributeConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SearchAttributeConfig'] -slug: /tools/sdk/powershell/v3/models/search-attribute-config -tags: ['SDK', 'Software Development Kit', 'SearchAttributeConfig'] ---- - - -# SearchAttributeConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | Name of the new attribute | [optional] -**DisplayName** | Pointer to **String** | The display name of the new attribute | [optional] -**ApplicationAttributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Map of application id and their associated attribute. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SearchAttributeConfig = Initialize-PSSailpoint.V3SearchAttributeConfig -Name newMailAttribute ` - -DisplayName New Mail Attribute ` - -ApplicationAttributes {2c91808b79fd2422017a0b35d30f3968=employeeNumber, 2c91808b79fd2422017a0b36008f396b=employeeNumber} -``` - -- Convert the resource to JSON -```powershell -$SearchAttributeConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SearchDocument.md b/docs/tools/sdk/powershell/reference/v3/Models/SearchDocument.md deleted file mode 100644 index 3ae9dca44..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SearchDocument.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -id: search-document -title: SearchDocument -pagination_label: SearchDocument -sidebar_label: SearchDocument -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SearchDocument'] -slug: /tools/sdk/powershell/v3/models/search-document -tags: ['SDK', 'Software Development Kit', 'SearchDocument'] ---- - - -# SearchDocument - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The unique ID of the referenced object. | [required] -**Name** | **String** | The human readable name of the referenced object. | [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** | [**DocumentType**](document-type) | | [required] -**Source** | Pointer to [**IdentityDocumentAllOfSource**](identity-document-all-of-source) | | [optional] -**Entitlements** | Pointer to [**[]BaseEntitlement**](base-entitlement) | Entitlements included with the role. | [optional] -**EntitlementCount** | Pointer to **Int32** | Number of entitlements included with the role. | [optional] -**Tags** | Pointer to **[]String** | Tags that have been applied to the object. | [optional] -**Action** | Pointer to **String** | Name of the event as it's displayed in audit reports. | [optional] -**Stage** | Pointer to **String** | Activity's current stage. | [optional] -**Origin** | Pointer to **String** | Activity's origin. | [optional] -**Status** | Pointer to **String** | Identity's status in SailPoint. | [optional] -**Requester** | Pointer to [**AccountSource**](account-source) | | [optional] -**Recipient** | Pointer to [**AccountSource**](account-source) | | [optional] -**TrackingNumber** | Pointer to **String** | ID of the group of events. | [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] -**DisplayName** | Pointer to **String** | Identity's display name. | [optional] -**Segments** | Pointer to [**[]BaseSegment**](base-segment) | Segments with the role. | [optional] -**SegmentCount** | Pointer to **Int32** | Number of segments with the role. | [optional] -**CloudGoverned** | Pointer to **Boolean** | Indicates whether the entitlement is cloud governed. | [optional] [default to $false] -**Privileged** | Pointer to **Boolean** | Indicates whether the entitlement is privileged. | [optional] [default to $false] -**IdentityCount** | Pointer to **Int32** | Number of identities who have access to the entitlement. | [optional] -**Type** | Pointer to **String** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional] -**Actor** | Pointer to **String** | Name of the actor that generated the event. | [optional] -**Target** | Pointer to **String** | Name of the target, or recipient, of the event. | [optional] -**Stack** | Pointer to **String** | The event's stack. | [optional] -**IpAddress** | Pointer to **String** | Target system's IP address. | [optional] -**Details** | Pointer to **String** | ID of event's details. | [optional] -**Attributes** | 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] -**Objects** | Pointer to **[]String** | Objects the event is happening to. | [optional] -**Operation** | Pointer to **String** | Operation, or action, performed during the event. | [optional] -**TechnicalName** | Pointer to **String** | Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. | [optional] -**FirstName** | Pointer to **String** | Identity's first name. | [optional] -**LastName** | Pointer to **String** | Identity's last name. | [optional] -**Email** | Pointer to **String** | Identity's primary email address. | [optional] -**Phone** | Pointer to **String** | Identity's phone number. | [optional] -**Inactive** | Pointer to **Boolean** | Indicates whether the identity is inactive. | [optional] [default to $false] -**Protected** | Pointer to **Boolean** | Indicates whether the identity is protected. | [optional] [default to $false] -**EmployeeNumber** | Pointer to **String** | Identity's employee number. | [optional] -**Manager** | Pointer to [**IdentityDocumentAllOfManager**](identity-document-all-of-manager) | | [optional] -**IsManager** | Pointer to **Boolean** | Indicates whether the identity is a manager of other identities. | [optional] -**IdentityProfile** | Pointer to [**IdentityDocumentAllOfIdentityProfile**](identity-document-all-of-identity-profile) | | [optional] -**ProcessingState** | Pointer to **String** | Identity's processing state. | [optional] -**ProcessingDetails** | Pointer to [**ProcessingDetails**](processing-details) | | [optional] -**Accounts** | Pointer to [**[]BaseAccount**](base-account) | List of accounts associated with the identity. | [optional] -**AccountCount** | Pointer to **Int32** | Number of accounts associated with the identity. | [optional] -**Apps** | Pointer to [**[]App**](app) | List of applications the identity has access to. | [optional] -**AppCount** | Pointer to **Int32** | Number of applications the identity has access to. | [optional] -**Access** | Pointer to [**[]IdentityAccess**](identity-access) | List of access items assigned to the identity. | [optional] -**AccessCount** | Pointer to **Int32** | Number of access items assigned to the identity. | [optional] -**RoleCount** | Pointer to **Int32** | Number of roles assigned to the identity. | [optional] -**AccessProfileCount** | Pointer to **Int32** | Number of access profiles included with the role. | [optional] -**Owns** | Pointer to [**[]Owns**](owns) | Access items the identity owns. | [optional] -**OwnsCount** | Pointer to **Int32** | Number of access items the identity owns. | [optional] -**AccessProfiles** | Pointer to [**[]BaseAccessProfile**](base-access-profile) | Access profiles included with the role. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SearchDocument = Initialize-PSSailpoint.V3SearchDocument -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 ` - -Type null ` - -Source null ` - -Entitlements null ` - -EntitlementCount 3 ` - -Tags [TAG_1, TAG_2] ` - -Action update ` - -Stage Completed ` - -Origin null ` - -Status UNREGISTERED ` - -Requester null ` - -Recipient null ` - -TrackingNumber 63f891e0735f4cc8bf1968144a1e7440 ` - -Errors null ` - -Warnings null ` - -Approvals null ` - -OriginalRequests null ` - -ExpansionItems null ` - -AccountRequests null ` - -Sources smartsheet-test, airtable-v4, IdentityNow ` - -DisplayName Carol.Adams ` - -Segments null ` - -SegmentCount 1 ` - -CloudGoverned false ` - -Privileged false ` - -IdentityCount 3 ` - -Type SYSTEM_CONFIG ` - -Actor System ` - -Target Carol.Adams ` - -Stack tpe ` - -IpAddress 52.52.97.85 ` - -Details 73b65dfbed1842548c207432a18c84b0 ` - -Attributes {country=US, firstname=Carol, cloudStatus=UNREGISTERED} ` - -Objects null ` - -Operation REQUEST ` - -TechnicalName AUTHENTICATION_REQUEST_PASSED ` - -FirstName Carol ` - -LastName Adams ` - -Email Carol.Adams@sailpointdemo.com ` - -Phone +1 440-527-3672 ` - -Inactive false ` - -Protected false ` - -EmployeeNumber 1a2a3d4e ` - -Manager null ` - -IsManager false ` - -IdentityProfile null ` - -ProcessingState null ` - -ProcessingDetails null ` - -Accounts null ` - -AccountCount 3 ` - -Apps null ` - -AppCount 2 ` - -Access null ` - -AccessCount 5 ` - -RoleCount 1 ` - -AccessProfileCount 1 ` - -Owns null ` - -OwnsCount 5 ` - -AccessProfiles null -``` - -- Convert the resource to JSON -```powershell -$SearchDocument | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SearchExportReportArguments.md b/docs/tools/sdk/powershell/reference/v3/Models/SearchExportReportArguments.md deleted file mode 100644 index b55013989..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SearchExportReportArguments.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: search-export-report-arguments -title: SearchExportReportArguments -pagination_label: SearchExportReportArguments -sidebar_label: SearchExportReportArguments -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SearchExportReportArguments'] -slug: /tools/sdk/powershell/v3/models/search-export-report-arguments -tags: ['SDK', 'Software Development Kit', 'SearchExportReportArguments'] ---- - - -# SearchExportReportArguments - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Indices** | Pointer to [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] -**Query** | **String** | The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | [required] -**Columns** | Pointer to **String** | Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. | [optional] -**Sort** | Pointer to **[]String** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SearchExportReportArguments = Initialize-PSSailpoint.V3SearchExportReportArguments -Indices [entitlements] ` - -Query name:a* ` - -Columns displayName,firstName,lastName,email,created,attributes.cloudLifecycleState ` - -Sort [displayName, +id] -``` - -- Convert the resource to JSON -```powershell -$SearchExportReportArguments | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SearchFilterType.md b/docs/tools/sdk/powershell/reference/v3/Models/SearchFilterType.md deleted file mode 100644 index f94e675ee..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SearchFilterType.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: search-filter-type -title: SearchFilterType -pagination_label: SearchFilterType -sidebar_label: SearchFilterType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SearchFilterType'] -slug: /tools/sdk/powershell/v3/models/search-filter-type -tags: ['SDK', 'Software Development Kit', 'SearchFilterType'] ---- - - -# SearchFilterType - -## Enum - - -* `TERM` (value: `"TERM"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SearchSchedule.md b/docs/tools/sdk/powershell/reference/v3/Models/SearchSchedule.md deleted file mode 100644 index f159c9884..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SearchSchedule.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: search-schedule -title: SearchSchedule -pagination_label: SearchSchedule -sidebar_label: SearchSchedule -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SearchSchedule'] -slug: /tools/sdk/powershell/v3/models/search-schedule -tags: ['SDK', 'Software Development Kit', 'SearchSchedule'] ---- - - -# SearchSchedule - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**SavedSearchId** | **String** | The ID of the saved search that will be executed. | [required] -**Created** | Pointer to **System.DateTime** | The date the scheduled search was initially created. | [optional] [readonly] -**Modified** | Pointer to **System.DateTime** | The last date the scheduled search was modified. | [optional] [readonly] -**Schedule** | [**Schedule1**](schedule1) | | [required] -**Recipients** | [**[]SearchScheduleRecipientsInner**](search-schedule-recipients-inner) | A list of identities that should receive the scheduled search report via email. | [required] -**Enabled** | Pointer to **Boolean** | Indicates if the scheduled search is enabled. | [optional] [default to $false] -**EmailEmptyResults** | Pointer to **Boolean** | Indicates if email generation should occur when search returns no results. | [optional] [default to $false] -**DisplayQueryDetails** | Pointer to **Boolean** | Indicates if the generated email should include the query and search results preview (which could include PII). | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$SearchSchedule = Initialize-PSSailpoint.V3SearchSchedule -SavedSearchId 554f1511-f0a1-4744-ab14-599514d3e57c ` - -Created 2018-06-25T20:22:28.104Z ` - -Modified 2018-06-25T20:22:28.104Z ` - -Schedule null ` - -Recipients null ` - -Enabled false ` - -EmailEmptyResults false ` - -DisplayQueryDetails false -``` - -- Convert the resource to JSON -```powershell -$SearchSchedule | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SearchScheduleRecipientsInner.md b/docs/tools/sdk/powershell/reference/v3/Models/SearchScheduleRecipientsInner.md deleted file mode 100644 index 4e99cc11b..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SearchScheduleRecipientsInner.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: search-schedule-recipients-inner -title: SearchScheduleRecipientsInner -pagination_label: SearchScheduleRecipientsInner -sidebar_label: SearchScheduleRecipientsInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SearchScheduleRecipientsInner'] -slug: /tools/sdk/powershell/v3/models/search-schedule-recipients-inner -tags: ['SDK', 'Software Development Kit', 'SearchScheduleRecipientsInner'] ---- - - -# SearchScheduleRecipientsInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY" ] | The type of object being referenced | [required] -**Id** | **String** | The ID of the referenced object | [required] - -## Examples - -- Prepare the resource -```powershell -$SearchScheduleRecipientsInner = Initialize-PSSailpoint.V3SearchScheduleRecipientsInner -Type IDENTITY ` - -Id 2c9180867624cbd7017642d8c8c81f67 -``` - -- Convert the resource to JSON -```powershell -$SearchScheduleRecipientsInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SectionDetails.md b/docs/tools/sdk/powershell/reference/v3/Models/SectionDetails.md deleted file mode 100644 index 411733754..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SectionDetails.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: section-details -title: SectionDetails -pagination_label: SectionDetails -sidebar_label: SectionDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SectionDetails'] -slug: /tools/sdk/powershell/v3/models/section-details -tags: ['SDK', 'Software Development Kit', 'SectionDetails'] ---- - - -# SectionDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | Name of the FormItem | [optional] -**Label** | Pointer to **String** | Label of the section | [optional] -**FormItems** | Pointer to [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | List of FormItems. FormItems can be SectionDetails and/or FieldDetails | [optional] - -## Examples - -- Prepare the resource -```powershell -$SectionDetails = Initialize-PSSailpoint.V3SectionDetails -Name Field1 ` - -Label Section 1 ` - -FormItems [] -``` - -- Convert the resource to JSON -```powershell -$SectionDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Segment.md b/docs/tools/sdk/powershell/reference/v3/Models/Segment.md deleted file mode 100644 index c770a7381..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Segment.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: segment -title: Segment -pagination_label: Segment -sidebar_label: Segment -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Segment'] -slug: /tools/sdk/powershell/v3/models/segment -tags: ['SDK', 'Software Development Kit', 'Segment'] ---- - - -# Segment - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The segment's ID. | [optional] -**Name** | Pointer to **String** | The segment's business name. | [optional] -**Created** | Pointer to **System.DateTime** | The time when the segment is created. | [optional] -**Modified** | Pointer to **System.DateTime** | The time when the segment is modified. | [optional] -**Description** | Pointer to **String** | The segment's optional description. | [optional] -**Owner** | Pointer to [**OwnerReferenceSegments**](owner-reference-segments) | | [optional] -**VisibilityCriteria** | Pointer to [**SegmentVisibilityCriteria**](segment-visibility-criteria) | | [optional] -**Active** | Pointer to **Boolean** | This boolean indicates whether the segment is currently active. Inactive segments have no effect. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$Segment = Initialize-PSSailpoint.V3Segment -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` - -Name segment-xyz ` - -Created 2020-01-01T00:00Z ` - -Modified 2020-01-01T00:00Z ` - -Description This segment represents xyz ` - -Owner null ` - -VisibilityCriteria null ` - -Active true -``` - -- Convert the resource to JSON -```powershell -$Segment | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SegmentVisibilityCriteria.md b/docs/tools/sdk/powershell/reference/v3/Models/SegmentVisibilityCriteria.md deleted file mode 100644 index e1bb53ef6..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SegmentVisibilityCriteria.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: segment-visibility-criteria -title: SegmentVisibilityCriteria -pagination_label: SegmentVisibilityCriteria -sidebar_label: SegmentVisibilityCriteria -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SegmentVisibilityCriteria'] -slug: /tools/sdk/powershell/v3/models/segment-visibility-criteria -tags: ['SDK', 'Software Development Kit', 'SegmentVisibilityCriteria'] ---- - - -# SegmentVisibilityCriteria - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Expression** | Pointer to [**Expression**](expression) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SegmentVisibilityCriteria = Initialize-PSSailpoint.V3SegmentVisibilityCriteria -Expression null -``` - -- Convert the resource to JSON -```powershell -$SegmentVisibilityCriteria | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Selector.md b/docs/tools/sdk/powershell/reference/v3/Models/Selector.md deleted file mode 100644 index d20b8cdfe..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Selector.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: selector -title: Selector -pagination_label: Selector -sidebar_label: Selector -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Selector'] -slug: /tools/sdk/powershell/v3/models/selector -tags: ['SDK', 'Software Development Kit', 'Selector'] ---- - - -# Selector - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | [**SelectorType**](selector-type) | | [required] -**Values** | **[]String** | The selected values. | [required] -**Interval** | Pointer to **Int32** | The selected interval for RANGE selectors. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Selector = Initialize-PSSailpoint.V3Selector -Type null ` - -Values [MON, WED] ` - -Interval 3 -``` - -- Convert the resource to JSON -```powershell -$Selector | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SelectorType.md b/docs/tools/sdk/powershell/reference/v3/Models/SelectorType.md deleted file mode 100644 index e417dfe96..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SelectorType.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: selector-type -title: SelectorType -pagination_label: SelectorType -sidebar_label: SelectorType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SelectorType'] -slug: /tools/sdk/powershell/v3/models/selector-type -tags: ['SDK', 'Software Development Kit', 'SelectorType'] ---- - - -# SelectorType - -## Enum - - -* `LIST` (value: `"LIST"`) - -* `RANGE` (value: `"RANGE"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SendTokenRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/SendTokenRequest.md deleted file mode 100644 index 48fff664c..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SendTokenRequest.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: send-token-request -title: SendTokenRequest -pagination_label: SendTokenRequest -sidebar_label: SendTokenRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SendTokenRequest'] -slug: /tools/sdk/powershell/v3/models/send-token-request -tags: ['SDK', 'Software Development Kit', 'SendTokenRequest'] ---- - - -# SendTokenRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**UserAlias** | **String** | User alias from table spt_identity field named 'name' | [required] -**DeliveryType** | **Enum** [ "SMS_PERSONAL", "VOICE_PERSONAL", "SMS_WORK", "VOICE_WORK", "EMAIL_WORK", "EMAIL_PERSONAL" ] | Token delivery type | [required] - -## Examples - -- Prepare the resource -```powershell -$SendTokenRequest = Initialize-PSSailpoint.V3SendTokenRequest -UserAlias will.albin ` - -DeliveryType EMAIL_WORK -``` - -- Convert the resource to JSON -```powershell -$SendTokenRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SendTokenResponse.md b/docs/tools/sdk/powershell/reference/v3/Models/SendTokenResponse.md deleted file mode 100644 index 2d591e924..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SendTokenResponse.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: send-token-response -title: SendTokenResponse -pagination_label: SendTokenResponse -sidebar_label: SendTokenResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SendTokenResponse'] -slug: /tools/sdk/powershell/v3/models/send-token-response -tags: ['SDK', 'Software Development Kit', 'SendTokenResponse'] ---- - - -# SendTokenResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RequestId** | Pointer to **String** | The token request ID | [optional] -**Status** | Pointer to **Enum** [ "SUCCESS", "FAILED" ] | Status of sending token | [optional] -**ErrorMessage** | Pointer to **String** | Error messages from token send request | [optional] - -## Examples - -- Prepare the resource -```powershell -$SendTokenResponse = Initialize-PSSailpoint.V3SendTokenResponse -RequestId 089899f13a8f4da7824996191587bab9 ` - -Status SUCCESS ` - -ErrorMessage Unable to sent text message -``` - -- Convert the resource to JSON -```powershell -$SendTokenResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ServiceDeskIntegrationDto.md b/docs/tools/sdk/powershell/reference/v3/Models/ServiceDeskIntegrationDto.md deleted file mode 100644 index ed1b461d9..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ServiceDeskIntegrationDto.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -id: service-desk-integration-dto -title: ServiceDeskIntegrationDto -pagination_label: ServiceDeskIntegrationDto -sidebar_label: ServiceDeskIntegrationDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceDeskIntegrationDto'] -slug: /tools/sdk/powershell/v3/models/service-desk-integration-dto -tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationDto'] ---- - - -# ServiceDeskIntegrationDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Unique identifier for the Service Desk integration | [optional] -**Name** | **String** | Service Desk integration's name. The name must be unique. | [required] -**Created** | Pointer to **System.DateTime** | The date and time the Service Desk integration was created | [optional] -**Modified** | Pointer to **System.DateTime** | The date and time the Service Desk integration was last modified | [optional] -**Description** | **String** | Service Desk integration's description. | [required] -**Type** | **String** | Service Desk integration types: - ServiceNowSDIM - ServiceNow | [required][default to "ServiceNowSDIM"] -**OwnerRef** | Pointer to [**OwnerDto**](owner-dto) | | [optional] -**ClusterRef** | Pointer to [**SourceClusterDto**](source-cluster-dto) | | [optional] -**Cluster** | Pointer to **String** | Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). | [optional] -**ManagedSources** | Pointer to **[]String** | Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility). | [optional] -**ProvisioningConfig** | Pointer to [**ProvisioningConfig**](provisioning-config) | | [optional] -**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Service Desk integration's attributes. Validation constraints enforced by the implementation. | [required] -**BeforeProvisioningRule** | Pointer to [**BeforeProvisioningRuleDto**](before-provisioning-rule-dto) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ServiceDeskIntegrationDto = Initialize-PSSailpoint.V3ServiceDeskIntegrationDto -Id 62945a496ef440189b1f03e3623411c8 ` - -Name Service Desk Integration Name ` - -Created 2024-01-17T18:45:25.994Z ` - -Modified 2024-02-18T18:45:25.994Z ` - -Description A very nice Service Desk integration ` - -Type ServiceNowSDIM ` - -OwnerRef null ` - -ClusterRef null ` - -Cluster xyzzy999 ` - -ManagedSources [2c9180835d191a86015d28455b4a2329, 2c5680835d191a85765d28455b4a9823] ` - -ProvisioningConfig null ` - -Attributes {property=value, key=value} ` - -BeforeProvisioningRule null -``` - -- Convert the resource to JSON -```powershell -$ServiceDeskIntegrationDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ServiceDeskIntegrationTemplateDto.md b/docs/tools/sdk/powershell/reference/v3/Models/ServiceDeskIntegrationTemplateDto.md deleted file mode 100644 index 137db3004..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ServiceDeskIntegrationTemplateDto.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: service-desk-integration-template-dto -title: ServiceDeskIntegrationTemplateDto -pagination_label: ServiceDeskIntegrationTemplateDto -sidebar_label: ServiceDeskIntegrationTemplateDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceDeskIntegrationTemplateDto'] -slug: /tools/sdk/powershell/v3/models/service-desk-integration-template-dto -tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationTemplateDto'] ---- - - -# ServiceDeskIntegrationTemplateDto - -## 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] -**Type** | **String** | The 'type' property specifies the type of the Service Desk integration template. | [required][default to "Web Service SDIM"] -**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The 'attributes' property value is a map of attributes available for integrations using this Service Desk integration template. | [required] -**ProvisioningConfig** | [**ProvisioningConfig**](provisioning-config) | | [required] - -## Examples - -- Prepare the resource -```powershell -$ServiceDeskIntegrationTemplateDto = Initialize-PSSailpoint.V3ServiceDeskIntegrationTemplateDto -Id id12345 ` - -Name aName ` - -Created 2015-05-28T14:07:17Z ` - -Modified 2015-05-28T14:07:17Z ` - -Type Web Service SDIM ` - -Attributes {property=value, key=value} ` - -ProvisioningConfig null -``` - -- Convert the resource to JSON -```powershell -$ServiceDeskIntegrationTemplateDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ServiceDeskIntegrationTemplateType.md b/docs/tools/sdk/powershell/reference/v3/Models/ServiceDeskIntegrationTemplateType.md deleted file mode 100644 index 50b3c45d3..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ServiceDeskIntegrationTemplateType.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: service-desk-integration-template-type -title: ServiceDeskIntegrationTemplateType -pagination_label: ServiceDeskIntegrationTemplateType -sidebar_label: ServiceDeskIntegrationTemplateType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceDeskIntegrationTemplateType'] -slug: /tools/sdk/powershell/v3/models/service-desk-integration-template-type -tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationTemplateType'] ---- - - -# ServiceDeskIntegrationTemplateType - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | This is the name of the type. | [optional] -**Type** | **String** | This is the type value for the type. | [required] -**ScriptName** | **String** | This is the scriptName attribute value for the type. | [required] - -## Examples - -- Prepare the resource -```powershell -$ServiceDeskIntegrationTemplateType = Initialize-PSSailpoint.V3ServiceDeskIntegrationTemplateType -Name aName ` - -Type aType ` - -ScriptName aScriptName -``` - -- Convert the resource to JSON -```powershell -$ServiceDeskIntegrationTemplateType | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ServiceDeskSource.md b/docs/tools/sdk/powershell/reference/v3/Models/ServiceDeskSource.md deleted file mode 100644 index 18d440c8b..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ServiceDeskSource.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: service-desk-source -title: ServiceDeskSource -pagination_label: ServiceDeskSource -sidebar_label: ServiceDeskSource -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceDeskSource'] -slug: /tools/sdk/powershell/v3/models/service-desk-source -tags: ['SDK', 'Software Development Kit', 'ServiceDeskSource'] ---- - - -# ServiceDeskSource - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "SOURCE" ] | DTO type of source for service desk integration template. | [optional] -**Id** | Pointer to **String** | ID of source for service desk integration template. | [optional] -**Name** | Pointer to **String** | Human-readable name of source for service desk integration template. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ServiceDeskSource = Initialize-PSSailpoint.V3ServiceDeskSource -Type SOURCE ` - -Id 2c9180835d191a86015d28455b4b232a ` - -Name HR Active Directory -``` - -- Convert the resource to JSON -```powershell -$ServiceDeskSource | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ServiceProviderConfiguration.md b/docs/tools/sdk/powershell/reference/v3/Models/ServiceProviderConfiguration.md deleted file mode 100644 index d5f5fcabc..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ServiceProviderConfiguration.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: service-provider-configuration -title: ServiceProviderConfiguration -pagination_label: ServiceProviderConfiguration -sidebar_label: ServiceProviderConfiguration -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceProviderConfiguration'] -slug: /tools/sdk/powershell/v3/models/service-provider-configuration -tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfiguration'] ---- - - -# ServiceProviderConfiguration - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Enabled** | Pointer to **Boolean** | This determines whether or not the SAML authentication flow is enabled for an org | [optional] [default to $false] -**BypassIdp** | Pointer to **Boolean** | This allows basic login with the parameter prompt=true. This is often toggled on when debugging SAML authentication setup. When false, only org admins with MFA-enabled can bypass the IDP. | [optional] [default to $false] -**SamlConfigurationValid** | Pointer to **Boolean** | This indicates whether or not the SAML configuration is valid. | [optional] [default to $false] -**FederationProtocolDetails** | Pointer to [**[]ServiceProviderConfigurationFederationProtocolDetailsInner**](service-provider-configuration-federation-protocol-details-inner) | A list of the abstract implementations of the Federation Protocol details. Typically, this will include on SpDetails object and one IdpDetails object used in tandem to define a SAML integration between a customer's identity provider and a customer's SailPoint instance (i.e., the service provider). | [optional] - -## Examples - -- Prepare the resource -```powershell -$ServiceProviderConfiguration = Initialize-PSSailpoint.V3ServiceProviderConfiguration -Enabled true ` - -BypassIdp true ` - -SamlConfigurationValid true ` - -FederationProtocolDetails [{role=SAML_IDP, entityId=http://www.okta.com/exktq4o24bmQA4fr60h7, cert=MIIDpDCCAoygAwIBAgIGAYhZ+b29MA0GCSqGSIb3DQEBCwUAMIGSMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxEzARBgNVBAMMCmRldi0yMDY0NDUxHDAaBgkqhkiG9w0BCQEWDWluZm9Ab2t0YS5jb20wHhcNMjMwNTI2MjEzMDU5WhcNMzMwNTI2MjEzMTU5WjCBkjELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDTALBgNVBAoMBE9rdGExFDASBgNVBAsMC1NTT1Byb3ZpZGVyMRMwEQYDVQQDDApkZXYtMjA2NDQ1MRwwGgYJKoZIhvcNAQkBFg1pbmZvQG9rdGEuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwvi1+WbF2ceGlLCrLl5PrG1lpj04IsrHX6OE666ObC2WFh+Nxvpxy+Vmzon9c9+akhK3bTv+9ifEoVc6tA1qWuCfXISAn9g81JqI68I1PGUbe6eF8pmOA18rjOrt7x94k4QukpR3+I8DfPJ+TynatltB51laLb8H4jchMafA4rDTjV/ZiYPxV0LMEIbprVyGuvBEhiEWha3wwVdDuJq996okX36YNS8PcGH+5CJ8c3YWZp/wrspgJmfCooMXeV+6zBpZfXqPpMWlUo0gcZqDOFgy3r4vkXehJdVYRlInMfDv04Lvy8VI1YAZClG/duO/6o9YVUFLjD9s+mQfhgaF5wIDAQABMA0GCSqGSIb3DQEBCwUAA4IBAQB1CTrA/pTHkarbhMHsdSFAjVoYWwdAfrssG99rIjwwr/CW9tavTC3keaoUmUeddcnLY4V/TfL07+xgQGHCBR88cnzG9h6rC9qWxt6C3nug3YDVQfkdCDgnW9A8QEvLeq/KVLoRccpJNEENb2Y5ESUXHi1+PtjkFBtvfSgZ4eEhVggirL0bJdWVm700hCnjb2iCGSbSX7WflfPi0GSmjht983caG9OwZDnDzNFt8qGWCxo4bNSThT00JnWEN/6f1BWNOt9YDrxqEyNclqhLL+RDqFsPBFIrQlsoXzqpWqCL8oS9UMNxbGATK2v3d5ueE9+SswBAFBhirCuqZw19Ri2W, loginUrlPost=https://dev-206445.oktapreview.com/app/tivolidev206445_acmeidntest_1/exktq4o24bmQA4fr60h7/sso/saml, loginUrlRedirect=https://dev-206445.oktapreview.com/app/tivolidev206445_acmeidntest_1/exktq4o24bmQA4fr60h7/sso/saml, logoutUrl=https://dev-206445.oktapreview.com/login/signout, nameId=urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, binding=urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST, authnContext=urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport, includeAuthnContext=true, mappingAttribute=email, jitConfiguration={enabled=true, sourceId=2c9180897427f3a501745042afc83144, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email}}, certificateExpirationDate=Thu May 26 21:31:59 GMT 2033, certificateName=EMAILADDRESS=info@okta.com, CN=dev-206445, OU=SSOProvider, O=Okta, L=San Francisco, ST=California, C=US}, {role=SAML_SP, entityId=https://acme.identitysoon.com/sp, alias=acme-sp, callbackUrl=https://acme.test-login.sailpoint.com/saml/SSO/alias/acme-sp, legacyAcsUrl=https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp}] -``` - -- Convert the resource to JSON -```powershell -$ServiceProviderConfiguration | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md b/docs/tools/sdk/powershell/reference/v3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md deleted file mode 100644 index 84917d28c..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -id: service-provider-configuration-federation-protocol-details-inner -title: ServiceProviderConfigurationFederationProtocolDetailsInner -pagination_label: ServiceProviderConfigurationFederationProtocolDetailsInner -sidebar_label: ServiceProviderConfigurationFederationProtocolDetailsInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceProviderConfigurationFederationProtocolDetailsInner'] -slug: /tools/sdk/powershell/v3/models/service-provider-configuration-federation-protocol-details-inner -tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfigurationFederationProtocolDetailsInner'] ---- - - -# ServiceProviderConfigurationFederationProtocolDetailsInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Role** | Pointer to **Enum** [ "SAML_SP" ] | Federation protocol role | [optional] -**EntityId** | Pointer to **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] -**Binding** | Pointer to **String** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] -**AuthContext** | Pointer to **String** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] -**LogoutUrl** | Pointer to **String** | The IDP logout URL. Used with IDP configurations. | [optional] -**IncludeAuthContext** | Pointer to **Boolean** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to $false] -**NameId** | Pointer to **String** | The name id format to use. Used with IDP configurations. | [optional] -**JitConfiguration** | Pointer to [**JITConfiguration**](jit-configuration) | | [optional] -**Cert** | Pointer to **String** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] -**LoginUrlPost** | Pointer to **String** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] -**LoginUrlRedirect** | Pointer to **String** | The IDP Redirect URL. Used with IDP configurations. | [optional] -**MappingAttribute** | Pointer to **String** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [optional] -**CertificateExpirationDate** | Pointer to **String** | The expiration date extracted from the certificate. | [optional] -**CertificateName** | Pointer to **String** | The name extracted from the certificate. | [optional] -**Alias** | Pointer to **String** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] -**CallbackUrl** | Pointer to **String** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ServiceProviderConfigurationFederationProtocolDetailsInner = Initialize-PSSailpoint.V3ServiceProviderConfigurationFederationProtocolDetailsInner -Role SAML_SP ` - -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 ` - -Binding urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST ` - -AuthContext urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport ` - -LogoutUrl https://dev-206445.oktapreview.com/login/signout ` - -IncludeAuthContext false ` - -NameId urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress ` - -JitConfiguration null ` - -Cert -----BEGIN CERTIFICATE-----****-----END CERTIFICATE----- ` - -LoginUrlPost https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml ` - -LoginUrlRedirect https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml ` - -MappingAttribute email ` - -CertificateExpirationDate Fri Mar 08 08:54:24 UTC 2013 ` - -CertificateName OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL ` - -Alias acme-sp ` - -CallbackUrl https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp -``` - -- Convert the resource to JSON -```powershell -$ServiceProviderConfigurationFederationProtocolDetailsInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SessionConfiguration.md b/docs/tools/sdk/powershell/reference/v3/Models/SessionConfiguration.md deleted file mode 100644 index cc427f22c..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SessionConfiguration.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: session-configuration -title: SessionConfiguration -pagination_label: SessionConfiguration -sidebar_label: SessionConfiguration -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SessionConfiguration'] -slug: /tools/sdk/powershell/v3/models/session-configuration -tags: ['SDK', 'Software Development Kit', 'SessionConfiguration'] ---- - - -# SessionConfiguration - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**MaxIdleTime** | Pointer to **Int32** | The maximum time in minutes a session can be idle. | [optional] -**RememberMe** | Pointer to **Boolean** | Denotes if 'remember me' is enabled. | [optional] [default to $false] -**MaxSessionTime** | Pointer to **Int32** | The maximum allowable session time in minutes. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SessionConfiguration = Initialize-PSSailpoint.V3SessionConfiguration -MaxIdleTime 15 ` - -RememberMe true ` - -MaxSessionTime 45 -``` - -- Convert the resource to JSON -```powershell -$SessionConfiguration | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SetLifecycleState200Response.md b/docs/tools/sdk/powershell/reference/v3/Models/SetLifecycleState200Response.md deleted file mode 100644 index a335ee644..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SetLifecycleState200Response.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: set-lifecycle-state200-response -title: SetLifecycleState200Response -pagination_label: SetLifecycleState200Response -sidebar_label: SetLifecycleState200Response -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SetLifecycleState200Response'] -slug: /tools/sdk/powershell/v3/models/set-lifecycle-state200-response -tags: ['SDK', 'Software Development Kit', 'SetLifecycleState200Response'] ---- - - -# SetLifecycleState200Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccountActivityId** | Pointer to **String** | ID of the IdentityRequest object that is generated when the workflow launches. To follow the IdentityRequest, you can provide this ID with a [Get Account Activity request](https://developer.sailpoint.com/docs/api/v3/get-account-activity/). The response will contain relevant information about the IdentityRequest, such as its status. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SetLifecycleState200Response = Initialize-PSSailpoint.V3SetLifecycleState200Response -AccountActivityId 2c9180837ab5b716017ab7c6c9ef1e20 -``` - -- Convert the resource to JSON -```powershell -$SetLifecycleState200Response | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SetLifecycleStateRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/SetLifecycleStateRequest.md deleted file mode 100644 index acfb697f7..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SetLifecycleStateRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: set-lifecycle-state-request -title: SetLifecycleStateRequest -pagination_label: SetLifecycleStateRequest -sidebar_label: SetLifecycleStateRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SetLifecycleStateRequest'] -slug: /tools/sdk/powershell/v3/models/set-lifecycle-state-request -tags: ['SDK', 'Software Development Kit', 'SetLifecycleStateRequest'] ---- - - -# SetLifecycleStateRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**LifecycleStateId** | Pointer to **String** | ID of the lifecycle state to set. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SetLifecycleStateRequest = Initialize-PSSailpoint.V3SetLifecycleStateRequest -LifecycleStateId 2c9180877a86e408017a8c19fefe046c -``` - -- Convert the resource to JSON -```powershell -$SetLifecycleStateRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SlimCampaign.md b/docs/tools/sdk/powershell/reference/v3/Models/SlimCampaign.md deleted file mode 100644 index 8a8f4c34f..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SlimCampaign.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -id: slim-campaign -title: SlimCampaign -pagination_label: SlimCampaign -sidebar_label: SlimCampaign -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SlimCampaign'] -slug: /tools/sdk/powershell/v3/models/slim-campaign -tags: ['SDK', 'Software Development Kit', 'SlimCampaign'] ---- - - -# SlimCampaign - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Id of the campaign | [optional] [readonly] -**Name** | **String** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] -**Description** | **String** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] -**Deadline** | Pointer to **System.DateTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] -**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION", "MACHINE_ACCOUNT" ] | The type of campaign. Could be extended in the future. | [required] -**EmailNotificationEnabled** | Pointer to **Boolean** | Enables email notification for this campaign | [optional] [default to $false] -**AutoRevokeAllowed** | Pointer to **Boolean** | Allows auto revoke for this campaign | [optional] [default to $false] -**RecommendationsEnabled** | Pointer to **Boolean** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to $false] -**Status** | Pointer to **Enum** [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ] | The campaign's current status. | [optional] [readonly] -**CorrelatedStatus** | Pointer to **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] -**Created** | Pointer to **System.DateTime** | Created time of the campaign | [optional] [readonly] -**TotalCertifications** | Pointer to **Int32** | The total number of certifications in this campaign. | [optional] [readonly] -**CompletedCertifications** | Pointer to **Int32** | The number of completed certifications in this campaign. | [optional] [readonly] -**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] - -## Examples - -- Prepare the resource -```powershell -$SlimCampaign = Initialize-PSSailpoint.V3SlimCampaign -Id 2c9079b270a266a60170a2779fcb0007 ` - -Name Manager Campaign ` - -Description Everyone needs to be reviewed by their manager ` - -Deadline 2020-03-15T10:00:01.456Z ` - -Type MANAGER ` - -EmailNotificationEnabled false ` - -AutoRevokeAllowed false ` - -RecommendationsEnabled true ` - -Status ACTIVE ` - -CorrelatedStatus CORRELATED ` - -Created 2020-03-03T22:15:13.611Z ` - -TotalCertifications 100 ` - -CompletedCertifications 10 ` - -Alerts null -``` - -- Convert the resource to JSON -```powershell -$SlimCampaign | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SlimDiscoveredApplications.md b/docs/tools/sdk/powershell/reference/v3/Models/SlimDiscoveredApplications.md deleted file mode 100644 index fa96f867f..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SlimDiscoveredApplications.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: slim-discovered-applications -title: SlimDiscoveredApplications -pagination_label: SlimDiscoveredApplications -sidebar_label: SlimDiscoveredApplications -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SlimDiscoveredApplications'] -slug: /tools/sdk/powershell/v3/models/slim-discovered-applications -tags: ['SDK', 'Software Development Kit', 'SlimDiscoveredApplications'] ---- - - -# SlimDiscoveredApplications - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Unique identifier for the discovered application. | [optional] -**Name** | Pointer to **String** | Name of the discovered application. | [optional] -**DiscoverySource** | Pointer to **String** | Source from which the application was discovered. | [optional] -**DiscoveredVendor** | Pointer to **String** | The vendor associated with the discovered application. | [optional] -**Description** | Pointer to **String** | A brief description of the discovered application. | [optional] -**RecommendedConnectors** | Pointer to **[]String** | List of recommended connectors for the application. | [optional] -**DiscoveredAt** | Pointer to **System.DateTime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] -**CreatedAt** | Pointer to **System.DateTime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] -**Status** | Pointer to **String** | The status of an application within the discovery source. By default this field is set to ""ACTIVE"" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to ""INACTIVE"". | [optional] - -## Examples - -- Prepare the resource -```powershell -$SlimDiscoveredApplications = Initialize-PSSailpoint.V3SlimDiscoveredApplications -Id null ` - -Name ExampleApp ` - -DiscoverySource csv ` - -DiscoveredVendor ExampleVendor ` - -Description An application for managing examples. ` - -RecommendedConnectors [ConnectorA, ConnectorB] ` - -DiscoveredAt 2023-01-01T12:00Z ` - -CreatedAt 2023-01-01T12:00Z ` - -Status ACTIVE -``` - -- Convert the resource to JSON -```powershell -$SlimDiscoveredApplications | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SodExemptCriteria.md b/docs/tools/sdk/powershell/reference/v3/Models/SodExemptCriteria.md deleted file mode 100644 index 06384b8e2..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SodExemptCriteria.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: sod-exempt-criteria -title: SodExemptCriteria -pagination_label: SodExemptCriteria -sidebar_label: SodExemptCriteria -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodExemptCriteria'] -slug: /tools/sdk/powershell/v3/models/sod-exempt-criteria -tags: ['SDK', 'Software Development Kit', 'SodExemptCriteria'] ---- - - -# SodExemptCriteria - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Existing** | Pointer to **Boolean** | If the entitlement already belonged to the user or not. | [optional] [default to $false] -**Type** | Pointer to [**DtoType**](dto-type) | | [optional] -**Id** | Pointer to **String** | Entitlement ID | [optional] -**Name** | Pointer to **String** | Entitlement name | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodExemptCriteria = Initialize-PSSailpoint.V3SodExemptCriteria -Existing true ` - -Type null ` - -Id 2c918085771e9d3301773b3cb66f6398 ` - -Name My HR Entitlement -``` - -- Convert the resource to JSON -```powershell -$SodExemptCriteria | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SodPolicy.md b/docs/tools/sdk/powershell/reference/v3/Models/SodPolicy.md deleted file mode 100644 index d5c9eeed9..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SodPolicy.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -id: sod-policy -title: SodPolicy -pagination_label: SodPolicy -sidebar_label: SodPolicy -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicy'] -slug: /tools/sdk/powershell/v3/models/sod-policy -tags: ['SDK', 'Software Development Kit', 'SodPolicy'] ---- - - -# SodPolicy - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Policy id | [optional] [readonly] -**Name** | Pointer to **String** | Policy Business Name | [optional] -**Created** | Pointer to **System.DateTime** | The time when this SOD policy is created. | [optional] [readonly] -**Modified** | Pointer to **System.DateTime** | The time when this SOD policy is modified. | [optional] [readonly] -**Description** | Pointer to **String** | Optional description of the SOD policy | [optional] -**OwnerRef** | Pointer to [**SodPolicyOwnerRef**](sod-policy-owner-ref) | | [optional] -**ExternalPolicyReference** | Pointer to **String** | Optional External Policy Reference | [optional] -**PolicyQuery** | Pointer to **String** | Search query of the SOD policy | [optional] -**CompensatingControls** | Pointer to **String** | Optional compensating controls(Mitigating Controls) | [optional] -**CorrectionAdvice** | Pointer to **String** | Optional correction advice | [optional] -**State** | Pointer to **Enum** [ "ENFORCED", "NOT_ENFORCED" ] | whether the policy is enforced or not | [optional] -**Tags** | Pointer to **[]String** | tags for this policy object | [optional] -**CreatorId** | Pointer to **String** | Policy's creator ID | [optional] [readonly] -**ModifierId** | Pointer to **String** | Policy's modifier ID | [optional] [readonly] -**ViolationOwnerAssignmentConfig** | Pointer to [**ViolationOwnerAssignmentConfig**](violation-owner-assignment-config) | | [optional] -**Scheduled** | Pointer to **Boolean** | defines whether a policy has been scheduled or not | [optional] [default to $false] -**Type** | Pointer to **Enum** [ "GENERAL", "CONFLICTING_ACCESS_BASED" ] | whether a policy is query based or conflicting access based | [optional] [default to "GENERAL"] -**ConflictingAccessCriteria** | Pointer to [**SodPolicyConflictingAccessCriteria**](sod-policy-conflicting-access-criteria) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodPolicy = Initialize-PSSailpoint.V3SodPolicy -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` - -Name policy-xyz ` - -Created 2020-01-01T00:00Z ` - -Modified 2020-01-01T00:00Z ` - -Description This policy ensures compliance of xyz ` - -OwnerRef null ` - -ExternalPolicyReference XYZ policy ` - -PolicyQuery @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf) ` - -CompensatingControls Have a manager review the transaction decisions for their "out of compliance" employee ` - -CorrectionAdvice Based on the role of the employee, managers should remove access that is not required for their job function. ` - -State ENFORCED ` - -Tags [TAG1, TAG2] ` - -CreatorId 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` - -ModifierId 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` - -ViolationOwnerAssignmentConfig null ` - -Scheduled true ` - -Type GENERAL ` - -ConflictingAccessCriteria null -``` - -- Convert the resource to JSON -```powershell -$SodPolicy | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SodPolicyConflictingAccessCriteria.md b/docs/tools/sdk/powershell/reference/v3/Models/SodPolicyConflictingAccessCriteria.md deleted file mode 100644 index b1b3327cf..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SodPolicyConflictingAccessCriteria.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: sod-policy-conflicting-access-criteria -title: SodPolicyConflictingAccessCriteria -pagination_label: SodPolicyConflictingAccessCriteria -sidebar_label: SodPolicyConflictingAccessCriteria -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicyConflictingAccessCriteria'] -slug: /tools/sdk/powershell/v3/models/sod-policy-conflicting-access-criteria -tags: ['SDK', 'Software Development Kit', 'SodPolicyConflictingAccessCriteria'] ---- - - -# SodPolicyConflictingAccessCriteria - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**LeftCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] -**RightCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodPolicyConflictingAccessCriteria = Initialize-PSSailpoint.V3SodPolicyConflictingAccessCriteria -LeftCriteria null ` - -RightCriteria null -``` - -- Convert the resource to JSON -```powershell -$SodPolicyConflictingAccessCriteria | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SodPolicyDto.md b/docs/tools/sdk/powershell/reference/v3/Models/SodPolicyDto.md deleted file mode 100644 index fe8b5349a..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SodPolicyDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: sod-policy-dto -title: SodPolicyDto -pagination_label: SodPolicyDto -sidebar_label: SodPolicyDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicyDto'] -slug: /tools/sdk/powershell/v3/models/sod-policy-dto -tags: ['SDK', 'Software Development Kit', 'SodPolicyDto'] ---- - - -# SodPolicyDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "SOD_POLICY" ] | SOD policy DTO type. | [optional] -**Id** | Pointer to **String** | SOD policy ID. | [optional] -**Name** | Pointer to **String** | SOD policy display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodPolicyDto = Initialize-PSSailpoint.V3SodPolicyDto -Type SOD_POLICY ` - -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` - -Name Business SOD Policy -``` - -- Convert the resource to JSON -```powershell -$SodPolicyDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SodPolicyOwnerRef.md b/docs/tools/sdk/powershell/reference/v3/Models/SodPolicyOwnerRef.md deleted file mode 100644 index 9c6b08a2b..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SodPolicyOwnerRef.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: sod-policy-owner-ref -title: SodPolicyOwnerRef -pagination_label: SodPolicyOwnerRef -sidebar_label: SodPolicyOwnerRef -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicyOwnerRef'] -slug: /tools/sdk/powershell/v3/models/sod-policy-owner-ref -tags: ['SDK', 'Software Development Kit', 'SodPolicyOwnerRef'] ---- - - -# SodPolicyOwnerRef - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY", "GOVERNANCE_GROUP" ] | Owner type. | [optional] -**Id** | Pointer to **String** | Owner's ID. | [optional] -**Name** | Pointer to **String** | Owner's name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodPolicyOwnerRef = Initialize-PSSailpoint.V3SodPolicyOwnerRef -Type IDENTITY ` - -Id 2c9180a46faadee4016fb4e018c20639 ` - -Name Support -``` - -- Convert the resource to JSON -```powershell -$SodPolicyOwnerRef | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SodPolicySchedule.md b/docs/tools/sdk/powershell/reference/v3/Models/SodPolicySchedule.md deleted file mode 100644 index 0da632865..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SodPolicySchedule.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: sod-policy-schedule -title: SodPolicySchedule -pagination_label: SodPolicySchedule -sidebar_label: SodPolicySchedule -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicySchedule'] -slug: /tools/sdk/powershell/v3/models/sod-policy-schedule -tags: ['SDK', 'Software Development Kit', 'SodPolicySchedule'] ---- - - -# SodPolicySchedule - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | SOD Policy schedule name | [optional] -**Created** | Pointer to **System.DateTime** | The time when this SOD policy schedule is created. | [optional] [readonly] -**Modified** | Pointer to **System.DateTime** | The time when this SOD policy schedule is modified. | [optional] [readonly] -**Description** | Pointer to **String** | SOD Policy schedule description | [optional] -**Schedule** | Pointer to [**Schedule1**](schedule1) | | [optional] -**Recipients** | Pointer to [**[]SodRecipient**](sod-recipient) | | [optional] -**EmailEmptyResults** | Pointer to **Boolean** | Indicates if empty results need to be emailed | [optional] [default to $false] -**CreatorId** | Pointer to **String** | Policy's creator ID | [optional] [readonly] -**ModifierId** | Pointer to **String** | Policy's modifier ID | [optional] [readonly] - -## Examples - -- Prepare the resource -```powershell -$SodPolicySchedule = Initialize-PSSailpoint.V3SodPolicySchedule -Name SCH-1584312283015 ` - -Created 2020-01-01T00:00Z ` - -Modified 2020-01-01T00:00Z ` - -Description Schedule for policy xyz ` - -Schedule null ` - -Recipients null ` - -EmailEmptyResults false ` - -CreatorId 0f11f2a47c944bf3a2bd742580fe3bde ` - -ModifierId 0f11f2a47c944bf3a2bd742580fe3bde -``` - -- Convert the resource to JSON -```powershell -$SodPolicySchedule | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SodRecipient.md b/docs/tools/sdk/powershell/reference/v3/Models/SodRecipient.md deleted file mode 100644 index 5a0f761be..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SodRecipient.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: sod-recipient -title: SodRecipient -pagination_label: SodRecipient -sidebar_label: SodRecipient -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodRecipient'] -slug: /tools/sdk/powershell/v3/models/sod-recipient -tags: ['SDK', 'Software Development Kit', 'SodRecipient'] ---- - - -# SodRecipient - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | SOD policy recipient DTO type. | [optional] -**Id** | Pointer to **String** | SOD policy recipient's identity ID. | [optional] -**Name** | Pointer to **String** | SOD policy recipient's display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodRecipient = Initialize-PSSailpoint.V3SodRecipient -Type IDENTITY ` - -Id 2c7180a46faadee4016fb4e018c20642 ` - -Name Michael Michaels -``` - -- Convert the resource to JSON -```powershell -$SodRecipient | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SodReportResultDto.md b/docs/tools/sdk/powershell/reference/v3/Models/SodReportResultDto.md deleted file mode 100644 index c5e941541..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SodReportResultDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: sod-report-result-dto -title: SodReportResultDto -pagination_label: SodReportResultDto -sidebar_label: SodReportResultDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodReportResultDto'] -slug: /tools/sdk/powershell/v3/models/sod-report-result-dto -tags: ['SDK', 'Software Development Kit', 'SodReportResultDto'] ---- - - -# SodReportResultDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "REPORT_RESULT" ] | SOD policy violation report result DTO type. | [optional] -**Id** | Pointer to **String** | SOD policy violation report result ID. | [optional] -**Name** | Pointer to **String** | Human-readable name of the SOD policy violation report result. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodReportResultDto = Initialize-PSSailpoint.V3SodReportResultDto -Type REPORT_RESULT ` - -Id 2c9180835d191a86015d28455b4b232a ` - -Name SOD Policy 1 Violation -``` - -- Convert the resource to JSON -```powershell -$SodReportResultDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SodViolationCheck.md b/docs/tools/sdk/powershell/reference/v3/Models/SodViolationCheck.md deleted file mode 100644 index 5e6ec48ca..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SodViolationCheck.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: sod-violation-check -title: SodViolationCheck -pagination_label: SodViolationCheck -sidebar_label: SodViolationCheck -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationCheck'] -slug: /tools/sdk/powershell/v3/models/sod-violation-check -tags: ['SDK', 'Software Development Kit', 'SodViolationCheck'] ---- - - -# SodViolationCheck - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RequestId** | **String** | The id of the original request | [required] -**Created** | Pointer to **System.DateTime** | The date-time when this request was created. | [optional] [readonly] - -## Examples - -- Prepare the resource -```powershell -$SodViolationCheck = Initialize-PSSailpoint.V3SodViolationCheck -RequestId 089899f13a8f4da7824996191587bab9 ` - -Created 2020-01-01T00:00Z -``` - -- Convert the resource to JSON -```powershell -$SodViolationCheck | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SodViolationCheckResult.md b/docs/tools/sdk/powershell/reference/v3/Models/SodViolationCheckResult.md deleted file mode 100644 index 8fd412897..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SodViolationCheckResult.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: sod-violation-check-result -title: SodViolationCheckResult -pagination_label: SodViolationCheckResult -sidebar_label: SodViolationCheckResult -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationCheckResult'] -slug: /tools/sdk/powershell/v3/models/sod-violation-check-result -tags: ['SDK', 'Software Development Kit', 'SodViolationCheckResult'] ---- - - -# SodViolationCheckResult - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Message** | Pointer to [**ErrorMessageDto**](error-message-dto) | | [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 completion of the violation check. | [optional] -**ViolationContexts** | Pointer to [**[]SodViolationContext**](sod-violation-context) | | [optional] -**ViolatedPolicies** | Pointer to [**[]SodPolicyDto**](sod-policy-dto) | A list of the SOD policies that were violated. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodViolationCheckResult = Initialize-PSSailpoint.V3SodViolationCheckResult -Message null ` - -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` - -ViolationContexts null ` - -ViolatedPolicies null -``` - -- Convert the resource to JSON -```powershell -$SodViolationCheckResult | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SodViolationContext.md b/docs/tools/sdk/powershell/reference/v3/Models/SodViolationContext.md deleted file mode 100644 index 0da4d47b4..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SodViolationContext.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: sod-violation-context -title: SodViolationContext -pagination_label: SodViolationContext -sidebar_label: SodViolationContext -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContext'] -slug: /tools/sdk/powershell/v3/models/sod-violation-context -tags: ['SDK', 'Software Development Kit', 'SodViolationContext'] ---- - - -# SodViolationContext - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Policy** | Pointer to [**SodPolicyDto**](sod-policy-dto) | | [optional] -**ConflictingAccessCriteria** | Pointer to [**SodViolationContextConflictingAccessCriteria**](sod-violation-context-conflicting-access-criteria) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodViolationContext = Initialize-PSSailpoint.V3SodViolationContext -Policy null ` - -ConflictingAccessCriteria null -``` - -- Convert the resource to JSON -```powershell -$SodViolationContext | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SodViolationContextCheckCompleted.md b/docs/tools/sdk/powershell/reference/v3/Models/SodViolationContextCheckCompleted.md deleted file mode 100644 index 16047a34b..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SodViolationContextCheckCompleted.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: sod-violation-context-check-completed -title: SodViolationContextCheckCompleted -pagination_label: SodViolationContextCheckCompleted -sidebar_label: SodViolationContextCheckCompleted -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContextCheckCompleted'] -slug: /tools/sdk/powershell/v3/models/sod-violation-context-check-completed -tags: ['SDK', 'Software Development Kit', 'SodViolationContextCheckCompleted'] ---- - - -# SodViolationContextCheckCompleted - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**State** | Pointer to **Enum** [ "SUCCESS", "ERROR" ] | The status of SOD violation check | [optional] -**Uuid** | Pointer to **String** | The id of the Violation check event | [optional] -**ViolationCheckResult** | Pointer to [**SodViolationCheckResult**](sod-violation-check-result) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodViolationContextCheckCompleted = Initialize-PSSailpoint.V3SodViolationContextCheckCompleted -State SUCCESS ` - -Uuid f73d16e9-a038-46c5-b217-1246e15fdbdd ` - -ViolationCheckResult null -``` - -- Convert the resource to JSON -```powershell -$SodViolationContextCheckCompleted | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SodViolationContextConflictingAccessCriteria.md b/docs/tools/sdk/powershell/reference/v3/Models/SodViolationContextConflictingAccessCriteria.md deleted file mode 100644 index 76fcf8417..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SodViolationContextConflictingAccessCriteria.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: sod-violation-context-conflicting-access-criteria -title: SodViolationContextConflictingAccessCriteria -pagination_label: SodViolationContextConflictingAccessCriteria -sidebar_label: SodViolationContextConflictingAccessCriteria -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContextConflictingAccessCriteria'] -slug: /tools/sdk/powershell/v3/models/sod-violation-context-conflicting-access-criteria -tags: ['SDK', 'Software Development Kit', 'SodViolationContextConflictingAccessCriteria'] ---- - - -# SodViolationContextConflictingAccessCriteria - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**LeftCriteria** | Pointer to [**SodViolationContextConflictingAccessCriteriaLeftCriteria**](sod-violation-context-conflicting-access-criteria-left-criteria) | | [optional] -**RightCriteria** | Pointer to [**SodViolationContextConflictingAccessCriteriaLeftCriteria**](sod-violation-context-conflicting-access-criteria-left-criteria) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodViolationContextConflictingAccessCriteria = Initialize-PSSailpoint.V3SodViolationContextConflictingAccessCriteria -LeftCriteria null ` - -RightCriteria null -``` - -- Convert the resource to JSON -```powershell -$SodViolationContextConflictingAccessCriteria | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md b/docs/tools/sdk/powershell/reference/v3/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md deleted file mode 100644 index fdece6482..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: sod-violation-context-conflicting-access-criteria-left-criteria -title: SodViolationContextConflictingAccessCriteriaLeftCriteria -pagination_label: SodViolationContextConflictingAccessCriteriaLeftCriteria -sidebar_label: SodViolationContextConflictingAccessCriteriaLeftCriteria -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContextConflictingAccessCriteriaLeftCriteria'] -slug: /tools/sdk/powershell/v3/models/sod-violation-context-conflicting-access-criteria-left-criteria -tags: ['SDK', 'Software Development Kit', 'SodViolationContextConflictingAccessCriteriaLeftCriteria'] ---- - - -# SodViolationContextConflictingAccessCriteriaLeftCriteria - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CriteriaList** | Pointer to [**[]SodExemptCriteria**](sod-exempt-criteria) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodViolationContextConflictingAccessCriteriaLeftCriteria = Initialize-PSSailpoint.V3SodViolationContextConflictingAccessCriteriaLeftCriteria -CriteriaList null -``` - -- Convert the resource to JSON -```powershell -$SodViolationContextConflictingAccessCriteriaLeftCriteria | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Source.md b/docs/tools/sdk/powershell/reference/v3/Models/Source.md deleted file mode 100644 index 769e08194..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Source.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -id: source -title: Source -pagination_label: Source -sidebar_label: Source -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Source'] -slug: /tools/sdk/powershell/v3/models/source -tags: ['SDK', 'Software Development Kit', 'Source'] ---- - - -# Source - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Source ID. | [optional] [readonly] -**Name** | **String** | Source's human-readable name. | [required] -**Description** | Pointer to **String** | Source's human-readable description. | [optional] -**Owner** | [**SourceOwner**](source-owner) | | [required] -**Cluster** | Pointer to [**SourceCluster**](source-cluster) | | [optional] -**AccountCorrelationConfig** | Pointer to [**SourceAccountCorrelationConfig**](source-account-correlation-config) | | [optional] -**AccountCorrelationRule** | Pointer to [**SourceAccountCorrelationRule**](source-account-correlation-rule) | | [optional] -**ManagerCorrelationMapping** | Pointer to [**SourceManagerCorrelationMapping**](source-manager-correlation-mapping) | | [optional] -**ManagerCorrelationRule** | Pointer to [**SourceManagerCorrelationRule**](source-manager-correlation-rule) | | [optional] -**BeforeProvisioningRule** | Pointer to [**SourceBeforeProvisioningRule**](source-before-provisioning-rule) | | [optional] -**Schemas** | Pointer to [**[]SourceSchemasInner**](source-schemas-inner) | List of references to schema objects. | [optional] -**PasswordPolicies** | Pointer to [**[]SourcePasswordPoliciesInner**](source-password-policies-inner) | List of references to the associated PasswordPolicy objects. | [optional] -**Features** | Pointer to **[]String** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] -**Type** | Pointer to **String** | Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [optional] -**Connector** | **String** | Connector script name. | [required] -**ConnectorClass** | Pointer to **String** | Fully qualified name of the Java class that implements the connector interface. | [optional] -**ConnectorAttributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Connector specific configuration. This configuration will differ from type to type. | [optional] -**DeleteThreshold** | Pointer to **Int32** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional] -**Authoritative** | Pointer to **Boolean** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to $false] -**ManagementWorkgroup** | Pointer to [**SourceManagementWorkgroup**](source-management-workgroup) | | [optional] -**Healthy** | Pointer to **Boolean** | When this is true, it indicates that the source is healthy. | [optional] [default to $false] -**Status** | Pointer to **Enum** [ "SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT", "SOURCE_STATE_ERROR_CLUSTER", "SOURCE_STATE_ERROR_SOURCE", "SOURCE_STATE_ERROR_VA", "SOURCE_STATE_FAILURE_CLUSTER", "SOURCE_STATE_FAILURE_SOURCE", "SOURCE_STATE_HEALTHY", "SOURCE_STATE_UNCHECKED_CLUSTER", "SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES", "SOURCE_STATE_UNCHECKED_SOURCE", "SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS" ] | Status identifier that gives specific information about why a source is or isn't healthy. | [optional] -**Since** | Pointer to **String** | Timestamp that shows when a source health check was last performed. | [optional] -**ConnectorId** | Pointer to **String** | Connector ID | [optional] -**ConnectorName** | Pointer to **String** | Name of the connector that was chosen during source creation. | [optional] -**ConnectionType** | Pointer to **String** | Type of connection (direct or file). | [optional] -**ConnectorImplementationId** | Pointer to **String** | Connector implementation ID. | [optional] -**Created** | Pointer to **System.DateTime** | Date-time when the source was created | [optional] -**Modified** | Pointer to **System.DateTime** | Date-time when the source was last modified. | [optional] -**CredentialProviderEnabled** | Pointer to **Boolean** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to $false] -**Category** | Pointer to **String** | Source category (e.g. null, CredentialProvider). | [optional] - -## Examples - -- Prepare the resource -```powershell -$Source = Initialize-PSSailpoint.V3Source -Id 2c91808568c529c60168cca6f90c1324 ` - -Name My Source ` - -Description This is the corporate directory. ` - -Owner null ` - -Cluster null ` - -AccountCorrelationConfig null ` - -AccountCorrelationRule null ` - -ManagerCorrelationMapping null ` - -ManagerCorrelationRule null ` - -BeforeProvisioningRule null ` - -Schemas [{type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232a, name=account}, {type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232b, name=group}] ` - -PasswordPolicies [{type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb053980, name=Corporate Password Policy}, {type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb057777, name=Vendor Password Policy}] ` - -Features [PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS] ` - -Type OpenLDAP - Direct ` - -Connector active-directory ` - -ConnectorClass sailpoint.connector.LDAPConnector ` - -ConnectorAttributes {healthCheckTimeout=30, authSearchAttributes=[cn, uid, mail]} ` - -DeleteThreshold 10 ` - -Authoritative false ` - -ManagementWorkgroup null ` - -Healthy true ` - -Status SOURCE_STATE_HEALTHY ` - -Since 2021-09-28T15:48:29.3801666300Z ` - -ConnectorId active-directory ` - -ConnectorName Active Directory ` - -ConnectionType file ` - -ConnectorImplementationId delimited-file ` - -Created 2022-02-08T14:50:03.827Z ` - -Modified 2024-01-23T18:08:50.897Z ` - -CredentialProviderEnabled false ` - -Category CredentialProvider -``` - -- Convert the resource to JSON -```powershell -$Source | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SourceAccountCorrelationConfig.md b/docs/tools/sdk/powershell/reference/v3/Models/SourceAccountCorrelationConfig.md deleted file mode 100644 index 5c4d439fd..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SourceAccountCorrelationConfig.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: source-account-correlation-config -title: SourceAccountCorrelationConfig -pagination_label: SourceAccountCorrelationConfig -sidebar_label: SourceAccountCorrelationConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAccountCorrelationConfig'] -slug: /tools/sdk/powershell/v3/models/source-account-correlation-config -tags: ['SDK', 'Software Development Kit', 'SourceAccountCorrelationConfig'] ---- - - -# SourceAccountCorrelationConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "ACCOUNT_CORRELATION_CONFIG" ] | Type of object being referenced. | [optional] -**Id** | Pointer to **String** | Account correlation config ID. | [optional] -**Name** | Pointer to **String** | Account correlation config's human-readable display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SourceAccountCorrelationConfig = Initialize-PSSailpoint.V3SourceAccountCorrelationConfig -Type ACCOUNT_CORRELATION_CONFIG ` - -Id 2c9180855d191c59015d28583727245a ` - -Name Directory [source-62867] Account Correlation -``` - -- Convert the resource to JSON -```powershell -$SourceAccountCorrelationConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SourceAccountCorrelationRule.md b/docs/tools/sdk/powershell/reference/v3/Models/SourceAccountCorrelationRule.md deleted file mode 100644 index d7f4febc2..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SourceAccountCorrelationRule.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: source-account-correlation-rule -title: SourceAccountCorrelationRule -pagination_label: SourceAccountCorrelationRule -sidebar_label: SourceAccountCorrelationRule -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAccountCorrelationRule'] -slug: /tools/sdk/powershell/v3/models/source-account-correlation-rule -tags: ['SDK', 'Software Development Kit', 'SourceAccountCorrelationRule'] ---- - - -# SourceAccountCorrelationRule - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "RULE" ] | Type of object being referenced. | [optional] -**Id** | Pointer to **String** | Rule ID. | [optional] -**Name** | Pointer to **String** | Rule's human-readable display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SourceAccountCorrelationRule = Initialize-PSSailpoint.V3SourceAccountCorrelationRule -Type RULE ` - -Id 2c918085708c274401708c2a8a760001 ` - -Name Example Rule -``` - -- Convert the resource to JSON -```powershell -$SourceAccountCorrelationRule | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SourceBeforeProvisioningRule.md b/docs/tools/sdk/powershell/reference/v3/Models/SourceBeforeProvisioningRule.md deleted file mode 100644 index 9c48c0f56..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SourceBeforeProvisioningRule.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: source-before-provisioning-rule -title: SourceBeforeProvisioningRule -pagination_label: SourceBeforeProvisioningRule -sidebar_label: SourceBeforeProvisioningRule -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceBeforeProvisioningRule'] -slug: /tools/sdk/powershell/v3/models/source-before-provisioning-rule -tags: ['SDK', 'Software Development Kit', 'SourceBeforeProvisioningRule'] ---- - - -# SourceBeforeProvisioningRule - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "RULE" ] | Type of object being referenced. | [optional] -**Id** | Pointer to **String** | Rule ID. | [optional] -**Name** | Pointer to **String** | Rule's human-readable display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SourceBeforeProvisioningRule = Initialize-PSSailpoint.V3SourceBeforeProvisioningRule -Type RULE ` - -Id 2c918085708c274401708c2a8a760001 ` - -Name Example Rule -``` - -- Convert the resource to JSON -```powershell -$SourceBeforeProvisioningRule | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SourceCluster.md b/docs/tools/sdk/powershell/reference/v3/Models/SourceCluster.md deleted file mode 100644 index 8f451d52f..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SourceCluster.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: source-cluster -title: SourceCluster -pagination_label: SourceCluster -sidebar_label: SourceCluster -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceCluster'] -slug: /tools/sdk/powershell/v3/models/source-cluster -tags: ['SDK', 'Software Development Kit', 'SourceCluster'] ---- - - -# SourceCluster - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "CLUSTER" ] | Type of object being referenced. | [required] -**Id** | **String** | Cluster ID. | [required] -**Name** | **String** | Cluster's human-readable display name. | [required] - -## Examples - -- Prepare the resource -```powershell -$SourceCluster = Initialize-PSSailpoint.V3SourceCluster -Type CLUSTER ` - -Id 2c9180866166b5b0016167c32ef31a66 ` - -Name Corporate Cluster -``` - -- Convert the resource to JSON -```powershell -$SourceCluster | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SourceClusterDto.md b/docs/tools/sdk/powershell/reference/v3/Models/SourceClusterDto.md deleted file mode 100644 index 1e76fed66..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SourceClusterDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: source-cluster-dto -title: SourceClusterDto -pagination_label: SourceClusterDto -sidebar_label: SourceClusterDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceClusterDto'] -slug: /tools/sdk/powershell/v3/models/source-cluster-dto -tags: ['SDK', 'Software Development Kit', 'SourceClusterDto'] ---- - - -# SourceClusterDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "CLUSTER" ] | Source cluster DTO type. | [optional] -**Id** | Pointer to **String** | Source cluster ID. | [optional] -**Name** | Pointer to **String** | Source cluster display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SourceClusterDto = Initialize-PSSailpoint.V3SourceClusterDto -Type CLUSTER ` - -Id 2c9180847a7fccdd017aa5896f9f4f6f ` - -Name Training VA -``` - -- Convert the resource to JSON -```powershell -$SourceClusterDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SourceConnectionsDto.md b/docs/tools/sdk/powershell/reference/v3/Models/SourceConnectionsDto.md deleted file mode 100644 index 43df5bc39..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SourceConnectionsDto.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: source-connections-dto -title: SourceConnectionsDto -pagination_label: SourceConnectionsDto -sidebar_label: SourceConnectionsDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceConnectionsDto'] -slug: /tools/sdk/powershell/v3/models/source-connections-dto -tags: ['SDK', 'Software Development Kit', 'SourceConnectionsDto'] ---- - - -# SourceConnectionsDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IdentityProfiles** | Pointer to [**[]IdentityProfilesConnections**](identity-profiles-connections) | The IdentityProfile attached to this source | [optional] -**CredentialProfiles** | Pointer to **[]String** | Name of the CredentialProfile attached to this source | [optional] -**SourceAttributes** | Pointer to **[]String** | The attributes attached to this source | [optional] -**MappingProfiles** | Pointer to **[]String** | The profiles attached to this source | [optional] -**DependentCustomTransforms** | Pointer to [**[]Transform**](transform) | | [optional] -**DependentApps** | Pointer to [**[]DependantAppConnections**](dependant-app-connections) | | [optional] -**MissingDependents** | Pointer to [**[]DependantConnectionsMissingDto**](dependant-connections-missing-dto) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SourceConnectionsDto = Initialize-PSSailpoint.V3SourceConnectionsDto -IdentityProfiles null ` - -CredentialProfiles null ` - -SourceAttributes null ` - -MappingProfiles [ODS-AD-Profile, ODS-Profile2] ` - -DependentCustomTransforms null ` - -DependentApps null ` - -MissingDependents null -``` - -- Convert the resource to JSON -```powershell -$SourceConnectionsDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SourceHealthDto.md b/docs/tools/sdk/powershell/reference/v3/Models/SourceHealthDto.md deleted file mode 100644 index 6bd3ebc39..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SourceHealthDto.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: source-health-dto -title: SourceHealthDto -pagination_label: SourceHealthDto -sidebar_label: SourceHealthDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceHealthDto'] -slug: /tools/sdk/powershell/v3/models/source-health-dto -tags: ['SDK', 'Software Development Kit', 'SourceHealthDto'] ---- - - -# SourceHealthDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | the id of the Source | [optional] [readonly] -**Type** | Pointer to **String** | Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. | [optional] -**Name** | Pointer to **String** | the name of the source | [optional] -**Org** | Pointer to **String** | source's org | [optional] -**IsAuthoritative** | Pointer to **Boolean** | Is the source authoritative | [optional] -**IsCluster** | Pointer to **Boolean** | Is the source in a cluster | [optional] -**Hostname** | Pointer to **String** | source's hostname | [optional] -**Pod** | Pointer to **String** | source's pod | [optional] -**IqServiceVersion** | Pointer to **String** | The version of the iqService | [optional] -**Status** | Pointer to **Enum** [ "SOURCE_STATE_ERROR_CLUSTER", "SOURCE_STATE_ERROR_SOURCE", "SOURCE_STATE_ERROR_VA", "SOURCE_STATE_FAILURE_CLUSTER", "SOURCE_STATE_FAILURE_SOURCE", "SOURCE_STATE_HEALTHY", "SOURCE_STATE_UNCHECKED_CLUSTER", "SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES", "SOURCE_STATE_UNCHECKED_SOURCE", "SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS" ] | connection test result | [optional] - -## Examples - -- Prepare the resource -```powershell -$SourceHealthDto = Initialize-PSSailpoint.V3SourceHealthDto -Id 2c91808568c529c60168cca6f90c1324 ` - -Type OpenLDAP - Direct ` - -Name Source1234 ` - -Org denali-cjh ` - -IsAuthoritative false ` - -IsCluster false ` - -Hostname megapod-useast1-secret-hostname.sailpoint.com ` - -Pod megapod-useast1 ` - -IqServiceVersion iqVersion123 ` - -Status SOURCE_STATE_UNCHECKED_SOURCE -``` - -- Convert the resource to JSON -```powershell -$SourceHealthDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SourceManagementWorkgroup.md b/docs/tools/sdk/powershell/reference/v3/Models/SourceManagementWorkgroup.md deleted file mode 100644 index 5fb848d0c..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SourceManagementWorkgroup.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: source-management-workgroup -title: SourceManagementWorkgroup -pagination_label: SourceManagementWorkgroup -sidebar_label: SourceManagementWorkgroup -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceManagementWorkgroup'] -slug: /tools/sdk/powershell/v3/models/source-management-workgroup -tags: ['SDK', 'Software Development Kit', 'SourceManagementWorkgroup'] ---- - - -# SourceManagementWorkgroup - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "GOVERNANCE_GROUP" ] | Type of object being referenced. | [optional] -**Id** | Pointer to **String** | Management workgroup ID. | [optional] -**Name** | Pointer to **String** | Management workgroup's human-readable display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SourceManagementWorkgroup = Initialize-PSSailpoint.V3SourceManagementWorkgroup -Type GOVERNANCE_GROUP ` - -Id 2c91808568c529c60168cca6f90c2222 ` - -Name My Management Workgroup -``` - -- Convert the resource to JSON -```powershell -$SourceManagementWorkgroup | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SourceManagerCorrelationMapping.md b/docs/tools/sdk/powershell/reference/v3/Models/SourceManagerCorrelationMapping.md deleted file mode 100644 index 363845803..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SourceManagerCorrelationMapping.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: source-manager-correlation-mapping -title: SourceManagerCorrelationMapping -pagination_label: SourceManagerCorrelationMapping -sidebar_label: SourceManagerCorrelationMapping -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceManagerCorrelationMapping'] -slug: /tools/sdk/powershell/v3/models/source-manager-correlation-mapping -tags: ['SDK', 'Software Development Kit', 'SourceManagerCorrelationMapping'] ---- - - -# SourceManagerCorrelationMapping - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccountAttributeName** | Pointer to **String** | Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. | [optional] -**IdentityAttributeName** | Pointer to **String** | Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SourceManagerCorrelationMapping = Initialize-PSSailpoint.V3SourceManagerCorrelationMapping -AccountAttributeName manager ` - -IdentityAttributeName manager -``` - -- Convert the resource to JSON -```powershell -$SourceManagerCorrelationMapping | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SourceManagerCorrelationRule.md b/docs/tools/sdk/powershell/reference/v3/Models/SourceManagerCorrelationRule.md deleted file mode 100644 index 263523476..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SourceManagerCorrelationRule.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: source-manager-correlation-rule -title: SourceManagerCorrelationRule -pagination_label: SourceManagerCorrelationRule -sidebar_label: SourceManagerCorrelationRule -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceManagerCorrelationRule'] -slug: /tools/sdk/powershell/v3/models/source-manager-correlation-rule -tags: ['SDK', 'Software Development Kit', 'SourceManagerCorrelationRule'] ---- - - -# SourceManagerCorrelationRule - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "RULE" ] | Type of object being referenced. | [optional] -**Id** | Pointer to **String** | Rule ID. | [optional] -**Name** | Pointer to **String** | Rule's human-readable display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SourceManagerCorrelationRule = Initialize-PSSailpoint.V3SourceManagerCorrelationRule -Type RULE ` - -Id 2c918085708c274401708c2a8a760001 ` - -Name Example Rule -``` - -- Convert the resource to JSON -```powershell -$SourceManagerCorrelationRule | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SourceOwner.md b/docs/tools/sdk/powershell/reference/v3/Models/SourceOwner.md deleted file mode 100644 index dedc6a817..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SourceOwner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: source-owner -title: SourceOwner -pagination_label: SourceOwner -sidebar_label: SourceOwner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceOwner'] -slug: /tools/sdk/powershell/v3/models/source-owner -tags: ['SDK', 'Software Development Kit', 'SourceOwner'] ---- - - -# SourceOwner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | Type of object being referenced. | [optional] -**Id** | Pointer to **String** | Owner identity's ID. | [optional] -**Name** | Pointer to **String** | Owner identity's human-readable display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SourceOwner = Initialize-PSSailpoint.V3SourceOwner -Type IDENTITY ` - -Id 2c91808568c529c60168cca6f90c1313 ` - -Name MyName -``` - -- Convert the resource to JSON -```powershell -$SourceOwner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SourcePasswordPoliciesInner.md b/docs/tools/sdk/powershell/reference/v3/Models/SourcePasswordPoliciesInner.md deleted file mode 100644 index e4b755d04..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SourcePasswordPoliciesInner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: source-password-policies-inner -title: SourcePasswordPoliciesInner -pagination_label: SourcePasswordPoliciesInner -sidebar_label: SourcePasswordPoliciesInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourcePasswordPoliciesInner'] -slug: /tools/sdk/powershell/v3/models/source-password-policies-inner -tags: ['SDK', 'Software Development Kit', 'SourcePasswordPoliciesInner'] ---- - - -# SourcePasswordPoliciesInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "PASSWORD_POLICY" ] | Type of object being referenced. | [optional] -**Id** | Pointer to **String** | Policy ID. | [optional] -**Name** | Pointer to **String** | Policy's human-readable display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SourcePasswordPoliciesInner = Initialize-PSSailpoint.V3SourcePasswordPoliciesInner -Type PASSWORD_POLICY ` - -Id 2c91808568c529c60168cca6f90c1777 ` - -Name My Password Policy -``` - -- Convert the resource to JSON -```powershell -$SourcePasswordPoliciesInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SourceSchemasInner.md b/docs/tools/sdk/powershell/reference/v3/Models/SourceSchemasInner.md deleted file mode 100644 index d3cbae9dd..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SourceSchemasInner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: source-schemas-inner -title: SourceSchemasInner -pagination_label: SourceSchemasInner -sidebar_label: SourceSchemasInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceSchemasInner'] -slug: /tools/sdk/powershell/v3/models/source-schemas-inner -tags: ['SDK', 'Software Development Kit', 'SourceSchemasInner'] ---- - - -# SourceSchemasInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "CONNECTOR_SCHEMA" ] | Type of object being referenced. | [optional] -**Id** | Pointer to **String** | Schema ID. | [optional] -**Name** | Pointer to **String** | Schema's human-readable display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SourceSchemasInner = Initialize-PSSailpoint.V3SourceSchemasInner -Type CONNECTOR_SCHEMA ` - -Id 2c91808568c529c60168cca6f90c1777 ` - -Name MySchema -``` - -- Convert the resource to JSON -```powershell -$SourceSchemasInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SourceUsage.md b/docs/tools/sdk/powershell/reference/v3/Models/SourceUsage.md deleted file mode 100644 index 90c5b77b7..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SourceUsage.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: source-usage -title: SourceUsage -pagination_label: SourceUsage -sidebar_label: SourceUsage -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceUsage'] -slug: /tools/sdk/powershell/v3/models/source-usage -tags: ['SDK', 'Software Development Kit', 'SourceUsage'] ---- - - -# SourceUsage - -## 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 **Double** | The average number of days that accounts were active within this source, for the month. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SourceUsage = Initialize-PSSailpoint.V3SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` - -Count 10.45 -``` - -- Convert the resource to JSON -```powershell -$SourceUsage | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SourceUsageStatus.md b/docs/tools/sdk/powershell/reference/v3/Models/SourceUsageStatus.md deleted file mode 100644 index a0e60731d..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SourceUsageStatus.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: source-usage-status -title: SourceUsageStatus -pagination_label: SourceUsageStatus -sidebar_label: SourceUsageStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceUsageStatus'] -slug: /tools/sdk/powershell/v3/models/source-usage-status -tags: ['SDK', 'Software Development Kit', 'SourceUsageStatus'] ---- - - -# SourceUsageStatus - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Status** | Pointer to **Enum** [ "COMPLETE", "INCOMPLETE" ] | Source Usage Status. Acceptable values are: - COMPLETE - This status means that an activity data source has been setup and usage insights are available for the source. - INCOMPLETE - This status means that an activity data source has not been setup and usage insights are not available for the source. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SourceUsageStatus = Initialize-PSSailpoint.V3SourceUsageStatus -Status COMPLETE -``` - -- Convert the resource to JSON -```powershell -$SourceUsageStatus | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SpConfigMessage.md b/docs/tools/sdk/powershell/reference/v3/Models/SpConfigMessage.md deleted file mode 100644 index 824036dd9..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SpConfigMessage.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: sp-config-message -title: SpConfigMessage -pagination_label: SpConfigMessage -sidebar_label: SpConfigMessage -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigMessage'] -slug: /tools/sdk/powershell/v3/models/sp-config-message -tags: ['SDK', 'Software Development Kit', 'SpConfigMessage'] ---- - - -# SpConfigMessage - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Key** | **String** | Message key. | [required] -**Text** | **String** | Message text. | [required] -**Details** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Message details if any, in key:value pairs. | [required] - -## Examples - -- Prepare the resource -```powershell -$SpConfigMessage = Initialize-PSSailpoint.V3SpConfigMessage -Key UNKNOWN_REFERENCE_RESOLVER ` - -Text Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity] ` - -Details {details=message details} -``` - -- Convert the resource to JSON -```powershell -$SpConfigMessage | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SpDetails.md b/docs/tools/sdk/powershell/reference/v3/Models/SpDetails.md deleted file mode 100644 index 902a10fba..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SpDetails.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: sp-details -title: SpDetails -pagination_label: SpDetails -sidebar_label: SpDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SpDetails'] -slug: /tools/sdk/powershell/v3/models/sp-details -tags: ['SDK', 'Software Development Kit', 'SpDetails'] ---- - - -# SpDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Role** | Pointer to **Enum** [ "SAML_SP" ] | Federation protocol role | [optional] -**EntityId** | Pointer to **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] -**Alias** | Pointer to **String** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] -**CallbackUrl** | Pointer to **String** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SpDetails = Initialize-PSSailpoint.V3SpDetails -Role SAML_SP ` - -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 ` - -Alias acme-sp ` - -CallbackUrl https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp -``` - -- Convert the resource to JSON -```powershell -$SpDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Split.md b/docs/tools/sdk/powershell/reference/v3/Models/Split.md deleted file mode 100644 index bbe35fa38..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Split.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: split -title: Split -pagination_label: Split -sidebar_label: Split -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Split'] -slug: /tools/sdk/powershell/v3/models/split -tags: ['SDK', 'Software Development Kit', 'Split'] ---- - - -# Split - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Delimiter** | **String** | This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data | [required] -**Index** | **String** | An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc. | [required] -**Throws** | Pointer to **Boolean** | A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) `true` - The transform should return ""IndexOutOfBoundsException"" `false` - The transform should return null If not provided, the transform will default to false and return a null | [optional] [default to $false] -**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 -$Split = Initialize-PSSailpoint.V3Split -Delimiter , ` - -Index 5 ` - -Throws true ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$Split | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/StandardLevel.md b/docs/tools/sdk/powershell/reference/v3/Models/StandardLevel.md deleted file mode 100644 index 6e0aaa82d..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/StandardLevel.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: standard-level -title: StandardLevel -pagination_label: StandardLevel -sidebar_label: StandardLevel -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'StandardLevel'] -slug: /tools/sdk/powershell/v3/models/standard-level -tags: ['SDK', 'Software Development Kit', 'StandardLevel'] ---- - - -# StandardLevel - -## Enum - - -* `false` (value: `"false"`) - -* `FATAL` (value: `"FATAL"`) - -* `ERROR` (value: `"ERROR"`) - -* `WARN` (value: `"WARN"`) - -* `INFO` (value: `"INFO"`) - -* `DEBUG` (value: `"DEBUG"`) - -* `TRACE` (value: `"TRACE"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Static.md b/docs/tools/sdk/powershell/reference/v3/Models/Static.md deleted file mode 100644 index e87e1d1ed..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Static.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: static -title: Static -pagination_label: Static -sidebar_label: Static -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Static'] -slug: /tools/sdk/powershell/v3/models/static -tags: ['SDK', 'Software Development Kit', 'Static'] ---- - - -# Static - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Values** | **String** | This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language. | [required] -**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] - -## Examples - -- Prepare the resource -```powershell -$Static = Initialize-PSSailpoint.V3Static -Values string$variable ` - -RequiresPeriodicRefresh false -``` - -- Convert the resource to JSON -```powershell -$Static | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/SubSearchAggregationSpecification.md b/docs/tools/sdk/powershell/reference/v3/Models/SubSearchAggregationSpecification.md deleted file mode 100644 index a8de4cadb..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/SubSearchAggregationSpecification.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: sub-search-aggregation-specification -title: SubSearchAggregationSpecification -pagination_label: SubSearchAggregationSpecification -sidebar_label: SubSearchAggregationSpecification -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SubSearchAggregationSpecification'] -slug: /tools/sdk/powershell/v3/models/sub-search-aggregation-specification -tags: ['SDK', 'Software Development Kit', 'SubSearchAggregationSpecification'] ---- - - -# SubSearchAggregationSpecification - -## 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] -**SubAggregation** | Pointer to [**Aggregations**](aggregations) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SubSearchAggregationSpecification = Initialize-PSSailpoint.V3SubSearchAggregationSpecification -Nested null ` - -Metric null ` - -VarFilter null ` - -Bucket null ` - -SubAggregation null -``` - -- Convert the resource to JSON -```powershell -$SubSearchAggregationSpecification | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Substring.md b/docs/tools/sdk/powershell/reference/v3/Models/Substring.md deleted file mode 100644 index 85d2db325..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Substring.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: substring -title: Substring -pagination_label: Substring -sidebar_label: Substring -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Substring'] -slug: /tools/sdk/powershell/v3/models/substring -tags: ['SDK', 'Software Development Kit', 'Substring'] ---- - - -# Substring - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**VarBegin** | **Int32** | The index of the first character to include in the returned substring. If `begin` is set to -1, the transform will begin at character 0 of the input data | [required] -**BeginOffset** | Pointer to **Int32** | This integer value is the number of characters to add to the begin attribute when returning a substring. This attribute is only used if begin is not -1. | [optional] -**VarEnd** | Pointer to **Int32** | The index of the first character to exclude from the returned substring. If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. | [optional] -**EndOffset** | Pointer to **Int32** | This integer value is the number of characters to add to the end attribute when returning a substring. This attribute is only used if end is provided and is not -1. | [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 -$Substring = Initialize-PSSailpoint.V3Substring -VarBegin 1 ` - -BeginOffset 3 ` - -VarEnd 6 ` - -EndOffset 1 ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$Substring | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/TaggedObject.md b/docs/tools/sdk/powershell/reference/v3/Models/TaggedObject.md deleted file mode 100644 index caa2054bd..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/TaggedObject.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: tagged-object -title: TaggedObject -pagination_label: TaggedObject -sidebar_label: TaggedObject -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TaggedObject'] -slug: /tools/sdk/powershell/v3/models/tagged-object -tags: ['SDK', 'Software Development Kit', 'TaggedObject'] ---- - - -# TaggedObject - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ObjectRef** | Pointer to [**TaggedObjectDto**](tagged-object-dto) | | [optional] -**Tags** | Pointer to **[]String** | Labels to be applied to an Object | [optional] - -## Examples - -- Prepare the resource -```powershell -$TaggedObject = Initialize-PSSailpoint.V3TaggedObject -ObjectRef null ` - -Tags [BU_FINANCE, PCI] -``` - -- Convert the resource to JSON -```powershell -$TaggedObject | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/TaggedObjectDto.md b/docs/tools/sdk/powershell/reference/v3/Models/TaggedObjectDto.md deleted file mode 100644 index 1d0aa12fe..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/TaggedObjectDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: tagged-object-dto -title: TaggedObjectDto -pagination_label: TaggedObjectDto -sidebar_label: TaggedObjectDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TaggedObjectDto'] -slug: /tools/sdk/powershell/v3/models/tagged-object-dto -tags: ['SDK', 'Software Development Kit', 'TaggedObjectDto'] ---- - - -# TaggedObjectDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "APPLICATION", "CAMPAIGN", "ENTITLEMENT", "IDENTITY", "ROLE", "SOD_POLICY", "SOURCE" ] | DTO type | [optional] -**Id** | Pointer to **String** | ID of the object this reference applies to | [optional] -**Name** | Pointer to **String** | Human-readable display name of the object this reference applies to | [optional] - -## Examples - -- Prepare the resource -```powershell -$TaggedObjectDto = Initialize-PSSailpoint.V3TaggedObjectDto -Type IDENTITY ` - -Id 2c91808568c529c60168cca6f90c1313 ` - -Name William Wilson -``` - -- Convert the resource to JSON -```powershell -$TaggedObjectDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/TaskResultDetails.md b/docs/tools/sdk/powershell/reference/v3/Models/TaskResultDetails.md deleted file mode 100644 index 2c2f23785..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/TaskResultDetails.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -id: task-result-details -title: TaskResultDetails -pagination_label: TaskResultDetails -sidebar_label: TaskResultDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TaskResultDetails'] -slug: /tools/sdk/powershell/v3/models/task-result-details -tags: ['SDK', 'Software Development Kit', 'TaskResultDetails'] ---- - - -# TaskResultDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "QUARTZ", "QPOC", "MENTOS", "QUEUED_TASK" ] | Type of the job or task underlying in the report processing. It could be a quartz task, QPOC or MENTOS jobs or a refresh/sync task. | [optional] -**Id** | Pointer to **String** | Unique task definition identifier. | [optional] -**ReportType** | Pointer to **Enum** [ "ACCOUNTS", "IDENTITIES_DETAILS", "IDENTITIES", "IDENTITY_PROFILE_IDENTITY_ERROR", "ORPHAN_IDENTITIES", "SEARCH_EXPORT", "UNCORRELATED_ACCOUNTS" ] | Use this property to define what report should be processed in the RDE service. | [optional] -**Description** | Pointer to **String** | Description of the report purpose and/or contents. | [optional] -**ParentName** | Pointer to **String** | Name of the parent task/report if exists. | [optional] -**Launcher** | Pointer to **String** | Name of the report processing initiator. | [optional] -**Created** | Pointer to **System.DateTime** | Report creation date | [optional] -**Launched** | Pointer to **System.DateTime** | Report start date | [optional] -**Completed** | Pointer to **System.DateTime** | Report completion date | [optional] -**CompletionStatus** | Pointer to **Enum** [ "SUCCESS", "WARNING", "ERROR", "TERMINATED", "TEMP_ERROR" ] | Report completion status. | [optional] -**Messages** | Pointer to [**[]TaskResultDetailsMessagesInner**](task-result-details-messages-inner) | List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. | [optional] -**Returns** | Pointer to [**[]TaskResultDetailsReturnsInner**](task-result-details-returns-inner) | Task definition results, if necessary. | [optional] -**Attributes** | Pointer to [**map[string]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Extra attributes map(dictionary) needed for the report. | [optional] -**Progress** | Pointer to **String** | Current report state. | [optional] - -## Examples - -- Prepare the resource -```powershell -$TaskResultDetails = Initialize-PSSailpoint.V3TaskResultDetails -Type MENTOS ` - -Id a248c16fe22222b2bd49615481311111 ` - -ReportType IDENTITIES_DETAILS ` - -Description A detailed view of the identities in the system. ` - -ParentName Audit Report ` - -Launcher cloudadmin ` - -Created null ` - -Launched null ` - -Completed null ` - -CompletionStatus Success ` - -Messages [] ` - -Returns [] ` - -Attributes {org=an-org} ` - -Progress Initializing... -``` - -- Convert the resource to JSON -```powershell -$TaskResultDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/TaskResultDetailsMessagesInner.md b/docs/tools/sdk/powershell/reference/v3/Models/TaskResultDetailsMessagesInner.md deleted file mode 100644 index d065918d6..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/TaskResultDetailsMessagesInner.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: task-result-details-messages-inner -title: TaskResultDetailsMessagesInner -pagination_label: TaskResultDetailsMessagesInner -sidebar_label: TaskResultDetailsMessagesInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TaskResultDetailsMessagesInner'] -slug: /tools/sdk/powershell/v3/models/task-result-details-messages-inner -tags: ['SDK', 'Software Development Kit', 'TaskResultDetailsMessagesInner'] ---- - - -# TaskResultDetailsMessagesInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "INFO", "WARN", "ERROR" ] | Type of the message. | [optional] -**VarError** | Pointer to **Boolean** | Flag whether message is an error. | [optional] [default to $false] -**Warning** | Pointer to **Boolean** | Flag whether message is a warning. | [optional] [default to $false] -**Key** | Pointer to **String** | Message string identifier. | [optional] -**LocalizedText** | Pointer to **String** | Message context with the locale based language. | [optional] - -## Examples - -- Prepare the resource -```powershell -$TaskResultDetailsMessagesInner = Initialize-PSSailpoint.V3TaskResultDetailsMessagesInner -Type WARN ` - -VarError false ` - -Warning true ` - -Key The following account(s) failed to correlate: A,B,C ` - -LocalizedText The following account(s) failed to correlate: A,B,C -``` - -- Convert the resource to JSON -```powershell -$TaskResultDetailsMessagesInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/TaskResultDetailsReturnsInner.md b/docs/tools/sdk/powershell/reference/v3/Models/TaskResultDetailsReturnsInner.md deleted file mode 100644 index f2a64f0f9..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/TaskResultDetailsReturnsInner.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: task-result-details-returns-inner -title: TaskResultDetailsReturnsInner -pagination_label: TaskResultDetailsReturnsInner -sidebar_label: TaskResultDetailsReturnsInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TaskResultDetailsReturnsInner'] -slug: /tools/sdk/powershell/v3/models/task-result-details-returns-inner -tags: ['SDK', 'Software Development Kit', 'TaskResultDetailsReturnsInner'] ---- - - -# TaskResultDetailsReturnsInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DisplayLabel** | Pointer to **String** | Attribute description. | [optional] -**AttributeName** | Pointer to **String** | System or database attribute name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$TaskResultDetailsReturnsInner = Initialize-PSSailpoint.V3TaskResultDetailsReturnsInner -DisplayLabel ` - -AttributeName -``` - -- Convert the resource to JSON -```powershell -$TaskResultDetailsReturnsInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/TaskResultDto.md b/docs/tools/sdk/powershell/reference/v3/Models/TaskResultDto.md deleted file mode 100644 index 7b84cc43e..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/TaskResultDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: task-result-dto -title: TaskResultDto -pagination_label: TaskResultDto -sidebar_label: TaskResultDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TaskResultDto'] -slug: /tools/sdk/powershell/v3/models/task-result-dto -tags: ['SDK', 'Software Development Kit', 'TaskResultDto'] ---- - - -# TaskResultDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "TASK_RESULT" ] | Task result DTO type. | [optional] -**Id** | Pointer to **String** | Task result ID. | [optional] -**Name** | Pointer to **String** | Task result display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$TaskResultDto = Initialize-PSSailpoint.V3TaskResultDto -Type TASK_RESULT ` - -Id 464ae7bf791e49fdb74606a2e4a89635 ` - -Name null -``` - -- Convert the resource to JSON -```powershell -$TaskResultDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/TaskResultSimplified.md b/docs/tools/sdk/powershell/reference/v3/Models/TaskResultSimplified.md deleted file mode 100644 index 89ca6317e..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/TaskResultSimplified.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: task-result-simplified -title: TaskResultSimplified -pagination_label: TaskResultSimplified -sidebar_label: TaskResultSimplified -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TaskResultSimplified'] -slug: /tools/sdk/powershell/v3/models/task-result-simplified -tags: ['SDK', 'Software Development Kit', 'TaskResultSimplified'] ---- - - -# TaskResultSimplified - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Task identifier | [optional] -**Name** | Pointer to **String** | Task name | [optional] -**Description** | Pointer to **String** | Task description | [optional] -**Launcher** | Pointer to **String** | User or process who launched the task | [optional] -**Completed** | Pointer to **System.DateTime** | Date time of completion | [optional] -**Launched** | Pointer to **System.DateTime** | Date time when the task was launched | [optional] -**CompletionStatus** | Pointer to **Enum** [ "Success", "Warning", "Error", "Terminated", "TempError" ] | Task result status | [optional] - -## Examples - -- Prepare the resource -```powershell -$TaskResultSimplified = Initialize-PSSailpoint.V3TaskResultSimplified -Id ff8081814d977c21014da056804a0af3 ` - -Name Background Object Terminator c8f030f2-b1a6-4e33-99e8-6935bc18735d ` - -Description Generic task for terminating data in the overlay, used by the TerminationService. ` - -Launcher support ` - -Completed null ` - -Launched null ` - -CompletionStatus Success -``` - -- Convert the resource to JSON -```powershell -$TaskResultSimplified | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/TestExternalExecuteWorkflow200Response.md b/docs/tools/sdk/powershell/reference/v3/Models/TestExternalExecuteWorkflow200Response.md deleted file mode 100644 index 77b4b4668..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/TestExternalExecuteWorkflow200Response.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: test-external-execute-workflow200-response -title: TestExternalExecuteWorkflow200Response -pagination_label: TestExternalExecuteWorkflow200Response -sidebar_label: TestExternalExecuteWorkflow200Response -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TestExternalExecuteWorkflow200Response'] -slug: /tools/sdk/powershell/v3/models/test-external-execute-workflow200-response -tags: ['SDK', 'Software Development Kit', 'TestExternalExecuteWorkflow200Response'] ---- - - -# TestExternalExecuteWorkflow200Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Payload** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The input that was received | [optional] - -## Examples - -- Prepare the resource -```powershell -$TestExternalExecuteWorkflow200Response = Initialize-PSSailpoint.V3TestExternalExecuteWorkflow200Response -Payload {test=hello world} -``` - -- Convert the resource to JSON -```powershell -$TestExternalExecuteWorkflow200Response | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/TestExternalExecuteWorkflowRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/TestExternalExecuteWorkflowRequest.md deleted file mode 100644 index 33c479390..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/TestExternalExecuteWorkflowRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: test-external-execute-workflow-request -title: TestExternalExecuteWorkflowRequest -pagination_label: TestExternalExecuteWorkflowRequest -sidebar_label: TestExternalExecuteWorkflowRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TestExternalExecuteWorkflowRequest'] -slug: /tools/sdk/powershell/v3/models/test-external-execute-workflow-request -tags: ['SDK', 'Software Development Kit', 'TestExternalExecuteWorkflowRequest'] ---- - - -# TestExternalExecuteWorkflowRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**VarInput** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The test input for the workflow | [optional] - -## Examples - -- Prepare the resource -```powershell -$TestExternalExecuteWorkflowRequest = Initialize-PSSailpoint.V3TestExternalExecuteWorkflowRequest -VarInput {test=hello world} -``` - -- Convert the resource to JSON -```powershell -$TestExternalExecuteWorkflowRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/TestWorkflow200Response.md b/docs/tools/sdk/powershell/reference/v3/Models/TestWorkflow200Response.md deleted file mode 100644 index f5a088a6f..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/TestWorkflow200Response.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: test-workflow200-response -title: TestWorkflow200Response -pagination_label: TestWorkflow200Response -sidebar_label: TestWorkflow200Response -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TestWorkflow200Response'] -slug: /tools/sdk/powershell/v3/models/test-workflow200-response -tags: ['SDK', 'Software Development Kit', 'TestWorkflow200Response'] ---- - - -# TestWorkflow200Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**WorkflowExecutionId** | Pointer to **String** | The workflow execution id | [optional] - -## Examples - -- Prepare the resource -```powershell -$TestWorkflow200Response = Initialize-PSSailpoint.V3TestWorkflow200Response -WorkflowExecutionId 0e11cefa-96e7-4b67-90d0-065bc1da5753 -``` - -- Convert the resource to JSON -```powershell -$TestWorkflow200Response | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/TestWorkflowRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/TestWorkflowRequest.md deleted file mode 100644 index 56f8c9592..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/TestWorkflowRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: test-workflow-request -title: TestWorkflowRequest -pagination_label: TestWorkflowRequest -sidebar_label: TestWorkflowRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TestWorkflowRequest'] -slug: /tools/sdk/powershell/v3/models/test-workflow-request -tags: ['SDK', 'Software Development Kit', 'TestWorkflowRequest'] ---- - - -# TestWorkflowRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**VarInput** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The test input for the workflow. | [required] - -## Examples - -- Prepare the resource -```powershell -$TestWorkflowRequest = Initialize-PSSailpoint.V3TestWorkflowRequest -VarInput null -``` - -- Convert the resource to JSON -```powershell -$TestWorkflowRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/TextQuery.md b/docs/tools/sdk/powershell/reference/v3/Models/TextQuery.md deleted file mode 100644 index e1c6ee131..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/TextQuery.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: text-query -title: TextQuery -pagination_label: TextQuery -sidebar_label: TextQuery -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TextQuery'] -slug: /tools/sdk/powershell/v3/models/text-query -tags: ['SDK', 'Software Development Kit', 'TextQuery'] ---- - - -# TextQuery - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Terms** | **[]String** | Words or characters that specify a particular thing to be searched for. | [required] -**Fields** | **[]String** | The fields to be searched. | [required] -**MatchAny** | Pointer to **Boolean** | Indicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found. | [optional] [default to $false] -**Contains** | Pointer to **Boolean** | Indicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$TextQuery = Initialize-PSSailpoint.V3TextQuery -Terms [The quick brown fox, 3141592, 7] ` - -Fields [displayName, employeeNumber, roleCount] ` - -MatchAny false ` - -Contains true -``` - -- Convert the resource to JSON -```powershell -$TextQuery | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/TokenAuthRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/TokenAuthRequest.md deleted file mode 100644 index 2f8db3086..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/TokenAuthRequest.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: token-auth-request -title: TokenAuthRequest -pagination_label: TokenAuthRequest -sidebar_label: TokenAuthRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TokenAuthRequest'] -slug: /tools/sdk/powershell/v3/models/token-auth-request -tags: ['SDK', 'Software Development Kit', 'TokenAuthRequest'] ---- - - -# TokenAuthRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Token** | **String** | Token value | [required] -**UserAlias** | **String** | User alias from table spt_identity field named 'name' | [required] -**DeliveryType** | **Enum** [ "SMS_PERSONAL", "VOICE_PERSONAL", "SMS_WORK", "VOICE_WORK", "EMAIL_WORK", "EMAIL_PERSONAL" ] | Token delivery type | [required] - -## Examples - -- Prepare the resource -```powershell -$TokenAuthRequest = Initialize-PSSailpoint.V3TokenAuthRequest -Token 12345 ` - -UserAlias will.albin ` - -DeliveryType EMAIL_WORK -``` - -- Convert the resource to JSON -```powershell -$TokenAuthRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/TokenAuthResponse.md b/docs/tools/sdk/powershell/reference/v3/Models/TokenAuthResponse.md deleted file mode 100644 index 415ccdf2c..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/TokenAuthResponse.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: token-auth-response -title: TokenAuthResponse -pagination_label: TokenAuthResponse -sidebar_label: TokenAuthResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TokenAuthResponse'] -slug: /tools/sdk/powershell/v3/models/token-auth-response -tags: ['SDK', 'Software Development Kit', 'TokenAuthResponse'] ---- - - -# TokenAuthResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Status** | Pointer to **Enum** [ "PENDING", "SUCCESS", "FAILED", "LOCKOUT", "NOT_ENOUGH_DATA" ] | MFA Authentication status | [optional] - -## Examples - -- Prepare the resource -```powershell -$TokenAuthResponse = Initialize-PSSailpoint.V3TokenAuthResponse -Status PENDING -``` - -- Convert the resource to JSON -```powershell -$TokenAuthResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Transform.md b/docs/tools/sdk/powershell/reference/v3/Models/Transform.md deleted file mode 100644 index 7f389a09c..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Transform.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: transform -title: Transform -pagination_label: Transform -sidebar_label: Transform -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Transform'] -slug: /tools/sdk/powershell/v3/models/transform -tags: ['SDK', 'Software Development Kit', 'Transform'] ---- - - -# Transform - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | Unique name of this transform | [required] -**Type** | **Enum** [ "accountAttribute", "base64Decode", "base64Encode", "concat", "conditional", "dateCompare", "dateFormat", "dateMath", "decomposeDiacriticalMarks", "e164phone", "firstValid", "rule", "identityAttribute", "indexOf", "iso3166", "lastIndexOf", "leftPad", "lookup", "lower", "normalizeNames", "randomAlphaNumeric", "randomNumeric", "reference", "replaceAll", "replace", "rightPad", "split", "static", "substring", "trim", "upper", "usernameGenerator", "uuid", "displayName", "rfc5646" ] | The type of transform operation | [required] -**Attributes** | [**TransformAttributes**](transform-attributes) | | [required] - -## Examples - -- Prepare the resource -```powershell -$Transform = Initialize-PSSailpoint.V3Transform -Name Timestamp To Date ` - -Type dateFormat ` - -Attributes null -``` - -- Convert the resource to JSON -```powershell -$Transform | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/TransformAttributes.md b/docs/tools/sdk/powershell/reference/v3/Models/TransformAttributes.md deleted file mode 100644 index add7b3ac5..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/TransformAttributes.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -id: transform-attributes -title: TransformAttributes -pagination_label: TransformAttributes -sidebar_label: TransformAttributes -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TransformAttributes'] -slug: /tools/sdk/powershell/v3/models/transform-attributes -tags: ['SDK', 'Software Development Kit', 'TransformAttributes'] ---- - - -# TransformAttributes - -## 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] -**Values** | **String** | This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language. | [required] -**Expression** | **String** | A string value of the date and time components to operation on, along with the math operations to execute. | [required] -**PositiveCondition** | **String** | The output of the transform if the expression evalutes to true | [required] -**NegativeCondition** | **String** | The output of the transform if the expression evalutes to false | [required] -**FirstDate** | [**DateCompareFirstDate**](date-compare-first-date) | | [required] -**SecondDate** | [**DateCompareSecondDate**](date-compare-second-date) | | [required] -**Operator** | **Enum** [ "LT", "LTE", "GT", "GTE" ] | This is the comparison to perform. | Operation | Description | | --------- | ------- | | LT | Strictly less than: `firstDate < secondDate` | | LTE | Less than or equal to: `firstDate <= secondDate` | | GT | Strictly greater than: `firstDate > secondDate` | | GTE | Greater than or equal to: `firstDate >= secondDate` | | [required] -**InputFormat** | Pointer to [**DateFormatInputFormat**](date-format-input-format) | | [optional] -**OutputFormat** | Pointer to [**DateFormatOutputFormat**](date-format-output-format) | | [optional] -**RoundUp** | Pointer to **Boolean** | A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. If not provided, the transform will default to `false` `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) | [optional] [default to $false] -**DefaultRegion** | Pointer to **String** | This is an optional attribute that can be used to define the region of the phone number to format into. If defaultRegion is not provided, it will take US as the default country. The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) | [optional] -**IgnoreErrors** | Pointer to **Boolean** | a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. | [optional] [default to $false] -**Name** | **String** | The system (camel-cased) name of the identity attribute to bring in | [required] -**Operation** | **String** | The operation to perform `getReferenceIdentityAttribute` | [required] -**IncludeNumbers** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include numbers | [required] -**IncludeSpecialChars** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include special characters | [required] -**Length** | **String** | An integer value for the desired length of the final output string | [required] -**Uid** | **String** | This is the SailPoint User Name (uid) value of the identity whose attribute is desired As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. | [required] -**Substring** | **String** | A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring. | [required] -**Format** | Pointer to **String** | An optional value to denote which ISO 3166 format to return. Valid values are: `alpha2` - Two-character country code (e.g., ""US""); this is the default value if no format is supplied `alpha3` - Three-character country code (e.g., ""USA"") `numeric` - The numeric country code (e.g., ""840"") | [optional] -**Padding** | Pointer to **String** | A string value representing the character that the incoming data should be padded with to get to the desired length If not provided, the transform will default to a single space ("" "") character for padding | [optional] -**Table** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value. | [required] -**Id** | **String** | This ID specifies the name of the pre-existing transform which you want to use within your current transform | [required] -**Regex** | **String** | This can be a string or a regex pattern in which you want to replace. | [required] -**Replacement** | **String** | This is the replacement string that should be substituded wherever the string or pattern is found. | [required] -**Delimiter** | **String** | This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data | [required] -**Index** | **String** | An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc. | [required] -**Throws** | Pointer to **Boolean** | A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) `true` - The transform should return ""IndexOutOfBoundsException"" `false` - The transform should return null If not provided, the transform will default to false and return a null | [optional] [default to $false] -**VarBegin** | **Int32** | The index of the first character to include in the returned substring. If `begin` is set to -1, the transform will begin at character 0 of the input data | [required] -**BeginOffset** | Pointer to **Int32** | This integer value is the number of characters to add to the begin attribute when returning a substring. This attribute is only used if begin is not -1. | [optional] -**VarEnd** | Pointer to **Int32** | The index of the first character to exclude from the returned substring. If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. | [optional] -**EndOffset** | Pointer to **Int32** | This integer value is the number of characters to add to the end attribute when returning a substring. This attribute is only used if end is provided and is not -1. | [optional] - -## Examples - -- Prepare the resource -```powershell -$TransformAttributes = Initialize-PSSailpoint.V3TransformAttributes -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}} ` - -Values string$variable ` - -Expression now+1w ` - -PositiveCondition true ` - -NegativeCondition false ` - -FirstDate null ` - -SecondDate null ` - -Operator LT ` - -InputFormat null ` - -OutputFormat null ` - -RoundUp false ` - -DefaultRegion US ` - -IgnoreErrors false ` - -Name email ` - -Operation getReferenceIdentityAttribute ` - -IncludeNumbers true ` - -IncludeSpecialChars true ` - -Length 4 ` - -Uid 2c91808570313110017040b06f344ec9 ` - -Substring admin_ ` - -Format alpha2 ` - -Padding 0 ` - -Table {-= , "=', ñ=n} ` - -Id Existing Transform ` - -Regex [^a-zA-Z] ` - -Replacement ` - -Delimiter , ` - -Index 5 ` - -Throws true ` - -VarBegin 1 ` - -BeginOffset 3 ` - -VarEnd 6 ` - -EndOffset 1 -``` - -- Convert the resource to JSON -```powershell -$TransformAttributes | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/TransformDefinition.md b/docs/tools/sdk/powershell/reference/v3/Models/TransformDefinition.md deleted file mode 100644 index 8c27c20a0..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/TransformDefinition.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: transform-definition -title: TransformDefinition -pagination_label: TransformDefinition -sidebar_label: TransformDefinition -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TransformDefinition'] -slug: /tools/sdk/powershell/v3/models/transform-definition -tags: ['SDK', 'Software Development Kit', 'TransformDefinition'] ---- - - -# TransformDefinition - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **String** | The type of the transform definition. | [optional] -**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Arbitrary key-value pairs to store any metadata for the object | [optional] - -## Examples - -- Prepare the resource -```powershell -$TransformDefinition = Initialize-PSSailpoint.V3TransformDefinition -Type accountAttribute ` - -Attributes {attributeName=e-mail, sourceName=MySource, sourceId=2c9180877a826e68017a8c0b03da1a53} -``` - -- Convert the resource to JSON -```powershell -$TransformDefinition | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/TransformRead.md b/docs/tools/sdk/powershell/reference/v3/Models/TransformRead.md deleted file mode 100644 index 9496624f9..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/TransformRead.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: transform-read -title: TransformRead -pagination_label: TransformRead -sidebar_label: TransformRead -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TransformRead'] -slug: /tools/sdk/powershell/v3/models/transform-read -tags: ['SDK', 'Software Development Kit', 'TransformRead'] ---- - - -# TransformRead - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | Unique name of this transform | [required] -**Type** | **Enum** [ "accountAttribute", "base64Decode", "base64Encode", "concat", "conditional", "dateCompare", "dateFormat", "dateMath", "decomposeDiacriticalMarks", "e164phone", "firstValid", "rule", "identityAttribute", "indexOf", "iso3166", "lastIndexOf", "leftPad", "lookup", "lower", "normalizeNames", "randomAlphaNumeric", "randomNumeric", "reference", "replaceAll", "replace", "rightPad", "split", "static", "substring", "trim", "upper", "usernameGenerator", "uuid", "displayName", "rfc5646" ] | The type of transform operation | [required] -**Attributes** | [**TransformAttributes**](transform-attributes) | | [required] -**Id** | **String** | Unique ID of this transform | [required] -**Internal** | **Boolean** | Indicates whether this is an internal SailPoint-created transform or a customer-created transform | [required][default to $false] - -## Examples - -- Prepare the resource -```powershell -$TransformRead = Initialize-PSSailpoint.V3TransformRead -Name Timestamp To Date ` - -Type dateFormat ` - -Attributes null ` - -Id 2cd78adghjkja34jh2b1hkjhasuecd ` - -Internal false -``` - -- Convert the resource to JSON -```powershell -$TransformRead | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/TransformRule.md b/docs/tools/sdk/powershell/reference/v3/Models/TransformRule.md deleted file mode 100644 index a13f4c22e..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/TransformRule.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: transform-rule -title: TransformRule -pagination_label: TransformRule -sidebar_label: TransformRule -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TransformRule'] -slug: /tools/sdk/powershell/v3/models/transform-rule -tags: ['SDK', 'Software Development Kit', 'TransformRule'] ---- - - -# TransformRule - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | This is the name of the Transform rule that needs to be invoked by the transform | [required] -**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] - -## Examples - -- Prepare the resource -```powershell -$TransformRule = Initialize-PSSailpoint.V3TransformRule -Name Transform Calculation Rule ` - -RequiresPeriodicRefresh false -``` - -- Convert the resource to JSON -```powershell -$TransformRule | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Trim.md b/docs/tools/sdk/powershell/reference/v3/Models/Trim.md deleted file mode 100644 index 7d594150c..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Trim.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: trim -title: Trim -pagination_label: Trim -sidebar_label: Trim -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Trim'] -slug: /tools/sdk/powershell/v3/models/trim -tags: ['SDK', 'Software Development Kit', 'Trim'] ---- - - -# Trim - -## 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 -$Trim = Initialize-PSSailpoint.V3Trim -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$Trim | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/TypeAheadQuery.md b/docs/tools/sdk/powershell/reference/v3/Models/TypeAheadQuery.md deleted file mode 100644 index 6bce7a917..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/TypeAheadQuery.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: type-ahead-query -title: TypeAheadQuery -pagination_label: TypeAheadQuery -sidebar_label: TypeAheadQuery -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TypeAheadQuery'] -slug: /tools/sdk/powershell/v3/models/type-ahead-query -tags: ['SDK', 'Software Development Kit', 'TypeAheadQuery'] ---- - - -# TypeAheadQuery - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Query** | **String** | The type ahead query string used to construct a phrase prefix match query. | [required] -**Field** | **String** | The field on which to perform the type ahead search. | [required] -**NestedType** | Pointer to **String** | The nested type. | [optional] -**MaxExpansions** | Pointer to **Int32** | The number of suffixes the last term will be expanded into. Influences the performance of the query and the number results returned. Valid values: 1 to 1000. | [optional] [default to 10] -**Size** | Pointer to **Int32** | The max amount of records the search will return. | [optional] [default to 100] -**Sort** | Pointer to **String** | The sort order of the returned records. | [optional] [default to "desc"] -**SortByValue** | Pointer to **Boolean** | The flag that defines the sort type, by count or value. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$TypeAheadQuery = Initialize-PSSailpoint.V3TypeAheadQuery -Query Work ` - -Field source.name ` - -NestedType access ` - -MaxExpansions 10 ` - -Size 100 ` - -Sort asc ` - -SortByValue true -``` - -- Convert the resource to JSON -```powershell -$TypeAheadQuery | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/TypedReference.md b/docs/tools/sdk/powershell/reference/v3/Models/TypedReference.md deleted file mode 100644 index 9ed053913..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/TypedReference.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: typed-reference -title: TypedReference -pagination_label: TypedReference -sidebar_label: TypedReference -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TypedReference'] -slug: /tools/sdk/powershell/v3/models/typed-reference -tags: ['SDK', 'Software Development Kit', 'TypedReference'] ---- - - -# TypedReference - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | [**DtoType**](dto-type) | | [required] -**Id** | **String** | The id of the object. | [required] - -## Examples - -- Prepare the resource -```powershell -$TypedReference = Initialize-PSSailpoint.V3TypedReference -Type null ` - -Id 2c91808568c529c60168cca6f90c1313 -``` - -- Convert the resource to JSON -```powershell -$TypedReference | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/UUIDGenerator.md b/docs/tools/sdk/powershell/reference/v3/Models/UUIDGenerator.md deleted file mode 100644 index 0ab402168..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/UUIDGenerator.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: uuid-generator -title: UUIDGenerator -pagination_label: UUIDGenerator -sidebar_label: UUIDGenerator -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'UUIDGenerator'] -slug: /tools/sdk/powershell/v3/models/uuid-generator -tags: ['SDK', 'Software Development Kit', 'UUIDGenerator'] ---- - - -# UUIDGenerator - -## 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] - -## Examples - -- Prepare the resource -```powershell -$UUIDGenerator = Initialize-PSSailpoint.V3UUIDGenerator -RequiresPeriodicRefresh false -``` - -- Convert the resource to JSON -```powershell -$UUIDGenerator | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/UncorrelatedAccountsReportArguments.md b/docs/tools/sdk/powershell/reference/v3/Models/UncorrelatedAccountsReportArguments.md deleted file mode 100644 index 224c9c154..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/UncorrelatedAccountsReportArguments.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: uncorrelated-accounts-report-arguments -title: UncorrelatedAccountsReportArguments -pagination_label: UncorrelatedAccountsReportArguments -sidebar_label: UncorrelatedAccountsReportArguments -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'UncorrelatedAccountsReportArguments'] -slug: /tools/sdk/powershell/v3/models/uncorrelated-accounts-report-arguments -tags: ['SDK', 'Software Development Kit', 'UncorrelatedAccountsReportArguments'] ---- - - -# UncorrelatedAccountsReportArguments - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**SelectedFormats** | Pointer to **[]String** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] - -## Examples - -- Prepare the resource -```powershell -$UncorrelatedAccountsReportArguments = Initialize-PSSailpoint.V3UncorrelatedAccountsReportArguments -SelectedFormats [CSV] -``` - -- Convert the resource to JSON -```powershell -$UncorrelatedAccountsReportArguments | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/UpdateDetail.md b/docs/tools/sdk/powershell/reference/v3/Models/UpdateDetail.md deleted file mode 100644 index 2df42e3dc..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/UpdateDetail.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: update-detail -title: UpdateDetail -pagination_label: UpdateDetail -sidebar_label: UpdateDetail -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'UpdateDetail'] -slug: /tools/sdk/powershell/v3/models/update-detail -tags: ['SDK', 'Software Development Kit', 'UpdateDetail'] ---- - - -# UpdateDetail - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Message** | Pointer to **String** | The detailed message for an update. Typically the relevent error message when status is error. | [optional] -**ScriptName** | Pointer to **String** | The connector script name | [optional] -**UpdatedFiles** | Pointer to **[]String** | The list of updated files supported by the connector | [optional] -**Status** | Pointer to **Enum** [ "ERROR", "UPDATED", "UNCHANGED", "SKIPPED" ] | The connector update status | [optional] - -## Examples - -- Prepare the resource -```powershell -$UpdateDetail = Initialize-PSSailpoint.V3UpdateDetail -Message unsupported xsd version, please ensure latest xsd version http://www.sailpoint.com/xsd/sailpoint_form_2_0.xsd is used for source config ` - -ScriptName servicenow ` - -UpdatedFiles [pod/org/connectorFiles/testconnector/test1.jar] ` - -Status ERROR -``` - -- Convert the resource to JSON -```powershell -$UpdateDetail | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Upper.md b/docs/tools/sdk/powershell/reference/v3/Models/Upper.md deleted file mode 100644 index b41d644d0..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Upper.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: upper -title: Upper -pagination_label: Upper -sidebar_label: Upper -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Upper'] -slug: /tools/sdk/powershell/v3/models/upper -tags: ['SDK', 'Software Development Kit', 'Upper'] ---- - - -# Upper - -## 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 -$Upper = Initialize-PSSailpoint.V3Upper -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$Upper | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/UsageType.md b/docs/tools/sdk/powershell/reference/v3/Models/UsageType.md deleted file mode 100644 index a0040e0dc..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/UsageType.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -id: usage-type -title: UsageType -pagination_label: UsageType -sidebar_label: UsageType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'UsageType'] -slug: /tools/sdk/powershell/v3/models/usage-type -tags: ['SDK', 'Software Development Kit', 'UsageType'] ---- - - -# UsageType - -## Enum - - -* `CREATE` (value: `"CREATE"`) - -* `UPDATE` (value: `"UPDATE"`) - -* `ENABLE` (value: `"ENABLE"`) - -* `DISABLE` (value: `"DISABLE"`) - -* `DELETE` (value: `"DELETE"`) - -* `ASSIGN` (value: `"ASSIGN"`) - -* `UNASSIGN` (value: `"UNASSIGN"`) - -* `CREATE_GROUP` (value: `"CREATE_GROUP"`) - -* `UPDATE_GROUP` (value: `"UPDATE_GROUP"`) - -* `DELETE_GROUP` (value: `"DELETE_GROUP"`) - -* `REGISTER` (value: `"REGISTER"`) - -* `CREATE_IDENTITY` (value: `"CREATE_IDENTITY"`) - -* `UPDATE_IDENTITY` (value: `"UPDATE_IDENTITY"`) - -* `EDIT_GROUP` (value: `"EDIT_GROUP"`) - -* `UNLOCK` (value: `"UNLOCK"`) - -* `CHANGE_PASSWORD` (value: `"CHANGE_PASSWORD"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/V3ConnectorDto.md b/docs/tools/sdk/powershell/reference/v3/Models/V3ConnectorDto.md deleted file mode 100644 index c8bd25060..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/V3ConnectorDto.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: v3-connector-dto -title: V3ConnectorDto -pagination_label: V3ConnectorDto -sidebar_label: V3ConnectorDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'V3ConnectorDto'] -slug: /tools/sdk/powershell/v3/models/v3-connector-dto -tags: ['SDK', 'Software Development Kit', 'V3ConnectorDto'] ---- - - -# V3ConnectorDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | The connector name | [optional] -**Type** | Pointer to **String** | The connector type | [optional] -**ScriptName** | Pointer to **String** | The connector script name | [optional] -**ClassName** | Pointer to **String** | The connector class name. | [optional] -**Features** | Pointer to **[]String** | The list of features supported by the connector | [optional] -**DirectConnect** | Pointer to **Boolean** | true if the source is a direct connect source | [optional] [default to $false] -**ConnectorMetadata** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A map containing metadata pertinent to the connector | [optional] -**Status** | Pointer to **Enum** [ "DEPRECATED", "DEVELOPMENT", "DEMO", "RELEASED" ] | The connector status | [optional] - -## Examples - -- Prepare the resource -```powershell -$V3ConnectorDto = Initialize-PSSailpoint.V3V3ConnectorDto -Name name ` - -Type ServiceNow ` - -ScriptName servicenow ` - -ClassName sailpoint.connector.OpenConnectorAdapter ` - -Features [PROVISIONING, SYNC_PROVISIONING, SEARCH, UNSTRUCTURED_TARGETS] ` - -DirectConnect true ` - -ConnectorMetadata {supportedUI=ANGULAR, platform=ccg, shortDesc=connector description} ` - -Status RELEASED -``` - -- Convert the resource to JSON -```powershell -$V3ConnectorDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/V3CreateConnectorDto.md b/docs/tools/sdk/powershell/reference/v3/Models/V3CreateConnectorDto.md deleted file mode 100644 index 5924b08e2..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/V3CreateConnectorDto.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: v3-create-connector-dto -title: V3CreateConnectorDto -pagination_label: V3CreateConnectorDto -sidebar_label: V3CreateConnectorDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'V3CreateConnectorDto'] -slug: /tools/sdk/powershell/v3/models/v3-create-connector-dto -tags: ['SDK', 'Software Development Kit', 'V3CreateConnectorDto'] ---- - - -# V3CreateConnectorDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | The connector name. Need to be unique per tenant. The name will able be used to derive a url friendly unique scriptname that will be in response. Script name can then be used for all update endpoints | [required] -**Type** | Pointer to **String** | The connector type. If not specified will be defaulted to 'custom '+name | [optional] -**ClassName** | **String** | The connector class name. If you are implementing openconnector standard (what is recommended), then this need to be set to sailpoint.connector.OpenConnectorAdapter | [required] -**DirectConnect** | Pointer to **Boolean** | true if the source is a direct connect source | [optional] [default to $true] -**Status** | Pointer to **Enum** [ "DEVELOPMENT", "DEMO", "RELEASED" ] | The connector status | [optional] - -## Examples - -- Prepare the resource -```powershell -$V3CreateConnectorDto = Initialize-PSSailpoint.V3V3CreateConnectorDto -Name custom connector ` - -Type custom connector type ` - -ClassName sailpoint.connector.OpenConnectorAdapter ` - -DirectConnect true ` - -Status RELEASED -``` - -- Convert the resource to JSON -```powershell -$V3CreateConnectorDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Value.md b/docs/tools/sdk/powershell/reference/v3/Models/Value.md deleted file mode 100644 index 4270e1742..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Value.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: value -title: Value -pagination_label: Value -sidebar_label: Value -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Value'] -slug: /tools/sdk/powershell/v3/models/value -tags: ['SDK', 'Software Development Kit', 'Value'] ---- - - -# Value - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **String** | The type of attribute value | [optional] -**Value** | Pointer to **String** | The attribute value | [optional] - -## Examples - -- Prepare the resource -```powershell -$Value = Initialize-PSSailpoint.V3Value -Type STRING ` - -Value Austin -``` - -- Convert the resource to JSON -```powershell -$Value | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/VendorConnectorMapping.md b/docs/tools/sdk/powershell/reference/v3/Models/VendorConnectorMapping.md deleted file mode 100644 index c42cbeaab..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/VendorConnectorMapping.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: vendor-connector-mapping -title: VendorConnectorMapping -pagination_label: VendorConnectorMapping -sidebar_label: VendorConnectorMapping -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMapping'] -slug: /tools/sdk/powershell/v3/models/vendor-connector-mapping -tags: ['SDK', 'Software Development Kit', 'VendorConnectorMapping'] ---- - - -# VendorConnectorMapping - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The unique identifier for the vendor-connector mapping. | [optional] -**Vendor** | Pointer to **String** | The name of the vendor. | [optional] -**Connector** | Pointer to **String** | The name of the connector. | [optional] -**CreatedAt** | Pointer to **System.DateTime** | The creation timestamp of the mapping. | [optional] -**CreatedBy** | Pointer to **String** | The identifier of the user who created the mapping. | [optional] -**UpdatedAt** | Pointer to [**VendorConnectorMappingUpdatedAt**](vendor-connector-mapping-updated-at) | | [optional] -**UpdatedBy** | Pointer to [**VendorConnectorMappingUpdatedBy**](vendor-connector-mapping-updated-by) | | [optional] -**DeletedAt** | Pointer to [**VendorConnectorMappingDeletedAt**](vendor-connector-mapping-deleted-at) | | [optional] -**DeletedBy** | Pointer to [**VendorConnectorMappingDeletedBy**](vendor-connector-mapping-deleted-by) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$VendorConnectorMapping = Initialize-PSSailpoint.V3VendorConnectorMapping -Id 78733556-9ea3-4f59-bf69-e5cd92b011b4 ` - -Vendor Example vendor ` - -Connector Example connector ` - -CreatedAt 2024-03-13T12:56:19.391294Z ` - -CreatedBy admin ` - -UpdatedAt null ` - -UpdatedBy null ` - -DeletedAt null ` - -DeletedBy null -``` - -- Convert the resource to JSON -```powershell -$VendorConnectorMapping | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/VendorConnectorMappingDeletedAt.md b/docs/tools/sdk/powershell/reference/v3/Models/VendorConnectorMappingDeletedAt.md deleted file mode 100644 index b6fa6c39c..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/VendorConnectorMappingDeletedAt.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: vendor-connector-mapping-deleted-at -title: VendorConnectorMappingDeletedAt -pagination_label: VendorConnectorMappingDeletedAt -sidebar_label: VendorConnectorMappingDeletedAt -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMappingDeletedAt'] -slug: /tools/sdk/powershell/v3/models/vendor-connector-mapping-deleted-at -tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingDeletedAt'] ---- - - -# VendorConnectorMappingDeletedAt - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Time** | Pointer to **System.DateTime** | The timestamp when the mapping was deleted, represented in ISO 8601 format, if applicable. | [optional] -**Valid** | Pointer to **Boolean** | A flag indicating if the 'Time' field is set and valid, i.e., if the mapping has been deleted. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$VendorConnectorMappingDeletedAt = Initialize-PSSailpoint.V3VendorConnectorMappingDeletedAt -Time 0001-01-01T00:00Z ` - -Valid false -``` - -- Convert the resource to JSON -```powershell -$VendorConnectorMappingDeletedAt | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/VendorConnectorMappingDeletedBy.md b/docs/tools/sdk/powershell/reference/v3/Models/VendorConnectorMappingDeletedBy.md deleted file mode 100644 index 9302376f3..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/VendorConnectorMappingDeletedBy.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: vendor-connector-mapping-deleted-by -title: VendorConnectorMappingDeletedBy -pagination_label: VendorConnectorMappingDeletedBy -sidebar_label: VendorConnectorMappingDeletedBy -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMappingDeletedBy'] -slug: /tools/sdk/powershell/v3/models/vendor-connector-mapping-deleted-by -tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingDeletedBy'] ---- - - -# VendorConnectorMappingDeletedBy - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**String** | Pointer to **String** | The identifier of the user who deleted the mapping, if applicable. | [optional] -**Valid** | Pointer to **Boolean** | A flag indicating if the 'String' field is set and valid, i.e., if the mapping has been deleted. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$VendorConnectorMappingDeletedBy = Initialize-PSSailpoint.V3VendorConnectorMappingDeletedBy -String ` - -Valid false -``` - -- Convert the resource to JSON -```powershell -$VendorConnectorMappingDeletedBy | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/VendorConnectorMappingUpdatedAt.md b/docs/tools/sdk/powershell/reference/v3/Models/VendorConnectorMappingUpdatedAt.md deleted file mode 100644 index 3a2d4f58a..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/VendorConnectorMappingUpdatedAt.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: vendor-connector-mapping-updated-at -title: VendorConnectorMappingUpdatedAt -pagination_label: VendorConnectorMappingUpdatedAt -sidebar_label: VendorConnectorMappingUpdatedAt -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMappingUpdatedAt'] -slug: /tools/sdk/powershell/v3/models/vendor-connector-mapping-updated-at -tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingUpdatedAt'] ---- - - -# VendorConnectorMappingUpdatedAt - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Time** | Pointer to **System.DateTime** | The timestamp when the mapping was last updated, represented in ISO 8601 format. | [optional] -**Valid** | Pointer to **Boolean** | A flag indicating if the 'Time' field is set and valid. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$VendorConnectorMappingUpdatedAt = Initialize-PSSailpoint.V3VendorConnectorMappingUpdatedAt -Time 2024-03-14T12:56:19.391294Z ` - -Valid true -``` - -- Convert the resource to JSON -```powershell -$VendorConnectorMappingUpdatedAt | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/VendorConnectorMappingUpdatedBy.md b/docs/tools/sdk/powershell/reference/v3/Models/VendorConnectorMappingUpdatedBy.md deleted file mode 100644 index c6cea8430..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/VendorConnectorMappingUpdatedBy.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: vendor-connector-mapping-updated-by -title: VendorConnectorMappingUpdatedBy -pagination_label: VendorConnectorMappingUpdatedBy -sidebar_label: VendorConnectorMappingUpdatedBy -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMappingUpdatedBy'] -slug: /tools/sdk/powershell/v3/models/vendor-connector-mapping-updated-by -tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingUpdatedBy'] ---- - - -# VendorConnectorMappingUpdatedBy - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**String** | Pointer to **String** | The identifier of the user who last updated the mapping, if available. | [optional] -**Valid** | Pointer to **Boolean** | A flag indicating if the 'String' field is set and valid. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$VendorConnectorMappingUpdatedBy = Initialize-PSSailpoint.V3VendorConnectorMappingUpdatedBy -String user-67891 ` - -Valid true -``` - -- Convert the resource to JSON -```powershell -$VendorConnectorMappingUpdatedBy | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/VerificationPollRequest.md b/docs/tools/sdk/powershell/reference/v3/Models/VerificationPollRequest.md deleted file mode 100644 index 68134090c..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/VerificationPollRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: verification-poll-request -title: VerificationPollRequest -pagination_label: VerificationPollRequest -sidebar_label: VerificationPollRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'VerificationPollRequest'] -slug: /tools/sdk/powershell/v3/models/verification-poll-request -tags: ['SDK', 'Software Development Kit', 'VerificationPollRequest'] ---- - - -# VerificationPollRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RequestId** | **String** | Verification request Id | [required] - -## Examples - -- Prepare the resource -```powershell -$VerificationPollRequest = Initialize-PSSailpoint.V3VerificationPollRequest -RequestId 089899f13a8f4da7824996191587bab9 -``` - -- Convert the resource to JSON -```powershell -$VerificationPollRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/VerificationResponse.md b/docs/tools/sdk/powershell/reference/v3/Models/VerificationResponse.md deleted file mode 100644 index 229a1553d..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/VerificationResponse.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: verification-response -title: VerificationResponse -pagination_label: VerificationResponse -sidebar_label: VerificationResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'VerificationResponse'] -slug: /tools/sdk/powershell/v3/models/verification-response -tags: ['SDK', 'Software Development Kit', 'VerificationResponse'] ---- - - -# VerificationResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RequestId** | Pointer to **String** | The verificationPollRequest request ID | [optional] -**Status** | Pointer to **Enum** [ "PENDING", "SUCCESS", "FAILED", "LOCKOUT", "NOT_ENOUGH_DATA" ] | MFA Authentication status | [optional] -**VarError** | Pointer to **String** | Error messages from MFA verification request | [optional] - -## Examples - -- Prepare the resource -```powershell -$VerificationResponse = Initialize-PSSailpoint.V3VerificationResponse -RequestId 089899f13a8f4da7824996191587bab9 ` - -Status SUCCESS ` - -VarError Unable to connect DUO Service during verification -``` - -- Convert the resource to JSON -```powershell -$VerificationResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ViolationContext.md b/docs/tools/sdk/powershell/reference/v3/Models/ViolationContext.md deleted file mode 100644 index 4dfc29ec0..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ViolationContext.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: violation-context -title: ViolationContext -pagination_label: ViolationContext -sidebar_label: ViolationContext -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ViolationContext'] -slug: /tools/sdk/powershell/v3/models/violation-context -tags: ['SDK', 'Software Development Kit', 'ViolationContext'] ---- - - -# ViolationContext - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Policy** | Pointer to [**ViolationContextPolicy**](violation-context-policy) | | [optional] -**ConflictingAccessCriteria** | Pointer to [**ExceptionAccessCriteria**](exception-access-criteria) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ViolationContext = Initialize-PSSailpoint.V3ViolationContext -Policy null ` - -ConflictingAccessCriteria null -``` - -- Convert the resource to JSON -```powershell -$ViolationContext | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ViolationContextPolicy.md b/docs/tools/sdk/powershell/reference/v3/Models/ViolationContextPolicy.md deleted file mode 100644 index 82925e545..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ViolationContextPolicy.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: violation-context-policy -title: ViolationContextPolicy -pagination_label: ViolationContextPolicy -sidebar_label: ViolationContextPolicy -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ViolationContextPolicy'] -slug: /tools/sdk/powershell/v3/models/violation-context-policy -tags: ['SDK', 'Software Development Kit', 'ViolationContextPolicy'] ---- - - -# ViolationContextPolicy - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | The type of object that is referenced | [optional] -**Id** | Pointer to **String** | SOD policy ID. | [optional] -**Name** | Pointer to **String** | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ViolationContextPolicy = Initialize-PSSailpoint.V3ViolationContextPolicy -Type ENTITLEMENT ` - -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` - -Name A very cool policy name -``` - -- Convert the resource to JSON -```powershell -$ViolationContextPolicy | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ViolationOwnerAssignmentConfig.md b/docs/tools/sdk/powershell/reference/v3/Models/ViolationOwnerAssignmentConfig.md deleted file mode 100644 index db089ec62..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ViolationOwnerAssignmentConfig.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: violation-owner-assignment-config -title: ViolationOwnerAssignmentConfig -pagination_label: ViolationOwnerAssignmentConfig -sidebar_label: ViolationOwnerAssignmentConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ViolationOwnerAssignmentConfig'] -slug: /tools/sdk/powershell/v3/models/violation-owner-assignment-config -tags: ['SDK', 'Software Development Kit', 'ViolationOwnerAssignmentConfig'] ---- - - -# ViolationOwnerAssignmentConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AssignmentRule** | Pointer to **Enum** [ "MANAGER", "STATIC" ] | Details about the violations owner. MANAGER - identity's manager STATIC - Governance Group or Identity | [optional] -**OwnerRef** | Pointer to [**ViolationOwnerAssignmentConfigOwnerRef**](violation-owner-assignment-config-owner-ref) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ViolationOwnerAssignmentConfig = Initialize-PSSailpoint.V3ViolationOwnerAssignmentConfig -AssignmentRule MANAGER ` - -OwnerRef null -``` - -- Convert the resource to JSON -```powershell -$ViolationOwnerAssignmentConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ViolationOwnerAssignmentConfigOwnerRef.md b/docs/tools/sdk/powershell/reference/v3/Models/ViolationOwnerAssignmentConfigOwnerRef.md deleted file mode 100644 index 7882334d0..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ViolationOwnerAssignmentConfigOwnerRef.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: violation-owner-assignment-config-owner-ref -title: ViolationOwnerAssignmentConfigOwnerRef -pagination_label: ViolationOwnerAssignmentConfigOwnerRef -sidebar_label: ViolationOwnerAssignmentConfigOwnerRef -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ViolationOwnerAssignmentConfigOwnerRef'] -slug: /tools/sdk/powershell/v3/models/violation-owner-assignment-config-owner-ref -tags: ['SDK', 'Software Development Kit', 'ViolationOwnerAssignmentConfigOwnerRef'] ---- - - -# ViolationOwnerAssignmentConfigOwnerRef - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY", "GOVERNANCE_GROUP", "MANAGER" ] | Owner type. | [optional] -**Id** | Pointer to **String** | Owner's ID. | [optional] -**Name** | Pointer to **String** | Owner's name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ViolationOwnerAssignmentConfigOwnerRef = Initialize-PSSailpoint.V3ViolationOwnerAssignmentConfigOwnerRef -Type IDENTITY ` - -Id 2c9180a46faadee4016fb4e018c20639 ` - -Name Support -``` - -- Convert the resource to JSON -```powershell -$ViolationOwnerAssignmentConfigOwnerRef | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/ViolationPrediction.md b/docs/tools/sdk/powershell/reference/v3/Models/ViolationPrediction.md deleted file mode 100644 index f07a02414..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/ViolationPrediction.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: violation-prediction -title: ViolationPrediction -pagination_label: ViolationPrediction -sidebar_label: ViolationPrediction -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ViolationPrediction'] -slug: /tools/sdk/powershell/v3/models/violation-prediction -tags: ['SDK', 'Software Development Kit', 'ViolationPrediction'] ---- - - -# ViolationPrediction - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ViolationContexts** | Pointer to [**[]ViolationContext**](violation-context) | List of Violation Contexts | [optional] - -## Examples - -- Prepare the resource -```powershell -$ViolationPrediction = Initialize-PSSailpoint.V3ViolationPrediction -ViolationContexts null -``` - -- Convert the resource to JSON -```powershell -$ViolationPrediction | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/VisibilityCriteria.md b/docs/tools/sdk/powershell/reference/v3/Models/VisibilityCriteria.md deleted file mode 100644 index 13e8ef229..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/VisibilityCriteria.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: visibility-criteria -title: VisibilityCriteria -pagination_label: VisibilityCriteria -sidebar_label: VisibilityCriteria -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'VisibilityCriteria'] -slug: /tools/sdk/powershell/v3/models/visibility-criteria -tags: ['SDK', 'Software Development Kit', 'VisibilityCriteria'] ---- - - -# VisibilityCriteria - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Expression** | Pointer to [**Expression**](expression) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$VisibilityCriteria = Initialize-PSSailpoint.V3VisibilityCriteria -Expression null -``` - -- Convert the resource to JSON -```powershell -$VisibilityCriteria | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/WorkItemForward.md b/docs/tools/sdk/powershell/reference/v3/Models/WorkItemForward.md deleted file mode 100644 index 9e90898d6..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/WorkItemForward.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: work-item-forward -title: WorkItemForward -pagination_label: WorkItemForward -sidebar_label: WorkItemForward -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemForward'] -slug: /tools/sdk/powershell/v3/models/work-item-forward -tags: ['SDK', 'Software Development Kit', 'WorkItemForward'] ---- - - -# WorkItemForward - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**TargetOwnerId** | **String** | The ID of the identity to forward this work item to. | [required] -**Comment** | **String** | Comments to send to the target owner | [required] -**SendNotifications** | Pointer to **Boolean** | If true, send a notification to the target owner. | [optional] [default to $true] - -## Examples - -- Prepare the resource -```powershell -$WorkItemForward = Initialize-PSSailpoint.V3WorkItemForward -TargetOwnerId 2c9180835d2e5168015d32f890ca1581 ` - -Comment I'm going on vacation. ` - -SendNotifications true -``` - -- Convert the resource to JSON -```powershell -$WorkItemForward | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/WorkItemState.md b/docs/tools/sdk/powershell/reference/v3/Models/WorkItemState.md deleted file mode 100644 index 64a5193d4..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/WorkItemState.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -id: work-item-state -title: WorkItemState -pagination_label: WorkItemState -sidebar_label: WorkItemState -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemState'] -slug: /tools/sdk/powershell/v3/models/work-item-state -tags: ['SDK', 'Software Development Kit', 'WorkItemState'] ---- - - -# WorkItemState - -## Enum - - -* `Finished` (value: `"Finished"`) - -* `Rejected` (value: `"Rejected"`) - -* `Returned` (value: `"Returned"`) - -* `Expired` (value: `"Expired"`) - -* `Pending` (value: `"Pending"`) - -* `Canceled` (value: `"Canceled"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/WorkItemStateManualWorkItems.md b/docs/tools/sdk/powershell/reference/v3/Models/WorkItemStateManualWorkItems.md deleted file mode 100644 index 25f4fa0a7..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/WorkItemStateManualWorkItems.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -id: work-item-state-manual-work-items -title: WorkItemStateManualWorkItems -pagination_label: WorkItemStateManualWorkItems -sidebar_label: WorkItemStateManualWorkItems -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemStateManualWorkItems'] -slug: /tools/sdk/powershell/v3/models/work-item-state-manual-work-items -tags: ['SDK', 'Software Development Kit', 'WorkItemStateManualWorkItems'] ---- - - -# WorkItemStateManualWorkItems - -## Enum - - -* `Finished` (value: `"Finished"`) - -* `Rejected` (value: `"Rejected"`) - -* `Returned` (value: `"Returned"`) - -* `Expired` (value: `"Expired"`) - -* `Pending` (value: `"Pending"`) - -* `Canceled` (value: `"Canceled"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/WorkItemTypeManualWorkItems.md b/docs/tools/sdk/powershell/reference/v3/Models/WorkItemTypeManualWorkItems.md deleted file mode 100644 index 4d785e382..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/WorkItemTypeManualWorkItems.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -id: work-item-type-manual-work-items -title: WorkItemTypeManualWorkItems -pagination_label: WorkItemTypeManualWorkItems -sidebar_label: WorkItemTypeManualWorkItems -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemTypeManualWorkItems'] -slug: /tools/sdk/powershell/v3/models/work-item-type-manual-work-items -tags: ['SDK', 'Software Development Kit', 'WorkItemTypeManualWorkItems'] ---- - - -# WorkItemTypeManualWorkItems - -## Enum - - -* `Generic` (value: `"Generic"`) - -* `Certification` (value: `"Certification"`) - -* `Remediation` (value: `"Remediation"`) - -* `Delegation` (value: `"Delegation"`) - -* `Approval` (value: `"Approval"`) - -* `ViolationReview` (value: `"ViolationReview"`) - -* `Form` (value: `"Form"`) - -* `PolicyVioloation` (value: `"PolicyVioloation"`) - -* `Challenge` (value: `"Challenge"`) - -* `ImpactAnalysis` (value: `"ImpactAnalysis"`) - -* `Signoff` (value: `"Signoff"`) - -* `Event` (value: `"Event"`) - -* `ManualAction` (value: `"ManualAction"`) - -* `Test` (value: `"Test"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/WorkItems.md b/docs/tools/sdk/powershell/reference/v3/Models/WorkItems.md deleted file mode 100644 index cb88e9217..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/WorkItems.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -id: work-items -title: WorkItems -pagination_label: WorkItems -sidebar_label: WorkItems -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItems'] -slug: /tools/sdk/powershell/v3/models/work-items -tags: ['SDK', 'Software Development Kit', 'WorkItems'] ---- - - -# WorkItems - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | ID of the work item | [optional] -**RequesterId** | Pointer to **String** | ID of the requester | [optional] -**RequesterDisplayName** | Pointer to **String** | The displayname of the requester | [optional] -**OwnerId** | Pointer to **String** | The ID of the owner | [optional] -**OwnerName** | Pointer to **String** | The name of the owner | [optional] -**Created** | Pointer to **System.DateTime** | Time when the work item was created | [optional] -**Modified** | Pointer to **System.DateTime** | Time when the work item was last updated | [optional] -**Description** | Pointer to **String** | The description of the work item | [optional] -**State** | Pointer to [**WorkItemStateManualWorkItems**](work-item-state-manual-work-items) | | [optional] -**Type** | Pointer to [**WorkItemTypeManualWorkItems**](work-item-type-manual-work-items) | | [optional] -**RemediationItems** | Pointer to [**[]RemediationItemDetails**](remediation-item-details) | A list of remediation items | [optional] -**ApprovalItems** | Pointer to [**[]ApprovalItemDetails**](approval-item-details) | A list of items that need to be approved | [optional] -**Name** | Pointer to **String** | The work item name | [optional] -**Completed** | Pointer to **System.DateTime** | The time at which the work item completed | [optional] -**NumItems** | Pointer to **Int32** | The number of items in the work item | [optional] -**Form** | Pointer to [**WorkItemsForm**](work-items-form) | | [optional] -**Errors** | Pointer to **[]String** | An array of errors that ocurred during the work item | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkItems = Initialize-PSSailpoint.V3WorkItems -Id 2c9180835d2e5168015d32f890ca1581 ` - -RequesterId 2c9180835d2e5168015d32f890ca1581 ` - -RequesterDisplayName John Smith ` - -OwnerId 2c9180835d2e5168015d32f890ca1581 ` - -OwnerName Jason Smith ` - -Created 2017-07-11T18:45:37.098Z ` - -Modified 2018-06-25T20:22:28.104Z ` - -Description Create account on source 'AD' ` - -State null ` - -Type null ` - -RemediationItems null ` - -ApprovalItems null ` - -Name Account Create ` - -Completed 2018-10-19T13:49:37.385Z ` - -NumItems 19 ` - -Form null ` - -Errors [The work item ID that was specified was not found.] -``` - -- Convert the resource to JSON -```powershell -$WorkItems | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/WorkItemsCount.md b/docs/tools/sdk/powershell/reference/v3/Models/WorkItemsCount.md deleted file mode 100644 index 256783443..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/WorkItemsCount.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: work-items-count -title: WorkItemsCount -pagination_label: WorkItemsCount -sidebar_label: WorkItemsCount -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemsCount'] -slug: /tools/sdk/powershell/v3/models/work-items-count -tags: ['SDK', 'Software Development Kit', 'WorkItemsCount'] ---- - - -# WorkItemsCount - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Count** | Pointer to **Int32** | The count of work items | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkItemsCount = Initialize-PSSailpoint.V3WorkItemsCount -Count 29 -``` - -- Convert the resource to JSON -```powershell -$WorkItemsCount | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/WorkItemsForm.md b/docs/tools/sdk/powershell/reference/v3/Models/WorkItemsForm.md deleted file mode 100644 index b46959e63..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/WorkItemsForm.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: work-items-form -title: WorkItemsForm -pagination_label: WorkItemsForm -sidebar_label: WorkItemsForm -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemsForm'] -slug: /tools/sdk/powershell/v3/models/work-items-form -tags: ['SDK', 'Software Development Kit', 'WorkItemsForm'] ---- - - -# WorkItemsForm - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | ID of the form | [optional] -**Name** | Pointer to **String** | Name of the form | [optional] -**Title** | Pointer to **String** | The form title | [optional] -**Subtitle** | Pointer to **String** | The form subtitle. | [optional] -**TargetUser** | Pointer to **String** | The name of the user that should be shown this form | [optional] -**Sections** | Pointer to [**[]SectionDetails**](section-details) | Sections of the form | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkItemsForm = Initialize-PSSailpoint.V3WorkItemsForm -Id 2c9180835d2e5168015d32f890ca1581 ` - -Name AccountSelection Form ` - -Title Account Selection for John.Doe ` - -Subtitle Please select from the following ` - -TargetUser Jane.Doe ` - -Sections null -``` - -- Convert the resource to JSON -```powershell -$WorkItemsForm | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/WorkItemsSummary.md b/docs/tools/sdk/powershell/reference/v3/Models/WorkItemsSummary.md deleted file mode 100644 index 8e87f1932..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/WorkItemsSummary.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: work-items-summary -title: WorkItemsSummary -pagination_label: WorkItemsSummary -sidebar_label: WorkItemsSummary -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemsSummary'] -slug: /tools/sdk/powershell/v3/models/work-items-summary -tags: ['SDK', 'Software Development Kit', 'WorkItemsSummary'] ---- - - -# WorkItemsSummary - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Open** | Pointer to **Int32** | The count of open work items | [optional] -**Completed** | Pointer to **Int32** | The count of completed work items | [optional] -**Total** | Pointer to **Int32** | The count of total work items | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkItemsSummary = Initialize-PSSailpoint.V3WorkItemsSummary -Open 29 ` - -Completed 1 ` - -Total 30 -``` - -- Convert the resource to JSON -```powershell -$WorkItemsSummary | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/Workflow.md b/docs/tools/sdk/powershell/reference/v3/Models/Workflow.md deleted file mode 100644 index 20f0859a9..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/Workflow.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -id: workflow -title: Workflow -pagination_label: Workflow -sidebar_label: Workflow -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Workflow'] -slug: /tools/sdk/powershell/v3/models/workflow -tags: ['SDK', 'Software Development Kit', 'Workflow'] ---- - - -# Workflow - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | The name of the workflow | [optional] -**Owner** | Pointer to [**WorkflowBodyOwner**](workflow-body-owner) | | [optional] -**Description** | Pointer to **String** | Description of what the workflow accomplishes | [optional] -**Definition** | Pointer to [**WorkflowDefinition**](workflow-definition) | | [optional] -**Enabled** | Pointer to **Boolean** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to $false] -**Trigger** | Pointer to [**WorkflowTrigger**](workflow-trigger) | | [optional] -**Id** | Pointer to **String** | Workflow ID. This is a UUID generated upon creation. | [optional] -**ExecutionCount** | Pointer to **Int32** | The number of times this workflow has been executed. | [optional] -**FailureCount** | Pointer to **Int32** | The number of times this workflow has failed during execution. | [optional] -**Created** | Pointer to **System.DateTime** | The date and time the workflow was created. | [optional] -**Modified** | Pointer to **System.DateTime** | The date and time the workflow was modified. | [optional] -**ModifiedBy** | Pointer to [**WorkflowModifiedBy**](workflow-modified-by) | | [optional] -**Creator** | Pointer to [**WorkflowAllOfCreator**](workflow-all-of-creator) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$Workflow = Initialize-PSSailpoint.V3Workflow -Name Send Email ` - -Owner null ` - -Description Send an email to the identity who's attributes changed. ` - -Definition null ` - -Enabled false ` - -Trigger null ` - -Id d201c5e9-d37b-4aff-af14-66414f39d569 ` - -ExecutionCount 2 ` - -FailureCount 0 ` - -Created 2022-01-10T16:06:16.636381447Z ` - -Modified 2023-12-05T15:18:27.699132301Z ` - -ModifiedBy null ` - -Creator null -``` - -- Convert the resource to JSON -```powershell -$Workflow | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowAllOfCreator.md b/docs/tools/sdk/powershell/reference/v3/Models/WorkflowAllOfCreator.md deleted file mode 100644 index 91bc40ad2..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowAllOfCreator.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: workflow-all-of-creator -title: WorkflowAllOfCreator -pagination_label: WorkflowAllOfCreator -sidebar_label: WorkflowAllOfCreator -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowAllOfCreator'] -slug: /tools/sdk/powershell/v3/models/workflow-all-of-creator -tags: ['SDK', 'Software Development Kit', 'WorkflowAllOfCreator'] ---- - - -# WorkflowAllOfCreator - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | Workflow creator's DTO type. | [optional] -**Id** | Pointer to **String** | Workflow creator's identity ID. | [optional] -**Name** | Pointer to **String** | Workflow creator's display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkflowAllOfCreator = Initialize-PSSailpoint.V3WorkflowAllOfCreator -Type IDENTITY ` - -Id 2c7180a46faadee4016fb4e018c20642 ` - -Name Michael Michaels -``` - -- Convert the resource to JSON -```powershell -$WorkflowAllOfCreator | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowBody.md b/docs/tools/sdk/powershell/reference/v3/Models/WorkflowBody.md deleted file mode 100644 index ce42653f7..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowBody.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: workflow-body -title: WorkflowBody -pagination_label: WorkflowBody -sidebar_label: WorkflowBody -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowBody'] -slug: /tools/sdk/powershell/v3/models/workflow-body -tags: ['SDK', 'Software Development Kit', 'WorkflowBody'] ---- - - -# WorkflowBody - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | The name of the workflow | [optional] -**Owner** | Pointer to [**WorkflowBodyOwner**](workflow-body-owner) | | [optional] -**Description** | Pointer to **String** | Description of what the workflow accomplishes | [optional] -**Definition** | Pointer to [**WorkflowDefinition**](workflow-definition) | | [optional] -**Enabled** | Pointer to **Boolean** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to $false] -**Trigger** | Pointer to [**WorkflowTrigger**](workflow-trigger) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkflowBody = Initialize-PSSailpoint.V3WorkflowBody -Name Send Email ` - -Owner null ` - -Description Send an email to the identity who's attributes changed. ` - -Definition null ` - -Enabled false ` - -Trigger null -``` - -- Convert the resource to JSON -```powershell -$WorkflowBody | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowBodyOwner.md b/docs/tools/sdk/powershell/reference/v3/Models/WorkflowBodyOwner.md deleted file mode 100644 index 45dfc61e0..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowBodyOwner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: workflow-body-owner -title: WorkflowBodyOwner -pagination_label: WorkflowBodyOwner -sidebar_label: WorkflowBodyOwner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowBodyOwner'] -slug: /tools/sdk/powershell/v3/models/workflow-body-owner -tags: ['SDK', 'Software Development Kit', 'WorkflowBodyOwner'] ---- - - -# WorkflowBodyOwner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | The type of object that is referenced | [optional] -**Id** | Pointer to **String** | The unique ID of the object | [optional] -**Name** | Pointer to **String** | The name of the object | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkflowBodyOwner = Initialize-PSSailpoint.V3WorkflowBodyOwner -Type IDENTITY ` - -Id 2c91808568c529c60168cca6f90c1313 ` - -Name William Wilson -``` - -- Convert the resource to JSON -```powershell -$WorkflowBodyOwner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowDefinition.md b/docs/tools/sdk/powershell/reference/v3/Models/WorkflowDefinition.md deleted file mode 100644 index 923d70ddc..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowDefinition.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: workflow-definition -title: WorkflowDefinition -pagination_label: WorkflowDefinition -sidebar_label: WorkflowDefinition -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowDefinition'] -slug: /tools/sdk/powershell/v3/models/workflow-definition -tags: ['SDK', 'Software Development Kit', 'WorkflowDefinition'] ---- - - -# WorkflowDefinition - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Start** | Pointer to **String** | The name of the starting step. | [optional] -**Steps** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkflowDefinition = Initialize-PSSailpoint.V3WorkflowDefinition -Start Send Email Test ` - -Steps {Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=ACTION}, success={type=success}} -``` - -- Convert the resource to JSON -```powershell -$WorkflowDefinition | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowExecution.md b/docs/tools/sdk/powershell/reference/v3/Models/WorkflowExecution.md deleted file mode 100644 index 1e614ec69..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowExecution.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: workflow-execution -title: WorkflowExecution -pagination_label: WorkflowExecution -sidebar_label: WorkflowExecution -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowExecution'] -slug: /tools/sdk/powershell/v3/models/workflow-execution -tags: ['SDK', 'Software Development Kit', 'WorkflowExecution'] ---- - - -# WorkflowExecution - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Workflow execution ID. | [optional] -**WorkflowId** | Pointer to **String** | Workflow ID. | [optional] -**RequestId** | Pointer to **String** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] -**StartTime** | Pointer to **System.DateTime** | Date/time when the workflow started. | [optional] -**CloseTime** | Pointer to **System.DateTime** | Date/time when the workflow ended. | [optional] -**Status** | Pointer to **Enum** [ "Completed", "Failed", "Canceled", "Executing" ] | Workflow execution status. | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkflowExecution = Initialize-PSSailpoint.V3WorkflowExecution -Id b393f4e2-4785-4d7f-ab27-3a6b8ded4c81 ` - -WorkflowId d201c5d9-d37b-4a2f-af14-66414f39d568 ` - -RequestId 41e12a74fa7b4a6a98ae47887b64acdb ` - -StartTime 2022-02-07T20:13:29.356648026Z ` - -CloseTime 2022-02-07T20:13:31.682410165Z ` - -Status Completed -``` - -- Convert the resource to JSON -```powershell -$WorkflowExecution | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowExecutionEvent.md b/docs/tools/sdk/powershell/reference/v3/Models/WorkflowExecutionEvent.md deleted file mode 100644 index 6f6b03432..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowExecutionEvent.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: workflow-execution-event -title: WorkflowExecutionEvent -pagination_label: WorkflowExecutionEvent -sidebar_label: WorkflowExecutionEvent -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowExecutionEvent'] -slug: /tools/sdk/powershell/v3/models/workflow-execution-event -tags: ['SDK', 'Software Development Kit', 'WorkflowExecutionEvent'] ---- - - -# WorkflowExecutionEvent - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "WorkflowExecutionScheduled", "WorkflowExecutionStarted", "WorkflowExecutionCompleted", "WorkflowExecutionFailed", "WorkflowTaskScheduled", "WorkflowTaskStarted", "WorkflowTaskCompleted", "WorkflowTaskFailed", "ActivityTaskScheduled", "ActivityTaskStarted", "ActivityTaskCompleted", "ActivityTaskFailed", "StartChildWorkflowExecutionInitiated", "ChildWorkflowExecutionStarted", "ChildWorkflowExecutionCompleted", "ChildWorkflowExecutionFailed" ] | The type of event | [optional] -**Timestamp** | Pointer to **System.DateTime** | The date-time when the event occurred | [optional] -**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Additional attributes associated with the event | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkflowExecutionEvent = Initialize-PSSailpoint.V3WorkflowExecutionEvent -Type WorkflowTaskScheduled ` - -Timestamp 2022-02-07T20:13:31.640618296Z ` - -Attributes {} -``` - -- Convert the resource to JSON -```powershell -$WorkflowExecutionEvent | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowLibraryAction.md b/docs/tools/sdk/powershell/reference/v3/Models/WorkflowLibraryAction.md deleted file mode 100644 index 5f1cbc6c5..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowLibraryAction.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -id: workflow-library-action -title: WorkflowLibraryAction -pagination_label: WorkflowLibraryAction -sidebar_label: WorkflowLibraryAction -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowLibraryAction'] -slug: /tools/sdk/powershell/v3/models/workflow-library-action -tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryAction'] ---- - - -# WorkflowLibraryAction - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Action ID. This is a static namespaced ID for the action | [optional] -**Name** | Pointer to **String** | Action Name | [optional] -**Type** | Pointer to **String** | Action type | [optional] -**Description** | Pointer to **String** | Action Description | [optional] -**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the action accepts | [optional] -**ExampleOutput** | Pointer to [**WorkflowLibraryActionExampleOutput**](workflow-library-action-example-output) | | [optional] -**Deprecated** | Pointer to **Boolean** | | [optional] -**DeprecatedBy** | Pointer to **System.DateTime** | | [optional] -**VersionNumber** | Pointer to **Int32** | Version number | [optional] -**IsSimulationEnabled** | Pointer to **Boolean** | | [optional] -**IsDynamicSchema** | Pointer to **Boolean** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] [default to $false] -**OutputSchema** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Defines the output schema, if any, that this action produces. | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkflowLibraryAction = Initialize-PSSailpoint.V3WorkflowLibraryAction -Id sp:create-campaign ` - -Name Create Certification Campaign ` - -Type ACTION ` - -Description Generates a certification campaign. ` - -FormFields null ` - -ExampleOutput null ` - -Deprecated null ` - -DeprecatedBy null ` - -VersionNumber null ` - -IsSimulationEnabled null ` - -IsDynamicSchema false ` - -OutputSchema {definitions={}, properties={autoRevokeAllowed={$id=#sp:create-campaign/autoRevokeAllowed, default=true, examples=[false], title=autoRevokeAllowed, type=boolean}, deadline={$id=#sp:create-campaign/deadline, default=, examples=[2020-12-25T06:00:00.468Z], format=date-time, pattern=^.*$, title=deadline, type=string}, description={$id=#sp:create-campaign/description, default=, examples=[A review of everyone's access by their manager.], pattern=^.*$, title=description, type=string}, emailNotificationEnabled={$id=#sp:create-campaign/emailNotificationEnabled, default=true, examples=[false], title=emailNotificationEnabled, type=boolean}, filter={$id=#sp:create-campaign/filter, properties={id={$id=#sp:create-campaign/filter/id, default=, examples=[e0adaae69852e8fe8b8a3d48e5ce757c], pattern=^.*$, title=id, type=string}, type={$id=#sp:create-campaign/filter/type, default=, examples=[CAMPAIGN_FILTER], pattern=^.*$, title=type, type=string}}, title=filter, type=object}, id={$id=#sp:create-campaign/id, default=, examples=[2c918086719eec070171a7e3355a360a], pattern=^.*$, title=id, type=string}, name={$id=#sp:create-campaign/name, default=, examples=[Manager Review], pattern=^.*$, title=name, type=string}, recommendationsEnabled={$id=#sp:create-campaign/recommendationsEnabled, default=true, examples=[false], title=recommendationEnabled, type=boolean}, type={$id=#sp:create-campaign/type, default=, examples=[MANAGER], pattern=^.*$, title=type, type=string}}, title=sp:create-campaign, type=object} -``` - -- Convert the resource to JSON -```powershell -$WorkflowLibraryAction | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowLibraryActionExampleOutput.md b/docs/tools/sdk/powershell/reference/v3/Models/WorkflowLibraryActionExampleOutput.md deleted file mode 100644 index aa19086ee..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowLibraryActionExampleOutput.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: workflow-library-action-example-output -title: WorkflowLibraryActionExampleOutput -pagination_label: WorkflowLibraryActionExampleOutput -sidebar_label: WorkflowLibraryActionExampleOutput -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowLibraryActionExampleOutput'] -slug: /tools/sdk/powershell/v3/models/workflow-library-action-example-output -tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryActionExampleOutput'] ---- - - -# WorkflowLibraryActionExampleOutput - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -## Examples - -- Prepare the resource -```powershell -$WorkflowLibraryActionExampleOutput = Initialize-PSSailpoint.V3WorkflowLibraryActionExampleOutput -``` - -- Convert the resource to JSON -```powershell -$WorkflowLibraryActionExampleOutput | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowLibraryFormFields.md b/docs/tools/sdk/powershell/reference/v3/Models/WorkflowLibraryFormFields.md deleted file mode 100644 index d80814248..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowLibraryFormFields.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: workflow-library-form-fields -title: WorkflowLibraryFormFields -pagination_label: WorkflowLibraryFormFields -sidebar_label: WorkflowLibraryFormFields -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowLibraryFormFields'] -slug: /tools/sdk/powershell/v3/models/workflow-library-form-fields -tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryFormFields'] ---- - - -# WorkflowLibraryFormFields - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Description** | Pointer to **String** | Description of the form field | [optional] -**HelpText** | Pointer to **String** | Describes the form field in the UI | [optional] -**Label** | Pointer to **String** | A human readable name for this form field in the UI | [optional] -**Name** | Pointer to **String** | The name of the input attribute | [optional] -**Required** | Pointer to **Boolean** | Denotes if this field is a required attribute | [optional] [default to $false] -**Type** | Pointer to **Enum** [ "text", "textarea", "boolean", "email", "url", "number", "json", "checkbox", "jsonpath", "select", "multiType", "duration", "toggle", "formPicker", "identityPicker", "governanceGroupPicker", "string", "object", "array", "secret", "keyValuePairs", "emailPicker", "advancedToggle", "variableCreator", "htmlEditor" ] | The type of the form field | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkflowLibraryFormFields = Initialize-PSSailpoint.V3WorkflowLibraryFormFields -Description First value to compare ` - -HelpText The name to give to this certification campaign. ` - -Label Campaign Name ` - -Name name ` - -Required false ` - -Type text -``` - -- Convert the resource to JSON -```powershell -$WorkflowLibraryFormFields | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowLibraryOperator.md b/docs/tools/sdk/powershell/reference/v3/Models/WorkflowLibraryOperator.md deleted file mode 100644 index 1b31c92a1..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowLibraryOperator.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: workflow-library-operator -title: WorkflowLibraryOperator -pagination_label: WorkflowLibraryOperator -sidebar_label: WorkflowLibraryOperator -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowLibraryOperator'] -slug: /tools/sdk/powershell/v3/models/workflow-library-operator -tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryOperator'] ---- - - -# WorkflowLibraryOperator - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Operator ID. | [optional] -**Name** | Pointer to **String** | Operator friendly name | [optional] -**Type** | Pointer to **String** | Operator type | [optional] -**Description** | Pointer to **String** | Description of the operator | [optional] -**IsDynamicSchema** | Pointer to **Boolean** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] -**Deprecated** | Pointer to **Boolean** | | [optional] -**DeprecatedBy** | Pointer to **System.DateTime** | | [optional] -**IsSimulationEnabled** | Pointer to **Boolean** | | [optional] -**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the operator accepts | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkflowLibraryOperator = Initialize-PSSailpoint.V3WorkflowLibraryOperator -Id sp:compare-boolean ` - -Name Compare Boolean Values ` - -Type OPERATOR ` - -Description Compare two boolean values and decide what happens based on the result. ` - -IsDynamicSchema false ` - -Deprecated null ` - -DeprecatedBy null ` - -IsSimulationEnabled null ` - -FormFields [{description=Enter the JSONPath to a value from the input to compare to Variable B., helpText=, label=Variable A, name=variableA.$, required=true, type=text}, {helpText=Select an operation., label=Operation, name=operator, options=[{label=Equals, value=BooleanEquals}], required=true, type=select}, {description=Enter the JSONPath to a value from the input to compare to Variable A., helpText=, label=Variable B, name=variableB.$, required=false, type=text}, {description=Enter True or False., helpText=, label=Variable B, name=variableB, required=false, type=text}] -``` - -- Convert the resource to JSON -```powershell -$WorkflowLibraryOperator | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowLibraryTrigger.md b/docs/tools/sdk/powershell/reference/v3/Models/WorkflowLibraryTrigger.md deleted file mode 100644 index d38072356..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowLibraryTrigger.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -id: workflow-library-trigger -title: WorkflowLibraryTrigger -pagination_label: WorkflowLibraryTrigger -sidebar_label: WorkflowLibraryTrigger -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowLibraryTrigger'] -slug: /tools/sdk/powershell/v3/models/workflow-library-trigger -tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryTrigger'] ---- - - -# WorkflowLibraryTrigger - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Trigger ID. This is a static namespaced ID for the trigger. | [optional] -**Type** | Pointer to **Enum** [ "EVENT", "SCHEDULED", "EXTERNAL" ] | Trigger type | [optional] -**Deprecated** | Pointer to **Boolean** | | [optional] -**DeprecatedBy** | Pointer to **System.DateTime** | | [optional] -**IsSimulationEnabled** | Pointer to **Boolean** | | [optional] -**OutputSchema** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Example output schema | [optional] -**Name** | Pointer to **String** | Trigger Name | [optional] -**Description** | Pointer to **String** | Trigger Description | [optional] -**IsDynamicSchema** | Pointer to **Boolean** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] [default to $false] -**InputExample** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Example trigger payload if applicable | [optional] -**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the trigger accepts | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkflowLibraryTrigger = Initialize-PSSailpoint.V3WorkflowLibraryTrigger -Id idn:identity-attributes-changed ` - -Type EVENT ` - -Deprecated null ` - -DeprecatedBy null ` - -IsSimulationEnabled null ` - -OutputSchema null ` - -Name Identity Attributes Changed ` - -Description One or more identity attributes changed. ` - -IsDynamicSchema false ` - -InputExample {changes=[{attribute=department, newValue=marketing, oldValue=sales}, {attribute=manager, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}}, {attribute=email, newValue=john.doe@gmail.com, oldValue=john.doe@hotmail.com}], identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}} ` - -FormFields [] -``` - -- Convert the resource to JSON -```powershell -$WorkflowLibraryTrigger | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowModifiedBy.md b/docs/tools/sdk/powershell/reference/v3/Models/WorkflowModifiedBy.md deleted file mode 100644 index 4cc9d0575..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowModifiedBy.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: workflow-modified-by -title: WorkflowModifiedBy -pagination_label: WorkflowModifiedBy -sidebar_label: WorkflowModifiedBy -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowModifiedBy'] -slug: /tools/sdk/powershell/v3/models/workflow-modified-by -tags: ['SDK', 'Software Development Kit', 'WorkflowModifiedBy'] ---- - - -# WorkflowModifiedBy - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | | [optional] -**Id** | Pointer to **String** | Identity ID | [optional] -**Name** | Pointer to **String** | Human-readable display name of identity. | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkflowModifiedBy = Initialize-PSSailpoint.V3WorkflowModifiedBy -Type IDENTITY ` - -Id 2c9180a46faadee4016fb4e018c20639 ` - -Name Thomas Edison -``` - -- Convert the resource to JSON -```powershell -$WorkflowModifiedBy | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowOAuthClient.md b/docs/tools/sdk/powershell/reference/v3/Models/WorkflowOAuthClient.md deleted file mode 100644 index e06b214e4..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowOAuthClient.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: workflow-o-auth-client -title: WorkflowOAuthClient -pagination_label: WorkflowOAuthClient -sidebar_label: WorkflowOAuthClient -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowOAuthClient'] -slug: /tools/sdk/powershell/v3/models/workflow-o-auth-client -tags: ['SDK', 'Software Development Kit', 'WorkflowOAuthClient'] ---- - - -# WorkflowOAuthClient - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | OAuth client ID for the trigger. This is a UUID generated upon creation. | [optional] -**Secret** | Pointer to **String** | OAuthClient secret. | [optional] -**Url** | Pointer to **String** | URL for the external trigger to invoke | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkflowOAuthClient = Initialize-PSSailpoint.V3WorkflowOAuthClient -Id 1a58c03a6bf64dc2876f6988c6e2c7b7 ` - -Secret 00cc24a7fe810fe06a7cb38bc168ae104d703c7abb296f9944dc68e69ddb578b ` - -Url https://tenant.api.identitynow.com/beta/workflows/execute/external/c17bea3a-574d-453c-9e04-4365fbf5af0b -``` - -- Convert the resource to JSON -```powershell -$WorkflowOAuthClient | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowTrigger.md b/docs/tools/sdk/powershell/reference/v3/Models/WorkflowTrigger.md deleted file mode 100644 index 3035fa610..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowTrigger.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: workflow-trigger -title: WorkflowTrigger -pagination_label: WorkflowTrigger -sidebar_label: WorkflowTrigger -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowTrigger'] -slug: /tools/sdk/powershell/v3/models/workflow-trigger -tags: ['SDK', 'Software Development Kit', 'WorkflowTrigger'] ---- - - -# WorkflowTrigger - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "EVENT", "EXTERNAL", "SCHEDULED", "" ] | The trigger type | [required] -**DisplayName** | Pointer to **String** | | [optional] -**Attributes** | [**WorkflowTriggerAttributes**](workflow-trigger-attributes) | | [required] - -## Examples - -- Prepare the resource -```powershell -$WorkflowTrigger = Initialize-PSSailpoint.V3WorkflowTrigger -Type EVENT ` - -DisplayName null ` - -Attributes null -``` - -- Convert the resource to JSON -```powershell -$WorkflowTrigger | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowTriggerAttributes.md b/docs/tools/sdk/powershell/reference/v3/Models/WorkflowTriggerAttributes.md deleted file mode 100644 index 5af7f3083..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/WorkflowTriggerAttributes.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -id: workflow-trigger-attributes -title: WorkflowTriggerAttributes -pagination_label: WorkflowTriggerAttributes -sidebar_label: WorkflowTriggerAttributes -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowTriggerAttributes'] -slug: /tools/sdk/powershell/v3/models/workflow-trigger-attributes -tags: ['SDK', 'Software Development Kit', 'WorkflowTriggerAttributes'] ---- - - -# WorkflowTriggerAttributes - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The unique ID of the trigger | [required] -**VarFilter** | Pointer to **String** | JSON path expression that will limit which events the trigger will fire on | [optional] -**Description** | Pointer to **String** | Additonal context about the external trigger | [optional] -**AttributeToFilter** | Pointer to **String** | The attribute to filter on | [optional] -**Name** | Pointer to **String** | A unique name for the external trigger | [optional] -**ClientId** | Pointer to **String** | OAuth Client ID to authenticate with this trigger | [optional] -**Url** | Pointer to **String** | URL to invoke this workflow | [optional] -**CronString** | Pointer to **String** | A valid CRON expression | [optional] -**Frequency** | **Enum** [ "daily", "weekly", "monthly", "yearly", "cronSchedule" ] | Frequency of execution | [required] -**TimeZone** | Pointer to **String** | Time zone identifier | [optional] -**WeeklyDays** | Pointer to **[]String** | Scheduled days of the week for execution | [optional] -**WeeklyTimes** | Pointer to **[]String** | Scheduled execution times | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkflowTriggerAttributes = Initialize-PSSailpoint.V3WorkflowTriggerAttributes -Id idn:identity-attributes-changed ` - -VarFilter $.changes[?(@.attribute == 'manager')] ` - -Description Run a search and notify the results ` - -AttributeToFilter LifecycleState ` - -Name search-and-notify ` - -ClientId 87e239b2-b85b-4bde-b9a7-55bf304ddcdc ` - -Url https://tenant.api.identitynow.com/beta/workflows/execute/external/c79e0079-562c-4df5-aa73-60a9e25c916d ` - -CronString 0 9 * * 1 ` - -Frequency null ` - -TimeZone America/Chicago ` - -WeeklyDays Monday ` - -WeeklyTimes Monday -``` - -- Convert the resource to JSON -```powershell -$WorkflowTriggerAttributes | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/reference/v3/Models/indices.md b/docs/tools/sdk/powershell/reference/v3/Models/indices.md deleted file mode 100644 index fe9c378fc..000000000 --- a/docs/tools/sdk/powershell/reference/v3/Models/indices.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: index -title: Index -pagination_label: Index -sidebar_label: Index -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Index'] -slug: /tools/sdk/powershell/v3/models/index -tags: ['SDK', 'Software Development Kit', 'Index'] ---- - - -# Index - -## Enum - - -* `accessprofiles` (value: `"accessprofiles"`) - -* `accountactivities` (value: `"accountactivities"`) - -* `entitlements` (value: `"entitlements"`) - -* `events` (value: `"events"`) - -* `identities` (value: `"identities"`) - -* `roles` (value: `"roles"`) - -* `STAR` (value: `"*"`) - - -[[Back to top]](#) -