Share via


SoapContext.IdentityToken Property

Gets or sets the identity security token for a SOAP message.

Namespace: Microsoft.Web.Services3
Assembly: Microsoft.Web.Services3 (in microsoft.web.services3.dll)

Usage

'Usage
Dim soapContext1 As SoapContext

Dim returnValue As SecurityToken
returnValue = soapContext1.IdentityToken

Dim sampleValue As SecurityToken
soapContext1.IdentityToken = sampleValue

Syntax

'Declaration
Public Property IdentityToken() As SecurityToken
public SecurityToken IdentityToken {get; set;}
public:
property SecurityToken^ IdentityToken {
    SecurityToken^ get();
    void set(SecurityToken^ value);
}
public SecurityToken get_IdentityToken();
public void set_IdentityToken(SecurityToken);
public function get IdentityToken() : SecurityToken;
public function set IdentityToken(SecurityToken);

Property Value

The SecurityToken that represents the identity token for the SOAP message.

Exceptions

Exception type Condition
ArgumentException

The IdentityToken property has already been set and the property is being set to a security token that is not equivalent to the current value. The SecurityToken.Equals method is called to determine whether the two security tokens are valid.

Remarks

The identity token for a SOAP message specifies the sender's identity for a SOAP message. Which security token in the SOAP message is the identity token is determined by application code, policy or a custom input filter that receives the SOAP request. There is no XML in the SOAP message that specifies which security token is the identity token. Once it is determined which security token is the identity token, it is up to the application how the identity token is used, with the exception of policy.

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

Development Platforms

Windows XP Home Edition, Windows XP Professional, Windows Server 2003, Windows 2000, Windows 2000 Server, Windows 2000 Advanced Server

Target Platforms

See Also

Reference

SoapContext Class
SoapContext Members
Microsoft.Web.Services3 Namespace