SnipeitPS/docs/Set-User.md
Stephen Maunder aa961824a5 Update Help
2018-04-29 08:58:34 +01:00

4.9 KiB

external help file Module Name online version schema
SnipeItPS-help.xml SnipeItPS http://go.microsoft.com/fwlink/?LinkId=821589 2.0.0

Set-User

SYNOPSIS

Short description

SYNTAX

Set-User [-id] <Int32> [[-first_name] <String>] [[-last_name] <String>] [[-userName] <String>]
 [[-jobtitle] <String>] [[-email] <String>] [[-phone] <String>] [[-company_id] <Int32>]
 [[-location_id] <Int32>] [[-department_id] <Int32>] [[-manager_id] <Int32>] [[-employee_num] <String>]
 [[-activated] <Boolean>] [[-notes] <String>] [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Long description

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

An example

PARAMETERS

-id

Parameter description

Type: Int32
Parameter Sets: (All)
Aliases: 

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

-first_name

Parameter description

Type: String
Parameter Sets: (All)
Aliases: 

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

-last_name

Parameter description

Type: String
Parameter Sets: (All)
Aliases: 

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

-userName

Parameter description

Type: String
Parameter Sets: (All)
Aliases: 

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

-jobtitle

Parameter description

Type: String
Parameter Sets: (All)
Aliases: 

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

-email

Parameter description

Type: String
Parameter Sets: (All)
Aliases: 

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

-phone

Parameter description

Type: String
Parameter Sets: (All)
Aliases: 

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

-company_id

Parameter description

Type: Int32
Parameter Sets: (All)
Aliases: 

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

-location_id

Parameter description

Type: Int32
Parameter Sets: (All)
Aliases: 

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

-department_id

Parameter description

Type: Int32
Parameter Sets: (All)
Aliases: 

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

-manager_id

Parameter description

Type: Int32
Parameter Sets: (All)
Aliases: 

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

-employee_num

Parameter description

Type: String
Parameter Sets: (All)
Aliases: 

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

-activated

Parameter description

Type: Boolean
Parameter Sets: (All)
Aliases: 

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

-notes

Parameter description

Type: String
Parameter Sets: (All)
Aliases: 

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

-url

Parameter description

Type: String
Parameter Sets: (All)
Aliases: 

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

-apiKey

Parameter description

Type: String
Parameter Sets: (All)
Aliases: 

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

General notes