Uses of Interface
org.eclipse.microprofile.openapi.models.security.OAuthFlow
-
Packages that use OAuthFlow Package Description org.eclipse.microprofile.openapi A set of Java interfaces, annotations and programming models which allow Java developers to natively produce OpenAPI v3.1 documents from their Jakarta REST applications.org.eclipse.microprofile.openapi.models.security A set of model interfaces to represent various security components of an OpenAPI app. -
-
Uses of OAuthFlow in org.eclipse.microprofile.openapi
Methods in org.eclipse.microprofile.openapi that return OAuthFlow Modifier and Type Method Description static OAuthFlow
OASFactory. createOAuthFlow()
This method creates a newOAuthFlow
instance. -
Uses of OAuthFlow in org.eclipse.microprofile.openapi.models.security
Methods in org.eclipse.microprofile.openapi.models.security that return OAuthFlow Modifier and Type Method Description OAuthFlow
OAuthFlow. addScope(String scope, String description)
Adds name of an existing scope object and item parameters to scopes as a key-value pair in a map.default OAuthFlow
OAuthFlow. authorizationUrl(String authorizationUrl)
The authorization URL to be used for this flow.OAuthFlow
OAuthFlows. getAuthorizationCode()
OAuth Authorization Code flow; previously called accessCode in OpenAPI 2.0OAuthFlow
OAuthFlows. getClientCredentials()
OAuth Client Credential flow; previously called application in OpenAPI 2.0OAuthFlow
OAuthFlows. getImplicit()
This method returns the implicit property from OAuthFlows instance.OAuthFlow
OAuthFlows. getPassword()
OAuth Resource Owner Password flowdefault OAuthFlow
OAuthFlow. refreshUrl(String refreshUrl)
The URL to be used for obtaining refresh tokens.default OAuthFlow
OAuthFlow. scopes(Map<String,String> scopes)
The available scopes for the OAuth2 security scheme.default OAuthFlow
OAuthFlow. tokenUrl(String tokenUrl)
The token URL to be used for this flow.Methods in org.eclipse.microprofile.openapi.models.security with parameters of type OAuthFlow Modifier and Type Method Description default OAuthFlows
OAuthFlows. authorizationCode(OAuthFlow authorizationCode)
OAuth Authorization Code flow; previously called accessCode in OpenAPI 2.0default OAuthFlows
OAuthFlows. clientCredentials(OAuthFlow clientCredentials)
OAuth Client Credential flow; previously called application in OpenAPI 2.0default OAuthFlows
OAuthFlows. implicit(OAuthFlow implicit)
This method sets the implicit property of OAuthFlows instance to the given implicit argument and returns the modified instance.default OAuthFlows
OAuthFlows. password(OAuthFlow password)
OAuth Resource Owner Password flowvoid
OAuthFlows. setAuthorizationCode(OAuthFlow authorizationCode)
OAuth Authorization Code flow; previously called accessCode in OpenAPI 2.0void
OAuthFlows. setClientCredentials(OAuthFlow clientCredentials)
OAuth Client Credential flow; previously called application in OpenAPI 2.0void
OAuthFlows. setImplicit(OAuthFlow implicit)
This method sets the implicit property of OAuthFlows instance to the given implicit argument.void
OAuthFlows. setPassword(OAuthFlow password)
OAuth Resource Owner Password flow
-