New-PodeAuthBearerScheme
SYNOPSIS
Creates a new Bearer Authentication Scheme.
SYNTAX
New-PodeAuthBearerScheme [[-Realm] <String>] [[-HeaderTag] <String>] [[-Scope] <String[]>] [[-Secret] <String>]
[[-Description] <String>] [[-Middleware] <Object[]>] [[-InnerScheme] <Hashtable>] [-AsJWT]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Creates a new Bearer Authentication Scheme.
EXAMPLES
EXAMPLE 1
$scheme = New-PodeAuthBearerScheme
EXAMPLE 2
$scheme = New-PodeAuthBearerScheme -Scope 'read', 'write'
EXAMPLE 3
$scheme = New-PodeAuthBearerScheme -AsJWT
EXAMPLE 4
$scheme = New-PodeAuthBearerScheme -AsJWT -Secret 'my_secret_key'
PARAMETERS
-AsJWT
If specified, the token will be issued as a JWT, and the payload supplied instead.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Description
An optional short description for Authentication Scheme. CommonMark syntax MAY be used for rich text representation.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-HeaderTag
The "Tag" name to use in the Authorization header during parsing. (Default: Bearer)
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: Bearer
Accept pipeline input: False
Accept wildcard characters: False
-InnerScheme
An optional Authentication Scheme (such as New-PodeAuthFormScheme) that will be called prior to this Scheme.
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Middleware
An optional array of Middleware ScriptBlocks to run before the Scheme's scriptblock.
Type: Object[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
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
-Realm
An optional Realm to use. (Default: User)
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: User
Accept pipeline input: False
Accept wildcard characters: False
-Scope
An optional array of scopes to request.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Secret
An optional secret key used for signing the token, enabling verification of the token's integrity.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
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.