SnipeitPS/docs/Get-SnipeitUser.md

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

Get-SnipeitUser

SYNOPSIS

Gets a list of Snipe-it Users

SYNTAX

Search (Default)

Get-SnipeitUser [-search <String>] [-company_id <Int32>] [-location_id <Int32>] [-group_id <Int32>]
 [-department_id <Int32>] [-username <String>] [-email <String>] [-order <String>] [-limit <Int32>]
 [-offset <Int32>] [-all] -url <String> -apiKey <String> [<CommonParameters>]

Get with ID

Get-SnipeitUser [-id <String>] -url <String> -apiKey <String> [<CommonParameters>]

Get users a specific accessory id has been checked out to

Get-SnipeitUser [-accessory_id <String>] [-all] -url <String> -apiKey <String> [<CommonParameters>]

DESCRIPTION

{{ Fill in the Description }}

EXAMPLES

EXAMPLE 1

Get-SnipeitUser -search SomeSurname

EXAMPLE 2

Get-SnipeitUser -id 3

EXAMPLE 3

Get-SnipeitUser -username someuser

EXAMPLE 4

Get-SnipeitUser -email user@somedomain.com

EXAMPLE 5

Get-SnipeitUser -accessory_id 3
Get users with accessory id 3 has been checked out to

PARAMETERS

-search

A text string to search the User data

Type: String
Parameter Sets: Search
Aliases:

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

-id

A id of specific User

Type: String
Parameter Sets: Get with ID
Aliases:

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

-accessory_id

{{ Fill accessory_id Description }}

Type: String
Parameter Sets: Get users a specific accessory id has been checked out to
Aliases:

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

-company_id

{{ Fill company_id Description }}

Type: Int32
Parameter Sets: Search
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-location_id

{{ Fill location_id Description }}

Type: Int32
Parameter Sets: Search
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-group_id

{{ Fill group_id Description }}

Type: Int32
Parameter Sets: Search
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-department_id

{{ Fill department_id Description }}

Type: Int32
Parameter Sets: Search
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-username

Search string for username field

Type: String
Parameter Sets: Search
Aliases:

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

-email

Search string for email field

Type: String
Parameter Sets: Search
Aliases:

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

-order

{{ Fill order Description }}

Type: String
Parameter Sets: Search
Aliases:

Required: False
Position: Named
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False

-limit

Specify the number of results you wish to return. Defaults to 50. Defines batch size for -all

Type: Int32
Parameter Sets: Search
Aliases:

Required: False
Position: Named
Default value: 50
Accept pipeline input: False
Accept wildcard characters: False

-offset

Offset to use

Type: Int32
Parameter Sets: Search
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-all

A return all results, works with -offset and other parameters

Type: SwitchParameter
Parameter Sets: Search, Get users a specific accessory id has been checked out to
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-url

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

Type: String
Parameter Sets: (All)
Aliases:

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

-apiKey

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

Type: String
Parameter Sets: (All)
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS