v3/src/PSSailpoint/Model/Source.ps1
|
# # Identity Security Cloud V3 API # Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. # Version: 3.0.0 # Generated by OpenAPI Generator: https://openapi-generator.tech # <# .SYNOPSIS No summary available. .DESCRIPTION No description available. .PARAMETER Name Source's human-readable name. .PARAMETER Description Source's human-readable description. .PARAMETER Owner No description available. .PARAMETER Cluster No description available. .PARAMETER AccountCorrelationConfig No description available. .PARAMETER AccountCorrelationRule No description available. .PARAMETER ManagerCorrelationMapping No description available. .PARAMETER ManagerCorrelationRule No description available. .PARAMETER BeforeProvisioningRule No description available. .PARAMETER Schemas List of references to schema objects. .PARAMETER PasswordPolicies List of references to the associated PasswordPolicy objects. .PARAMETER Features 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 .PARAMETER Type Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. .PARAMETER Connector Connector script name. .PARAMETER ConnectorClass Fully qualified name of the Java class that implements the connector interface. .PARAMETER ConnectorAttributes Connector specific configuration. This configuration will differ from type to type. .PARAMETER DeleteThreshold Number from 0 to 100 that specifies when to skip the delete phase. .PARAMETER Authoritative When this is true, it indicates that the source is referenced by an identity profile. .PARAMETER ManagementWorkgroup No description available. .PARAMETER Healthy When this is true, it indicates that the source is healthy. .PARAMETER Status Status identifier that gives specific information about why a source is or isn't healthy. .PARAMETER Since Timestamp that shows when a source health check was last performed. .PARAMETER ConnectorId Connector ID .PARAMETER ConnectorName Name of the connector that was chosen during source creation. .PARAMETER ConnectionType Type of connection (direct or file). .PARAMETER ConnectorImplementationId Connector implementation ID. .PARAMETER Created Date-time when the source was created .PARAMETER Modified Date-time when the source was last modified. .PARAMETER CredentialProviderEnabled 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. .PARAMETER Category Source category (e.g. null, CredentialProvider). .OUTPUTS Source<PSCustomObject> #> function Initialize-Source { [CmdletBinding()] Param ( [Parameter(ValueFromPipelineByPropertyName = $true)] [String] ${Name}, [Parameter(ValueFromPipelineByPropertyName = $true)] [String] ${Description}, [Parameter(ValueFromPipelineByPropertyName = $true)] [PSCustomObject] ${Owner}, [Parameter(ValueFromPipelineByPropertyName = $true)] [PSCustomObject] ${Cluster}, [Parameter(ValueFromPipelineByPropertyName = $true)] [PSCustomObject] ${AccountCorrelationConfig}, [Parameter(ValueFromPipelineByPropertyName = $true)] [PSCustomObject] ${AccountCorrelationRule}, [Parameter(ValueFromPipelineByPropertyName = $true)] [PSCustomObject] ${ManagerCorrelationMapping}, [Parameter(ValueFromPipelineByPropertyName = $true)] [PSCustomObject] ${ManagerCorrelationRule}, [Parameter(ValueFromPipelineByPropertyName = $true)] [PSCustomObject] ${BeforeProvisioningRule}, [Parameter(ValueFromPipelineByPropertyName = $true)] [PSCustomObject[]] ${Schemas}, [Parameter(ValueFromPipelineByPropertyName = $true)] [PSCustomObject[]] ${PasswordPolicies}, [Parameter(ValueFromPipelineByPropertyName = $true)] [ValidateSet("AUTHENTICATE", "COMPOSITE", "DIRECT_PERMISSIONS", "DISCOVER_SCHEMA", "ENABLE", "MANAGER_LOOKUP", "NO_RANDOM_ACCESS", "PROXY", "SEARCH", "TEMPLATE", "UNLOCK", "UNSTRUCTURED_TARGETS", "SHAREPOINT_TARGET", "PROVISIONING", "GROUP_PROVISIONING", "SYNC_PROVISIONING", "PASSWORD", "CURRENT_PASSWORD", "ACCOUNT_ONLY_REQUEST", "ADDITIONAL_ACCOUNT_REQUEST", "NO_AGGREGATION", "GROUPS_HAVE_MEMBERS", "NO_PERMISSIONS_PROVISIONING", "NO_GROUP_PERMISSIONS_PROVISIONING", "NO_UNSTRUCTURED_TARGETS_PROVISIONING", "NO_DIRECT_PERMISSIONS_PROVISIONING", "PREFER_UUID", "ARM_SECURITY_EXTRACT", "ARM_UTILIZATION_EXTRACT", "ARM_CHANGELOG_EXTRACT", "USES_UUID")] [String[]] ${Features}, [Parameter(ValueFromPipelineByPropertyName = $true)] [String] ${Type}, [Parameter(ValueFromPipelineByPropertyName = $true)] [String] ${Connector}, [Parameter(ValueFromPipelineByPropertyName = $true)] [String] ${ConnectorClass}, [Parameter(ValueFromPipelineByPropertyName = $true)] [PSCustomObject] ${ConnectorAttributes}, [Parameter(ValueFromPipelineByPropertyName = $true)] [System.Nullable[Int32]] ${DeleteThreshold}, [Parameter(ValueFromPipelineByPropertyName = $true)] [System.Nullable[Boolean]] ${Authoritative} = $false, [Parameter(ValueFromPipelineByPropertyName = $true)] [PSCustomObject] ${ManagementWorkgroup}, [Parameter(ValueFromPipelineByPropertyName = $true)] [System.Nullable[Boolean]] ${Healthy} = $false, [Parameter(ValueFromPipelineByPropertyName = $true)] [ValidateSet("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")] [String] ${Status}, [Parameter(ValueFromPipelineByPropertyName = $true)] [String] ${Since}, [Parameter(ValueFromPipelineByPropertyName = $true)] [String] ${ConnectorId}, [Parameter(ValueFromPipelineByPropertyName = $true)] [String] ${ConnectorName}, [Parameter(ValueFromPipelineByPropertyName = $true)] [String] ${ConnectionType}, [Parameter(ValueFromPipelineByPropertyName = $true)] [String] ${ConnectorImplementationId}, [Parameter(ValueFromPipelineByPropertyName = $true)] [System.Nullable[System.DateTime]] ${Created}, [Parameter(ValueFromPipelineByPropertyName = $true)] [System.Nullable[System.DateTime]] ${Modified}, [Parameter(ValueFromPipelineByPropertyName = $true)] [System.Nullable[Boolean]] ${CredentialProviderEnabled} = $false, [Parameter(ValueFromPipelineByPropertyName = $true)] [String] ${Category} ) Process { 'Creating PSCustomObject: PSSailpoint => Source' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug if (!$Name) { throw "invalid value for 'Name', 'Name' cannot be null." } if (!$Owner) { throw "invalid value for 'Owner', 'Owner' cannot be null." } if (!$Connector) { throw "invalid value for 'Connector', 'Connector' cannot be null." } $PSO = [PSCustomObject]@{ "name" = ${Name} "description" = ${Description} "owner" = ${Owner} "cluster" = ${Cluster} "accountCorrelationConfig" = ${AccountCorrelationConfig} "accountCorrelationRule" = ${AccountCorrelationRule} "managerCorrelationMapping" = ${ManagerCorrelationMapping} "managerCorrelationRule" = ${ManagerCorrelationRule} "beforeProvisioningRule" = ${BeforeProvisioningRule} "schemas" = ${Schemas} "passwordPolicies" = ${PasswordPolicies} "features" = ${Features} "type" = ${Type} "connector" = ${Connector} "connectorClass" = ${ConnectorClass} "connectorAttributes" = ${ConnectorAttributes} "deleteThreshold" = ${DeleteThreshold} "authoritative" = ${Authoritative} "managementWorkgroup" = ${ManagementWorkgroup} "healthy" = ${Healthy} "status" = ${Status} "since" = ${Since} "connectorId" = ${ConnectorId} "connectorName" = ${ConnectorName} "connectionType" = ${ConnectionType} "connectorImplementationId" = ${ConnectorImplementationId} "created" = ${Created} "modified" = ${Modified} "credentialProviderEnabled" = ${CredentialProviderEnabled} "category" = ${Category} } return $PSO } } <# .SYNOPSIS Convert from JSON to Source<PSCustomObject> .DESCRIPTION Convert from JSON to Source<PSCustomObject> .PARAMETER Json Json object .OUTPUTS Source<PSCustomObject> #> function ConvertFrom-JsonToSource { Param( [AllowEmptyString()] [string]$Json ) Process { 'Converting JSON to PSCustomObject: PSSailpoint => Source' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $JsonParameters = ConvertFrom-Json -InputObject $Json # check if Json contains properties not defined in Source $AllProperties = ("id", "name", "description", "owner", "cluster", "accountCorrelationConfig", "accountCorrelationRule", "managerCorrelationMapping", "managerCorrelationRule", "beforeProvisioningRule", "schemas", "passwordPolicies", "features", "type", "connector", "connectorClass", "connectorAttributes", "deleteThreshold", "authoritative", "managementWorkgroup", "healthy", "status", "since", "connectorId", "connectorName", "connectionType", "connectorImplementationId", "created", "modified", "credentialProviderEnabled", "category") foreach ($name in $JsonParameters.PsObject.Properties.Name) { if (!($AllProperties.Contains($name))) { throw "Error! JSON key '$name' not found in the properties: $($AllProperties)" } } If ([string]::IsNullOrEmpty($Json) -or $Json -eq "{}") { # empty json throw "Error! Empty JSON cannot be serialized due to the required property 'name' missing." } if (!([bool]($JsonParameters.PSobject.Properties.name -match "name"))) { throw "Error! JSON cannot be serialized due to the required property 'name' missing." } else { $Name = $JsonParameters.PSobject.Properties["name"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "owner"))) { throw "Error! JSON cannot be serialized due to the required property 'owner' missing." } else { $Owner = $JsonParameters.PSobject.Properties["owner"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "connector"))) { throw "Error! JSON cannot be serialized due to the required property 'connector' missing." } else { $Connector = $JsonParameters.PSobject.Properties["connector"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "id"))) { #optional property not found $Id = $null } else { $Id = $JsonParameters.PSobject.Properties["id"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "description"))) { #optional property not found $Description = $null } else { $Description = $JsonParameters.PSobject.Properties["description"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "cluster"))) { #optional property not found $Cluster = $null } else { $Cluster = $JsonParameters.PSobject.Properties["cluster"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "accountCorrelationConfig"))) { #optional property not found $AccountCorrelationConfig = $null } else { $AccountCorrelationConfig = $JsonParameters.PSobject.Properties["accountCorrelationConfig"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "accountCorrelationRule"))) { #optional property not found $AccountCorrelationRule = $null } else { $AccountCorrelationRule = $JsonParameters.PSobject.Properties["accountCorrelationRule"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "managerCorrelationMapping"))) { #optional property not found $ManagerCorrelationMapping = $null } else { $ManagerCorrelationMapping = $JsonParameters.PSobject.Properties["managerCorrelationMapping"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "managerCorrelationRule"))) { #optional property not found $ManagerCorrelationRule = $null } else { $ManagerCorrelationRule = $JsonParameters.PSobject.Properties["managerCorrelationRule"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "beforeProvisioningRule"))) { #optional property not found $BeforeProvisioningRule = $null } else { $BeforeProvisioningRule = $JsonParameters.PSobject.Properties["beforeProvisioningRule"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "schemas"))) { #optional property not found $Schemas = $null } else { $Schemas = $JsonParameters.PSobject.Properties["schemas"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "passwordPolicies"))) { #optional property not found $PasswordPolicies = $null } else { $PasswordPolicies = $JsonParameters.PSobject.Properties["passwordPolicies"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "features"))) { #optional property not found $Features = $null } else { $Features = $JsonParameters.PSobject.Properties["features"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "type"))) { #optional property not found $Type = $null } else { $Type = $JsonParameters.PSobject.Properties["type"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "connectorClass"))) { #optional property not found $ConnectorClass = $null } else { $ConnectorClass = $JsonParameters.PSobject.Properties["connectorClass"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "connectorAttributes"))) { #optional property not found $ConnectorAttributes = $null } else { $ConnectorAttributes = $JsonParameters.PSobject.Properties["connectorAttributes"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "deleteThreshold"))) { #optional property not found $DeleteThreshold = $null } else { $DeleteThreshold = $JsonParameters.PSobject.Properties["deleteThreshold"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "authoritative"))) { #optional property not found $Authoritative = $null } else { $Authoritative = $JsonParameters.PSobject.Properties["authoritative"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "managementWorkgroup"))) { #optional property not found $ManagementWorkgroup = $null } else { $ManagementWorkgroup = $JsonParameters.PSobject.Properties["managementWorkgroup"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "healthy"))) { #optional property not found $Healthy = $null } else { $Healthy = $JsonParameters.PSobject.Properties["healthy"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "status"))) { #optional property not found $Status = $null } else { $Status = $JsonParameters.PSobject.Properties["status"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "since"))) { #optional property not found $Since = $null } else { $Since = $JsonParameters.PSobject.Properties["since"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "connectorId"))) { #optional property not found $ConnectorId = $null } else { $ConnectorId = $JsonParameters.PSobject.Properties["connectorId"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "connectorName"))) { #optional property not found $ConnectorName = $null } else { $ConnectorName = $JsonParameters.PSobject.Properties["connectorName"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "connectionType"))) { #optional property not found $ConnectionType = $null } else { $ConnectionType = $JsonParameters.PSobject.Properties["connectionType"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "connectorImplementationId"))) { #optional property not found $ConnectorImplementationId = $null } else { $ConnectorImplementationId = $JsonParameters.PSobject.Properties["connectorImplementationId"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "created"))) { #optional property not found $Created = $null } else { $Created = $JsonParameters.PSobject.Properties["created"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "modified"))) { #optional property not found $Modified = $null } else { $Modified = $JsonParameters.PSobject.Properties["modified"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "credentialProviderEnabled"))) { #optional property not found $CredentialProviderEnabled = $null } else { $CredentialProviderEnabled = $JsonParameters.PSobject.Properties["credentialProviderEnabled"].value } if (!([bool]($JsonParameters.PSobject.Properties.name -match "category"))) { #optional property not found $Category = $null } else { $Category = $JsonParameters.PSobject.Properties["category"].value } $PSO = [PSCustomObject]@{ "id" = ${Id} "name" = ${Name} "description" = ${Description} "owner" = ${Owner} "cluster" = ${Cluster} "accountCorrelationConfig" = ${AccountCorrelationConfig} "accountCorrelationRule" = ${AccountCorrelationRule} "managerCorrelationMapping" = ${ManagerCorrelationMapping} "managerCorrelationRule" = ${ManagerCorrelationRule} "beforeProvisioningRule" = ${BeforeProvisioningRule} "schemas" = ${Schemas} "passwordPolicies" = ${PasswordPolicies} "features" = ${Features} "type" = ${Type} "connector" = ${Connector} "connectorClass" = ${ConnectorClass} "connectorAttributes" = ${ConnectorAttributes} "deleteThreshold" = ${DeleteThreshold} "authoritative" = ${Authoritative} "managementWorkgroup" = ${ManagementWorkgroup} "healthy" = ${Healthy} "status" = ${Status} "since" = ${Since} "connectorId" = ${ConnectorId} "connectorName" = ${ConnectorName} "connectionType" = ${ConnectionType} "connectorImplementationId" = ${ConnectorImplementationId} "created" = ${Created} "modified" = ${Modified} "credentialProviderEnabled" = ${CredentialProviderEnabled} "category" = ${Category} } return $PSO } } |