Class: JWTAuthHandler

vertx-web-js/jwt_auth_handler~ JWTAuthHandler

new JWTAuthHandler()

An auth handler that provides JWT Authentication support.
Source:

Methods

addAuthorities(authorities) → {AuthHandler}

Add a set of required authorities for this auth handler
Parameters:
Name Type Description
authorities Array.<string> the set of authorities
Source:
Returns:
a reference to this, so the API can be used fluently
Type
AuthHandler

addAuthority(authority) → {AuthHandler}

Add a required authority for this auth handler
Parameters:
Name Type Description
authority string the authority
Source:
Returns:
a reference to this, so the API can be used fluently
Type
AuthHandler

authorize(user, handler)

Authorizes the given user against all added authorities.
Parameters:
Name Type Description
user User a user.
handler function the handler for the result.
Source:

handle(arg0)

Parameters:
Name Type Description
arg0 RoutingContext
Source:

parseCredentials(context, handler)

Parses the credentials from the request into a JsonObject. The implementation should be able to extract the required info for the auth provider in the format the provider expects.
Parameters:
Name Type Description
context RoutingContext the routing context
handler function the handler to be called once the information is available.
Source:

setAudience(audience) → {JWTAuthHandler}

Set the audience list
Parameters:
Name Type Description
audience Array.<string> the audience list
Source:
Returns:
a reference to this for fluency
Type
JWTAuthHandler

setIgnoreExpiration(ignoreExpiration) → {JWTAuthHandler}

Set whether expiration is ignored
Parameters:
Name Type Description
ignoreExpiration boolean whether expiration is ignored
Source:
Returns:
a reference to this for fluency
Type
JWTAuthHandler

setIssuer(issuer) → {JWTAuthHandler}

Set the issuer
Parameters:
Name Type Description
issuer string the issuer
Source:
Returns:
a reference to this for fluency
Type
JWTAuthHandler