Set-AdfsWebConfig

Module:

ADFS Module

Modifies web customization configuration settings.

Syntax

Default (Default)

Set-AdfsWebConfig
    [-ActiveThemeName <String>]
    [-CDCCookieReader <Uri>]
    [-CDCCookieWriter <Uri>]
    [-HRDCookieLifetime <Int32>]
    [-HRDCookieEnabled <Boolean>]
    [-ContextCookieEnabled <Boolean>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Set-AdfsWebConfig cmdlet modifies web customization configuration settings. These settings impact any protocol that Active Directory Federation Services (AD FS) supports where a web browser facilitates token requests for home realm discovery (HRD) and authentication.

Examples

Example 1: Set customization configuration properties

$pSSetAdfsWebConfigSplat = @{
    ActiveThemeName = "Default"
    CDCCookieReader = 'https://www.Contoso.com/reader.aspx'
    CDCCookieWriter = 'https://www.Contoso.com/writer.aspx'
    ContextCookieEnabled = $True
    HRDCookieEnabled = $True
    HRDCookieLifetime = 30
}
PSSet-AdfsWebConfig @pSSetAdfsWebConfigSplat

ActiveThemeName      : Default
CDCCookieReader      :
CDCCookieWriter      :
HRDCookieLifetime    : 30
HRDCookieEnabled     : True
ContextCookieEnabled : True

This command sets properties in the web customization configuration settings.

Parameters

-ActiveThemeName

Specifies the name of a web theme to be set as the active web theme in the web customization configuration. To create a web theme, use the New-AdfsWebTheme cmdlet.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-CDCCookieReader

Specifies the Uniform Resource Identifier (URI) of the Common Domain Cookie (CDC) reader.

Parameter properties

Type:	Uri
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-CDCCookieWriter

Specifies the URI of the CDC writer.

Parameter properties

Type:	Uri
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ContextCookieEnabled

Indicates whether to enable the context cookie.

Parameter properties

Type:	Boolean
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-HRDCookieEnabled

Indicates whether to enable the HRD cookie. If you specify a value of $false, when AD FS has more than one claims provider trust enabled, end users must select the home realm in every application request.

Parameter properties

Type:	Boolean
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-HRDCookieLifetime

Specifies the lifetime, in days, of an HRD cookie.

Parameter properties

Type:	Int32
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-PassThru

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

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WhatIf

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

Parameter properties

Type:	SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False
Aliases:	wi

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

None

By default, this cmdlet doesn't return any output.

AdfsWebConfig

When you use the PassThru parameter, this cmdlet returns an AdfsWebConfig object that represents the modified configuration settings.

Related Links

• Get-AdfsWebConfig
• New-AdfsWebTheme