This documentation is archived and is not being maintained.

SecurityTokenProvider.GetToken Method

Gets a security token.

Namespace:  System.IdentityModel.Selectors
Assembly:  System.IdentityModel (in System.IdentityModel.dll)

public SecurityToken GetToken(
	TimeSpan timeout
)

Parameters

timeout
Type: System.TimeSpan
A TimeSpan that specifies the timeout value for the message that gets the security token.

Return Value

Type: System.IdentityModel.Tokens.SecurityToken
The SecurityToken that represents the security token to get.

The GetToken method is called by the ClientCredentials class when a client sends a SOAP message and a security token is required.

The GetToken method calls the GetTokenCore method.

In most cases the timeout parameter is not used by derived classes of SecurityTokenProvider such as UserNameSecurityTokenProvider. However, sometimes retrieving a security token involves distributed messaging. An example is IssuedSecurityTokenProvider used in a federated service. In these cases the timeout parameter is used to avoid exceptions caused by network failures, message loss, and other error conditions.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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