Get-VcUser¶
SYNOPSIS¶
Get user details
SYNTAX¶
Id (Default)¶
Get-VcUser -ID <String[]> [-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Me¶
Get-VcUser [-Me] [-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
All¶
Get-VcUser [-All] [-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION¶
Returns user information for TLSPC.
EXAMPLES¶
EXAMPLE 1¶
Get user details from an id
EXAMPLE 2¶
Get user details from a username
EXAMPLE 3¶
Get user details for authenticated/current user
EXAMPLE 4¶
Get all users
PARAMETERS¶
-ID¶
Either be the user id (guid) or username which is the email address.
Type: String[]
Parameter Sets: Id
Aliases: userId, owningUser, owningUsers, owningUserId
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Me¶
Returns details of the authenticated/current user
Type: SwitchParameter
Parameter Sets: Me
Aliases:
Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-All¶
Return a complete list of local users.
Type: SwitchParameter
Parameter Sets: All
Aliases:
Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-VenafiSession¶
Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TLSPC key can also provided.
Type: PSObject
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction¶
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.