Skip to content

Add-PodeAuthWindowsAd

SYNOPSIS

Adds the inbuilt Windows AD Authentication method for verifying users.

SYNTAX

Groups (Default)

Add-PodeAuthWindowsAd -Name <String> -Scheme <Hashtable> [-Fqdn <String>] [-Domain <String>]
 [-Groups <String[]>] [-Users <String[]>] [-FailureUrl <String>] [-FailureMessage <String>]
 [-SuccessUrl <String>] [-ScriptBlock <ScriptBlock>] [-Sessionless] [-OpenLDAP] [-SuccessUseOrigin]
 [<CommonParameters>]

NoGroups

Add-PodeAuthWindowsAd -Name <String> -Scheme <Hashtable> [-Fqdn <String>] [-Domain <String>]
 [-Users <String[]>] [-FailureUrl <String>] [-FailureMessage <String>] [-SuccessUrl <String>]
 [-ScriptBlock <ScriptBlock>] [-Sessionless] [-NoGroups] [-OpenLDAP] [-SuccessUseOrigin] [<CommonParameters>]

DESCRIPTION

Adds the inbuilt Windows AD Authentication method for verifying users.

EXAMPLES

EXAMPLE 1

New-PodeAuthScheme -Form | Add-PodeAuthWindowsAd -Name 'WinAuth'

EXAMPLE 2

New-PodeAuthScheme -Basic | Add-PodeAuthWindowsAd -Name 'WinAuth' -Groups @('Developers')

EXAMPLE 3

New-PodeAuthScheme -Form | Add-PodeAuthWindowsAd -Name 'WinAuth' -NoGroups

EXAMPLE 4

New-PodeAuthScheme -Form | Add-PodeAuthWindowsAd -Name 'UnixAuth' -Server 'testdomain.company.com' -Domain 'testdomain'

PARAMETERS

-Domain

(Unix Only) A custom domain name that is prepended onto usernames that are missing it (\<Domain>\\<Username>).

Type: String
Parameter Sets: (All)
Aliases:

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

-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

-Fqdn

A custom FQDN for the DNS of the AD you wish to authenticate against. (Alias: Server)

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

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: Groups
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

-NoGroups

If supplied, groups will not be retrieved for the user in AD.

Type: SwitchParameter
Parameter Sets: NoGroups
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-OpenLDAP

If supplied, and on Windows, OpenLDAP will be used instead.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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.

INPUTS

OUTPUTS

NOTES