Package | Description |
---|---|
org.eclipse.microprofile.openapi |
A set of Java interfaces, annotations and programming models
which allow Java developers to natively produce OpenAPI v3 documents
from their JAX-RS applications.
|
org.eclipse.microprofile.openapi.models.security |
A set of model interfaces to represent various security components of an OpenAPI app.
|
Modifier and Type | Method and Description |
---|---|
static OAuthFlow |
OASFactory.createOAuthFlow()
This method creates a new
OAuthFlow instance. |
Modifier and Type | Method and 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.0
|
OAuthFlow |
OAuthFlows.getClientCredentials()
OAuth Client Credential flow; previously called application in OpenAPI 2.0
|
OAuthFlow |
OAuthFlows.getImplicit()
This method returns the implicit property from OAuthFlows instance.
|
OAuthFlow |
OAuthFlows.getPassword()
OAuth Resource Owner Password flow
|
default 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.
|
Modifier and Type | Method and Description |
---|---|
default OAuthFlows |
OAuthFlows.authorizationCode(OAuthFlow authorizationCode)
OAuth Authorization Code flow; previously called accessCode in OpenAPI 2.0
|
default OAuthFlows |
OAuthFlows.clientCredentials(OAuthFlow clientCredentials)
OAuth Client Credential flow; previously called application in OpenAPI 2.0
|
default 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 flow
|
void |
OAuthFlows.setAuthorizationCode(OAuthFlow authorizationCode)
OAuth Authorization Code flow; previously called accessCode in OpenAPI 2.0
|
void |
OAuthFlows.setClientCredentials(OAuthFlow clientCredentials)
OAuth Client Credential flow; previously called application in OpenAPI 2.0
|
void |
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
|
Copyright © 2017 – 2020 Eclipse Foundation. All rights reserved.
Use is subject to license terms.