JwtHeader Class

The JwtHeader class contains JSON objects that represent the cryptographic operations applied to the JSON Web Token (JWT) and optionally any additional properties of the JWT.

Inheritance Hierarchy

System.Object
  System.Collections.Generic.Dictionary<String, String>
    System.IdentityModel.Tokens.JwtHeader

Namespace:  System.IdentityModel.Tokens
Assembly:  System.IdentityModel.Tokens.Jwt (in System.IdentityModel.Tokens.Jwt.dll)

Syntax

'Declaration
Public Class JwtHeader _
    Inherits Dictionary(Of String, String)

public class JwtHeader : Dictionary<string, string>

public ref class JwtHeader : public Dictionary<String^, String^>

type JwtHeader =  
    class 
        inherit Dictionary<string, string>
    end

public class JwtHeader extends Dictionary<String, String>

The JwtHeader type exposes the following members.

Constructors

	Name	Description
	JwtHeader()	Creates an empty JwtHeader object.
	JwtHeader(SigningCredentials)	Creates a new JwtHeader object with the Header Parameters as follows: { { typ, JWT }, { alg, Mapped(System.IdentityModel.Tokens.SigningCredentials.SignatureAlgorithm) } }

Top

Properties

	Name	Description
	Comparer	Gets the IEqualityComparer<T> that is used to determine equality of keys for the dictionary. (Inherited from Dictionary<String, String>.)
	Count	Gets the number of key/value pairs contained in the Dictionary<TKey, TValue>. (Inherited from Dictionary<String, String>.)
	Item	Gets or sets the value associated with the specified key. (Inherited from Dictionary<String, String>.)
	Keys	Gets a collection containing the keys in the Dictionary<TKey, TValue>. (Inherited from Dictionary<String, String>.)
	SignatureAlgorithm	Gets the signature algorithm that was used to create the signature.
	SigningCredentials	Gets the SigningCredentials passed in the constructor.
	SigningKeyIdentifier	Gets a SecurityKeyIdentifier that contains a SecurityKeyIdentifierClause for each key found.
	Values	Gets a collection containing the values in the Dictionary<TKey, TValue>. (Inherited from Dictionary<String, String>.)

Top

Methods

	Name	Description
	Add	Adds the specified key and value to the dictionary. (Inherited from Dictionary<String, String>.)
	Clear	Removes all keys and values from the Dictionary<TKey, TValue>. (Inherited from Dictionary<String, String>.)
	ContainsKey	Determines whether the Dictionary<TKey, TValue> contains the specified key. (Inherited from Dictionary<String, String>.)
	ContainsValue	Determines whether the Dictionary<TKey, TValue> contains a specific value. (Inherited from Dictionary<String, String>.)
	Encode	Encodes this instance as a [Base64UrlEncoded] string.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetEnumerator	Returns an enumerator that iterates through the Dictionary<TKey, TValue>. (Inherited from Dictionary<String, String>.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetObjectData	Security Critical. Implements the System.Runtime.Serialization.ISerializable interface and returns the data needed to serialize the Dictionary<TKey, TValue> instance. (Inherited from Dictionary<String, String>.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnDeserialization	Implements the System.Runtime.Serialization.ISerializable interface and raises the deserialization event when the deserialization is complete. (Inherited from Dictionary<String, String>.)
	Remove	Removes the value with the specified key from the Dictionary<TKey, TValue>. (Inherited from Dictionary<String, String>.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryGetValue	Gets the value associated with the specified key. (Inherited from Dictionary<String, String>.)

Top

Explicit Interface Implementations

	Name	Description
	ICollection<KeyValuePair<TKey, TValue>>.Add	Adds the specified value to the ICollection<T> with the specified key. (Inherited from Dictionary<String, String>.)
	IDictionary.Add	Adds the specified key and value to the dictionary. (Inherited from Dictionary<String, String>.)
	ICollection<KeyValuePair<TKey, TValue>>.Contains	Determines whether the ICollection<T> contains a specific key and value. (Inherited from Dictionary<String, String>.)
	IDictionary.Contains	Determines whether the IDictionary contains an element with the specified key. (Inherited from Dictionary<String, String>.)
	ICollection<KeyValuePair<TKey, TValue>>.CopyTo	Copies the elements of the ICollection<T> to an array of type KeyValuePair<TKey, TValue>, starting at the specified array index. (Inherited from Dictionary<String, String>.)
	ICollection.CopyTo	Copies the elements of the ICollection<T> to an array, starting at the specified array index. (Inherited from Dictionary<String, String>.)
	IEnumerable<KeyValuePair<TKey, TValue>>.GetEnumerator	Returns an enumerator that iterates through the collection. (Inherited from Dictionary<String, String>.)
	IEnumerable.GetEnumerator	Returns an enumerator that iterates through the collection. (Inherited from Dictionary<String, String>.)
	IDictionary.GetEnumerator	Returns an IDictionaryEnumerator for the IDictionary. (Inherited from Dictionary<String, String>.)
	IDictionary.IsFixedSize	Gets a value indicating whether the IDictionary has a fixed size. (Inherited from Dictionary<String, String>.)
	ICollection<KeyValuePair<TKey, TValue>>.IsReadOnly	Gets a value indicating whether the dictionary is read-only. (Inherited from Dictionary<String, String>.)
	IDictionary.IsReadOnly	Gets a value indicating whether the IDictionary is read-only. (Inherited from Dictionary<String, String>.)
	ICollection.IsSynchronized	Gets a value indicating whether access to the ICollection is synchronized (thread safe). (Inherited from Dictionary<String, String>.)
	IDictionary.Item	Gets or sets the value with the specified key. (Inherited from Dictionary<String, String>.)
	IDictionary<TKey, TValue>.Keys	Gets an ICollection<T> containing the keys of the IDictionary<TKey, TValue>. (Inherited from Dictionary<String, String>.)
	IReadOnlyDictionary<TKey, TValue>.Keys	Gets a collection containing the keys of the IReadOnlyDictionary<TKey, TValue>. (Inherited from Dictionary<String, String>.)
	IDictionary.Keys	Gets an ICollection containing the keys of the IDictionary. (Inherited from Dictionary<String, String>.)
	ICollection<KeyValuePair<TKey, TValue>>.Remove	Removes a key and value from the dictionary. (Inherited from Dictionary<String, String>.)
	IDictionary.Remove	Removes the element with the specified key from the IDictionary. (Inherited from Dictionary<String, String>.)
	ICollection.SyncRoot	Gets an object that can be used to synchronize access to the ICollection. (Inherited from Dictionary<String, String>.)
	IDictionary<TKey, TValue>.Values	Gets an ICollection<T> containing the values in the IDictionary<TKey, TValue>. (Inherited from Dictionary<String, String>.)
	IReadOnlyDictionary<TKey, TValue>.Values	Gets a collection containing the values of the IReadOnlyDictionary<TKey, TValue>. (Inherited from Dictionary<String, String>.)
	IDictionary.Values	Gets an ICollection containing the values in the IDictionary. (Inherited from Dictionary<String, String>.)

Top

Remarks

The member names within the JWT Header are referred to as Header Parameter Names. These names must be unique and the values must be of type String. The corresponding values are referred to as Header Parameter Values.

Thread Safety

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

See Also

Reference

System.IdentityModel.Tokens Namespace