JsonWebToken.TryGetClaim(String, Claim) Method

Reference

Definition

Namespace:: Microsoft.IdentityModel.JsonWebTokens

Assembly:: Microsoft.IdentityModel.JsonWebTokens.dll

Package:: Microsoft.IdentityModel.JsonWebTokens v7.5.2

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.

Try to get a Claim representing the { key, 'value' } pair corresponding to the provided key. The value is obtained from the Payload.

public bool TryGetClaim (string key, out System.Security.Claims.Claim value);

member this.TryGetClaim : string * Claim -> bool

Public Function TryGetClaim (key As String, ByRef value As Claim) As Boolean

Parameters

key: String

value: Claim

Returns

Boolean

true if successful, false otherwise.

Remarks

A Claim requires each value to be represented as a string. If the value was not a string, then Type contains the json type. JsonClaimValueTypes and ClaimValueTypes to determine the json type.

Applies to

Share via