io.swagger.v3.oas.annotations.security

Annotation Type OAuthFlows

@Target(value={})
 @Retention(value=RUNTIME)
 @Inherited
public @interface OAuthFlows

Allows configuration of the supported OAuth Flows.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
OAuthFlow	authorizationCode Configuration for the OAuth Authorization Code flow.
OAuthFlow	clientCredentials Configuration for the OAuth Client Credentials flow.
Extension[]	extensions The list of optional extensions
OAuthFlow	implicit Configuration for the OAuth Implicit flow.
OAuthFlow	password Configuration for the OAuth Resource Owner Password flow.

Element Detail

implicit

public abstract OAuthFlow implicit

Configuration for the OAuth Implicit flow.

Returns:

OAuthFlow implicit

Default:

@io.swagger.v3.oas.annotations.security.OAuthFlow

password

public abstract OAuthFlow password

Configuration for the OAuth Resource Owner Password flow.

Returns:

OAuthFlow password

Default:

@io.swagger.v3.oas.annotations.security.OAuthFlow

clientCredentials

public abstract OAuthFlow clientCredentials

Configuration for the OAuth Client Credentials flow.

Returns:

OAuthFlow clientCredentials

Default:

@io.swagger.v3.oas.annotations.security.OAuthFlow

authorizationCode

public abstract OAuthFlow authorizationCode

Configuration for the OAuth Authorization Code flow.

Returns:

OAuthFloe authorizationCode

Default:

@io.swagger.v3.oas.annotations.security.OAuthFlow

extensions

public abstract Extension[] extensions

The list of optional extensions

Returns:

an optional array of extensions

Default:

{}