MicroProfile 7.0 · org.eclipse.microprofile.openapi.annotations.security

A set of annotations to represent various security components of an OpenAPI app.

Example usage:

@Path("/reviews")
@SecurityScheme(
 securitySchemeName = "reviewoauth2",
 type = SecuritySchemeType.OAUTH2,
 description = "authentication needed to create and delete reviews",
 flows = @OAuthFlows(
     implicit = @OAuthFlow(
         authorizationUrl = "https://example.com/api/oauth/dialog",
         scopes = @OAuthScope(
             name = "write:reviews",
             description = "create a review"
         )
     )
  )
)

Annotation Summary

Modifier and Type	Annotation and Description
public @interface	OAuthFlow Configuration details for a supported OAuth Flow.
public @interface	OAuthFlows Allows configuration of the supported OAuth Flows.
public @interface	OAuthScope Represents an OAuth scope.
public @interface	SecurityRequirement Specifies a security requirement for an operation.
public @interface	SecurityRequirements Container annotation for repeated `SecurityRequirement` annotations.
public @interface	SecurityRequirementsSet This annotation represents a set of security requirements which permit access to an operation if all of them are satisfied.
public @interface	SecurityRequirementsSets Represents an array of security requirement sets that apply to an operation.
public @interface	SecurityScheme Defines a security scheme that can be used by the operations.
public @interface	SecuritySchemes This object represents an array of SecurityScheme annotations that can be specified at the definition level.

Package org.eclipse.microprofile.openapi.annotations.security

Annotation Summary