Export (0) Print
Expand All

GenericIdentity Class

Represents a generic user.

Namespace:  System.Security.Principal
Assembly:  mscorlib (in mscorlib.dll)

'Declaration
<SerializableAttribute> _
<ComVisibleAttribute(True)> _
Public Class GenericIdentity _
	Inherits ClaimsIdentity

The GenericIdentity type exposes the following members.

  NameDescription
Protected methodGenericIdentity(GenericIdentity)Initializes a new instance of the GenericIdentity class by using the specified GenericIdentity object.
Public methodGenericIdentity(String)Initializes a new instance of the GenericIdentity class representing the user with the specified name.
Public methodGenericIdentity(String, String)Initializes a new instance of the GenericIdentity class representing the user with the specified name and authentication type.
Top

  NameDescription
Public propertyActorGets or sets the identity of the calling party that was granted delegation rights. (Inherited from ClaimsIdentity.)
Public propertyAuthenticationTypeGets the type of authentication used to identify the user. (Overrides ClaimsIdentity.AuthenticationType.)
Public propertyBootstrapContextGets or sets the token that was used to create this claims identity. (Inherited from ClaimsIdentity.)
Public propertyClaimsGets all claims for the user represented by this generic identity. (Overrides ClaimsIdentity.Claims.)
Public propertyIsAuthenticatedGets a value indicating whether the user has been authenticated. (Overrides ClaimsIdentity.IsAuthenticated.)
Public propertyLabelGets or sets the label for this claims identity. (Inherited from ClaimsIdentity.)
Public propertyNameGets the user's name. (Overrides ClaimsIdentity.Name.)
Public propertyNameClaimTypeGets the claim type that is used to determine which claims provide the value for the Name property of this claims identity. (Inherited from ClaimsIdentity.)
Public propertyRoleClaimTypeGets the claim type that will be interpreted as a .NET Framework role among the claims in this claims identity. (Inherited from ClaimsIdentity.)
Top

  NameDescription
Public methodAddClaimAdds a single claim to this claims identity. (Inherited from ClaimsIdentity.)
Public methodAddClaimsAdds a list of claims to this claims identity. (Inherited from ClaimsIdentity.)
Public methodCloneCreates a new object that is a copy of the current instance. (Overrides ClaimsIdentity.Clone.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodFindAll(Predicate(Of Claim))Retrieves all of the claims that are matched by the specified predicate. (Inherited from ClaimsIdentity.)
Public methodFindAll(String)Retrieves all of the claims that have the specified claim type. (Inherited from ClaimsIdentity.)
Public methodFindFirst(Predicate(Of Claim))Retrieves the first claim that is matched by the specified predicate. (Inherited from ClaimsIdentity.)
Public methodFindFirst(String)Retrieves the first claim with the specified claim type. (Inherited from ClaimsIdentity.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Protected methodGetObjectDataPopulates the SerializationInfo with data needed to serialize the current ClaimsIdentity object. (Inherited from ClaimsIdentity.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodHasClaim(Predicate(Of Claim))Determines whether this claims identity has a claim that is matched by the specified predicate. (Inherited from ClaimsIdentity.)
Public methodHasClaim(String, String)Determines whether this claims identity has a claim with the specified claim type and value. (Inherited from ClaimsIdentity.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodRemoveClaimAttempts to remove a claim from the claims identity. (Inherited from ClaimsIdentity.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodTryRemoveClaimAttempts to remove a claim from the claims identity. (Inherited from ClaimsIdentity.)
Top

An identity object represents the user on whose behalf the code is running.

The following example shows the use of members of the GenericIdentity class.

Imports System
Imports System.Security.Principal

Public Class Form1
    Inherits System.Windows.Forms.Form

    ' Event handler for Run button. 
    Private Sub Button1_Click( _
        ByVal sender As System.Object, _
        ByVal e As System.EventArgs) Handles Button1.Click

        tbxOutput.Cursor = Cursors.WaitCursor
        tbxOutput.Text = "" 

        ' Create a GenericIdentity object with no authentication type  
        ' specified. 
        Dim defaultIdentity As New GenericIdentity("DefaultUser")

        ' Retrieve a GenericIdentity created from current WindowsIdentity 
        ' values. 
        Dim currentIdentity As GenericIdentity = GetGenericIdentity()

        ShowIdentityPreferences(New GenericIdentity(""))
        ShowIdentityPreferences(defaultIdentity)
        ShowIdentityPreferences(currentIdentity)

        ' Align interface and conclude application.
        tbxOutput.AppendText(vbCrLf + "This sample completed " + _
            "successfully; press Exit to continue.")

        tbxOutput.Cursor = Cursors.Default 
    End Sub 

    ' Print identity preferences to the console window. 
    Private Sub ShowIdentityPreferences( _
        ByVal genericIdentity As GenericIdentity)

        ' Retrieve the name of the generic identity object. 
        Dim identityName As String = genericIdentity.Name

        ' Retrieve the authentication type of the generic identity object. 
        Dim identityAuthenticationType As String
        identityAuthenticationType = genericIdentity.AuthenticationType()

        tbxOutput.AppendText(vbCrLf + "Name: " + identityName)
        tbxOutput.AppendText(vbCrLf + "Type: " + identityAuthenticationType)

        tbxOutput.AppendText(vbCrLf)

        ' Verify that the user's identity has been authenticated 
        ' (was created with a valid name). 
        If (genericIdentity.IsAuthenticated) Then
            tbxOutput.AppendText("The user's identity has been " + _
                "authenticated.")
        Else
            tbxOutput.AppendText("The user's identity has not been " + _
                "authenticated.")
        End If

        tbxOutput.AppendText(vbCrLf + "~~~~~~~~~~~~~~~~~~~~~~~~~")
    End Sub 

    ' Create generic identity based on values from the current 
    ' WindowsIdentity. 
    Private Function GetGenericIdentity()
        ' Get values from the current WindowsIdentity. 
        Dim windowsIdentity As WindowsIdentity = windowsIdentity.GetCurrent()

        ' Construct a GenericIdentity object based on the current Windows 
        ' identity name and authentication type. 
        Dim authenticationType As String = windowsIdentity.AuthenticationType
        Dim userName As String = windowsIdentity.Name
        Dim authenticatedGenericIdentity As _
            New GenericIdentity(userName, authenticationType)

        Return authenticatedGenericIdentity
    End Function 

    ' Event handler for Exit button. 
    Private Sub Button2_Click( _
        ByVal sender As System.Object, _
        ByVal e As System.EventArgs) Handles Button2.Click

        Application.Exit()
    End Sub
#Region " Windows Form Designer generated code " 

    Public Sub New()
        MyBase.New()

        'This call is required by the Windows Form Designer.
        InitializeComponent()

        'Add any initialization after the InitializeComponent() call 

    End Sub 

    'Form overrides dispose to clean up the component list. 
    Protected Overloads Overrides Sub Dispose(ByVal disposing As Boolean)
        If disposing Then 
            If Not (components Is Nothing) Then
                components.Dispose()
            End If 
        End If 
        MyBase.Dispose(disposing)
    End Sub 

    'Required by the Windows Form Designer 
    Private components As System.ComponentModel.IContainer

    'NOTE: The following procedure is required by the Windows Form Designer 
    'It can be modified using the Windows Form Designer.   
    'Do not modify it using the code editor. 
    Friend WithEvents Panel2 As System.Windows.Forms.Panel
    Friend WithEvents Panel1 As System.Windows.Forms.Panel
    Friend WithEvents Button1 As System.Windows.Forms.Button
    Friend WithEvents Button2 As System.Windows.Forms.Button
    Friend WithEvents tbxOutput As System.Windows.Forms.RichTextBox
    <System.Diagnostics.DebuggerStepThrough()> _
    Private Sub InitializeComponent()
        Me.Panel2 = New System.Windows.Forms.Panel
        Me.Button1 = New System.Windows.Forms.Button
        Me.Button2 = New System.Windows.Forms.Button
        Me.Panel1 = New System.Windows.Forms.Panel
        Me.tbxOutput = New System.Windows.Forms.RichTextBox
        Me.Panel2.SuspendLayout()
        Me.Panel1.SuspendLayout()
        Me.SuspendLayout()
        
        'Panel2 
        
        Me.Panel2.Controls.Add(Me.Button1)
        Me.Panel2.Controls.Add(Me.Button2)
        Me.Panel2.Dock = System.Windows.Forms.DockStyle.Bottom
        Me.Panel2.DockPadding.All = 20
        Me.Panel2.Location = New System.Drawing.Point(0, 320)
        Me.Panel2.Name = "Panel2" 
        Me.Panel2.Size = New System.Drawing.Size(616, 64)
        Me.Panel2.TabIndex = 1
        
        'Button1 
        
        Me.Button1.Dock = System.Windows.Forms.DockStyle.Right
        Me.Button1.Font = New System.Drawing.Font( _
            "Microsoft Sans Serif", _
            9.0!, _
            System.Drawing.FontStyle.Regular, _
            System.Drawing.GraphicsUnit.Point, _
            CType(0, Byte))
        Me.Button1.Location = New System.Drawing.Point(446, 20)
        Me.Button1.Name = "Button1" 
        Me.Button1.Size = New System.Drawing.Size(75, 24)
        Me.Button1.TabIndex = 2
        Me.Button1.Text = "&Run" 
        
        'Button2 
        
        Me.Button2.Dock = System.Windows.Forms.DockStyle.Right
        Me.Button2.Font = New System.Drawing.Font( _
            "Microsoft Sans Serif", _
            9.0!, _
            System.Drawing.FontStyle.Regular, _
            System.Drawing.GraphicsUnit.Point, _
            CType(0, Byte))
        Me.Button2.Location = New System.Drawing.Point(521, 20)
        Me.Button2.Name = "Button2" 
        Me.Button2.Size = New System.Drawing.Size(75, 24)
        Me.Button2.TabIndex = 3
        Me.Button2.Text = "E&xit" 
        
        'Panel1 
        
        Me.Panel1.Controls.Add(Me.tbxOutput)
        Me.Panel1.Dock = System.Windows.Forms.DockStyle.Fill
        Me.Panel1.DockPadding.All = 20
        Me.Panel1.Location = New System.Drawing.Point(0, 0)
        Me.Panel1.Name = "Panel1" 
        Me.Panel1.Size = New System.Drawing.Size(616, 320)
        Me.Panel1.TabIndex = 2
        
        'tbxOutput 
        
        Me.tbxOutput.AccessibleDescription = _
            "Displays output from application." 
        Me.tbxOutput.AccessibleName = "Output textbox." 
        Me.tbxOutput.Dock = System.Windows.Forms.DockStyle.Fill
        Me.tbxOutput.Location = New System.Drawing.Point(20, 20)
        Me.tbxOutput.Name = "tbxOutput" 
        Me.tbxOutput.Size = New System.Drawing.Size(576, 280)
        Me.tbxOutput.TabIndex = 1
        Me.tbxOutput.Text = "Click the Run button to run the application." 
        
        'Form1 
        
        Me.AutoScaleBaseSize = New System.Drawing.Size(6, 15)
        Me.ClientSize = New System.Drawing.Size(616, 384)
        Me.Controls.Add(Me.Panel1)
        Me.Controls.Add(Me.Panel2)
        Me.Name = "Form1" 
        Me.Text = "GenericIdentity" 
        Me.Panel2.ResumeLayout(False)
        Me.Panel1.ResumeLayout(False)
        Me.ResumeLayout(False)

    End Sub

#End Region
End Class

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft