MicroProfile 7.0 · org.eclipse.microprofile.openapi.annotations.security.OAuthFlow

Method Summary

Modifier and Type	Method and Description
public String	Returns: authorization URL for this flow authorizationUrl() The authorization URL to be used for this flow.
public Extension[]	Returns: array of extensions extensions() List of extensions to be added to the `OAuthFlow` model corresponding to the containing annotation.
public String	Returns: URL for obtaining refresh tokens refreshUrl() The URL to be used for obtaining refresh tokens.
public OAuthScope[]	Returns: scopes available for this security scheme scopes() This is a REQUIRED property.
public String	Returns: token URL for this flow tokenUrl() The token URL to be used for this flow.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

authorizationUrl	back to summary
public String authorizationUrl() The authorization URL to be used for this flow. This is a REQUIRED property and MUST be in the form of a URL. Applies to oauth2 ("implicit", "authorizationCode") type. Returns:String authorization URL for this flow

authorizationUrl

public String authorizationUrl()

The authorization URL to be used for this flow.

This is a REQUIRED property and MUST be in the form of a URL. Applies to oauth2 ("implicit", "authorizationCode") type.

extensions back to summary

extensions	back to summary
public Extension[] extensions() List of extensions to be added to the `OAuthFlow` model corresponding to the containing annotation. Returns:Extension[] array of extensions Since 3.1

public Extension[] extensions()

List of extensions to be added to the OAuthFlow model corresponding to the containing annotation.

refreshUrl	back to summary
public String refreshUrl() The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. Applies to oauth2 type. Returns:String URL for obtaining refresh tokens

refreshUrl

public String refreshUrl()

The URL to be used for obtaining refresh tokens.

This MUST be in the form of a URL. Applies to oauth2 type.

scopes	back to summary
public OAuthScope[] scopes() This is a REQUIRED property. The available scopes for the OAuth2 security scheme. Applies to oauth2 type. Returns:OAuthScope[] scopes available for this security scheme

scopes

public OAuthScope[] scopes()

This is a REQUIRED property.

The available scopes for the OAuth2 security scheme. Applies to oauth2 type.

tokenUrl	back to summary
public String tokenUrl() The token URL to be used for this flow. This is a REQUIRED property and MUST be in the form of a URL. Applies to oauth2 ("password", "clientCredentials", "authorizationCode") type. Returns:String token URL for this flow

tokenUrl

public String tokenUrl()

The token URL to be used for this flow.

This is a REQUIRED property and MUST be in the form of a URL. Applies to oauth2 ("password", "clientCredentials", "authorizationCode") type.