Add-PodeAuthWindowsAd

NAME Add-PodeAuthWindowsAd



SYNOPSIS

Adds the inbuilt Windows AD Authentication method for verifying users.





SYNTAX

Add-PodeAuthWindowsAd -Name <String> -Type <Hashtable> [-Fqdn <String>] [-Groups <String[]>] [-Users <String[]>]

[<CommonParameters>]



Add-PodeAuthWindowsAd -Name <String> -Type <Hashtable> [-Fqdn <String>] [-Users <String[]>] [-NoGroups]

[<CommonParameters>]





DESCRIPTION

Adds the inbuilt Windows AD Authentication method for verifying users.





PARAMETERS

-Name <String>

A unique Name for the Authentication method.



Required? true

Position? named

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? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Fqdn <String>

A custom FQDN for the DNS of the AD you wish to authenticate against.



Required? false

Position? named

Default value $env:USERDNSDOMAIN

Accept pipeline input? false

Accept wildcard characters? false



-Groups <String[]>

An array of Group names to only allow access.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Users <String[]>

An array of Usernames to only allow access.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-NoGroups [<SwitchParameter>]

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



Required? false

Position? named

Default value False

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-PodeAuthWindowsAd -Name 'WinAuth'













-------------------------- EXAMPLE 2 --------------------------



PS C:\\>New-PodeAuthType -Basic | Add-PodeAuthWindowsAd -Name 'WinAuth' -Groups @('Developers')













-------------------------- EXAMPLE 3 --------------------------



PS C:\\>New-PodeAuthType -Form | Add-PodeAuthWindowsAd -Name 'WinAuth' -NoGroups















RELATED LINKS