JsonWebToken.GetHeaderValue<T>(String) Method

Definition

Gets the 'value' corresponding to key from the JWT header transformed as type 'T'.

public T GetHeaderValue<T> (string key);
member this.GetHeaderValue : string -> 'T
Public Function GetHeaderValue(Of T) (key As String) As T

Type Parameters

T

Parameters

key
String

Returns

T

The value as T.

Exceptions

Thrown if claim is not found or a transformation to T cannot be made.

Remarks

The expectation is that the 'value' corresponds to a type are expected in a JWT token. The 5 basic types: number, string, true / false, nil, array (of basic types). This is not a general purpose translation layer for complex types.

Applies to