Public/Software/Get-FreshServiceSoftwareUser.ps1
|
<#
.SYNOPSIS Returns a Freshservice application (i.e. software) user. .DESCRIPTION Returns a Freshservice application (i.e. software) user via REST API. https://api.freshservice.com/#view_user .PARAMETER software_id Unique id of the Software to get users. .PARAMETER Id Unique id of the Software user. .PARAMETER per_page Number of records to return per page during pagination. Maximum of 100 records. .PARAMETER page The page number to retrieve during pagination. .EXAMPLE Get-FreshServiceSoftwareUser -software_id 21000240239 additional_data : @{usage=; last_sync_date=} id : 21000064393 user_id : 21000418006 license_id : allocated_date : 8/29/2022 4:00:00 AM first_used : 8/29/2022 4:00:00 AM last_used : 8/29/2022 4:00:00 AM sources : {} created_at : 8/29/2022 2:17:55 PM updated_at : 8/29/2022 2:17:55 PM Returns all Freshservice Sofware Users. .EXAMPLE Get-FreshServiceSoftwareUser -software_id 21000240239 -id 21000064393 additional_data : @{usage=; last_sync_date=} id : 21000064393 user_id : 21000418006 license_id : allocated_date : 8/29/2022 4:00:00 AM first_used : 8/29/2022 4:00:00 AM last_used : 8/29/2022 4:00:00 AM sources : {} created_at : 8/29/2022 2:17:55 PM updated_at : 8/29/2022 2:17:55 PM Returns a Freshservice Software User by Id. .NOTES This module was developed and tested with Freshservice REST API v2. #> function Get-FreshServiceSoftwareUser { [CmdletBinding(DefaultParameterSetName = 'default')] param ( [Parameter( Mandatory = $true, HelpMessage = 'Unique id of the software to get user information from.', ParameterSetName = 'default', Position = 0 )] [Alias('applicationid')] [long]$software_id, [Parameter( Mandatory = $false, HelpMessage = 'Unique id of the Product.', ParameterSetName = 'default', Position = 0 )] [long]$Id, [Parameter( Mandatory = $false, HelpMessage = 'Number of records per page returned during pagination. Default is 30. Max is 100.', ParameterSetName = 'default', Position = 1 )] [int]$per_page = 100, [Parameter( Mandatory = $false, HelpMessage = 'Page number to begin record return.', ParameterSetName = 'default', Position = 2 )] [int]$page = 1 ) 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." } $qry = [System.Web.HttpUtility]::ParseQueryString([String]::Empty) $uri = [System.UriBuilder]('{0}/applications' -f $PrivateData['FreshserviceBaseUri']) $enablePagination = $true } process { if ($software_id) { $uri.Path = "{0}/{1}/users" -f $uri.Path, $software_id } if ($id) { $uri.Path = "{0}/{1}" -f $uri.Path, $Id $enablePagination = $false } try { if ($enablePagination) { $qry['page'] = $page $qry['per_page'] = $per_page } $uri.Query = $qry.ToString() $uri = $uri.Uri.AbsoluteUri do { $params = @{ Uri = $uri Method = 'GET' 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)" } if ($result.Headers.Link) { $uri = [regex]::Matches($result.Headers.Link,'<(?<Uri>.*)>')[0].Groups['Uri'].Value } } until (!$result.Headers.Link) } catch { Throw $_ } } end {} } |