Get CteraUser - dfch/biz.dfch.PS.Storebox.Api GitHub Wiki
NAME
Get-CteraUser
SYNOPSIS
Gets Storebox Users from currently selected Portal on a given UriPortal.
SYNTAX
Get-CteraUser [[-PortalName] <String>] [-Username] <String> [-Session <Hashtable>] [<CommonParameters>]
Get-CteraUser [[-Filter] <String>] [-Session <Hashtable>] [-ListAvailable] [<CommonParameters>]
DESCRIPTION
Gets Storebox Users from currently selected Portal on a given UriPortal.
For more information about Cmdlets see 'about_Functions_CmdletBindingAttribute'.
PARAMETERS
-PortalName <String>
The name of a Storebox Portal to select.
Required? false
Position? 2
Default value $biz_dfch_PS_Storebox_Api.PortalName
Accept pipeline input? false
Accept wildcard characters? false
-Username <String>
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Filter <String>
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Session <Hashtable>
Required? false
Position? named
Default value $biz_dfch_PS_Storebox_Api.Session
Accept pipeline input? false
Accept wildcard characters? false
-ListAvailable [<SwitchParameter>]
Required? true
Position? 1
Default value False
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
See PARAMETER section for a description of input parameters.
For more information about input parameters see 'help about_Functions_Advanced_Parameters'.
OUTPUTS
This Cmdlet returns a HtmlWebResponseObject parameter. On failure the string contains $null.
For more information about output parameters see 'help about_Functions_OutputTypeAttribute'.
NOTES
Requires Powershell v3.
Requires module 'biz.dfch.PS.System.Logging'.
EXAMPLE1
C:\PS>Perform a login to a StoreBox server with username and plaintext password.
Get-User -UriPortal 'https://promo.ds01.swisscom.com' -Username 'PeterLustig' -Password 'S0nnensch3!n'
EXAMPLE2
C:\PS>Perform a login to a StoreBox server with username and encrypted password.
Get-User -UriPortal 'https://promo.ds01.swisscom.com' -Username 'PeterLustig' -Credentials [PSCredentials]
RELATED LINKS
Online Version: http://dfch.biz/PS/Storebox/Api/Get-User/
Enter-Ctera