Set-AdfsGlobalWebContent

Set-AdfsGlobalWebContent

Sets properties for global web content objects.

Syntax

Parameter Set: IdentifierName
Set-AdfsGlobalWebContent [[-Locale] <CultureInfo> ] [-CertificatePageDescriptionText <String> ] [-CompanyName <String> ] [-ErrorPageAuthorizationErrorMessage <String> ] [-ErrorPageDescriptionText <String> ] [-ErrorPageDeviceAuthenticationErrorMessage <String> ] [-ErrorPageGenericErrorMessage <String> ] [-ErrorPageSupportEmail <String> ] [-HelpDeskLink <Uri> ] [-HelpDeskLinkText <String> ] [-HomeLink <Uri> ] [-HomeLinkText <String> ] [-PassThru] [-PrivacyLink <Uri> ] [-PrivacyLinkText <String> ] [-SignInPageAdditionalAuthenticationDescriptionText <String> ] [-SignInPageDescriptionText <String> ] [-SignOutPageDescriptionText <String> ] [-UpdatePasswordPageDescriptionText <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: IdentifierObject
Set-AdfsGlobalWebContent [-TargetWebContent] <AdfsGlobalWebContent> [-CertificatePageDescriptionText <String> ] [-CompanyName <String> ] [-ErrorPageAuthorizationErrorMessage <String> ] [-ErrorPageDescriptionText <String> ] [-ErrorPageDeviceAuthenticationErrorMessage <String> ] [-ErrorPageGenericErrorMessage <String> ] [-ErrorPageSupportEmail <String> ] [-HelpDeskLink <Uri> ] [-HelpDeskLinkText <String> ] [-HomeLink <Uri> ] [-HomeLinkText <String> ] [-PassThru] [-PrivacyLink <Uri> ] [-PrivacyLinkText <String> ] [-SignInPageAdditionalAuthenticationDescriptionText <String> ] [-SignInPageDescriptionText <String> ] [-SignOutPageDescriptionText <String> ] [-UpdatePasswordPageDescriptionText <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed 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<String>

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.

-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.

-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.

-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.

-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 , or a certificate is disabled in . This string can be an HTML fragment. You can override this message for an application by using the Set-AdfsRelyingPartyWebContent cmdlet.

-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.

-ErrorPageSupportEmail<String>

Specifies the support email address on the error page.

-HelpDeskLink<Uri>

Specifies the help desk link that is shown on the logon pages for AD FS.

-HelpDeskLinkText<String>

Specifies the help desk link text that is shown on the logon pages for AD FS.

-HomeLink<Uri>

Specifies the Home link that is shown on the logon pages for AD FS.

-HomeLinkText<String>

Specifies the Home link text that is shown on the logon pages for AD FS.

-Locale<CultureInfo>

Specifies a locale. The cmdlet sets global web content for the locale that you specify.

-PassThru

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

-PrivacyLink<Uri>

Specifies the Privacy policy link that is shown on the logon pages for AD FS.

-PrivacyLinkText<String>

Specifies the Privacy policy link text that is shown on the logon pages for AD FS.

-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.

-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.

-SignOutPageDescriptionText<String>

Specifies the description to display when a user signs out of applications.

-TargetWebContent<AdfsGlobalWebContent>

Specifies an AdfsGlobalWebContent object. The cmdlet modifies content for the object that you specify. To obtain a AdfsGlobalWebContentobject, use the Get-AdfsGlobalWebContent cmdlet.

-UpdatePasswordPageDescriptionText<String>

Specifies the description to display in the update password page when users change their passwords.

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

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

<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.IdentityServer.Management.Resources.AdfsGlobalWebContent

  This cmdlet generates a System.IdentityServer.Management.Resources.AdfsGlobalWebContent object that represents global web content. The object includes the following properties:

  Locale: System.Globalization.CultureInfo
  CompanyName: System.String
  HelpDeskLink: System.Uri
  HelpDeskLinkText: System.String
  HomeLink: System.Uri
  HomeLinkText: System.String
  PrivacyLink: System.Uri
  PrivacyLinkText: System.String
  SignInPageDescriptionText: System.String
  SignOutPageDescriptionText: System.String
  ErrorPageDescriptionText: System.String
  ErrorPageGenericErrorMessage: System.String
  ErrorPageAuthorizationErrorMessage: System.String
  ErrorPageDeviceAuthenticationErrorMessage: System.String
  ErrorPageSupportEmail: System.String
  ErrorPageSupportEmailText: System.String
  UpdatePasswordPageDescriptionText: System.String
  SignInPageAdditionalAuthenticationDescriptionText: System.String

Examples

Example 1: Set the company name for the global web content

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 Contoso.

PS C:\> Set-AdfsGlobalWebContent -Locale "" -CompanyName "Contoso"

Example 2: Set the text and links for the sign-in pages

This command specifies the text to display in the sign-in pages for AD FS for the en-us locale.

PS C:\> Set-AdfsWebContent -Locale "en-us" -CompanyName "Contoso" -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 "support@contoso.com" -ErrorPageSupportEmailText "Email" -UpdatePasswordPageDescriptionText "Update password here" -UpdatePasswordPageLink "http://updatepasswordlink" -UpdatePasswordPageLinkText "Update password"

Example 3: Set the text and links for the certificate page

This command specifies the text and links to display when an application prompts a user prompted for a certificate.

PS C:\> Set-AdfsGlobalWebContent -Locale "en-us" -CompanyName "Contoso" -HomeLink "http://homelink" -HomeLinkText "Home" -PrivacyLink "http://privaylink" -PrivacyLinkText "Privacy statement" -SignInPageDescriptionText "<p>Sign-in to Contoso requires device registration. Click <A href='http://fs1.contoso.com/deviceregistration/'>here</A> for more information.</p>" -SignOutPageDescriptionText "Sign out here" -ErrorPageGenericErrorMessage "An error occurred." -ErrorPageSupportEmail "support@contoso.com" -UpdatePasswordPageDescriptionText "Update password here" -CertificatePageDescriptionText "Sign in with your Smartcard"

Related topics

Get-AdfsGlobalWebContent

Remove-AdfsGlobalWebContent

Set-AdfsRelyingPartyWebContent