Index (MicroProfile JWT Auth API)

A C D G I J L N O S T V

A

AUDIENCES - Static variable in interface org.eclipse.microprofile.jwt.config.Names: The expected "aud" claim value(s), separated by commas.

C

Claim - Annotation Type in org.eclipse.microprofile.jwt: Annotation used to signify an injection point for a ClaimValue from a JsonWebToken
claim(String) - Method in interface org.eclipse.microprofile.jwt.JsonWebToken: A utility method to access a claim value in an Optional wrapper
claim(Claims) - Method in interface org.eclipse.microprofile.jwt.JsonWebToken: A utility method to access a claim value in an Optional wrapper
ClaimLiteral - Class in org.eclipse.microprofile.jwt: Annotation literal for Claim
ClaimLiteral() - Constructor for class org.eclipse.microprofile.jwt.ClaimLiteral: Creates a default value Claim literal
ClaimLiteral(String) - Constructor for class org.eclipse.microprofile.jwt.ClaimLiteral: Construct a Claim literal from a string name of a claim
ClaimLiteral(Claims) - Constructor for class org.eclipse.microprofile.jwt.ClaimLiteral: Construct a Claim literal from a standard claim defined in Claims
Claims - Enum in org.eclipse.microprofile.jwt: This enum represents the standardized claims that the MP-JWT specification allows for in terms of interoperability.
ClaimValue<T> - Interface in org.eclipse.microprofile.jwt: A representation of a claim in a JsonWebToken
CLOCK_SKEW - Static variable in interface org.eclipse.microprofile.jwt.config.Names: The clock skew in seconds used during the token expiry and age verification.
containsClaim(String) - Method in interface org.eclipse.microprofile.jwt.JsonWebToken: Verify is a given claim exists

D

DECRYPTOR_KEY_ALGORITHM - Static variable in interface org.eclipse.microprofile.jwt.config.Names: Key Management Algorithm property which can be set to either 'RSA-OAEP' or 'RSA-OAEP-256'
DECRYPTOR_KEY_LOCATION - Static variable in interface org.eclipse.microprofile.jwt.config.Names: The relative path or full URL of the decryption key.

G

getAudience() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken: The aud(Audience) claim identifies the recipients that the JWT is intended for.
getClaim(String) - Method in interface org.eclipse.microprofile.jwt.JsonWebToken: Access the value of the indicated claim.
getClaim(Claims) - Method in interface org.eclipse.microprofile.jwt.JsonWebToken: Access the value of the indicated claim.
getClaimNames() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken: Access the names of all claims are associated with this token.
getDescription() - Method in enum org.eclipse.microprofile.jwt.Claims
getExpirationTime() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken: The exp (Expiration time) claim identifies the expiration time on or after which the JWT MUST NOT be accepted for processing in seconds since 1970-01-01T00:00:00Z UTC
getGroups() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken: The groups claim provides the group names the JWT principal has been granted.
getIssuedAtTime() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken: The iat(Issued at time) claim identifies the time at which the JWT was issued in seconds since 1970-01-01T00:00:00Z UTC
getIssuer() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken: The iss(Issuer) claim identifies the principal that issued the JWT
getName() - Method in interface org.eclipse.microprofile.jwt.ClaimValue: Access the name of the claim.
getName() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken: Returns the unique name of this principal.
getRawToken() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken: Get the raw bearer token string originally passed in the authentication header
getSubject() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken: The sub(Subject) claim identifies the principal that is the subject of the JWT.
getTokenID() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken: The jti(JWT ID) claim provides a unique identifier for the JWT.
getType() - Method in enum org.eclipse.microprofile.jwt.Claims: The required type of the claim
getValue() - Method in interface org.eclipse.microprofile.jwt.ClaimValue: Access the value of the claim.

I

ISSUER - Static variable in interface org.eclipse.microprofile.jwt.config.Names: The expected iss claim value to validate against an MP-JWT.

J

JsonWebToken - Interface in org.eclipse.microprofile.jwt: A read-only interface for the the claims required by Eclipse MicroProfile conforming tokens.

L

LoginConfig - Annotation Type in org.eclipse.microprofile.auth: A security annotation describing the authentication method and the associated realm name that should be used for this application.

N

Names - Interface in org.eclipse.microprofile.jwt.config: 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.

O

org.eclipse.microprofile.auth - package org.eclipse.microprofile.auth: Metadata for JWT RBAC for Microprofile
org.eclipse.microprofile.jwt - package org.eclipse.microprofile.jwt: Interoperable JWT RBAC for Microprofile
org.eclipse.microprofile.jwt.config - package org.eclipse.microprofile.jwt.config

S

standard() - Method in class org.eclipse.microprofile.jwt.ClaimLiteral

T

TOKEN_AGE - Static variable in interface org.eclipse.microprofile.jwt.config.Names: The number of seconds since 'iat' after which the token must be considered invalid.
TOKEN_COOKIE - Static variable in interface org.eclipse.microprofile.jwt.config.Names: The Cookie name expected to containe the JWT token (default is Bearer).
TOKEN_HEADER - Static variable in interface org.eclipse.microprofile.jwt.config.Names: The HTTP header name expected to contain the JWT token.

V

value() - Method in class org.eclipse.microprofile.jwt.ClaimLiteral
valueOf(String) - Static method in enum org.eclipse.microprofile.jwt.Claims: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.eclipse.microprofile.jwt.Claims: Returns an array containing the constants of this enum type, in the order they are declared.
VERIFIER_PUBLIC_KEY - Static variable in interface org.eclipse.microprofile.jwt.config.Names: The embedded key material of the verification public key for the MP-JWT signer in PKCS8 PEM or JWK(S) format.
VERIFIER_PUBLIC_KEY_ALGORITHM - Static variable in interface org.eclipse.microprofile.jwt.config.Names: Public Key Signature Algorithm property which can be set to either 'RS256' or 'ES256'.
VERIFIER_PUBLIC_KEY_LOCATION - Static variable in interface org.eclipse.microprofile.jwt.config.Names: The relative path or full URL of the verification public key.

A C D G I J L N O S T V