-
Notifications
You must be signed in to change notification settings - Fork 32
/
JsonWebTokenHandler.xml
1115 lines (1115 loc) Β· 95.9 KB
/
JsonWebTokenHandler.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="JsonWebTokenHandler" FullName="Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler">
<TypeSignature Language="C#" Value="public class JsonWebTokenHandler : Microsoft.IdentityModel.Tokens.TokenHandler" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit JsonWebTokenHandler extends Microsoft.IdentityModel.Tokens.TokenHandler" />
<TypeSignature Language="DocId" Value="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler" />
<TypeSignature Language="VB.NET" Value="Public Class JsonWebTokenHandler
Inherits TokenHandler" />
<TypeSignature Language="F#" Value="type JsonWebTokenHandler = class
 inherit TokenHandler" />
<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>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.IdentityModel.Tokens.TokenHandler</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
A <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenHandler" /> designed for creating and validating Json Web Tokens.
See: https://datatracker.ietf.org/doc/html/rfc7519 and http://www.rfc-editor.org/info/rfc7515.
</summary>
<remarks>This partial class is focused on TokenCreation.</remarks>
<remarks>This partial class contains methods and logic related to the validation of tokens.</remarks>
<remarks>This partial class contains methods and logic related to the validation of tokens' signatures.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public JsonWebTokenHandler ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Base64UrlEncodedUnsignedJWSHeader">
<MemberSignature Language="C#" Value="public const string Base64UrlEncodedUnsignedJWSHeader;" />
<MemberSignature Language="ILAsm" Value=".field public static literal string Base64UrlEncodedUnsignedJWSHeader" />
<MemberSignature Language="DocId" Value="F:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.Base64UrlEncodedUnsignedJWSHeader" />
<MemberSignature Language="VB.NET" Value="Public Const Base64UrlEncodedUnsignedJWSHeader As String " />
<MemberSignature Language="F#" Value="val mutable Base64UrlEncodedUnsignedJWSHeader : string" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.Base64UrlEncodedUnsignedJWSHeader" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the Base64Url encoded string representation of the following JWT header:
{ <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Alg" />, <see cref="F:Microsoft.IdentityModel.Tokens.SecurityAlgorithms.None" /> }.
</summary>
<remarks>To be added.</remarks>
<return>The Base64Url encoded string representation of the unsigned JWT header.</return>
</Docs>
</Member>
<Member MemberName="CanReadToken">
<MemberSignature Language="C#" Value="public virtual bool CanReadToken (string token);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool CanReadToken(string token) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CanReadToken(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CanReadToken (token As String) As Boolean" />
<MemberSignature Language="F#" Value="abstract member CanReadToken : string -> bool
override this.CanReadToken : string -> bool" Usage="jsonWebTokenHandler.CanReadToken token" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="token" Type="System.String" />
</Parameters>
<Docs>
<param name="token">String that should represent a valid JWT.</param>
<summary>
Determines if the string is a well formed JSON Web Token (JWT). See: <see href="https://datatracker.ietf.org/doc/html/rfc7519" />.
</summary>
<returns>
<para>
<see langword="false" /> if the token is null or whitespace.</para>
<para>
<see langword="false" /> if token.Length is greater than <see cref="P:Microsoft.IdentityModel.Tokens.TokenHandler.MaximumTokenSizeInBytes" />.</para>
<para>
<see langword="true" /> if the token is in JSON Compact Serialization format.</para>
</returns>
<remarks>Uses <see cref="M:System.Text.RegularExpressions.Regex.IsMatch(System.String,System.String)" /> matching:
<para>JWS: @"^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]*$"</para><para>JWE: (dir): @"^[A-Za-z0-9-_]+\.\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]*$"</para><para>JWE: (wrappedkey): @"^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]$"</para></remarks>
</Docs>
</Member>
<Member MemberName="CanValidateToken">
<MemberSignature Language="C#" Value="public virtual bool CanValidateToken { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool CanValidateToken" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CanValidateToken" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property CanValidateToken As Boolean" />
<MemberSignature Language="F#" Value="member this.CanValidateToken : bool" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CanValidateToken" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Returns a value that indicates if this handler can validate a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken" />.
</summary>
<value>
<see langword="true" /> if this instance can validate a <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateClaimsIdentity">
<MemberSignature Language="C#" Value="protected virtual System.Security.Claims.ClaimsIdentity CreateClaimsIdentity (Microsoft.IdentityModel.JsonWebTokens.JsonWebToken jwtToken, Microsoft.IdentityModel.Tokens.TokenValidationParameters validationParameters);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.Security.Claims.ClaimsIdentity CreateClaimsIdentity(class Microsoft.IdentityModel.JsonWebTokens.JsonWebToken jwtToken, class Microsoft.IdentityModel.Tokens.TokenValidationParameters validationParameters) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateClaimsIdentity(Microsoft.IdentityModel.JsonWebTokens.JsonWebToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Function CreateClaimsIdentity (jwtToken As JsonWebToken, validationParameters As TokenValidationParameters) As ClaimsIdentity" />
<MemberSignature Language="F#" Value="abstract member CreateClaimsIdentity : Microsoft.IdentityModel.JsonWebTokens.JsonWebToken * Microsoft.IdentityModel.Tokens.TokenValidationParameters -> System.Security.Claims.ClaimsIdentity
override this.CreateClaimsIdentity : Microsoft.IdentityModel.JsonWebTokens.JsonWebToken * Microsoft.IdentityModel.Tokens.TokenValidationParameters -> System.Security.Claims.ClaimsIdentity" Usage="jsonWebTokenHandler.CreateClaimsIdentity (jwtToken, validationParameters)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Security.Claims.ClaimsIdentity</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="jwtToken" Type="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" />
<Parameter Name="validationParameters" Type="Microsoft.IdentityModel.Tokens.TokenValidationParameters" />
</Parameters>
<Docs>
<param name="jwtToken">The <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" /> to use as a <see cref="T:System.Security.Claims.Claim" /> source.</param>
<param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters" /> to be used for validating the token.</param>
<summary>
Creates a <see cref="T:System.Security.Claims.ClaimsIdentity" /> from a <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" />.
</summary>
<returns>A <see cref="T:System.Security.Claims.ClaimsIdentity" /> containing the <see cref="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Claims" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateClaimsIdentity">
<MemberSignature Language="C#" Value="protected virtual System.Security.Claims.ClaimsIdentity CreateClaimsIdentity (Microsoft.IdentityModel.JsonWebTokens.JsonWebToken jwtToken, Microsoft.IdentityModel.Tokens.TokenValidationParameters validationParameters, string issuer);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.Security.Claims.ClaimsIdentity CreateClaimsIdentity(class Microsoft.IdentityModel.JsonWebTokens.JsonWebToken jwtToken, class Microsoft.IdentityModel.Tokens.TokenValidationParameters validationParameters, string issuer) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateClaimsIdentity(Microsoft.IdentityModel.JsonWebTokens.JsonWebToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters,System.String)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Function CreateClaimsIdentity (jwtToken As JsonWebToken, validationParameters As TokenValidationParameters, issuer As String) As ClaimsIdentity" />
<MemberSignature Language="F#" Value="abstract member CreateClaimsIdentity : Microsoft.IdentityModel.JsonWebTokens.JsonWebToken * Microsoft.IdentityModel.Tokens.TokenValidationParameters * string -> System.Security.Claims.ClaimsIdentity
override this.CreateClaimsIdentity : Microsoft.IdentityModel.JsonWebTokens.JsonWebToken * Microsoft.IdentityModel.Tokens.TokenValidationParameters * string -> System.Security.Claims.ClaimsIdentity" Usage="jsonWebTokenHandler.CreateClaimsIdentity (jwtToken, validationParameters, issuer)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Security.Claims.ClaimsIdentity</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="jwtToken" Type="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" />
<Parameter Name="validationParameters" Type="Microsoft.IdentityModel.Tokens.TokenValidationParameters" />
<Parameter Name="issuer" Type="System.String" />
</Parameters>
<Docs>
<param name="jwtToken">The <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" /> to use as a <see cref="T:System.Security.Claims.Claim" /> source.</param>
<param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters" /> to be used for validating the token.</param>
<param name="issuer">Specifies the issuer for the <see cref="T:System.Security.Claims.ClaimsIdentity" />.</param>
<summary>
Creates a <see cref="T:System.Security.Claims.ClaimsIdentity" /> from a <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" /> with the specified issuer.
</summary>
<returns>A <see cref="T:System.Security.Claims.ClaimsIdentity" /> containing the <see cref="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Claims" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateToken">
<MemberSignature Language="C#" Value="public virtual string CreateToken (Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor tokenDescriptor);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string CreateToken(class Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor tokenDescriptor) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateToken (tokenDescriptor As SecurityTokenDescriptor) As String" />
<MemberSignature Language="F#" Value="abstract member CreateToken : Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor -> string
override this.CreateToken : Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor -> string" Usage="jsonWebTokenHandler.CreateToken tokenDescriptor" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="tokenDescriptor" Type="Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor" />
</Parameters>
<Docs>
<param name="tokenDescriptor">A <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor" /> that contains details of contents of the token.</param>
<summary>
Creates a JWT that can be a JWS or JWE.
</summary>
<returns>A JWT in Compact Serialization format.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateToken">
<MemberSignature Language="C#" Value="public virtual string CreateToken (string payload);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string CreateToken(string payload) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateToken (payload As String) As String" />
<MemberSignature Language="F#" Value="abstract member CreateToken : string -> string
override this.CreateToken : string -> string" Usage="jsonWebTokenHandler.CreateToken payload" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="payload" Type="System.String" />
</Parameters>
<Docs>
<param name="payload">A string containing JSON which represents the JWT token payload.</param>
<summary>
Creates an unsigned JSON Web Signature (JWS).
</summary>
<returns>A JWS in Compact Serialization format.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="payload" /> is null.</exception>
</Docs>
</Member>
<Member MemberName="CreateToken">
<MemberSignature Language="C#" Value="public virtual string CreateToken (string payload, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string CreateToken(string payload, class Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.EncryptingCredentials)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateToken (payload As String, encryptingCredentials As EncryptingCredentials) As String" />
<MemberSignature Language="F#" Value="abstract member CreateToken : string * Microsoft.IdentityModel.Tokens.EncryptingCredentials -> string
override this.CreateToken : string * Microsoft.IdentityModel.Tokens.EncryptingCredentials -> string" Usage="jsonWebTokenHandler.CreateToken (payload, encryptingCredentials)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="payload" Type="System.String" />
<Parameter Name="encryptingCredentials" Type="Microsoft.IdentityModel.Tokens.EncryptingCredentials" />
</Parameters>
<Docs>
<param name="payload">A string containing JSON which represents the JWT token payload.</param>
<param name="encryptingCredentials">Defines the security key and algorithm that will be used to encrypt the JWT.</param>
<summary>
Creates a JSON Web Encryption (JWE).
</summary>
<returns>A JWE in Compact Serialization format.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateToken">
<MemberSignature Language="C#" Value="public virtual string CreateToken (string payload, Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string CreateToken(string payload, class Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.SigningCredentials)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateToken (payload As String, signingCredentials As SigningCredentials) As String" />
<MemberSignature Language="F#" Value="abstract member CreateToken : string * Microsoft.IdentityModel.Tokens.SigningCredentials -> string
override this.CreateToken : string * Microsoft.IdentityModel.Tokens.SigningCredentials -> string" Usage="jsonWebTokenHandler.CreateToken (payload, signingCredentials)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="payload" Type="System.String" />
<Parameter Name="signingCredentials" Type="Microsoft.IdentityModel.Tokens.SigningCredentials" />
</Parameters>
<Docs>
<param name="payload">A string containing JSON which represents the JWT token payload.</param>
<param name="signingCredentials">Defines the security key and algorithm that will be used to sign the JWS.</param>
<summary>
Creates a JSON Web Signature (JWS).
</summary>
<returns>A JWS in Compact Serialization format.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="signingCredentials" /> is null.</exception>
</Docs>
</Member>
<Member MemberName="CreateToken">
<MemberSignature Language="C#" Value="public virtual string CreateToken (string payload, System.Collections.Generic.IDictionary<string,object> additionalHeaderClaims);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string CreateToken(string payload, class System.Collections.Generic.IDictionary`2<string, object> additionalHeaderClaims) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,System.Collections.Generic.IDictionary{System.String,System.Object})" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateToken (payload As String, additionalHeaderClaims As IDictionary(Of String, Object)) As String" />
<MemberSignature Language="F#" Value="abstract member CreateToken : string * System.Collections.Generic.IDictionary<string, obj> -> string
override this.CreateToken : string * System.Collections.Generic.IDictionary<string, obj> -> string" Usage="jsonWebTokenHandler.CreateToken (payload, additionalHeaderClaims)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="payload" Type="System.String" />
<Parameter Name="additionalHeaderClaims" Type="System.Collections.Generic.IDictionary<System.String,System.Object>" />
</Parameters>
<Docs>
<param name="payload">A string containing JSON which represents the JWT token payload.</param>
<param name="additionalHeaderClaims">Defines the dictionary containing any custom header claims that need to be added to the JWT token header.</param>
<summary>
Creates an unsigned JSON Web Signature (JWS).
</summary>
<returns>A JWS in Compact Serialization format.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="additionalHeaderClaims" /> is null.</exception>
</Docs>
</Member>
<Member MemberName="CreateToken">
<MemberSignature Language="C#" Value="public virtual string CreateToken (string payload, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, System.Collections.Generic.IDictionary<string,object> additionalHeaderClaims);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string CreateToken(string payload, class Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, class System.Collections.Generic.IDictionary`2<string, object> additionalHeaderClaims) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.Collections.Generic.IDictionary{System.String,System.Object})" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateToken (payload As String, encryptingCredentials As EncryptingCredentials, additionalHeaderClaims As IDictionary(Of String, Object)) As String" />
<MemberSignature Language="F#" Value="abstract member CreateToken : string * Microsoft.IdentityModel.Tokens.EncryptingCredentials * System.Collections.Generic.IDictionary<string, obj> -> string
override this.CreateToken : string * Microsoft.IdentityModel.Tokens.EncryptingCredentials * System.Collections.Generic.IDictionary<string, obj> -> string" Usage="jsonWebTokenHandler.CreateToken (payload, encryptingCredentials, additionalHeaderClaims)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="payload" Type="System.String" />
<Parameter Name="encryptingCredentials" Type="Microsoft.IdentityModel.Tokens.EncryptingCredentials" />
<Parameter Name="additionalHeaderClaims" Type="System.Collections.Generic.IDictionary<System.String,System.Object>" />
</Parameters>
<Docs>
<param name="payload">A string containing JSON which represents the JWT token payload.</param>
<param name="encryptingCredentials">Defines the security key and algorithm that will be used to encrypt the JWT.</param>
<param name="additionalHeaderClaims">Defines the dictionary containing any custom header claims that need to be added to the outer JWT token header.</param>
<summary>
Creates a JSON Web Encryption (JWE).
</summary>
<returns>A JWS in Compact Serialization format.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="additionalHeaderClaims" /> is null.</exception>
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException">Thrown if <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Alg" />, <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Kid" /><see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.X5t" />, <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Enc" />, and/or <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Zip" />
are present inside of <paramref name="additionalHeaderClaims" />.</exception>
</Docs>
</Member>
<Member MemberName="CreateToken">
<MemberSignature Language="C#" Value="public virtual string CreateToken (string payload, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, string compressionAlgorithm);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string CreateToken(string payload, class Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, string compressionAlgorithm) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateToken (payload As String, encryptingCredentials As EncryptingCredentials, compressionAlgorithm As String) As String" />
<MemberSignature Language="F#" Value="abstract member CreateToken : string * Microsoft.IdentityModel.Tokens.EncryptingCredentials * string -> string
override this.CreateToken : string * Microsoft.IdentityModel.Tokens.EncryptingCredentials * string -> string" Usage="jsonWebTokenHandler.CreateToken (payload, encryptingCredentials, compressionAlgorithm)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="payload" Type="System.String" />
<Parameter Name="encryptingCredentials" Type="Microsoft.IdentityModel.Tokens.EncryptingCredentials" />
<Parameter Name="compressionAlgorithm" Type="System.String" />
</Parameters>
<Docs>
<param name="payload">A string containing JSON which represents the JWT token payload.</param>
<param name="encryptingCredentials">The security key and algorithm that will be used to encrypt the JWT.</param>
<param name="compressionAlgorithm">The compression algorithm that will be used to compress the JWT token payload.</param>
<summary>
Creates a JSON Web Encryption (JWE).
</summary>
<returns>A JWE in Compact Serialization format.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="compressionAlgorithm" /> is null or empty.</exception>
</Docs>
</Member>
<Member MemberName="CreateToken">
<MemberSignature Language="C#" Value="public virtual string CreateToken (string payload, Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string CreateToken(string payload, class Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials, class Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.SigningCredentials,Microsoft.IdentityModel.Tokens.EncryptingCredentials)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateToken (payload As String, signingCredentials As SigningCredentials, encryptingCredentials As EncryptingCredentials) As String" />
<MemberSignature Language="F#" Value="abstract member CreateToken : string * Microsoft.IdentityModel.Tokens.SigningCredentials * Microsoft.IdentityModel.Tokens.EncryptingCredentials -> string
override this.CreateToken : string * Microsoft.IdentityModel.Tokens.SigningCredentials * Microsoft.IdentityModel.Tokens.EncryptingCredentials -> string" Usage="jsonWebTokenHandler.CreateToken (payload, signingCredentials, encryptingCredentials)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="payload" Type="System.String" />
<Parameter Name="signingCredentials" Type="Microsoft.IdentityModel.Tokens.SigningCredentials" />
<Parameter Name="encryptingCredentials" Type="Microsoft.IdentityModel.Tokens.EncryptingCredentials" />
</Parameters>
<Docs>
<param name="payload">A string containing JSON which represents the JWT token payload.</param>
<param name="signingCredentials">Defines the security key and algorithm that will be used to sign the JWT.</param>
<param name="encryptingCredentials">Defines the security key and algorithm that will be used to encrypt the JWT.</param>
<summary>
Creates a JSON Web Encryption (JWE).
</summary>
<returns>A JWE in Compact Serialization format.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="encryptingCredentials" /> is null.</exception>
</Docs>
</Member>
<Member MemberName="CreateToken">
<MemberSignature Language="C#" Value="public virtual string CreateToken (string payload, Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials, System.Collections.Generic.IDictionary<string,object> additionalHeaderClaims);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string CreateToken(string payload, class Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials, class System.Collections.Generic.IDictionary`2<string, object> additionalHeaderClaims) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.SigningCredentials,System.Collections.Generic.IDictionary{System.String,System.Object})" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateToken (payload As String, signingCredentials As SigningCredentials, additionalHeaderClaims As IDictionary(Of String, Object)) As String" />
<MemberSignature Language="F#" Value="abstract member CreateToken : string * Microsoft.IdentityModel.Tokens.SigningCredentials * System.Collections.Generic.IDictionary<string, obj> -> string
override this.CreateToken : string * Microsoft.IdentityModel.Tokens.SigningCredentials * System.Collections.Generic.IDictionary<string, obj> -> string" Usage="jsonWebTokenHandler.CreateToken (payload, signingCredentials, additionalHeaderClaims)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="payload" Type="System.String" />
<Parameter Name="signingCredentials" Type="Microsoft.IdentityModel.Tokens.SigningCredentials" />
<Parameter Name="additionalHeaderClaims" Type="System.Collections.Generic.IDictionary<System.String,System.Object>" />
</Parameters>
<Docs>
<param name="payload">A string containing JSON which represents the JWT token payload.</param>
<param name="signingCredentials">Defines the security key and algorithm that will be used to sign the JWS.</param>
<param name="additionalHeaderClaims">Defines the dictionary containing any custom header claims that need to be added to the JWT token header.</param>
<summary>
Creates a JSON Web Signature (JWS).
</summary>
<returns>A JWS in Compact Serialization format.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="additionalHeaderClaims" /> is null.</exception>
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException">Thrown if <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Alg" />, <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Kid" /><see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.X5t" />, <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Enc" />, and/or <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Zip" />
are present inside of <paramref name="additionalHeaderClaims" />.</exception>
</Docs>
</Member>
<Member MemberName="CreateToken">
<MemberSignature Language="C#" Value="public virtual string CreateToken (string payload, Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, System.Collections.Generic.IDictionary<string,object> additionalHeaderClaims);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string CreateToken(string payload, class Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials, class Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, class System.Collections.Generic.IDictionary`2<string, object> additionalHeaderClaims) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.SigningCredentials,Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.Collections.Generic.IDictionary{System.String,System.Object})" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateToken (payload As String, signingCredentials As SigningCredentials, encryptingCredentials As EncryptingCredentials, additionalHeaderClaims As IDictionary(Of String, Object)) As String" />
<MemberSignature Language="F#" Value="abstract member CreateToken : string * Microsoft.IdentityModel.Tokens.SigningCredentials * Microsoft.IdentityModel.Tokens.EncryptingCredentials * System.Collections.Generic.IDictionary<string, obj> -> string
override this.CreateToken : string * Microsoft.IdentityModel.Tokens.SigningCredentials * Microsoft.IdentityModel.Tokens.EncryptingCredentials * System.Collections.Generic.IDictionary<string, obj> -> string" Usage="jsonWebTokenHandler.CreateToken (payload, signingCredentials, encryptingCredentials, additionalHeaderClaims)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="payload" Type="System.String" />
<Parameter Name="signingCredentials" Type="Microsoft.IdentityModel.Tokens.SigningCredentials" />
<Parameter Name="encryptingCredentials" Type="Microsoft.IdentityModel.Tokens.EncryptingCredentials" />
<Parameter Name="additionalHeaderClaims" Type="System.Collections.Generic.IDictionary<System.String,System.Object>" />
</Parameters>
<Docs>
<param name="payload">A string containing JSON which represents the JWT token payload.</param>
<param name="signingCredentials">Defines the security key and algorithm that will be used to sign the JWT.</param>
<param name="encryptingCredentials">Defines the security key and algorithm that will be used to encrypt the JWT.</param>
<param name="additionalHeaderClaims">Defines the dictionary containing any custom header claims that need to be added to the outer JWT token header.</param>
<summary>
Creates a JSON Web Encryption (JWE).
</summary>
<returns>A JWE in Compact Serialization format.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="additionalHeaderClaims" /> is null.</exception>
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException">Thrown if <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Alg" />, <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Kid" /><see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.X5t" />, <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Enc" />, and/or <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Zip" />
are present inside of <paramref name="additionalHeaderClaims" />.</exception>
</Docs>
</Member>
<Member MemberName="CreateToken">
<MemberSignature Language="C#" Value="public virtual string CreateToken (string payload, Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, string compressionAlgorithm);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string CreateToken(string payload, class Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials, class Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, string compressionAlgorithm) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.SigningCredentials,Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateToken (payload As String, signingCredentials As SigningCredentials, encryptingCredentials As EncryptingCredentials, compressionAlgorithm As String) As String" />
<MemberSignature Language="F#" Value="abstract member CreateToken : string * Microsoft.IdentityModel.Tokens.SigningCredentials * Microsoft.IdentityModel.Tokens.EncryptingCredentials * string -> string
override this.CreateToken : string * Microsoft.IdentityModel.Tokens.SigningCredentials * Microsoft.IdentityModel.Tokens.EncryptingCredentials * string -> string" Usage="jsonWebTokenHandler.CreateToken (payload, signingCredentials, encryptingCredentials, compressionAlgorithm)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="payload" Type="System.String" />
<Parameter Name="signingCredentials" Type="Microsoft.IdentityModel.Tokens.SigningCredentials" />
<Parameter Name="encryptingCredentials" Type="Microsoft.IdentityModel.Tokens.EncryptingCredentials" />
<Parameter Name="compressionAlgorithm" Type="System.String" />
</Parameters>
<Docs>
<param name="payload">A string containing JSON which represents the JWT token payload.</param>
<param name="signingCredentials">Defines the security key and algorithm that will be used to sign the JWT.</param>
<param name="encryptingCredentials">Defines the security key and algorithm that will be used to encrypt the JWT.</param>
<param name="compressionAlgorithm">Defines the compression algorithm that will be used to compress the JWT token payload.</param>
<summary>
Creates a JSON Web Encryption (JWE).
</summary>
<returns>A JWE in Compact Serialization format.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="compressionAlgorithm" /> is null.</exception>
</Docs>
</Member>
<Member MemberName="CreateToken">
<MemberSignature Language="C#" Value="public virtual string CreateToken (string payload, Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, string compressionAlgorithm, System.Collections.Generic.IDictionary<string,object> additionalHeaderClaims);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string CreateToken(string payload, class Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials, class Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, string compressionAlgorithm, class System.Collections.Generic.IDictionary`2<string, object> additionalHeaderClaims) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.SigningCredentials,Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateToken (payload As String, signingCredentials As SigningCredentials, encryptingCredentials As EncryptingCredentials, compressionAlgorithm As String, additionalHeaderClaims As IDictionary(Of String, Object)) As String" />
<MemberSignature Language="F#" Value="abstract member CreateToken : string * Microsoft.IdentityModel.Tokens.SigningCredentials * Microsoft.IdentityModel.Tokens.EncryptingCredentials * string * System.Collections.Generic.IDictionary<string, obj> -> string
override this.CreateToken : string * Microsoft.IdentityModel.Tokens.SigningCredentials * Microsoft.IdentityModel.Tokens.EncryptingCredentials * string * System.Collections.Generic.IDictionary<string, obj> -> string" Usage="jsonWebTokenHandler.CreateToken (payload, signingCredentials, encryptingCredentials, compressionAlgorithm, additionalHeaderClaims)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="payload" Type="System.String" />
<Parameter Name="signingCredentials" Type="Microsoft.IdentityModel.Tokens.SigningCredentials" />
<Parameter Name="encryptingCredentials" Type="Microsoft.IdentityModel.Tokens.EncryptingCredentials" />
<Parameter Name="compressionAlgorithm" Type="System.String" />
<Parameter Name="additionalHeaderClaims" Type="System.Collections.Generic.IDictionary<System.String,System.Object>" />
</Parameters>
<Docs>
<param name="payload">A string containing JSON which represents the JWT token payload.</param>
<param name="signingCredentials">Defines the security key and algorithm that will be used to sign the JWT.</param>
<param name="encryptingCredentials">Defines the security key and algorithm that will be used to encrypt the JWT.</param>
<param name="compressionAlgorithm">Defines the compression algorithm that will be used to compress the JWT token payload.</param>
<param name="additionalHeaderClaims">Defines the dictionary containing any custom header claims that need to be added to the outer JWT token header.</param>
<summary>
Creates a JSON Web Encryption (JWE).
</summary>
<returns>A JWE in Compact Serialization format.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="additionalHeaderClaims" /> is null.</exception>
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException">Thrown if <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Alg" />, <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Kid" /><see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.X5t" />, <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Enc" />, and/or <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Zip" />
are present inside of <paramref name="additionalHeaderClaims" />.</exception>
</Docs>
</Member>
<Member MemberName="CreateToken">
<MemberSignature Language="C#" Value="public virtual string CreateToken (string payload, Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, string compressionAlgorithm, System.Collections.Generic.IDictionary<string,object> additionalHeaderClaims, System.Collections.Generic.IDictionary<string,object> additionalInnerHeaderClaims);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string CreateToken(string payload, class Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials, class Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, string compressionAlgorithm, class System.Collections.Generic.IDictionary`2<string, object> additionalHeaderClaims, class System.Collections.Generic.IDictionary`2<string, object> additionalInnerHeaderClaims) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.SigningCredentials,Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.String,System.Collections.Generic.IDictionary{System.String,System.Object},System.Collections.Generic.IDictionary{System.String,System.Object})" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateToken (payload As String, signingCredentials As SigningCredentials, encryptingCredentials As EncryptingCredentials, compressionAlgorithm As String, additionalHeaderClaims As IDictionary(Of String, Object), additionalInnerHeaderClaims As IDictionary(Of String, Object)) As String" />
<MemberSignature Language="F#" Value="abstract member CreateToken : string * Microsoft.IdentityModel.Tokens.SigningCredentials * Microsoft.IdentityModel.Tokens.EncryptingCredentials * string * System.Collections.Generic.IDictionary<string, obj> * System.Collections.Generic.IDictionary<string, obj> -> string
override this.CreateToken : string * Microsoft.IdentityModel.Tokens.SigningCredentials * Microsoft.IdentityModel.Tokens.EncryptingCredentials * string * System.Collections.Generic.IDictionary<string, obj> * System.Collections.Generic.IDictionary<string, obj> -> string" Usage="jsonWebTokenHandler.CreateToken (payload, signingCredentials, encryptingCredentials, compressionAlgorithm, additionalHeaderClaims, additionalInnerHeaderClaims)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="payload" Type="System.String" />
<Parameter Name="signingCredentials" Type="Microsoft.IdentityModel.Tokens.SigningCredentials" />
<Parameter Name="encryptingCredentials" Type="Microsoft.IdentityModel.Tokens.EncryptingCredentials" />
<Parameter Name="compressionAlgorithm" Type="System.String" />
<Parameter Name="additionalHeaderClaims" Type="System.Collections.Generic.IDictionary<System.String,System.Object>" />
<Parameter Name="additionalInnerHeaderClaims" Type="System.Collections.Generic.IDictionary<System.String,System.Object>" />
</Parameters>
<Docs>
<param name="payload">A string containing JSON which represents the JWT token payload.</param>
<param name="signingCredentials">Defines the security key and algorithm that will be used to sign the JWT.</param>
<param name="encryptingCredentials">Defines the security key and algorithm that will be used to encrypt the JWT.</param>
<param name="compressionAlgorithm">Defines the compression algorithm that will be used to compress the JWT token payload.</param>
<param name="additionalHeaderClaims">Defines the dictionary containing any custom header claims that need to be added to the outer JWT token header.</param>
<param name="additionalInnerHeaderClaims">Defines the dictionary containing any custom header claims that need to be added to the inner JWT token header.</param>
<summary>
Creates a JSON Web Encryption (JWE).
</summary>
<returns>A JWE in Compact Serialization format.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="additionalHeaderClaims" /> is null.</exception>
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException">Thrown if <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Alg" />, <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Kid" /><see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.X5t" />, <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Enc" />, and/or <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Zip" />
are present inside of <paramref name="additionalHeaderClaims" />.</exception>
</Docs>
</Member>
<Member MemberName="DecryptToken">
<MemberSignature Language="C#" Value="public string DecryptToken (Microsoft.IdentityModel.JsonWebTokens.JsonWebToken jwtToken, Microsoft.IdentityModel.Tokens.TokenValidationParameters validationParameters);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance string DecryptToken(class Microsoft.IdentityModel.JsonWebTokens.JsonWebToken jwtToken, class Microsoft.IdentityModel.Tokens.TokenValidationParameters validationParameters) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.DecryptToken(Microsoft.IdentityModel.JsonWebTokens.JsonWebToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)" />
<MemberSignature Language="VB.NET" Value="Public Function DecryptToken (jwtToken As JsonWebToken, validationParameters As TokenValidationParameters) As String" />
<MemberSignature Language="F#" Value="member this.DecryptToken : Microsoft.IdentityModel.JsonWebTokens.JsonWebToken * Microsoft.IdentityModel.Tokens.TokenValidationParameters -> string" Usage="jsonWebTokenHandler.DecryptToken (jwtToken, validationParameters)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="jwtToken" Type="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" />
<Parameter Name="validationParameters" Type="Microsoft.IdentityModel.Tokens.TokenValidationParameters" />
</Parameters>
<Docs>
<param name="jwtToken">The JWE that contains the cypher text.</param>
<param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters" /> to be used for validating the token.</param>
<summary>
Decrypts a JWE and returns the clear text.
</summary>
<returns>The decoded / cleartext contents of the JWE.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="validationParameters" /> is null.</exception>
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException">Thrown if <see cref="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Enc" /> is null or empty.</exception>
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecompressionFailedException">Thrown if the decompression failed.</exception>
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException">Thrown if <see cref="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Kid" /> is not null AND the decryption fails.</exception>
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException">Thrown if the JWE was not able to be decrypted.</exception>
</Docs>
</Member>
<Member MemberName="DefaultInboundClaimTypeMap">
<MemberSignature Language="C#" Value="public static System.Collections.Generic.IDictionary<string,string> DefaultInboundClaimTypeMap;" />
<MemberSignature Language="ILAsm" Value=".field public static class System.Collections.Generic.IDictionary`2<string, string> DefaultInboundClaimTypeMap" />
<MemberSignature Language="DocId" Value="F:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.DefaultInboundClaimTypeMap" />
<MemberSignature Language="VB.NET" Value="Public Shared DefaultInboundClaimTypeMap As IDictionary(Of String, String) " />
<MemberSignature Language="F#" Value=" staticval mutable DefaultInboundClaimTypeMap : System.Collections.Generic.IDictionary<string, string>" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.DefaultInboundClaimTypeMap" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IDictionary<System.String,System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Default claim type mapping for inbound claims.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DefaultMapInboundClaims">
<MemberSignature Language="C#" Value="public static bool DefaultMapInboundClaims;" />
<MemberSignature Language="ILAsm" Value=".field public static bool DefaultMapInboundClaims" />
<MemberSignature Language="DocId" Value="F:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.DefaultMapInboundClaims" />
<MemberSignature Language="VB.NET" Value="Public Shared DefaultMapInboundClaims As Boolean " />
<MemberSignature Language="F#" Value=" staticval mutable DefaultMapInboundClaims : bool" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.DefaultMapInboundClaims" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Default value for the flag that determines whether or not the InboundClaimTypeMap is used.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EncryptToken">
<MemberSignature Language="C#" Value="public string EncryptToken (string innerJwt, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance string EncryptToken(string innerJwt, class Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.EncryptToken(System.String,Microsoft.IdentityModel.Tokens.EncryptingCredentials)" />
<MemberSignature Language="VB.NET" Value="Public Function EncryptToken (innerJwt As String, encryptingCredentials As EncryptingCredentials) As String" />
<MemberSignature Language="F#" Value="member this.EncryptToken : string * Microsoft.IdentityModel.Tokens.EncryptingCredentials -> string" Usage="jsonWebTokenHandler.EncryptToken (innerJwt, encryptingCredentials)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="innerJwt" Type="System.String" />
<Parameter Name="encryptingCredentials" Type="Microsoft.IdentityModel.Tokens.EncryptingCredentials" />
</Parameters>
<Docs>
<param name="innerJwt">A JSON Web Token (JWT) in JWS Compact Serialization format.</param>
<param name="encryptingCredentials">Defines the security key and algorithm that will be used to encrypt the <paramref name="innerJwt" />.</param>
<summary>
Encrypts a JWS.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="encryptingCredentials" /> is null.</exception>
<exception cref="T:System.ArgumentException">Thrown if both <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.CryptoProviderFactory" /> and <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key" /> are null.</exception>
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">Thrown if not using one of the supported content encryption key (CEK) algorithms: 128, 384 or 512 AesCbcHmac (this applies in the case of key wrap only, not direct encryption).</exception>
</Docs>
</Member>
<Member MemberName="EncryptToken">
<MemberSignature Language="C#" Value="public string EncryptToken (string innerJwt, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, System.Collections.Generic.IDictionary<string,object> additionalHeaderClaims);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance string EncryptToken(string innerJwt, class Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, class System.Collections.Generic.IDictionary`2<string, object> additionalHeaderClaims) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.EncryptToken(System.String,Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.Collections.Generic.IDictionary{System.String,System.Object})" />
<MemberSignature Language="VB.NET" Value="Public Function EncryptToken (innerJwt As String, encryptingCredentials As EncryptingCredentials, additionalHeaderClaims As IDictionary(Of String, Object)) As String" />
<MemberSignature Language="F#" Value="member this.EncryptToken : string * Microsoft.IdentityModel.Tokens.EncryptingCredentials * System.Collections.Generic.IDictionary<string, obj> -> string" Usage="jsonWebTokenHandler.EncryptToken (innerJwt, encryptingCredentials, additionalHeaderClaims)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="innerJwt" Type="System.String" />
<Parameter Name="encryptingCredentials" Type="Microsoft.IdentityModel.Tokens.EncryptingCredentials" />
<Parameter Name="additionalHeaderClaims" Type="System.Collections.Generic.IDictionary<System.String,System.Object>" />
</Parameters>
<Docs>
<param name="innerJwt">A JSON Web Token (JWT) in JWS Compact Serialization format.</param>
<param name="encryptingCredentials">Defines the security key and algorithm that will be used to encrypt the <paramref name="innerJwt" />.</param>
<param name="additionalHeaderClaims">Defines the dictionary containing any custom header claims that need to be added to the outer JWT token header.</param>
<summary>
Encrypts a JWS.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="additionalHeaderClaims" /> is null.</exception>
<exception cref="T:System.ArgumentException">Thrown if both <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.CryptoProviderFactory" /> and <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key" /> are null.</exception>
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">Thrown if not using one of the supported content encryption key (CEK) algorithms: 128, 384 or 512 AesCbcHmac (this applies in the case of key wrap only, not direct encryption).</exception>
</Docs>
</Member>
<Member MemberName="EncryptToken">
<MemberSignature Language="C#" Value="public string EncryptToken (string innerJwt, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, string algorithm);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance string EncryptToken(string innerJwt, class Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, string algorithm) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.EncryptToken(System.String,Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function EncryptToken (innerJwt As String, encryptingCredentials As EncryptingCredentials, algorithm As String) As String" />
<MemberSignature Language="F#" Value="member this.EncryptToken : string * Microsoft.IdentityModel.Tokens.EncryptingCredentials * string -> string" Usage="jsonWebTokenHandler.EncryptToken (innerJwt, encryptingCredentials, algorithm)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="innerJwt" Type="System.String" />
<Parameter Name="encryptingCredentials" Type="Microsoft.IdentityModel.Tokens.EncryptingCredentials" />
<Parameter Name="algorithm" Type="System.String" />
</Parameters>
<Docs>
<param name="innerJwt">A JSON Web Token (JWT) in JWS Compact Serialization format.</param>
<param name="encryptingCredentials">Defines the security key and algorithm that will be used to encrypt the <paramref name="innerJwt" />.</param>
<param name="algorithm">Defines the compression algorithm that will be used to compress the <paramref name="innerJwt" />.</param>
<summary>
Encrypts a JWS.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="algorithm" /> is null or empty.</exception>
<exception cref="T:System.ArgumentException">Thrown if both <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.CryptoProviderFactory" /> and <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key" /> are null.</exception>
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">Thrown if not using one of the supported content encryption key (CEK) algorithms: 128, 384 or 512 AesCbcHmac (this applies in the case of key wrap only, not direct encryption).</exception>
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenCompressionFailedException">Thrown if compression using <paramref name="algorithm" /> fails.</exception>
</Docs>
</Member>
<Member MemberName="EncryptToken">
<MemberSignature Language="C#" Value="public string EncryptToken (string innerJwt, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, string algorithm, System.Collections.Generic.IDictionary<string,object> additionalHeaderClaims);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance string EncryptToken(string innerJwt, class Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, string algorithm, class System.Collections.Generic.IDictionary`2<string, object> additionalHeaderClaims) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.EncryptToken(System.String,Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})" />
<MemberSignature Language="VB.NET" Value="Public Function EncryptToken (innerJwt As String, encryptingCredentials As EncryptingCredentials, algorithm As String, additionalHeaderClaims As IDictionary(Of String, Object)) As String" />
<MemberSignature Language="F#" Value="member this.EncryptToken : string * Microsoft.IdentityModel.Tokens.EncryptingCredentials * string * System.Collections.Generic.IDictionary<string, obj> -> string" Usage="jsonWebTokenHandler.EncryptToken (innerJwt, encryptingCredentials, algorithm, additionalHeaderClaims)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="innerJwt" Type="System.String" />
<Parameter Name="encryptingCredentials" Type="Microsoft.IdentityModel.Tokens.EncryptingCredentials" />
<Parameter Name="algorithm" Type="System.String" />
<Parameter Name="additionalHeaderClaims" Type="System.Collections.Generic.IDictionary<System.String,System.Object>" />
</Parameters>
<Docs>
<param name="innerJwt">A JSON Web Token (JWT) in JWS Compact Serialization format.</param>
<param name="encryptingCredentials">Defines the security key and algorithm that will be used to encrypt the <paramref name="innerJwt" />.</param>
<param name="algorithm">Defines the compression algorithm that will be used to compress the <paramref name="innerJwt" /></param>
<param name="additionalHeaderClaims">Defines the dictionary containing any custom header claims that need to be added to the outer JWT token header.</param>
<summary>
Encrypts a JWS.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="additionalHeaderClaims" /> is null or empty.</exception>
<exception cref="T:System.ArgumentException">Thrown if both <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.CryptoProviderFactory" /> and <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key" /> are null.</exception>
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">Thrown if not using one of the supported content encryption key (CEK) algorithms: 128, 384 or 512 AesCbcHmac (this applies in the case of key wrap only, not direct encryption).</exception>
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenCompressionFailedException">Thrown if compression using 'algorithm' fails.</exception>
</Docs>
</Member>
<Member MemberName="InboundClaimTypeMap">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IDictionary<string,string> InboundClaimTypeMap { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2<string, string> InboundClaimTypeMap" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.InboundClaimTypeMap" />
<MemberSignature Language="VB.NET" Value="Public Property InboundClaimTypeMap As IDictionary(Of String, String)" />
<MemberSignature Language="F#" Value="member this.InboundClaimTypeMap : System.Collections.Generic.IDictionary<string, string> with get, set" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.InboundClaimTypeMap" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IDictionary<System.String,System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the <see cref="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.InboundClaimTypeMap" /> which is used when setting the <see cref="P:System.Security.Claims.Claim.Type" /> for claims in the <see cref="T:System.Security.Claims.ClaimsPrincipal" /> extracted when validating a <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" />.
<para>The <see cref="P:System.Security.Claims.Claim.Type" /> is set to the JSON claim 'name' after translating using this mapping.</para><para>The default value is ClaimTypeMapping.InboundClaimTypeMap.</para></summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">Thrown if 'value' is null.</exception>
</Docs>
</Member>
<Member MemberName="MapInboundClaims">
<MemberSignature Language="C#" Value="public bool MapInboundClaims { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool MapInboundClaims" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.MapInboundClaims" />
<MemberSignature Language="VB.NET" Value="Public Property MapInboundClaims As Boolean" />
<MemberSignature Language="F#" Value="member this.MapInboundClaims : bool with get, set" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.MapInboundClaims" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the <see cref="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.MapInboundClaims" /> property which is used when determining whether or not to map claim types that are extracted when validating a <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" />.
<para>If this is set to true, the <see cref="P:System.Security.Claims.Claim.Type" /> is set to the JSON claim 'name' after translating using this mapping. Otherwise, no mapping occurs.</para><para>The default value is false.</para></summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReadJsonWebToken">
<MemberSignature Language="C#" Value="public virtual Microsoft.IdentityModel.JsonWebTokens.JsonWebToken ReadJsonWebToken (string token);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.IdentityModel.JsonWebTokens.JsonWebToken ReadJsonWebToken(string token) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ReadJsonWebToken(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ReadJsonWebToken (token As String) As JsonWebToken" />
<MemberSignature Language="F#" Value="abstract member ReadJsonWebToken : string -> Microsoft.IdentityModel.JsonWebTokens.JsonWebToken
override this.ReadJsonWebToken : string -> Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" Usage="jsonWebTokenHandler.ReadJsonWebToken token" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.IdentityModel.JsonWebTokens.JsonWebToken</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="token" Type="System.String" />
</Parameters>
<Docs>
<param name="token">A JSON Web Token (JWT) in JWS or JWE Compact Serialization format.</param>
<summary>
Converts a string into an instance of <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" />.
</summary>
<returns>A <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" />.</returns>
<remarks>
<para>If the <paramref name="token" /> is in JWE Compact Serialization format, only the protected header will be deserialized.</para>
This method is unable to decrypt the payload. Use <see cref="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ValidateToken(System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters)" />to obtain the payload.
<para>
The token is NOT validated and no security decisions should be made about the contents.
Use <see cref="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ValidateToken(System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters)" /> or <see cref="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ValidateTokenAsync(System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters)" /> to ensure the token is acceptable.
</para></remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="token" /> is null or empty.</exception>
<exception cref="T:System.ArgumentException">Thrown if the length of <paramref name="token" /> is greater than <see cref="P:Microsoft.IdentityModel.Tokens.TokenHandler.MaximumTokenSizeInBytes" />.</exception>
</Docs>
</Member>
<Member MemberName="ReadToken">
<MemberSignature Language="C#" Value="public override Microsoft.IdentityModel.Tokens.SecurityToken ReadToken (string token);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class Microsoft.IdentityModel.Tokens.SecurityToken ReadToken(string token) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ReadToken(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ReadToken (token As String) As SecurityToken" />
<MemberSignature Language="F#" Value="override this.ReadToken : string -> Microsoft.IdentityModel.Tokens.SecurityToken" Usage="jsonWebTokenHandler.ReadToken token" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.IdentityModel.Tokens.SecurityToken</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="token" Type="System.String" />
</Parameters>
<Docs>
<param name="token">A JSON Web Token (JWT) in JWS or JWE Compact Serialization format.</param>
<summary>
Converts a string into an instance of <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" />.
</summary>
<returns>A <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" />.</returns>
<remarks>The token is NOT validated and no security decisions should be made about the contents.
<para>Use <see cref="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ValidateToken(System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters)" /> or <see cref="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ValidateTokenAsync(System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters)" /> to ensure the token is acceptable.</para></remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="token" /> is null or empty.</exception>
<exception cref="T:System.ArgumentException">Thrown if the length of <paramref name="token" /> is greater than <see cref="P:Microsoft.IdentityModel.Tokens.TokenHandler.MaximumTokenSizeInBytes" />.</exception>
</Docs>
</Member>
<Member MemberName="ResolveTokenDecryptionKey">
<MemberSignature Language="C#" Value="protected virtual Microsoft.IdentityModel.Tokens.SecurityKey ResolveTokenDecryptionKey (string token, Microsoft.IdentityModel.JsonWebTokens.JsonWebToken jwtToken, Microsoft.IdentityModel.Tokens.TokenValidationParameters validationParameters);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class Microsoft.IdentityModel.Tokens.SecurityKey ResolveTokenDecryptionKey(string token, class Microsoft.IdentityModel.JsonWebTokens.JsonWebToken jwtToken, class Microsoft.IdentityModel.Tokens.TokenValidationParameters validationParameters) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ResolveTokenDecryptionKey(System.String,Microsoft.IdentityModel.JsonWebTokens.JsonWebToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Function ResolveTokenDecryptionKey (token As String, jwtToken As JsonWebToken, validationParameters As TokenValidationParameters) As SecurityKey" />
<MemberSignature Language="F#" Value="abstract member ResolveTokenDecryptionKey : string * Microsoft.IdentityModel.JsonWebTokens.JsonWebToken * Microsoft.IdentityModel.Tokens.TokenValidationParameters -> Microsoft.IdentityModel.Tokens.SecurityKey
override this.ResolveTokenDecryptionKey : string * Microsoft.IdentityModel.JsonWebTokens.JsonWebToken * Microsoft.IdentityModel.Tokens.TokenValidationParameters -> Microsoft.IdentityModel.Tokens.SecurityKey" Usage="jsonWebTokenHandler.ResolveTokenDecryptionKey (token, jwtToken, validationParameters)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.IdentityModel.Tokens.SecurityKey</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="token" Type="System.String" />
<Parameter Name="jwtToken" Type="Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" />
<Parameter Name="validationParameters" Type="Microsoft.IdentityModel.Tokens.TokenValidationParameters" />
</Parameters>
<Docs>
<param name="token">The <see cref="T:System.String" /> the token that is being decrypted.</param>
<param name="jwtToken">The <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken" /> that is being decrypted.</param>
<param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters" /> to be used for validating the token.</param>
<summary>
Returns a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey" /> to use when decrypting a JWE.
</summary>
<returns>A <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey" /> to use for signature validation.</returns>
<remarks>If key fails to resolve, then null is returned.</remarks>
</Docs>
</Member>
<Member MemberName="ShortClaimTypeProperty">
<MemberSignature Language="C#" Value="public static string ShortClaimTypeProperty { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property string ShortClaimTypeProperty" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ShortClaimTypeProperty" />
<MemberSignature Language="VB.NET" Value="Public Shared Property ShortClaimTypeProperty As String" />
<MemberSignature Language="F#" Value="static member ShortClaimTypeProperty : string with get, set" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ShortClaimTypeProperty" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.JsonWebTokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the property name of <see cref="P:System.Security.Claims.Claim.Properties" /> the will contain the original JSON claim 'name' if a mapping occurred when the <see cref="T:System.Security.Claims.Claim" />(s) were created.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">Thrown if 'value' is null or whitespace.</exception>
</Docs>
</Member>
<Member MemberName="TokenType">
<MemberSignature Language="C#" Value="public Type TokenType { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Type TokenType" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.TokenType" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property TokenType As Type" />
<MemberSignature Language="F#" Value="member this.TokenType : Type" Usage="Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.TokenType" />
<MemberType>Property</MemberType>