Register-PodeAuthEvent
SYNOPSIS
Registers an Authentication event ScriptBlock.
SYNTAX
Register-PodeAuthEvent [-Name] <String[]> [-Type] <String> [-EventName] <String> [-ScriptBlock] <ScriptBlock>
[[-ArgumentList] <Object[]>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Registers an Authentication event ScriptBlock, allowing custom code to be run on Login or Logout events.
EXAMPLES
EXAMPLE 1
Register-PodeAuthEvent -Name 'Basic' -Type 'Login' -EventName 'OnLogin' -ScriptBlock {
"User $($TriggeredEvent.User.Name) has logged in" | Out-Default
}
PARAMETERS
-ArgumentList
An optional array of Arguments to pass to the ScriptBlock.
Type: Object[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EventName
A unique Name for the event.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name
An array of Authentication method Names to register the event for.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ScriptBlock
The ScriptBlock to run when the event is triggered.
Type: ScriptBlock
Parameter Sets: (All)
Aliases:
Required: True
Position: 4
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Type
The Type of event to register, either 'Login' or 'Logout'.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
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.