mirror of
https://github.com/snazy2000/SnipeitPS.git
synced 2025-12-14 02:12:29 +00:00
104 lines
2.2 KiB
PowerShell
104 lines
2.2 KiB
PowerShell
<#
|
|
.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 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-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,
|
|
|
|
[string]$id,
|
|
|
|
[int]$company_id,
|
|
|
|
[int]$location_id,
|
|
|
|
[int]$group_id,
|
|
|
|
[int]$department_id,
|
|
|
|
[string]$username,
|
|
|
|
[string]$email,
|
|
|
|
[ValidateSet("asc", "desc")]
|
|
[string]$order = "desc",
|
|
|
|
[int]$limit = 50,
|
|
|
|
[int]$offset,
|
|
|
|
[switch]$all = $false,
|
|
|
|
[parameter(mandatory = $true)]
|
|
[string]$url,
|
|
|
|
[parameter(mandatory = $true)]
|
|
[string]$apiKey
|
|
)
|
|
|
|
$SearchParameter = . Get-ParameterValue $MyInvocation.MyCommand.Parameters
|
|
|
|
$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-User @callargs
|
|
$res
|
|
if ($res.count -lt $limit) {
|
|
break
|
|
}
|
|
$offstart = $offstart + $limit
|
|
}
|
|
} else {
|
|
$result = Invoke-SnipeitMethod @Parameters
|
|
$result
|
|
}
|
|
}
|