SnipeitPS/docs/Get-User.md
2017-11-20 09:07:58 +00:00

1.1 KiB

external help file Module Name online version schema
SnipeItPS-help.xml SnipeItPS 2.0.0

Get-User

SYNOPSIS

Gets a list of Snipe-it Users

SYNTAX

Get-User [-url] <String> [-apiKey] <String>

DESCRIPTION

{{Fill in the Description}}

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

Get-User -url "https://assets.example.com" -token "token..."

-------------------------- EXAMPLE 2 --------------------------

Get-User -url "https://assets.example.com" -token "token..." | Where-Object {$_.username -eq "stephenm" }

PARAMETERS

-url

URL of Snipeit system, can be set using Set-Info command

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-apiKey

Users API Key for Snipeit, can be set using Set-Info command

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

INPUTS

OUTPUTS

NOTES