mirror of
https://github.com/snazy2000/SnipeitPS.git
synced 2025-12-13 01:42:29 +00:00
275 lines
4.4 KiB
Markdown
275 lines
4.4 KiB
Markdown
---
|
|
external help file: SnipeItPS-help.xml
|
|
Module Name: SnipeitPS
|
|
online version:
|
|
schema: 2.0.0
|
|
---
|
|
|
|
# Get-SnipeItUser
|
|
|
|
## SYNOPSIS
|
|
# Gets a list of Snipe-it Users
|
|
|
|
## SYNTAX
|
|
|
|
### Search
|
|
```
|
|
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>]
|
|
```
|
|
|
|
## 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
|
|
```
|
|
|
|
## PARAMETERS
|
|
|
|
### -all
|
|
A return all results, works with -offset and other parameters
|
|
|
|
```yaml
|
|
Type: SwitchParameter
|
|
Parameter Sets: Search
|
|
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-SnipeItInfo command
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Required: True
|
|
Position: Named
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -company_id
|
|
{{ Fill company_id Description }}
|
|
|
|
```yaml
|
|
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 }}
|
|
|
|
```yaml
|
|
Type: Int32
|
|
Parameter Sets: Search
|
|
Aliases:
|
|
|
|
Required: False
|
|
Position: Named
|
|
Default value: 0
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -email
|
|
Search string for email field
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: Search
|
|
Aliases:
|
|
|
|
Required: False
|
|
Position: Named
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -group_id
|
|
{{ Fill group_id Description }}
|
|
|
|
```yaml
|
|
Type: Int32
|
|
Parameter Sets: Search
|
|
Aliases:
|
|
|
|
Required: False
|
|
Position: Named
|
|
Default value: 0
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -id
|
|
A id of specific User
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: Get with ID
|
|
Aliases:
|
|
|
|
Required: False
|
|
Position: Named
|
|
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
|
|
|
|
```yaml
|
|
Type: Int32
|
|
Parameter Sets: Search
|
|
Aliases:
|
|
|
|
Required: False
|
|
Position: Named
|
|
Default value: 50
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -location_id
|
|
{{ Fill location_id Description }}
|
|
|
|
```yaml
|
|
Type: Int32
|
|
Parameter Sets: Search
|
|
Aliases:
|
|
|
|
Required: False
|
|
Position: Named
|
|
Default value: 0
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -offset
|
|
Offset to use
|
|
|
|
```yaml
|
|
Type: Int32
|
|
Parameter Sets: Search
|
|
Aliases:
|
|
|
|
Required: False
|
|
Position: Named
|
|
Default value: 0
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -order
|
|
{{ Fill order Description }}
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: Search
|
|
Aliases:
|
|
|
|
Required: False
|
|
Position: Named
|
|
Default value: Desc
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -search
|
|
A text string to search the User data
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: Search
|
|
Aliases:
|
|
|
|
Required: False
|
|
Position: Named
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -url
|
|
URL of Snipeit system, can be set using Set-SnipeItInfo command
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Required: True
|
|
Position: Named
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -username
|
|
Search string for username field
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: Search
|
|
Aliases:
|
|
|
|
Required: False
|
|
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](http://go.microsoft.com/fwlink/?LinkID=113216).
|
|
|
|
## INPUTS
|
|
|
|
## OUTPUTS
|
|
|
|
## NOTES
|
|
|
|
## RELATED LINKS
|