Get-WssUser
Get-WssUser
Retrieves a user account by name or security identifier.
Syntax
Parameter Set: ByNameParamSet
Get-WssUser [-Name] <String> [ <CommonParameters>]
Parameter Set: BySidParamSet
Get-WssUser [-Sid] <String> [ <CommonParameters>]
Detailed Description
The Get-WssUser cmdlet retrieves a server user account. To retrieve a user account by name, specify the login name. To retrieve a user account by security identifier, specify the SID. To retrieve all user accounts, use the cmdlet without arguments.
Parameters
-Name<String>
Specifies the logon name of a user.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Sid<String>
Specifies the security identifier of a user.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Retrieve a user account by name
This command retrieves a user account by name.
PS C:\> Get-WSSUser -Name "SarahJones"