Remove-PASGroupMember
Remove-PASGroupMember
SYNOPSIS
Removes a vault user from a group
SYNTAX
Remove-PASGroupMember [-GroupID] <String> [-Member] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Removes an existing member from an existing group in the vault
EXAMPLES
EXAMPLE 1
Remove-PASGroupMember -GroupID X1_Y2 -Member TargetUser
Removes TargetUser from group
EXAMPLE 2
Get-PASGroup -groupName "Domain Admins" | Remove-PASGroupMember -Member Bob
Finds the group named “Domain Admins” and removes Bob as a member, using the id value supplied via the pipeline
EXAMPLE 3
Remove-PASGroupMember -GroupID X1_Y2 -Member TargetUser -WhatIf
Shows what would happen if TargetUser was removed from the group, without making the change
EXAMPLE 4
'Bob','Alice' | ForEach-Object { Remove-PASGroupMember -GroupID X1_Y2 -Member $_ }
Removes both Bob and Alice from the group with id X1_Y2
PARAMETERS
-GroupID
The ID of the group
Type: String
Parameter Sets: (All)
Aliases: ID
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Member
The name of the group member
Type: String
Parameter Sets: (All)
Aliases: UserName
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
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.