Public/Get-SnipeItUser.ps1
|
<# .SYNOPSIS # Gets a list of Snipe-it Users .PARAMETER search A text string to search the User data .PARAMETER id A id of specific User .PARAMETER username Search string for username field .PARAMETER email Search string for email field .PARAMETER limit Specify the number of results you wish to return. Defaults to 50. Defines batch size for -all .PARAMETER offset Offset to use .PARAMETER all A return all results, works with -offset and other parameters .PARAMETER url URL of Snipeit system, can be set using Set-SnipeItInfo command .PARAMETER apiKey Users API Key for Snipeit, can be set using Set-SnipeItInfo command .EXAMPLE Get-SnipeItUser -search SomeSurname .EXAMPLE Get-SnipeItUser -id 3 .EXAMPLE Get-SnipeItUser -username someuser .EXAMPLE Get-SnipeItUser -email user@somedomain.com #> function Get-SnipeItUser() { Param( [parameter(ParameterSetName='Search')] [string]$search, [parameter(ParameterSetName='Get with ID')] [string]$id, [parameter(ParameterSetName='Search')] [int]$company_id, [parameter(ParameterSetName='Search')] [int]$location_id, [parameter(ParameterSetName='Search')] [int]$group_id, [parameter(ParameterSetName='Search')] [int]$department_id, [parameter(ParameterSetName='Search')] [string]$username, [parameter(ParameterSetName='Search')] [string]$email, [parameter(ParameterSetName='Search')] [ValidateSet("asc", "desc")] [string]$order = "desc", [parameter(ParameterSetName='Search')] [int]$limit = 50, [parameter(ParameterSetName='Search')] [int]$offset, [parameter(ParameterSetName='Search')] [switch]$all = $false, [parameter(mandatory = $true)] [string]$url, [parameter(mandatory = $true)] [string]$apiKey ) Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name $SearchParameter = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters $apiurl = "$url/api/v1/users" if ($search -and $id ) { Throw "[$($MyInvocation.MyCommand.Name)] Please specify only -search or -id parameter , not both " } if ($id) { $apiurl= "$url/api/v1/users/$id" } $Parameters = @{ Uri = $apiurl Method = 'Get' GetParameters = $SearchParameter Token = $apiKey } if ($all) { $offstart = $(if($offset){$offset} Else {0}) $callargs = $SearchParameter $callargs.Remove('all') while ($true) { $callargs['offset'] = $offstart $callargs['limit'] = $limit $res=Get-SnipeItUser @callargs $res if ($res.count -lt $limit) { break } $offstart = $offstart + $limit } } else { $result = Invoke-SnipeitMethod @Parameters $result } } |