Feature: User

[lipkau]

The following functionality should be supported by the module:

Create a new user

• New-HipChatUser
  POST /v2/user

Parameter

• -Name
  • Mandatory: yes
  • **Type: ** string
  • Min length: 1
  • Max length: 50
• -Roles
  • Mandatory: no
  • **Type: ** Array
  • Investigate where to get allowed values from
• -Title
  • Mandatory: no
  • **Type: ** string
• -MentionName
  • Mandatory: no
  • **Type: ** string
• -GroupAdmin
  • Mandatory: no
  • **Type: ** switch
  • maybe find a better name?
• -Timezone
  • Mandatory: no
  • **Type: ** string
  • Investigate valid values
• -Password
  • Mandatory: no
  • **Type: ** secure string
• -Email
  • Mandatory: yes
  • **Type: ** string
  • Validate if email is ok
• -$PassThru
  • Mandatory: no
  • Type: switch

Output

[HipChatPS.User]

if ($PassThru) {Get-HipChatUser -Id $resonse.id}

Get User

• Get-HipChatUser

No Parameter

GET /v2/user

Parameter

GET /v2/user/{id_or_email}

• -Id
  • Mandatory: yes, within ParameterSet
  • ValueFromPipelineByProperty: yes
  • type: Int
  • Validate $_ to by of type [HipChatPS.User]
• -Email
  • Mandatory: yes, within ParameterSet
  • type: String[]

Output

[HipChatPS.User]

Update a user

• Set-HipChatUser
  PUT /v2/user/{id_or_email}

Parameter

• -Id
  • Mandatory: yes, within ParameterSet
  • ValueFromPipelineByProperty: yes
  • type: Int
  • Validate $_ to by of type [HipChatPS.User]
• -Email
  • Mandatory: yes, within ParameterSet
  • type: String[]
• [String]Name
• [Array]Roles
• [String]Title
• [Hashtable]Presence @{status ; show}
• [string]MentionName
• [Switch]GroupAdmin
• [String]Timezone
• [SecureString]Password
• [String]NewEmail

Output

[HipChatPS.User]

Delete a user

• Remove-HipChatUser
  DELETE /v2/user/{id_or_email}

Parameter

• -Id
  • Mandatory: yes, within ParameterSet
  • ValueFromPipelineByProperty: yes
  • type: Int
  • Validate $_ to by of type [HipChatPS.User]
• -Email
  • Mandatory: yes, within ParameterSet
  • type: String[]

Output

Bool