-
Notifications
You must be signed in to change notification settings - Fork 32
/
JsonWebToken.xml
1210 lines (1210 loc) · 65.6 KB
/
JsonWebToken.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<Type Name="JsonWebToken" FullName="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken">
<TypeSignature Language="C#" Value="public class JsonWebToken : Microsoft.IdentityModel.Tokens.SecurityToken" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit JsonWebToken extends Microsoft.IdentityModel.Tokens.SecurityToken" />
<TypeSignature Language="DocId" Value="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" />
<TypeSignature Language="VB.NET" Value="Public Class JsonWebToken
Inherits SecurityToken" />
<TypeSignature Language="F#" Value="type JsonWebToken = class
 inherit SecurityToken" />
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>6.25.0.0</AssemblyVersion>
<AssemblyVersion>6.25.1.0</AssemblyVersion>
<AssemblyVersion>6.27.0.0</AssemblyVersion>
<AssemblyVersion>6.28.1.0</AssemblyVersion>
<AssemblyVersion>6.29.0.0</AssemblyVersion>
<AssemblyVersion>6.30.0.0</AssemblyVersion>
<AssemblyVersion>6.30.1.0</AssemblyVersion>
<AssemblyVersion>6.31.0.0</AssemblyVersion>
<AssemblyVersion>6.32.0.0</AssemblyVersion>
<AssemblyVersion>6.32.1.0</AssemblyVersion>
<AssemblyVersion>6.32.2.0</AssemblyVersion>
<AssemblyVersion>6.32.3.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.2.0</AssemblyVersion>
<AssemblyVersion>7.0.3.0</AssemblyVersion>
<AssemblyVersion>7.2.0.0</AssemblyVersion>
<AssemblyVersion>7.3.1.0</AssemblyVersion>
<AssemblyVersion>7.4.0.0</AssemblyVersion>
<AssemblyVersion>7.4.1.0</AssemblyVersion>
<AssemblyVersion>7.5.0.0</AssemblyVersion>
<AssemblyVersion>7.5.1.0</AssemblyVersion>
<AssemblyVersion>7.5.2.0</AssemblyVersion>
<AssemblyVersion>7.6.0.0</AssemblyVersion>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
<AssemblyVersion>7.6.3.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.1.0</AssemblyVersion>
<AssemblyVersion>8.0.2.0</AssemblyVersion>
<AssemblyVersion>8.1.0.0</AssemblyVersion>
<AssemblyVersion>8.1.1.0</AssemblyVersion>
<AssemblyVersion>8.1.2.0</AssemblyVersion>
<AssemblyVersion>8.2.0.0</AssemblyVersion>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.IdentityModel.Tokens.SecurityToken</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
A <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken" /> designed for representing a JSON Web Token (JWT).
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public JsonWebToken (ReadOnlyMemory<char> encodedTokenMemory);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.ReadOnlyMemory`1<char> encodedTokenMemory) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.ReadOnlyMemory{System.Char})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (encodedTokenMemory As ReadOnlyMemory(Of Char))" />
<MemberSignature Language="F#" Value="new Microsoft.IdentityModel.JsonWebTokens.JsonWebToken : ReadOnlyMemory<char> -> Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" Usage="new Microsoft.IdentityModel.JsonWebTokens.JsonWebToken encodedTokenMemory" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="encodedTokenMemory" Type="System.ReadOnlyMemory<System.Char>" />
</Parameters>
<Docs>
<param name="encodedTokenMemory">A ReadOnlyMemory{char} containing the JSON Web Token serialized in JWS or JWE Compact format.</param>
<summary>
Initializes a new instance of <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" /> from a ReadOnlyMemory{char} in JWS or JWE Compact serialized format.
</summary>
<remarks>
See: <see href="https://datatracker.ietf.org/doc/html/rfc7519" /> (JWT).
See: <see href="https://datatracker.ietf.org/doc/html/rfc7515" /> (JWS).
See: <see href="https://datatracker.ietf.org/doc/html/rfc7516" /> (JWE).
<para>
The contents of the returned <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" /> have not been validated; the JSON Web Token is simply decoded. Validation can be performed using the methods in <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler" />.
</para></remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="encodedTokenMemory" /> is empty.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="encodedTokenMemory" /> does not represent a valid JWS or JWE Compact Serialization format.</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public JsonWebToken (string jwtEncodedString);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string jwtEncodedString) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (jwtEncodedString As String)" />
<MemberSignature Language="F#" Value="new Microsoft.IdentityModel.JsonWebTokens.JsonWebToken : string -> Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" Usage="new Microsoft.IdentityModel.JsonWebTokens.JsonWebToken jwtEncodedString" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="jwtEncodedString" Type="System.String" />
</Parameters>
<Docs>
<param name="jwtEncodedString">A JSON Web Token that has been serialized in JWS or JWE Compact serialized format.</param>
<summary>
Initializes a new instance of <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" /> from a string in JWS or JWE Compact serialized format.
</summary>
<remarks>
See: <see href="https://datatracker.ietf.org/doc/html/rfc7519" /> (JWT).
See: <see href="https://datatracker.ietf.org/doc/html/rfc7515" /> (JWS).
See: <see href="https://datatracker.ietf.org/doc/html/rfc7516" /> (JWE).
<para>
The contents of the returned <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" /> have not been validated, the JSON Web Token is simply decoded. Validation can be accomplished using the validation methods in <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler" /></para></remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="jwtEncodedString" /> is null or empty.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="jwtEncodedString" /> is not in JWS or JWE Compact Serialization format.</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public JsonWebToken (string header, string payload);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string header, string payload) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (header As String, payload As String)" />
<MemberSignature Language="F#" Value="new Microsoft.IdentityModel.JsonWebTokens.JsonWebToken : string * string -> Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" Usage="new Microsoft.IdentityModel.JsonWebTokens.JsonWebToken (header, payload)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="header" Type="System.String" />
<Parameter Name="payload" Type="System.String" />
</Parameters>
<Docs>
<param name="header">A string containing JSON which represents the cryptographic operations applied to the JWT and optionally any additional properties of the JWT.</param>
<param name="payload">A string containing JSON which represents the claims contained in the JWT. Each claim is a JSON object of the form { Name, Value }. Can be the empty.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" /> class where the header contains the crypto algorithms applied to the encoded header and payload.
</summary>
<remarks>
See: <see href="https://datatracker.ietf.org/doc/html/rfc7519" /> (JWT).
See: <see href="https://datatracker.ietf.org/doc/html/rfc7515" /> (JWS).
See: <see href="https://datatracker.ietf.org/doc/html/rfc7516" /> (JWE).
<para>
The contents of the returned <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" /> have not been validated, the JSON Web Token is simply decoded. Validation can be accomplished using the validation methods in <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler" /></para></remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="payload" /> is null.</exception>
</Docs>
</Member>
<Member MemberName="Actor">
<MemberSignature Language="C#" Value="public string Actor { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Actor" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Actor" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Actor As String" />
<MemberSignature Language="F#" Value="member this.Actor : string" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Actor" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the 'value' of the 'actort' claim the payload.
</summary>
<value>To be added.</value>
<remarks>
If the 'actort' claim is not found, an empty string is returned.
</remarks>
</Docs>
</Member>
<Member MemberName="Alg">
<MemberSignature Language="C#" Value="public string Alg { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Alg" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Alg" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Alg As String" />
<MemberSignature Language="F#" Value="member this.Alg : string" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Alg" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the 'value' of the 'alg' claim from the header.
</summary>
<value>To be added.</value>
<remarks>
Identifies the cryptographic algorithm used to encrypt or determine the value of the Content Encryption Key.
Applicable to an encrypted JWT (JWE).
See: <see href="https://datatracker.ietf.org/doc/html/rfc7516#section-4-1-1" />.
<para>
If the 'alg' claim is not found, an empty string is returned.
</para></remarks>
</Docs>
</Member>
<Member MemberName="Audiences">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<string> Audiences { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1<string> Audiences" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Audiences" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Audiences As IEnumerable(Of String)" />
<MemberSignature Language="F#" Value="member this.Audiences : seq<string>" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Audiences" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the list of 'aud' claims from the payload.
</summary>
<value>To be added.</value>
<remarks>
Identifies the recipients that the JWT is intended for.
See: <see href="https://datatracker.ietf.org/doc/html/rfc7519#section-4-1-3" />.
<para>
If the 'aud' claim is not found, enumeration will be empty.
</para></remarks>
</Docs>
</Member>
<Member MemberName="AuthenticationTag">
<MemberSignature Language="C#" Value="public string AuthenticationTag { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string AuthenticationTag" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.AuthenticationTag" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property AuthenticationTag As String" />
<MemberSignature Language="F#" Value="member this.AuthenticationTag : string" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.AuthenticationTag" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the AuthenticationTag from the original raw data of this instance when it was created.
</summary>
<value>To be added.</value>
<remarks>
Contains the results of a Authentication Encryption with Associated Data (AEAD).
See: <see href="https://datatracker.ietf.org/doc/html/rfc7516#section-2" />.
<para>
If this JWT is not encrypted with an algorithms that uses an Authentication Tag, an empty string will be returned.
</para></remarks>
</Docs>
</Member>
<Member MemberName="Azp">
<MemberSignature Language="C#" Value="public string Azp { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Azp" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Azp" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Azp As String" />
<MemberSignature Language="F#" Value="member this.Azp : string" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Azp" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the 'azp' claim from the payload.
</summary>
<value>To be added.</value>
<remarks>
Identifies the authorized party for the id_token.
See: <see href="https://openid.net/specs/openid-connect-core-1_0.html" />.
<para>
If the 'azp' claim is not found, an empty string is returned.
</para></remarks>
</Docs>
</Member>
<Member MemberName="Ciphertext">
<MemberSignature Language="C#" Value="public string Ciphertext { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Ciphertext" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Ciphertext" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Ciphertext As String" />
<MemberSignature Language="F#" Value="member this.Ciphertext : string" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Ciphertext" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the Ciphertext representing the encrypted JWT in the original raw data.
</summary>
<value>To be added.</value>
<remarks>
When decrypted using values in the JWE header will contain the plaintext payload.
See: <see href="https://datatracker.ietf.org/doc/html/rfc7516#section-2" />.
<para>
If this JWT is not encrypted, an empty string will be returned.
</para></remarks>
</Docs>
</Member>
<Member MemberName="Claims">
<MemberSignature Language="C#" Value="public virtual System.Collections.Generic.IEnumerable<System.Security.Claims.Claim> Claims { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1<class System.Security.Claims.Claim> Claims" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Claims" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property Claims As IEnumerable(Of Claim)" />
<MemberSignature Language="F#" Value="member this.Claims : seq<System.Security.Claims.Claim>" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Claims" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable<System.Security.Claims.Claim></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets a <see cref="T:System.Collections.Generic.IEnumerable`1" /> where each claim in the JWT { name, value } is returned as a <see cref="T:System.Security.Claims.Claim" />.
</summary>
<value>To be added.</value>
<remarks>
A <see cref="T:System.Security.Claims.Claim" /> requires each value to be represented as a string. If the value was not a string, then <see cref="P:System.Security.Claims.Claim.Type" /> contains the json type.
<see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonClaimValueTypes" /> and <see cref="T:System.Security.Claims.ClaimValueTypes" /> to determine the json type.
</remarks>
</Docs>
</Member>
<Member MemberName="Cty">
<MemberSignature Language="C#" Value="public string Cty { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Cty" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Cty" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Cty As String" />
<MemberSignature Language="F#" Value="member this.Cty : string" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Cty" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the 'value' of the 'cty' claim from the header.
</summary>
<value>To be added.</value>
<remarks>
Used by JWS applications to declare the media type[IANA.MediaTypes] of the secured content (the payload).
See: <see href="https://datatracker.ietf.org/doc/html/rfc7516#section-4.1.12" /> (JWE).
See: <see href="https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.10" /> (JWS).
<para>
If the 'cty' claim is not found, an empty string is returned.
</para></remarks>
</Docs>
</Member>
<Member MemberName="Enc">
<MemberSignature Language="C#" Value="public string Enc { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Enc" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Enc" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Enc As String" />
<MemberSignature Language="F#" Value="member this.Enc : string" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Enc" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the 'value' of the 'enc' claim from the header.
</summary>
<value>To be added.</value>
<remarks>
Identifies the content encryption algorithm used to perform authenticated encryption
on the plaintext to produce the ciphertext and the Authentication Tag.
See: <see href="https://datatracker.ietf.org/doc/html/rfc7516#section-4.1.2" />.
</remarks>
</Docs>
</Member>
<Member MemberName="EncodedHeader">
<MemberSignature Language="C#" Value="public string EncodedHeader { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string EncodedHeader" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.EncodedHeader" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property EncodedHeader As String" />
<MemberSignature Language="F#" Value="member this.EncodedHeader : string" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.EncodedHeader" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the EncodedHeader from the original raw data of this instance when it was created.
</summary>
<value>To be added.</value>
<remarks>
The original Base64UrlEncoded string of the JWT header.
</remarks>
</Docs>
</Member>
<Member MemberName="EncodedPayload">
<MemberSignature Language="C#" Value="public string EncodedPayload { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string EncodedPayload" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.EncodedPayload" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property EncodedPayload As String" />
<MemberSignature Language="F#" Value="member this.EncodedPayload : string" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.EncodedPayload" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the EncodedPayload from the original raw data of this instance when it was created.
</summary>
<value>To be added.</value>
<remarks>
The original Base64UrlEncoded of the JWT payload, for JWE this will an empty string.
</remarks>
</Docs>
</Member>
<Member MemberName="EncodedSignature">
<MemberSignature Language="C#" Value="public string EncodedSignature { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string EncodedSignature" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.EncodedSignature" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property EncodedSignature As String" />
<MemberSignature Language="F#" Value="member this.EncodedSignature : string" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.EncodedSignature" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the EncodedSignature from the original raw data of this instance when it was created.
</summary>
<value>To be added.</value>
<remarks>
The original Base64UrlEncoded of the JWT signature.
If the JWT was not signed or a JWE, an empty string is returned.
</remarks>
</Docs>
</Member>
<Member MemberName="EncodedToken">
<MemberSignature Language="C#" Value="public string EncodedToken { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string EncodedToken" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.EncodedToken" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property EncodedToken As String" />
<MemberSignature Language="F#" Value="member this.EncodedToken : string" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.EncodedToken" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the original raw data of this instance when it was created.
</summary>
<value>To be added.</value>
<remarks>
The original Base64UrlEncoded of the JWT.
</remarks>
</Docs>
</Member>
<Member MemberName="EncryptedKey">
<MemberSignature Language="C#" Value="public string EncryptedKey { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string EncryptedKey" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.EncryptedKey" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property EncryptedKey As String" />
<MemberSignature Language="F#" Value="member this.EncryptedKey : string" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.EncryptedKey" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the Encrypted Content Encryption Key.
</summary>
<value>To be added.</value>
<remarks>
For some algorithms this value may be null even though the JWT was encrypted.
See: <see href="https://datatracker.ietf.org/doc/html/rfc7516#section-2" />.
<para>
If not found, an empty string is returned.
</para></remarks>
</Docs>
</Member>
<Member MemberName="GetClaim">
<MemberSignature Language="C#" Value="public System.Security.Claims.Claim GetClaim (string key);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Security.Claims.Claim GetClaim(string key) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.GetClaim(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function GetClaim (key As String) As Claim" />
<MemberSignature Language="F#" Value="member this.GetClaim : string -> System.Security.Claims.Claim" Usage="jsonWebToken.GetClaim key" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Security.Claims.Claim</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="System.String" />
</Parameters>
<Docs>
<param name="key">To be added.</param>
<summary>
Gets a <see cref="T:System.Security.Claims.Claim" /> representing the { key, 'value' } pair corresponding to the provided <paramref name="key" />.
</summary>
<returns>To be added.</returns>
<remarks>
A <see cref="T:System.Security.Claims.Claim" /> requires each value to be represented as a string. If the value was not a string, then <see cref="P:System.Security.Claims.Claim.Type" /> contains the json type.
<see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonClaimValueTypes" /> and <see cref="T:System.Security.Claims.ClaimValueTypes" /> to determine the json type.
<para>
If the key has no corresponding value, this method will throw.
</para></remarks>
</Docs>
</Member>
<Member MemberName="GetHeaderValue<T>">
<MemberSignature Language="C#" Value="public T GetHeaderValue<T> (string key);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance !!T GetHeaderValue<T>(string key) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.GetHeaderValue``1(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function GetHeaderValue(Of T) (key As String) As T" />
<MemberSignature Language="F#" Value="member this.GetHeaderValue : string -> 'T" Usage="jsonWebToken.GetHeaderValue key" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="key" Type="System.String" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="key">To be added.</param>
<summary>
Gets the 'value' corresponding to key from the JWT header transformed as type 'T'.
</summary>
<returns>The value as <typeparamref name="T" />.</returns>
<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.
</remarks>
<exception cref="T:System.ArgumentException">Thrown if claim is not found or a transformation to <typeparamref name="T" /> cannot be made.</exception>
</Docs>
</Member>
<Member MemberName="GetPayloadValue<T>">
<MemberSignature Language="C#" Value="public T GetPayloadValue<T> (string key);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance !!T GetPayloadValue<T>(string key) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.GetPayloadValue``1(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function GetPayloadValue(Of T) (key As String) As T" />
<MemberSignature Language="F#" Value="member this.GetPayloadValue : string -> 'T" Usage="jsonWebToken.GetPayloadValue key" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="key" Type="System.String" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="key">To be added.</param>
<summary>
Gets the 'value' corresponding to key from the JWT payload transformed as type 'T'.
</summary>
<returns>The value as <typeparamref name="T" />.</returns>
<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.
</remarks>
<exception cref="T:System.ArgumentException">Thrown if claim is not found or a transformation to <typeparamref name="T" /> cannot be made.</exception>
</Docs>
</Member>
<Member MemberName="Id">
<MemberSignature Language="C#" Value="public override string Id { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Id" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Id" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property Id As String" />
<MemberSignature Language="F#" Value="member this.Id : string" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Id" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the 'value' of the 'jti' claim from the payload.
</summary>
<value>To be added.</value>
<remarks>
Provides a unique identifier for the JWT.
See: <see href="https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.7" />.
<para>
If the 'jti' claim is not found, an empty string is returned.
</para></remarks>
</Docs>
</Member>
<Member MemberName="InitializationVector">
<MemberSignature Language="C#" Value="public string InitializationVector { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string InitializationVector" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.InitializationVector" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property InitializationVector As String" />
<MemberSignature Language="F#" Value="member this.InitializationVector : string" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.InitializationVector" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the Initialization Vector used when encrypting the plaintext.
</summary>
<value>To be added.</value>
<remarks>
See: <see href="https://datatracker.ietf.org/doc/html/rfc7516#appendix-A-1-4" />.
<para>
Some algorithms may not use an Initialization Vector.
If not found an empty string is returned.
</para></remarks>
</Docs>
</Member>
<Member MemberName="InnerToken">
<MemberSignature Language="C#" Value="public Microsoft.IdentityModel.JsonWebTokens.JsonWebToken InnerToken { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.IdentityModel.JsonWebTokens.JsonWebToken InnerToken" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.InnerToken" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property InnerToken As JsonWebToken" />
<MemberSignature Language="F#" Value="member this.InnerToken : Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.InnerToken" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.IdentityModel.JsonWebTokens.JsonWebToken</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" /> associated with this instance.
</summary>
<value>To be added.</value>
<remarks>
See: <see href="https://datatracker.ietf.org/doc/html/rfc7516#section-2" />.
For encrypted tokens (JWE), this represents the JWT that was encrypted.
<para>
If the JWT is not encrypted, this value will be null.
</para></remarks>
</Docs>
</Member>
<Member MemberName="IsEncrypted">
<MemberSignature Language="C#" Value="public bool IsEncrypted { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsEncrypted" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.IsEncrypted" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsEncrypted As Boolean" />
<MemberSignature Language="F#" Value="member this.IsEncrypted : bool" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.IsEncrypted" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Returns <see langword="true" /> if this JsonWebToken was encrypted a JWE.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsSigned">
<MemberSignature Language="C#" Value="public bool IsSigned { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsSigned" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.IsSigned" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsSigned As Boolean" />
<MemberSignature Language="F#" Value="member this.IsSigned : bool" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.IsSigned" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Returns <see langword="true" /> if this JsonWebToken was signed a JWS.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IssuedAt">
<MemberSignature Language="C#" Value="public DateTime IssuedAt { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime IssuedAt" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.IssuedAt" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IssuedAt As DateTime" />
<MemberSignature Language="F#" Value="member this.IssuedAt : DateTime" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.IssuedAt" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the 'value' of the 'iat' claim converted to a <see cref="T:System.DateTime" /> from the payload.
</summary>
<value>To be added.</value>
<remarks>
Identifies the time at which the JWT was issued.
See: <see href="https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.6" />.
<para>
If the 'iat' claim is not found, then <see cref="F:System.DateTime.MinValue" /> is returned.
</para></remarks>
</Docs>
</Member>
<Member MemberName="Issuer">
<MemberSignature Language="C#" Value="public override string Issuer { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Issuer" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Issuer" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property Issuer As String" />
<MemberSignature Language="F#" Value="member this.Issuer : string" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Issuer" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the 'value' of the 'iss' claim from the payload.
</summary>
<value>To be added.</value>
<remarks>
Identifies the principal that issued the JWT.
See: <see href="https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.1" />.
<para>
If the 'iss' claim is not found, an empty string is returned.
</para></remarks>
</Docs>
</Member>
<Member MemberName="Kid">
<MemberSignature Language="C#" Value="public string Kid { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Kid" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Kid" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Kid As String" />
<MemberSignature Language="F#" Value="member this.Kid : string" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Kid" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the 'value' of the 'kid' claim from the header.
</summary>
<value>To be added.</value>
<remarks>
'kid'is a hint indicating which key was used to secure the JWS.
See: <see href="https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.4" /> (JWS).
See: <see href="https://datatracker.ietf.org/doc/html/rfc7516#section-4.1.6" /> (JWE).
<para>
If the 'kid' claim is not found, an empty string is returned.
</para></remarks>
</Docs>
</Member>
<Member MemberName="SecurityKey">
<MemberSignature Language="C#" Value="public override Microsoft.IdentityModel.Tokens.SecurityKey SecurityKey { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.IdentityModel.Tokens.SecurityKey SecurityKey" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.SecurityKey" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property SecurityKey As SecurityKey" />
<MemberSignature Language="F#" Value="member this.SecurityKey : Microsoft.IdentityModel.Tokens.SecurityKey" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.SecurityKey" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.IdentityModel.Tokens.SecurityKey</ReturnType>
</ReturnValue>
<Docs>
<summary>
Not implemented.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SigningKey">
<MemberSignature Language="C#" Value="public override Microsoft.IdentityModel.Tokens.SecurityKey SigningKey { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.IdentityModel.Tokens.SecurityKey SigningKey" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.SigningKey" />
<MemberSignature Language="VB.NET" Value="Public Overrides Property SigningKey As SecurityKey" />
<MemberSignature Language="F#" Value="member this.SigningKey : Microsoft.IdentityModel.Tokens.SecurityKey with get, set" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.SigningKey" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.IdentityModel.Tokens.SecurityKey</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the <see cref="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.SecurityKey" /> that was used to sign this token.
</summary>
<value>To be added.</value>
<remarks>
If the JWT was not signed or validated, this value will be null.
</remarks>
</Docs>
</Member>
<Member MemberName="Subject">
<MemberSignature Language="C#" Value="public string Subject { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Subject" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Subject" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Subject As String" />
<MemberSignature Language="F#" Value="member this.Subject : string" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Subject" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the 'value' of the 'sub' claim from the payload.
</summary>
<value>To be added.</value>
<remarks>
See: <see href="https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.2" />.
Identifies the principal that is the subject of the JWT.
<para>
If the 'sub' claim is not found, an empty string is returned.
</para></remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="jsonWebToken.ToString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Returns the encoded token without signature or authentication tag.
</summary>
<returns>Encoded token string without signature or authentication tag.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TryGetClaim">
<MemberSignature Language="C#" Value="public bool TryGetClaim (string key, out System.Security.Claims.Claim value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryGetClaim(string key, [out] class System.Security.Claims.Claim& value) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.TryGetClaim(System.String,System.Security.Claims.Claim@)" />
<MemberSignature Language="VB.NET" Value="Public Function TryGetClaim (key As String, ByRef value As Claim) As Boolean" />
<MemberSignature Language="F#" Value="member this.TryGetClaim : string * Claim -> bool" Usage="jsonWebToken.TryGetClaim (key, value)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="System.String" />
<Parameter Name="value" Type="System.Security.Claims.Claim" RefType="out" />
</Parameters>
<Docs>
<param name="key">To be added.</param>
<param name="value">To be added.</param>
<summary>
Try to get a <see cref="T:System.Security.Claims.Claim" /> representing the { key, 'value' } pair corresponding to the provided <paramref name="key" />.
The value is obtained from the Payload.
</summary>
<returns>true if successful, false otherwise.</returns>
<remarks>
A <see cref="T:System.Security.Claims.Claim" /> requires each value to be represented as a string. If the value was not a string, then <see cref="P:System.Security.Claims.Claim.Type" /> contains the json type.
<see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonClaimValueTypes" /> and <see cref="T:System.Security.Claims.ClaimValueTypes" /> to determine the json type.
</remarks>
</Docs>
</Member>
<Member MemberName="TryGetHeaderValue<T>">
<MemberSignature Language="C#" Value="public bool TryGetHeaderValue<T> (string key, out T value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryGetHeaderValue<T>(string key, [out] !!T& value) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.TryGetHeaderValue``1(System.String,``0@)" />
<MemberSignature Language="VB.NET" Value="Public Function TryGetHeaderValue(Of T) (key As String, ByRef value As T) As Boolean" />
<MemberSignature Language="F#" Value="member this.TryGetHeaderValue : string * 'T -> bool" Usage="jsonWebToken.TryGetHeaderValue (key, value)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="key" Type="System.String" />
<Parameter Name="value" Type="T" RefType="out" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="key">To be added.</param>
<param name="value">To be added.</param>
<summary>
Tries to get the value corresponding to the provided key from the JWT header { key, 'value' }.
</summary>
<returns>
<see langword="true" /> if successful, false otherwise.</returns>
<remarks>
The expectation is that the 'value' corresponds to a type 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.
</remarks>
</Docs>
</Member>
<Member MemberName="TryGetPayloadValue<T>">
<MemberSignature Language="C#" Value="public bool TryGetPayloadValue<T> (string key, out T value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryGetPayloadValue<T>(string key, [out] !!T& value) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.TryGetPayloadValue``1(System.String,``0@)" />
<MemberSignature Language="VB.NET" Value="Public Function TryGetPayloadValue(Of T) (key As String, ByRef value As T) As Boolean" />
<MemberSignature Language="F#" Value="member this.TryGetPayloadValue : string * 'T -> bool" Usage="jsonWebToken.TryGetPayloadValue (key, value)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.3.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="key" Type="System.String" />
<Parameter Name="value" Type="T" RefType="out" />
</Parameters>