JsonWebToken.GetHeaderValue<T>(String) Method

Reference

Definition

Namespace:: Microsoft.IdentityModel.JsonWebTokens

Assembly:: Microsoft.IdentityModel.JsonWebTokens.dll

Package:: Microsoft.IdentityModel.JsonWebTokens v8.2.0

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.

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

The value as T.

Exceptions

ArgumentException

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

Share via