io.swagger.v3.oas.annotations.security

Annotation Type OAuthFlow

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

Configuration details for a supported OAuth Flow.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	authorizationUrl The authorization URL to be used for this flow.
Extension[]	extensions The list of optional extensions
String	refreshUrl The URL to be used for obtaining refresh tokens.
OAuthScope[]	scopes The available scopes for the OAuth2 security scheme.
String	tokenUrl The token URL to be used for this flow.

Element Detail

authorizationUrl

public abstract String authorizationUrl

The authorization URL to be used for this flow. This must be in the form of a URL. Applies to oauth2 ("implicit", "authorizationCode") type.

Returns:

the authorization url

Default:

""

tokenUrl

public abstract String tokenUrl

The token URL to be used for this flow. This must be in the form of a URL. Applies to oauth2 ("password", "clientCredentials", "authorizationCode") type.

Returns:

the token url

Default:

""

refreshUrl

public abstract String refreshUrl

The URL to be used for obtaining refresh tokens. This must be in the form of a URL. Applies to oauth2 type.

Returns:

the refresh url

Default:

""

scopes

public abstract OAuthScope[] scopes

The available scopes for the OAuth2 security scheme. Applies to oauth2 type.

Returns:

array of scopes

Default:

{}

extensions

public abstract Extension[] extensions

The list of optional extensions

Returns:

an optional array of extensions

Default:

{}