SignInRequestMessage.Realm Property

.NET Framework (current version)
 

Gets or sets the wtrealm parameter of the message.

Namespace:   System.IdentityModel.Services
Assembly:  System.IdentityModel.Services (in System.IdentityModel.Services.dll)

public string Realm { get; set; }

Property Value

Type: System.String

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

Exception Condition
ArgumentException

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

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

System_CAPS_importantImportant

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.

.NET Framework
Available since 4.5
Return to top
Show: