Microsoft.IdentityModel.JsonWebTokens.xml 53 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.IdentityModel.JsonWebTokens</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.IdentityModel.JsonWebTokens.JsonClaimValueTypes">
  8. <summary>
  9. Constants for Json Web tokens.
  10. </summary>
  11. </member>
  12. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JsonClaimValueTypes.Json">
  13. <summary>
  14. A URI that represents the JSON XML data type.
  15. </summary>
  16. <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>
  17. </member>
  18. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JsonClaimValueTypes.JsonArray">
  19. <summary>
  20. A URI that represents the JSON array XML data type.
  21. </summary>
  22. <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>
  23. </member>
  24. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JsonClaimValueTypes.JsonNull">
  25. <summary>
  26. A URI that represents the JSON null data type
  27. </summary>
  28. <remarks>When mapping json to .Net Claim(s), we use empty string to represent the claim value and set the ClaimValueType to JsonNull</remarks>
  29. </member>
  30. <member name="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken">
  31. <summary>
  32. A <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> designed for representing a JSON Web Token (JWT).
  33. </summary>
  34. </member>
  35. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String)">
  36. <summary>
  37. Initializes a new instance of <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/> from a string in JWS or JWE Compact serialized format.
  38. </summary>
  39. <param name="jwtEncodedString">A JSON Web Token that has been serialized in JWS or JWE Compact serialized format.</param>
  40. <exception cref="T:System.ArgumentNullException">'jwtEncodedString' is null or empty.</exception>
  41. <exception cref="T:System.ArgumentException">'jwtEncodedString' is not in JWS or JWE Compact serialization format.</exception>
  42. <remarks>
  43. 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"/>
  44. </remarks>
  45. </member>
  46. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String,System.String)">
  47. <summary>
  48. 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.
  49. </summary>
  50. <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>
  51. <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>
  52. <exception cref="T:System.ArgumentNullException">'header' is null.</exception>
  53. <exception cref="T:System.ArgumentNullException">'payload' is null.</exception>
  54. </member>
  55. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Actor">
  56. <summary>
  57. Gets the 'value' of the 'actort' claim { actort, 'value' }.
  58. </summary>
  59. <remarks>If the 'actort' claim is not found, an empty string is returned.</remarks>
  60. </member>
  61. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Alg">
  62. <summary>
  63. Gets the 'value' of the 'alg' claim { alg, 'value' }.
  64. </summary>
  65. <remarks>If the 'alg' claim is not found, an empty string is returned.</remarks>
  66. </member>
  67. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Audiences">
  68. <summary>
  69. Gets the list of 'aud' claim { aud, 'value' }.
  70. </summary>
  71. <remarks>If the 'aud' claim is not found, enumeration will be empty.</remarks>
  72. </member>
  73. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.AuthenticationTag">
  74. <summary>
  75. Gets the AuthenticationTag from the original raw data of this instance when it was created.
  76. </summary>
  77. <remarks>The original JSON Compact serialized format passed into the constructor. <see cref="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String)"/></remarks>
  78. </member>
  79. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Ciphertext">
  80. <summary>
  81. Gets the Ciphertext from the original raw data of this instance when it was created.
  82. </summary>
  83. <remarks>The original JSON Compact serialized format passed into the constructor. <see cref="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String)"/></remarks>
  84. </member>
  85. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Claims">
  86. <summary>
  87. Gets a <see cref="T:System.Collections.Generic.IEnumerable`1"/><see cref="T:System.Security.Claims.Claim"/> for each JSON { name, value }.
  88. </summary>
  89. </member>
  90. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Cty">
  91. <summary>
  92. Gets the 'value' of the 'cty' claim { cty, 'value' }.
  93. </summary>
  94. <remarks>If the 'cty' claim is not found, an empty string is returned.</remarks>
  95. </member>
  96. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Enc">
  97. <summary>
  98. Gets the 'value' of the 'enc' claim { enc, 'value' }.
  99. </summary>
  100. <remarks>If the 'enc' value is not found, an empty string is returned.</remarks>
  101. </member>
  102. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.EncryptedKey">
  103. <summary>
  104. Gets the EncryptedKey from the original raw data of this instance when it was created.
  105. </summary>
  106. <remarks>The original JSON Compact serialized format passed into the constructor. <see cref="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String)"/></remarks>
  107. </member>
  108. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Header">
  109. <summary>
  110. Represents the cryptographic operations applied to the JWT and optionally any additional properties of the JWT.
  111. </summary>
  112. </member>
  113. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Id">
  114. <summary>
  115. Gets the 'value' of the 'jti' claim { jti, ''value' }.
  116. </summary>
  117. <remarks>If the 'jti' claim is not found, an empty string is returned.</remarks>
  118. </member>
  119. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.InitializationVector">
  120. <summary>
  121. Gets the InitializationVector from the original raw data of this instance when it was created.
  122. </summary>
  123. <remarks>The original JSON Compact serialized format passed into the constructor. <see cref="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String)"/></remarks>
  124. </member>
  125. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.InnerToken">
  126. <summary>
  127. Gets the <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/> associated with this instance.
  128. </summary>
  129. </member>
  130. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.IssuedAt">
  131. <summary>
  132. 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).
  133. </summary>
  134. <remarks>If the 'iat' claim is not found, then <see cref="F:System.DateTime.MinValue"/> is returned.</remarks>
  135. </member>
  136. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Issuer">
  137. <summary>
  138. Gets the 'value' of the 'iss' claim { iss, 'value' }.
  139. </summary>
  140. <remarks>If the 'iss' claim is not found, an empty string is returned.</remarks>
  141. </member>
  142. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Kid">
  143. <summary>
  144. Gets the 'value' of the 'kid' claim { kid, 'value' }.
  145. </summary>
  146. <remarks>If the 'kid' claim is not found, an empty string is returned.</remarks>
  147. </member>
  148. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Payload">
  149. <summary>
  150. Represents the JSON payload.
  151. </summary>
  152. </member>
  153. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.EncodedHeader">
  154. <summary>
  155. Gets the EncodedHeader from the original raw data of this instance when it was created.
  156. </summary>
  157. <remarks>The original JSON Compact serialized format passed into the constructor. <see cref="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String)"/></remarks>
  158. </member>
  159. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.EncodedPayload">
  160. <summary>
  161. Gets the EncodedPayload from the original raw data of this instance when it was created.
  162. </summary>
  163. <remarks>The original JSON Compact serialized format passed into the constructor. <see cref="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String)"/></remarks>
  164. </member>
  165. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.EncodedSignature">
  166. <summary>
  167. Gets the EncodedSignature from the original raw data of this instance when it was created.
  168. </summary>
  169. <remarks>The original JSON Compact serialized format passed into the constructor. <see cref="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String)"/></remarks>
  170. </member>
  171. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.EncodedToken">
  172. <summary>
  173. Gets the original raw data of this instance when it was created.
  174. </summary>
  175. </member>
  176. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.SecurityKey">
  177. <summary>
  178. Not implemented.
  179. </summary>
  180. </member>
  181. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.SigningKey">
  182. <summary>
  183. Not implemented.
  184. </summary>
  185. </member>
  186. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Subject">
  187. <summary>
  188. Gets the 'value' of the 'sub' claim { sub, 'value' }.
  189. </summary>
  190. <remarks>If the 'sub' claim is not found, an empty string is returned.</remarks>
  191. </member>
  192. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Typ">
  193. <summary>
  194. Gets the 'value' of the 'typ' claim { typ, 'value' }.
  195. </summary>
  196. <remarks>If the 'typ' claim is not found, an empty string is returned.</remarks>
  197. </member>
  198. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.ValidFrom">
  199. <summary>
  200. 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).
  201. </summary>
  202. <remarks>If the 'nbf' claim is not found, then <see cref="F:System.DateTime.MinValue"/> is returned.</remarks>
  203. </member>
  204. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.ValidTo">
  205. <summary>
  206. 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).
  207. </summary>
  208. <remarks>If the 'exp' claim is not found, then <see cref="F:System.DateTime.MinValue"/> is returned.</remarks>
  209. </member>
  210. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.X5t">
  211. <summary>
  212. Gets the 'value' of the 'x5t' claim { x5t, 'value' }.
  213. </summary>
  214. <remarks>If the 'x5t' claim is not found, an empty string is returned.</remarks>
  215. </member>
  216. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Zip">
  217. <summary>
  218. Gets the 'value' of the 'zip' claim { zip, 'value' }.
  219. </summary>
  220. <remarks>If the 'zip' claim is not found, an empty string is returned.</remarks>
  221. </member>
  222. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Decode(System.String[],System.String)">
  223. <summary>
  224. Decodes the string into the header, payload and signature.
  225. </summary>
  226. <param name="tokenParts">the tokenized string.</param>
  227. <param name="rawData">the original token.</param>
  228. </member>
  229. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.DecodeJwe(System.String[])">
  230. <summary>
  231. Decodes the payload and signature from the JWE parts.
  232. </summary>
  233. <param name="tokenParts">Parts of the JWE including the header.</param>
  234. <remarks>Assumes Header has already been set.</remarks>
  235. </member>
  236. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.DecodeJws(System.String[])">
  237. <summary>
  238. Decodes the payload and signature from the JWS parts.
  239. </summary>
  240. <param name="tokenParts">Parts of the JWS including the header.</param>
  241. <remarks>Assumes Header has already been set.</remarks>
  242. </member>
  243. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.GetClaim(System.String)">
  244. <summary>
  245. Gets a <see cref="T:System.Security.Claims.Claim"/> representing the { key, 'value' } pair corresponding to the provided <paramref name="key"/>.
  246. </summary>
  247. <remarks>If the key has no corresponding value, this method will throw.</remarks>
  248. </member>
  249. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.GetPayloadValue``1(System.String)">
  250. <summary>
  251. Gets the 'value' corresponding to the provided key from the JWT payload { key, 'value' }.
  252. </summary>
  253. <remarks>If the key has no corresponding value, this method will throw. </remarks>
  254. </member>
  255. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.TryGetClaim(System.String,System.Security.Claims.Claim@)">
  256. <summary>
  257. Tries to get the <see cref="T:System.Security.Claims.Claim"/> representing the { key, 'value' } pair corresponding to the provided <paramref name="key"/>.
  258. </summary>
  259. <remarks>If the key has no corresponding value, returns false. Otherwise returns true. </remarks>
  260. </member>
  261. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.TryGetPayloadValue``1(System.String,``0@)">
  262. <summary>
  263. Tries to get the 'value' corresponding to the provided key from the JWT payload { key, 'value' }.
  264. </summary>
  265. <remarks>If the key has no corresponding value, returns false. Otherwise returns true. </remarks>
  266. </member>
  267. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.GetHeaderValue``1(System.String)">
  268. <summary>
  269. Gets the 'value' corresponding to the provided key from the JWT header { key, 'value' }.
  270. </summary>
  271. <remarks>If the key has no corresponding value, this method will throw. </remarks>
  272. </member>
  273. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.TryGetHeaderValue``1(System.String,``0@)">
  274. <summary>
  275. Tries to get the value corresponding to the provided key from the JWT header { key, 'value' }.
  276. </summary>
  277. <remarks>If the key has no corresponding value, returns false. Otherwise returns true. </remarks>
  278. </member>
  279. <member name="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler">
  280. <summary>
  281. A <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenHandler"/> designed for creating and validating Json Web Tokens.
  282. See: http://tools.ietf.org/html/rfc7519 and http://www.rfc-editor.org/info/rfc7515.
  283. </summary>
  284. </member>
  285. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.TokenType">
  286. <summary>
  287. Gets the type of the <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/>.
  288. </summary>
  289. <return>The type of <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/></return>
  290. </member>
  291. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CanReadToken(System.String)">
  292. <summary>
  293. Determines if the string is a well formed Json Web Token (JWT).
  294. <para>see: http://tools.ietf.org/html/rfc7519 </para>
  295. </summary>
  296. <param name="token">String that should represent a valid JWT.</param>
  297. <remarks>Uses <see cref="M:System.Text.RegularExpressions.Regex.IsMatch(System.String,System.String)"/> matching:
  298. <para>JWS: @"^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]*$"</para>
  299. <para>JWE: (dir): @"^[A-Za-z0-9-_]+\.\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]*$"</para>
  300. <para>JWE: (wrappedkey): @"^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]$"</para>
  301. </remarks>
  302. <returns>
  303. <para>'false' if the token is null or whitespace.</para>
  304. <para>'false' if token.Length is greater than <see cref="P:Microsoft.IdentityModel.Tokens.TokenHandler.MaximumTokenSizeInBytes"/>.</para>
  305. <para>'true' if the token is in JSON compact serialization format.</para>
  306. </returns>
  307. </member>
  308. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CanValidateToken">
  309. <summary>
  310. Returns a value that indicates if this handler can validate a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.
  311. </summary>
  312. <returns>'true', indicating this instance can validate a <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/>.</returns>
  313. </member>
  314. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.SigningCredentials)">
  315. <summary>
  316. Creates a JWS (Json Web Signature).
  317. </summary>
  318. <param name="payload">A string containing JSON which represents the JWT token payload.</param>
  319. <param name="signingCredentials">Defines the security key and algorithm that will be used to sign the JWS.</param>
  320. <returns>A JWS in Compact Serialization Format.</returns>
  321. </member>
  322. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor)">
  323. <summary>
  324. Creates a JWS(Json Web Signature).
  325. </summary>
  326. <param name="tokenDescriptor">A <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor"/> that contains details of contents of the token.</param>
  327. <returns>A JWS in Compact Serialization Format.</returns>
  328. </member>
  329. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.SigningCredentials,Microsoft.IdentityModel.Tokens.EncryptingCredentials)">
  330. <summary>
  331. Creates a JWE (Json Web Encryption).
  332. </summary>
  333. <param name="payload">A string containing JSON which represents the JWT token payload.</param>
  334. <param name="signingCredentials">Defines the security key and algorithm that will be used to sign the JWT.</param>
  335. <param name="encryptingCredentials">Defines the security key and algorithm that will be used to encrypt the JWT.</param>
  336. <returns>A JWE in compact serialization format.</returns>
  337. </member>
  338. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.SigningCredentials,Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.String)">
  339. <summary>
  340. Creates a JWE (Json Web Encryption).
  341. </summary>
  342. <param name="payload">A string containing JSON which represents the JWT token payload.</param>
  343. <param name="signingCredentials">Defines the security key and algorithm that will be used to sign the JWT.</param>
  344. <param name="encryptingCredentials">Defines the security key and algorithm that will be used to encrypt the JWT.</param>
  345. <param name="compressionAlgorithm">Defines the compression algorithm that will be used to compress the JWT token payload.</param>
  346. <returns>A JWE in compact serialization format.</returns>
  347. </member>
  348. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CompressToken(System.String,System.String)">
  349. <summary>
  350. Compress a JWT token string.
  351. </summary>
  352. <param name="token"></param>
  353. <param name="algorithm"></param>
  354. <exception cref="T:System.ArgumentNullException">if 'token' is null.</exception>
  355. <exception cref="T:System.ArgumentNullException">if 'algorithm' is null.</exception>
  356. <exception cref="T:System.NotSupportedException">if the compression algorithm is not supported.</exception>
  357. <returns>Compressed JWT token bytes.</returns>
  358. </member>
  359. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateClaimsIdentity(Microsoft.IdentityModel.JsonWebTokens.JsonWebToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
  360. <summary>
  361. Creates a <see cref="T:System.Security.Claims.ClaimsIdentity"/> from a <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/>.
  362. </summary>
  363. <param name="jwtToken">The <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/> to use as a <see cref="T:System.Security.Claims.Claim"/> source.</param>
  364. <param name="validationParameters"> Contains parameters for validating the token.</param>
  365. <returns>A <see cref="T:System.Security.Claims.ClaimsIdentity"/> containing the <see cref="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Claims"/>.</returns>
  366. </member>
  367. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.DecryptToken(Microsoft.IdentityModel.JsonWebTokens.JsonWebToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
  368. <summary>
  369. Decrypts a JWE and returns the clear text
  370. </summary>
  371. <param name="jwtToken">the JWE that contains the cypher text.</param>
  372. <param name="validationParameters">contains crypto material.</param>
  373. <returns>the decoded / cleartext contents of the JWE.</returns>
  374. <exception cref="T:System.ArgumentNullException">if 'jwtToken' is null.</exception>
  375. <exception cref="T:System.ArgumentNullException">if 'validationParameters' is null.</exception>
  376. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException">if 'jwtToken.Enc' is null or empty.</exception>
  377. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecompressionFailedException">if decompression failed.</exception>
  378. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException">if 'jwtToken.Kid' is not null AND decryption fails.</exception>
  379. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException">if the JWE was not able to be decrypted.</exception>
  380. </member>
  381. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.EncryptToken(System.String,Microsoft.IdentityModel.Tokens.EncryptingCredentials)">
  382. <summary>
  383. Encrypts a JWS.
  384. </summary>
  385. <param name="innerJwt">A 'JSON Web Token' (JWT) in JWS Compact Serialization Format.</param>
  386. <param name="encryptingCredentials">Defines the security key and algorithm that will be used to encrypt the <paramref name="innerJwt"/>.</param>
  387. <exception cref="T:System.ArgumentNullException">if <paramref name="innerJwt"/> is null or empty.</exception>
  388. <exception cref="T:System.ArgumentNullException">if <paramref name="encryptingCredentials"/> is null.</exception>
  389. <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>
  390. <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>
  391. <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>
  392. <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>
  393. <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>
  394. </member>
  395. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.EncryptToken(System.String,Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.String)">
  396. <summary>
  397. Encrypts a JWS.
  398. </summary>
  399. <param name="innerJwt">A 'JSON Web Token' (JWT) in JWS Compact Serialization Format.</param>
  400. <param name="encryptingCredentials">Defines the security key and algorithm that will be used to encrypt the <paramref name="innerJwt"/>.</param>
  401. <param name="algorithm">Defines the compression algorithm that will be used to compress the 'innerJwt'.</param>
  402. <exception cref="T:System.ArgumentNullException">if <paramref name="innerJwt"/> is null or empty.</exception>
  403. <exception cref="T:System.ArgumentNullException">if <paramref name="encryptingCredentials"/> is null.</exception>
  404. <exception cref="T:System.ArgumentNullException">if 'algorithm' is null or empty.</exception>
  405. <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>
  406. <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>
  407. <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>
  408. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenCompressionFailedException">if compression using 'algorithm' fails.</exception>
  409. <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>
  410. <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>
  411. </member>
  412. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ResolveIssuerSigningKey(Microsoft.IdentityModel.JsonWebTokens.JsonWebToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
  413. <summary>
  414. Returns a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use when validating the signature of a token.
  415. </summary>
  416. <param name="jwtToken">The <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/> that is being validated.</param>
  417. <param name="validationParameters">A <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param>
  418. <returns>Returns a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use for signature validation.</returns>
  419. <remarks>If key fails to resolve, then null is returned</remarks>
  420. </member>
  421. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ResolveTokenDecryptionKey(System.String,Microsoft.IdentityModel.JsonWebTokens.JsonWebToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
  422. <summary>
  423. Returns a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use when decrypting a JWE.
  424. </summary>
  425. <param name="token">The <see cref="T:System.String"/> the token that is being decrypted.</param>
  426. <param name="jwtToken">The <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/> that is being decrypted.</param>
  427. <param name="validationParameters">A <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param>
  428. <returns>Returns a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use for signature validation.</returns>
  429. <remarks>If key fails to resolve, then null is returned</remarks>
  430. </member>
  431. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ReadJsonWebToken(System.String)">
  432. <summary>
  433. Converts a string into an instance of <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/>.
  434. </summary>
  435. <param name="token">A 'JSON Web Token' (JWT) in JWS or JWE Compact Serialization Format.</param>
  436. <returns>A <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/></returns>
  437. <exception cref="T:System.ArgumentNullException">'token' is null or empty.</exception>
  438. <exception cref="T:System.ArgumentException">'token.Length' is greater than <see cref="P:Microsoft.IdentityModel.Tokens.TokenHandler.MaximumTokenSizeInBytes"/>.</exception>
  439. <remarks><para>If the 'token' is in JWE Compact Serialization format, only the protected header will be deserialized.</para>
  440. 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>
  441. </member>
  442. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ReadToken(System.String)">
  443. <summary>
  444. Converts a string into an instance of <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/>.
  445. </summary>
  446. <param name="token">A 'JSON Web Token' (JWT) in JWS or JWE Compact Serialization Format.</param>
  447. <returns>A <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/></returns>
  448. <exception cref="T:System.ArgumentNullException">'token' is null or empty.</exception>
  449. <exception cref="T:System.ArgumentException">'token.Length' is greater than <see cref="P:Microsoft.IdentityModel.Tokens.TokenHandler.MaximumTokenSizeInBytes"/>.</exception>
  450. </member>
  451. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ValidateToken(System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
  452. <summary>
  453. Validates a JWS or a JWE.
  454. </summary>
  455. <param name="token">A 'JSON Web Token' (JWT) in JWS or JWE Compact Serialization Format.</param>
  456. <param name="validationParameters">A <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param>
  457. <returns>A <see cref="T:Microsoft.IdentityModel.JsonWebTokens.TokenValidationResult"/></returns>
  458. </member>
  459. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ValidateSignature(System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
  460. <summary>
  461. Validates the JWT signature.
  462. </summary>
  463. </member>
  464. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ValidateSignature(System.Byte[],System.Byte[],Microsoft.IdentityModel.Tokens.SecurityKey,System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
  465. <summary>
  466. Obtains a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> and validates the signature.
  467. </summary>
  468. <param name="encodedBytes">Bytes to validate.</param>
  469. <param name="signature">Signature to compare against.</param>
  470. <param name="key"><See cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use.</param>
  471. <param name="algorithm">Crypto algorithm to use.</param>
  472. <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>
  473. <returns>'true' if signature is valid.</returns>
  474. </member>
  475. <member name="T:Microsoft.IdentityModel.JsonWebTokens.JwtConstants">
  476. <summary>
  477. Constants for Json Web Tokens.
  478. </summary>
  479. </member>
  480. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.HeaderType">
  481. <summary>
  482. Short header type.
  483. </summary>
  484. </member>
  485. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.HeaderTypeAlt">
  486. <summary>
  487. Long header type.
  488. </summary>
  489. </member>
  490. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.TokenType">
  491. <summary>
  492. Short token type.
  493. </summary>
  494. </member>
  495. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.TokenTypeAlt">
  496. <summary>
  497. Long token type.
  498. </summary>
  499. </member>
  500. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.JsonCompactSerializationRegex">
  501. <summary>
  502. JWS - Token format: 'header.payload.signature'. Signature is optional, but '.' is required.
  503. </summary>
  504. </member>
  505. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.JweCompactSerializationRegex">
  506. <summary>
  507. JWE - Token format: 'protectedheader.encryptedkey.iv.cyphertext.authenticationtag'.
  508. </summary>
  509. </member>
  510. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.JweSegmentCount">
  511. <summary>
  512. The number of parts in a JWE token.
  513. </summary>
  514. </member>
  515. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.JwsSegmentCount">
  516. <summary>
  517. The number of parts in a JWS token.
  518. </summary>
  519. </member>
  520. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.MaxJwtSegmentCount">
  521. <summary>
  522. The maximum number of parts in a JWT.
  523. </summary>
  524. </member>
  525. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.DirectKeyUseAlg">
  526. <summary>
  527. JWE header alg indicating a shared symmetric key is directly used as CEK.
  528. </summary>
  529. </member>
  530. <member name="T:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames">
  531. <summary>
  532. List of header parameter names see: http://tools.ietf.org/html/rfc7519#section-5.
  533. </summary>
  534. </member>
  535. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Alg">
  536. <summary>
  537. see:https://tools.ietf.org/html/rfc7515#section-4.1.1
  538. </summary>
  539. </member>
  540. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Cty">
  541. <summary>
  542. see:https://tools.ietf.org/html/rfc7515#section-4.1.10
  543. also:https://tools.ietf.org/html/rfc7519#section-5.2
  544. </summary>
  545. </member>
  546. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Enc">
  547. <summary>
  548. see:https://tools.ietf.org/html/rfc7516#section-4.1.2
  549. </summary>
  550. </member>
  551. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.IV">
  552. <summary>
  553. see:https://tools.ietf.org/html/rfc7518#section-4.7.1.1
  554. </summary>
  555. </member>
  556. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Jku">
  557. <summary>
  558. see:https://tools.ietf.org/html/rfc7515#section-4.1.2
  559. </summary>
  560. </member>
  561. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Jwk">
  562. <summary>
  563. see:https://tools.ietf.org/html/rfc7515#section-4.1.3
  564. </summary>
  565. </member>
  566. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Kid">
  567. <summary>
  568. see:https://tools.ietf.org/html/rfc7515#section-4.1.4
  569. </summary>
  570. </member>
  571. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Typ">
  572. <summary>
  573. see:https://tools.ietf.org/html/rfc7515#section-4.1.9
  574. also:https://tools.ietf.org/html/rfc7519#section-5.1
  575. </summary>
  576. </member>
  577. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.X5c">
  578. <summary>
  579. see:https://tools.ietf.org/html/rfc7515#section-4.1.6
  580. </summary>
  581. </member>
  582. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.X5t">
  583. <summary>
  584. see:https://tools.ietf.org/html/rfc7515#page-12
  585. </summary>
  586. </member>
  587. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.X5u">
  588. <summary>
  589. see:https://tools.ietf.org/html/rfc7515#section-4.1.5
  590. </summary>
  591. </member>
  592. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Zip">
  593. <summary>
  594. see:https://tools.ietf.org/html/rfc7516#section-4.1.3
  595. </summary>
  596. </member>
  597. <member name="T:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames">
  598. <summary>
  599. List of registered claims from different sources
  600. http://tools.ietf.org/html/rfc7519#section-4
  601. http://openid.net/specs/openid-connect-core-1_0.html#IDToken
  602. </summary>
  603. </member>
  604. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Actort">
  605. <summary>
  606. http://tools.ietf.org/html/rfc7519#section-4
  607. </summary>
  608. </member>
  609. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Acr">
  610. <summary>
  611. http://openid.net/specs/openid-connect-core-1_0.html#IDToken
  612. </summary>
  613. </member>
  614. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Amr">
  615. <summary>
  616. http://openid.net/specs/openid-connect-core-1_0.html#IDToken
  617. </summary>
  618. </member>
  619. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Aud">
  620. <summary>
  621. http://tools.ietf.org/html/rfc7519#section-4
  622. </summary>
  623. </member>
  624. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.AuthTime">
  625. <summary>
  626. http://openid.net/specs/openid-connect-core-1_0.html#IDToken
  627. </summary>
  628. </member>
  629. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Azp">
  630. <summary>
  631. http://openid.net/specs/openid-connect-core-1_0.html#IDToken
  632. </summary>
  633. </member>
  634. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Birthdate">
  635. <summary>
  636. http://tools.ietf.org/html/rfc7519#section-4
  637. </summary>
  638. </member>
  639. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.CHash">
  640. <summary>
  641. http://tools.ietf.org/html/rfc7519#section-4
  642. </summary>
  643. </member>
  644. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.AtHash">
  645. <summary>
  646. http://openid.net/specs/openid-connect-core-1_0.html#CodeIDToken
  647. </summary>
  648. </member>
  649. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Email">
  650. <summary>
  651. http://tools.ietf.org/html/rfc7519#section-4
  652. </summary>
  653. </member>
  654. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Exp">
  655. <summary>
  656. http://tools.ietf.org/html/rfc7519#section-4
  657. </summary>
  658. </member>
  659. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Gender">
  660. <summary>
  661. http://tools.ietf.org/html/rfc7519#section-4
  662. </summary>
  663. </member>
  664. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.FamilyName">
  665. <summary>
  666. http://tools.ietf.org/html/rfc7519#section-4
  667. </summary>
  668. </member>
  669. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.GivenName">
  670. <summary>
  671. http://tools.ietf.org/html/rfc7519#section-4
  672. </summary>
  673. </member>
  674. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Iat">
  675. <summary>
  676. http://tools.ietf.org/html/rfc7519#section-4
  677. </summary>
  678. </member>
  679. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Iss">
  680. <summary>
  681. http://tools.ietf.org/html/rfc7519#section-4
  682. </summary>
  683. </member>
  684. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Jti">
  685. <summary>
  686. http://tools.ietf.org/html/rfc7519#section-4
  687. </summary>
  688. </member>
  689. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.NameId">
  690. <summary>
  691. http://tools.ietf.org/html/rfc7519#section-4
  692. </summary>
  693. </member>
  694. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Nonce">
  695. <summary>
  696. http://tools.ietf.org/html/rfc7519#section-4
  697. </summary>
  698. </member>
  699. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Nbf">
  700. <summary>
  701. http://tools.ietf.org/html/rfc7519#section-4
  702. </summary>
  703. </member>
  704. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Prn">
  705. <summary>
  706. http://tools.ietf.org/html/rfc7519#section-4
  707. </summary>
  708. </member>
  709. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Sid">
  710. <summary>
  711. http://openid.net/specs/openid-connect-frontchannel-1_0.html#OPLogout
  712. </summary>
  713. </member>
  714. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Sub">
  715. <summary>
  716. http://tools.ietf.org/html/rfc7519#section-4
  717. </summary>
  718. </member>
  719. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Typ">
  720. <summary>
  721. http://tools.ietf.org/html/rfc7519#section-4
  722. </summary>
  723. </member>
  724. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.UniqueName">
  725. <summary>
  726. http://tools.ietf.org/html/rfc7519#section-4
  727. </summary>
  728. </member>
  729. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Website">
  730. <summary>
  731. http://tools.ietf.org/html/rfc7519#section-4
  732. </summary>
  733. </member>
  734. <member name="T:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities">
  735. <summary>
  736. A class which contains useful methods for processing JWT tokens.
  737. </summary>
  738. </member>
  739. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.RegexJws">
  740. <summary>
  741. Regex that is used to figure out if a token is in JWS format.
  742. </summary>
  743. </member>
  744. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.RegexJwe">
  745. <summary>
  746. Regex that is used to figure out if a token is in JWE format.
  747. </summary>
  748. </member>
  749. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.CreateEncodedSignature(System.String,Microsoft.IdentityModel.Tokens.SigningCredentials)">
  750. <summary>
  751. Produces a signature over the 'input'.
  752. </summary>
  753. <param name="input">String to be signed</param>
  754. <param name="signingCredentials">The <see cref="T:Microsoft.IdentityModel.Tokens.SigningCredentials"/> that contain crypto specs used to sign the token.</param>
  755. <returns>The bse64urlendcoded signature over the bytes obtained from UTF8Encoding.GetBytes( 'input' ).</returns>
  756. <exception cref="T:System.ArgumentNullException">'input' or 'signingCredentials' is null.</exception>
  757. </member>
  758. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.DecompressToken(System.Byte[],System.String)">
  759. <summary>
  760. Decompress JWT token bytes.
  761. </summary>
  762. <param name="tokenBytes"></param>
  763. <param name="algorithm"></param>
  764. <exception cref="T:System.ArgumentNullException">if <paramref name="tokenBytes"/> is null.</exception>
  765. <exception cref="T:System.ArgumentNullException">if <paramref name="algorithm"/> is null.</exception>
  766. <exception cref="T:System.NotSupportedException">if the decompression <paramref name="algorithm"/> is not supported.</exception>
  767. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecompressionFailedException">if decompression using <paramref name="algorithm"/> fails.</exception>
  768. <returns>Decompressed JWT token</returns>
  769. </member>
  770. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.FindKeyMatch(System.String,System.String,Microsoft.IdentityModel.Tokens.SecurityKey,System.Collections.Generic.IEnumerable{Microsoft.IdentityModel.Tokens.SecurityKey})">
  771. <summary>
  772. Has extra code for X509SecurityKey keys where the kid or x5t match in a case insensitive manner.
  773. </summary>
  774. <param name="kid"></param>
  775. <param name="x5t"></param>
  776. <param name="securityKey"></param>
  777. <param name="keys"></param>
  778. <returns>a key if found, null otherwise.</returns>
  779. </member>
  780. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.GenerateKeyBytes(System.Int32)">
  781. <summary>
  782. Generates key bytes.
  783. </summary>
  784. </member>
  785. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.GetAllDecryptionKeys(Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
  786. <summary>
  787. Gets all decryption keys.
  788. </summary>
  789. </member>
  790. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.GetDateTime(System.String,Newtonsoft.Json.Linq.JObject)">
  791. <summary>
  792. Gets the DateTime using the number of seconds from 1970-01-01T0:0:0Z (UTC)
  793. </summary>
  794. <param name="key">Claim in the payload that should map to an integer, float, or string.</param>
  795. <param name="payload">The payload that contains the desired claim value.</param>
  796. <remarks>If the claim is not found, the function returns: DateTime.MinValue
  797. </remarks>
  798. <exception cref="T:System.FormatException">If the value of the claim cannot be parsed into a long.</exception>
  799. <returns>The DateTime representation of a claim.</returns>
  800. </member>
  801. <member name="T:Microsoft.IdentityModel.JsonWebTokens.LogMessages">
  802. <summary>
  803. Log messages and codes
  804. </summary>
  805. </member>
  806. <member name="T:Microsoft.IdentityModel.JsonWebTokens.TokenValidationResult">
  807. <summary>
  808. Contains artifacts obtained when a SecurityToken is validated.
  809. </summary>
  810. </member>
  811. <member name="P:Microsoft.IdentityModel.JsonWebTokens.TokenValidationResult.ClaimsIdentity">
  812. <summary>
  813. The <see cref="P:Microsoft.IdentityModel.JsonWebTokens.TokenValidationResult.ClaimsIdentity"/> created from the validated security token.
  814. </summary>
  815. </member>
  816. <member name="P:Microsoft.IdentityModel.JsonWebTokens.TokenValidationResult.Exception">
  817. <summary>
  818. Gets or sets the <see cref="P:Microsoft.IdentityModel.JsonWebTokens.TokenValidationResult.Exception"/> that occurred during validation.
  819. </summary>
  820. </member>
  821. <member name="P:Microsoft.IdentityModel.JsonWebTokens.TokenValidationResult.Issuer">
  822. <summary>
  823. Gets or sets the issuer that was found in the token.
  824. </summary>
  825. </member>
  826. <member name="P:Microsoft.IdentityModel.JsonWebTokens.TokenValidationResult.IsValid">
  827. <summary>
  828. True if the token was successfully validated, false otherwise.
  829. </summary>
  830. </member>
  831. <member name="P:Microsoft.IdentityModel.JsonWebTokens.TokenValidationResult.SecurityToken">
  832. <summary>
  833. Gets or sets the <see cref="P:Microsoft.IdentityModel.JsonWebTokens.TokenValidationResult.SecurityToken"/> that was validated.
  834. </summary>
  835. </member>
  836. <member name="P:Microsoft.IdentityModel.JsonWebTokens.TokenValidationResult.TokenContext">
  837. <summary>
  838. Gets or sets the <see cref="P:Microsoft.IdentityModel.JsonWebTokens.TokenValidationResult.TokenContext"/> that contains call information.
  839. </summary>
  840. </member>
  841. <member name="P:Microsoft.IdentityModel.JsonWebTokens.TokenValidationResult.TokenType">
  842. <summary>
  843. Gets or sets the token type of the <see cref="P:Microsoft.IdentityModel.JsonWebTokens.TokenValidationResult.SecurityToken"/> that was validated.
  844. </summary>
  845. </member>
  846. </members>
  847. </doc>