Microsoft.IdentityModel.JsonWebTokens.xml
|
<?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.</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.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, returns null. </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, returns null. </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="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,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> <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.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> <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> <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="algorithm"></param> <exception cref="T:System.ArgumentNullException">if 'token' is null.</exception> <exception cref="T:System.ArgumentNullException">if 'algorithm' 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.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 'tokenBytes' is null.</exception> <exception cref="T:System.ArgumentNullException">if 'algorithm' is null.</exception> <exception cref="T:System.NotSupportedException">if the decompression algorithm is not supported.</exception> <returns>Decompressed JWT token</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 'jwtToken' is null.</exception> <exception cref="T:System.ArgumentNullException">if 'validationParameters' is null.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException">if '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 '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.ResolveIssuerSigningKey(Microsoft.IdentityModel.JsonWebTokens.JsonWebToken,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="jwtToken">The <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/> that is 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.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.JsonWebTokens.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.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="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> http://tools.ietf.org/html/rfc7519#section-4 </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> http://tools.ietf.org/html/rfc7519#section-4 </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.CHash"> <summary> http://tools.ietf.org/html/rfc7519#section-4 </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> http://tools.ietf.org/html/rfc7519#section-4 </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> http://tools.ietf.org/html/rfc7519#section-4 </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.FamilyName"> <summary> http://tools.ietf.org/html/rfc7519#section-4 </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.GivenName"> <summary> http://tools.ietf.org/html/rfc7519#section-4 </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.NameId"> <summary> http://tools.ietf.org/html/rfc7519#section-4 </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Nonce"> <summary> http://tools.ietf.org/html/rfc7519#section-4 </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.Prn"> <summary> http://tools.ietf.org/html/rfc7519#section-4 </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> http://tools.ietf.org/html/rfc7519#section-4 </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.UniqueName"> <summary> http://tools.ietf.org/html/rfc7519#section-4 </summary> </member> <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Website"> <summary> http://tools.ietf.org/html/rfc7519#section-4 </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.FindKeyMatch(System.String,System.String,Microsoft.IdentityModel.Tokens.SecurityKey,System.Collections.Generic.IEnumerable{Microsoft.IdentityModel.Tokens.SecurityKey})"> <summary> Has extra code for X509SecurityKey keys where the kid or x5t match in a case insensitive manner. </summary> <param name="kid"></param> <param name="x5t"></param> <param name="securityKey"></param> <param name="keys"></param> <returns>a key if found, null otherwise.</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,Newtonsoft.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="T:Microsoft.IdentityModel.JsonWebTokens.LogMessages"> <summary> Log messages and codes </summary> </member> <member name="T:Microsoft.IdentityModel.JsonWebTokens.TokenValidationResult"> <summary> Contains artifacts obtained when a SecurityToken is validated. </summary> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.TokenValidationResult.ClaimsIdentity"> <summary> The <see cref="P:Microsoft.IdentityModel.JsonWebTokens.TokenValidationResult.ClaimsIdentity"/> created from the validated security token. </summary> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.TokenValidationResult.Exception"> <summary> Gets or sets the <see cref="P:Microsoft.IdentityModel.JsonWebTokens.TokenValidationResult.Exception"/> that occurred during validation. </summary> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.TokenValidationResult.Issuer"> <summary> Gets or sets the issuer that was found in the token. </summary> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.TokenValidationResult.IsValid"> <summary> True if the token was successfully validated, false otherwise. </summary> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.TokenValidationResult.SecurityToken"> <summary> Gets or sets the <see cref="P:Microsoft.IdentityModel.JsonWebTokens.TokenValidationResult.SecurityToken"/> that was validated. </summary> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.TokenValidationResult.TokenContext"> <summary> Gets or sets the <see cref="P:Microsoft.IdentityModel.JsonWebTokens.TokenValidationResult.TokenContext"/> that contains call information. </summary> </member> <member name="P:Microsoft.IdentityModel.JsonWebTokens.TokenValidationResult.TokenType"> <summary> Gets or sets the token type of the <see cref="P:Microsoft.IdentityModel.JsonWebTokens.TokenValidationResult.SecurityToken"/> that was validated. </summary> </member> </members> </doc> |