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

Creates a SAML 2.0 authentication statement from the specified authentication information.

Namespace: Microsoft.IdentityModel.Tokens.Saml2
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim authInfo As AuthenticationInformation
Dim tokenDescriptor As SecurityTokenDescriptor
Dim returnValue As Saml2AuthenticationStatement

returnValue = Me.CreateAuthenticationStatement(authInfo, tokenDescriptor)

Syntax

'Declaration
Protected Overridable Function CreateAuthenticationStatement ( _
    authInfo As AuthenticationInformation, _
    tokenDescriptor As SecurityTokenDescriptor _
) As Saml2AuthenticationStatement

protected virtual Saml2AuthenticationStatement CreateAuthenticationStatement (
    AuthenticationInformation authInfo,
    SecurityTokenDescriptor tokenDescriptor
)

protected:
virtual Saml2AuthenticationStatement^ CreateAuthenticationStatement (
    AuthenticationInformation^ authInfo, 
    SecurityTokenDescriptor^ tokenDescriptor
)

protected Saml2AuthenticationStatement CreateAuthenticationStatement (
    AuthenticationInformation authInfo, 
    SecurityTokenDescriptor tokenDescriptor
)

protected function CreateAuthenticationStatement (
    authInfo : AuthenticationInformation, 
    tokenDescriptor : SecurityTokenDescriptor
) : Saml2AuthenticationStatement

Parameters

authInfo
An AuthenticationInformation object that contains the state to be wrapped as a Saml2AuthenticationStatement object.

tokenDescriptor
The token descriptor.

Return Value

A Saml2AuthenticationStatement to add to the assertion being created or null to ignore the AuthenticationInformation object (and not create a SAML 2.0 authentication statement).

Exceptions

Exception type	Condition
ArgumentNullException	tokenDescriptor is null. -or- The Subject property of tokenDescriptor is null.
InvalidOperationException	The subject of the tokenDescriptor (the Subject property) contains claims with a claim type of either AuthenticationInstant or AuthenticationMethod but does not contain at least one claim of each type. -or- The authentication method specified by the subject of the tokenDescriptor cannot be resolved to an absolute URI.

ArgumentNullException

tokenDescriptor is null.

-or-

The Subject property of tokenDescriptor is null.

InvalidOperationException

The subject of the tokenDescriptor (the Subject property) contains claims with a claim type of either AuthenticationInstant or AuthenticationMethod but does not contain at least one claim of each type.

-or-

The authentication method specified by the subject of the tokenDescriptor cannot be resolved to an absolute URI.

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)

Share via