New-HipchatUser

NAME New-HipchatUser



SYNOPSIS

Creates a new HipChat user account.





SYNTAX

New-HipchatUser [-FirstName] <String> [-LastName] <String> -EmailAddress <String> -ApiToken <String> [-MentionName

<String>] [<CommonParameters>]





DESCRIPTION

Creates a new HipChat user account using HipChat's API. The mention name is

the user's first name and last name by default, but a custom mention name

can be provided.





PARAMETERS

-FirstName <String>

Required: The user's first name.



Required? true

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-LastName <String>

Required: The user's last name.



Required? true

Position? 2

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-EmailAddress <String>

Required: The user's e-mail address.



Required? true

Position? named

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

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-MentionName <String>

Optional: The mention name (@MentionName) that should be used, if different

from the default first name last name format.



Required? false

Position? named

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:\\>New-HipchatUser -FirstName 'John' -LastName 'Smith' -EmailAddress 'jsmith@example.com' -ApiToken

'REXsCauSe553gsoIJg1Gj4zwNsSAwS'



Creates an account for John Smith, with a mention name of @JohnSmith.









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



PS C:\\>New-HipchatUser 'John' 'Smith' -EmailAddress 'jsmith@example.com' '-MentionName 'Jay.Smith' -ApiToken

'REXsCauSe553gsoIJg1Gj4zwNsSAwS'



Creates an account for John Smith with a custom mention name of @jay.smith.











RELATED LINKS