mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 12:27:47 +00:00
Update to powershell SDK docs: 14132734151
This commit is contained in:
developer-relations-sp
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: v2024-connector-customizer-create-request
|
||||
title: ConnectorCustomizerCreateRequest
|
||||
pagination_label: ConnectorCustomizerCreateRequest
|
||||
sidebar_label: ConnectorCustomizerCreateRequest
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorCustomizerCreateRequest', 'V2024ConnectorCustomizerCreateRequest']
|
||||
slug: /tools/sdk/powershell/v2024/models/connector-customizer-create-request
|
||||
tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizerCreateRequest', 'V2024ConnectorCustomizerCreateRequest']
|
||||
---
|
||||
|
||||
|
||||
# ConnectorCustomizerCreateRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | **String** | Connector customizer name. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ConnectorCustomizerCreateRequest = Initialize-PSSailpoint.V2024ConnectorCustomizerCreateRequest -Name My Custom Connector
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ConnectorCustomizerCreateRequest | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
---
|
||||
id: v2024-connector-customizer-create-response
|
||||
title: ConnectorCustomizerCreateResponse
|
||||
pagination_label: ConnectorCustomizerCreateResponse
|
||||
sidebar_label: ConnectorCustomizerCreateResponse
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorCustomizerCreateResponse', 'V2024ConnectorCustomizerCreateResponse']
|
||||
slug: /tools/sdk/powershell/v2024/models/connector-customizer-create-response
|
||||
tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizerCreateResponse', 'V2024ConnectorCustomizerCreateResponse']
|
||||
---
|
||||
|
||||
|
||||
# ConnectorCustomizerCreateResponse
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | the ID of connector customizer. | [optional]
|
||||
**Name** | **String** | name of the connector customizer. | [optional]
|
||||
**TenantID** | **String** | Connector customizer tenant id. | [optional]
|
||||
**Created** | **System.DateTime** | Date-time when the connector customizer was created. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ConnectorCustomizerCreateResponse = Initialize-PSSailpoint.V2024ConnectorCustomizerCreateResponse -Id b07dc46a-1498-4de8-bfbb-259a68e70c8a `
|
||||
-Name connector-customizer-name `
|
||||
-TenantID 2c91808568c529c60168cca6f90c1324 `
|
||||
-Created null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ConnectorCustomizerCreateResponse | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: v2024-connector-customizer-update-request
|
||||
title: ConnectorCustomizerUpdateRequest
|
||||
pagination_label: ConnectorCustomizerUpdateRequest
|
||||
sidebar_label: ConnectorCustomizerUpdateRequest
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorCustomizerUpdateRequest', 'V2024ConnectorCustomizerUpdateRequest']
|
||||
slug: /tools/sdk/powershell/v2024/models/connector-customizer-update-request
|
||||
tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizerUpdateRequest', 'V2024ConnectorCustomizerUpdateRequest']
|
||||
---
|
||||
|
||||
|
||||
# ConnectorCustomizerUpdateRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | **String** | Connector customizer name. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ConnectorCustomizerUpdateRequest = Initialize-PSSailpoint.V2024ConnectorCustomizerUpdateRequest -Name My Custom Connector
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ConnectorCustomizerUpdateRequest | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
id: v2024-connector-customizer-update-response
|
||||
title: ConnectorCustomizerUpdateResponse
|
||||
pagination_label: ConnectorCustomizerUpdateResponse
|
||||
sidebar_label: ConnectorCustomizerUpdateResponse
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorCustomizerUpdateResponse', 'V2024ConnectorCustomizerUpdateResponse']
|
||||
slug: /tools/sdk/powershell/v2024/models/connector-customizer-update-response
|
||||
tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizerUpdateResponse', 'V2024ConnectorCustomizerUpdateResponse']
|
||||
---
|
||||
|
||||
|
||||
# ConnectorCustomizerUpdateResponse
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | the ID of connector customizer. | [optional]
|
||||
**Name** | **String** | name of the connector customizer. | [optional]
|
||||
**TenantID** | **String** | Connector customizer tenant id. | [optional]
|
||||
**Created** | **System.DateTime** | Date-time when the connector customizer was created. | [optional]
|
||||
**ImageVersion** | **Int64** | Connector customizer image version. | [optional]
|
||||
**ImageID** | **String** | Connector customizer image id. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ConnectorCustomizerUpdateResponse = Initialize-PSSailpoint.V2024ConnectorCustomizerUpdateResponse -Id b07dc46a-1498-4de8-bfbb-259a68e70c8a `
|
||||
-Name connector-customizer-name `
|
||||
-TenantID 2c91808568c529c60168cca6f90c1324 `
|
||||
-Created null `
|
||||
-ImageVersion 1 `
|
||||
-ImageID 2c91808568c529c60168cca6f90c1324
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ConnectorCustomizerUpdateResponse | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
---
|
||||
id: v2024-connector-customizer-version-create-response
|
||||
title: ConnectorCustomizerVersionCreateResponse
|
||||
pagination_label: ConnectorCustomizerVersionCreateResponse
|
||||
sidebar_label: ConnectorCustomizerVersionCreateResponse
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorCustomizerVersionCreateResponse', 'V2024ConnectorCustomizerVersionCreateResponse']
|
||||
slug: /tools/sdk/powershell/v2024/models/connector-customizer-version-create-response
|
||||
tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizerVersionCreateResponse', 'V2024ConnectorCustomizerVersionCreateResponse']
|
||||
---
|
||||
|
||||
|
||||
# ConnectorCustomizerVersionCreateResponse
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**CustomizerID** | **String** | ID of connector customizer. | [optional]
|
||||
**ImageID** | **String** | ImageID of the connector customizer. | [optional]
|
||||
**Version** | **Int64** | Image version of the connector customizer. | [optional]
|
||||
**Created** | **System.DateTime** | Date-time when the connector customizer version was created. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ConnectorCustomizerVersionCreateResponse = Initialize-PSSailpoint.V2024ConnectorCustomizerVersionCreateResponse -CustomizerID b07dc46a-1498-4de8-bfbb-259a68e70c8a `
|
||||
-ImageID 2c91808568c529c60168cca6f90c1324 `
|
||||
-Version 1 `
|
||||
-Created 2022-02-08T14:50:03.827Z
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ConnectorCustomizerVersionCreateResponse | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
id: v2024-connector-customizers-response
|
||||
title: ConnectorCustomizersResponse
|
||||
pagination_label: ConnectorCustomizersResponse
|
||||
sidebar_label: ConnectorCustomizersResponse
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorCustomizersResponse', 'V2024ConnectorCustomizersResponse']
|
||||
slug: /tools/sdk/powershell/v2024/models/connector-customizers-response
|
||||
tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizersResponse', 'V2024ConnectorCustomizersResponse']
|
||||
---
|
||||
|
||||
|
||||
# ConnectorCustomizersResponse
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | Connector customizer ID. | [optional] [readonly]
|
||||
**Name** | **String** | Connector customizer name. | [optional]
|
||||
**ImageVersion** | **Int64** | Connector customizer image version. | [optional]
|
||||
**ImageID** | **String** | Connector customizer image id. | [optional]
|
||||
**TenantID** | **String** | Connector customizer tenant id. | [optional]
|
||||
**Created** | **System.DateTime** | Date-time when the connector customizer was created | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ConnectorCustomizersResponse = Initialize-PSSailpoint.V2024ConnectorCustomizersResponse -Id b07dc46a-1498-4de8-bfbb-259a68e70c8a `
|
||||
-Name connector-customizer-name `
|
||||
-ImageVersion 1 `
|
||||
-ImageID 2c91808568c529c60168cca6f90c1324 `
|
||||
-TenantID 2c91808568c529c60168cca6f90c1324 `
|
||||
-Created null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ConnectorCustomizersResponse | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -18,7 +18,7 @@ Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Op** | **Enum** [ "add", "remove", "replace", "move", "copy", "test" ] | The operation to be performed | [required]
|
||||
**Path** | **String** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required]
|
||||
**Value** | [**JsonPatchOperationValue**](json-patch-operation-value) | | [optional]
|
||||
**Value** | [**UpdateMultiHostSourcesRequestInnerValue**](update-multi-host-sources-request-inner-value) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -1,34 +0,0 @@
|
||||
---
|
||||
id: v2024-json-patch-operation-value
|
||||
title: JsonPatchOperationValue
|
||||
pagination_label: JsonPatchOperationValue
|
||||
sidebar_label: JsonPatchOperationValue
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'JsonPatchOperationValue', 'V2024JsonPatchOperationValue']
|
||||
slug: /tools/sdk/powershell/v2024/models/json-patch-operation-value
|
||||
tags: ['SDK', 'Software Development Kit', 'JsonPatchOperationValue', 'V2024JsonPatchOperationValue']
|
||||
---
|
||||
|
||||
|
||||
# JsonPatchOperationValue
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$JsonPatchOperationValue = Initialize-PSSailpoint.V2024JsonPatchOperationValue
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$JsonPatchOperationValue | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
id: v2024-managed-cluster-type
|
||||
title: ManagedClusterType
|
||||
pagination_label: ManagedClusterType
|
||||
sidebar_label: ManagedClusterType
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterType', 'V2024ManagedClusterType']
|
||||
slug: /tools/sdk/powershell/v2024/models/managed-cluster-type
|
||||
tags: ['SDK', 'Software Development Kit', 'ManagedClusterType', 'V2024ManagedClusterType']
|
||||
---
|
||||
|
||||
|
||||
# ManagedClusterType
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | ManagedClusterType ID | [optional] [readonly]
|
||||
**Type** | **String** | ManagedClusterType type name | [required]
|
||||
**Pod** | **String** | ManagedClusterType pod | [required]
|
||||
**Org** | **String** | ManagedClusterType org | [required]
|
||||
**ManagedProcessIds** | **[]String** | List of processes for the cluster type | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ManagedClusterType = Initialize-PSSailpoint.V2024ManagedClusterType -Id aClusterTypeId `
|
||||
-Type idn `
|
||||
-Pod megapod-useast1 `
|
||||
-Org denali-cjh `
|
||||
-ManagedProcessIds [someId, someId2]
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ManagedClusterType | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: v2024-multi-host-integration-template-type
|
||||
title: MultiHostIntegrationTemplateType
|
||||
pagination_label: MultiHostIntegrationTemplateType
|
||||
sidebar_label: MultiHostIntegrationTemplateType
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationTemplateType', 'V2024MultiHostIntegrationTemplateType']
|
||||
slug: /tools/sdk/powershell/v2024/models/multi-host-integration-template-type
|
||||
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationTemplateType', 'V2024MultiHostIntegrationTemplateType']
|
||||
---
|
||||
|
||||
|
||||
# MultiHostIntegrationTemplateType
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | **String** | This is the name of the type. | [optional]
|
||||
**Type** | **String** | This is the type value for the type. | [required]
|
||||
**ScriptName** | **String** | This is the scriptName attribute value for the type. | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$MultiHostIntegrationTemplateType = Initialize-PSSailpoint.V2024MultiHostIntegrationTemplateType -Name aName `
|
||||
-Type aType `
|
||||
-ScriptName aScriptName
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$MultiHostIntegrationTemplateType | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,97 @@
|
||||
---
|
||||
id: v2024-multi-host-integrations
|
||||
title: MultiHostIntegrations
|
||||
pagination_label: MultiHostIntegrations
|
||||
sidebar_label: MultiHostIntegrations
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrations', 'V2024MultiHostIntegrations']
|
||||
slug: /tools/sdk/powershell/v2024/models/multi-host-integrations
|
||||
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrations', 'V2024MultiHostIntegrations']
|
||||
---
|
||||
|
||||
|
||||
# MultiHostIntegrations
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | Multi-Host Integration ID. | [required][readonly]
|
||||
**Name** | **String** | Multi-Host Integration's human-readable name. | [required]
|
||||
**Description** | **String** | Multi-Host Integration's human-readable description. | [required]
|
||||
**Owner** | [**SourceOwner**](source-owner) | | [required]
|
||||
**Cluster** | [**SourceCluster**](source-cluster) | | [optional]
|
||||
**AccountCorrelationConfig** | [**SourceAccountCorrelationConfig**](source-account-correlation-config) | | [optional]
|
||||
**AccountCorrelationRule** | [**SourceAccountCorrelationRule**](source-account-correlation-rule) | | [optional]
|
||||
**ManagerCorrelationMapping** | [**SourceManagerCorrelationMapping**](source-manager-correlation-mapping) | | [optional]
|
||||
**ManagerCorrelationRule** | [**SourceManagerCorrelationRule**](source-manager-correlation-rule) | | [optional]
|
||||
**BeforeProvisioningRule** | [**MultiHostIntegrationsBeforeProvisioningRule**](multi-host-integrations-before-provisioning-rule) | | [optional]
|
||||
**Schemas** | [**[]SourceSchemasInner**](source-schemas-inner) | List of references to schema objects. | [optional]
|
||||
**PasswordPolicies** | [**[]SourcePasswordPoliciesInner**](source-password-policies-inner) | List of references to the associated PasswordPolicy objects. | [optional]
|
||||
**Features** | **[]String** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional]
|
||||
**Type** | **String** | Specifies the type of system being managed e.g. Workday, Multi-Host - Microsoft SQL Server, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [optional]
|
||||
**Connector** | **String** | Connector script name. | [required]
|
||||
**ConnectorClass** | **String** | Fully qualified name of the Java class that implements the connector interface. | [optional]
|
||||
**ConnectorAttributes** | [**MultiHostIntegrationsConnectorAttributes**](multi-host-integrations-connector-attributes) | | [optional]
|
||||
**DeleteThreshold** | **Int32** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional]
|
||||
**Authoritative** | **Boolean** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to $false]
|
||||
**ManagementWorkgroup** | [**SourceManagementWorkgroup**](source-management-workgroup) | | [optional]
|
||||
**Healthy** | **Boolean** | When this is true, it indicates that the source is healthy. | [optional] [default to $false]
|
||||
**Status** | **Enum** [ "SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT", "SOURCE_STATE_ERROR_CLUSTER", "SOURCE_STATE_ERROR_SOURCE", "SOURCE_STATE_ERROR_VA", "SOURCE_STATE_FAILURE_CLUSTER", "SOURCE_STATE_FAILURE_SOURCE", "SOURCE_STATE_HEALTHY", "SOURCE_STATE_UNCHECKED_CLUSTER", "SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES", "SOURCE_STATE_UNCHECKED_SOURCE", "SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS" ] | Status identifier that gives specific information about why a source is or isn't healthy. | [optional]
|
||||
**Since** | **System.DateTime** | Timestamp that shows when a source health check was last performed. | [optional]
|
||||
**ConnectorId** | **String** | Connector ID | [optional]
|
||||
**ConnectorName** | **String** | Name of the connector that was chosen during source creation. | [optional]
|
||||
**ConnectionType** | **Enum** [ "direct", "file" ] | Type of connection (direct or file). | [optional]
|
||||
**ConnectorImplementationId** | **String** | Connector implementation ID. | [optional]
|
||||
**Created** | **System.DateTime** | Date-time when the source was created | [optional]
|
||||
**Modified** | **System.DateTime** | Date-time when the source was last modified. | [optional]
|
||||
**CredentialProviderEnabled** | **Boolean** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to $false]
|
||||
**Category** | **String** | Source category (e.g. null, CredentialProvider). | [optional]
|
||||
**AccountsFile** | [**MultiHostIntegrationsAccountsFile**](multi-host-integrations-accounts-file) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$MultiHostIntegrations = Initialize-PSSailpoint.V2024MultiHostIntegrations -Id 2c91808568c529c60168cca6f90c1324 `
|
||||
-Name My Multi-Host Integration `
|
||||
-Description This is a Multi-Host Integration. `
|
||||
-Owner null `
|
||||
-Cluster null `
|
||||
-AccountCorrelationConfig null `
|
||||
-AccountCorrelationRule null `
|
||||
-ManagerCorrelationMapping null `
|
||||
-ManagerCorrelationRule null `
|
||||
-BeforeProvisioningRule null `
|
||||
-Schemas [{type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232a, name=account}, {type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232b, name=group}] `
|
||||
-PasswordPolicies [{type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb053980, name=Corporate Password Policy}, {type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb057777, name=Vendor Password Policy}] `
|
||||
-Features [PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS] `
|
||||
-Type Multi-Host - Microsoft SQL Server `
|
||||
-Connector multihost-microsoft-sql-server `
|
||||
-ConnectorClass sailpoint.connector.OpenConnectorAdapter `
|
||||
-ConnectorAttributes null `
|
||||
-DeleteThreshold 10 `
|
||||
-Authoritative false `
|
||||
-ManagementWorkgroup null `
|
||||
-Healthy true `
|
||||
-Status SOURCE_STATE_HEALTHY `
|
||||
-Since null `
|
||||
-ConnectorId multihost-microsoft-sql-server `
|
||||
-ConnectorName Multi-Host Microsoft SQL Server `
|
||||
-ConnectionType direct `
|
||||
-ConnectorImplementationId multihost-microsoft-sql-server `
|
||||
-Created 2022-02-08T14:50:03.827Z `
|
||||
-Modified 2024-01-23T18:08:50.897Z `
|
||||
-CredentialProviderEnabled false `
|
||||
-Category CredentialProvider `
|
||||
-AccountsFile null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$MultiHostIntegrations | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
id: v2024-multi-host-integrations-accounts-file
|
||||
title: MultiHostIntegrationsAccountsFile
|
||||
pagination_label: MultiHostIntegrationsAccountsFile
|
||||
sidebar_label: MultiHostIntegrationsAccountsFile
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationsAccountsFile', 'V2024MultiHostIntegrationsAccountsFile']
|
||||
slug: /tools/sdk/powershell/v2024/models/multi-host-integrations-accounts-file
|
||||
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsAccountsFile', 'V2024MultiHostIntegrationsAccountsFile']
|
||||
---
|
||||
|
||||
|
||||
# MultiHostIntegrationsAccountsFile
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | **String** | Name of the accounts file. | [optional]
|
||||
**Key** | **String** | The accounts file key. | [optional]
|
||||
**UploadTime** | **System.DateTime** | Date-time when the file was uploaded | [optional]
|
||||
**Expiry** | **System.DateTime** | Date-time when the accounts file expired. | [optional]
|
||||
**Expired** | **Boolean** | If this is true, it indicates that the accounts file has expired. | [optional] [default to $false]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$MultiHostIntegrationsAccountsFile = Initialize-PSSailpoint.V2024MultiHostIntegrationsAccountsFile -Name My Accounts File `
|
||||
-Key 2c91808568c529c60168cca6f90c2222 `
|
||||
-UploadTime 2022-02-08T14:50:03.827Z `
|
||||
-Expiry 2022-02-08T14:50:03.827Z `
|
||||
-Expired false
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$MultiHostIntegrationsAccountsFile | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
id: v2024-multi-host-integrations-agg-schedule-update
|
||||
title: MultiHostIntegrationsAggScheduleUpdate
|
||||
pagination_label: MultiHostIntegrationsAggScheduleUpdate
|
||||
sidebar_label: MultiHostIntegrationsAggScheduleUpdate
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationsAggScheduleUpdate', 'V2024MultiHostIntegrationsAggScheduleUpdate']
|
||||
slug: /tools/sdk/powershell/v2024/models/multi-host-integrations-agg-schedule-update
|
||||
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsAggScheduleUpdate', 'V2024MultiHostIntegrationsAggScheduleUpdate']
|
||||
---
|
||||
|
||||
|
||||
# MultiHostIntegrationsAggScheduleUpdate
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**MultihostId** | **String** | Multi-Host Integration ID. The ID must be unique | [required]
|
||||
**AggregationGrpId** | **String** | Multi-Host Integration aggregation group ID | [required]
|
||||
**AggregationGrpName** | **String** | Multi-Host Integration name | [required]
|
||||
**AggregationCronSchedule** | **String** | Cron expression to schedule aggregation | [required]
|
||||
**EnableSchedule** | **Boolean** | Boolean value for Multi-Host Integration aggregation schedule. This specifies if scheduled aggregation is enabled or disabled. | [required][default to $false]
|
||||
**SourceIdList** | **[]String** | Source IDs of the Multi-Host Integration | [required]
|
||||
**Created** | **System.DateTime** | Created date of Multi-Host Integration aggregation schedule | [optional]
|
||||
**Modified** | **System.DateTime** | Modified date of Multi-Host Integration aggregation schedule | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$MultiHostIntegrationsAggScheduleUpdate = Initialize-PSSailpoint.V2024MultiHostIntegrationsAggScheduleUpdate -MultihostId 004091cb79b04636b88662afa50a4456 `
|
||||
-AggregationGrpId 004091cb79b04636b88662afa50a4448 `
|
||||
-AggregationGrpName Multi-Host Integration aggregation group name `
|
||||
-AggregationCronSchedule 0 0 0 * * ? `
|
||||
-EnableSchedule false `
|
||||
-SourceIdList [004091cb79b04636b88662afa50a4440, 00af6d0d562a49b591c47be908740542] `
|
||||
-Created 2024-01-23T18:08:50.897Z `
|
||||
-Modified 2024-01-23T18:08:50.897Z
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$MultiHostIntegrationsAggScheduleUpdate | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: v2024-multi-host-integrations-before-provisioning-rule
|
||||
title: MultiHostIntegrationsBeforeProvisioningRule
|
||||
pagination_label: MultiHostIntegrationsBeforeProvisioningRule
|
||||
sidebar_label: MultiHostIntegrationsBeforeProvisioningRule
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationsBeforeProvisioningRule', 'V2024MultiHostIntegrationsBeforeProvisioningRule']
|
||||
slug: /tools/sdk/powershell/v2024/models/multi-host-integrations-before-provisioning-rule
|
||||
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsBeforeProvisioningRule', 'V2024MultiHostIntegrationsBeforeProvisioningRule']
|
||||
---
|
||||
|
||||
|
||||
# MultiHostIntegrationsBeforeProvisioningRule
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **Enum** [ "RULE" ] | Type of object being referenced. | [optional]
|
||||
**Id** | **String** | Rule ID. | [optional]
|
||||
**Name** | **String** | Rule's human-readable display name. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$MultiHostIntegrationsBeforeProvisioningRule = Initialize-PSSailpoint.V2024MultiHostIntegrationsBeforeProvisioningRule -Type RULE `
|
||||
-Id 2c918085708c274401708c2a8a760001 `
|
||||
-Name Example Rule
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$MultiHostIntegrationsBeforeProvisioningRule | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
id: v2024-multi-host-integrations-connector-attributes
|
||||
title: MultiHostIntegrationsConnectorAttributes
|
||||
pagination_label: MultiHostIntegrationsConnectorAttributes
|
||||
sidebar_label: MultiHostIntegrationsConnectorAttributes
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationsConnectorAttributes', 'V2024MultiHostIntegrationsConnectorAttributes']
|
||||
slug: /tools/sdk/powershell/v2024/models/multi-host-integrations-connector-attributes
|
||||
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsConnectorAttributes', 'V2024MultiHostIntegrationsConnectorAttributes']
|
||||
---
|
||||
|
||||
|
||||
# MultiHostIntegrationsConnectorAttributes
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**MaxAllowedSources** | **Int32** | Maximum sources allowed count of a Multi-Host Integration | [optional]
|
||||
**LastSourceUploadCount** | **Int32** | Last upload sources count of a Multi-Host Integration | [optional]
|
||||
**ConnectorFileUploadHistory** | [**MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory**](multi-host-integrations-connector-attributes-connector-file-upload-history) | | [optional]
|
||||
**MultihostStatus** | **Enum** [ "ready", "processing", "fileUploadInProgress", "sourceCreationInProgress", "aggregationGroupingInProgress", "aggregationScheduleInProgress", "deleteInProgress", "deleteFailed" ] | Multi-Host integration status. | [optional]
|
||||
**ShowAccountSchema** | **Boolean** | Show account schema | [optional] [default to $true]
|
||||
**ShowEntitlementSchema** | **Boolean** | Show entitlement schema | [optional] [default to $true]
|
||||
**MultiHostAttributes** | [**MultiHostIntegrationsConnectorAttributesMultiHostAttributes**](multi-host-integrations-connector-attributes-multi-host-attributes) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$MultiHostIntegrationsConnectorAttributes = Initialize-PSSailpoint.V2024MultiHostIntegrationsConnectorAttributes -MaxAllowedSources 250 `
|
||||
-LastSourceUploadCount 40 `
|
||||
-ConnectorFileUploadHistory null `
|
||||
-MultihostStatus ready `
|
||||
-ShowAccountSchema true `
|
||||
-ShowEntitlementSchema true `
|
||||
-MultiHostAttributes null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$MultiHostIntegrationsConnectorAttributes | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: v2024-multi-host-integrations-connector-attributes-connector-file-upload-history
|
||||
title: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory
|
||||
pagination_label: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory
|
||||
sidebar_label: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory', 'V2024MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory']
|
||||
slug: /tools/sdk/powershell/v2024/models/multi-host-integrations-connector-attributes-connector-file-upload-history
|
||||
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory', 'V2024MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory']
|
||||
---
|
||||
|
||||
|
||||
# MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ConnectorFileNameUploadedDate** | **String** | File name of the connector JAR | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory = Initialize-PSSailpoint.V2024MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory -ConnectorFileNameUploadedDate 2024-08-29T10:20:38.896479Z
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
---
|
||||
id: v2024-multi-host-integrations-connector-attributes-multi-host-attributes
|
||||
title: MultiHostIntegrationsConnectorAttributesMultiHostAttributes
|
||||
pagination_label: MultiHostIntegrationsConnectorAttributesMultiHostAttributes
|
||||
sidebar_label: MultiHostIntegrationsConnectorAttributesMultiHostAttributes
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationsConnectorAttributesMultiHostAttributes', 'V2024MultiHostIntegrationsConnectorAttributesMultiHostAttributes']
|
||||
slug: /tools/sdk/powershell/v2024/models/multi-host-integrations-connector-attributes-multi-host-attributes
|
||||
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsConnectorAttributesMultiHostAttributes', 'V2024MultiHostIntegrationsConnectorAttributesMultiHostAttributes']
|
||||
---
|
||||
|
||||
|
||||
# MultiHostIntegrationsConnectorAttributesMultiHostAttributes
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Password** | **String** | Password. | [optional]
|
||||
**ConnectorFiles** | **String** | Connector file. | [optional]
|
||||
**AuthType** | **String** | Authentication type. | [optional]
|
||||
**User** | **String** | Username. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$MultiHostIntegrationsConnectorAttributesMultiHostAttributes = Initialize-PSSailpoint.V2024MultiHostIntegrationsConnectorAttributesMultiHostAttributes -Password Password `
|
||||
-ConnectorFiles mssql-jdbc-8.4.1.jre8.jar `
|
||||
-AuthType SQLAuthentication `
|
||||
-User My Username
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$MultiHostIntegrationsConnectorAttributesMultiHostAttributes | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,51 @@
|
||||
---
|
||||
id: v2024-multi-host-integrations-create
|
||||
title: MultiHostIntegrationsCreate
|
||||
pagination_label: MultiHostIntegrationsCreate
|
||||
sidebar_label: MultiHostIntegrationsCreate
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationsCreate', 'V2024MultiHostIntegrationsCreate']
|
||||
slug: /tools/sdk/powershell/v2024/models/multi-host-integrations-create
|
||||
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsCreate', 'V2024MultiHostIntegrationsCreate']
|
||||
---
|
||||
|
||||
|
||||
# MultiHostIntegrationsCreate
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | **String** | Multi-Host Integration's human-readable name. | [required]
|
||||
**Description** | **String** | Multi-Host Integration's human-readable description. | [required]
|
||||
**Owner** | [**SourceOwner**](source-owner) | | [required]
|
||||
**Cluster** | [**SourceCluster**](source-cluster) | | [optional]
|
||||
**Connector** | **String** | Connector script name. | [required]
|
||||
**ConnectorAttributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Multi-Host Integration specific configuration. User can add any number of additional attributes. e.g. maxSourcesPerAggGroup, maxAllowedSources etc. | [optional]
|
||||
**ManagementWorkgroup** | [**SourceManagementWorkgroup**](source-management-workgroup) | | [optional]
|
||||
**Created** | **System.DateTime** | Date-time when the source was created | [optional]
|
||||
**Modified** | **System.DateTime** | Date-time when the source was last modified. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$MultiHostIntegrationsCreate = Initialize-PSSailpoint.V2024MultiHostIntegrationsCreate -Name My Multi-Host Integration `
|
||||
-Description This is the Multi-Host Integration. `
|
||||
-Owner null `
|
||||
-Cluster null `
|
||||
-Connector multihost-microsoft-sql-server `
|
||||
-ConnectorAttributes {maxSourcesPerAggGroup=10, maxAllowedSources=300} `
|
||||
-ManagementWorkgroup null `
|
||||
-Created 2022-02-08T14:50:03.827Z `
|
||||
-Modified 2024-01-23T18:08:50.897Z
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$MultiHostIntegrationsCreate | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: v2024-multi-host-integrations-create-sources
|
||||
title: MultiHostIntegrationsCreateSources
|
||||
pagination_label: MultiHostIntegrationsCreateSources
|
||||
sidebar_label: MultiHostIntegrationsCreateSources
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationsCreateSources', 'V2024MultiHostIntegrationsCreateSources']
|
||||
slug: /tools/sdk/powershell/v2024/models/multi-host-integrations-create-sources
|
||||
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsCreateSources', 'V2024MultiHostIntegrationsCreateSources']
|
||||
---
|
||||
|
||||
|
||||
# MultiHostIntegrationsCreateSources
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | **String** | Source's human-readable name. | [required]
|
||||
**Description** | **String** | Source's human-readable description. | [optional]
|
||||
**ConnectorAttributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Connector specific configuration. This configuration will differ from type to type. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$MultiHostIntegrationsCreateSources = Initialize-PSSailpoint.V2024MultiHostIntegrationsCreateSources -Name My Source `
|
||||
-Description This is the corporate directory. `
|
||||
-ConnectorAttributes {authType=SQLAuthentication, url=jdbc:sqlserver://178.18.41.118:1433, user=username, driverClass=com.microsoft.sqlserver.jdbc.SQLServerDriver, maxSourcesPerAggGroup=10, maxAllowedSources=300}
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$MultiHostIntegrationsCreateSources | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,95 @@
|
||||
---
|
||||
id: v2024-multi-host-sources
|
||||
title: MultiHostSources
|
||||
pagination_label: MultiHostSources
|
||||
sidebar_label: MultiHostSources
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostSources', 'V2024MultiHostSources']
|
||||
slug: /tools/sdk/powershell/v2024/models/multi-host-sources
|
||||
tags: ['SDK', 'Software Development Kit', 'MultiHostSources', 'V2024MultiHostSources']
|
||||
---
|
||||
|
||||
|
||||
# MultiHostSources
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | Source ID. | [required][readonly]
|
||||
**Name** | **String** | Source's human-readable name. | [required]
|
||||
**Description** | **String** | Source's human-readable description. | [optional]
|
||||
**Owner** | [**SourceOwner**](source-owner) | | [required]
|
||||
**Cluster** | [**SourceCluster**](source-cluster) | | [optional]
|
||||
**AccountCorrelationConfig** | [**SourceAccountCorrelationConfig**](source-account-correlation-config) | | [optional]
|
||||
**AccountCorrelationRule** | [**SourceAccountCorrelationRule**](source-account-correlation-rule) | | [optional]
|
||||
**ManagerCorrelationMapping** | [**ManagerCorrelationMapping**](manager-correlation-mapping) | | [optional]
|
||||
**ManagerCorrelationRule** | [**SourceManagerCorrelationRule**](source-manager-correlation-rule) | | [optional]
|
||||
**BeforeProvisioningRule** | [**SourceBeforeProvisioningRule**](source-before-provisioning-rule) | | [optional]
|
||||
**Schemas** | [**[]SourceSchemasInner**](source-schemas-inner) | List of references to schema objects. | [optional]
|
||||
**PasswordPolicies** | [**[]SourcePasswordPoliciesInner**](source-password-policies-inner) | List of references to the associated PasswordPolicy objects. | [optional]
|
||||
**Features** | **[]String** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional]
|
||||
**Type** | **String** | Specifies the type of system being managed e.g. Multi-Host - Microsoft SQL Server, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [optional]
|
||||
**Connector** | **String** | Connector script name. | [required]
|
||||
**ConnectorClass** | **String** | Fully qualified name of the Java class that implements the connector interface. | [optional]
|
||||
**ConnectorAttributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Connector specific configuration. This configuration will differ from type to type. | [optional]
|
||||
**DeleteThreshold** | **Int32** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional]
|
||||
**Authoritative** | **Boolean** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to $false]
|
||||
**ManagementWorkgroup** | [**SourceManagementWorkgroup**](source-management-workgroup) | | [optional]
|
||||
**Healthy** | **Boolean** | When this is true, it indicates that the source is healthy. | [optional] [default to $false]
|
||||
**Status** | **Enum** [ "SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT", "SOURCE_STATE_ERROR_CLUSTER", "SOURCE_STATE_ERROR_SOURCE", "SOURCE_STATE_ERROR_VA", "SOURCE_STATE_FAILURE_CLUSTER", "SOURCE_STATE_FAILURE_SOURCE", "SOURCE_STATE_HEALTHY", "SOURCE_STATE_UNCHECKED_CLUSTER", "SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES", "SOURCE_STATE_UNCHECKED_SOURCE", "SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS" ] | Status identifier that gives specific information about why a source is or isn't healthy. | [optional]
|
||||
**Since** | **System.DateTime** | Timestamp that shows when a source health check was last performed. | [optional]
|
||||
**ConnectorId** | **String** | Connector ID | [optional]
|
||||
**ConnectorName** | **String** | Name of the connector that was chosen during source creation. | [required]
|
||||
**ConnectionType** | **String** | Type of connection (direct or file). | [optional]
|
||||
**ConnectorImplementationId** | **String** | Connector implementation ID. | [optional]
|
||||
**Created** | **System.DateTime** | Date-time when the source was created | [optional]
|
||||
**Modified** | **System.DateTime** | Date-time when the source was last modified. | [optional]
|
||||
**CredentialProviderEnabled** | **Boolean** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to $false]
|
||||
**Category** | **String** | Source category (e.g. null, CredentialProvider). | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$MultiHostSources = Initialize-PSSailpoint.V2024MultiHostSources -Id 2c91808568c529c60168cca6f90c1324 `
|
||||
-Name My Source `
|
||||
-Description This is the Source. `
|
||||
-Owner null `
|
||||
-Cluster null `
|
||||
-AccountCorrelationConfig null `
|
||||
-AccountCorrelationRule null `
|
||||
-ManagerCorrelationMapping null `
|
||||
-ManagerCorrelationRule null `
|
||||
-BeforeProvisioningRule null `
|
||||
-Schemas [{type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232a, name=account}, {type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232b, name=group}] `
|
||||
-PasswordPolicies [{type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb053980, name=Corporate Password Policy}, {type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb057777, name=Vendor Password Policy}] `
|
||||
-Features [PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS] `
|
||||
-Type Multi-Host - Microsoft SQL Server `
|
||||
-Connector multihost-microsoft-sql-server `
|
||||
-ConnectorClass sailpoint.connector.OpenConnectorAdapter `
|
||||
-ConnectorAttributes {healthCheckTimeout=30, authSearchAttributes=[cn, uid, mail]} `
|
||||
-DeleteThreshold 10 `
|
||||
-Authoritative false `
|
||||
-ManagementWorkgroup null `
|
||||
-Healthy true `
|
||||
-Status SOURCE_STATE_HEALTHY `
|
||||
-Since null `
|
||||
-ConnectorId multihost-microsoft-sql-server `
|
||||
-ConnectorName Multi-Host Microsoft SQL Server `
|
||||
-ConnectionType file `
|
||||
-ConnectorImplementationId multihost-microsoft-sql-server `
|
||||
-Created 2022-02-08T14:50:03.827Z `
|
||||
-Modified 2024-01-23T18:08:50.897Z `
|
||||
-CredentialProviderEnabled false `
|
||||
-Category CredentialProvider
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$MultiHostSources | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -18,7 +18,7 @@ Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Op** | **Enum** [ "remove", "replace" ] | The operation to be performed | [optional]
|
||||
**Path** | **String** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required]
|
||||
**Value** | [**JsonPatchOperationValue**](json-patch-operation-value) | | [optional]
|
||||
**Value** | [**UpdateMultiHostSourcesRequestInnerValue**](update-multi-host-sources-request-inner-value) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
id: v2024-source-creation-errors
|
||||
title: SourceCreationErrors
|
||||
pagination_label: SourceCreationErrors
|
||||
sidebar_label: SourceCreationErrors
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'SourceCreationErrors', 'V2024SourceCreationErrors']
|
||||
slug: /tools/sdk/powershell/v2024/models/source-creation-errors
|
||||
tags: ['SDK', 'Software Development Kit', 'SourceCreationErrors', 'V2024SourceCreationErrors']
|
||||
---
|
||||
|
||||
|
||||
# SourceCreationErrors
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**MultihostId** | **String** | Multi-Host Integration ID. | [optional] [readonly]
|
||||
**SourceName** | **String** | Source's human-readable name. | [optional]
|
||||
**SourceError** | **String** | Source's human-readable description. | [optional]
|
||||
**Created** | **System.DateTime** | Date-time when the source was created | [optional]
|
||||
**Modified** | **System.DateTime** | Date-time when the source was last modified. | [optional]
|
||||
**Operation** | **String** | operation category (e.g. DELETE). | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$SourceCreationErrors = Initialize-PSSailpoint.V2024SourceCreationErrors -MultihostId 2c91808568c529c60168cca6f90c1324 `
|
||||
-SourceName My Source `
|
||||
-SourceError Source with internal name "My Source [source]" already exists. `
|
||||
-Created 2022-02-08T14:50:03.827Z `
|
||||
-Modified 2024-01-23T18:08:50.897Z `
|
||||
-Operation DELETE
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$SourceCreationErrors | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
id: v2024-test-source-connection-multihost200-response
|
||||
title: TestSourceConnectionMultihost200Response
|
||||
pagination_label: TestSourceConnectionMultihost200Response
|
||||
sidebar_label: TestSourceConnectionMultihost200Response
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'TestSourceConnectionMultihost200Response', 'V2024TestSourceConnectionMultihost200Response']
|
||||
slug: /tools/sdk/powershell/v2024/models/test-source-connection-multihost200-response
|
||||
tags: ['SDK', 'Software Development Kit', 'TestSourceConnectionMultihost200Response', 'V2024TestSourceConnectionMultihost200Response']
|
||||
---
|
||||
|
||||
|
||||
# TestSourceConnectionMultihost200Response
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Success** | **Boolean** | Source's test connection status. | [optional]
|
||||
**Message** | **String** | Source's test connection message. | [optional]
|
||||
**Timing** | **Int32** | Source's test connection timing. | [optional]
|
||||
**ResultType** | **Enum** [ "SOURCE_STATE_ERROR_CLUSTER", "SOURCE_STATE_ERROR_SOURCE", "SOURCE_STATE_ERROR_VA", "SOURCE_STATE_FAILURE_CLUSTER", "SOURCE_STATE_FAILURE_SOURCE", "SOURCE_STATE_HEALTHY", "SOURCE_STATE_UNCHECKED_CLUSTER", "SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES", "SOURCE_STATE_UNCHECKED_SOURCE", "SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS", "SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT" ] | Source's human-readable result type. | [optional]
|
||||
**TestConnectionDetails** | **String** | Source's human-readable test connection details. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$TestSourceConnectionMultihost200Response = Initialize-PSSailpoint.V2024TestSourceConnectionMultihost200Response -Success true `
|
||||
-Message Tes. `
|
||||
-Timing null `
|
||||
-ResultType SOURCE_STATE_HEALTHY `
|
||||
-TestConnectionDetails null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$TestSourceConnectionMultihost200Response | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: v2024-update-multi-host-sources-request-inner
|
||||
title: UpdateMultiHostSourcesRequestInner
|
||||
pagination_label: UpdateMultiHostSourcesRequestInner
|
||||
sidebar_label: UpdateMultiHostSourcesRequestInner
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'UpdateMultiHostSourcesRequestInner', 'V2024UpdateMultiHostSourcesRequestInner']
|
||||
slug: /tools/sdk/powershell/v2024/models/update-multi-host-sources-request-inner
|
||||
tags: ['SDK', 'Software Development Kit', 'UpdateMultiHostSourcesRequestInner', 'V2024UpdateMultiHostSourcesRequestInner']
|
||||
---
|
||||
|
||||
|
||||
# UpdateMultiHostSourcesRequestInner
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Op** | **Enum** [ "add", "replace" ] | The operation to be performed | [required]
|
||||
**Path** | **String** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required]
|
||||
**Value** | [**UpdateMultiHostSourcesRequestInnerValue**](update-multi-host-sources-request-inner-value) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$UpdateMultiHostSourcesRequestInner = Initialize-PSSailpoint.V2024UpdateMultiHostSourcesRequestInner -Op replace `
|
||||
-Path /description `
|
||||
-Value null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$UpdateMultiHostSourcesRequestInner | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
---
|
||||
id: v2024-update-multi-host-sources-request-inner-value
|
||||
title: UpdateMultiHostSourcesRequestInnerValue
|
||||
pagination_label: UpdateMultiHostSourcesRequestInnerValue
|
||||
sidebar_label: UpdateMultiHostSourcesRequestInnerValue
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'UpdateMultiHostSourcesRequestInnerValue', 'V2024UpdateMultiHostSourcesRequestInnerValue']
|
||||
slug: /tools/sdk/powershell/v2024/models/update-multi-host-sources-request-inner-value
|
||||
tags: ['SDK', 'Software Development Kit', 'UpdateMultiHostSourcesRequestInnerValue', 'V2024UpdateMultiHostSourcesRequestInnerValue']
|
||||
---
|
||||
|
||||
|
||||
# UpdateMultiHostSourcesRequestInnerValue
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$UpdateMultiHostSourcesRequestInnerValue = Initialize-PSSailpoint.V2024UpdateMultiHostSourcesRequestInnerValue
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$UpdateMultiHostSourcesRequestInnerValue | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
Reference in New Issue
Block a user