mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 20:37:46 +00:00
removing part of model docs from v2024
This commit is contained in:
darrell-thobe-sp
@@ -1,39 +0,0 @@
|
||||
---
|
||||
id: v2024-approval-summary
|
||||
title: ApprovalSummary
|
||||
pagination_label: ApprovalSummary
|
||||
sidebar_label: ApprovalSummary
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalSummary']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024ApprovalSummary -Pending 0 `
|
||||
-Approved 0 `
|
||||
-Rejected 0
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ApprovalSummary | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
id: v2024-argument
|
||||
title: Argument
|
||||
pagination_label: Argument
|
||||
sidebar_label: Argument
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'Argument']
|
||||
slug: /tools/sdk/powershell/v2024/models/argument
|
||||
tags: ['SDK', 'Software Development Kit', 'Argument']
|
||||
---
|
||||
|
||||
|
||||
# Argument
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | **String** | the name of the argument | [required]
|
||||
**Description** | Pointer to **String** | the description of the argument | [optional]
|
||||
**Type** | Pointer to **String** | the programmatic type of the argument | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$Argument = Initialize-PSSailpoint.V2024Argument -Name firstName `
|
||||
-Description the first name of the identity `
|
||||
-Type String
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$Argument | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,34 +0,0 @@
|
||||
---
|
||||
id: v2024-array-inner
|
||||
title: ArrayInner
|
||||
pagination_label: ArrayInner
|
||||
sidebar_label: ArrayInner
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ArrayInner']
|
||||
slug: /tools/sdk/powershell/v2024/models/array-inner
|
||||
tags: ['SDK', 'Software Development Kit', 'ArrayInner']
|
||||
---
|
||||
|
||||
|
||||
# ArrayInner
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ArrayInner = Initialize-PSSailpoint.V2024ArrayInner
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ArrayInner | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
id: v2024-assignment-context-dto
|
||||
title: AssignmentContextDto
|
||||
pagination_label: AssignmentContextDto
|
||||
sidebar_label: AssignmentContextDto
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AssignmentContextDto']
|
||||
slug: /tools/sdk/powershell/v2024/models/assignment-context-dto
|
||||
tags: ['SDK', 'Software Development Kit', 'AssignmentContextDto']
|
||||
---
|
||||
|
||||
|
||||
# AssignmentContextDto
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Requested** | Pointer to [**AccessRequestContext**](access-request-context) | | [optional]
|
||||
**Matched** | Pointer to [**[]RoleMatchDto**](role-match-dto) | | [optional]
|
||||
**ComputedDate** | Pointer to **String** | Date that the assignment will was evaluated | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AssignmentContextDto = Initialize-PSSailpoint.V2024AssignmentContextDto -Requested null `
|
||||
-Matched null `
|
||||
-ComputedDate Wed Feb 14 10:58:42
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AssignmentContextDto | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
id: v2024-attr-sync-source
|
||||
title: AttrSyncSource
|
||||
pagination_label: AttrSyncSource
|
||||
sidebar_label: AttrSyncSource
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AttrSyncSource']
|
||||
slug: /tools/sdk/powershell/v2024/models/attr-sync-source
|
||||
tags: ['SDK', 'Software Development Kit', 'AttrSyncSource']
|
||||
---
|
||||
|
||||
|
||||
# AttrSyncSource
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | Pointer to **Enum** [ "SOURCE" ] | DTO type of target source for attribute synchronization. | [optional]
|
||||
**Id** | Pointer to **String** | ID of target source for attribute synchronization. | [optional]
|
||||
**Name** | Pointer to **String** | Human-readable name of target source for attribute synchronization. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AttrSyncSource = Initialize-PSSailpoint.V2024AttrSyncSource -Type SOURCE `
|
||||
-Id 2c9180835d191a86015d28455b4b232a `
|
||||
-Name HR Active Directory
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AttrSyncSource | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
id: v2024-attr-sync-source-attribute-config
|
||||
title: AttrSyncSourceAttributeConfig
|
||||
pagination_label: AttrSyncSourceAttributeConfig
|
||||
sidebar_label: AttrSyncSourceAttributeConfig
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AttrSyncSourceAttributeConfig']
|
||||
slug: /tools/sdk/powershell/v2024/models/attr-sync-source-attribute-config
|
||||
tags: ['SDK', 'Software Development Kit', 'AttrSyncSourceAttributeConfig']
|
||||
---
|
||||
|
||||
|
||||
# AttrSyncSourceAttributeConfig
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | **String** | Name of the identity attribute | [required]
|
||||
**DisplayName** | **String** | Display name of the identity attribute | [required]
|
||||
**Enabled** | **Boolean** | Determines whether or not the attribute is enabled for synchronization | [required]
|
||||
**Target** | **String** | Name of the source account attribute to which the identity attribute value will be synchronized if enabled | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AttrSyncSourceAttributeConfig = Initialize-PSSailpoint.V2024AttrSyncSourceAttributeConfig -Name email `
|
||||
-DisplayName Email `
|
||||
-Enabled true `
|
||||
-Target mail
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AttrSyncSourceAttributeConfig | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
id: v2024-attr-sync-source-config
|
||||
title: AttrSyncSourceConfig
|
||||
pagination_label: AttrSyncSourceConfig
|
||||
sidebar_label: AttrSyncSourceConfig
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AttrSyncSourceConfig']
|
||||
slug: /tools/sdk/powershell/v2024/models/attr-sync-source-config
|
||||
tags: ['SDK', 'Software Development Kit', 'AttrSyncSourceConfig']
|
||||
---
|
||||
|
||||
|
||||
# AttrSyncSourceConfig
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Source** | [**AttrSyncSource**](attr-sync-source) | | [required]
|
||||
**Attributes** | [**[]AttrSyncSourceAttributeConfig**](attr-sync-source-attribute-config) | Attribute synchronization configuration for specific identity attributes in the context of a source | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AttrSyncSourceConfig = Initialize-PSSailpoint.V2024AttrSyncSourceConfig -Source null `
|
||||
-Attributes [{name=email, displayName=Email, enabled=true, target=mail}, {name=firstname, displayName=First Name, enabled=false, target=givenName}]
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AttrSyncSourceConfig | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
id: v2024-attribute-change
|
||||
title: AttributeChange
|
||||
pagination_label: AttributeChange
|
||||
sidebar_label: AttributeChange
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeChange']
|
||||
slug: /tools/sdk/powershell/v2024/models/attribute-change
|
||||
tags: ['SDK', 'Software Development Kit', 'AttributeChange']
|
||||
---
|
||||
|
||||
|
||||
# AttributeChange
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | Pointer to **String** | the attribute name | [optional]
|
||||
**PreviousValue** | Pointer to **String** | the old value of attribute | [optional]
|
||||
**NewValue** | Pointer to **String** | the new value of attribute | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AttributeChange = Initialize-PSSailpoint.V2024AttributeChange -Name null `
|
||||
-PreviousValue null `
|
||||
-NewValue null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AttributeChange | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,49 +0,0 @@
|
||||
---
|
||||
id: v2024-attribute-dto
|
||||
title: AttributeDTO
|
||||
pagination_label: AttributeDTO
|
||||
sidebar_label: AttributeDTO
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDTO']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024AttributeDTO -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]](#)
|
||||
|
||||
@@ -1,35 +0,0 @@
|
||||
---
|
||||
id: v2024-attribute-dto-list
|
||||
title: AttributeDTOList
|
||||
pagination_label: AttributeDTOList
|
||||
sidebar_label: AttributeDTOList
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDTOList']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024AttributeDTOList -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]](#)
|
||||
|
||||
@@ -1,47 +0,0 @@
|
||||
---
|
||||
id: v2024-attribute-definition
|
||||
title: AttributeDefinition
|
||||
pagination_label: AttributeDefinition
|
||||
sidebar_label: AttributeDefinition
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDefinition']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024AttributeDefinition -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]](#)
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
id: v2024-attribute-definition-schema
|
||||
title: AttributeDefinitionSchema
|
||||
pagination_label: AttributeDefinitionSchema
|
||||
sidebar_label: AttributeDefinitionSchema
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDefinitionSchema']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024AttributeDefinitionSchema -Type CONNECTOR_SCHEMA `
|
||||
-Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name group
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AttributeDefinitionSchema | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,28 +0,0 @@
|
||||
---
|
||||
id: v2024-attribute-definition-type
|
||||
title: AttributeDefinitionType
|
||||
pagination_label: AttributeDefinitionType
|
||||
sidebar_label: AttributeDefinitionType
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDefinitionType']
|
||||
slug: /tools/sdk/powershell/v2024/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]](#)
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
id: v2024-attribute-request
|
||||
title: AttributeRequest
|
||||
pagination_label: AttributeRequest
|
||||
sidebar_label: AttributeRequest
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeRequest']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024AttributeRequest -Name groups `
|
||||
-Op Add `
|
||||
-Value 3203537556531076
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AttributeRequest | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
id: v2024-attribute-value-dto
|
||||
title: AttributeValueDTO
|
||||
pagination_label: AttributeValueDTO
|
||||
sidebar_label: AttributeValueDTO
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeValueDTO']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024AttributeValueDTO -Value public `
|
||||
-Name Public `
|
||||
-Status active
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AttributeValueDTO | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
id: v2024-attributes-changed
|
||||
title: AttributesChanged
|
||||
pagination_label: AttributesChanged
|
||||
sidebar_label: AttributesChanged
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AttributesChanged']
|
||||
slug: /tools/sdk/powershell/v2024/models/attributes-changed
|
||||
tags: ['SDK', 'Software Development Kit', 'AttributesChanged']
|
||||
---
|
||||
|
||||
|
||||
# AttributesChanged
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Changes** | Pointer to [**[]AttributeChange**](attribute-change) | | [optional]
|
||||
**EventType** | Pointer to **String** | the event type | [optional]
|
||||
**IdentityId** | Pointer to **String** | the identity id | [optional]
|
||||
**Dt** | Pointer to **String** | the date of event | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AttributesChanged = Initialize-PSSailpoint.V2024AttributesChanged -Changes null `
|
||||
-EventType null `
|
||||
-IdentityId null `
|
||||
-Dt null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AttributesChanged | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
id: v2024-audit-details
|
||||
title: AuditDetails
|
||||
pagination_label: AuditDetails
|
||||
sidebar_label: AuditDetails
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AuditDetails']
|
||||
slug: /tools/sdk/powershell/v2024/models/audit-details
|
||||
tags: ['SDK', 'Software Development Kit', 'AuditDetails']
|
||||
---
|
||||
|
||||
|
||||
# AuditDetails
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Created** | Pointer to **System.DateTime** | Initial date and time when the record was created | [optional]
|
||||
**CreatedBy** | Pointer to [**Identity1**](identity1) | | [optional]
|
||||
**Modified** | Pointer to **System.DateTime** | Last modified date and time for the record | [optional]
|
||||
**ModifiedBy** | Pointer to [**Identity1**](identity1) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AuditDetails = Initialize-PSSailpoint.V2024AuditDetails -Created 2022-07-21T11:13:12.345Z `
|
||||
-CreatedBy null `
|
||||
-Modified 2022-07-21T11:13:12.345Z `
|
||||
-ModifiedBy null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AuditDetails | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,47 +0,0 @@
|
||||
---
|
||||
id: v2024-auth-profile
|
||||
title: AuthProfile
|
||||
pagination_label: AuthProfile
|
||||
sidebar_label: AuthProfile
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AuthProfile']
|
||||
slug: /tools/sdk/powershell/v2024/models/auth-profile
|
||||
tags: ['SDK', 'Software Development Kit', 'AuthProfile']
|
||||
---
|
||||
|
||||
|
||||
# AuthProfile
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | Pointer to **String** | Authentication Profile name. | [optional]
|
||||
**OffNetwork** | Pointer to **Boolean** | Use it to block access from off network. | [optional] [default to $false]
|
||||
**UntrustedGeography** | Pointer to **Boolean** | Use it to block access from untrusted geoographies. | [optional] [default to $false]
|
||||
**ApplicationId** | Pointer to **String** | Application ID. | [optional]
|
||||
**ApplicationName** | Pointer to **String** | Application name. | [optional]
|
||||
**Type** | Pointer to **Enum** [ "BLOCK", "MFA", "NON_PTA", "PTA" ] | Type of the Authentication Profile. | [optional]
|
||||
**StrongAuthLogin** | Pointer to **Boolean** | Use it to enable strong authentication. | [optional] [default to $false]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AuthProfile = Initialize-PSSailpoint.V2024AuthProfile -Name EndToEnd-Profile `
|
||||
-OffNetwork true `
|
||||
-UntrustedGeography true `
|
||||
-ApplicationId 2c91808458ae7a4f0158b1bbf8af0628 `
|
||||
-ApplicationName EndToEnd-Source `
|
||||
-Type PTA `
|
||||
-StrongAuthLogin true
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AuthProfile | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
id: v2024-auth-profile-summary
|
||||
title: AuthProfileSummary
|
||||
pagination_label: AuthProfileSummary
|
||||
sidebar_label: AuthProfileSummary
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AuthProfileSummary']
|
||||
slug: /tools/sdk/powershell/v2024/models/auth-profile-summary
|
||||
tags: ['SDK', 'Software Development Kit', 'AuthProfileSummary']
|
||||
---
|
||||
|
||||
|
||||
# AuthProfileSummary
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Tenant** | Pointer to **String** | Tenant name. | [optional]
|
||||
**Id** | Pointer to **String** | Identity ID. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AuthProfileSummary = Initialize-PSSailpoint.V2024AuthProfileSummary -Tenant test-tenant `
|
||||
-Id 2c91808458ae7a4f0158b1bbf8af0628
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AuthProfileSummary | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,67 +0,0 @@
|
||||
---
|
||||
id: v2024-auth-user
|
||||
title: AuthUser
|
||||
pagination_label: AuthUser
|
||||
sidebar_label: AuthUser
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AuthUser']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024AuthUser -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]](#)
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
id: v2024-backup-options
|
||||
title: BackupOptions
|
||||
pagination_label: BackupOptions
|
||||
sidebar_label: BackupOptions
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'BackupOptions']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024BackupOptions -IncludeTypes null `
|
||||
-ObjectOptions {TRIGGER_SUBSCRIPTION={includedNames=[Trigger Subscription name]}}
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$BackupOptions | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,67 +0,0 @@
|
||||
---
|
||||
id: v2024-backup-response
|
||||
title: BackupResponse
|
||||
pagination_label: BackupResponse
|
||||
sidebar_label: BackupResponse
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'BackupResponse']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024BackupResponse -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]](#)
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
id: v2024-base64-decode
|
||||
title: Base64Decode
|
||||
pagination_label: Base64Decode
|
||||
sidebar_label: Base64Decode
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'Base64Decode']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024Base64Decode -RequiresPeriodicRefresh false `
|
||||
-VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}}
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$Base64Decode | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
id: v2024-base64-encode
|
||||
title: Base64Encode
|
||||
pagination_label: Base64Encode
|
||||
sidebar_label: Base64Encode
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'Base64Encode']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024Base64Encode -RequiresPeriodicRefresh false `
|
||||
-VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}}
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$Base64Encode | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,53 +0,0 @@
|
||||
---
|
||||
id: v2024-base-access
|
||||
title: BaseAccess
|
||||
pagination_label: BaseAccess
|
||||
sidebar_label: BaseAccess
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'BaseAccess']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024BaseAccess -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]](#)
|
||||
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
id: v2024-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/v2024/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.V2024BaseAccessAllOfOwner -Type IDENTITY `
|
||||
-Id 2c9180a46faadee4016fb4e018c20639 `
|
||||
-Name Support `
|
||||
-Email cloud-support@sailpoint.com
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$BaseAccessAllOfOwner | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
id: v2024-base-access-profile
|
||||
title: BaseAccessProfile
|
||||
pagination_label: BaseAccessProfile
|
||||
sidebar_label: BaseAccessProfile
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'BaseAccessProfile']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024BaseAccessProfile -Id 2c91809c6faade77016fb4f0b63407ae `
|
||||
-Name Admin Access
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$BaseAccessProfile | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,55 +0,0 @@
|
||||
---
|
||||
id: v2024-base-account
|
||||
title: BaseAccount
|
||||
pagination_label: BaseAccount
|
||||
sidebar_label: BaseAccount
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'BaseAccount']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024BaseAccount -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]](#)
|
||||
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
id: v2024-base-common-dto
|
||||
title: BaseCommonDto
|
||||
pagination_label: BaseCommonDto
|
||||
sidebar_label: BaseCommonDto
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'BaseCommonDto']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024BaseCommonDto -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]](#)
|
||||
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
id: v2024-base-common-dto1
|
||||
title: BaseCommonDto1
|
||||
pagination_label: BaseCommonDto1
|
||||
sidebar_label: BaseCommonDto1
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'BaseCommonDto1']
|
||||
slug: /tools/sdk/powershell/v2024/models/base-common-dto1
|
||||
tags: ['SDK', 'Software Development Kit', 'BaseCommonDto1']
|
||||
---
|
||||
|
||||
|
||||
# BaseCommonDto1
|
||||
|
||||
## 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
|
||||
$BaseCommonDto1 = Initialize-PSSailpoint.V2024BaseCommonDto1 -Id id12345 `
|
||||
-Name aName `
|
||||
-Created 2023-01-03T21:16:22.432Z `
|
||||
-Modified 2023-01-03T21:16:22.432Z
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$BaseCommonDto1 | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
id: v2024-base-document
|
||||
title: BaseDocument
|
||||
pagination_label: BaseDocument
|
||||
sidebar_label: BaseDocument
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'BaseDocument']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024BaseDocument -Id 2c91808375d8e80a0175e1f88a575222 `
|
||||
-Name john.doe `
|
||||
-Type null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$BaseDocument | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,49 +0,0 @@
|
||||
---
|
||||
id: v2024-base-entitlement
|
||||
title: BaseEntitlement
|
||||
pagination_label: BaseEntitlement
|
||||
sidebar_label: BaseEntitlement
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'BaseEntitlement']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024BaseEntitlement -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]](#)
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
id: v2024-base-reference-dto
|
||||
title: BaseReferenceDto
|
||||
pagination_label: BaseReferenceDto
|
||||
sidebar_label: BaseReferenceDto
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'BaseReferenceDto']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024BaseReferenceDto -Type null `
|
||||
-Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name William Wilson
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$BaseReferenceDto | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
id: v2024-base-reference-dto1
|
||||
title: BaseReferenceDto1
|
||||
pagination_label: BaseReferenceDto1
|
||||
sidebar_label: BaseReferenceDto1
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'BaseReferenceDto1']
|
||||
slug: /tools/sdk/powershell/v2024/models/base-reference-dto1
|
||||
tags: ['SDK', 'Software Development Kit', 'BaseReferenceDto1']
|
||||
---
|
||||
|
||||
|
||||
# BaseReferenceDto1
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | the application ID | [optional]
|
||||
**Name** | Pointer to **String** | the application name | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$BaseReferenceDto1 = Initialize-PSSailpoint.V2024BaseReferenceDto1 -Id ff8081814d977c21014da056804a0af3 `
|
||||
-Name Github
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$BaseReferenceDto1 | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
id: v2024-base-segment
|
||||
title: BaseSegment
|
||||
pagination_label: BaseSegment
|
||||
sidebar_label: BaseSegment
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'BaseSegment']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024BaseSegment -Id b009b6e3-b56d-41d9-8735-cb532ea0b017 `
|
||||
-Name Test Segment
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$BaseSegment | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
id: v2024-basic-auth-config
|
||||
title: BasicAuthConfig
|
||||
pagination_label: BasicAuthConfig
|
||||
sidebar_label: BasicAuthConfig
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'BasicAuthConfig']
|
||||
slug: /tools/sdk/powershell/v2024/models/basic-auth-config
|
||||
tags: ['SDK', 'Software Development Kit', 'BasicAuthConfig']
|
||||
---
|
||||
|
||||
|
||||
# BasicAuthConfig
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**UserName** | Pointer to **String** | The username to authenticate. | [optional]
|
||||
**Password** | Pointer to **String** | The password to authenticate. On response, this field is set to null as to not return secrets. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$BasicAuthConfig = Initialize-PSSailpoint.V2024BasicAuthConfig -UserName user@example.com `
|
||||
-Password null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$BasicAuthConfig | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,35 +0,0 @@
|
||||
---
|
||||
id: v2024-bearer-token-auth-config
|
||||
title: BearerTokenAuthConfig
|
||||
pagination_label: BearerTokenAuthConfig
|
||||
sidebar_label: BearerTokenAuthConfig
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'BearerTokenAuthConfig']
|
||||
slug: /tools/sdk/powershell/v2024/models/bearer-token-auth-config
|
||||
tags: ['SDK', 'Software Development Kit', 'BearerTokenAuthConfig']
|
||||
---
|
||||
|
||||
|
||||
# BearerTokenAuthConfig
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**BearerToken** | Pointer to **String** | Bearer token | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$BearerTokenAuthConfig = Initialize-PSSailpoint.V2024BearerTokenAuthConfig -BearerToken null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$BearerTokenAuthConfig | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
id: v2024-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/v2024/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.V2024BeforeProvisioningRuleDto -Type RULE `
|
||||
-Id 048eb3d55c5a4758bd07dccb87741c78 `
|
||||
-Name Before Provisioning Airtable Rule
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$BeforeProvisioningRuleDto | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
id: v2024-bound
|
||||
title: Bound
|
||||
pagination_label: Bound
|
||||
sidebar_label: Bound
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'Bound']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024Bound -Value 1 `
|
||||
-Inclusive false
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$Bound | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,49 +0,0 @@
|
||||
---
|
||||
id: v2024-branding-item
|
||||
title: BrandingItem
|
||||
pagination_label: BrandingItem
|
||||
sidebar_label: BrandingItem
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'BrandingItem']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024BrandingItem -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]](#)
|
||||
|
||||
@@ -1,49 +0,0 @@
|
||||
---
|
||||
id: v2024-branding-item-create
|
||||
title: BrandingItemCreate
|
||||
pagination_label: BrandingItemCreate
|
||||
sidebar_label: BrandingItemCreate
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'BrandingItemCreate']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024BrandingItemCreate -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]](#)
|
||||
|
||||
@@ -1,43 +0,0 @@
|
||||
---
|
||||
id: v2024-bucket-aggregation
|
||||
title: BucketAggregation
|
||||
pagination_label: BucketAggregation
|
||||
sidebar_label: BucketAggregation
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'BucketAggregation']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024BucketAggregation -Name Identity Locations `
|
||||
-Type null `
|
||||
-Field attributes.city `
|
||||
-Size 100 `
|
||||
-MinDocCount 2
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$BucketAggregation | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,22 +0,0 @@
|
||||
---
|
||||
id: v2024-bucket-type
|
||||
title: BucketType
|
||||
pagination_label: BucketType
|
||||
sidebar_label: BucketType
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'BucketType']
|
||||
slug: /tools/sdk/powershell/v2024/models/bucket-type
|
||||
tags: ['SDK', 'Software Development Kit', 'BucketType']
|
||||
---
|
||||
|
||||
|
||||
# BucketType
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `TERMS` (value: `"TERMS"`)
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
id: v2024-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/v2024/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.V2024BulkAddTaggedObject -ObjectRefs null `
|
||||
-Tags [BU_FINANCE, PCI] `
|
||||
-Operation MERGE
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$BulkAddTaggedObject | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
id: v2024-bulk-approve-access-request
|
||||
title: BulkApproveAccessRequest
|
||||
pagination_label: BulkApproveAccessRequest
|
||||
sidebar_label: BulkApproveAccessRequest
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'BulkApproveAccessRequest']
|
||||
slug: /tools/sdk/powershell/v2024/models/bulk-approve-access-request
|
||||
tags: ['SDK', 'Software Development Kit', 'BulkApproveAccessRequest']
|
||||
---
|
||||
|
||||
|
||||
# BulkApproveAccessRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ApprovalIds** | **[]String** | List of approval ids to approve the pending requests | [required]
|
||||
**Comment** | **String** | Reason for approving the pending access request. | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$BulkApproveAccessRequest = Initialize-PSSailpoint.V2024BulkApproveAccessRequest -ApprovalIds [2c9180835d2e5168015d32f890ca1581, 2c9180835d2e5168015d32f890ca1582] `
|
||||
-Comment I approve these request items
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$BulkApproveAccessRequest | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
id: v2024-bulk-cancel-access-request
|
||||
title: BulkCancelAccessRequest
|
||||
pagination_label: BulkCancelAccessRequest
|
||||
sidebar_label: BulkCancelAccessRequest
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'BulkCancelAccessRequest']
|
||||
slug: /tools/sdk/powershell/v2024/models/bulk-cancel-access-request
|
||||
tags: ['SDK', 'Software Development Kit', 'BulkCancelAccessRequest']
|
||||
---
|
||||
|
||||
|
||||
# BulkCancelAccessRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**AccessRequestIds** | **[]String** | List of access requests ids to cancel the pending requests | [required]
|
||||
**Comment** | **String** | Reason for cancelling the pending access request. | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$BulkCancelAccessRequest = Initialize-PSSailpoint.V2024BulkCancelAccessRequest -AccessRequestIds [2c9180835d2e5168015d32f890ca1581, 2c9180835d2e5168015d32f890ca1582] `
|
||||
-Comment I requested this role by mistake.
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$BulkCancelAccessRequest | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
id: v2024-bulk-identities-accounts-response
|
||||
title: BulkIdentitiesAccountsResponse
|
||||
pagination_label: BulkIdentitiesAccountsResponse
|
||||
sidebar_label: BulkIdentitiesAccountsResponse
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'BulkIdentitiesAccountsResponse']
|
||||
slug: /tools/sdk/powershell/v2024/models/bulk-identities-accounts-response
|
||||
tags: ['SDK', 'Software Development Kit', 'BulkIdentitiesAccountsResponse']
|
||||
---
|
||||
|
||||
|
||||
# BulkIdentitiesAccountsResponse
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | Identifier of bulk request item. | [optional]
|
||||
**StatusCode** | Pointer to **Int32** | Response status value. | [optional]
|
||||
**Message** | Pointer to **String** | Status containing additional context information about failures. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$BulkIdentitiesAccountsResponse = Initialize-PSSailpoint.V2024BulkIdentitiesAccountsResponse -Id 2c9180858082150f0180893dbaf553fe `
|
||||
-StatusCode 404 `
|
||||
-Message Referenced identity "2c9180858082150f0180893dbaf553fe" was not found.
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$BulkIdentitiesAccountsResponse | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
id: v2024-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/v2024/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.V2024BulkRemoveTaggedObject -ObjectRefs null `
|
||||
-Tags [BU_FINANCE, PCI]
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$BulkRemoveTaggedObject | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
id: v2024-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/v2024/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.V2024BulkTaggedObjectResponse -ObjectRefs null `
|
||||
-Tags [BU_FINANCE, PCI]
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$BulkTaggedObjectResponse | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,79 +0,0 @@
|
||||
---
|
||||
id: v2024-campaign
|
||||
title: Campaign
|
||||
pagination_label: Campaign
|
||||
sidebar_label: Campaign
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'Campaign']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024Campaign -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]](#)
|
||||
|
||||
@@ -1,35 +0,0 @@
|
||||
---
|
||||
id: v2024-campaign-activated
|
||||
title: CampaignActivated
|
||||
pagination_label: CampaignActivated
|
||||
sidebar_label: CampaignActivated
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignActivated']
|
||||
slug: /tools/sdk/powershell/v2024/models/campaign-activated
|
||||
tags: ['SDK', 'Software Development Kit', 'CampaignActivated']
|
||||
---
|
||||
|
||||
|
||||
# CampaignActivated
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Campaign** | [**CampaignActivatedCampaign**](campaign-activated-campaign) | | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$CampaignActivated = Initialize-PSSailpoint.V2024CampaignActivated -Campaign null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CampaignActivated | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,51 +0,0 @@
|
||||
---
|
||||
id: v2024-campaign-activated-campaign
|
||||
title: CampaignActivatedCampaign
|
||||
pagination_label: CampaignActivatedCampaign
|
||||
sidebar_label: CampaignActivatedCampaign
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignActivatedCampaign']
|
||||
slug: /tools/sdk/powershell/v2024/models/campaign-activated-campaign
|
||||
tags: ['SDK', 'Software Development Kit', 'CampaignActivatedCampaign']
|
||||
---
|
||||
|
||||
|
||||
# CampaignActivatedCampaign
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | Unique ID for the campaign. | [required]
|
||||
**Name** | **String** | The human friendly name of the campaign. | [required]
|
||||
**Description** | **String** | Extended description of the campaign. | [required]
|
||||
**Created** | **System.DateTime** | The date and time the campaign was created. | [required]
|
||||
**Modified** | Pointer to **System.DateTime** | The date and time the campaign was last modified. | [optional]
|
||||
**Deadline** | **System.DateTime** | The date and time the campaign is due. | [required]
|
||||
**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION" ] | The type of campaign. | [required]
|
||||
**CampaignOwner** | [**CampaignActivatedCampaignCampaignOwner**](campaign-activated-campaign-campaign-owner) | | [required]
|
||||
**Status** | **Enum** [ "ACTIVE" ] | The current status of the campaign. | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$CampaignActivatedCampaign = Initialize-PSSailpoint.V2024CampaignActivatedCampaign -Id 2c91808576f886190176f88cac5a0010 `
|
||||
-Name Manager Access Campaign `
|
||||
-Description Audit access for all employees. `
|
||||
-Created 2021-02-16T03:04:45.815Z `
|
||||
-Modified 2021-02-16T03:06:45.815Z `
|
||||
-Deadline 2021-03-16T03:04:45.815Z `
|
||||
-Type MANAGER `
|
||||
-CampaignOwner null `
|
||||
-Status ACTIVE
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CampaignActivatedCampaign | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
id: v2024-campaign-activated-campaign-campaign-owner
|
||||
title: CampaignActivatedCampaignCampaignOwner
|
||||
pagination_label: CampaignActivatedCampaignCampaignOwner
|
||||
sidebar_label: CampaignActivatedCampaignCampaignOwner
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignActivatedCampaignCampaignOwner']
|
||||
slug: /tools/sdk/powershell/v2024/models/campaign-activated-campaign-campaign-owner
|
||||
tags: ['SDK', 'Software Development Kit', 'CampaignActivatedCampaignCampaignOwner']
|
||||
---
|
||||
|
||||
|
||||
# CampaignActivatedCampaignCampaignOwner
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | The unique ID of the identity. | [required]
|
||||
**DisplayName** | **String** | The human friendly name of the identity. | [required]
|
||||
**Email** | **String** | The primary email address of the identity. | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$CampaignActivatedCampaignCampaignOwner = Initialize-PSSailpoint.V2024CampaignActivatedCampaignCampaignOwner -Id 37f080867702c1910177031320c40n27 `
|
||||
-DisplayName John Snow `
|
||||
-Email john.snow@example.com
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CampaignActivatedCampaignCampaignOwner | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
id: v2024-campaign-alert
|
||||
title: CampaignAlert
|
||||
pagination_label: CampaignAlert
|
||||
sidebar_label: CampaignAlert
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAlert']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024CampaignAlert -Level ERROR `
|
||||
-Localizations null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CampaignAlert | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
id: v2024-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/v2024/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.V2024CampaignAllOfFilter -Id 0fbe863c063c4c88a35fd7f17e8a3df5 `
|
||||
-Type CAMPAIGN_FILTER `
|
||||
-Name Test Filter
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CampaignAllOfFilter | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
id: v2024-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/v2024/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.V2024CampaignAllOfMachineAccountCampaignInfo -SourceIds [0fbe863c063c4c88a35fd7f17e8a3df5] `
|
||||
-ReviewerType ACCOUNT_OWNER
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CampaignAllOfMachineAccountCampaignInfo | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,43 +0,0 @@
|
||||
---
|
||||
id: v2024-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/v2024/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.V2024CampaignAllOfRoleCompositionCampaignInfo -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]](#)
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
id: v2024-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/v2024/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.V2024CampaignAllOfRoleCompositionCampaignInfoRemediatorRef -Type IDENTITY `
|
||||
-Id 2c90ad2a70ace7d50170acf22ca90010 `
|
||||
-Name Role Admin
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CampaignAllOfRoleCompositionCampaignInfoRemediatorRef | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,45 +0,0 @@
|
||||
---
|
||||
id: v2024-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/v2024/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.V2024CampaignAllOfSearchCampaignInfo -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]](#)
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
id: v2024-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/v2024/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.V2024CampaignAllOfSearchCampaignInfoReviewer -Type IDENTITY `
|
||||
-Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name William Wilson
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CampaignAllOfSearchCampaignInfoReviewer | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,35 +0,0 @@
|
||||
---
|
||||
id: v2024-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/v2024/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.V2024CampaignAllOfSourceOwnerCampaignInfo -SourceIds [0fbe863c063c4c88a35fd7f17e8a3df5]
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CampaignAllOfSourceOwnerCampaignInfo | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
id: v2024-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/v2024/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.V2024CampaignAllOfSourcesWithOrphanEntitlements -Id 2c90ad2a70ace7d50170acf22ca90010 `
|
||||
-Type SOURCE `
|
||||
-Name Source with orphan entitlements
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CampaignAllOfSourcesWithOrphanEntitlements | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,35 +0,0 @@
|
||||
---
|
||||
id: v2024-campaign-complete-options
|
||||
title: CampaignCompleteOptions
|
||||
pagination_label: CampaignCompleteOptions
|
||||
sidebar_label: CampaignCompleteOptions
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignCompleteOptions']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024CampaignCompleteOptions -AutoCompleteAction REVOKE
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CampaignCompleteOptions | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,35 +0,0 @@
|
||||
---
|
||||
id: v2024-campaign-ended
|
||||
title: CampaignEnded
|
||||
pagination_label: CampaignEnded
|
||||
sidebar_label: CampaignEnded
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignEnded']
|
||||
slug: /tools/sdk/powershell/v2024/models/campaign-ended
|
||||
tags: ['SDK', 'Software Development Kit', 'CampaignEnded']
|
||||
---
|
||||
|
||||
|
||||
# CampaignEnded
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Campaign** | [**CampaignEndedCampaign**](campaign-ended-campaign) | | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$CampaignEnded = Initialize-PSSailpoint.V2024CampaignEnded -Campaign null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CampaignEnded | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,51 +0,0 @@
|
||||
---
|
||||
id: v2024-campaign-ended-campaign
|
||||
title: CampaignEndedCampaign
|
||||
pagination_label: CampaignEndedCampaign
|
||||
sidebar_label: CampaignEndedCampaign
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignEndedCampaign']
|
||||
slug: /tools/sdk/powershell/v2024/models/campaign-ended-campaign
|
||||
tags: ['SDK', 'Software Development Kit', 'CampaignEndedCampaign']
|
||||
---
|
||||
|
||||
|
||||
# CampaignEndedCampaign
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | Unique ID for the campaign. | [required]
|
||||
**Name** | **String** | The human friendly name of the campaign. | [required]
|
||||
**Description** | **String** | Extended description of the campaign. | [required]
|
||||
**Created** | **System.DateTime** | The date and time the campaign was created. | [required]
|
||||
**Modified** | Pointer to **System.DateTime** | The date and time the campaign was last modified. | [optional]
|
||||
**Deadline** | **System.DateTime** | The date and time the campaign is due. | [required]
|
||||
**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION" ] | The type of campaign. | [required]
|
||||
**CampaignOwner** | [**CampaignActivatedCampaignCampaignOwner**](campaign-activated-campaign-campaign-owner) | | [required]
|
||||
**Status** | **Enum** [ "COMPLETED" ] | The current status of the campaign. | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$CampaignEndedCampaign = Initialize-PSSailpoint.V2024CampaignEndedCampaign -Id 2c91808576f886190176f88cac5a0010 `
|
||||
-Name Manager Access Campaign `
|
||||
-Description Audit access for all employees. `
|
||||
-Created 2021-02-16T03:04:45.815Z `
|
||||
-Modified 2021-03-16T03:06:45.815Z `
|
||||
-Deadline 2021-03-16T03:04:45.815Z `
|
||||
-Type MANAGER `
|
||||
-CampaignOwner null `
|
||||
-Status COMPLETED
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CampaignEndedCampaign | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,47 +0,0 @@
|
||||
---
|
||||
id: v2024-campaign-filter-details
|
||||
title: CampaignFilterDetails
|
||||
pagination_label: CampaignFilterDetails
|
||||
sidebar_label: CampaignFilterDetails
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignFilterDetails']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024CampaignFilterDetails -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]](#)
|
||||
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
id: v2024-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/v2024/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.V2024CampaignFilterDetailsCriteriaListInner -Type null `
|
||||
-Operation null `
|
||||
-Property displayName `
|
||||
-Value Allie
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CampaignFilterDetailsCriteriaListInner | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,35 +0,0 @@
|
||||
---
|
||||
id: v2024-campaign-generated
|
||||
title: CampaignGenerated
|
||||
pagination_label: CampaignGenerated
|
||||
sidebar_label: CampaignGenerated
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignGenerated']
|
||||
slug: /tools/sdk/powershell/v2024/models/campaign-generated
|
||||
tags: ['SDK', 'Software Development Kit', 'CampaignGenerated']
|
||||
---
|
||||
|
||||
|
||||
# CampaignGenerated
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Campaign** | [**CampaignGeneratedCampaign**](campaign-generated-campaign) | | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$CampaignGenerated = Initialize-PSSailpoint.V2024CampaignGenerated -Campaign null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CampaignGenerated | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,51 +0,0 @@
|
||||
---
|
||||
id: v2024-campaign-generated-campaign
|
||||
title: CampaignGeneratedCampaign
|
||||
pagination_label: CampaignGeneratedCampaign
|
||||
sidebar_label: CampaignGeneratedCampaign
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignGeneratedCampaign']
|
||||
slug: /tools/sdk/powershell/v2024/models/campaign-generated-campaign
|
||||
tags: ['SDK', 'Software Development Kit', 'CampaignGeneratedCampaign']
|
||||
---
|
||||
|
||||
|
||||
# CampaignGeneratedCampaign
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | The unique ID of the campaign. | [required]
|
||||
**Name** | **String** | Human friendly name of the campaign. | [required]
|
||||
**Description** | **String** | Extended description of the campaign. | [required]
|
||||
**Created** | **System.DateTime** | The date and time the campaign was created. | [required]
|
||||
**Modified** | Pointer to **String** | The date and time the campaign was last modified. | [optional]
|
||||
**Deadline** | Pointer to **String** | The date and time when the campaign must be finished by. | [optional]
|
||||
**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION" ] | The type of campaign that was generated. | [required]
|
||||
**CampaignOwner** | [**CampaignGeneratedCampaignCampaignOwner**](campaign-generated-campaign-campaign-owner) | | [required]
|
||||
**Status** | **Enum** [ "STAGED", "ACTIVATING", "ACTIVE" ] | The current status of the campaign. | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$CampaignGeneratedCampaign = Initialize-PSSailpoint.V2024CampaignGeneratedCampaign -Id 2c91808576f886190176f88cac5a0010 `
|
||||
-Name Manager Access Campaign `
|
||||
-Description Audit access for all employees. `
|
||||
-Created 2021-02-16T03:04:45.815Z `
|
||||
-Modified 2021-02-17T03:04:45.815Z `
|
||||
-Deadline 2021-02-18T03:04:45.815Z `
|
||||
-Type MANAGER `
|
||||
-CampaignOwner null `
|
||||
-Status STAGED
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CampaignGeneratedCampaign | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
id: v2024-campaign-generated-campaign-campaign-owner
|
||||
title: CampaignGeneratedCampaignCampaignOwner
|
||||
pagination_label: CampaignGeneratedCampaignCampaignOwner
|
||||
sidebar_label: CampaignGeneratedCampaignCampaignOwner
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignGeneratedCampaignCampaignOwner']
|
||||
slug: /tools/sdk/powershell/v2024/models/campaign-generated-campaign-campaign-owner
|
||||
tags: ['SDK', 'Software Development Kit', 'CampaignGeneratedCampaignCampaignOwner']
|
||||
---
|
||||
|
||||
|
||||
# CampaignGeneratedCampaignCampaignOwner
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | The unique ID of the identity. | [required]
|
||||
**DisplayName** | **String** | The display name of the identity. | [required]
|
||||
**Email** | **String** | The primary email address of the identity. | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$CampaignGeneratedCampaignCampaignOwner = Initialize-PSSailpoint.V2024CampaignGeneratedCampaignCampaignOwner -Id 37f080867702c1910177031320c40n27 `
|
||||
-DisplayName John Snow `
|
||||
-Email john.snow@example.com
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CampaignGeneratedCampaignCampaignOwner | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,47 +0,0 @@
|
||||
---
|
||||
id: v2024-campaign-reference
|
||||
title: CampaignReference
|
||||
pagination_label: CampaignReference
|
||||
sidebar_label: CampaignReference
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignReference']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024CampaignReference -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]](#)
|
||||
|
||||
@@ -1,45 +0,0 @@
|
||||
---
|
||||
id: v2024-campaign-report
|
||||
title: CampaignReport
|
||||
pagination_label: CampaignReport
|
||||
sidebar_label: CampaignReport
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignReport']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024CampaignReport -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]](#)
|
||||
|
||||
@@ -1,35 +0,0 @@
|
||||
---
|
||||
id: v2024-campaign-reports-config
|
||||
title: CampaignReportsConfig
|
||||
pagination_label: CampaignReportsConfig
|
||||
sidebar_label: CampaignReportsConfig
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignReportsConfig']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024CampaignReportsConfig -IdentityAttributeColumns [firstname, lastname]
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CampaignReportsConfig | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,51 +0,0 @@
|
||||
---
|
||||
id: v2024-campaign-template
|
||||
title: CampaignTemplate
|
||||
pagination_label: CampaignTemplate
|
||||
sidebar_label: CampaignTemplate
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignTemplate']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024CampaignTemplate -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]](#)
|
||||
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
id: v2024-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/v2024/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.V2024CampaignTemplateOwnerRef -Id 2c918086676d3e0601677611dbde220f `
|
||||
-Type IDENTITY `
|
||||
-Name Mister Manager `
|
||||
-Email mr.manager@example.com
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CampaignTemplateOwnerRef | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,35 +0,0 @@
|
||||
---
|
||||
id: v2024-campaigns-delete-request
|
||||
title: CampaignsDeleteRequest
|
||||
pagination_label: CampaignsDeleteRequest
|
||||
sidebar_label: CampaignsDeleteRequest
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignsDeleteRequest']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024CampaignsDeleteRequest -Ids [2c9180887335cee10173490db1776c26, 2c9180836a712436016a7125a90c0021]
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CampaignsDeleteRequest | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
id: v2024-cancel-access-request
|
||||
title: CancelAccessRequest
|
||||
pagination_label: CancelAccessRequest
|
||||
sidebar_label: CancelAccessRequest
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CancelAccessRequest']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024CancelAccessRequest -AccountActivityId 2c9180835d2e5168015d32f890ca1581 `
|
||||
-Comment I requested this role by mistake.
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CancelAccessRequest | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
id: v2024-cancelled-request-details
|
||||
title: CancelledRequestDetails
|
||||
pagination_label: CancelledRequestDetails
|
||||
sidebar_label: CancelledRequestDetails
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CancelledRequestDetails']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024CancelledRequestDetails -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]](#)
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
id: v2024-cancelled-request-details1
|
||||
title: CancelledRequestDetails1
|
||||
pagination_label: CancelledRequestDetails1
|
||||
sidebar_label: CancelledRequestDetails1
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CancelledRequestDetails1']
|
||||
slug: /tools/sdk/powershell/v2024/models/cancelled-request-details1
|
||||
tags: ['SDK', 'Software Development Kit', 'CancelledRequestDetails1']
|
||||
---
|
||||
|
||||
|
||||
# CancelledRequestDetails1
|
||||
|
||||
## 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
|
||||
$CancelledRequestDetails1 = Initialize-PSSailpoint.V2024CancelledRequestDetails1 -Comment This request must be cancelled. `
|
||||
-Owner null `
|
||||
-Modified 2019-12-20T09:17:12.192Z
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CancelledRequestDetails1 | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,67 +0,0 @@
|
||||
---
|
||||
id: v2024-certification
|
||||
title: Certification
|
||||
pagination_label: Certification
|
||||
sidebar_label: Certification
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'Certification']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024Certification -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]](#)
|
||||
|
||||
@@ -1,24 +0,0 @@
|
||||
---
|
||||
id: v2024-certification-decision
|
||||
title: CertificationDecision
|
||||
pagination_label: CertificationDecision
|
||||
sidebar_label: CertificationDecision
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationDecision']
|
||||
slug: /tools/sdk/powershell/v2024/models/certification-decision
|
||||
tags: ['SDK', 'Software Development Kit', 'CertificationDecision']
|
||||
---
|
||||
|
||||
|
||||
# CertificationDecision
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `APPROVE` (value: `"APPROVE"`)
|
||||
|
||||
* `REVOKE` (value: `"REVOKE"`)
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,59 +0,0 @@
|
||||
---
|
||||
id: v2024-certification-dto
|
||||
title: CertificationDto
|
||||
pagination_label: CertificationDto
|
||||
sidebar_label: CertificationDto
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationDto']
|
||||
slug: /tools/sdk/powershell/v2024/models/certification-dto
|
||||
tags: ['SDK', 'Software Development Kit', 'CertificationDto']
|
||||
---
|
||||
|
||||
|
||||
# CertificationDto
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**CampaignRef** | [**CampaignReference**](campaign-reference) | | [required]
|
||||
**Phase** | [**CertificationPhase**](certification-phase) | | [required]
|
||||
**Due** | **System.DateTime** | The due date of the certification. | [required]
|
||||
**Signed** | **System.DateTime** | The date the reviewer signed off on the certification. | [required]
|
||||
**Reviewer** | [**Reviewer1**](reviewer1) | | [required]
|
||||
**Reassignment** | Pointer to [**Reassignment1**](reassignment1) | | [optional]
|
||||
**HasErrors** | **Boolean** | Indicates it the certification has any errors. | [required]
|
||||
**ErrorMessage** | Pointer to **String** | A message indicating what the error is. | [optional]
|
||||
**Completed** | **Boolean** | Indicates if all certification decisions have been made. | [required]
|
||||
**DecisionsMade** | **Int32** | The number of approve/revoke/acknowledge decisions that have been made by the reviewer. | [required]
|
||||
**DecisionsTotal** | **Int32** | The total number of approve/revoke/acknowledge decisions for the certification. | [required]
|
||||
**EntitiesCompleted** | **Int32** | The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. | [required]
|
||||
**EntitiesTotal** | **Int32** | The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$CertificationDto = Initialize-PSSailpoint.V2024CertificationDto -CampaignRef null `
|
||||
-Phase null `
|
||||
-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 `
|
||||
-Completed false `
|
||||
-DecisionsMade 20 `
|
||||
-DecisionsTotal 40 `
|
||||
-EntitiesCompleted 5 `
|
||||
-EntitiesTotal 10
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CertificationDto | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
id: v2024-certification-identity-summary
|
||||
title: CertificationIdentitySummary
|
||||
pagination_label: CertificationIdentitySummary
|
||||
sidebar_label: CertificationIdentitySummary
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationIdentitySummary']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024CertificationIdentitySummary -Id 2c91808772a504f50172a9540e501ba7 `
|
||||
-Name Alison Ferguso `
|
||||
-IdentityId 2c9180857182306001719937377a33de `
|
||||
-Completed true
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CertificationIdentitySummary | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,26 +0,0 @@
|
||||
---
|
||||
id: v2024-certification-phase
|
||||
title: CertificationPhase
|
||||
pagination_label: CertificationPhase
|
||||
sidebar_label: CertificationPhase
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationPhase']
|
||||
slug: /tools/sdk/powershell/v2024/models/certification-phase
|
||||
tags: ['SDK', 'Software Development Kit', 'CertificationPhase']
|
||||
---
|
||||
|
||||
|
||||
# CertificationPhase
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `STAGED` (value: `"STAGED"`)
|
||||
|
||||
* `ACTIVE` (value: `"ACTIVE"`)
|
||||
|
||||
* `SIGNED` (value: `"SIGNED"`)
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
id: v2024-certification-reference
|
||||
title: CertificationReference
|
||||
pagination_label: CertificationReference
|
||||
sidebar_label: CertificationReference
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationReference']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024CertificationReference -Id ef38f94347e94562b5bb8424a56397d8 `
|
||||
-Name Certification Name `
|
||||
-Type CERTIFICATION `
|
||||
-Reviewer null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CertificationReference | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
id: v2024-certification-reference1
|
||||
title: CertificationReference1
|
||||
pagination_label: CertificationReference1
|
||||
sidebar_label: CertificationReference1
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationReference1']
|
||||
slug: /tools/sdk/powershell/v2024/models/certification-reference1
|
||||
tags: ['SDK', 'Software Development Kit', 'CertificationReference1']
|
||||
---
|
||||
|
||||
|
||||
# CertificationReference1
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | Pointer to **Enum** [ "CERTIFICATION" ] | DTO type of certification for review. | [optional]
|
||||
**Id** | Pointer to **String** | ID of certification for review. | [optional]
|
||||
**Name** | Pointer to **String** | Display name of certification for review. | [optional]
|
||||
**Reviewer** | Pointer to [**Reviewer1**](reviewer1) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$CertificationReference1 = Initialize-PSSailpoint.V2024CertificationReference1 -Type IDENTITY `
|
||||
-Id 7589a83cec4b4f138ce56c1a5ef0756d `
|
||||
-Name Manager Access for Michael Michaels `
|
||||
-Reviewer null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CertificationReference1 | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
id: v2024-certification-reference-dto
|
||||
title: CertificationReferenceDto
|
||||
pagination_label: CertificationReferenceDto
|
||||
sidebar_label: CertificationReferenceDto
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationReferenceDto']
|
||||
slug: /tools/sdk/powershell/v2024/models/certification-reference-dto
|
||||
tags: ['SDK', 'Software Development Kit', 'CertificationReferenceDto']
|
||||
---
|
||||
|
||||
|
||||
# CertificationReferenceDto
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | Pointer to **Enum** [ "CERTIFICATION" ] | DTO type of certification for review. | [optional]
|
||||
**Id** | Pointer to **String** | ID of certification for review. | [optional]
|
||||
**Name** | Pointer to **String** | Display name of certification for review. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$CertificationReferenceDto = Initialize-PSSailpoint.V2024CertificationReferenceDto -Type IDENTITY `
|
||||
-Id 7589a83cec4b4f138ce56c1a5ef0756d `
|
||||
-Name Manager Access for Michael Michaels
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CertificationReferenceDto | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,35 +0,0 @@
|
||||
---
|
||||
id: v2024-certification-signed-off
|
||||
title: CertificationSignedOff
|
||||
pagination_label: CertificationSignedOff
|
||||
sidebar_label: CertificationSignedOff
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationSignedOff']
|
||||
slug: /tools/sdk/powershell/v2024/models/certification-signed-off
|
||||
tags: ['SDK', 'Software Development Kit', 'CertificationSignedOff']
|
||||
---
|
||||
|
||||
|
||||
# CertificationSignedOff
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Certification** | [**CertificationSignedOffCertification**](certification-signed-off-certification) | | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$CertificationSignedOff = Initialize-PSSailpoint.V2024CertificationSignedOff -Certification null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CertificationSignedOff | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,67 +0,0 @@
|
||||
---
|
||||
id: v2024-certification-signed-off-certification
|
||||
title: CertificationSignedOffCertification
|
||||
pagination_label: CertificationSignedOffCertification
|
||||
sidebar_label: CertificationSignedOffCertification
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationSignedOffCertification']
|
||||
slug: /tools/sdk/powershell/v2024/models/certification-signed-off-certification
|
||||
tags: ['SDK', 'Software Development Kit', 'CertificationSignedOffCertification']
|
||||
---
|
||||
|
||||
|
||||
# CertificationSignedOffCertification
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | Unique ID of the certification. | [required]
|
||||
**Name** | **String** | The name of the certification. | [required]
|
||||
**Created** | **System.DateTime** | The date and time the certification was created. | [required]
|
||||
**Modified** | Pointer to **System.DateTime** | The date and time the certification was last modified. | [optional]
|
||||
**CampaignRef** | [**CampaignReference**](campaign-reference) | | [required]
|
||||
**Phase** | [**CertificationPhase**](certification-phase) | | [required]
|
||||
**Due** | **System.DateTime** | The due date of the certification. | [required]
|
||||
**Signed** | **System.DateTime** | The date the reviewer signed off on the certification. | [required]
|
||||
**Reviewer** | [**Reviewer1**](reviewer1) | | [required]
|
||||
**Reassignment** | Pointer to [**Reassignment1**](reassignment1) | | [optional]
|
||||
**HasErrors** | **Boolean** | Indicates it the certification has any errors. | [required]
|
||||
**ErrorMessage** | Pointer to **String** | A message indicating what the error is. | [optional]
|
||||
**Completed** | **Boolean** | Indicates if all certification decisions have been made. | [required]
|
||||
**DecisionsMade** | **Int32** | The number of approve/revoke/acknowledge decisions that have been made by the reviewer. | [required]
|
||||
**DecisionsTotal** | **Int32** | The total number of approve/revoke/acknowledge decisions for the certification. | [required]
|
||||
**EntitiesCompleted** | **Int32** | The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. | [required]
|
||||
**EntitiesTotal** | **Int32** | The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$CertificationSignedOffCertification = Initialize-PSSailpoint.V2024CertificationSignedOffCertification -Id 2c91808576f886190176f88caf0d0067 `
|
||||
-Name Manager Access Review for Alice Baker `
|
||||
-Created 2020-02-16T03:04:45.815Z `
|
||||
-Modified 2020-02-16T03:06:45.815Z `
|
||||
-CampaignRef null `
|
||||
-Phase null `
|
||||
-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 `
|
||||
-Completed false `
|
||||
-DecisionsMade 20 `
|
||||
-DecisionsTotal 40 `
|
||||
-EntitiesCompleted 5 `
|
||||
-EntitiesTotal 10
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CertificationSignedOffCertification | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,49 +0,0 @@
|
||||
---
|
||||
id: v2024-certification-task
|
||||
title: CertificationTask
|
||||
pagination_label: CertificationTask
|
||||
sidebar_label: CertificationTask
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationTask']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024CertificationTask -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]](#)
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
id: v2024-certifier-response
|
||||
title: CertifierResponse
|
||||
pagination_label: CertifierResponse
|
||||
sidebar_label: CertifierResponse
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CertifierResponse']
|
||||
slug: /tools/sdk/powershell/v2024/models/certifier-response
|
||||
tags: ['SDK', 'Software Development Kit', 'CertifierResponse']
|
||||
---
|
||||
|
||||
|
||||
# CertifierResponse
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | the id of the certifier | [optional]
|
||||
**DisplayName** | Pointer to **String** | the name of the certifier | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$CertifierResponse = Initialize-PSSailpoint.V2024CertifierResponse -Id 8a80828f643d484f01643e14202e206f `
|
||||
-DisplayName John Snow
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CertifierResponse | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,43 +0,0 @@
|
||||
---
|
||||
id: v2024-client-log-configuration
|
||||
title: ClientLogConfiguration
|
||||
pagination_label: ClientLogConfiguration
|
||||
sidebar_label: ClientLogConfiguration
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ClientLogConfiguration']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024ClientLogConfiguration -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]](#)
|
||||
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
id: v2024-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/v2024/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.V2024ClientLogConfigurationDurationMinutes -ClientId 3a38a51992e8445ab51a549c0a70ee66 `
|
||||
-DurationMinutes 120 `
|
||||
-RootLevel null `
|
||||
-LogLevels INFO
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ClientLogConfigurationDurationMinutes | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
id: v2024-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/v2024/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.V2024ClientLogConfigurationExpiration -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]](#)
|
||||
|
||||
@@ -1,24 +0,0 @@
|
||||
---
|
||||
id: v2024-client-type
|
||||
title: ClientType
|
||||
pagination_label: ClientType
|
||||
sidebar_label: ClientType
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ClientType']
|
||||
slug: /tools/sdk/powershell/v2024/models/client-type
|
||||
tags: ['SDK', 'Software Development Kit', 'ClientType']
|
||||
---
|
||||
|
||||
|
||||
# ClientType
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `CONFIDENTIAL` (value: `"CONFIDENTIAL"`)
|
||||
|
||||
* `PUBLIC` (value: `"PUBLIC"`)
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
id: v2024-close-access-request
|
||||
title: CloseAccessRequest
|
||||
pagination_label: CloseAccessRequest
|
||||
sidebar_label: CloseAccessRequest
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CloseAccessRequest']
|
||||
slug: /tools/sdk/powershell/v2024/models/close-access-request
|
||||
tags: ['SDK', 'Software Development Kit', 'CloseAccessRequest']
|
||||
---
|
||||
|
||||
|
||||
# CloseAccessRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**AccessRequestIds** | **[]String** | Access Request IDs for the requests to be closed. Accepts 1-500 Identity Request IDs per request. | [required]
|
||||
**Message** | Pointer to **String** | Reason for closing the access request. Displayed under Warnings in IdentityNow. | [optional] [default to "The IdentityNow Administrator manually closed this request."]
|
||||
**ExecutionStatus** | Pointer to **Enum** [ "Terminated", "Completed" ] | The request's provisioning status. Displayed as Stage in IdentityNow. | [optional] [default to "Terminated"]
|
||||
**CompletionStatus** | Pointer to **Enum** [ "Success", "Incomplete", "Failure" ] | The request's overall status. Displayed as Status in IdentityNow. | [optional] [default to "Failure"]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$CloseAccessRequest = Initialize-PSSailpoint.V2024CloseAccessRequest -AccessRequestIds [2c90ad2a70ace7d50170acf22ca90010] `
|
||||
-Message The IdentityNow Administrator manually closed this request. `
|
||||
-ExecutionStatus Terminated `
|
||||
-CompletionStatus Failure
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CloseAccessRequest | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
id: v2024-column
|
||||
title: Column
|
||||
pagination_label: Column
|
||||
sidebar_label: Column
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'Column']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024Column -Field email `
|
||||
-Header Work Email
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$Column | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
id: v2024-comment
|
||||
title: Comment
|
||||
pagination_label: Comment
|
||||
sidebar_label: Comment
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'Comment']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024Comment -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]](#)
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
id: v2024-comment-dto
|
||||
title: CommentDto
|
||||
pagination_label: CommentDto
|
||||
sidebar_label: CommentDto
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CommentDto']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024CommentDto -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]](#)
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
id: v2024-comment-dto-author
|
||||
title: CommentDtoAuthor
|
||||
pagination_label: CommentDtoAuthor
|
||||
sidebar_label: CommentDtoAuthor
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'CommentDtoAuthor']
|
||||
slug: /tools/sdk/powershell/v2024/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.V2024CommentDtoAuthor -Type IDENTITY `
|
||||
-Id 2c9180847e25f377017e2ae8cae4650b `
|
||||
-Name john.doe
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$CommentDtoAuthor | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user