Edit

Share via

Set-AdfsRelyingPartyWebContent

  • Reference
Module:
ADFS

Sets properties for the relying party web content objects.

Syntax

Set-AdfsRelyingPartyWebContent
   [-ErrorPageGenericErrorMessage <String>]
   [-ErrorPageAuthorizationErrorMessage <String>]
   [-ErrorPageDeviceAuthenticationErrorMessage <String>]
   [-PassThru]
   [[-Locale] <CultureInfo>]
   -Name <String>
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AdfsRelyingPartyWebContent
   [-ErrorPageGenericErrorMessage <String>]
   [-ErrorPageAuthorizationErrorMessage <String>]
   [-ErrorPageDeviceAuthenticationErrorMessage <String>]
   [-PassThru]
   [-TargetWebContent] <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.

Parameters

-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

-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

-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

-Name

Specifies a name. The cmdlet modifies content for the relying party that you specify by name.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
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

-TargetWebContent

Specifies a relying party web content object. The cmdlet modifies content for the object that you specify. To obtain a relying party web content object, use Get-AdfsRelyingPartyWebContent.

Type:AdfsRelyingPartyWebContent
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