Factory interface for creating OAuth2 based io.vertx.ext.auth.AuthProvider instances.

  • OAuth2Auth
    • AuthProvider
      • Basic
        • Identifiable
        • Object
          • Anything

no subtypes hierarchy

Initializer
OAuth2Auth(OAuth2Auth unknown)
Inherited Attributes
Attributes inherited from: Object
hash, string
Methods
apishared default OAuth2Auth api(HttpMethod method, String path, Object params, Anything(Throwable|Object) handler)

Call OAuth2 APIs.

Parameters:
  • method

    HttpMethod

  • path

    target path

  • params

    parameters

  • handler

    handler

authorizeURLshared default String authorizeURL(Object params)

Generate a redirect URL to the authN/Z backend. It only applies to auth_code flow.

getTokenshared default void getToken(Object params, Anything(Throwable|AccessToken) handler)

Returns the Access Token object.

Parameters:
  • params
    • JSON with the options, each flow requires different options.
  • handler
    • The handler returning the results.
Inherited Methods
Methods inherited from: AuthProvider
authenticate
Methods inherited from: Object
equals