Saml2AuthenticationStatement.xml

<Type Name="Saml2AuthenticationStatement" FullName="System.IdentityModel.Tokens.Saml2AuthenticationStatement">
  <TypeSignature Language="C#" Value="public class Saml2AuthenticationStatement : System.IdentityModel.Tokens.Saml2Statement" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Saml2AuthenticationStatement extends System.IdentityModel.Tokens.Saml2Statement" />
  <TypeSignature Language="DocId" Value="T:System.IdentityModel.Tokens.Saml2AuthenticationStatement" />
  <TypeSignature Language="VB.NET" Value="Public Class Saml2AuthenticationStatement&#xA;Inherits Saml2Statement" />
  <TypeSignature Language="F#" Value="type Saml2AuthenticationStatement = class&#xA;    inherit Saml2Statement" />
  <TypeSignature Language="C++ CLI" Value="public ref class Saml2AuthenticationStatement : System::IdentityModel::Tokens::Saml2Statement" />
  <AssemblyInfo>
    <AssemblyName>System.IdentityModel</AssemblyName>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.IdentityModel.Tokens.Saml2Statement</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>Represents the AuthnStatement element specified in [Saml2Core, 2.7.2].</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Remarks  
 For more information about the element that this class represents, see the SAML V2.0 Core specification.  
  
 ]]></format>
    </remarks>
  </Docs>
  <Members>
    <MemberGroup MemberName=".ctor">
      <AssemblyInfo>
        <AssemblyName>System.IdentityModel</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Docs>
        <summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Tokens.Saml2AuthenticationStatement" /> class.</summary>
      </Docs>
    </MemberGroup>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Saml2AuthenticationStatement (System.IdentityModel.Tokens.Saml2AuthenticationContext authenticationContext);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.IdentityModel.Tokens.Saml2AuthenticationContext authenticationContext) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.Saml2AuthenticationStatement.#ctor(System.IdentityModel.Tokens.Saml2AuthenticationContext)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (authenticationContext As Saml2AuthenticationContext)" />
      <MemberSignature Language="F#" Value="new System.IdentityModel.Tokens.Saml2AuthenticationStatement : System.IdentityModel.Tokens.Saml2AuthenticationContext -&gt; System.IdentityModel.Tokens.Saml2AuthenticationStatement" Usage="new System.IdentityModel.Tokens.Saml2AuthenticationStatement authenticationContext" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; Saml2AuthenticationStatement(System::IdentityModel::Tokens::Saml2AuthenticationContext ^ authenticationContext);" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.IdentityModel</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="authenticationContext" Type="System.IdentityModel.Tokens.Saml2AuthenticationContext" />
      </Parameters>
      <Docs>
        <param name="authenticationContext">The authentication context of this statement.</param>
        <summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Tokens.Saml2AuthenticationStatement" /> class with the specified authentication context and the current time as the authentication instant.</summary>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The <xref:System.IdentityModel.Tokens.Saml2AuthenticationStatement.AuthenticationInstant%2A> property is set to <xref:System.DateTime.UtcNow%2A>.  
  
 ]]></format>
        </remarks>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="authenticationContext" /> is <see langword="null" />.</exception>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Saml2AuthenticationStatement (System.IdentityModel.Tokens.Saml2AuthenticationContext authenticationContext, DateTime authenticationInstant);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.IdentityModel.Tokens.Saml2AuthenticationContext authenticationContext, valuetype System.DateTime authenticationInstant) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.Saml2AuthenticationStatement.#ctor(System.IdentityModel.Tokens.Saml2AuthenticationContext,System.DateTime)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (authenticationContext As Saml2AuthenticationContext, authenticationInstant As DateTime)" />
      <MemberSignature Language="F#" Value="new System.IdentityModel.Tokens.Saml2AuthenticationStatement : System.IdentityModel.Tokens.Saml2AuthenticationContext * DateTime -&gt; System.IdentityModel.Tokens.Saml2AuthenticationStatement" Usage="new System.IdentityModel.Tokens.Saml2AuthenticationStatement (authenticationContext, authenticationInstant)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; Saml2AuthenticationStatement(System::IdentityModel::Tokens::Saml2AuthenticationContext ^ authenticationContext, DateTime authenticationInstant);" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.IdentityModel</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="authenticationContext" Type="System.IdentityModel.Tokens.Saml2AuthenticationContext" />
        <Parameter Name="authenticationInstant" Type="System.DateTime" />
      </Parameters>
      <Docs>
        <param name="authenticationContext">The authentication context of this statement.</param>
        <param name="authenticationInstant">The time of the authentication.</param>
        <summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Tokens.Saml2AuthenticationStatement" /> class with the specified authentication context and authentication time.</summary>
        <remarks>To be added.</remarks>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="authenticationContext" /> is <see langword="null" />.</exception>
      </Docs>
    </Member>
    <Member MemberName="AuthenticationContext">
      <MemberSignature Language="C#" Value="public System.IdentityModel.Tokens.Saml2AuthenticationContext AuthenticationContext { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.IdentityModel.Tokens.Saml2AuthenticationContext AuthenticationContext" />
      <MemberSignature Language="DocId" Value="P:System.IdentityModel.Tokens.Saml2AuthenticationStatement.AuthenticationContext" />
      <MemberSignature Language="VB.NET" Value="Public Property AuthenticationContext As Saml2AuthenticationContext" />
      <MemberSignature Language="F#" Value="member this.AuthenticationContext : System.IdentityModel.Tokens.Saml2AuthenticationContext with get, set" Usage="System.IdentityModel.Tokens.Saml2AuthenticationStatement.AuthenticationContext" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::IdentityModel::Tokens::Saml2AuthenticationContext ^ AuthenticationContext { System::IdentityModel::Tokens::Saml2AuthenticationContext ^ get(); void set(System::IdentityModel::Tokens::Saml2AuthenticationContext ^ value); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.IdentityModel</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.IdentityModel.Tokens.Saml2AuthenticationContext</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets or sets the context used by the authenticating authority up to and including the authentication event that yielded this statement. [Saml2Core, 2.7.2]</summary>
        <value>A <see cref="T:System.IdentityModel.Tokens.Saml2AuthenticationContext" /> that represents the context.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The AuthnContext element. This element is required.  
  
 ]]></format>
        </remarks>
        <exception cref="T:System.ArgumentNullException">An attempt to set a value that is <see langword="null" /> occurs.</exception>
      </Docs>
    </Member>
    <Member MemberName="AuthenticationInstant">
      <MemberSignature Language="C#" Value="public DateTime AuthenticationInstant { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime AuthenticationInstant" />
      <MemberSignature Language="DocId" Value="P:System.IdentityModel.Tokens.Saml2AuthenticationStatement.AuthenticationInstant" />
      <MemberSignature Language="VB.NET" Value="Public Property AuthenticationInstant As DateTime" />
      <MemberSignature Language="F#" Value="member this.AuthenticationInstant : DateTime with get, set" Usage="System.IdentityModel.Tokens.Saml2AuthenticationStatement.AuthenticationInstant" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property DateTime AuthenticationInstant { DateTime get(); void set(DateTime value); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.IdentityModel</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.DateTime</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets or sets the time at which the authentication took place. [Saml2Core, 2.7.2]</summary>
        <value>A <see cref="T:System.DateTime" /> that represents the time of authentication in UTC.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The AuthnInstant attribute. This attribute is required.  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="SessionIndex">
      <MemberSignature Language="C#" Value="public string SessionIndex { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string SessionIndex" />
      <MemberSignature Language="DocId" Value="P:System.IdentityModel.Tokens.Saml2AuthenticationStatement.SessionIndex" />
      <MemberSignature Language="VB.NET" Value="Public Property SessionIndex As String" />
      <MemberSignature Language="F#" Value="member this.SessionIndex : string with get, set" Usage="System.IdentityModel.Tokens.Saml2AuthenticationStatement.SessionIndex" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ SessionIndex { System::String ^ get(); void set(System::String ^ value); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.IdentityModel</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets or sets the index of a particular session between the principal identified by the subject and the authenticating authority. [Saml2Core, 2.7.2]</summary>
        <value>A string that contains the session index.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The SessionIndex attribute.  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="SessionNotOnOrAfter">
      <MemberSignature Language="C#" Value="public DateTime? SessionNotOnOrAfter { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;valuetype System.DateTime&gt; SessionNotOnOrAfter" />
      <MemberSignature Language="DocId" Value="P:System.IdentityModel.Tokens.Saml2AuthenticationStatement.SessionNotOnOrAfter" />
      <MemberSignature Language="VB.NET" Value="Public Property SessionNotOnOrAfter As Nullable(Of DateTime)" />
      <MemberSignature Language="F#" Value="member this.SessionNotOnOrAfter : Nullable&lt;DateTime&gt; with get, set" Usage="System.IdentityModel.Tokens.Saml2AuthenticationStatement.SessionNotOnOrAfter" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property Nullable&lt;DateTime&gt; SessionNotOnOrAfter { Nullable&lt;DateTime&gt; get(); void set(Nullable&lt;DateTime&gt; value); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.IdentityModel</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.DateTime&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets or sets the time instant at which the session between the principal identified by the subject and the SAML authority issuing this statement must be considered ended. [Saml2Core, 2.7.2]</summary>
        <value>A nullable <see cref="T:System.DateTime" /> that represents the session expiration time in UTC. A <see langword="null" /> value indicates that the attribute is not specified.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The SessionNotOnOrAfter attribute.  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="SubjectLocality">
      <MemberSignature Language="C#" Value="public System.IdentityModel.Tokens.Saml2SubjectLocality SubjectLocality { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.IdentityModel.Tokens.Saml2SubjectLocality SubjectLocality" />
      <MemberSignature Language="DocId" Value="P:System.IdentityModel.Tokens.Saml2AuthenticationStatement.SubjectLocality" />
      <MemberSignature Language="VB.NET" Value="Public Property SubjectLocality As Saml2SubjectLocality" />
      <MemberSignature Language="F#" Value="member this.SubjectLocality : System.IdentityModel.Tokens.Saml2SubjectLocality with get, set" Usage="System.IdentityModel.Tokens.Saml2AuthenticationStatement.SubjectLocality" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::IdentityModel::Tokens::Saml2SubjectLocality ^ SubjectLocality { System::IdentityModel::Tokens::Saml2SubjectLocality ^ get(); void set(System::IdentityModel::Tokens::Saml2SubjectLocality ^ value); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.IdentityModel</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.IdentityModel.Tokens.Saml2SubjectLocality</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets or sets the DNS domain name and IP address for the system from which the assertion subject was apparently authenticated. [Saml2Core, 2.7.2]</summary>
        <value>A <see cref="T:System.IdentityModel.Tokens.Saml2SubjectLocality" /> that specifies the DNS domain name and IP address.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The SubjectLocality element.  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
  </Members>
</Type>