Remove-HipchatUser

NAME Remove-HipchatUser



SYNOPSIS

Removes an existing HipChat user account.





SYNTAX

Remove-HipchatUser [[-MentionName] <String>] [[-EmailAddress] <String>] [-ApiToken] <String> [<CommonParameters>]





DESCRIPTION

Removes an existing HipChat user account using HipChat's API. This cmdlet

accepts the e-mail address or mention name (@ name) of the user.





PARAMETERS

-MentionName <String>

Required: The user's mention name (@ name).



Required? false

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-EmailAddress <String>

Required: The user's e-mail address.



Required? false

Position? 2

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-ApiToken <String>

Required: Your HipChat API Token. You can obtain an API Token from the

HipChat website by navigating to Account Settings > API Access.



Required? true

Position? 3

Default value

Accept pipeline input? true (ByValue)

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





Version: 1.0

Author: Corey Fonseca

Creation Date: 3/17/17

Purpose/Change: Full Functionality



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



PS C:\\>Remove-HipchatUser -MentionName 'JohnSmith' -ApiToken 'REXsCauSe553gsoIJg1Gj4zwNsSAwS'



Removes the user account associated with the mention name '@JohnSmith'.









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



PS C:\\>Remove-HipchatUser -EmailAddress 'jsmith@example.com' -ApiToken 'REXsCauSe553gsoIJg1Gj4zwNsSAwS'



Removes the user account associated with 'jsmith@example.com'.











RELATED LINKS