Top Description Methods
org.eclipse.microprofile.openapi.annotations.security

public @Interface OAuthFlows

extends Annotation
Annotations
@Target
@Retention:RUNTIME
@Inherited
Imports
java.lang.annotation.Inherited, .Retention, .RetentionPolicy, .Target, org.eclipse.microprofile.openapi.annotations.extensions.Extension
Allows configuration of the supported OAuth Flows.
See Also
OpenAPI Specification OAuth Flows Object

Method Summary

Modifier and TypeMethod and Description
public OAuthFlow

Returns:

OAuth Authorization Code flow
authorizationCode()

Configuration for the OAuth Authorization Code flow.

public OAuthFlow

Returns:

OAuth Client Credentials flow
clientCredentials()

Configuration for the OAuth Client Credentials flow.

public Extension[]

Returns:

array of extensions
extensions()

List of extensions to be added to the OAuthFlows model corresponding to the containing annotation.

public OAuthFlow

Returns:

implicit OAuth flow
implicit()

Configuration for the OAuth Implicit flow.

public OAuthFlow

Returns:

OAuth Resource Owner Password flow
password()

Configuration for the OAuth Resource Owner Password flow.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

authorizationCodeback to summary
public OAuthFlow authorizationCode()

Configuration for the OAuth Authorization Code flow.

Returns:OAuthFlow

OAuth Authorization Code flow

clientCredentialsback to summary
public OAuthFlow clientCredentials()

Configuration for the OAuth Client Credentials flow.

Returns:OAuthFlow

OAuth Client Credentials flow

extensionsback to summary
public Extension[] extensions()

List of extensions to be added to the OAuthFlows model corresponding to the containing annotation.

Returns:Extension[]

array of extensions

Since
3.1
implicitback to summary
public OAuthFlow implicit()

Configuration for the OAuth Implicit flow.

Returns:OAuthFlow

implicit OAuth flow

passwordback to summary
public OAuthFlow password()

Configuration for the OAuth Resource Owner Password flow.

Returns:OAuthFlow

OAuth Resource Owner Password flow