Index

A B C D E G H I J K N O P R S T V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

acceptExpiresAt(long) - Method in interface com.auth0.jwt.interfaces.Verification
 
acceptExpiresAt(long) - Method in class com.auth0.jwt.JWTVerifier.BaseVerification
Set a specific leeway window in seconds in which the Expires At ("exp") Claim will still be valid.
acceptIssuedAt(long) - Method in interface com.auth0.jwt.interfaces.Verification
 
acceptIssuedAt(long) - Method in class com.auth0.jwt.JWTVerifier.BaseVerification
Set a specific leeway window in seconds in which the Issued At ("iat") Claim will still be valid.
acceptLeeway(long) - Method in interface com.auth0.jwt.interfaces.Verification
 
acceptLeeway(long) - Method in class com.auth0.jwt.JWTVerifier.BaseVerification
Define the default window in seconds in which the Not Before, Issued At and Expires At Claims will still be valid.
acceptNotBefore(long) - Method in interface com.auth0.jwt.interfaces.Verification
 
acceptNotBefore(long) - Method in class com.auth0.jwt.JWTVerifier.BaseVerification
Set a specific leeway window in seconds in which the Not Before ("nbf") Claim will still be valid.
addClaim(String, Object) - Method in class com.auth0.jwt.JWTCreator.Builder
 
addDeserializers(ObjectMapper) - Method in class com.auth0.jwt.impl.JWTParser
 
addLeewayToDateClaims() - Method in class com.auth0.jwt.JWTVerifier.BaseVerification
 
algorithm - Variable in class com.auth0.jwt.impl.BasicHeader
 
algorithm - Variable in class com.auth0.jwt.JWTCreator
 
algorithm - Variable in class com.auth0.jwt.JWTVerifier
 
algorithm - Variable in class com.auth0.jwt.JWTVerifier.BaseVerification
 
Algorithm - Class in com.auth0.jwt.algorithms
The Algorithm class represents an algorithm to be used in the Signing or Verification process of a Token.
Algorithm(String, String) - Constructor for class com.auth0.jwt.algorithms.Algorithm
 
ALGORITHM - Static variable in interface com.auth0.jwt.impl.PublicClaims
 
AlgorithmMismatchException - Exception Class in com.auth0.jwt.exceptions
 
AlgorithmMismatchException(String) - Constructor for exception class com.auth0.jwt.exceptions.AlgorithmMismatchException
 
as(Class<T>) - Method in class com.auth0.jwt.impl.JsonNodeClaim
 
as(Class<T>) - Method in class com.auth0.jwt.impl.NullClaim
 
as(Class<T>) - Method in interface com.auth0.jwt.interfaces.Claim
Get this Claim as a custom type T.
asArray(Class<T>) - Method in class com.auth0.jwt.impl.JsonNodeClaim
 
asArray(Class<T>) - Method in class com.auth0.jwt.impl.NullClaim
 
asArray(Class<T>) - Method in interface com.auth0.jwt.interfaces.Claim
Get this Claim as an Array of type T.
asBoolean() - Method in class com.auth0.jwt.impl.JsonNodeClaim
 
asBoolean() - Method in class com.auth0.jwt.impl.NullClaim
 
asBoolean() - Method in interface com.auth0.jwt.interfaces.Claim
Get this Claim as a Boolean.
asDate() - Method in class com.auth0.jwt.impl.JsonNodeClaim
 
asDate() - Method in class com.auth0.jwt.impl.NullClaim
 
asDate() - Method in interface com.auth0.jwt.interfaces.Claim
Get this Claim as a Date.
asDouble() - Method in class com.auth0.jwt.impl.JsonNodeClaim
 
asDouble() - Method in class com.auth0.jwt.impl.NullClaim
 
asDouble() - Method in interface com.auth0.jwt.interfaces.Claim
Get this Claim as a Double.
asInt() - Method in class com.auth0.jwt.impl.JsonNodeClaim
 
asInt() - Method in class com.auth0.jwt.impl.NullClaim
 
asInt() - Method in interface com.auth0.jwt.interfaces.Claim
Get this Claim as an Integer.
asList(Class<T>) - Method in class com.auth0.jwt.impl.JsonNodeClaim
 
asList(Class<T>) - Method in class com.auth0.jwt.impl.NullClaim
 
asList(Class<T>) - Method in interface com.auth0.jwt.interfaces.Claim
Get this Claim as a List of type T.
asLong() - Method in class com.auth0.jwt.impl.JsonNodeClaim
 
asLong() - Method in class com.auth0.jwt.impl.NullClaim
 
asLong() - Method in interface com.auth0.jwt.interfaces.Claim
Get this Claim as an Long.
asMap() - Method in class com.auth0.jwt.impl.JsonNodeClaim
 
asMap() - Method in class com.auth0.jwt.impl.NullClaim
 
asMap() - Method in interface com.auth0.jwt.interfaces.Claim
Get this Claim as a generic Map of values.
assertDateIsFuture(Date, long, Date) - Method in class com.auth0.jwt.JWTVerifier
 
assertDateIsPast(Date, long, Date) - Method in class com.auth0.jwt.JWTVerifier
 
assertNonNull(String) - Method in class com.auth0.jwt.JWTCreator.Builder
 
assertNonNull(String) - Method in class com.auth0.jwt.JWTVerifier.BaseVerification
 
assertPositive(long) - Method in class com.auth0.jwt.JWTVerifier.BaseVerification
 
assertValidAudienceClaim(List<String>, List<String>) - Method in class com.auth0.jwt.JWTVerifier
 
assertValidClaim(Claim, String, Object) - Method in class com.auth0.jwt.JWTVerifier
 
assertValidDateClaim(Date, long, boolean) - Method in class com.auth0.jwt.JWTVerifier
 
assertValidIssuerClaim(String, List<String>) - Method in class com.auth0.jwt.JWTVerifier
 
assertValidStringClaim(String, String, String) - Method in class com.auth0.jwt.JWTVerifier
 
asString() - Method in class com.auth0.jwt.impl.JsonNodeClaim
 
asString() - Method in class com.auth0.jwt.impl.NullClaim
 
asString() - Method in interface com.auth0.jwt.interfaces.Claim
Get this Claim as a String.
audience - Variable in class com.auth0.jwt.impl.PayloadImpl
 
AUDIENCE - Static variable in interface com.auth0.jwt.impl.PublicClaims
 

B

BaseVerification(Algorithm) - Constructor for class com.auth0.jwt.JWTVerifier.BaseVerification
 
BasicHeader - Class in com.auth0.jwt.impl
The BasicHeader class implements the Header interface.
BasicHeader(String, String, String, String, Map<String, JsonNode>, ObjectReader) - Constructor for class com.auth0.jwt.impl.BasicHeader
 
build() - Method in interface com.auth0.jwt.interfaces.Verification
 
build() - Method in class com.auth0.jwt.JWTVerifier.BaseVerification
Creates a new and reusable instance of the JWTVerifier with the configuration already provided.
build(Clock) - Method in class com.auth0.jwt.JWTVerifier.BaseVerification
Creates a new and reusable instance of the JWTVerifier with the configuration already provided.
Builder() - Constructor for class com.auth0.jwt.JWTCreator.Builder
 

C

Claim - Interface in com.auth0.jwt.interfaces
The Claim class holds the value in a generic way so that it can be recovered in many representations.
claimFromNode(JsonNode, ObjectReader) - Static method in class com.auth0.jwt.impl.JsonNodeClaim
Helper method to create a Claim representation from the given JsonNode.
claims - Variable in class com.auth0.jwt.impl.ClaimsHolder
 
claims - Variable in class com.auth0.jwt.JWTVerifier.BaseVerification
 
claims - Variable in class com.auth0.jwt.JWTVerifier
 
ClaimsHolder - Class in com.auth0.jwt.impl
The ClaimsHolder class is just a wrapper for the Map of Claims used for building a JWT.
ClaimsHolder(Map<String, Object>) - Constructor for class com.auth0.jwt.impl.ClaimsHolder
 
clock - Variable in class com.auth0.jwt.JWTVerifier
 
Clock - Interface in com.auth0.jwt.interfaces
The Clock class is used to wrap calls to Date class.
ClockImpl - Class in com.auth0.jwt
 
ClockImpl() - Constructor for class com.auth0.jwt.ClockImpl
 
com.auth0.jwt - package com.auth0.jwt
 
com.auth0.jwt.algorithms - package com.auth0.jwt.algorithms
 
com.auth0.jwt.exceptions - package com.auth0.jwt.exceptions
 
com.auth0.jwt.impl - package com.auth0.jwt.impl
 
com.auth0.jwt.interfaces - package com.auth0.jwt.interfaces
 
CONTENT_TYPE - Static variable in interface com.auth0.jwt.impl.PublicClaims
 
contentType - Variable in class com.auth0.jwt.impl.BasicHeader
 
countPadding(byte[], int, int) - Method in class com.auth0.jwt.algorithms.ECDSAAlgorithm
 
create() - Static method in class com.auth0.jwt.JWT
Returns a Json Web Token builder used to create and sign tokens
createSignatureFor(String, byte[], byte[]) - Method in class com.auth0.jwt.algorithms.CryptoHelper
Deprecated.
rather use corresponding method which takes header and payload as separate inputs
createSignatureFor(String, byte[], byte[], byte[]) - Method in class com.auth0.jwt.algorithms.CryptoHelper
Create signature for JWT header and payload.
createSignatureFor(String, PrivateKey, byte[]) - Method in class com.auth0.jwt.algorithms.CryptoHelper
Deprecated.
rather use corresponding method which takes header and payload as separate inputs
createSignatureFor(String, PrivateKey, byte[], byte[]) - Method in class com.auth0.jwt.algorithms.CryptoHelper
Create signature for JWT header and payload using a private key.
crypto - Variable in class com.auth0.jwt.algorithms.ECDSAAlgorithm
 
crypto - Variable in class com.auth0.jwt.algorithms.HMACAlgorithm
 
crypto - Variable in class com.auth0.jwt.algorithms.RSAAlgorithm
 
CryptoHelper - Class in com.auth0.jwt.algorithms
 
CryptoHelper() - Constructor for class com.auth0.jwt.algorithms.CryptoHelper
 

D

data - Variable in class com.auth0.jwt.impl.JsonNodeClaim
 
dateToSeconds(Date) - Method in class com.auth0.jwt.impl.PayloadSerializer
 
decode(String) - Static method in class com.auth0.jwt.JWT
Decode a given Json Web Token.
DecodedJWT - Interface in com.auth0.jwt.interfaces
Class that represents a Json Web Token that was decoded from it's string representation.
decodeException() - Static method in class com.auth0.jwt.impl.JWTParser
 
decodeException(String) - Static method in class com.auth0.jwt.impl.JWTParser
 
decodeJwt(String) - Method in class com.auth0.jwt.JWT
Decode a given Json Web Token.
defaultLeeway - Variable in class com.auth0.jwt.JWTVerifier.BaseVerification
 
DERToJOSE(byte[]) - Method in class com.auth0.jwt.algorithms.ECDSAAlgorithm
 
description - Variable in class com.auth0.jwt.algorithms.Algorithm
 
deserialize(JsonParser, DeserializationContext) - Method in class com.auth0.jwt.impl.HeaderDeserializer
 
deserialize(JsonParser, DeserializationContext) - Method in class com.auth0.jwt.impl.PayloadDeserializer
 

E

ECDSA256(ECDSAKeyProvider) - Static method in class com.auth0.jwt.algorithms.Algorithm
Creates a new Algorithm instance using SHA256withECDSA.
ECDSA256(ECKey) - Static method in class com.auth0.jwt.algorithms.Algorithm
ECDSA256(ECPublicKey, ECPrivateKey) - Static method in class com.auth0.jwt.algorithms.Algorithm
Creates a new Algorithm instance using SHA256withECDSA.
ECDSA384(ECDSAKeyProvider) - Static method in class com.auth0.jwt.algorithms.Algorithm
Creates a new Algorithm instance using SHA384withECDSA.
ECDSA384(ECKey) - Static method in class com.auth0.jwt.algorithms.Algorithm
ECDSA384(ECPublicKey, ECPrivateKey) - Static method in class com.auth0.jwt.algorithms.Algorithm
Creates a new Algorithm instance using SHA384withECDSA.
ECDSA512(ECDSAKeyProvider) - Static method in class com.auth0.jwt.algorithms.Algorithm
Creates a new Algorithm instance using SHA512withECDSA.
ECDSA512(ECKey) - Static method in class com.auth0.jwt.algorithms.Algorithm
ECDSA512(ECPublicKey, ECPrivateKey) - Static method in class com.auth0.jwt.algorithms.Algorithm
Creates a new Algorithm instance using SHA512withECDSA.
ECDSAAlgorithm - Class in com.auth0.jwt.algorithms
 
ECDSAAlgorithm(CryptoHelper, String, String, int, ECDSAKeyProvider) - Constructor for class com.auth0.jwt.algorithms.ECDSAAlgorithm
 
ECDSAAlgorithm(String, String, int, ECDSAKeyProvider) - Constructor for class com.auth0.jwt.algorithms.ECDSAAlgorithm
 
ECDSAKeyProvider - Interface in com.auth0.jwt.interfaces
Elliptic Curve (EC) Public/Private Key provider.
ecNumberSize - Variable in class com.auth0.jwt.algorithms.ECDSAAlgorithm
 
EXPIRES_AT - Static variable in interface com.auth0.jwt.impl.PublicClaims
 
expiresAt - Variable in class com.auth0.jwt.impl.PayloadImpl
 
extractClaim(String, Map<String, JsonNode>, ObjectReader) - Static method in class com.auth0.jwt.impl.JsonNodeClaim
Helper method to extract a Claim from the given JsonNode tree.

G

getAlgorithm() - Method in class com.auth0.jwt.impl.BasicHeader
 
getAlgorithm() - Method in interface com.auth0.jwt.interfaces.Header
Getter for the Algorithm "alg" claim defined in the JWT's Header.
getAlgorithm() - Method in class com.auth0.jwt.JWTDecoder
 
getAudience() - Method in class com.auth0.jwt.impl.PayloadImpl
 
getAudience() - Method in interface com.auth0.jwt.interfaces.Payload
Get the value of the "aud" claim, or null if it's not available.
getAudience() - Method in class com.auth0.jwt.JWTDecoder
 
getClaim(String) - Method in class com.auth0.jwt.impl.PayloadImpl
 
getClaim(String) - Method in interface com.auth0.jwt.interfaces.Payload
Get a Claim given it's name.
getClaim(String) - Method in class com.auth0.jwt.JWTDecoder
 
getClaims() - Method in class com.auth0.jwt.impl.ClaimsHolder
 
getClaims() - Method in class com.auth0.jwt.impl.PayloadImpl
 
getClaims() - Method in interface com.auth0.jwt.interfaces.Payload
Get the Claims defined in the Token.
getClaims() - Method in class com.auth0.jwt.JWTDecoder
 
getContentType() - Method in class com.auth0.jwt.impl.BasicHeader
 
getContentType() - Method in interface com.auth0.jwt.interfaces.Header
Getter for the Content Type "cty" claim defined in the JWT's Header.
getContentType() - Method in class com.auth0.jwt.JWTDecoder
 
getDateFromSeconds(Map<String, JsonNode>, String) - Method in class com.auth0.jwt.impl.PayloadDeserializer
 
getDefaultObjectMapper() - Static method in class com.auth0.jwt.impl.JWTParser
 
getDescription() - Method in class com.auth0.jwt.algorithms.Algorithm
Getter for the description of this Algorithm, required when instantiating a Mac or Signature object.
getExpiresAt() - Method in class com.auth0.jwt.impl.PayloadImpl
 
getExpiresAt() - Method in interface com.auth0.jwt.interfaces.Payload
Get the value of the "exp" claim, or null if it's not available.
getExpiresAt() - Method in class com.auth0.jwt.JWTDecoder
 
getHeader() - Method in interface com.auth0.jwt.interfaces.DecodedJWT
Getter for the Header contained in the JWT as a Base64 encoded String.
getHeader() - Method in class com.auth0.jwt.JWTDecoder
 
getHeaderClaim(String) - Method in class com.auth0.jwt.impl.BasicHeader
 
getHeaderClaim(String) - Method in interface com.auth0.jwt.interfaces.Header
Get a Private Claim given it's name.
getHeaderClaim(String) - Method in class com.auth0.jwt.JWTDecoder
 
getId() - Method in class com.auth0.jwt.impl.PayloadImpl
 
getId() - Method in interface com.auth0.jwt.interfaces.Payload
Get the value of the "jti" claim, or null if it's not available.
getId() - Method in class com.auth0.jwt.JWTDecoder
 
getIssuedAt() - Method in class com.auth0.jwt.impl.PayloadImpl
 
getIssuedAt() - Method in interface com.auth0.jwt.interfaces.Payload
Get the value of the "iat" claim, or null if it's not available.
getIssuedAt() - Method in class com.auth0.jwt.JWTDecoder
 
getIssuer() - Method in class com.auth0.jwt.impl.PayloadImpl
 
getIssuer() - Method in interface com.auth0.jwt.interfaces.Payload
Get the value of the "iss" claim, or null if it's not available.
getIssuer() - Method in class com.auth0.jwt.JWTDecoder
 
getKeyId() - Method in class com.auth0.jwt.impl.BasicHeader
 
getKeyId() - Method in interface com.auth0.jwt.interfaces.Header
Get the value of the "kid" claim, or null if it's not available.
getKeyId() - Method in class com.auth0.jwt.JWTDecoder
 
getName() - Method in class com.auth0.jwt.algorithms.Algorithm
Getter for the name of this Algorithm, as defined in the JWT Standard.
getNotBefore() - Method in class com.auth0.jwt.impl.PayloadImpl
 
getNotBefore() - Method in interface com.auth0.jwt.interfaces.Payload
Get the value of the "nbf" claim, or null if it's not available.
getNotBefore() - Method in class com.auth0.jwt.JWTDecoder
 
getPayload() - Method in interface com.auth0.jwt.interfaces.DecodedJWT
Getter for the Payload contained in the JWT as a Base64 encoded String.
getPayload() - Method in class com.auth0.jwt.JWTDecoder
 
getPrivateKey() - Method in interface com.auth0.jwt.interfaces.KeyProvider
Getter for the Private Key instance.
getPrivateKeyId() - Method in interface com.auth0.jwt.interfaces.KeyProvider
Getter for the Id of the Private Key used to sign the tokens.
getPublicKeyById(String) - Method in interface com.auth0.jwt.interfaces.KeyProvider
Getter for the Public Key instance with the given Id.
getSecretBytes(String) - Static method in class com.auth0.jwt.algorithms.HMACAlgorithm
 
getSignature() - Method in interface com.auth0.jwt.interfaces.DecodedJWT
Getter for the Signature contained in the JWT as a Base64 encoded String.
getSignature() - Method in class com.auth0.jwt.JWTDecoder
 
getSigningKeyId() - Method in class com.auth0.jwt.algorithms.Algorithm
Getter for the Id of the Private Key used to sign the tokens.
getSigningKeyId() - Method in class com.auth0.jwt.algorithms.ECDSAAlgorithm
 
getSigningKeyId() - Method in class com.auth0.jwt.algorithms.RSAAlgorithm
 
getString(Map<String, JsonNode>, String) - Method in class com.auth0.jwt.impl.HeaderDeserializer
 
getString(Map<String, JsonNode>, String) - Method in class com.auth0.jwt.impl.PayloadDeserializer
 
getStringOrArray(Map<String, JsonNode>, String) - Method in class com.auth0.jwt.impl.PayloadDeserializer
 
getSubject() - Method in class com.auth0.jwt.impl.PayloadImpl
 
getSubject() - Method in interface com.auth0.jwt.interfaces.Payload
Get the value of the "sub" claim, or null if it's not available.
getSubject() - Method in class com.auth0.jwt.JWTDecoder
 
getToday() - Method in class com.auth0.jwt.ClockImpl
 
getToday() - Method in interface com.auth0.jwt.interfaces.Clock
Returns a new Date representing Today's time.
getToken() - Method in interface com.auth0.jwt.interfaces.DecodedJWT
Getter for the String Token used to create this JWT instance.
getToken() - Method in class com.auth0.jwt.JWTDecoder
 
getTree() - Method in class com.auth0.jwt.impl.BasicHeader
 
getTree() - Method in class com.auth0.jwt.impl.PayloadImpl
 
getType() - Method in class com.auth0.jwt.impl.BasicHeader
 
getType() - Method in interface com.auth0.jwt.interfaces.Header
Getter for the Type "typ" claim defined in the JWT's Header.
getType() - Method in class com.auth0.jwt.JWTDecoder
 

H

header - Variable in class com.auth0.jwt.JWTDecoder
 
Header - Interface in com.auth0.jwt.interfaces
The Header class represents the 1st part of the JWT, where the Header value is hold.
headerClaims - Variable in class com.auth0.jwt.JWTCreator.Builder
 
HeaderDeserializer - Class in com.auth0.jwt.impl
 
HeaderDeserializer(ObjectReader) - Constructor for class com.auth0.jwt.impl.HeaderDeserializer
 
HeaderDeserializer(Class<?>, ObjectReader) - Constructor for class com.auth0.jwt.impl.HeaderDeserializer
 
headerJson - Variable in class com.auth0.jwt.JWTCreator
 
headerReader - Variable in class com.auth0.jwt.impl.JWTParser
 
HMAC256(byte[]) - Static method in class com.auth0.jwt.algorithms.Algorithm
Creates a new Algorithm instance using HmacSHA256.
HMAC256(String) - Static method in class com.auth0.jwt.algorithms.Algorithm
Creates a new Algorithm instance using HmacSHA256.
HMAC384(byte[]) - Static method in class com.auth0.jwt.algorithms.Algorithm
Creates a new Algorithm instance using HmacSHA384.
HMAC384(String) - Static method in class com.auth0.jwt.algorithms.Algorithm
Creates a new Algorithm instance using HmacSHA384.
HMAC512(byte[]) - Static method in class com.auth0.jwt.algorithms.Algorithm
Creates a new Algorithm instance using HmacSHA512.
HMAC512(String) - Static method in class com.auth0.jwt.algorithms.Algorithm
Creates a new Algorithm instance using HmacSHA512.
HMACAlgorithm - Class in com.auth0.jwt.algorithms
 
HMACAlgorithm(CryptoHelper, String, String, byte[]) - Constructor for class com.auth0.jwt.algorithms.HMACAlgorithm
 
HMACAlgorithm(String, String, byte[]) - Constructor for class com.auth0.jwt.algorithms.HMACAlgorithm
 
HMACAlgorithm(String, String, String) - Constructor for class com.auth0.jwt.algorithms.HMACAlgorithm
 

I

ignoreIssuedAt - Variable in class com.auth0.jwt.JWTVerifier.BaseVerification
 
ignoreIssuedAt() - Method in interface com.auth0.jwt.interfaces.Verification
 
ignoreIssuedAt() - Method in class com.auth0.jwt.JWTVerifier.BaseVerification
Skip the Issued At ("iat") date verification.
init() - Static method in class com.auth0.jwt.JWTCreator
Initialize a JWTCreator instance.
init(Algorithm) - Static method in class com.auth0.jwt.JWTVerifier
Initialize a JWTVerifier instance using the given Algorithm.
InvalidClaimException - Exception Class in com.auth0.jwt.exceptions
 
InvalidClaimException(String) - Constructor for exception class com.auth0.jwt.exceptions.InvalidClaimException
 
isNull() - Method in class com.auth0.jwt.impl.JsonNodeClaim
 
isNull() - Method in class com.auth0.jwt.impl.NullClaim
 
isNull() - Method in interface com.auth0.jwt.interfaces.Claim
Whether this Claim has a null value or not.
ISSUED_AT - Static variable in interface com.auth0.jwt.impl.PublicClaims
 
issuedAt - Variable in class com.auth0.jwt.impl.PayloadImpl
 
issuer - Variable in class com.auth0.jwt.impl.PayloadImpl
 
ISSUER - Static variable in interface com.auth0.jwt.impl.PublicClaims
 

J

JOSEToDER(byte[]) - Method in class com.auth0.jwt.algorithms.ECDSAAlgorithm
 
JsonNodeClaim - Class in com.auth0.jwt.impl
The JsonNodeClaim retrieves a claim value from a JsonNode object.
JsonNodeClaim(JsonNode, ObjectReader) - Constructor for class com.auth0.jwt.impl.JsonNodeClaim
 
JWT - Class in com.auth0.jwt
 
JWT() - Constructor for class com.auth0.jwt.JWT
Constructs a new instance of the JWT library.
JWT_ID - Static variable in interface com.auth0.jwt.impl.PublicClaims
 
JWT_PART_SEPARATOR - Static variable in class com.auth0.jwt.algorithms.CryptoHelper
 
JWTCreationException - Exception Class in com.auth0.jwt.exceptions
 
JWTCreationException(String, Throwable) - Constructor for exception class com.auth0.jwt.exceptions.JWTCreationException
 
JWTCreator - Class in com.auth0.jwt
The JWTCreator class holds the sign method to generate a complete JWT (with Signature) from a given Header and Payload content.
JWTCreator(Algorithm, Map<String, Object>, Map<String, Object>) - Constructor for class com.auth0.jwt.JWTCreator
 
JWTCreator.Builder - Class in com.auth0.jwt
The Builder class holds the Claims that defines the JWT to be created.
JWTDecodeException - Exception Class in com.auth0.jwt.exceptions
 
JWTDecodeException(String) - Constructor for exception class com.auth0.jwt.exceptions.JWTDecodeException
 
JWTDecodeException(String, Throwable) - Constructor for exception class com.auth0.jwt.exceptions.JWTDecodeException
 
JWTDecoder - Class in com.auth0.jwt
The JWTDecoder class holds the decode method to parse a given JWT token into it's JWT representation.
JWTDecoder(JWTParser, String) - Constructor for class com.auth0.jwt.JWTDecoder
 
JWTDecoder(String) - Constructor for class com.auth0.jwt.JWTDecoder
 
jwtId - Variable in class com.auth0.jwt.impl.PayloadImpl
 
JWTParser - Class in com.auth0.jwt.impl
 
JWTParser() - Constructor for class com.auth0.jwt.impl.JWTParser
 
JWTParser(ObjectMapper) - Constructor for class com.auth0.jwt.impl.JWTParser
 
JWTPartsParser - Interface in com.auth0.jwt.interfaces
The JWTPartsParser class defines which parts of the JWT should be converted to it's specific Object representation instance.
JWTVerificationException - Exception Class in com.auth0.jwt.exceptions
 
JWTVerificationException(String) - Constructor for exception class com.auth0.jwt.exceptions.JWTVerificationException
 
JWTVerificationException(String, Throwable) - Constructor for exception class com.auth0.jwt.exceptions.JWTVerificationException
 
JWTVerifier - Class in com.auth0.jwt
The JWTVerifier class holds the verify method to assert that a given Token has not only a proper JWT format, but also it's signature matches.
JWTVerifier - Interface in com.auth0.jwt.interfaces
 
JWTVerifier(Algorithm, Map<String, Object>, Clock) - Constructor for class com.auth0.jwt.JWTVerifier
 
JWTVerifier.BaseVerification - Class in com.auth0.jwt
The Verification class holds the Claims required by a JWT to be valid.

K

KEY_ID - Static variable in interface com.auth0.jwt.impl.PublicClaims
 
keyId - Variable in class com.auth0.jwt.impl.BasicHeader
 
keyProvider - Variable in class com.auth0.jwt.algorithms.ECDSAAlgorithm
 
keyProvider - Variable in class com.auth0.jwt.algorithms.RSAAlgorithm
 
KeyProvider<U,R> - Interface in com.auth0.jwt.interfaces
Generic Public/Private Key provider.

N

name - Variable in class com.auth0.jwt.algorithms.Algorithm
 
none() - Static method in class com.auth0.jwt.algorithms.Algorithm
 
NoneAlgorithm - Class in com.auth0.jwt.algorithms
 
NoneAlgorithm() - Constructor for class com.auth0.jwt.algorithms.NoneAlgorithm
 
NOT_BEFORE - Static variable in interface com.auth0.jwt.impl.PublicClaims
 
notBefore - Variable in class com.auth0.jwt.impl.PayloadImpl
 
NullClaim - Class in com.auth0.jwt.impl
The NullClaim class is a Claim implementation that returns null when any of it's methods it's called.
NullClaim() - Constructor for class com.auth0.jwt.impl.NullClaim
 

O

objectReader - Variable in class com.auth0.jwt.impl.BasicHeader
 
objectReader - Variable in class com.auth0.jwt.impl.HeaderDeserializer
 
objectReader - Variable in class com.auth0.jwt.impl.JsonNodeClaim
 
objectReader - Variable in class com.auth0.jwt.impl.PayloadDeserializer
 
objectReader - Variable in class com.auth0.jwt.impl.PayloadImpl
 

P

parseHeader(String) - Method in class com.auth0.jwt.impl.JWTParser
 
parseHeader(String) - Method in interface com.auth0.jwt.interfaces.JWTPartsParser
Parses the given JSON into a Header instance.
parsePayload(String) - Method in class com.auth0.jwt.impl.JWTParser
 
parsePayload(String) - Method in interface com.auth0.jwt.interfaces.JWTPartsParser
Parses the given JSON into a Payload instance.
parser - Variable in class com.auth0.jwt.JWT
 
parser - Variable in class com.auth0.jwt.JWTVerifier
 
parts - Variable in class com.auth0.jwt.JWTDecoder
 
payload - Variable in class com.auth0.jwt.JWTDecoder
 
Payload - Interface in com.auth0.jwt.interfaces
The Payload class represents the 2nd part of the JWT, where the Payload value is hold.
payloadClaims - Variable in class com.auth0.jwt.JWTCreator.Builder
 
PayloadDeserializer - Class in com.auth0.jwt.impl
 
PayloadDeserializer(ObjectReader) - Constructor for class com.auth0.jwt.impl.PayloadDeserializer
 
PayloadDeserializer(Class<?>, ObjectReader) - Constructor for class com.auth0.jwt.impl.PayloadDeserializer
 
PayloadImpl - Class in com.auth0.jwt.impl
The PayloadImpl class implements the Payload interface.
PayloadImpl(String, String, List<String>, Date, Date, Date, String, Map<String, JsonNode>, ObjectReader) - Constructor for class com.auth0.jwt.impl.PayloadImpl
 
payloadJson - Variable in class com.auth0.jwt.JWTCreator
 
payloadReader - Variable in class com.auth0.jwt.impl.JWTParser
 
PayloadSerializer - Class in com.auth0.jwt.impl
 
PayloadSerializer() - Constructor for class com.auth0.jwt.impl.PayloadSerializer
 
PayloadSerializer(Class<ClaimsHolder>) - Constructor for class com.auth0.jwt.impl.PayloadSerializer
 
providerForKeys(ECPublicKey, ECPrivateKey) - Static method in class com.auth0.jwt.algorithms.ECDSAAlgorithm
 
providerForKeys(RSAPublicKey, RSAPrivateKey) - Static method in class com.auth0.jwt.algorithms.RSAAlgorithm
 
PublicClaims - Interface in com.auth0.jwt.impl
 

R

require(Algorithm) - Static method in class com.auth0.jwt.JWT
Returns a JWTVerifier builder with the algorithm to be used to validate token signature.
requireClaim(String, Object) - Method in class com.auth0.jwt.JWTVerifier.BaseVerification
 
RSA256(RSAKeyProvider) - Static method in class com.auth0.jwt.algorithms.Algorithm
Creates a new Algorithm instance using SHA256withRSA.
RSA256(RSAKey) - Static method in class com.auth0.jwt.algorithms.Algorithm
RSA256(RSAPublicKey, RSAPrivateKey) - Static method in class com.auth0.jwt.algorithms.Algorithm
Creates a new Algorithm instance using SHA256withRSA.
RSA384(RSAKeyProvider) - Static method in class com.auth0.jwt.algorithms.Algorithm
Creates a new Algorithm instance using SHA384withRSA.
RSA384(RSAKey) - Static method in class com.auth0.jwt.algorithms.Algorithm
RSA384(RSAPublicKey, RSAPrivateKey) - Static method in class com.auth0.jwt.algorithms.Algorithm
Creates a new Algorithm instance using SHA384withRSA.
RSA512(RSAKeyProvider) - Static method in class com.auth0.jwt.algorithms.Algorithm
Creates a new Algorithm instance using SHA512withRSA.
RSA512(RSAKey) - Static method in class com.auth0.jwt.algorithms.Algorithm
RSA512(RSAPublicKey, RSAPrivateKey) - Static method in class com.auth0.jwt.algorithms.Algorithm
Creates a new Algorithm instance using SHA512withRSA.
RSAAlgorithm - Class in com.auth0.jwt.algorithms
 
RSAAlgorithm(CryptoHelper, String, String, RSAKeyProvider) - Constructor for class com.auth0.jwt.algorithms.RSAAlgorithm
 
RSAAlgorithm(String, String, RSAKeyProvider) - Constructor for class com.auth0.jwt.algorithms.RSAAlgorithm
 
RSAKeyProvider - Interface in com.auth0.jwt.interfaces
RSA Public/Private Key provider.

S

secret - Variable in class com.auth0.jwt.algorithms.HMACAlgorithm
 
serialize(ClaimsHolder, JsonGenerator, SerializerProvider) - Method in class com.auth0.jwt.impl.PayloadSerializer
 
serialVersionUID - Static variable in exception class com.auth0.jwt.exceptions.TokenExpiredException
 
sign() - Method in class com.auth0.jwt.JWTCreator
 
sign(byte[]) - Method in class com.auth0.jwt.algorithms.Algorithm
Deprecated.
Please use the Algorithm.sign(byte[], byte[]) method instead.
sign(byte[]) - Method in class com.auth0.jwt.algorithms.ECDSAAlgorithm
Deprecated.
sign(byte[]) - Method in class com.auth0.jwt.algorithms.HMACAlgorithm
Deprecated.
sign(byte[]) - Method in class com.auth0.jwt.algorithms.NoneAlgorithm
Deprecated.
sign(byte[]) - Method in class com.auth0.jwt.algorithms.RSAAlgorithm
 
sign(byte[], byte[]) - Method in class com.auth0.jwt.algorithms.Algorithm
Sign the given content using this Algorithm instance.
sign(byte[], byte[]) - Method in class com.auth0.jwt.algorithms.ECDSAAlgorithm
 
sign(byte[], byte[]) - Method in class com.auth0.jwt.algorithms.HMACAlgorithm
 
sign(byte[], byte[]) - Method in class com.auth0.jwt.algorithms.NoneAlgorithm
 
sign(byte[], byte[]) - Method in class com.auth0.jwt.algorithms.RSAAlgorithm
Deprecated.
sign(Algorithm) - Method in class com.auth0.jwt.JWTCreator.Builder
Creates a new JWT and signs is with the given algorithm
SignatureGenerationException - Exception Class in com.auth0.jwt.exceptions
 
SignatureGenerationException(Algorithm, Throwable) - Constructor for exception class com.auth0.jwt.exceptions.SignatureGenerationException
 
SignatureVerificationException - Exception Class in com.auth0.jwt.exceptions
 
SignatureVerificationException(Algorithm) - Constructor for exception class com.auth0.jwt.exceptions.SignatureVerificationException
 
SignatureVerificationException(Algorithm, Throwable) - Constructor for exception class com.auth0.jwt.exceptions.SignatureVerificationException
 
splitToken(String) - Static method in class com.auth0.jwt.TokenUtils
Splits the given token on the "." chars into a String array with 3 parts.
subject - Variable in class com.auth0.jwt.impl.PayloadImpl
 
SUBJECT - Static variable in interface com.auth0.jwt.impl.PublicClaims
 

T

TokenExpiredException - Exception Class in com.auth0.jwt.exceptions
 
TokenExpiredException(String) - Constructor for exception class com.auth0.jwt.exceptions.TokenExpiredException
 
TokenUtils - Class in com.auth0.jwt
 
TokenUtils() - Constructor for class com.auth0.jwt.TokenUtils
 
toString() - Method in class com.auth0.jwt.algorithms.Algorithm
 
tree - Variable in class com.auth0.jwt.impl.BasicHeader
 
tree - Variable in class com.auth0.jwt.impl.PayloadImpl
 
type - Variable in class com.auth0.jwt.impl.BasicHeader
 
TYPE - Static variable in interface com.auth0.jwt.impl.PublicClaims
 

V

Verification - Interface in com.auth0.jwt.interfaces
 
verify(DecodedJWT) - Method in class com.auth0.jwt.algorithms.Algorithm
Verify the given token using this Algorithm instance.
verify(DecodedJWT) - Method in class com.auth0.jwt.algorithms.ECDSAAlgorithm
 
verify(DecodedJWT) - Method in class com.auth0.jwt.algorithms.HMACAlgorithm
 
verify(DecodedJWT) - Method in class com.auth0.jwt.algorithms.NoneAlgorithm
 
verify(DecodedJWT) - Method in class com.auth0.jwt.algorithms.RSAAlgorithm
 
verify(DecodedJWT) - Method in interface com.auth0.jwt.interfaces.JWTVerifier
Performs the verification against the given decoded JWT
verify(DecodedJWT) - Method in class com.auth0.jwt.JWTVerifier
Perform the verification against the given decoded JWT, using any previous configured options.
verify(String) - Method in interface com.auth0.jwt.interfaces.JWTVerifier
Performs the verification against the given Token
verify(String) - Method in class com.auth0.jwt.JWTVerifier
Perform the verification against the given Token, using any previous configured options.
verifyAlgorithm(DecodedJWT, Algorithm) - Method in class com.auth0.jwt.JWTVerifier
 
verifyClaims(DecodedJWT, Map<String, Object>) - Method in class com.auth0.jwt.JWTVerifier
 
verifySignatureFor(String, byte[], byte[], byte[]) - Method in class com.auth0.jwt.algorithms.CryptoHelper
Deprecated.
rather use corresponding method which takes header and payload as separate inputs
verifySignatureFor(String, byte[], byte[], byte[], byte[]) - Method in class com.auth0.jwt.algorithms.CryptoHelper
Verify signature for JWT header and payload.
verifySignatureFor(String, byte[], String, String, byte[]) - Method in class com.auth0.jwt.algorithms.CryptoHelper
Verify signature for JWT header and payload.
verifySignatureFor(String, PublicKey, byte[], byte[]) - Method in class com.auth0.jwt.algorithms.CryptoHelper
Deprecated.
rather use corresponding method which takes header and payload as separate inputs
verifySignatureFor(String, PublicKey, byte[], byte[], byte[]) - Method in class com.auth0.jwt.algorithms.CryptoHelper
Verify signature for JWT header and payload using a public key.
verifySignatureFor(String, PublicKey, String, String, byte[]) - Method in class com.auth0.jwt.algorithms.CryptoHelper
Verify signature for JWT header and payload.

W

withArrayClaim(String, Integer...) - Method in interface com.auth0.jwt.interfaces.Verification
 
withArrayClaim(String, Integer[]) - Method in class com.auth0.jwt.JWTCreator.Builder
Add a custom Array Claim with the given items.
withArrayClaim(String, Integer...) - Method in class com.auth0.jwt.JWTVerifier.BaseVerification
Require a specific Array Claim to contain at least the given items.
withArrayClaim(String, Long[]) - Method in class com.auth0.jwt.JWTCreator.Builder
Add a custom Array Claim with the given items.
withArrayClaim(String, String...) - Method in interface com.auth0.jwt.interfaces.Verification
 
withArrayClaim(String, String[]) - Method in class com.auth0.jwt.JWTCreator.Builder
Add a custom Array Claim with the given items.
withArrayClaim(String, String...) - Method in class com.auth0.jwt.JWTVerifier.BaseVerification
Require a specific Array Claim to contain at least the given items.
withAudience(String...) - Method in interface com.auth0.jwt.interfaces.Verification
 
withAudience(String...) - Method in class com.auth0.jwt.JWTCreator.Builder
Add a specific Audience ("aud") claim to the Payload.
withAudience(String...) - Method in class com.auth0.jwt.JWTVerifier.BaseVerification
Require a specific Audience ("aud") claim.
withClaim(String, Boolean) - Method in interface com.auth0.jwt.interfaces.Verification
 
withClaim(String, Boolean) - Method in class com.auth0.jwt.JWTCreator.Builder
Add a custom Claim value.
withClaim(String, Boolean) - Method in class com.auth0.jwt.JWTVerifier.BaseVerification
Require a specific Claim value.
withClaim(String, Double) - Method in interface com.auth0.jwt.interfaces.Verification
 
withClaim(String, Double) - Method in class com.auth0.jwt.JWTCreator.Builder
Add a custom Claim value.
withClaim(String, Double) - Method in class com.auth0.jwt.JWTVerifier.BaseVerification
Require a specific Claim value.
withClaim(String, Integer) - Method in interface com.auth0.jwt.interfaces.Verification
 
withClaim(String, Integer) - Method in class com.auth0.jwt.JWTCreator.Builder
Add a custom Claim value.
withClaim(String, Integer) - Method in class com.auth0.jwt.JWTVerifier.BaseVerification
Require a specific Claim value.
withClaim(String, Long) - Method in interface com.auth0.jwt.interfaces.Verification
 
withClaim(String, Long) - Method in class com.auth0.jwt.JWTCreator.Builder
Add a custom Claim value.
withClaim(String, Long) - Method in class com.auth0.jwt.JWTVerifier.BaseVerification
Require a specific Claim value.
withClaim(String, String) - Method in interface com.auth0.jwt.interfaces.Verification
 
withClaim(String, String) - Method in class com.auth0.jwt.JWTCreator.Builder
Add a custom Claim value.
withClaim(String, String) - Method in class com.auth0.jwt.JWTVerifier.BaseVerification
Require a specific Claim value.
withClaim(String, Date) - Method in interface com.auth0.jwt.interfaces.Verification
 
withClaim(String, Date) - Method in class com.auth0.jwt.JWTCreator.Builder
Add a custom Claim value.
withClaim(String, Date) - Method in class com.auth0.jwt.JWTVerifier.BaseVerification
Require a specific Claim value.
withExpiresAt(Date) - Method in class com.auth0.jwt.JWTCreator.Builder
Add a specific Expires At ("exp") claim to the Payload.
withHeader(Map<String, Object>) - Method in class com.auth0.jwt.JWTCreator.Builder
Add specific Claims to set as the Header.
withIssuedAt(Date) - Method in class com.auth0.jwt.JWTCreator.Builder
Add a specific Issued At ("iat") claim to the Payload.
withIssuer(String) - Method in class com.auth0.jwt.JWTCreator.Builder
Add a specific Issuer ("iss") claim to the Payload.
withIssuer(String...) - Method in interface com.auth0.jwt.interfaces.Verification
 
withIssuer(String...) - Method in class com.auth0.jwt.JWTVerifier.BaseVerification
Require a specific Issuer ("iss") claim.
withJWTId(String) - Method in interface com.auth0.jwt.interfaces.Verification
 
withJWTId(String) - Method in class com.auth0.jwt.JWTCreator.Builder
Add a specific JWT Id ("jti") claim to the Payload.
withJWTId(String) - Method in class com.auth0.jwt.JWTVerifier.BaseVerification
Require a specific JWT Id ("jti") claim.
withKeyId(String) - Method in class com.auth0.jwt.JWTCreator.Builder
Add a specific Key Id ("kid") claim to the Header.
withNotBefore(Date) - Method in class com.auth0.jwt.JWTCreator.Builder
Add a specific Not Before ("nbf") claim to the Payload.
withSubject(String) - Method in interface com.auth0.jwt.interfaces.Verification
 
withSubject(String) - Method in class com.auth0.jwt.JWTCreator.Builder
Add a specific Subject ("sub") claim to the Payload.
withSubject(String) - Method in class com.auth0.jwt.JWTVerifier.BaseVerification
Require a specific Subject ("sub") claim.
A B C D E G H I J K N O P R S T V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form