Set-AdfsRelyingPartyWebContent
Sets properties for the relying party web content objects.
Syntax
Set-AdfsRelyingPartyWebContent
[-CertificatePageDescriptionText <String>]
[-CompanyName <String>]
[-ErrorPageDescriptionText <String>]
[-ErrorPageGenericErrorMessage <String>]
[-ErrorPageAuthorizationErrorMessage <String>]
[-ErrorPageDeviceAuthenticationErrorMessage <String>]
[-ErrorPageSupportEmail <String>]
[-HelpDeskLink <Uri>]
[-HelpDeskLinkText <String>]
[-HomeLink <Uri>]
[-HomeLinkText <String>]
[-HomeRealmDiscoveryOtherOrganizationDescriptionText <String>]
[-HomeRealmDiscoveryPageDescriptionText <String>]
[-OrganizationalNameDescriptionText <String>]
[-PrivacyLink <Uri>]
[-PrivacyLinkText <String>]
[-SignInPageDescriptionText <String>]
[-SignInPageAdditionalAuthenticationDescriptionText <String>]
[-PassThru]
[[-Locale] <CultureInfo>]
-TargetRelyingPartyName <String>
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-AdfsRelyingPartyWebContent
[-CertificatePageDescriptionText <String>]
[-CompanyName <String>]
[-ErrorPageDescriptionText <String>]
[-ErrorPageGenericErrorMessage <String>]
[-ErrorPageAuthorizationErrorMessage <String>]
[-ErrorPageDeviceAuthenticationErrorMessage <String>]
[-ErrorPageSupportEmail <String>]
[-HelpDeskLink <Uri>]
[-HelpDeskLinkText <String>]
[-HomeLink <Uri>]
[-HomeLinkText <String>]
[-HomeRealmDiscoveryOtherOrganizationDescriptionText <String>]
[-HomeRealmDiscoveryPageDescriptionText <String>]
[-OrganizationalNameDescriptionText <String>]
[-PrivacyLink <Uri>]
[-PrivacyLinkText <String>]
[-SignInPageDescriptionText <String>]
[-SignInPageAdditionalAuthenticationDescriptionText <String>]
[-PassThru]
[-TargetRelyingPartyWebContent] <AdfsRelyingPartyWebContent>
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Set-AdfsRelyingPartyWebContent cmdlet sets properties for a relying party web content object. These properties override equivalent values set by using the Set-AdfsGlobalWebContent cmdlet to obtain a web content object. Specify a relying party web content object by using a name and locale, or use the Get-AdfsRelyingPartyWebContent cmdlet. If you do not specify a locale, the cmdlet uses the invariant locale.
Examples
Example 1: Specify a generic error message
PS C:\> Set-AdfsRelyingPartyWebContent -Name "RelyingParty01" -ErrorPageGenericErrorMessage "There is an error."This command specifies a generic error message to display to users for the relying party named RelyingParty01.
Example 2: Specify multiple error messages
PS C:\> Set-AdfsRelyingPartyWebContent -Locale en-us -Name "RelyingParty02" -ErrorPageAuthorizationErrorMessage "There is an authorization error." -ErrorPageDeviceAuthenticationErrorMessage "There is a device authentication error." -ErrorPageGenericErrorMessage "There is an error."This command assigns multiple error messages to display to users for the relying party named RelyingParty01 with the specified locale.
Example 2: Create a custom message on the Sign in page
PS C:\> Set-AdfsRelyingPartyWebContent -SignInPageDescription "If you have forgotten your password, visit <A href='https://passwordreset.microsoftonline.com/'>Microsoft Entra self-service password reset</A>." -TargetRelyingPartyName "Microsoft Office 365 Identity Platform"The command creates a custom message on the Sign in page for the Office 365 relying party.
Parameters
-CertificatePageDescriptionText
Specifies text to display under the text for the CompanyName parameter on the certificate selection page.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CompanyName
Specifies the heading text on Sign in page.
| Type: | String |
| 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 |
-ErrorPageAuthorizationErrorMessage
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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ErrorPageDescriptionText
Specifies the text under the text for the CompanyName parameter on the Sign in error page.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ErrorPageDeviceAuthenticationErrorMessage
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 Active Directory Federation Services (AD FS), a certificate that is not found in Active Directory® Domain Services, or a certificate that is disabled in Active Directory Domain Services. This string can be an HTML fragment.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ErrorPageGenericErrorMessage
Specifies an error message to display for any generic errors that occur for a token request. This string can be an HTML fragment.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ErrorPageSupportEmail
Specifies the email address to display on the Sign in error page.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HelpDeskLink
Specifies the target of the Help Desk link at the bottom of the Sign in page.
| Type: | Uri |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HelpDeskLinkText
Specifies the text of the Help Desk link at the bottom of the Sign in page.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HomeLink
Specifies the target of the Home link at the bottom of the Sign in page.
| Type: | Uri |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HomeLinkText
Specifies the text of the Home link at the bottom of the Sign in page.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HomeRealmDiscoveryOtherOrganizationDescriptionText
Specifies a description displayed above the user name entry prompt. If you configure a UPN suffix mapping to one or more claims provider trusts, the home realm discovery page features an option for Other organization. If users select this option, they are prompted to enter a user name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HomeRealmDiscoveryPageDescriptionText
Specifies text to display under the text for the CompanyName parameter on the home realm discovery page.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Locale
Specifies a locale. The cmdlet sets relying party web content for the locale that you specify.
| Type: | CultureInfo |
| Position: | 0 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-OrganizationalNameDescriptionText
Specifies the text under the text for the CompanyName parameter on the Sign in page.
| Type: | String |
| 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 |
-PrivacyLink
Specifies the target of the Privacy link at the bottom of the Sign in page.
| Type: | Uri |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PrivacyLinkText
Specifies the text of the Privacy link at the bottom of the Sign in page.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SignInPageAdditionalAuthenticationDescriptionText
Specifies the text under the text for the CompanyName parameter on the additional authentication choice page.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SignInPageDescriptionText
Specifies the text under the sign in options on the Sign in page.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TargetRelyingPartyName
Specifies the name of the relying party trust to modify.
| Type: | String |
| Aliases: | Name |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TargetRelyingPartyWebContent
Specifies the name of the relying party web content to modify.
| Type: | AdfsRelyingPartyWebContent |
| Aliases: | TargetWebContent |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| 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 |
Outputs
System.IdentityServer.Management.Resources.AdfsRelyingPartyWebContent
This cmdlet generates a System.IdentityServer.Management.Resources.AdfsRelyingPartyWebContent object that represents web content of a relying party, or an array of such objects. The object includes the following properties:
- Locale: System.Globalization.CultureInfo
- Name: System.String
- ErrorPageGenericErrorMessage: System.String
- ErrorPageAuthorizationErrorMessage: System.String
- ErrorPageDeviceAuthenticationErrorMessage: System.String
Related Links
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for