A B C D E G H I J K N P R S T V W

A

acceptExpiresAt(long) - Method in class com.auth0.jwt.JWTVerifier.Verification

Set a specific leeway window in seconds in which the Expires At ("exp") Claim will still be valid.

acceptIssuedAt(long) - Method in class com.auth0.jwt.JWTVerifier.Verification

Set a specific leeway window in seconds in which the Issued At ("iat") Claim will still be valid.

acceptLeeway(long) - Method in class com.auth0.jwt.JWTVerifier.Verification

Define the default window in milliseconds in which the Not Before, Issued At and Expires At Claims will still be valid.

acceptNotBefore(long) - Method in class com.auth0.jwt.JWTVerifier.Verification

Set a specific leeway window in seconds in which the Not Before ("nbf") Claim will still be valid.

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 in com.auth0.jwt.exceptions

AlgorithmMismatchException(String) - Constructor for exception com.auth0.jwt.exceptions.AlgorithmMismatchException

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.NullClaim

asBoolean() - Method in interface com.auth0.jwt.interfaces.Claim

Get this Claim as a Boolean.

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.NullClaim

asDouble() - Method in interface com.auth0.jwt.interfaces.Claim

Get this Claim as a Double.

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.NullClaim

asList(Class<T>) - Method in interface com.auth0.jwt.interfaces.Claim

Get this Claim as a List of type T.

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 - Static variable in interface com.auth0.jwt.impl.PublicClaims

B

build() - Method in class com.auth0.jwt.JWTVerifier.Verification

Creates a new and reusable instance of the JWTVerifier with the configuration already provided.

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.

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

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

create() - Static method in class com.auth0.jwt.JWT

Returns a JWT builder used to create and sign jwt tokens

D

decode(String) - Static method in class com.auth0.jwt.JWT

Decode a given JWT token.

DecodedJWT - Interface in com.auth0.jwt.interfaces

Class that represents a Json Web Token that was decoded from it's string representation.

E

ECDSA256(ECKey) - Static method in class com.auth0.jwt.algorithms.Algorithm

Creates a new Algorithm instance using SHA256withECDSA.

ECDSA384(ECKey) - Static method in class com.auth0.jwt.algorithms.Algorithm

Creates a new Algorithm instance using SHA384withECDSA.

ECDSA512(ECKey) - Static method in class com.auth0.jwt.algorithms.Algorithm

Creates a new Algorithm instance using SHA512withECDSA.

EXPIRES_AT - Static variable in interface com.auth0.jwt.impl.PublicClaims

G

getAlgorithm() - Method in interface com.auth0.jwt.interfaces.Header

Getter for the Algorithm "alg" claim defined in the JWT's Header.

getAudience() - Method in interface com.auth0.jwt.interfaces.Payload

Get the value of the "aud" claim, or null if it's not available.

getClaim(String) - Method in interface com.auth0.jwt.interfaces.Payload

Get a Private Claim given it's name.

getContentType() - Method in interface com.auth0.jwt.interfaces.Header

Getter for the Content Type "cty" claim defined in the JWT's Header.

getExpiresAt() - Method in interface com.auth0.jwt.interfaces.Payload

Get the value of the "exp" claim, or null if it's not available.

getHeaderClaim(String) - Method in interface com.auth0.jwt.interfaces.Header

Get a Private Claim given it's name.

getId() - Method in interface com.auth0.jwt.interfaces.Payload

Get the value of the "jti" claim, or null if it's not available.

getIssuedAt() - Method in interface com.auth0.jwt.interfaces.Payload

Get the value of the "iat" claim, or null if it's not available.

getIssuer() - Method in interface com.auth0.jwt.interfaces.Payload

Get the value of the "iss" claim, or null if it's not available.

getKeyId() - Method in interface com.auth0.jwt.interfaces.Header

Get the value of the "kid" claim, or null if it's not available.

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 interface com.auth0.jwt.interfaces.Payload

Get the value of the "nbf" claim, or null if it's not available.

getSignature() - Method in interface com.auth0.jwt.interfaces.Signature

Getter for the Signature contained in the JWT as a Base64 encoded String.

getSubject() - Method in interface com.auth0.jwt.interfaces.Payload

Get the value of the "sub" claim, or null if it's not available.

getToken() - Method in interface com.auth0.jwt.interfaces.DecodedJWT

getType() - Method in interface com.auth0.jwt.interfaces.Header

Getter for the Type "typ" claim defined in the JWT's Header.

H

Header - Interface in com.auth0.jwt.interfaces

The Header class represents the 1st part of the JWT, where the Header value is hold.

HMAC256(String) - Static method in class com.auth0.jwt.algorithms.Algorithm

Creates a new Algorithm instance using HmacSHA256.

HMAC256(byte[]) - Static method in class com.auth0.jwt.algorithms.Algorithm

Creates a new Algorithm instance using HmacSHA256.

HMAC384(String) - Static method in class com.auth0.jwt.algorithms.Algorithm

Creates a new Algorithm instance using HmacSHA384.

HMAC384(byte[]) - Static method in class com.auth0.jwt.algorithms.Algorithm

Creates a new Algorithm instance using HmacSHA384.

HMAC512(String) - Static method in class com.auth0.jwt.algorithms.Algorithm

Creates a new Algorithm instance using HmacSHA512.

HMAC512(byte[]) - Static method in class com.auth0.jwt.algorithms.Algorithm

Creates a new Algorithm instance using HmacSHA512.

I

InvalidClaimException - Exception in com.auth0.jwt.exceptions

InvalidClaimException(String) - Constructor for exception com.auth0.jwt.exceptions.InvalidClaimException

isNull() - Method in class com.auth0.jwt.impl.NullClaim

isNull() - Method in interface com.auth0.jwt.interfaces.Claim

ISSUED_AT - Static variable in interface com.auth0.jwt.impl.PublicClaims

ISSUER - Static variable in interface com.auth0.jwt.impl.PublicClaims

J

JWT - Class in com.auth0.jwt

JWT() - Constructor for class com.auth0.jwt.JWT

JWT_ID - Static variable in interface com.auth0.jwt.impl.PublicClaims

JWTCreationException - Exception in com.auth0.jwt.exceptions

JWTCreationException(String, Throwable) - Constructor for exception 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.Builder - Class in com.auth0.jwt

The Builder class holds the Claims that defines the JWT to be created.

JWTDecodeException - Exception in com.auth0.jwt.exceptions

JWTDecodeException(String) - Constructor for exception com.auth0.jwt.exceptions.JWTDecodeException

JWTDecodeException(String, Throwable) - Constructor for exception com.auth0.jwt.exceptions.JWTDecodeException

JWTParser - Class in com.auth0.jwt.impl

JWTParser() - 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 in com.auth0.jwt.exceptions

JWTVerificationException(String) - Constructor for exception com.auth0.jwt.exceptions.JWTVerificationException

JWTVerificationException(String, Throwable) - Constructor for exception 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.Verification - 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

N

none() - Static method in class com.auth0.jwt.algorithms.Algorithm

NOT_BEFORE - Static variable in interface com.auth0.jwt.impl.PublicClaims

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

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.

Payload - Interface in com.auth0.jwt.interfaces

The Payload class represents the 2nd part of the JWT, where the Payload value is hold.

PayloadSerializer - Class in com.auth0.jwt.impl

PayloadSerializer() - Constructor for class com.auth0.jwt.impl.PayloadSerializer

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.

RSA256(RSAKey) - Static method in class com.auth0.jwt.algorithms.Algorithm

Creates a new Algorithm instance using SHA256withRSA.

RSA384(RSAKey) - Static method in class com.auth0.jwt.algorithms.Algorithm

Creates a new Algorithm instance using SHA384withRSA.

RSA512(RSAKey) - Static method in class com.auth0.jwt.algorithms.Algorithm

Creates a new Algorithm instance using SHA512withRSA.

S

serialize(ClaimsHolder, JsonGenerator, SerializerProvider) - Method in class com.auth0.jwt.impl.PayloadSerializer

sign(byte[]) - Method in class com.auth0.jwt.algorithms.Algorithm

Sign the given content using this Algorithm instance.

sign(Algorithm) - Method in class com.auth0.jwt.JWTCreator.Builder

Creates a new JWT and signs is with the given algorithm

Signature - Interface in com.auth0.jwt.interfaces

The Signature class represents the 3rd part of the JWT, where the Signature value is hold.

SignatureGenerationException - Exception in com.auth0.jwt.exceptions

SignatureGenerationException(Algorithm, Throwable) - Constructor for exception com.auth0.jwt.exceptions.SignatureGenerationException

SignatureVerificationException - Exception in com.auth0.jwt.exceptions

SignatureVerificationException(Algorithm) - Constructor for exception com.auth0.jwt.exceptions.SignatureVerificationException

SignatureVerificationException(Algorithm, Throwable) - Constructor for exception com.auth0.jwt.exceptions.SignatureVerificationException

SUBJECT - Static variable in interface com.auth0.jwt.impl.PublicClaims

T

toString() - Method in class com.auth0.jwt.algorithms.Algorithm

TYPE - Static variable in interface com.auth0.jwt.impl.PublicClaims

V

verify(byte[], byte[]) - Method in class com.auth0.jwt.algorithms.Algorithm

Verify the given content using this Algorithm instance.

verify(String) - Method in class com.auth0.jwt.JWTVerifier

Perform the verification against the given Token, using any previous configured options.

W

withAudience(String...) - Method in class com.auth0.jwt.JWTCreator.Builder

Add a specific Audience ("aud") claim.

withAudience(String...) - Method in class com.auth0.jwt.JWTVerifier.Verification

Require a specific Audience ("aud") claim.

withClaim(String, Object) - Method in class com.auth0.jwt.JWTCreator.Builder

Add a custom Claim value.

withClaim(String, Object) - Method in class com.auth0.jwt.JWTVerifier.Verification

Require a specific Claim value.

withExpiresAt(Date) - Method in class com.auth0.jwt.JWTCreator.Builder

Add a specific Expires At ("exp") claim.

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.

withIssuer(String) - Method in class com.auth0.jwt.JWTCreator.Builder

Add a specific Issuer ("iss") claim.

withIssuer(String) - Method in class com.auth0.jwt.JWTVerifier.Verification

Require a specific Issuer ("iss") claim.

withJWTId(String) - Method in class com.auth0.jwt.JWTCreator.Builder

Add a specific JWT Id ("jti") claim.

withJWTId(String) - Method in class com.auth0.jwt.JWTVerifier.Verification

Require a specific JWT Id ("jti") claim.

withNotBefore(Date) - Method in class com.auth0.jwt.JWTCreator.Builder

Add a specific Not Before ("nbf") claim.

withSubject(String) - Method in class com.auth0.jwt.JWTCreator.Builder

Add a specific Subject ("sub") claim.

withSubject(String) - Method in class com.auth0.jwt.JWTVerifier.Verification

Require a specific Subject ("sub") claim.

A B C D E G H I J K N P R S T V W