netFramework/Microsoft.IdentityModel.JsonWebTokens.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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 |
<?xml version="1.0"?>
<doc> <assembly> <name>Microsoft.IdentityModel.JsonWebTokens</name> </assembly> <members> <member name="T:Microsoft.IdentityModel.JsonWebTokens.JsonClaimValueTypes"> <summary> Constants for Json Web tokens. </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JsonClaimValueTypes.Json"> <summary> A URI that represents the JSON XML data type. </summary> <remarks>When mapping json to .Net Claim(s), if the value was not a string (or an enumeration of strings), the ClaimValue will serialized using the current JSON serializer, a property will be added with the .Net type and the ClaimTypeValue will be set to 'JsonClaimValueType'.</remarks> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JsonClaimValueTypes.JsonArray"> <summary> A URI that represents the JSON array XML data type. </summary> <remarks>When mapping json to .Net Claim(s), if the value was not a string (or an enumeration of strings), the ClaimValue will serialized using the current JSON serializer, a property will be added with the .Net type and the ClaimTypeValue will be set to 'JsonClaimValueType'.</remarks> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JsonClaimValueTypes.JsonNull"> <summary> A URI that represents the JSON null data type </summary> <remarks>When mapping json to .Net Claim(s), we use empty string to represent the claim value and set the ClaimValueType to JsonNull</remarks> </member> <member name="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"> <summary> A <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> designed for representing a JSON Web Token (JWT). </summary> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String)"> <summary> Initializes a new instance of <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/> from a string in JWS or JWE Compact serialized format. </summary> <param name="jwtEncodedString">A JSON Web Token that has been serialized in JWS or JWE Compact serialized format.</param> <exception cref="T:System.ArgumentNullException">'jwtEncodedString' is null or empty.</exception> <exception cref="T:System.ArgumentException">'jwtEncodedString' is not in JWS or JWE Compact serialization format.</exception> <remarks> 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"/> </remarks> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String,System.String)"> <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> <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 }.</param> <exception cref="T:System.ArgumentNullException">'header' is null.</exception> <exception cref="T:System.ArgumentNullException">'payload' is null.</exception> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Actor"> <summary> Gets the 'value' of the 'actort' claim { actort, 'value' }. </summary> <remarks>If the 'actort' claim is not found, an empty string is returned.</remarks> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Alg"> <summary> Gets the 'value' of the 'alg' claim { alg, 'value' }. </summary> <remarks>If the 'alg' claim is not found, an empty string is returned.</remarks> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Audiences"> <summary> Gets the list of 'aud' claim { aud, 'value' }. </summary> <remarks>If the 'aud' claim is not found, enumeration will be empty.</remarks> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.AuthenticationTag"> <summary> Gets the AuthenticationTag from the original raw data of this instance when it was created. </summary> <remarks>The original JSON Compact serialized format passed into the constructor. <see cref="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String)"/></remarks> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Ciphertext"> <summary> Gets the Ciphertext from the original raw data of this instance when it was created. </summary> <remarks>The original JSON Compact serialized format passed into the constructor. <see cref="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String)"/></remarks> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Claims"> <summary> Gets a <see cref="T:System.Collections.Generic.IEnumerable`1"/><see cref="T:System.Security.Claims.Claim"/> for each JSON { name, value }. </summary> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Cty"> <summary> Gets the 'value' of the 'cty' claim { cty, 'value' }. </summary> <remarks>If the 'cty' claim is not found, an empty string is returned.</remarks> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Enc"> <summary> Gets the 'value' of the 'enc' claim { enc, 'value' }. </summary> <remarks>If the 'enc' value is not found, an empty string is returned.</remarks> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.EncryptedKey"> <summary> Gets the EncryptedKey from the original raw data of this instance when it was created. </summary> <remarks>The original JSON Compact serialized format passed into the constructor. <see cref="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String)"/></remarks> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Header"> <summary> Represents the cryptographic operations applied to the JWT and optionally any additional properties of the JWT. </summary> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Id"> <summary> Gets the 'value' of the 'jti' claim { jti, ''value' }. </summary> <remarks>If the 'jti' claim is not found, an empty string is returned.</remarks> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.InitializationVector"> <summary> Gets the InitializationVector from the original raw data of this instance when it was created. </summary> <remarks>The original JSON Compact serialized format passed into the constructor. <see cref="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String)"/></remarks> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.InnerToken"> <summary> Gets the <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/> associated with this instance. </summary> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.IssuedAt"> <summary> Gets the 'value' of the 'iat' claim { iat, 'value' } converted to a <see cref="T:System.DateTime"/> assuming 'value' is seconds since UnixEpoch (UTC 1970-01-01T0:0:0Z). </summary> <remarks>If the 'iat' claim is not found, then <see cref="F:System.DateTime.MinValue"/> is returned.</remarks> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Issuer"> <summary> Gets the 'value' of the 'iss' claim { iss, 'value' }. </summary> <remarks>If the 'iss' claim is not found, an empty string is returned.</remarks> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Kid"> <summary> Gets the 'value' of the 'kid' claim { kid, 'value' }. </summary> <remarks>If the 'kid' claim is not found, an empty string is returned.</remarks> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Payload"> <summary> Represents the JSON payload. </summary> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.EncodedHeader"> <summary> Gets the EncodedHeader from the original raw data of this instance when it was created. </summary> <remarks>The original JSON Compact serialized format passed into the constructor. <see cref="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String)"/></remarks> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.EncodedPayload"> <summary> Gets the EncodedPayload from the original raw data of this instance when it was created. </summary> <remarks>The original JSON Compact serialized format passed into the constructor. <see cref="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String)"/></remarks> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.EncodedSignature"> <summary> Gets the EncodedSignature from the original raw data of this instance when it was created. </summary> <remarks>The original JSON Compact serialized format passed into the constructor. <see cref="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String)"/></remarks> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.EncodedToken"> <summary> Gets the original raw data of this instance when it was created. </summary> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.SecurityKey"> <summary> Not implemented. </summary> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.SigningKey"> <summary> Not implemented. </summary> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Subject"> <summary> Gets the 'value' of the 'sub' claim { sub, 'value' }. </summary> <remarks>If the 'sub' claim is not found, an empty string is returned.</remarks> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Typ"> <summary> Gets the 'value' of the 'typ' claim { typ, 'value' }. </summary> <remarks>If the 'typ' claim is not found, an empty string is returned.</remarks> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.ValidFrom"> <summary> Gets the 'value' of the 'nbf' claim { nbf, 'value' } converted to a <see cref="T:System.DateTime"/> assuming 'value' is seconds since UnixEpoch (UTC 1970-01-01T0:0:0Z). </summary> <remarks>If the 'nbf' claim is not found, then <see cref="F:System.DateTime.MinValue"/> is returned.</remarks> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.ValidTo"> <summary> Gets the 'value' of the 'exp' claim { exp, 'value' } converted to a <see cref="T:System.DateTime"/> assuming 'value' is seconds since UnixEpoch (UTC 1970-01-01T0:0:0Z). </summary> <remarks>If the 'exp' claim is not found, then <see cref="F:System.DateTime.MinValue"/> is returned.</remarks> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.X5t"> <summary> Gets the 'value' of the 'x5t' claim { x5t, 'value' }. </summary> <remarks>If the 'x5t' claim is not found, an empty string is returned.</remarks> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Zip"> <summary> Gets the 'value' of the 'zip' claim { zip, 'value' }. </summary> <remarks>If the 'zip' claim is not found, an empty string is returned.</remarks> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Decode(System.String[],System.String)"> <summary> Decodes the string into the header, payload and signature. </summary> <param name="tokenParts">the tokenized string.</param> <param name="rawData">the original token.</param> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.DecodeJwe(System.String[])"> <summary> Decodes the payload and signature from the JWE parts. </summary> <param name="tokenParts">Parts of the JWE including the header.</param> <remarks> Assumes Header has already been set. According to the JWE documentation (https://tools.ietf.org/html/rfc7516#section-2), it is possible for the EncryptedKey, InitializationVector, and AuthenticationTag to be empty strings. </remarks> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.DecodeJws(System.String[])"> <summary> Decodes the payload and signature from the JWS parts. </summary> <param name="tokenParts">Parts of the JWS including the header.</param> <remarks>Assumes Header has already been set.</remarks> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.GetClaim(System.String)"> <summary> Gets a <see cref="T:System.Security.Claims.Claim"/> representing the { key, 'value' } pair corresponding to the provided <paramref name="key"/>. </summary> <remarks>If the key has no corresponding value, this method will throw.</remarks> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.GetPayloadValue``1(System.String)"> <summary> Gets the 'value' corresponding to the provided key from the JWT payload { key, 'value' }. </summary> <remarks>If the key has no corresponding value, this method will throw. </remarks> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.TryGetClaim(System.String,System.Security.Claims.Claim@)"> <summary> Tries to get the <see cref="T:System.Security.Claims.Claim"/> representing the { key, 'value' } pair corresponding to the provided <paramref name="key"/>. </summary> <remarks>If the key has no corresponding value, returns false. Otherwise returns true. </remarks> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.TryGetPayloadValue``1(System.String,``0@)"> <summary> Tries to get the 'value' corresponding to the provided key from the JWT payload { key, 'value' }. </summary> <remarks>If the key has no corresponding value, returns false. Otherwise returns true. </remarks> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.GetHeaderValue``1(System.String)"> <summary> Gets the 'value' corresponding to the provided key from the JWT header { key, 'value' }. </summary> <remarks>If the key has no corresponding value, this method will throw. </remarks> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.TryGetHeaderValue``1(System.String,``0@)"> <summary> Tries to get the value corresponding to the provided key from the JWT header { key, 'value' }. </summary> <remarks>If the key has no corresponding value, returns false. Otherwise returns true. </remarks> </member> <member name="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler"> <summary> A <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenHandler"/> designed for creating and validating Json Web Tokens. See: http://tools.ietf.org/html/rfc7519 and http://www.rfc-editor.org/info/rfc7515. </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.Base64UrlEncodedUnsignedJWSHeader"> <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> <return>The Base64Url encoded string representation of the unsigned JWT header.</return> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.TokenType"> <summary> Gets the type of the <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/>. </summary> <return>The type of <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/></return> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CanReadToken(System.String)"> <summary> Determines if the string is a well formed Json Web Token (JWT). <para>see: http://tools.ietf.org/html/rfc7519 </para> </summary> <param name="token">String that should represent a valid JWT.</param> <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> <returns> <para>'false' if the token is null or whitespace.</para> <para>'false' if token.Length is greater than <see cref="P:Microsoft.IdentityModel.Tokens.TokenHandler.MaximumTokenSizeInBytes"/>.</para> <para>'true' if the token is in JSON compact serialization format.</para> </returns> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CanValidateToken"> <summary> Returns a value that indicates if this handler can validate a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>. </summary> <returns>'true', indicating this instance can validate a <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/>.</returns> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String)"> <summary> Creates an unsigned JWS (Json Web Signature). </summary> <param name="payload">A string containing JSON which represents the JWT token payload.</param> <exception cref="T:System.ArgumentNullException">if <paramref name="payload"/> is null.</exception> <returns>A JWS in Compact Serialization Format.</returns> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,System.Collections.Generic.IDictionary{System.String,System.Object})"> <summary> Creates an unsigned JWS (Json Web Signature). </summary> <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> <exception cref="T:System.ArgumentNullException">if <paramref name="payload"/> is null.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="additionalHeaderClaims"/> is null.</exception> <returns>A JWS in Compact Serialization Format.</returns> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.SigningCredentials)"> <summary> Creates a JWS (Json Web Signature). </summary> <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> <exception cref="T:System.ArgumentNullException">if <paramref name="payload"/> is null.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="signingCredentials"/> is null.</exception> <returns>A JWS in Compact Serialization Format.</returns> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.SigningCredentials,System.Collections.Generic.IDictionary{System.String,System.Object})"> <summary> Creates a JWS (Json Web Signature). </summary> <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> <exception cref="T:System.ArgumentNullException">if <paramref name="payload"/> is null.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="signingCredentials"/> is null.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="additionalHeaderClaims"/> is null.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException">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> <returns>A JWS in Compact Serialization Format.</returns> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor)"> <summary> Creates a JWS(Json Web Signature). </summary> <param name="tokenDescriptor">A <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor"/> that contains details of contents of the token.</param> <returns>A JWS in Compact Serialization Format.</returns> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.EncryptingCredentials)"> <summary> Creates a JWE (Json Web Encryption). </summary> <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> <returns>A JWE in compact serialization format.</returns> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.SigningCredentials,Microsoft.IdentityModel.Tokens.EncryptingCredentials)"> <summary> Creates a JWE (Json Web Encryption). </summary> <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> <exception cref="T:System.ArgumentNullException">if <paramref name="payload"/> is null.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="signingCredentials"/> is null.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="encryptingCredentials"/> is null.</exception> <returns>A JWE in compact serialization format.</returns> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.SigningCredentials,Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.Collections.Generic.IDictionary{System.String,System.Object})"> <summary> Creates a JWE (Json Web Encryption). </summary> <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> <exception cref="T:System.ArgumentNullException">if <paramref name="payload"/> is null.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="signingCredentials"/> is null.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="encryptingCredentials"/> is null.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="additionalHeaderClaims"/> is null.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException">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> <returns>A JWE in compact serialization format.</returns> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.String)"> <summary> Creates a JWE (Json Web Encryption). </summary> <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="compressionAlgorithm">Defines the compression algorithm that will be used to compress the JWT token payload.</param> <returns>A JWE in compact serialization format.</returns> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.SigningCredentials,Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.String)"> <summary> Creates a JWE (Json Web Encryption). </summary> <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> <exception cref="T:System.ArgumentNullException">if <paramref name="payload"/> is null.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="signingCredentials"/> is null.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="encryptingCredentials"/> is null.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="compressionAlgorithm"/> is null.</exception> <returns>A JWE in compact serialization format.</returns> </member> <member name="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})"> <summary> Creates a JWE (Json Web Encryption). </summary> <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> <exception cref="T:System.ArgumentNullException">if <paramref name="payload"/> is null.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="signingCredentials"/> is null.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="encryptingCredentials"/> is null.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="compressionAlgorithm"/> is null.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="additionalHeaderClaims"/> is null.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException">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> <returns>A JWE in compact serialization format.</returns> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CompressToken(System.String,System.String)"> <summary> Compress a JWT token string. </summary> <param name="token"></param> <param name="compressionAlgorithm"></param> <exception cref="T:System.ArgumentNullException">if <paramref name="token"/> is null.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="compressionAlgorithm"/> is null.</exception> <exception cref="T:System.NotSupportedException">if the compression algorithm is not supported.</exception> <returns>Compressed JWT token bytes.</returns> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateClaimsIdentity(Microsoft.IdentityModel.JsonWebTokens.JsonWebToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)"> <summary> Creates a <see cref="T:System.Security.Claims.ClaimsIdentity"/> from a <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/>. </summary> <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"> Contains parameters for validating the token.</param> <returns>A <see cref="T:System.Security.Claims.ClaimsIdentity"/> containing the <see cref="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Claims"/>.</returns> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.DecryptToken(Microsoft.IdentityModel.JsonWebTokens.JsonWebToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)"> <summary> Decrypts a JWE and returns the clear text </summary> <param name="jwtToken">the JWE that contains the cypher text.</param> <param name="validationParameters">contains crypto material.</param> <returns>the decoded / cleartext contents of the JWE.</returns> <exception cref="T:System.ArgumentNullException">if <paramref name="jwtToken"/> is null.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="validationParameters"/> is null.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException">if '<paramref name="jwtToken"/> .Enc' is null or empty.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecompressionFailedException">if decompression failed.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException">if '<paramref name="jwtToken"/> .Kid' is not null AND decryption fails.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException">if the JWE was not able to be decrypted.</exception> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.EncryptToken(System.String,Microsoft.IdentityModel.Tokens.EncryptingCredentials)"> <summary> Encrypts a JWS. </summary> <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> <exception cref="T:System.ArgumentNullException">if <paramref name="innerJwt"/> is null or empty.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="encryptingCredentials"/> is null.</exception> <exception cref="T:System.ArgumentException">if both <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.CryptoProviderFactory"/> and <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/>.<see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"/> are null.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">if the CryptoProviderFactory being used does not support the <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Enc"/> (algorithm), <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/> pair.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">if unable to create a token encryption provider for the <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Enc"/> (algorithm), <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/> pair.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">if encryption fails using the <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Enc"/> (algorithm), <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/> pair.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">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> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.EncryptToken(System.String,Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.Collections.Generic.IDictionary{System.String,System.Object})"> <summary> Encrypts a JWS. </summary> <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> <exception cref="T:System.ArgumentNullException">if <paramref name="innerJwt"/> is null or empty.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="encryptingCredentials"/> is null.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="additionalHeaderClaims"/> is null.</exception> <exception cref="T:System.ArgumentException">if both <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.CryptoProviderFactory"/> and <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/>.<see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"/> are null.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">if the CryptoProviderFactory being used does not support the <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Enc"/> (algorithm), <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/> pair.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">if unable to create a token encryption provider for the <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Enc"/> (algorithm), <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/> pair.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">if encryption fails using the <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Enc"/> (algorithm), <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/> pair.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">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> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.EncryptToken(System.String,Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.String)"> <summary> Encrypts a JWS. </summary> <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 'innerJwt'.</param> <exception cref="T:System.ArgumentNullException">if <paramref name="innerJwt"/> is null or empty.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="encryptingCredentials"/> is null.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="algorithm"/> is null or empty.</exception> <exception cref="T:System.ArgumentException">if both <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.CryptoProviderFactory"/> and <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/>.<see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"/> are null.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">if the CryptoProviderFactory being used does not support the <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Enc"/> (algorithm), <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/> pair.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">if unable to create a token encryption provider for the <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Enc"/> (algorithm), <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/> pair.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenCompressionFailedException">if compression using <paramref name="algorithm"/> fails.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">if encryption fails using the <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Enc"/> (algorithm), <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/> pair.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">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> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.EncryptToken(System.String,Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})"> <summary> Encrypts a JWS. </summary> <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 '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> <exception cref="T:System.ArgumentNullException">if <paramref name="innerJwt"/> is null or empty.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="encryptingCredentials"/> is null.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="algorithm"/> is null or empty.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="additionalHeaderClaims"/> is null or empty.</exception> <exception cref="T:System.ArgumentException">if both <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.CryptoProviderFactory"/> and <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/>.<see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"/> are null.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">if the CryptoProviderFactory being used does not support the <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Enc"/> (algorithm), <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/> pair.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">if unable to create a token encryption provider for the <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Enc"/> (algorithm), <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/> pair.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenCompressionFailedException">if compression using 'algorithm' fails.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">if encryption fails using the <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Enc"/> (algorithm), <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/> pair.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">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> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ResolveTokenDecryptionKey(System.String,Microsoft.IdentityModel.JsonWebTokens.JsonWebToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)"> <summary> Returns a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use when decrypting a JWE. </summary> <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">A <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param> <returns>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> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ReadJsonWebToken(System.String)"> <summary> Converts a string into an instance of <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/>. </summary> <param name="token">A 'JSON Web Token' (JWT) in JWS or JWE Compact Serialization Format.</param> <returns>A <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/></returns> <exception cref="T:System.ArgumentNullException">'token' is null or empty.</exception> <exception cref="T:System.ArgumentException">'token.Length' is greater than <see cref="P:Microsoft.IdentityModel.Tokens.TokenHandler.MaximumTokenSizeInBytes"/>.</exception> <remarks><para>If the '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.</remarks> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ReadToken(System.String)"> <summary> Converts a string into an instance of <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/>. </summary> <param name="token">A 'JSON Web Token' (JWT) in JWS or JWE Compact Serialization Format.</param> <returns>A <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/></returns> <exception cref="T:System.ArgumentNullException">'token' is null or empty.</exception> <exception cref="T:System.ArgumentException">'token.Length' is greater than <see cref="P:Microsoft.IdentityModel.Tokens.TokenHandler.MaximumTokenSizeInBytes"/>.</exception> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ValidateToken(System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters)"> <summary> Validates a JWS or a JWE. </summary> <param name="token">A 'JSON Web Token' (JWT) in JWS or JWE Compact Serialization Format.</param> <param name="validationParameters">A <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param> <returns>A <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationResult"/></returns> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ValidateSignature(System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters)"> <summary> Validates the JWT signature. </summary> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ValidateSignature(System.Byte[],System.Byte[],Microsoft.IdentityModel.Tokens.SecurityKey,System.String,Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)"> <summary> Obtains a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> and validates the signature. </summary> <param name="encodedBytes">Bytes to validate.</param> <param name="signature">Signature to compare against.</param> <param name="key"><See cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use.</param> <param name="algorithm">Crypto algorithm to use.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param> <param name="validationParameters">Priority will be given to <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.CryptoProviderFactory"/> over <see cref="P:Microsoft.IdentityModel.Tokens.SecurityKey.CryptoProviderFactory"/>.</param> <returns>'true' if signature is valid.</returns> </member> <member name="T:Microsoft.IdentityModel.JsonWebTokens.JwtConstants"> <summary> Constants for Json Web Tokens. </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.HeaderType"> <summary> Short header type. </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.HeaderTypeAlt"> <summary> Long header type. </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.TokenType"> <summary> Short token type. </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.TokenTypeAlt"> <summary> Long token type. </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.JsonCompactSerializationRegex"> <summary> JWS - Token format: 'header.payload.signature'. Signature is optional, but '.' is required. </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.JweCompactSerializationRegex"> <summary> JWE - Token format: 'protectedheader.encryptedkey.iv.cyphertext.authenticationtag'. </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.JweSegmentCount"> <summary> The number of parts in a JWE token. </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.JwsSegmentCount"> <summary> The number of parts in a JWS token. </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.MaxJwtSegmentCount"> <summary> The maximum number of parts in a JWT. </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.DirectKeyUseAlg"> <summary> JWE header alg indicating a shared symmetric key is directly used as CEK. </summary> </member> <member name="T:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames"> <summary> List of header parameter names see: http://tools.ietf.org/html/rfc7519#section-5. </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Alg"> <summary> see:https://tools.ietf.org/html/rfc7515#section-4.1.1 </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Cty"> <summary> see:https://tools.ietf.org/html/rfc7515#section-4.1.10 also:https://tools.ietf.org/html/rfc7519#section-5.2 </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Enc"> <summary> see:https://tools.ietf.org/html/rfc7516#section-4.1.2 </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.IV"> <summary> see:https://tools.ietf.org/html/rfc7518#section-4.7.1.1 </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Jku"> <summary> see:https://tools.ietf.org/html/rfc7515#section-4.1.2 </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Jwk"> <summary> see:https://tools.ietf.org/html/rfc7515#section-4.1.3 </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Kid"> <summary> see:https://tools.ietf.org/html/rfc7515#section-4.1.4 </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Typ"> <summary> see:https://tools.ietf.org/html/rfc7515#section-4.1.9 also:https://tools.ietf.org/html/rfc7519#section-5.1 </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.X5c"> <summary> see:https://tools.ietf.org/html/rfc7515#section-4.1.6 </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.X5t"> <summary> see:https://tools.ietf.org/html/rfc7515#page-12 </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.X5u"> <summary> see:https://tools.ietf.org/html/rfc7515#section-4.1.5 </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Zip"> <summary> see:https://tools.ietf.org/html/rfc7516#section-4.1.3 </summary> </member> <member name="T:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames"> <summary> List of registered claims from different sources http://tools.ietf.org/html/rfc7519#section-4 http://openid.net/specs/openid-connect-core-1_0.html#IDToken </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Actort"> <summary> </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Acr"> <summary> http://openid.net/specs/openid-connect-core-1_0.html#IDToken </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Amr"> <summary> http://openid.net/specs/openid-connect-core-1_0.html#IDToken </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Aud"> <summary> http://tools.ietf.org/html/rfc7519#section-4 </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.AuthTime"> <summary> http://openid.net/specs/openid-connect-core-1_0.html#IDToken </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Azp"> <summary> http://openid.net/specs/openid-connect-core-1_0.html#IDToken </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Birthdate"> <summary> https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.CHash"> <summary> https://openid.net/specs/openid-connect-core-1_0.html#HybridIDToken </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.AtHash"> <summary> http://openid.net/specs/openid-connect-core-1_0.html#CodeIDToken </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Email"> <summary> https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Exp"> <summary> http://tools.ietf.org/html/rfc7519#section-4 </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Gender"> <summary> https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.FamilyName"> <summary> https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.GivenName"> <summary> https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Iat"> <summary> http://tools.ietf.org/html/rfc7519#section-4 </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Iss"> <summary> http://tools.ietf.org/html/rfc7519#section-4 </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Jti"> <summary> http://tools.ietf.org/html/rfc7519#section-4 </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Name"> <summary> https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.NameId"> <summary> </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Nonce"> <summary> https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Nbf"> <summary> http://tools.ietf.org/html/rfc7519#section-4 </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.PhoneNumber"> <summary> https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.PhoneNumberVerified"> <summary> https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Prn"> <summary> </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Sid"> <summary> http://openid.net/specs/openid-connect-frontchannel-1_0.html#OPLogout </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Sub"> <summary> http://tools.ietf.org/html/rfc7519#section-4 </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Typ"> <summary> https://tools.ietf.org/html/rfc7519#section-5 </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.UniqueName"> <summary> </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Website"> <summary> </summary> </member> <member name="T:Microsoft.IdentityModel.JsonWebTokens.JwtTokenDecryptionParameters"> <summary> Represents the parameters needed to decrypt a JSON Web Token </summary> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JwtTokenDecryptionParameters.Alg"> <summary> Gets or sets signature algorithm that was used to create the signature. </summary> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JwtTokenDecryptionParameters.AuthenticationTag"> <summary> Gets or sets the AuthenticationTag from the original raw data of this instance when it was created. </summary> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JwtTokenDecryptionParameters.Ciphertext"> <summary> Gets or sets the Ciphertext from the original raw data of this instance when it was created. </summary> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JwtTokenDecryptionParameters.DecompressionFunction"> <summary> Gets or sets the function used to attempt decompression with. </summary> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JwtTokenDecryptionParameters.Enc"> <summary> Gets or sets the encryption algorithm (Enc) of the token. </summary> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JwtTokenDecryptionParameters.EncodedHeader"> <summary> Gets the EncodedHeader from the original raw data of this instance when it was created. </summary> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JwtTokenDecryptionParameters.EncodedToken"> <summary> Gets or sets the EncodedHeader from the original raw data of this instance when it was created. </summary> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JwtTokenDecryptionParameters.InitializationVector"> <summary> Gets or sets the InitializationVector from the original raw data of this instance when it was created. </summary> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JwtTokenDecryptionParameters.Keys"> <summary> Gets or sets the collection of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>s to attempt to decrypt with. </summary> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.JwtTokenDecryptionParameters.Zip"> <summary> Gets or sets the 'value' of the 'zip' claim. </summary> </member> <member name="T:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities"> <summary> A class which contains useful methods for processing JWT tokens. </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.RegexJws"> <summary> Regex that is used to figure out if a token is in JWS format. </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.RegexJwe"> <summary> Regex that is used to figure out if a token is in JWE format. </summary> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.CreateEncodedSignature(System.String,Microsoft.IdentityModel.Tokens.SigningCredentials)"> <summary> Produces a signature over the 'input'. </summary> <param name="input">String to be signed</param> <param name="signingCredentials">The <see cref="T:Microsoft.IdentityModel.Tokens.SigningCredentials"/> that contain crypto specs used to sign the token.</param> <returns>The bse64urlendcoded signature over the bytes obtained from UTF8Encoding.GetBytes( 'input' ).</returns> <exception cref="T:System.ArgumentNullException">'input' or 'signingCredentials' is null.</exception> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.CreateEncodedSignature(System.String,Microsoft.IdentityModel.Tokens.SigningCredentials,System.Boolean)"> <summary> Produces a signature over the 'input'. </summary> <param name="input">String to be signed</param> <param name="signingCredentials">The <see cref="T:Microsoft.IdentityModel.Tokens.SigningCredentials"/> that contain crypto specs used to sign the token.</param> <param name="cacheProvider">should the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> be cached.</param> <returns>The bse64urlendcoded signature over the bytes obtained from UTF8Encoding.GetBytes( 'input' ).</returns> <exception cref="T:System.ArgumentNullException">'input' or 'signingCredentials' is null.</exception> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.DecompressToken(System.Byte[],System.String)"> <summary> Decompress JWT token bytes. </summary> <param name="tokenBytes"></param> <param name="algorithm"></param> <exception cref="T:System.ArgumentNullException">if <paramref name="tokenBytes"/> is null.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="algorithm"/> is null.</exception> <exception cref="T:System.NotSupportedException">if the decompression <paramref name="algorithm"/> is not supported.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecompressionFailedException">if decompression using <paramref name="algorithm"/> fails.</exception> <returns>Decompressed JWT token</returns> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.DecryptJwtToken(Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters,Microsoft.IdentityModel.JsonWebTokens.JwtTokenDecryptionParameters)"> <summary> Decrypts a Json Web Token. </summary> <param name="jwtToken">The Json Web Token</param> <param name="validationParameters">The validation parameters containing cryptographic material.</param> <param name="decryptionParameters">The decryption parameters container.</param> <returns>The decrypted, and if the 'zip' claim is set, decompressed string representation of the token.</returns> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.GenerateKeyBytes(System.Int32)"> <summary> Generates key bytes. </summary> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.GetAllDecryptionKeys(Microsoft.IdentityModel.Tokens.TokenValidationParameters)"> <summary> Gets all decryption keys. </summary> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.GetDateTime(System.String,Microsoft.IdentityModel.Json.Linq.JObject)"> <summary> Gets the DateTime using the number of seconds from 1970-01-01T0:0:0Z (UTC) </summary> <param name="key">Claim in the payload that should map to an integer, float, or string.</param> <param name="payload">The payload that contains the desired claim value.</param> <remarks>If the claim is not found, the function returns: DateTime.MinValue </remarks> <exception cref="T:System.FormatException">If the value of the claim cannot be parsed into a long.</exception> <returns>The DateTime representation of a claim.</returns> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.ResolveTokenSigningKeyWithConfig(System.String,System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters)"> <summary> Returns a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use when validating the signature of a token. </summary> <param name="kid">The <see cref="T:System.String"/> kid field of the token being validated</param> <param name="x5t">The <see cref="T:System.String"/> x5t field of the token being validated</param> <param name="validationParameters">A <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param> <returns>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> </member> <member name="M:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.ResolveTokenSigningKey(System.String,System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters)"> <summary> Returns a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use when validating the signature of a token. </summary> <param name="kid">The <see cref="T:System.String"/> kid field of the token being validated</param> <param name="x5t">The <see cref="T:System.String"/> x5t field of the token being validated</param> <param name="validationParameters">A <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param> <returns>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> </member> <member name="T:Microsoft.IdentityModel.JsonWebTokens.LogMessages"> <summary> Log messages and codes </summary> </member> </members> </doc> |