< Back

Get-HipchatUser

Tue Jan 14, 2020 1:11 am

NAME Get-HipchatUser



SYNOPSIS

Returns a list of all HipChat users.





SYNTAX

Get-HipchatUser [-ApiToken] <String> [<CommonParameters>]





DESCRIPTION

Returns a list of all existing HipChat user accounts.





PARAMETERS

-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? 1

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/15/17

Purpose/Change: Added object output.



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



PS C:\\>Get-HipchatUser -ApiToken 'REXsCauSe553gsoIJg1Gj4zwNsSAwS'



Returns a list of all HipChat users' names and mention names.











RELATED LINKS