Add-PodeAuthUserFile
SYNOPSIS
Adds the inbuilt User File Authentication method for verifying users.
SYNTAX
Add-PodeAuthUserFile -Name <String> -Scheme <Hashtable> [-FilePath <String>] [-Groups <String[]>]
[-Users <String[]>] [-HmacSecret <String>] [-FailureUrl <String>] [-FailureMessage <String>]
[-SuccessUrl <String>] [-ScriptBlock <ScriptBlock>] [-Sessionless] [-SuccessUseOrigin]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Adds the inbuilt User File Authentication method for verifying users.
EXAMPLES
EXAMPLE 1
New-PodeAuthScheme -Form | Add-PodeAuthUserFile -Name 'Login'
EXAMPLE 2
New-PodeAuthScheme -Form | Add-PodeAuthUserFile -Name 'Login' -FilePath './custom/path/users.json'
PARAMETERS
-FailureMessage
An override Message to throw when authentication fails.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FailureUrl
The URL to redirect to when authentication fails.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FilePath
A path to a users JSON file (Default: ./users.json)
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Groups
An array of Group names to only allow access.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-HmacSecret
An optional secret if the passwords are HMAC SHA256 hashed.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name
A unique Name for the Authentication method.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
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
-Scheme
The Scheme to use for retrieving credentials (From New-PodeAuthScheme).
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-ScriptBlock
Optional ScriptBlock that is passed the found user object for further validation.
Type: ScriptBlock
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Sessionless
If supplied, authenticated users will not be stored in sessions, and sessions will not be used.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-SuccessUrl
The URL to redirect to when authentication succeeds when logging in.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SuccessUseOrigin
If supplied, successful authentication from a login page will redirect back to the originating page instead of the FailureUrl.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Users
An array of Usernames to only allow access.
Type: String[]
Parameter Sets: (All)
Aliases:
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.