Set-AdfsGlobalWebContent
Set-AdfsGlobalWebContent is accessible with the help of adfs module. To install adfs on your system please refer to this adfs.
Synopsis
Sets properties for global web content objects.
Description
The Set-AdfsGlobalWebContent cmdlet sets properties for a global web content object. Specify a global web object by using a locale, or use the Get-AdfsGlobalWebContent cmdlet to obtain a web object.
Parameters
-CertificatePageDescriptionText
Specifies the text on the certificate page. Active Directory Federation Services (AD FS) displays the text that you specify when it prompts the user for a certificate. In earlier versions of AD FS, the user sees a blank page when AD FS prompts the user for a certificate.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-CompanyName <String>
Specifies the company name. AD FS displays the company name in the sign-in pages when you have not set a logo on the active web theme.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ErrorPageAuthorizationErrorMessage <String>
Specifies an error message to display when a user encounters any authorization errors that occur for a token request. This string can be an HTML fragment. You can override this message for an application by using the Set-AdfsRelyingPartyWebContent cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ErrorPageDescriptionText <String>
Specifies an error message to display when a user encounters any generic errors that occur for a token request. This string can be an HTML fragment. You can override this message for an application by using the Set-AdfsRelyingPartyWebContent cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ErrorPageDeviceAuthenticationErrorMessage <String>
Specifies an error message to display for any device authentication errors that occur for a token request. Device authentication errors occur when the user presents an expired user@device certificate to AD FS, a certificate is not found in ad_adds_3, or a certificate is disabled in ad_adds_3. This string can be an HTML fragment. You can override this message for an application by using the Set-AdfsRelyingPartyWebContent cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ErrorPageGenericErrorMessage <String>
Specifies an error message to display for any generic errors that occur for a token request. This string can be an HTML fragment. You can override this message for an application by using the Set-AdfsRelyingPartyWebContent cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ErrorPageSupportEmail <String>
Specifies the support email address on the error page.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-HelpDeskLink <Uri>
Specifies the help desk link that is shown on the logon pages for AD FS.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-HelpDeskLinkText <String>
Specifies the help desk link text that is shown on the logon pages for AD FS.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-HomeLink <Uri>
Specifies the Home link that is shown on the logon pages for AD FS.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-HomeLinkText <String>
Specifies the Home link text that is shown on the logon pages for AD FS.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-HomeRealmDiscoveryOtherOrganizationDescriptionText <String>
Specifies the text for the home realm discovery description for other organization.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-HomeRealmDiscoveryPageDescriptionText <String>
Specifies the text for the home realm discovery page description.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Locale <CultureInfo>
Specifies a locale. The cmdlet sets global web content for the locale that you specify.
Required? false
Position? 1
Default value none
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-OrganizationalNameDescriptionText <String>
Specifies text for the organizational name description.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-PassThru <SwitchParameter>
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-PrivacyLink <Uri>
Specifies the Privacy policy link that is shown on the logon pages for AD FS.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-PrivacyLinkText <String>
Specifies the Privacy policy link text that is shown on the logon pages for AD FS.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-SignInPageAdditionalAuthenticationDescriptionText <String>
Specifies the description to display when an application prompts a user for additional authentication. The sign-in page can also display a description that is provided by the additional authentication provider.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-SignInPageDescriptionText <String>
Specifies the description to display when a user signs in to applications by using AD FS. When you use Integrated Windows Authentication in the intranet, users do not see this page.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-SignOutPageDescriptionText <String>
Specifies the description to display when a user signs out of applications.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-TargetWebContent <AdfsGlobalWebContent>
Specifies an AdfsGlobalWebContent object. The cmdlet modifies content for the object that you specify. To obtain a AdfsGlobalWebContent object, use the Get-AdfsGlobalWebContent cmdlet.
Required? true
Position? 1
Default value none
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-UpdatePasswordPageDescriptionText <String>
Specifies the description to display in the update password page when users change their passwords.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Confirm <SwitchParameter>
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf <SwitchParameter>
Shows what would happen if the cmdlet runs. The cmdlet is not run.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
Syntax
Set-AdfsGlobalWebContent [-CompanyName <String>] [-HelpDeskLink <Uri>] [-HelpDeskLinkText <String>] [-HomeLink <Uri>] [-HomeLinkText <String>] [-HomeRealmDiscoveryOtherOrganizationDescriptionText <String>] [-HomeRealmDiscoveryPageDescriptionText <String>] [-OrganizationalNameDescriptionText <String>] [-PrivacyLink <Uri>] [-PrivacyLinkText <String>] [-CertificatePageDescriptionText <String>] [-SignInPageDescriptionText <String>] [-SignOutPageDescriptionText <String>] [-ErrorPageDescriptionText <String>] [-ErrorPageGenericErrorMessage <String>] [-ErrorPageAuthorizationErrorMessage <String>] [-ErrorPageDeviceAuthenticationErrorMessage <String>] [-ErrorPageSupportEmail <String>] [-UpdatePasswordPageDescriptionText <String>] [-SignInPageAdditionalAuthenticationDescriptionText <String>] [-PassThru] [[-Locale] <CultureInfo>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-AdfsGlobalWebContent [-CompanyName <String>] [-HelpDeskLink <Uri>] [-HelpDeskLinkText <String>] [-HomeLink <Uri>] [-HomeLinkText <String>] [-HomeRealmDiscoveryOtherOrganizationDescriptionText <String>] [-HomeRealmDiscoveryPageDescriptionText <String>] [-OrganizationalNameDescriptionText <String>] [-PrivacyLink <Uri>] [-PrivacyLinkText <String>] [-CertificatePageDescriptionText <String>] [-SignInPageDescriptionText <String>] [-SignOutPageDescriptionText <String>] [-ErrorPageDescriptionText <String>] [-ErrorPageGenericErrorMessage <String>] [-ErrorPageAuthorizationErrorMessage <String>] [-ErrorPageDeviceAuthenticationErrorMessage <String>] [-ErrorPageSupportEmail <String>] [-UpdatePasswordPageDescriptionText <String>] [-SignInPageAdditionalAuthenticationDescriptionText <String>] [-PassThru] [-TargetWebContent] <AdfsGlobalWebContent> [-WhatIf] [-Confirm] [<CommonParameters>]
—————————Example 1—————————
Set the company name for the global web content
PS C:> Set-AdfsGlobalWebContent -Locale “” -CompanyName “TOSS”
This command sets the company name of the global web content for the invariant locale. If there is no logo, the sign-in page displays the company name TOSS.
—————————Example 2—————————
Set the text and links for the sign-in pages
PS C:> Set-AdfsGlobalWebContent -Locale “en-us” -CompanyName “TOSS” -HelpDeskLink “http://helpdesklink” -HelpDeskLinkText “Help desk” -CopyrightText “Copy right” -HomeLink “http://homelink” -HomeLinkText “Home” -PrivacyLink “http://privacylink” -PrivacyLinkText “Privacy statement” -ContactLink “http://contactlink” -ContactLinkText “Contact” -SignInPageDescriptionText “Sign in here” -SignOutPageDescriptionText “Sign out here” -ErrorPageGenericErrorMessage “An error occurred.” -ErrorPageSupportEmail “[email protected]” -ErrorPageSupportEmailText “Email” -UpdatePasswordPageDescriptionText “Update password here” -UpdatePasswordPageLink “http://updatepasswordlink” -UpdatePasswordPageLinkText “Update password”
This command specifies the text to display in the sign-in pages for AD FS for the en-us locale.
—————————Example 2—————————
Set the text and links for the certificate page
PS C:> Set-AdfsGlobalWebContent -Locale “en-us” -CompanyName “TOSS” -HomeLink “http://homelink” -HomeLinkText “Home” -PrivacyLink “http://privaylink” -PrivacyLinkText “Privacy statement” -SignInPageDescriptionText “
This command specifies the text and links to display when an application prompts a user prompted for a certificate.
You can check the Version, CommandType and Source of this cmdlet by giving below command.
Get-Command Set-AdfsGlobalWebContent
You can also read about
- Get-AdfsGlobalWebContent
- Remove-AdfsGlobalWebContent
- Set-AdfsRelyingPartyWebContent