WSFederationAuthenticationModule.Realm Property

Definition

Namespace:

System.IdentityModel.Services

Assembly:

System.IdentityModel.Services.dll

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

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

A URI that identifies the relying party (RP) to the security token service (STS).

Exceptions

ArgumentException

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

-or-

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

Remarks

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.