SignInRequestMessage.Realm Property

Reference

Definition

Namespace:: System.IdentityModel.Services

Assembly:: System.IdentityModel.Services.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the wtrealm parameter of the message.

public:
 property System::String ^ Realm { System::String ^ get(); void set(System::String ^ value); };

public string Realm { get; set; }

member this.Realm : string with get, set

Public Property Realm As String

Property Value

String

The value of the wtrealm parameter. This is specified as a URI.

Exceptions

ArgumentException

An attempt to set a value that is not a valid, absolute URI occurs.

Remarks

The wtrealm parameter specifies the security realm to which the requested resource belongs. This is often the URL of the requested resource.

Important

For backward compatibility with Active Directory Federation Services (AD FS) version 1.0, Windows Identity Foundation (WIF) allows either the wtrealm parameter or the wreply parameter to be set (or both) for a sign-in message to be valid; however, the WS-Federation protocol requires that the wtrealm parameter be present in a sign-in request. In most scenarios, you should ensure that the wtrealm parameter is specified.

Set the Realm property to null or an empty string to remove the wtrealm parameter from the message.

Applies to