Set-AdfsGlobalAuthenticationPolicy

Set-AdfsGlobalAuthenticationPolicy

Modifies the AD FS global policy.

Syntax

Parameter Set: IdentifierName
Set-AdfsGlobalAuthenticationPolicy [-AdditionalAuthenticationProvider <String[]> ] [-DeviceAuthenticationEnabled <Boolean> ] [-PassThru] [-PrimaryExtranetAuthenticationProvider <String[]> ] [-PrimaryIntranetAuthenticationProvider <String[]> ] [-WindowsIntegratedFallbackEnabled <Boolean> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-AdfsGlobalAuthenticationPolicy cmdlet modifies the Active Directory Federation Services (AD FS) global policy. You can also use the cmdlet to enable an external provider in the global policy.

Parameters

-AdditionalAuthenticationProvider<String[]>

Specifies an array of names of external authentication providers to add to the global policy.

Specifying this parameter configures an external authentication provider, for second stage authentication, in the global policy. This is the first step in creating an AD FS policy that invokes an external authentication provider for multifactor authentication.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DeviceAuthenticationEnabled<Boolean>

Specifies whether device authentication is enabled for the global policy.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PrimaryExtranetAuthenticationProvider<String[]>

Specifies an array of names of authentication providers for the primary extranet to add to the global policy.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PrimaryIntranetAuthenticationProvider<String[]>

Specifies an array of names of authentication providers for the primary intranet to add to the global policy.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WindowsIntegratedFallbackEnabled<Boolean>

Specifies whether fallback to Integrated Windows Authentication is enabled on the intranet.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • System.Object

Examples

Example 1: Set the primary extranet authentication policy

This command sets the primary extranet authentication policy to forms-based or certificate-based authentication. In this case, the user is provided a choice when the user logs on to an application protected by AD FS from the extranet.

PS C:\> Set-AdfsGlobalAuthenticationPolicy -PrimaryExtranetAuthenticationProvider @('FormsAuthentication', 'CertificateAuthenticaton')

Example 2: Enable an additional authentication provider

This command enables the provider named A1ExternalAuthProvider as an additional authentication provider in the global policy. Note that the value provided for the AdditionalAuthenticationProvider parameter corresponds to the value you provide for the Name parameter in the Register-AdfsAuthenticationProvider cmdlet, and to the Name property in the output from the Get-AdfsAuthenticationProvider cmdlet.

PS C:\> Set-AdfsGlobalAuthenticationPolicy -AdditionalAuthenticationProvider "A1ExternalAuthProvider"

Get-AdfsGlobalAuthenticationPolicy

Register-AdfsAuthenticationProvider

Get-AdfsAuthenticationProvider