RequestSecurityToken Class

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.]

Represents the wst:RequestSecurityToken element (RST), which is used to request a security token.

Namespace: Microsoft.IdentityModel.Protocols.WSTrust
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim instance As RequestSecurityToken

Syntax

'Declaration
Public Class RequestSecurityToken
    Inherits WSTrustMessage

public class RequestSecurityToken : WSTrustMessage

public ref class RequestSecurityToken : public WSTrustMessage

public class RequestSecurityToken extends WSTrustMessage

public class RequestSecurityToken extends WSTrustMessage

Remarks

The wst:RequestSecurityToken element (message) contains the parameters and properties used to request a security token from a security token service (STS). The message (or element) is abbreviated as RST. The RequestSecurityToken class contains properties that represent the elements of the RST. An RST can form a request that corresponds to any of the request bindings defined by WS-Trust; for example, the Issuance binding, the Renewal binding, the Validate binding, or the Cancel binding. Many of the properties in the RequestSecurityToken class correspond to elements that are present only in specific kinds of requests as defined by these bindings. Depending on the kind of request a particular RequestSecurityToken object represents or the parameters present in the specific request that it represents, some properties of the object may be null.

The STS returns a response to the request in a message that contains a wst:RequestSecurityTokenResponse element (RSTR). This message is represented by the RequestSecurityTokenResponse class.

For more information about the element that this class represents, see the version of the WS-Trust specification that applies to your scenario. You can find links to the WS-Trust specifications and other WS-* specifications relevant to WIF in the Windows Identity Foundation SDK topic.

Inheritance Hierarchy

System.Object
   Microsoft.IdentityModel.OpenObject
     Microsoft.IdentityModel.Protocols.WSTrust.WSTrustMessage
      Microsoft.IdentityModel.Protocols.WSTrust.RequestSecurityToken

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)