Class APIKeyHandler

An authentication handler that provides API Key support.

API keys can be extracted from HTTP headers/query parameters/cookies.

By default this handler will extract the API key from an HTTP header named X-API-KEY.

Hierarchy

APIKeyHandler

Implements

any
AuthenticationHandler

Index

Methods

Methods

cookie

cookie(cookieName: string): APIKeyHandler

- Defined in io.vertx/vertx-web/target/npm/index.d.ts:49
Specify the source for the api key extraction as an HTTP cookie with the given name.

Parameters
- cookieName: string
Returns APIKeyHandler

handle

handle(arg0: RoutingContext): void

Implementation of AuthenticationHandler.handle
- Defined in io.vertx/vertx-web/target/npm/index.d.ts:29
Parameters
- arg0: RoutingContext
Returns void

header

header(headerName: string): APIKeyHandler

- Defined in io.vertx/vertx-web/target/npm/index.d.ts:39
Specify the source for the api key extraction as an HTTP header with the given name.

Parameters
- headerName: string
Returns APIKeyHandler

parameter

parameter(paramName: string): APIKeyHandler

- Defined in io.vertx/vertx-web/target/npm/index.d.ts:44
Specify the source for the api key extraction as an HTTP query parameter with the given name.

Parameters
- paramName: string
Returns APIKeyHandler

Static create

create(authProvider: AuthenticationProvider): APIKeyHandler

- Defined in io.vertx/vertx-web/target/npm/index.d.ts:34
Create an API Key authentication handler

Parameters
- authProvider: AuthenticationProvider
Returns APIKeyHandler

Generated using TypeDoc