Annotation Interface OpenApi.OAuthFlow

Enclosing class:

OpenApi

@Target({})
@Retention(CLASS)
@Documented
public static @interface OpenApi.OAuthFlow

OpenAPI OAuth Flow Object metadata.

The implicit flow requires authorizationUrl(). The password and clientCredentials flows require tokenUrl(). The authorizationCode flow requires authorizationUrl() and tokenUrl(). The deviceAuthorization flow requires deviceAuthorizationUrl() and tokenUrl().

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	authorizationUrl	Authorization URL.
String	deviceAuthorizationUrl	OpenAPI 3.2 device authorization URL.
String	refreshUrl	Refresh URL.
OpenApi.OAuthScope[]	scopes	OAuth scopes.
String	tokenUrl	Token URL.

Element Details

authorizationUrl

String authorizationUrl

Authorization URL.

Returns:

authorization URL

Default:

""

deviceAuthorizationUrl

String deviceAuthorizationUrl

OpenAPI 3.2 device authorization URL.

Rendered only for OpenAPI 3.2 output.

Returns:

device authorization URL

Default:

""

tokenUrl

String tokenUrl

Token URL.

Returns:

token URL

Default:

""

refreshUrl

String refreshUrl

Refresh URL.

Returns:

refresh URL

Default:

""

scopes

OpenApi.OAuthScope[] scopes

OAuth scopes.

Returns:

scopes

Default:

{}