Class KerberosSupplementalTicket

Namespace

Microsoft.Identity.Client.Kerberos

Assembly

Microsoft.Identity.Client.dll

Class for Kerberos tickets that are included as claims and used as a supplemental token in an OAuth/OIDC protocol response.

public class KerberosSupplementalTicket

Inheritance

object

KerberosSupplementalTicket

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

KerberosSupplementalTicket()

Creates a new instance of KerberosSupplementalTicket class.

public KerberosSupplementalTicket()

KerberosSupplementalTicket(string)

Creates a new instance of KerberosSupplementalTicket class with error message.

public KerberosSupplementalTicket(string errorMessage)

Parameters

errorMessage string

Error message to be set.

Properties

ClientKey

Get or Sets the client key used to encrypt the client portion of the ticket. This is optional. This will be null if KeyType is null. This MUST be protected in the protocol response.

[JsonPropertyName("clientKey")]
public string ClientKey { get; set; }

Property Value

string

ClientName

Get or Sets the client name. Depending on the ticket, this can be either a UserPrincipalName or SamAccountName.

[JsonPropertyName("cn")]
public string ClientName { get; set; }

Property Value

string

ErrorMessage

Get or Sets the error message that server encountered when creating a ticket granting ticket.

[JsonPropertyName("error")]
public string ErrorMessage { get; set; }

Property Value

string

KerberosMessageBuffer

Get or Sets the Base64 encoded KERB_MESSAGE_BUFFER

[JsonPropertyName("messageBuffer")]
public string KerberosMessageBuffer { get; set; }

Property Value

string

KeyType

Get or Sets the client key type.This is optional.This will be null if ClientKey is null.

[JsonPropertyName("keyType")]
public KerberosKeyTypes KeyType { get; set; }

Property Value

KerberosKeyTypes

Realm

Get or Sets the Kerberos realm/domain name.

[JsonPropertyName("realm")]
public string Realm { get; set; }

Property Value

string

ServicePrincipalName

Get or Sets the target service principal name (SPN).

[JsonPropertyName("sn")]
public string ServicePrincipalName { get; set; }

Property Value

string

Methods

ToString()

Creates a string representation of the data captured in the Kerberos supplemental ticket.

public override string ToString()

Returns

string

A string containing the realm, service principal name, client name, and key type.