Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

WSFederationAuthenticationModule::Realm Property

.NET Framework 4.5

Gets or sets the value of the wtrealm parameter to be used for WS-Federation sign-in requests (“wsignin1.0”).

Namespace:  System.IdentityModel.Services
Assembly:  System.IdentityModel.Services (in System.IdentityModel.Services.dll)
public:
property String^ Realm {
	String^ get ();
	void set (String^ value);
}

Property Value

Type: System::String
A URI that identifies the relying party (RP) to the security token service (STS).
ExceptionCondition
ArgumentException

An attempt to set the property to nullptr or an empty string occurs.

-or-

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

This is a required property for WS-Federation sign-in requests. It must be set if passive redirects are enabled. The URI identifies the RP to the STS. (For identifying the STS to the RP, see the Issuer property).

The value of this property is serialized as the wtrealm query string parameter in WS-Federation protocol. It identifies the RP to the STS. It is used by the STS to decide what policy to apply for token issuance and where to redirect the user to after token issuance. (For identifying the STS to the RP, see Issuer.)

You can override this setting on each HTTP request by adding a handler for the RedirectingToIdentityProvider event. This event is raised just before the module redirects to the security token service (STS) with a WS-Federation sign-in request message. The STS is specified by the Issuer property.

.NET Framework

Supported in: 4.5.1, 4.5

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.