Set-AdfsWebConfig
Modifies web customization configuration settings.
Syntax
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 : TrueThis 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CDCCookieReader
Specifies the Uniform Resource Identifier (URI) of the Common Domain Cookie (CDC) reader.
| Type: | Uri |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CDCCookieWriter
Specifies the URI of the CDC writer.
| Type: | Uri |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ContextCookieEnabled
Indicates whether to enable the context cookie.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HRDCookieLifetime
Specifies the lifetime, in days, of an HRD cookie.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
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.