Top Description Fields
org.eclipse.microprofile.jwt.config

public Interface Names


Constants for the names of the MP-config properties that MP-JWT implementations must support externalization of to ensure portable setup of MP-JWT implementations.

Field Summary

Modifier and TypeField and Description
public static final String
AUDIENCES

The expected "aud" claim value(s), separated by commas.

public static final String
CLOCK_SKEW

The clock skew in seconds used during the token expiry and age verification.

public static final String
DECRYPTOR_KEY_ALGORITHM

Key Management Algorithm property which can be set to either 'RSA-OAEP' or 'RSA-OAEP-256'

public static final String
DECRYPTOR_KEY_LOCATION

The relative path or full URL of the decryption key.

public static final String
ISSUER

The expected iss claim value to validate against an MP-JWT.

public static final String
TOKEN_AGE

The number of seconds since 'iat' after which the token must be considered invalid.

public static final String
TOKEN_COOKIE

The Cookie name expected to containe the JWT token (default is Bearer).

public static final String
TOKEN_HEADER

The HTTP header name expected to contain the JWT token.

public static final String
VERIFIER_PUBLIC_KEY

The embedded key material of the verification public key for the MP-JWT signer in PKCS8 PEM or JWK(S) format.

public static final String
VERIFIER_PUBLIC_KEY_ALGORITHM

Public Key Signature Algorithm property which can be set to either 'RS256' or 'ES256'.

public static final String
VERIFIER_PUBLIC_KEY_LOCATION

The relative path or full URL of the verification public key.

Field Detail

AUDIENCESback to summary
public static final String AUDIENCES

The expected "aud" claim value(s), separated by commas. If specified, MP-JWT claim must be present and match one of the values.

CLOCK_SKEWback to summary
public static final String CLOCK_SKEW

The clock skew in seconds used during the token expiry and age verification.

DECRYPTOR_KEY_ALGORITHMback to summary
public static final String DECRYPTOR_KEY_ALGORITHM

Key Management Algorithm property which can be set to either 'RSA-OAEP' or 'RSA-OAEP-256'

DECRYPTOR_KEY_LOCATIONback to summary
public static final String DECRYPTOR_KEY_LOCATION

The relative path or full URL of the decryption key. All relative paths will be resolved within the archive using ClassLoader.getResource. If the value is a URL it will be resolved using `new URL(“”).openStream()`

ISSUERback to summary
public static final String ISSUER

The expected iss claim value to validate against an MP-JWT.

TOKEN_AGEback to summary
public static final String TOKEN_AGE

The number of seconds since 'iat' after which the token must be considered invalid.

TOKEN_HEADERback to summary
public static final String TOKEN_HEADER

The HTTP header name expected to contain the JWT token.

Supported values are Authorization (default) and Cookie.

VERIFIER_PUBLIC_KEYback to summary
public static final String VERIFIER_PUBLIC_KEY

The embedded key material of the verification public key for the MP-JWT signer in PKCS8 PEM or JWK(S) format. If not found the VERIFIER_PUBLIC_KEY_LOCATION needs to be checked.

VERIFIER_PUBLIC_KEY_ALGORITHMback to summary
public static final String VERIFIER_PUBLIC_KEY_ALGORITHM

Public Key Signature Algorithm property which can be set to either 'RS256' or 'ES256'.

VERIFIER_PUBLIC_KEY_LOCATIONback to summary
public static final String VERIFIER_PUBLIC_KEY_LOCATION

The relative path or full URL of the verification public key. All relative paths will be resolved within the archive using ClassLoader.getResource. If the value is a URL it will be resolved using `new URL(“”).openStream()`