Public/SEPPmailLegacyCmdLets.ps1
|
<#
.SYNOPSIS This CmdLets returns licensing information. .DESCRIPTION Retrieve license information about specific users or a summary report, using the -summary parameter .EXAMPLE PS C:\> Get-SLLicenseInfo|Where-Object userid -like 'max@mustermann.com' Get the license status for a specific users .EXAMPLE PS C:\> Get-SLLicenseInfo -summary Get the license summary of the appliance .NOTES General notes #> function Get-SLLicenseInfo { [CmdletBinding()] param ( [Parameter( Mandatory = $false, HelpMessage = 'Receive a table with license summary info instead of single entries for each user' )] [switch]$summary ) begin { Set-SLConfig | Out-Null } process { $urlroot = New-SLUrlRoot -FQDN $SLConfig.SEPPmailFQDN -adminPort $SLConfig.adminPort $uri = $urlroot + 'statistics' + '?' + 'returnType' + '=' + 'CSV' $csvstats = Invoke-RestMethod -Uri $uri -Method GET -Credential $SLConfig.secret | ConvertFrom-Csv -Delimiter ';' #'Account last used' Datum länger als 3 Monate her - keine Lizenz # wenn 'May not sign mails'-like 'YES' UND 'May not encrypt mails' -like 'YES - keine Lizenz verbraucht == Deaktiviert # Transform output to HT-Array and make sure to have proper values everywhere. $statsarray = @() $statsArray = $csvstats | Select-Object 'User ID', 'Registered User', 'May not sign mails', 'May not encrypt mails', 'Account last used'` | ForEach-Object { [ordered]@{ 'userid' = if (($_.'User ID').Length -eq '0') { 'none' } else { $_.'User ID' }; 'reguser' = $_.'Registered user'; 'nosig' = if (($_.'May not sign mails').Length -eq '0') { $true } else { $false }; 'noenc' = if (($_.'May not encrypt mails').Length -eq '0') { $true } else { $false }; 'lastused' = if (($_.'Account last used').Length -eq '0') { Get-Date -Day 1 -Month 1 -Year 2000 } else { Get-Date $_.'Account last used' } } } } end { if ($summary) { $totalKnownUsers = ($statsArray.count) $totalLic = ($statsArray | Where-Object { ($_.'reguser' -eq '1') } | Measure-Object).Count $inactiveLic = ($statsArray | Where-Object { ($_.'reguser' -eq '0') } | Measure-Object).Count $nosend3m = ($statsArray | Where-Object { ($_.'reguser' -eq '1') -and ($_.'nosig' -eq $true) -and ($_.'noenc' -eq $true) -and ($_.'lastused' -gt (Get-Date).AddMonths(-3)) } | Measure-Object).Count $usedLic = ($statsArray | Where-Object { ($_.userid -ne 'none') -and ($_.'reguser' -eq '1') -and ($_.'nosig' -eq $true) -and ($_.'noenc' -eq $true) -and ($_.'lastused' -gt (Get-Date).AddMonths(-3)) } | Measure-Object).Count <# Total of 3 encryption/signature users with an account, but 0 set to inactive and 2 did not send mails in the last three months #> [psobject]$sum = @{ 'Total known users' = $totalKnownUsers 'Total ever used licenses' = $totalLic 'Deactivated Licenses' = $inactiveLic 'released licenses (inactive > 3 months)' = $nosend3m 'Currently used Licenses' = $usedLic } return $sum } else { return $statsarray | ForEach-Object { [pscustomobject]$_ } } } } <# .SYNOPSIS Retrieve group-membership of a SEPPmail appliance .DESCRIPTION SEPPmail uses groups to control access to the web-interface and other areas. This CmdLet reads the group configuration. .EXAMPLE PS C:\> Get-SLGroupInfo Retrieve all groups and all members .EXAMPLE PS C:\> Get-SLGroupInfo -Membername max@mustermann.com Retrieve the membership of a specific user #> function Get-SLGroupInfo { [CmdletBinding()] param ( [Parameter( Mandatory = $false, HelpMessage = 'Username to look for group membership' )] [string]$MemberName, [Parameter( Mandatory = $false, HelpMessage = 'Groupname to look for user membership' )] [string]$GroupName ) begin { #Write-Verbose 'Writing SLConfig to $global:SLConfig' Set-SLConfig | Out-Null } process { $urlroot = New-SLUrlRoot -FQDN $SLConfig.SEPPmailFQDN -adminPort $SLConfig.adminPort $uri = $urlroot + 'groupinfo' + '?' + 'returnType' + '=' + 'CSV' Write-Verbose 'Call REST-API' $groupraw = Invoke-RestMethod -Uri $uri -Method GET -Credential $SLConfig.secret | ConvertFrom-Csv -Delimiter ';' Write-Verbose 'Transform output to HT-Array and make sure to have proper values everywhere. ' # [0] returns object with 2 members 'group name' and 'member names' # GroupName param set if ($groupName) { if ($groupraw | Where-Object { $_.'group name' -like $groupName }) { $groupraw | Where-Object { $_.'group name' -like $groupName } } else { Write-Warning 'Group name not found, run without parameters to get list of group names' } } # MemberName param set if ($memberName) { foreach ($group in $groupraw) { [string[]]$members = $group.'member names' -replace ' ', '' -split ',' foreach ($m in $members) { if ($m -like $memberName) { "User " + $m + " is member of " + "GroupName: " + $group.'group name' } } } } # Ausgabe der Daten wenn keine Parameter angegeben werden if ((!($groupName)) -and (!($membername))) { return $groupraw } } } <# .SYNOPSIS Read satistics information from the SEPPmail Appliance .DESCRIPTION SEPPmail provides statistic data via the API for reporting purposes. .EXAMPLE PS C:\> Get-SLStatsInfo Get all statistics data (i.e. for daily reports) .EXAMPLE PS C:\> Get-SLStatsInfo -type user | Where-Object emailAddress -like 'internal.user@contoso.de' Get (sending) user-based status info only .EXAMPLE PS C:\> Get-SLStatsInfo -type domain|Where-Object domainname -like mustermann.com Get (sending) domain-based status info only #> function Get-SLStatsInfo { [CmdletBinding()] param( [Parameter( Mandatory = $false, HelpMessage = 'Get user or domain statistics' )] [ValidateSet('user', 'domain')] [string]$type = 'user', [Parameter( Mandatory = $false, HelpMessage = 'Rebuild cached stats info database' )] [switch]$rebuild = $false ) begin { Set-SLConfig | Out-Null | Out-Null } process { try { $urlroot = New-SLUrlRoot -FQDN $SLConfig.SEPPmailFQDN -adminPort $SLConfig.adminPort if ($rebuild) { $uribase = $urlroot + 'statistics' + '?' + 'returnType' + '=' + 'CSV' + '&rebuildList' } else { $uribase = $urlroot + 'statistics' + '?' + 'returnType' + '=' + 'CSV' } if ($type -like 'user') { $uri = $uribase + '&statisticsType=user' $userStatsRaw = Invoke-RestMethod -Uri $uri -Method GET -Credential $SLConfig.secret | ConvertFrom-Csv -Delimiter ';' $userStatsRaw.'accountLastUsed' $userArray = @() $userArray = $userStatsRaw | ForEach-Object ` { [ordered]@{ 'emailAddress' = [string]$_.'E-mail address' 'userId' = if ((!($_.'User ID'))) { 'none' } else { [String]$_.'User ID' } #'userId' = $_.'User ID' 'accountLastUsed' = if (!($_.'Account last used')) { 'none' } else { [DateTime]$_.'Account last used' } 'noEnc' = if (($_.'May not encrypt mails').Length -eq '0') { $true } else { $false } 'noDec' = if (($_.'May not decrypt mails').Length -eq '0') { $true } else { $false } 'noSig' = if (($_.'May not sign mails').Length -eq '0') { $true } else { $false } 'groupMembership' = [String[]]$_.'Group membership' 'regUser' = if ($_.'Registered user' -eq '0') { $false } else { $true } 'usesLicense' = if ($_.'Uses License' -eq '0') { $false } else { $true } 'certificateExpiresOn' = if (($_.'Certificate expires on').Length -eq '0') { 'no expiration date set' } else { [DateTime]$_.'Certificate expires on' } 'smimeEncMailsSent' = [int]$_.'S/MIME encrypted mails sent' 'smimeEncMailsReceived' = [int]$_.'S/MIME encrypted mails received' 'smimeSigMailsSent' = [int]$_.'S/MIME signed mails sent' 'smimeSigMailsReceived' = [int]$_.'S/MIME signed mails received' 'openPGPEncMailsSent' = [int]$_.'openPGP encrypted mails sent' 'openPGPEncMailsReceived' = [int]$_.'openPGP encrypted mails received' 'ginaEncMailsSent' = [int]$_.'GINA encrypted mails sent' 'ginaEncMailsReceived' = [int]$_.'GINA encrypted mails received' 'smimeDomainEncMailsSent' = [int]$_.'S/MIME Domain encrypted mails sent' 'smimeDomainEncMailsReceived' = [int]$_.'S/MIME Domain encrypted mails received' 'openPGPDomainEncMailsSent' = [int]$_.'openPGP Domain encrypted mails sent' 'openPGPDomainEncMailsReceived' = [int]$_.'openPGP Domain encrypted mails received' 'hinDomainEncMailsSent' = [int]$_.'HIN Domain encrypted mails sent' 'hinDomainEncMailsReceived' = [int]$_.'HIN domain encrypted mails received' 'mailsReroutedToIncamail' = [int]$_.'Mails rerouted to Incamail' } } return $userArray | ForEach-Object { [pscustomobject]$_ } } if ($type -like 'domain') { $uri = $uribase + '&statisticsType=domain' $domStatsRaw = Invoke-RestMethod -Uri $uri -Method GET -Credential $SLConfig.secret | ConvertFrom-Csv -Delimiter ';' Write-Verbose "Creating output Hashtables" $domArray = @() $domArray = $domstatsraw | ForEach-Object ` { [ordered]@{ 'domainName' = [string]$_.'Domain Name' 'smimeEncMailsSent' = [int]$_.'S/MIME encrypted mails sent' 'smimeEncMailsReceived' = [int]$_.'S/MIME encrypted mails received' 'smimeSignedMailsSent' = [int]$_.'S/MIME signed mails sent' 'smimeSignedMailsReceived' = [int]$_.'S/MIME signed mails received' 'openPGPEncMailsSent' = [int]$_.'openPGP encrypted mails sent' 'openPGPEncMailsReceived' = [int]$_.'openPGP encrypted mails received' 'ginaEncMailsSent' = [int]$_.'GINA encrypted mails sent' 'ginaEncMailsReceived' = [int]$_.'GINA encrypted mails received' 'smimeDomainEncMailsSent' = [int]$_.'S/MIME Domain encrypted mails sent' 'smimeDomainEncMailsReceived' = [int]$_.'S/MIME Domain encrypted mails received' 'openPGPDomainEncMailsSent' = [int]$_.'openPGP Domain encrypted mails sent' 'openPGPDomainEncMailsReceived' = [int]$_.'openPGP Domain encrypted mails received' 'hinDomainEncMailsSent' = [int]$_.'HIN Domain encrypted mails sent' 'hinDomainEncMailsReceived' = [int]$_.'HIN domain encrypted mails received' 'mailsReroutedToIncamail' = [int]$_.'Mails rerouted to Incamail' } } return $domArray | ForEach-Object { [pscustomobject]$_ } } } catch { Write-Error "Request to SEPPmail appliance failed with exception: $($_.Exception)" } } } <# .SYNOPSIS Read information about encryption for domains and users .DESCRIPTION SEPPmail stores information which encryption capabilities are available for an external recipient. The CmdLet can retrieve this data. This CmdLets support the `-rebuild` parameter to get current infos of the statistics database. The CmdLet has three operation modes (ParameterSets), personal, domain and EMailAddress. .EXAMPLE PS C:\> Get-SLEncInfo -personal -encModePer SMIME Show external recipients having SMIME as encryption method .EXAMPLE PS C:\> Get-SLEncInfo -personal -encModePer PGP Show external recipients having PGP as encryption method .EXAMPLE PS C:\> Get-SLEncInfo -personal -encModePer GINA|Where-Object status -ne 'enabled' Show external recipients having GINA as encryption method .EXAMPLE PS C:\> Get-SLEncInfo -domain -encModeDom SMIME Show external domains have SMIME as encryption method .EXAMPLE PS C:\> Get-SLEncInfo -eMailAddress max@mustermann.com Find out what encryption methods are possible for an external recipient #> function Get-SLEncInfo { [CmdletBinding()] param ( # Param block personal [Parameter( ParameterSetName = 'personal', Mandatory = $true, HelpMessage = 'Restrict to smtp-address-based encryption info' )] [switch]$personal, [Parameter( ParameterSetName = 'personal', Mandatory = $true, HelpMessage = 'Filter output to a specific encryption method' )] [ValidateSet('SMIME', 'PGP', 'GINA')] [Alias('encp')] [String]$encModePer, # Param block domain [Parameter( ParameterSetName = 'domain', Mandatory = $true, HelpMessage = 'Restrict to eMail-domain-based encryption info' )] [switch]$domain, [Parameter( ParameterSetName = 'domain', Mandatory = $true, HelpMessage = 'Filter output to a specific encryption method' )] [ValidateSet('SMIME', 'PGP', 'HIN', 'TLS')] [Alias('encd')] [String]$encModeDom, # param Block used in 'eMail' and multiple paramsets [Parameter( ParameterSetName = 'personal', Mandatory = $false, HelpMessage = 'Define a specific eMail adress' )] [Parameter( ParameterSetName = 'eMail', Mandatory = $true, HelpMessage = 'Define a specific eMail adress' )] [ValidatePattern('([a-z0-9][-a-z0-9_\+\.]*[a-z0-9])@([a-z0-9][-a-z0-9\.]*[a-z0-9]\.(arpa|root|aero|biz|cat|com|coop|edu|gov|info|int|jobs|mil|mobi|museum|name|net|org|pro|tel|travel|ac|ad|ae|af|ag|ai|al|am|an|ao|aq|ar|as|at|au|aw|ax|az|ba|bb|bd|be|bf|bg|bh|bi|bj|bm|bn|bo|br|bs|bt|bv|bw|by|bz|ca|cc|cd|cf|cg|ch|ci|ck|cl|cm|cn|co|cr|cu|cv|cx|cy|cz|de|dj|dk|dm|do|dz|ec|ee|eg|er|es|et|eu|fi|fj|fk|fm|fo|fr|ga|gb|gd|ge|gf|gg|gh|gi|gl|gm|gn|gp|gq|gr|gs|gt|gu|gw|gy|hk|hm|hn|hr|ht|hu|id|ie|il|im|in|io|iq|ir|is|it|je|jm|jo|jp|ke|kg|kh|ki|km|kn|kr|kw|ky|kz|la|lb|lc|li|lk|lr|ls|lt|lu|lv|ly|ma|mc|md|mg|mh|mk|ml|mm|mn|mo|mp|mq|mr|ms|mt|mu|mv|mw|mx|my|mz|na|nc|ne|nf|ng|ni|nl|no|np|nr|nu|nz|om|pa|pe|pf|pg|ph|pk|pl|pm|pn|pr|ps|pt|pw|py|qa|re|ro|ru|rw|sa|sb|sc|sd|se|sg|sh|si|sj|sk|sl|sm|sn|so|sr|st|su|sv|sy|sz|tc|td|tf|tg|th|tj|tk|tl|tm|tn|to|tp|tr|tt|tv|tw|tz|ua|ug|uk|um|us|uy|uz|va|vc|ve|vg|vi|vn|vu|wf|ws|ye|yt|yu|za|zm|zw)|([0-9]{1,3}\.{3}[0-9]{1,3}))')] [Alias('eMail')] [string]$eMailAddress, [Parameter( ParameterSetName = 'personal', Mandatory = $false, HelpMessage = 'Rebuild cached encryption info database' )] [Parameter( ParameterSetName = 'domain', Mandatory = $false, HelpMessage = 'Rebuild cached encryption info database' )] [Parameter( ParameterSetName = 'eMail', Mandatory = $false, HelpMessage = 'Rebuild cached encryption info database' )] [switch]$rebuild = $false ) begin { Set-SLConfig | Out-Null $urlroot = New-SLUrlRoot -FQDN $SLConfig.SEPPmailFQDN -adminPort $SLConfig.adminPort } process { try { if ($PSCmdlet.ParameterSetName -eq 'personal') { #$uri = "{0}{1}{2}/personal{3}{4}" -f $urlroot, 'encinfo', ($encModePer ? '/' + $encModePer.ToUpper():$null), ($eMailAddress ? '?mailAddress=' + $eMailAddress.ToLower():$null), ($rebuild ? '?rebuildList=1':$null) Write-Verbose 'Constructing personal parameterset' $encModePerParam = if ($encModePer) { '/' + "$($encModePer.ToUpper())" } else { $null } $eMailParam = if ($eMailAddress) { '?mailAddress=' + "$($eMailAddress.ToLower())" } else { $null } $rebuildParam = if ($rebuild) { '?rebuildList=1' } else { $null } Write-Verbose "passing encModeParam: $EncModePerParam, eMailParam: $eMailParam, rebuildParam: $rebuildParam" $uri = "{0}{1}{2}/personal{3}{4}" -f $urlroot, 'encinfo', $encModeParam, $eMailParam, $rebuildParam Write-Verbose "Final URI: $URI" } elseif ($PSCmdlet.ParameterSetName -eq 'domain') { #$uri = "{0}{1}{2}/domain{3}" -f $urlroot, 'encinfo', ($encModeDom ? '/' + $encModeDom.ToUpper():$null), ($rebuild ? '?rebuildList=1':$null) Write-Verbose 'Constructing domain parameterset' $encModeDomParam = if ($encModeDom) { '/' + "$($encModeDom.ToUpper())" } else { $null } $rebuildParam = if ($rebuild) { '?rebuildList=1' } else { $null } Write-Verbose "passing encModeParam: $EncModeParam, eMailParam: $eMailParam, rebuildParam: $rebuildParam" $uri = "{0}{1}{2}/domain{3}" -f $urlroot, 'encinfo', $encModeDomParam, $rebuildParam Write-Verbose "Final URI: $URI" } elseif ($PSCmdlet.ParameterSetName -eq 'eMail') { $uri = "{0}{1}/?mailAddress={2}" -f $urlroot, 'encinfo', $eMailAddress } $rawdata = Invoke-RestMethod -Uri $uri -Method GET -Credential $SLConfig.secret switch ($PSCmdlet.ParameterSetname) { personal { Switch ($encModePer) { SMIME { return $rawdata.smime.personal } PGP { return $rawdata.pgp.personal } GINA { return $rawdata.gina.personal } } } domain { switch ($encModeDom) { SMIME { return $rawdata.smime.domain } PGP { return $rawdata.pgp.domain } HIN { return $rawdata.hin.domain } TLS { return $rawdata.tls.domain } } } { $returndata = New-Object -TypeName PSObject if ($rawdata.smime.domain.domain) { $returndata | Add-Member -MemberType Noteproperty -Name SMIMEdomain -Value $rawdata.smime.domain.domain } if ($rawdata.smime.personal.status) { $returndata | Add-Member -MemberType Noteproperty -Name SMIMEpersonal -Value $rawdata.smime.personal.status } if ($rawdata.pgp.domain.domain) { $returndata | Add-Member -MemberType Noteproperty -Name PGPdomain -Value $rawdata.pgp.domain.domain } if ($rawdata.pgp.personal.status) { $returndata | Add-Member -MemberType Noteproperty -Name PGPdomain -Value $rawdata.pgp.personal.status } if ($rawdata.hin.domain.domain) { $returndata | Add-Member -MemberType Noteproperty -Name HINdomain -Value $rawdata.hin.domain.domain } if ($rawdata.tls.domain.domain) { $returndata | Add-Member -MemberType Noteproperty -Name TLSdomain -Value $rawdata.tls.domain.domain } if ($rawdata.gina.personal.status) { $returndata | Add-Member -MemberType Noteproperty -Name GINAperonal -Value $rawdata.gina.personal.status } return $returndata } } } catch { Write-Error "Request to SEPPmail appliance failed with exception $($_.Exception)" } } end { } } <# .SYNOPSIS Create a GINA-User .DESCRIPTION This PS Module allows you to create and modify GINA Users. This avoids the registration process for external recipients and allows the usage of known passwords for the user (i.e. an invoice Number, social security number or similar) and the mobile number to communicate via a second channel. .EXAMPLE PS C:\> New-SLGINAUser -userName 'Max Mustermann' -eMailAddress max.mustermann@test.co -oneTimePw 'hZ76$59' -mobile '+49123456789' To create a new GINA user use the CmdLet as above. .EXAMPLE PS C:\> Import-Csv .\examples\NewGINAUsers.csv|New-SLGINAUser Use a CSV File (see examples folder) to bulk-create GINA Users. #> function New-SLGinaUser { [CmdletBinding()] param ( [Parameter( Mandatory = $true, ValueFromPipelineByPropertyName = $true, HelpMessage = 'GINA user eMail address' )] [ValidatePattern('([a-z0-9][-a-z0-9_\+\.]*[a-z0-9])@([a-z0-9][-a-z0-9\.]*[a-z0-9]\.(arpa|root|aero|biz|cat|com|coop|edu|gov|info|int|jobs|mil|mobi|museum|name|net|org|pro|tel|travel|ac|ad|ae|af|ag|ai|al|am|an|ao|aq|ar|as|at|au|aw|ax|az|ba|bb|bd|be|bf|bg|bh|bi|bj|bm|bn|bo|br|bs|bt|bv|bw|by|bz|ca|cc|cd|cf|cg|ch|ci|ck|cl|cm|cn|co|cr|cu|cv|cx|cy|cz|de|dj|dk|dm|do|dz|ec|ee|eg|er|es|et|eu|fi|fj|fk|fm|fo|fr|ga|gb|gd|ge|gf|gg|gh|gi|gl|gm|gn|gp|gq|gr|gs|gt|gu|gw|gy|hk|hm|hn|hr|ht|hu|id|ie|il|im|in|io|iq|ir|is|it|je|jm|jo|jp|ke|kg|kh|ki|km|kn|kr|kw|ky|kz|la|lb|lc|li|lk|lr|ls|lt|lu|lv|ly|ma|mc|md|mg|mh|mk|ml|mm|mn|mo|mp|mq|mr|ms|mt|mu|mv|mw|mx|my|mz|na|nc|ne|nf|ng|ni|nl|no|np|nr|nu|nz|om|pa|pe|pf|pg|ph|pk|pl|pm|pn|pr|ps|pt|pw|py|qa|re|ro|ru|rw|sa|sb|sc|sd|se|sg|sh|si|sj|sk|sl|sm|sn|so|sr|st|su|sv|sy|sz|tc|td|tf|tg|th|tj|tk|tl|tm|tn|to|tp|tr|tt|tv|tw|tz|ua|ug|uk|um|us|uy|uz|va|vc|ve|vg|vi|vn|vu|wf|ws|ye|yt|yu|za|zm|zw)|([0-9]{1,3}\.{3}[0-9]{1,3}))')] [Alias('email')] [string]$eMailAddress, [Parameter( Mandatory = $true, ValueFromPipelineByPropertyName = $true, HelpMessage = 'GINA user full name' )] [Alias('user')] [string]$userName, [Parameter( Mandatory = $true, ValueFromPipelineByPropertyName = $true, HelpMessage = 'GINA user password as string' )] [Alias('password')] [string]$Pwd, [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = 'GINA user mobile number including country code' )] [ValidatePattern('^([+](\d{1,3})\s?)?((\(\d{3,5}\)|\d{3,5})(\s)?)\d{3,8}$')] [string]$mobile, [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = "GINA user `'expired`' setting 0 or 1" )] [ValidateSet('0','1')] [string]$expired = '0', [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = 'GINA user passwort reset question' )] [string]$question, [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = 'GINA user passwort reset answer' )] [string]$answer, [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = 'For MSP´s and multi-customer environments, set the GINA users customer' )] [string]$customer ) begin { try { Set-SLConfig | Out-Null } catch { Write-error "Could not load configuration with set-SLConfig" Write-Error $_ } } process { try { $urlRoot = New-SLUrlRoot -FQDN $SLConfig.SEPPmailFQDN -adminPort $SLConfig.adminPort $uri = $urlRoot + 'newginauser' # V1.1 $uri = $urlRoot + 'ginauser/new' $userData = [ordered]@{ email = $eMailAddress password = $pwd name = $userName mobile = $mobile expired = $expired question = $question answer = $answer customer = $customer } | ConvertTo-Json $invokeParam = @{ Uri = $uri Method = 'POST ' Credential = $SLConfig.secret ContentType = "application/json" body = $userData } Write-Verbose "Creating new GINA User $userName with E-mailAdress $eMailAddress" $NewGinaUser = Invoke-RestMethod @invokeParam Write-Verbose "ErrorCode $($NewGinaUser.ErrorCode)" if (!($($NewGinaUser.errorCode))) { return $NewGinaUser.message } else { Write-Error "SEPPmail returned Error $($newGinaUser.errorCode): $($NewGinaUser.ErrorMessage)" } } catch { Write-Error "Request to SEPPmail failes with exception $($_.Exception)" } } end { } } <# .SYNOPSIS Update GINA Users properties .DESCRIPTION This CmdLet lets you modify and add additional properties on GINA Users. This CmdLet is also pipeline-aware. .EXAMPLE PS C:\> Set-SLGINAUser -eMailAddress 'alice.miller@contoso.com' -answer 'Red' Update a single property of a GINA User .EXAMPLE PS C:\> Import-Csv .\examples\UpdateGINAUsers.csv|Set-SLGINAUser Mass-update GINA Users #> function Set-SLGinaUser { [CmdletBinding(SupportsShouldProcess)] param ( [Parameter( Mandatory = $true, ValueFromPipelineByPropertyName = $true, HelpMessage = 'GINA user eMail adress' )] [ValidatePattern('([a-z0-9][-a-z0-9_\+\.]*[a-z0-9])@([a-z0-9][-a-z0-9\.]*[a-z0-9]\.(arpa|root|aero|biz|cat|com|coop|edu|gov|info|int|jobs|mil|mobi|museum|name|net|org|pro|tel|travel|ac|ad|ae|af|ag|ai|al|am|an|ao|aq|ar|as|at|au|aw|ax|az|ba|bb|bd|be|bf|bg|bh|bi|bj|bm|bn|bo|br|bs|bt|bv|bw|by|bz|ca|cc|cd|cf|cg|ch|ci|ck|cl|cm|cn|co|cr|cu|cv|cx|cy|cz|de|dj|dk|dm|do|dz|ec|ee|eg|er|es|et|eu|fi|fj|fk|fm|fo|fr|ga|gb|gd|ge|gf|gg|gh|gi|gl|gm|gn|gp|gq|gr|gs|gt|gu|gw|gy|hk|hm|hn|hr|ht|hu|id|ie|il|im|in|io|iq|ir|is|it|je|jm|jo|jp|ke|kg|kh|ki|km|kn|kr|kw|ky|kz|la|lb|lc|li|lk|lr|ls|lt|lu|lv|ly|ma|mc|md|mg|mh|mk|ml|mm|mn|mo|mp|mq|mr|ms|mt|mu|mv|mw|mx|my|mz|na|nc|ne|nf|ng|ni|nl|no|np|nr|nu|nz|om|pa|pe|pf|pg|ph|pk|pl|pm|pn|pr|ps|pt|pw|py|qa|re|ro|ru|rw|sa|sb|sc|sd|se|sg|sh|si|sj|sk|sl|sm|sn|so|sr|st|su|sv|sy|sz|tc|td|tf|tg|th|tj|tk|tl|tm|tn|to|tp|tr|tt|tv|tw|tz|ua|ug|uk|um|us|uy|uz|va|vc|ve|vg|vi|vn|vu|wf|ws|ye|yt|yu|za|zm|zw)|([0-9]{1,3}\.{3}[0-9]{1,3}))')] [Alias('email')] [string]$eMailAddress, [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = 'GINA user full name' )] [Alias('user')] [string]$userName, [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = 'GINA user password as string' )] [Alias('password')] [string]$pwd, [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = 'GINA user mobile number including country code, i.e. +4911122233344' )] [ValidatePattern('^([+](\d{1,3})\s?)?((\(\d{3,5}\)|\d{3,5})(\s)?)\d{3,8}$')] [string]$mobile, [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = "GINA user `'language`' setting e or d" )] [ValidateSet('e','d')] [string]$language = 'd', [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = "GINA user `'expired`' setting 0 or 1" )] [ValidateSet('0','1')] [string]$expired, [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = 'GINA user passwort reset question' )] [string]$question, [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = 'GINA user passwort reset answer' )] [string]$answer, [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = 'For MSP´s and multi-customer environments, set the GINA users customer' )] [string]$customer, [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = "GINA user `'ZIP attachment`' setting" )] [ValidateSet('0','1')] [string]$zip_attachment, [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = "GINA user `'created by`' information" )] [string]$creator ) begin { try { Set-SLConfig | Out-Null } catch { Write-error "Could not load configuration with Set-SLConfig" Write-Error "$error" } } process { try { $urlRoot = New-SLUrlRoot -FQDN $SLConfig.SEPPmailFQDN -adminPort $SLConfig.adminPort $uri = $urlRoot + 'modifyginauser' # V1.1 $uri = $urlRoot + 'ginauser/set' $userData = [ordered]@{ email = $eMailAddress name = $userName customer = $customer language = $language password = $password mobile = $mobile zip_attachment = $zip_attachment question = $question answer = $answer creator = $creator expired = $expired } | ConvertTo-Json $invokeParam = @{ Uri = $uri Method = 'POST ' Credential = $SLConfig.secret ContentType = "application/json" body = $userData } Write-Verbose "Modifying GINA User $EMailAddress using URL $uri" if ($PSCmdLet.ShouldProcess($($userdata.eMailAddress),'Update GINA User')) { $SetGinaUser = Invoke-RestMethod @invokeParam Write-Verbose "ErrorCode $($SetGinaUser.ErrorCode)" if (!($($SETGinaUser.errorCode))) { return $SetGinaUser.message } } else { Write-Error "SEPPmail returned Error $($SetGinaUser.errorCode): $($SetGinaUser.ErrorMessage)" } } catch { Write-Error "An error occured, see $error" } } end { if ($SetGinaUser) {return $SetGinaUser} } } <# .SYNOPSIS Get a GINA Users properties .DESCRIPTION This CmdLet lets youread properties on an existing GINA User. This CmdLet is also pipeline-aware. .EXAMPLE PS C:\> Get-SLGINAUser Get all GINA Users .EXAMPLE PS C:\> Get-SLGINAUser -eMailAddress 'alice.miller@contoso.com' Get information about a GINA User .EXAMPLE PS C:\> Import-Csv .\examples\UpdateGINAUsers.csv|Get-SLGINAUser Mass-receive GINA Users (test if they exist) #> function Get-SLGinaUser { [CmdletBinding(SupportsShouldProcess)] param ( [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = 'GINA user eMail adress' )] [ValidatePattern('([a-z0-9][-a-z0-9_\+\.]*[a-z0-9])@([a-z0-9][-a-z0-9\.]*[a-z0-9]\.(arpa|root|aero|biz|cat|com|coop|edu|gov|info|int|jobs|mil|mobi|museum|name|net|org|pro|tel|travel|ac|ad|ae|af|ag|ai|al|am|an|ao|aq|ar|as|at|au|aw|ax|az|ba|bb|bd|be|bf|bg|bh|bi|bj|bm|bn|bo|br|bs|bt|bv|bw|by|bz|ca|cc|cd|cf|cg|ch|ci|ck|cl|cm|cn|co|cr|cu|cv|cx|cy|cz|de|dj|dk|dm|do|dz|ec|ee|eg|er|es|et|eu|fi|fj|fk|fm|fo|fr|ga|gb|gd|ge|gf|gg|gh|gi|gl|gm|gn|gp|gq|gr|gs|gt|gu|gw|gy|hk|hm|hn|hr|ht|hu|id|ie|il|im|in|io|iq|ir|is|it|je|jm|jo|jp|ke|kg|kh|ki|km|kn|kr|kw|ky|kz|la|lb|lc|li|lk|lr|ls|lt|lu|lv|ly|ma|mc|md|mg|mh|mk|ml|mm|mn|mo|mp|mq|mr|ms|mt|mu|mv|mw|mx|my|mz|na|nc|ne|nf|ng|ni|nl|no|np|nr|nu|nz|om|pa|pe|pf|pg|ph|pk|pl|pm|pn|pr|ps|pt|pw|py|qa|re|ro|ru|rw|sa|sb|sc|sd|se|sg|sh|si|sj|sk|sl|sm|sn|so|sr|st|su|sv|sy|sz|tc|td|tf|tg|th|tj|tk|tl|tm|tn|to|tp|tr|tt|tv|tw|tz|ua|ug|uk|um|us|uy|uz|va|vc|ve|vg|vi|vn|vu|wf|ws|ye|yt|yu|za|zm|zw)|([0-9]{1,3}\.{3}[0-9]{1,3}))')] [Alias('email')] [string]$eMailAddress, [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = 'GINA user full name' )] [Alias('user')] [string]$userName, [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = 'GINA user mobile number including country code, i.e. +4911122233344 or 004911122233344' )] [ValidatePattern('^([+](\d{1,3})\s?)?((\(\d{3,5}\)|\d{3,5})(\s)?)\d{3,8}$')] [string]$mobile, [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = 'For MSP´s and multi-customer environments, set the GINA users customer' )] [string]$customer ) begin { try { Set-SLConfig | Out-Null } catch { Write-error "Could not load configuration with Set-SLConfig" Write-Error "$error" } } process { try { $urlRoot = New-SLUrlRoot -FQDN $SLConfig.SEPPmailFQDN -adminPort $SLConfig.adminPort Write-Verbose "Passing eMailAddress: $eMailAddress, userName: $userName, mobile: $mobile, customer: $customer" ############################# $uri = "{0}{1}{2}{3}{4}{5}" -f $urlroot, 'ginauser/get', $eMailAddress, $userName, $mobile, $customer ############################# $invokeParam = @{ Uri = $uri Method = 'GET' Credential = $SLConfig.secret ContentType = "application/json" } Write-Verbose "Receiving GINA Users using URL $uri" if ($PSCmdLet.ShouldProcess($uri,'Get GINA User')) { $GetGinaUser = Invoke-RestMethod @invokeParam Write-Verbose "ErrorCode $($SetGinaUser.ErrorCode)" if (!($($GetGinaUser.errorCode))) { return $GetGinaUser.message } } else { Write-Error "SEPPmail returned error $($SetGinaUser.errorCode): $($SetGinaUser.ErrorMessage)" } } catch { Write-Error "An error occured, see $error" } } end { if ($GetGinaUser) {return $GetGinaUser} } } # SIG # Begin signature block # MIIL1wYJKoZIhvcNAQcCoIILyDCCC8QCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB # gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR # AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUpDRe922PcItDHrO+QA5dZv1T # HMGggglAMIIEmTCCA4GgAwIBAgIQcaC3NpXdsa/COyuaGO5UyzANBgkqhkiG9w0B # AQsFADCBqTELMAkGA1UEBhMCVVMxFTATBgNVBAoTDHRoYXd0ZSwgSW5jLjEoMCYG # A1UECxMfQ2VydGlmaWNhdGlvbiBTZXJ2aWNlcyBEaXZpc2lvbjE4MDYGA1UECxMv # KGMpIDIwMDYgdGhhd3RlLCBJbmMuIC0gRm9yIGF1dGhvcml6ZWQgdXNlIG9ubHkx # HzAdBgNVBAMTFnRoYXd0ZSBQcmltYXJ5IFJvb3QgQ0EwHhcNMTMxMjEwMDAwMDAw # WhcNMjMxMjA5MjM1OTU5WjBMMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMdGhhd3Rl # LCBJbmMuMSYwJAYDVQQDEx10aGF3dGUgU0hBMjU2IENvZGUgU2lnbmluZyBDQTCC # ASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJtVAkwXBenQZsP8KK3TwP7v # 4Ol+1B72qhuRRv31Fu2YB1P6uocbfZ4fASerudJnyrcQJVP0476bkLjtI1xC72Ql # WOWIIhq+9ceu9b6KsRERkxoiqXRpwXS2aIengzD5ZPGx4zg+9NbB/BL+c1cXNVeK # 3VCNA/hmzcp2gxPI1w5xHeRjyboX+NG55IjSLCjIISANQbcL4i/CgOaIe1Nsw0Rj # gX9oR4wrKs9b9IxJYbpphf1rAHgFJmkTMIA4TvFaVcnFUNaqOIlHQ1z+TXOlScWT # af53lpqv84wOV7oz2Q7GQtMDd8S7Oa2R+fP3llw6ZKbtJ1fB6EDzU/K+KTT+X/kC # AwEAAaOCARcwggETMC8GCCsGAQUFBwEBBCMwITAfBggrBgEFBQcwAYYTaHR0cDov # L3QyLnN5bWNiLmNvbTASBgNVHRMBAf8ECDAGAQH/AgEAMDIGA1UdHwQrMCkwJ6Al # oCOGIWh0dHA6Ly90MS5zeW1jYi5jb20vVGhhd3RlUENBLmNybDAdBgNVHSUEFjAU # BggrBgEFBQcDAgYIKwYBBQUHAwMwDgYDVR0PAQH/BAQDAgEGMCkGA1UdEQQiMCCk # HjAcMRowGAYDVQQDExFTeW1hbnRlY1BLSS0xLTU2ODAdBgNVHQ4EFgQUV4abVLi+ # pimK5PbC4hMYiYXN3LcwHwYDVR0jBBgwFoAUe1tFz6/Oy3r9MZIaarbzRutXSFAw # DQYJKoZIhvcNAQELBQADggEBACQ79degNhPHQ/7wCYdo0ZgxbhLkPx4flntrTB6H # novFbKOxDHtQktWBnLGPLCm37vmRBbmOQfEs9tBZLZjgueqAAUdAlbg9nQO9ebs1 # tq2cTCf2Z0UQycW8h05Ve9KHu93cMO/G1GzMmTVtHOBg081ojylZS4mWCEbJjvx1 # T8XcCcxOJ4tEzQe8rATgtTOlh5/03XMMkeoSgW/jdfAetZNsRBfVPpfJvQcsVncf # hd1G6L/eLIGUo/flt6fBN591ylV3TV42KcqF2EVBcld1wHlb+jQQBm1kIEK3Osgf # HUZkAl/GR77wxDooVNr2Hk+aohlDpG9J+PxeQiAohItHIG4wggSfMIIDh6ADAgEC # AhBdMTrn+ZR0fTH9F/xerQI2MA0GCSqGSIb3DQEBCwUAMEwxCzAJBgNVBAYTAlVT # MRUwEwYDVQQKEwx0aGF3dGUsIEluYy4xJjAkBgNVBAMTHXRoYXd0ZSBTSEEyNTYg # Q29kZSBTaWduaW5nIENBMB4XDTIwMDMxNjAwMDAwMFoXDTIzMDMxNjIzNTk1OVow # XTELMAkGA1UEBhMCQ0gxDzANBgNVBAgMBkFhcmdhdTERMA8GA1UEBwwITmV1ZW5o # b2YxFDASBgNVBAoMC1NFUFBtYWlsIEFHMRQwEgYDVQQDDAtTRVBQbWFpbCBBRzCC # ASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKE54Nn5Vr8YcEcTv5k0vFyW # 26kzBt9Pe2UcawfjnyqvYpWeCuOXxy9XXif24RNuBROEc3eqV4EHbA9v+cOrE1me # 4HTct7byRM0AQCzobeFAyei3eyeDbvb963pUD+XrluCQS+L80n8yCmcOwB+weX+Y # j2CY7s3HZfbArzTxBHo5AKEDp9XxyoCc/tUQOq6vy+wdbOOfLhrNMkDDCsBWSLqi # jx3t1E+frAYF7tXaO5/FEGTeb/OjXqOpoooNL38FmCJh0CKby090sBJP5wSienn1 # NdhmBOKRL+0K3bomozoYmQscpT5AfWo4pFQm+8bG4QdNaT8AV4AHPb4zf23bxWUC # AwEAAaOCAWowggFmMAkGA1UdEwQCMAAwHwYDVR0jBBgwFoAUV4abVLi+pimK5PbC # 4hMYiYXN3LcwHQYDVR0OBBYEFPKf1Ta/8vAMTng2ZeBzXX5uhp8jMCsGA1UdHwQk # MCIwIKAeoByGGmh0dHA6Ly90bC5zeW1jYi5jb20vdGwuY3JsMA4GA1UdDwEB/wQE # AwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzBuBgNVHSAEZzBlMGMGBmeBDAEEATBZ # MCYGCCsGAQUFBwIBFhpodHRwczovL3d3dy50aGF3dGUuY29tL2NwczAvBggrBgEF # BQcCAjAjDCFodHRwczovL3d3dy50aGF3dGUuY29tL3JlcG9zaXRvcnkwVwYIKwYB # BQUHAQEESzBJMB8GCCsGAQUFBzABhhNodHRwOi8vdGwuc3ltY2QuY29tMCYGCCsG # AQUFBzAChhpodHRwOi8vdGwuc3ltY2IuY29tL3RsLmNydDANBgkqhkiG9w0BAQsF # AAOCAQEAdszNU8RMB6w9ylqyXG3EjWnvii7aigN0/8BNwZIeqLP9aVrHhDEIqz0R # u+KJG729SgrtLgc7OenqubaDLiLp7YICAsZBUae3a+MS7ifgVLuDKBSdsMEH+oRu # N1iGMfnAhykg0P5ltdRlNfDvQlIFiqGCcRaaGVC3fqo/pbPttbW37osyIxTgmB4h # EWs1jo8uDEHxw5qyBw/3CGkBhf5GNc9mUOHeEBMnzOesmlq7h9R2Q5FaPH74G9FX # xAG2z/rCA7Cwcww1Qgb1k+3d+FGvUmVGxJE45d2rVj1+alNc+ZcB9Ya9+8jhMssM # LjhJ1BfzUWeWdZqRGNsfFj+aZskwxjGCAgEwggH9AgEBMGAwTDELMAkGA1UEBhMC # VVMxFTATBgNVBAoTDHRoYXd0ZSwgSW5jLjEmMCQGA1UEAxMddGhhd3RlIFNIQTI1 # NiBDb2RlIFNpZ25pbmcgQ0ECEF0xOuf5lHR9Mf0X/F6tAjYwCQYFKw4DAhoFAKB4 # MBgGCisGAQQBgjcCAQwxCjAIoAKAAKECgAAwGQYJKoZIhvcNAQkDMQwGCisGAQQB # gjcCAQQwHAYKKwYBBAGCNwIBCzEOMAwGCisGAQQBgjcCARUwIwYJKoZIhvcNAQkE # MRYEFMFcFwlvMMwZo0GRoLW1Y2h596QZMA0GCSqGSIb3DQEBAQUABIIBABENttx+ # txAWPo0XV0ir65i3U1DumFUV2+ma7rRefMTWwDmEZJrG8NIFBGh9WrNr367R9YVM # tVQoyvqfVZCxrokHqdZqFrBPnYhlPTPQv/4LaL9gf+I74zNrLbeYUkaXdd88eCiy # U/FhXDum7fnN1/W+0dJX9vP9k/7RDUbqNOdlO19pGhIHsBsAzq1+1UpLoMBqCWyb # FLiDy1x6P9Vaor/YAV77cY9Xak2sg89pN7sqzrEf9jCKJ/yKg37rGkz1oEvLu54d # 0XGNyNUkKd6WXnCGN+Js+9ZC4QLbdszoLfHKEnu3thdfyFkJY0atKySkufGfgt5B # QH1r49KIHzoPSlI= # SIG # End signature block |