GenericIdentity Class

GenericIdentity Class

 

Represents a generic user.

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

System.Object
  System.Security.Claims.ClaimsIdentity
    System.Security.Principal.GenericIdentity
      System.Net.HttpListenerBasicIdentity

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

NameDescription
System_CAPS_protmethodGenericIdentity(GenericIdentity)

Initializes a new instance of the GenericIdentity class by using the specified GenericIdentity object.

System_CAPS_pubmethodGenericIdentity(String)

Initializes a new instance of the GenericIdentity class representing the user with the specified name.

System_CAPS_pubmethodGenericIdentity(String, String)

Initializes a new instance of the GenericIdentity class representing the user with the specified name and authentication type.

NameDescription
System_CAPS_pubpropertyActor

Gets or sets the identity of the calling party that was granted delegation rights.(Inherited from ClaimsIdentity.)

System_CAPS_pubpropertyAuthenticationType

Gets the type of authentication used to identify the user.(Overrides ClaimsIdentity.AuthenticationType.)

System_CAPS_pubpropertyBootstrapContext

Gets or sets the token that was used to create this claims identity.(Inherited from ClaimsIdentity.)

System_CAPS_pubpropertyClaims

Gets all claims for the user represented by this generic identity.(Overrides ClaimsIdentity.Claims.)

System_CAPS_protpropertyCustomSerializationData

(Inherited from ClaimsIdentity.)

System_CAPS_pubpropertyIsAuthenticated

Gets a value indicating whether the user has been authenticated.(Overrides ClaimsIdentity.IsAuthenticated.)

System_CAPS_pubpropertyLabel

Gets or sets the label for this claims identity.(Inherited from ClaimsIdentity.)

System_CAPS_pubpropertyName

Gets the user's name.(Overrides ClaimsIdentity.Name.)

System_CAPS_pubpropertyNameClaimType

Gets the claim type that is used to determine which claims provide the value for the Name property of this claims identity.(Inherited from ClaimsIdentity.)

System_CAPS_pubpropertyRoleClaimType

Gets the claim type that will be interpreted as a .NET Framework role among the claims in this claims identity.(Inherited from ClaimsIdentity.)

NameDescription
System_CAPS_pubmethodAddClaim(Claim)

Adds a single claim to this claims identity.(Inherited from ClaimsIdentity.)

System_CAPS_pubmethodAddClaims(IEnumerable(Of Claim))

Adds a list of claims to this claims identity.(Inherited from ClaimsIdentity.)

System_CAPS_pubmethodClone()

Creates a new object that is a copy of the current instance.(Overrides ClaimsIdentity.Clone().)

System_CAPS_protmethodCreateClaim(BinaryReader)

(Inherited from ClaimsIdentity.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodFindAll(Predicate(Of Claim))

Retrieves all of the claims that are matched by the specified predicate.(Inherited from ClaimsIdentity.)

System_CAPS_pubmethodFindAll(String)

Retrieves all of the claims that have the specified claim type.(Inherited from ClaimsIdentity.)

System_CAPS_pubmethodFindFirst(Predicate(Of Claim))

Retrieves the first claim that is matched by the specified predicate.(Inherited from ClaimsIdentity.)

System_CAPS_pubmethodFindFirst(String)

Retrieves the first claim with the specified claim type.(Inherited from ClaimsIdentity.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_protmethodGetObjectData(SerializationInfo, StreamingContext)

Populates the SerializationInfo with data needed to serialize the current ClaimsIdentity object.(Inherited from ClaimsIdentity.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodHasClaim(Predicate(Of Claim))

Determines whether this claims identity has a claim that is matched by the specified predicate.(Inherited from ClaimsIdentity.)

System_CAPS_pubmethodHasClaim(String, String)

Determines whether this claims identity has a claim with the specified claim type and value.(Inherited from ClaimsIdentity.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodRemoveClaim(Claim)

Attempts to remove a claim from the claims identity.(Inherited from ClaimsIdentity.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodTryRemoveClaim(Claim)

Attempts to remove a claim from the claims identity.(Inherited from ClaimsIdentity.)

System_CAPS_pubmethodWriteTo(BinaryWriter)

(Inherited from ClaimsIdentity.)

System_CAPS_protmethodWriteTo(BinaryWriter, Byte())

(Inherited from ClaimsIdentity.)

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

Universal Windows Platform
Available since 10
.NET Framework
Available since 1.1

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

Return to top
Show:
© 2016 Microsoft