2021-05-20 14:42:42 +03:00
---
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
# New-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-06-08 20:23:32 +03:00
New-SnipeitUser [-first_name] < String > [-last_name] < String > [-username] < String > [[-password] < String > ]
2021-05-18 05:57:40 +03:00
[[-activated] < Boolean > ] [[-notes] < String > ] [[-jobtitle] < String > ] [[-email] < String > ] [[-phone] < String > ]
[[-company_id] < Int32 > ] [[-location_id] < Int32 > ] [[-department_id] < Int32 > ] [[-manager_id] < Int32 > ]
2021-08-23 18:50:13 +03:00
[[-employee_num] < String > ] [[-ldap_import] < Boolean > ] [[-image] < String > ] [[-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
New-Snipeituser -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
Creates new a new user who can't login to system
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
{{ Fill activated Description }}
2021-05-18 05:57:40 +03:00
```yaml
2021-05-23 23:24:44 +03:00
Type: Boolean
2021-05-18 05:57:40 +03:00
Parameter Sets: (All)
Aliases:
2021-05-23 23:24:44 +03:00
Required: False
Position: 5
Default value: False
2021-05-18 05:57:40 +03: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-08 23:59:31 +03:00
Position: 18
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
2021-05-23 23:24:44 +03:00
Required: False
Position: 10
Default value: 0
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
2021-05-18 05:57:40 +03:00
Required: False
2021-05-23 23:24:44 +03:00
Position: 12
Default value: 0
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
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: 8
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
### -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-05-23 23:24:44 +03:00
Position: 14
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-22 18:44:36 +03:00
Aliases:
2018-04-29 08:58:34 +01:00
2021-05-23 23:24:44 +03:00
Required: True
Position: 1
2018-04-29 08:58:34 +01:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-07-08 23:59:31 +03:00
### -image
2021-07-14 11:16:55 +03:00
User Image file name and path
2021-07-08 23:59:31 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 16
Default value: None
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-18 05:57:40 +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: 7
2021-05-18 05:57:40 +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
### -last_name
Users last name
2018-04-29 08:58:34 +01:00
```yaml
2021-05-18 05:57:40 +03:00
Type: String
2018-04-29 08:58:34 +01:00
Parameter Sets: (All)
2021-05-22 18:44:36 +03:00
Aliases:
2021-05-18 05:57:40 +03:00
2021-05-23 23:24:44 +03:00
Required: True
Position: 2
2021-05-18 05:57:40 +03:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -ldap_import
Mark user as import from ldap
2021-05-18 05:57:40 +03:00
```yaml
2021-05-23 23:24:44 +03:00
Type: Boolean
2021-05-18 05:57:40 +03:00
Parameter Sets: (All)
2021-05-22 18:44:36 +03:00
Aliases:
2018-04-29 08:58:34 +01:00
Required: False
2021-05-23 23:24:44 +03:00
Position: 15
Default value: False
2018-04-29 08:58:34 +01:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-18 05:57:40 +03:00
### -location_id
2021-05-19 15:51:49 +03:00
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-05-18 05:57:40 +03:00
Position: 11
2018-04-29 08:58:34 +01:00
Default value: 0
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
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-05-23 23:24:44 +03:00
Position: 13
2018-04-29 08:58:34 +01:00
Default value: 0
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-05-23 23:24:44 +03:00
Position: 6
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
### -password
2021-06-16 10:37:57 +03:00
Password for user
2021-05-18 05:57:40 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
2021-05-23 23:24:44 +03:00
Position: 4
2021-05-18 05:57:40 +03:00
Default value: None
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
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: 9
Default value: None
2018-04-29 08:58:34 +01:00
Accept pipeline input: False
Accept wildcard characters: False
```
### -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-08 23:59:31 +03:00
Position: 17
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
### -username
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
Required: True
2021-05-23 23:24:44 +03:00
Position: 3
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