MicroProfile 7.0 · org.eclipse.microprofile.jwt · APIdia, the JavaDoc alternative

Interoperable JWT RBAC for Microprofile

Overview

This package contains the primary interfaces and support classes for the JSON Web Tokens (JWT) for Role Based Access Control (RBAC) of MicroProfile microservice endpoints. The primary class is the JsonWebToken interface that defines the view of the current authenticated user and associated JWT claims. It is available for injection as well as the user principal available from the container security API. The supporting classes in this package include:

Claim: a qualifier annotation used to mark a JWT claim value injection point
Claims: this is an enum that defines the names and types of the JWT claims standardized through RFC7519, OIDC, etc.
ClaimValue: this is a proxyable/injectable interface that represents the value of a single JWT claim.

Interface Summary

Modifier and Type	Interface and Description
public interface	ClaimValue< the expected type of the claim T> A representation of a claim in a `JsonWebToken`
public interface	JsonWebToken A read-only interface for the the claims required by Eclipse MicroProfile conforming tokens.

Annotation Summary

Modifier and Type	Annotation and Description
public @interface	Claim Annotation used to signify an injection point for a `ClaimValue` from a `JsonWebToken`

Class Summary

Modifier and Type	Class and Description
public class	ClaimLiteral Annotation literal for `Claim`

Enum Summary

Modifier and Type	Enum and Description
public enum	Claims This enum represents the standardized claims that the MP-JWT specification allows for in terms of interoperability.

Package org.eclipse.microprofile.jwt

Overview

Interface Summary

Annotation Summary

Class Summary

Enum Summary