GenericIdentity Class

Reference

Definition

Namespace:: System.Security.Principal

Assemblies:: mscorlib.dll, System.Security.Claims.dll

Assemblies:: netstandard.dll, System.Security.Claims.dll

Assembly:: System.Security.Claims.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

Source:: GenericIdentity.cs

Source:: GenericIdentity.cs

Source:: GenericIdentity.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a generic user.

public ref class GenericIdentity : System::Security::Claims::ClaimsIdentity

public ref class GenericIdentity : System::Security::Principal::IIdentity

public class GenericIdentity : System.Security.Claims.ClaimsIdentity

[System.Serializable]
public class GenericIdentity : System.Security.Principal.IIdentity

[System.Serializable]
[System.Runtime.InteropServices.ComVisible(true)]
public class GenericIdentity : System.Security.Principal.IIdentity

[System.Serializable]
[System.Runtime.InteropServices.ComVisible(true)]
public class GenericIdentity : System.Security.Claims.ClaimsIdentity

type GenericIdentity = class
    inherit ClaimsIdentity

[<System.Serializable>]
type GenericIdentity = class
    interface IIdentity

[<System.Serializable>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type GenericIdentity = class
    interface IIdentity

[<System.Serializable>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type GenericIdentity = class
    inherit ClaimsIdentity

Public Class GenericIdentity
Inherits ClaimsIdentity

Public Class GenericIdentity
Implements IIdentity

Inheritance: Object

ClaimsIdentity
GenericIdentity

Inheritance: Object
GenericIdentity

Derived: System.Net.HttpListenerBasicIdentity

Attributes: SerializableAttribute ComVisibleAttribute

Implements: IIdentity

Examples

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

using namespace System;
using namespace System::Security::Principal;
void ShowIdentityPreferences( GenericIdentity^ genericIdentity );
GenericIdentity^ GetGenericIdentity();

[STAThread]
int main()
{
   // Create a GenericIdentity object with no authentication type 
   // specified.
   GenericIdentity^ defaultIdentity = gcnew GenericIdentity( "DefaultUser" );

   // Retrieve a GenericIdentity created from current WindowsIdentity
   // values.
   GenericIdentity^ currentIdentity = GetGenericIdentity();
   ShowIdentityPreferences( gcnew GenericIdentity( "" ) );
   ShowIdentityPreferences( defaultIdentity );
   ShowIdentityPreferences( currentIdentity );
   Console::WriteLine( "The sample completed successfully; "
   "press Enter to continue." );
   Console::ReadLine();
}

// Print identity preferences to the console window.
void ShowIdentityPreferences( GenericIdentity^ genericIdentity )
{
   // Retrieve the name of the generic identity object.
   String^ identityName = genericIdentity->Name;

   // Retrieve the authentication type of the generic identity object.
   String^ identityAuthenticationType = genericIdentity->AuthenticationType;

   Console::WriteLine( "Name: {0}", identityName );
   Console::WriteLine( "Type: {0}", identityAuthenticationType );

   // Verify that the user's identity has been authenticated
   // (was created with a valid name).
   if ( genericIdentity->IsAuthenticated )
   {
      Console::WriteLine( "The user's identity has been authenticated." );
   }
   else
   {
      Console::WriteLine( "The user's identity has not been "
      "authenticated." );
   }

   Console::WriteLine( "~~~~~~~~~~~~~~~~~~~~~~~~~" );
}


// Create generic identity based on values from the current
// WindowsIdentity.
GenericIdentity^ GetGenericIdentity()
{
   // Get values from the current WindowsIdentity.
   WindowsIdentity^ windowsIdentity = WindowsIdentity::GetCurrent();

   // Construct a GenericIdentity object based on the current Windows
   // identity name and authentication type.
   String^ authenticationType = windowsIdentity->AuthenticationType;
   String^ userName = windowsIdentity->Name;
   GenericIdentity^ authenticatedGenericIdentity = gcnew GenericIdentity( userName,authenticationType );

   return authenticatedGenericIdentity;
}

using System;
using System.Security.Principal;

class GenericIdentityMembers
{
    [STAThread]
    static void Main(string[] args)
    {
        // Create a GenericIdentity object with no authentication type 
        // specified.
        GenericIdentity defaultIdentity = new GenericIdentity("DefaultUser");

        // Retrieve a GenericIdentity created from current WindowsIdentity
        // values.
        GenericIdentity currentIdentity = GetGenericIdentity();

        ShowIdentityPreferences(new GenericIdentity(""));
        ShowIdentityPreferences(defaultIdentity);
        ShowIdentityPreferences(currentIdentity);

        Console.WriteLine("The sample completed successfully; " +
            "press Enter to continue.");
        Console.ReadLine();
    }

    // Print identity preferences to the console window.
    private static void ShowIdentityPreferences(
        GenericIdentity genericIdentity)
    {
        // Retrieve the name of the generic identity object.
        string identityName = genericIdentity.Name;

        // Retrieve the authentication type of the generic identity object.
        string identityAuthenticationType = 
            genericIdentity.AuthenticationType;

        Console.WriteLine("Name: " + identityName);
        Console.WriteLine("Type: " + identityAuthenticationType);
        
        // Verify that the user's identity has been authenticated
        // (was created with a valid name).
        if (genericIdentity.IsAuthenticated)
        {
            Console.WriteLine("The user's identity has been authenticated.");
        }
        else
        {
            Console.WriteLine("The user's identity has not been " + 
                "authenticated.");
        }
        Console.WriteLine("~~~~~~~~~~~~~~~~~~~~~~~~~");
    }

    // Create generic identity based on values from the current
    // WindowsIdentity.
    private static GenericIdentity GetGenericIdentity()
    {
        // Get values from the current WindowsIdentity.
        WindowsIdentity windowsIdentity = WindowsIdentity.GetCurrent();

        // Construct a GenericIdentity object based on the current Windows
        // identity name and authentication type.
        string authenticationType = windowsIdentity.AuthenticationType;
        string userName = windowsIdentity.Name;
        GenericIdentity authenticatedGenericIdentity =
            new GenericIdentity(userName, authenticationType);

        return authenticatedGenericIdentity;
    }
}

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

Remarks

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

Constructors

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

Fields

DefaultIssuer	The default issuer; "LOCAL AUTHORITY". (Inherited from ClaimsIdentity)
DefaultNameClaimType	The default name claim type; Name. (Inherited from ClaimsIdentity)
DefaultRoleClaimType	The default role claim type; Role. (Inherited from ClaimsIdentity)

Properties

Actor	Gets or sets the identity of the calling party that was granted delegation rights. (Inherited from ClaimsIdentity)
AuthenticationType	Gets the type of authentication used to identify the user.
BootstrapContext	Gets or sets the token that was used to create this claims identity. (Inherited from ClaimsIdentity)
Claims	Gets all claims for the user represented by this generic identity.
CustomSerializationData	Contains any additional data provided by a derived type. Typically set when calling WriteTo(BinaryWriter, Byte[]). (Inherited from ClaimsIdentity)
IsAuthenticated	Gets a value indicating whether the user has been authenticated.
Label	Gets or sets the label for this claims identity. (Inherited from ClaimsIdentity)
Name	Gets the user's name.
NameClaimType	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)
RoleClaimType	Gets the claim type that will be interpreted as a .NET role among the claims in this claims identity. (Inherited from ClaimsIdentity)

Methods

AddClaim(Claim)	Adds a single claim to this claims identity. (Inherited from ClaimsIdentity)
AddClaims(IEnumerable<Claim>)	Adds a list of claims to this claims identity. (Inherited from ClaimsIdentity)
Clone()	Creates a new object that is a copy of the current instance.
CreateClaim(BinaryReader)	Provides an extensibility point for derived types to create a custom Claim. (Inherited from ClaimsIdentity)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
FindAll(Predicate<Claim>)	Retrieves all of the claims that are matched by the specified predicate. (Inherited from ClaimsIdentity)
FindAll(String)	Retrieves all of the claims that have the specified claim type. (Inherited from ClaimsIdentity)
FindFirst(Predicate<Claim>)	Retrieves the first claim that is matched by the specified predicate. (Inherited from ClaimsIdentity)
FindFirst(String)	Retrieves the first claim with the specified claim type. (Inherited from ClaimsIdentity)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetObjectData(SerializationInfo, StreamingContext)	Populates the SerializationInfo with data needed to serialize the current ClaimsIdentity object. (Inherited from ClaimsIdentity)
GetType()	Gets the Type of the current instance. (Inherited from Object)
HasClaim(Predicate<Claim>)	Determines whether this claims identity has a claim that is matched by the specified predicate. (Inherited from ClaimsIdentity)
HasClaim(String, String)	Determines whether this claims identity has a claim with the specified claim type and value. (Inherited from ClaimsIdentity)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
RemoveClaim(Claim)	Attempts to remove a claim from the claims identity. (Inherited from ClaimsIdentity)
ToString()	Returns a string that represents the current object. (Inherited from Object)
TryRemoveClaim(Claim)	Attempts to remove a claim from the claims identity. (Inherited from ClaimsIdentity)
WriteTo(BinaryWriter, Byte[])	Serializes using a BinaryWriter. (Inherited from ClaimsIdentity)
WriteTo(BinaryWriter)	Serializes using a BinaryWriter. (Inherited from ClaimsIdentity)

Applies to

Product	Versions
.NET	Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	2.0, 2.1
UWP	10.0

Share via