SnipeitPS/docs/Remove-SnipeItUser.md

external help file	Module Name	online version	schema
SnipeItPS-help.xml	SnipeitPS		2.0.0

Remove-SnipeItUser

SYNOPSIS

Removes User from Snipe-it asset system

SYNTAX

Remove-SnipeItUser [-ID] <String> [-URL] <String> [-APIKey] <String> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Long description

EXAMPLES

EXAMPLE 1

Remove-SnipeItUser -ID 44 -url $url -apiKey $secret -Verbose

PARAMETERS

-APIKey

User's API Key for Snipeit, can be set using Set-SnipeItInfo command

Type: String
Parameter Sets: (All)
Aliases:

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

-ID

Unique ID For User to be removed

Type: String
Parameter Sets: (All)
Aliases:

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

-URL

URL of Snipeit system, can be set using Set-SnipeItInfo command

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
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

-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

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.

INPUTS

OUTPUTS

NOTES

RELATED LINKS