Remove-ePoUser

NAME Remove-ePoUser



SYNOPSIS

Removes a user from ePo API.





SYNTAX

Remove-ePoUser -UserID <String> [-WhatIf] [-Confirm] [<CommonParameters>]



Remove-ePoUser -UserName <String> [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

Removes the specifed user from ePo API using the core.removeUser API command. Needs either the Unique ID or Name

of the user to remove





PARAMETERS

-UserID <String>



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-UserName <String>



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES





Removes user using the core.removeUser API Command. Requires Global Administrator privilege on ePoServer.



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Remove-ePoUser -UserName "network"



Removes the user with the unique username network









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>$UserID = Get-ePoUser | Where {$_.FullName -like "Mark*"} | Remove-ePoUser



Gets the users that have Full Names like Mark* and pipes them to Remove-ePoUser, using the UserID property of the

Get-ePoUser function.

This will remove each user account with a full name beginning with Mark.











RELATED LINKS

https://github.com/Kreloc