Public/New-FreshServiceSoftwareUser.ps1
|
<#
.SYNOPSIS Creates a new Freshservice Software User. .DESCRIPTION Creates a new Freshservice Software User via REST API. https://api.freshservice.com/#bulk_create_users .PARAMETER id Unique Id of the software to add the user. .PARAMETER user_id Unique id of the User using the Software. .PARAMETER license_id Display ID of the allocated Software License Contract. .PARAMETER allocated_date Date and time when the license was allocated. .PARAMETER first_used Date and time when the application was first used by the user. .PARAMETER last_used Date and time when the application was last used by the user. .PARAMETER source Name of the source from where the user details are updated (API, Okta, Google...etc). .EXAMPLE $suParams = @{ software_id = 21000240239 #Get-FreshworksSoftware user_id = 21000418006 #Get-FreshServiceRequester license_id = 23 #Get-FreshserviceContract allocated_date = (Get-Date -Date '10/10/2019 12:00:00 AM') first_used = (Get-Date -Date '11/10/2019 12:00:00 AM') last_used = Get-Date source = 'API' } New-FSSoftwareUser @suParams api/v2/applications/21000240239/users/21000064393 Associate a user with software and a specific contract license. .NOTES This module was developed and tested with Freshservice REST API v2. #> function New-FreshServiceSoftwareUser { [CmdletBinding(SupportsShouldProcess=$true, ConfirmImpact='Medium')] param ( [Parameter( Mandatory = $true, HelpMessage = 'Unique Id of the software.', ValueFromPipelineByPropertyName = $true )] [Alias('software_id')] [long]$id, [Parameter( Mandatory = $true, HelpMessage = 'Unique id of the User using the Software. ', ValueFromPipelineByPropertyName = $true )] [long]$user_id, [Parameter( Mandatory = $false, HelpMessage = 'Display ID of the allocated Software License Contract.', ValueFromPipelineByPropertyName = $true )] [long]$license_id, [Parameter( Mandatory = $false, HelpMessage = 'Date and time when the license was allocated.', ValueFromPipelineByPropertyName = $true )] [datetime]$allocated_date, [Parameter( Mandatory = $false, HelpMessage = 'Date and time when the application was first used by the user.', ValueFromPipelineByPropertyName = $true )] [datetime]$first_used, [Parameter( Mandatory = $false, HelpMessage = 'Date and time when the application was last used by the user.', ValueFromPipelineByPropertyName = $true )] [datetime]$last_used, [Parameter( Mandatory = $false, HelpMessage = 'Name of the source from where the user details are updated (API, Okta, Google...etc).', ValueFromPipelineByPropertyName = $true )] [string]$source ) begin { $PrivateData = $MyInvocation.MyCommand.Module.PrivateData if (!$PrivateData.FreshserviceBaseUri) { throw "No connection found! Setup a new Freshservice connection with New-FreshServiceConnection and then Connect-FreshService. Set a default connection with New-FreshServiceConnection or Set-FreshConnection to automatically connect when importing the module." } $uri = [System.UriBuilder]('{0}/applications' -f $PrivateData['FreshserviceBaseUri']) $newRecords = @() if ($id) { $uri.Path = "{0}/{1}/users" -f $uri.Path, $id [void]$PSBoundParameters.Remove('id') } } process { $jsonBody = @{} $PSBoundParameters.keys.where{ $PSItem -notin $PrivateData.FreshserviceBodyExclusions }.foreach{ if ($PSBoundParameters[$PSItem] -is [datetime]) { $jsonBody[$PSItem.ToLower()] = Get-Date -Date $PSBoundParameters[$PSItem] -Format "o" } else { $jsonBody[$PSItem.ToLower()] = $PSBoundParameters[$PSItem] } } foreach ($id in $user_id) { $newRecords += [PSCustomobject[]]$jsonBody } } end { try { if ($PSCmdlet.ShouldProcess($uri.Uri.AbsoluteUri)) { $params = @{ Uri = $uri.Uri.AbsoluteUri Method = 'POST' Body = [PSCustomObject]@{application_users = $newRecords} | ConvertTo-Json ErrorAction = 'Stop' } $result = Invoke-FreshworksRestMethod @params if ($result.Content) { $content = $result.Content | ConvertFrom-Json #API returns singluar or plural property based on the number of records, parse to get property returned. $objProperty = $content[0].PSObject.Properties.Name Write-Verbose -Message ("Returning {0} property with count {1}" -f $objProperty, $content."$($objProperty)".Count) $content."$($objProperty)" } } } catch { Throw $_ } } } |