WSFederationAuthenticationModule.Realm Property

Article
10/05/2012

[Starting with the .NET Framework 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework. The version of WIF addressed by this topic, WIF 3.5, is deprecated and should only be used when developing against the .NET Framework 3.5 SP1 or the .NET Framework 4. For more information about WIF in the .NET Framework 4.5, also known as WIF 4.5, see the Windows Identity Foundation documentation in the .NET Framework 4.5 Development Guide.]

This is a required property if PassiveRedirectEnabled is set to true. Get or set a required property that is a URI identifying the relying party to the STS. (For identifying the STS to the RP, see Issuer).

Namespace: Microsoft.IdentityModel.Web
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim instance As WSFederationAuthenticationModule
Dim value As String

value = instance.Realm

instance.Realm = value

Syntax

'Declaration
Public Property Realm As String

public string Realm { get; set; }

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

/** @property */
public String get_Realm ()

/** @property */
public void set_Realm (String value)

public function get Realm () : String

public function set Realm (value : String)

Property Value

Returns String.

Remarks

The value of this property manifests itself as the wtrealm query string parameter in WS-Federation protocol. It is used by the Security Token Service to decide what policy to apply for token issuance and where to redirect the user to after token issuance.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Target Platforms

Windows 7, Windows Server 2008 R2, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2003 SP2 (32-bit or 64-bit)