Package io.vertx.openapi.contract
Interface OAuthFlow
-
- All Superinterfaces:
OpenAPIObject
public interface OAuthFlow extends OpenAPIObject
Represents an OAuth Flow Object (the configuration).
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetAuthorizationUrl()The authorization URL to be used for this flow.StringgetRefreshUrl()The URL to be used for obtaining refresh tokens.Set<String>getScopes()The available scopes for the OAuth2 security scheme.StringgetTokenUrl()The token URL to be used for this flow.-
Methods inherited from interface io.vertx.openapi.contract.OpenAPIObject
getExtensions, 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.
-
-