io.vertx.ext.auth.oauth2.impl

Class OAuth2API

java.lang.Object

io.vertx.ext.auth.oauth2.impl.OAuth2API

public class OAuth2API
extends Object

Author:

Paulo Lopes

Constructor Summary

Constructors

Constructor and Description
OAuth2API(Vertx vertx, OAuth2Options config)

Method Summary

Modifier and Type	Method and Description
String	authorizeURL(JsonObject params) The client sends the end-user's browser to this endpoint to request their authentication and consent.
String	endSessionURL(String idToken, JsonObject params) The logout (end-session) endpoint is specified in OpenID Connect Session Management 1.0.
void	fetch(HttpMethod method, String path, JsonObject headers, Buffer payload, Handler<AsyncResult<OAuth2Response>> callback)
void	jwkSet(Handler<AsyncResult<JsonObject>> handler) Retrieve the public server JSON Web Key (JWK) required to verify the authenticity of issued ID and access tokens.
void	logout(String accessToken, String refreshToken, Handler<AsyncResult<Void>> callback) Sign out an end-user.
static void	processNonStandardHeaders(JsonObject json, OAuth2Response reply, String sep)
void	token(String grantType, JsonObject params, Handler<AsyncResult<JsonObject>> handler) Post an OAuth 2.0 grant (code, refresh token, resource owner password credentials, client credentials) to obtain an ID and / or access token.
void	tokenIntrospection(String tokenType, String token, Handler<AsyncResult<JsonObject>> handler) Validate an access token and retrieve its underlying authorisation (for resource servers).
void	tokenRevocation(String tokenType, String token, Handler<AsyncResult<Void>> handler) Revoke an obtained access or refresh token.
void	userInfo(String accessToken, JWT jwt, Handler<AsyncResult<JsonObject>> handler) Retrieve profile information and other attributes for a logged-in end-user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OAuth2API

public OAuth2API(Vertx vertx,
                 OAuth2Options config)

Method Detail

jwkSet

public void jwkSet(Handler<AsyncResult<JsonObject>> handler)

Retrieve the public server JSON Web Key (JWK) required to verify the authenticity of issued ID and access tokens.

authorizeURL

public String authorizeURL(JsonObject params)

The client sends the end-user's browser to this endpoint to request their authentication and consent. This endpoint is used in the code and implicit OAuth 2.0 flows which require end-user interaction. see: https://tools.ietf.org/html/rfc6749

token

public void token(String grantType,
                  JsonObject params,
                  Handler<AsyncResult<JsonObject>> handler)

Post an OAuth 2.0 grant (code, refresh token, resource owner password credentials, client credentials) to obtain an ID and / or access token. see: https://tools.ietf.org/html/rfc6749

tokenIntrospection

public void tokenIntrospection(String tokenType,
                               String token,
                               Handler<AsyncResult<JsonObject>> handler)

Validate an access token and retrieve its underlying authorisation (for resource servers). see: https://tools.ietf.org/html/rfc7662

tokenRevocation

public void tokenRevocation(String tokenType,
                            String token,
                            Handler<AsyncResult<Void>> handler)

Revoke an obtained access or refresh token. see: https://tools.ietf.org/html/rfc7009

userInfo

public void userInfo(String accessToken,
                     JWT jwt,
                     Handler<AsyncResult<JsonObject>> handler)

Retrieve profile information and other attributes for a logged-in end-user. see: https://openid.net/specs/openid-connect-core-1_0.html#UserInfo

endSessionURL

public String endSessionURL(String idToken,
                            JsonObject params)

The logout (end-session) endpoint is specified in OpenID Connect Session Management 1.0. see: https://openid.net/specs/openid-connect-session-1_0.html

logout

public void logout(String accessToken,
                   String refreshToken,
                   Handler<AsyncResult<Void>> callback)

Sign out an end-user. see:

fetch

public void fetch(HttpMethod method,
                  String path,
                  JsonObject headers,
                  Buffer payload,
                  Handler<AsyncResult<OAuth2Response>> callback)

processNonStandardHeaders

public static void processNonStandardHeaders(JsonObject json,
                                             OAuth2Response reply,
                                             String sep)