SnipeitPS/SnipeitPS/Public/Get-User.ps1

56 lines
1.1 KiB
PowerShell

<#
.SYNOPSIS
# Gets a list of Snipe-it Users
.PARAMETER url
URL of Snipeit system, can be set using Set-Info command
.PARAMETER apiKey
Users API Key for Snipeit, can be set using Set-Info command
.EXAMPLE
Get-User -url "https://assets.example.com" -token "token..."
.EXAMPLE
Get-User -url "https://assets.example.com" -token "token..." | Where-Object {$_.username -eq "stephenm" }
#>
function Get-User() {
Param(
[string]$search,
[int]$company_id,
[int]$location_id,
[int]$group_id,
[int]$department_id,
[ValidateSet("asc", "desc")]
[string]$order = "desc",
[int]$limit = 50,
[int]$offset,
[parameter(mandatory = $true)]
[string]$url,
[parameter(mandatory = $true)]
[string]$apiKey
)
$SearchParameter = . Get-ParameterValue
$Parameters = @{
Uri = "$url/api/v1/users"
Method = 'Get'
GetParameters = $SearchParameter
Token = $apiKey
}
$result = Invoke-SnipeitMethod @Parameters
$result
}