Add-PodeAuth

NAME Add-PodeAuth



SYNOPSIS

Adds a custom Authentication method for verifying users.





SYNTAX

Add-PodeAuth [-Name] <String> [-Type] <Hashtable> [-ScriptBlock] <ScriptBlock> [[-ArgumentList] <Object[]>]

[<CommonParameters>]





DESCRIPTION

Adds a custom Authentication method for verifying users.





PARAMETERS

-Name <String>

A unique Name for the Authentication method.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Type <Hashtable>

The Type to use for retrieving credentials (From New-PodeAuthType).



Required? true

Position? 2

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-ScriptBlock <ScriptBlock>

The ScriptBlock defining logic that retrieves and verifys a user.



Required? true

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ArgumentList <Object[]>

An array of arguments to supply to the Custom Authentication's ScriptBlock.



Required? false

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



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



PS C:\\>New-PodeAuthType -Form | Add-PodeAuth -Name 'Main' -ScriptBlock { /* logic */ }















RELATED LINKS