Factory interface for creating OAuth2 based io.vertx.ext.auth.AuthProvider instances.
AnythingObjectBasic ...and other supertypesAuthProviderOAuth2AuthAuthProviderBasicIdentifiableObjectAnythingno subtypes hierarchy
| Initializer |
OAuth2Auth(OAuth2Auth unknown) |
| Inherited Attributes |
Attributes inherited from: Objecthash, string |
| Methods | |
api | shared default OAuth2Auth api(HttpMethod method, String path, Object params, Anything(Throwable|Object) handler)Call OAuth2 APIs. Parameters:
|
authorizeURL | shared default String authorizeURL(Object params)Generate a redirect URL to the authN/Z backend. It only applies to auth_code flow. |
getToken | shared default void getToken(Object params, Anything(Throwable|AccessToken) handler)Returns the Access Token object. Parameters:
|
hasJWTToken | shared default Boolean hasJWTToken()Returns true if this provider supports JWT tokens as the access_token. This is typically true if the provider
implements the 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. |
| Inherited Methods |
Methods inherited from: AuthProviderauthenticate |
Methods inherited from: Objectequals |