io.vertx.openapi.contract

Interface OAuthFlow

All Superinterfaces:

OpenAPIObject

public interface OAuthFlow
extends OpenAPIObject

Represents an OAuth Flow Object (the configuration).

Method Summary

Modifier and Type	Method and Description
String	getAuthorizationUrl() The authorization URL to be used for this flow.
String	getRefreshUrl() The URL to be used for obtaining refresh tokens.
Set<String>	getScopes() The available scopes for the OAuth2 security scheme.
String	getTokenUrl() The token URL to be used for this flow.

Methods inherited from interface io.vertx.openapi.contract.OpenAPIObject

getOpenAPIModel

Method Detail

getAuthorizationUrl

String getAuthorizationUrl()

The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.

getTokenUrl

String getTokenUrl()

The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.

getRefreshUrl

String getRefreshUrl()

The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.

getScopes

Set<String> getScopes()

The available scopes for the OAuth2 security scheme. A set of the scope names. The set MAY be empty.