Skip to content

Add-PodeAuthMiddleware

SYNOPSIS

Adds an authentication method as global middleware.

SYNTAX

Add-PodeAuthMiddleware [-Name] <String> [-Authentication] <String> [[-Route] <String>] [<CommonParameters>]

DESCRIPTION

Adds an authentication method as global middleware.

EXAMPLES

EXAMPLE 1

Add-PodeAuthMiddleware -Name 'GlobalAuth' -Authentication AuthName

EXAMPLE 2

Add-PodeAuthMiddleware -Name 'GlobalAuth' -Authentication AuthName -Route '/api/*'

PARAMETERS

-Authentication

The Name of the Authentication method to use.

Type: String
Parameter Sets: (All)
Aliases: Auth

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

-Name

The Name of the Middleware.

Type: String
Parameter Sets: (All)
Aliases:

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

-Route

A Route path for which Routes this Middleware should only be invoked against.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
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

Back to top