SnipeitPS/docs/Set-SnipeitUser.md

381 lines
6.1 KiB
Markdown
Raw Normal View History

---
2021-06-08 20:20:03 +03:00
external help file: SnipeitPS-help.xml
2021-08-23 18:50:13 +03:00
Module Name: snipeitps
2021-05-19 15:51:49 +03:00
online version:
2018-04-29 08:58:34 +01:00
schema: 2.0.0
---
2021-06-08 20:23:32 +03:00
# Set-SnipeitUser
2018-04-29 08:58:34 +01:00
## SYNOPSIS
2021-05-19 15:51:49 +03:00
Creates a new user
2018-04-29 08:58:34 +01:00
## SYNTAX
```
2021-08-23 18:50:13 +03:00
Set-SnipeitUser [-id] <Int32[]> [[-first_name] <String>] [[-last_name] <String>] [[-username] <String>]
2021-06-16 10:37:57 +03:00
[[-jobtitle] <String>] [[-email] <String>] [[-phone] <String>] [[-password] <String>] [[-company_id] <Int32>]
2018-04-29 08:58:34 +01:00
[[-location_id] <Int32>] [[-department_id] <Int32>] [[-manager_id] <Int32>] [[-employee_num] <String>]
2021-07-14 11:16:55 +03:00
[[-activated] <Boolean>] [[-notes] <String>] [[-image] <String>] [-image_delete] [[-RequestType] <String>]
2021-08-23 18:50:13 +03:00
[[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
2018-04-29 08:58:34 +01:00
```
## DESCRIPTION
2021-05-19 15:51:49 +03:00
Creates a new user to Snipe-IT system
2018-04-29 08:58:34 +01:00
## EXAMPLES
2021-05-18 05:57:40 +03:00
### EXAMPLE 1
2018-04-29 08:58:34 +01:00
```
2021-06-08 20:23:32 +03:00
Update-SnipeitUser -id 3 -fist_name It -lastname Snipe -username snipeit -activated $false -company_id 1 -location_id 1 -department_id 1
2021-05-19 15:51:49 +03:00
Updates user with id 3
2021-06-05 08:10:45 +03:00
```
2021-05-19 15:51:49 +03:00
2018-04-29 08:58:34 +01:00
## PARAMETERS
2021-05-23 23:24:44 +03:00
### -activated
2021-06-09 21:08:18 +03:00
Can user log in to snipe-it?
2018-04-29 08:58:34 +01:00
```yaml
2021-05-23 23:24:44 +03:00
Type: Boolean
2018-04-29 08:58:34 +01:00
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2018-04-29 08:58:34 +01:00
2021-05-23 23:24:44 +03:00
Required: False
2021-06-16 10:37:57 +03:00
Position: 14
2021-05-23 23:24:44 +03:00
Default value: False
2018-04-29 08:58:34 +01:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -apiKey
2021-08-23 18:50:13 +03:00
Deprecated parameter, please use Connect-SnipeitPS instead.
User's API Key for Snipeit.
2018-04-29 08:58:34 +01:00
```yaml
Type: String
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2018-04-29 08:58:34 +01:00
2021-08-23 18:50:13 +03:00
Required: False
2021-07-14 11:16:55 +03:00
Position: 19
2018-04-29 08:58:34 +01:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -company_id
ID number of company users belogs to
2018-04-29 08:58:34 +01:00
```yaml
2021-05-23 23:24:44 +03:00
Type: Int32
2018-04-29 08:58:34 +01:00
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2018-04-29 08:58:34 +01:00
Required: False
2021-06-16 10:37:57 +03:00
Position: 9
Default value: None
2018-04-29 08:58:34 +01:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -department_id
ID number of department
2018-04-29 08:58:34 +01:00
```yaml
2021-05-23 23:24:44 +03:00
Type: Int32
2018-04-29 08:58:34 +01:00
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2018-04-29 08:58:34 +01:00
Required: False
2021-06-16 10:37:57 +03:00
Position: 11
Default value: None
2018-04-29 08:58:34 +01:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -email
email address
2018-04-29 08:58:34 +01:00
```yaml
Type: String
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2018-04-29 08:58:34 +01:00
Required: False
2021-05-23 23:24:44 +03:00
Position: 6
2018-04-29 08:58:34 +01:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -employee_num
Employeenumber
2018-04-29 08:58:34 +01:00
```yaml
Type: String
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2018-04-29 08:58:34 +01:00
Required: False
2021-06-16 10:37:57 +03:00
Position: 13
2018-04-29 08:58:34 +01:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -first_name
Users first name
2018-04-29 08:58:34 +01:00
```yaml
Type: String
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2018-04-29 08:58:34 +01:00
Required: False
2021-05-23 23:24:44 +03:00
Position: 2
2018-04-29 08:58:34 +01:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -id
2021-06-08 22:04:25 +03:00
ID number of Snipe--It user or array of IDs
2018-04-29 08:58:34 +01:00
```yaml
2021-06-06 06:22:08 +03:00
Type: Int32[]
2018-04-29 08:58:34 +01:00
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2018-04-29 08:58:34 +01:00
2021-05-23 23:24:44 +03:00
Required: True
Position: 1
2021-06-08 22:04:25 +03:00
Default value: None
2021-06-06 06:22:08 +03:00
Accept pipeline input: True (ByPropertyName)
2018-04-29 08:58:34 +01:00
Accept wildcard characters: False
```
2021-07-08 23:59:31 +03:00
### -image
Image file name and path for item
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 16
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -image_delete
Remove current image
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -jobtitle
Users job tittle
2018-04-29 08:58:34 +01:00
```yaml
2021-05-23 23:24:44 +03:00
Type: String
2018-04-29 08:58:34 +01:00
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2018-04-29 08:58:34 +01:00
Required: False
2021-05-23 23:24:44 +03:00
Position: 5
Default value: None
2018-04-29 08:58:34 +01:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -last_name
Users last name
2018-04-29 08:58:34 +01:00
```yaml
2021-05-23 23:24:44 +03:00
Type: String
2018-04-29 08:58:34 +01:00
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2018-04-29 08:58:34 +01:00
Required: False
2021-05-23 23:24:44 +03:00
Position: 3
Default value: None
2018-04-29 08:58:34 +01:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -location_id
ID number of localtion
2018-04-29 08:58:34 +01:00
```yaml
Type: Int32
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2018-04-29 08:58:34 +01:00
Required: False
2021-06-16 10:37:57 +03:00
Position: 10
Default value: None
2018-04-29 08:58:34 +01:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -manager_id
ID number of manager
2018-04-29 08:58:34 +01:00
```yaml
2021-05-23 23:24:44 +03:00
Type: Int32
2018-04-29 08:58:34 +01:00
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2018-04-29 08:58:34 +01:00
Required: False
2021-06-16 10:37:57 +03:00
Position: 12
Default value: None
2018-04-29 08:58:34 +01:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -notes
User Notes
2018-04-29 08:58:34 +01:00
```yaml
2021-05-23 23:24:44 +03:00
Type: String
2018-04-29 08:58:34 +01:00
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2018-04-29 08:58:34 +01:00
Required: False
2021-06-16 10:37:57 +03:00
Position: 15
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -password
2021-06-16 10:55:25 +03:00
Password for user
2021-06-16 10:37:57 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
2021-05-23 23:24:44 +03:00
Default value: None
2018-04-29 08:58:34 +01:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -phone
Phone number
2018-04-29 08:58:34 +01:00
```yaml
Type: String
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2018-04-29 08:58:34 +01:00
Required: False
2021-05-23 23:24:44 +03:00
Position: 7
2018-04-29 08:58:34 +01:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-07-14 11:16:55 +03:00
### -RequestType
Http request type to send Snipe IT system.
Defaults to Patch you could use Put if needed.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 17
Default value: Patch
Accept pipeline input: False
Accept wildcard characters: False
```
2018-04-29 08:58:34 +01:00
### -url
2021-08-23 18:50:13 +03:00
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
2018-04-29 08:58:34 +01:00
```yaml
Type: String
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2018-04-29 08:58:34 +01:00
2021-08-23 18:50:13 +03:00
Required: False
2021-07-14 11:16:55 +03:00
Position: 18
2018-04-29 08:58:34 +01:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-08-23 18:50:13 +03:00
### -username
2021-05-23 23:24:44 +03:00
Username for user
2018-04-29 08:58:34 +01:00
```yaml
Type: String
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2018-04-29 08:58:34 +01:00
2021-05-23 23:24:44 +03:00
Required: False
Position: 4
2018-04-29 08:58:34 +01:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -Confirm
Prompts you for confirmation before running the cmdlet.
2018-04-29 08:58:34 +01:00
```yaml
Type: SwitchParameter
Parameter Sets: (All)
2021-05-23 23:24:44 +03:00
Aliases: cf
2018-04-29 08:58:34 +01:00
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
2018-04-29 08:58:34 +01:00
```yaml
Type: SwitchParameter
Parameter Sets: (All)
2021-05-23 23:24:44 +03:00
Aliases: wi
2018-04-29 08:58:34 +01:00
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
2021-05-18 05:57:40 +03:00
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).
2018-04-29 08:58:34 +01:00
## INPUTS
## OUTPUTS
## NOTES
General notes
## RELATED LINKS