4.2 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 [[-search] <String>] [[-id] <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>]
DESCRIPTION
{{ Fill in the Description }}
EXAMPLES
EXAMPLE 1
Get-User -search SomeSurname
EXAMPLE 2
Get-User -id 3
EXAMPLE 3
Get-User -username someuser
EXAMPLE 4
Get-User -email user@somedomain.com
PARAMETERS
-all
A return all results, works with -offset and other parameters
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
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: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-company_id
{{ Fill company_id Description }}
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-department_id
{{ Fill department_id Description }}
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
Search string for email field
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-group_id
{{ Fill group_id Description }}
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-id
A id of specific User
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
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: (All)
Aliases:
Required: False
Position: 10
Default value: 50
Accept pipeline input: False
Accept wildcard characters: False
-location_id
{{ Fill location_id Description }}
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-offset
Offset to use
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-order
{{ Fill order Description }}
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
-search
A text string to search the User data
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-url
URL of Snipeit system, can be set using Set-Info command
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-username
Search string for username field
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
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.