SecurityTokenService.GetProofToken Method

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

Gets the proof token to be included in the response (RSTR).

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

Usage

'Usage
Dim request As RequestSecurityToken
Dim scope As Scope
Dim returnValue As ProofDescriptor

returnValue = Me.GetProofToken(request, scope)

Syntax

'Declaration
Protected Overridable Function GetProofToken ( _
    request As RequestSecurityToken, _
    scope As Scope _
) As ProofDescriptor

protected virtual ProofDescriptor GetProofToken (
    RequestSecurityToken request,
    Scope scope
)

protected:
virtual ProofDescriptor^ GetProofToken (
    RequestSecurityToken^ request, 
    Scope^ scope
)

protected ProofDescriptor GetProofToken (
    RequestSecurityToken request, 
    Scope scope
)

protected function GetProofToken (
    request : RequestSecurityToken, 
    scope : Scope
) : ProofDescriptor

Parameters

request
A RequestSecurityToken that represents the incoming token request (RST).

scope
The Scope instance that encapsulates information about the relying party.

Return Value

A ProofDescriptor that represents the newly created proof descriptor. The proof descriptor can be an asymmetric proof descriptor, a symmetric proof descriptor, or null in the bearer token case.

Exceptions

Exception type	Condition
ArgumentNullException	request is null. -or- scope is null.

ArgumentNullException

request is null.

-or-

scope is null.

Remarks

This method is called from the default token issuance pipeline implemented in the Issue method. For more information about the token issuance pipeline, see the Claims Issuance Pipeline topic.

The default implementation returns a proof descriptor or throws an appropriate exception.

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)