vertx / io.vertx.rxjava.ext.auth.oauth2 / OAuth2Auth

# OAuth2Auth

`open class OAuth2Auth`

Factory interface for creating OAuth2 based io.vertx.rxjava.ext.auth.AuthProvider instances. NOTE: This class has been automatically generated from the io.vertx.ext.auth.oauth2.OAuth2Auth non RX-ified interface using Vert.x codegen.

### Constructors

<init> | `OAuth2Auth(delegate: OAuth2Auth)`

### Properties

__TYPE_ARG | `static val __TYPE_ARG: TypeArg<OAuth2Auth>`

### Functions

authorizeURL | `open fun authorizeURL(params: JsonObject): String` Generate a redirect URL to the authN/Z backend. It only applies to auth_code flow.
create | `open static fun create(vertx: Vertx, flow: OAuth2FlowType, config: OAuth2ClientOptions): OAuth2Auth` `open static fun create(vertx: Vertx, flow: OAuth2FlowType): OAuth2Auth` Create a OAuth2 auth provider
createKeycloak | `open static fun createKeycloak(vertx: Vertx, flow: OAuth2FlowType, config: JsonObject): OAuth2Auth`
decodeToken | `open fun decodeToken(token: String, handler: Handler<AsyncResult<AccessToken>>): OAuth2Auth` Decode a token to a io.vertx.rxjava.ext.auth.oauth2.AccessToken object. This is useful to handle bearer JWT tokens.
equals | `open fun equals(other: Any?): Boolean`
getDelegate | `open fun getDelegate(): OAuth2Auth`
getFlowType | `open fun getFlowType(): OAuth2FlowType` Returns the configured flow type for the Oauth2 provider.
getScopeSeparator | `open fun getScopeSeparator(): String` Returns the scope separator. The RFC 6749 states that a scope is expressed as a set of case-sensitive and space-delimited strings, however vendors tend not to agree on this and we see the following cases being used: space, plus sign, comma.
getToken | `open fun getToken(params: JsonObject, handler: Handler<AsyncResult<AccessToken>>): Unit` Returns the Access Token object.
hasJWTToken | `open fun hasJWTToken(): Boolean` Returns true if this provider supports JWT tokens as the access_token. This is typically true if the provider implements the `openid-connect` protocol. This is a plain return from the config option jwtToken, which is false by default. This information is important to validate grants. Since pure OAuth2 should be used for authorization and when a token is requested all grants should be declared, in case of openid-connect this is not true. OpenId will issue a token and all grants will be encoded on the token itself so the requester does not need to list the required grants.
hashCode | `open fun hashCode(): Int`
introspectToken | `open fun introspectToken(token: String, handler: Handler<AsyncResult<AccessToken>>): OAuth2Auth` `open fun introspectToken(token: String, tokenType: String, handler: Handler<AsyncResult<AccessToken>>): OAuth2Auth` Query an OAuth 2.0 authorization server to determine the active state of an OAuth 2.0 token and to determine meta-information about this token.
loadJWK | `open fun loadJWK(handler: Handler<AsyncResult<Void>>): OAuth2Auth` Loads a JWK Set from the remote provider. When calling this method several times, the loaded JWKs are updated in the underlying JWT object.
newInstance | `open static fun newInstance(arg: OAuth2Auth): OAuth2Auth`
rxDecodeToken | `open fun rxDecodeToken(token: String): Single<AccessToken>` Decode a token to a io.vertx.rxjava.ext.auth.oauth2.AccessToken object. This is useful to handle bearer JWT tokens.
rxGetToken | `open fun rxGetToken(params: JsonObject): Single<AccessToken>` Returns the Access Token object.
rxIntrospectToken | `open fun rxIntrospectToken(token: String): Single<AccessToken>` `open fun rxIntrospectToken(token: String, tokenType: String): Single<AccessToken>` Query an OAuth 2.0 authorization server to determine the active state of an OAuth 2.0 token and to determine meta-information about this token.
rxLoadJWK | `open fun rxLoadJWK(): Single<Void>` Loads a JWK Set from the remote provider. When calling this method several times, the loaded JWKs are updated in the underlying JWT object.
toString | `open fun toString(): String`
verifyIsUsingPassword | `open fun verifyIsUsingPassword(): Unit`