# Class: JWTAuthHandler

## vertx-web-js/jwt_auth_handler~ JWTAuthHandler

#### new JWTAuthHandler()

An auth handler that provides JWT Authentication support.

Source:
  - vertx-web-js/jwt_auth_handler.js, line 33

### 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:
  - vertx-web-js/jwt_auth_handler.js, line 73

##### 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:
  - vertx-web-js/jwt_auth_handler.js, line 58

##### 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:
  - vertx-web-js/jwt_auth_handler.js, line 110

#### handle(arg0)

##### Parameters:

Name | Type | Description
--- | --- | ---
`arg0` | RoutingContext |

Source:
  - vertx-web-js/jwt_auth_handler.js, line 44

#### 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:
  - vertx-web-js/jwt_auth_handler.js, line 90

#### setAudience(audience) → {JWTAuthHandler}

Set the audience list

##### Parameters:

Name | Type | Description
--- | --- | ---
`audience` | Array.<string> | the audience list

Source:
  - vertx-web-js/jwt_auth_handler.js, line 130

##### 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:
  - vertx-web-js/jwt_auth_handler.js, line 160

##### Returns:

a reference to this for fluency

Type
  JWTAuthHandler

#### setIssuer(issuer) → {JWTAuthHandler}

Set the issuer

##### Parameters:

Name | Type | Description
--- | --- | ---
`issuer` | string | the issuer

Source:
  - vertx-web-js/jwt_auth_handler.js, line 145

##### Returns:

a reference to this for fluency

Type
  JWTAuthHandler