Set-AdfsWebConfig
Set-AdfsWebConfig
Modifies web customization configuration settings.
Syntax
Parameter Set: Default
Set-AdfsWebConfig [-ActiveThemeName <String> ] [-CDCCookieReader <Uri> ] [-CDCCookieWriter <Uri> ] [-ContextCookieEnabled <Boolean> ] [-HRDCookieEnabled <Boolean> ] [-HRDCookieLifetime <Int32> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed 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.
Parameters
-ActiveThemeName<String>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CDCCookieReader<Uri>
Specifies the Uniform Resource Identifier (URI) of the Common Domain Cookie (CDC) reader.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CDCCookieWriter<Uri>
Specifies the URI of the CDC writer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ContextCookieEnabled<Boolean>
Indicates whether to enable the context cookie.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-HRDCookieEnabled<Boolean>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-HRDCookieLifetime<Int32>
Specifies the lifetime, in days, of an HRD cookie.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
30 |
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 |
-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.
- System.String;System.String[];System.Uri;System.Int32;System.Boolean
Outputs
The output type is the type of the objects that the cmdlet emits.
- This cmdlet generates string for a theme to save as the active theme.
Examples
Example 1: Set customization configuration properties
This command sets properties in the web customization configuration settings.
PS C:\> Set-AdfsWebConfig -ActiveThemeName "Default" -CDCCookieReader https://www.Contoso.com/reader.aspx -CDCCookieWriter https://www.Contoso.com/writer.aspx -ContextCookieEnabled $True -HRDCookieEnabled $True -HRDCookieLifetime 30