jovo-plugin-auth
TypeScript icon, indicating that this package has built-in type declarations

3.6.1 • Public • Published

Jovo Auth Integration

Installation

npm install --save jovo-plugin-auth

Usage in the app:

const { ApiKey } = require('jovo-plugin-auth');

app.use(
    new ApiKey({
        'x-api-key': 'foobar'          
    })
);

There are two ways to pass the key to the app:

Via header object:

{
    'x-api-key': 'foobar'
}

Via query param:

https://endpoint.example.com/user?x-api-key=foobar

Customization

If you want to pass your custom api key variable name, use customKeyName and customKeyValue

const { ApiKey } = require('jovo-plugin-auth');

app.use(
    new ApiKey({
        'customKeyName': 'apiKey'          
        'customKeyValue': 'foobar'          
    })
);

Dependencies (1)

Dev Dependencies (13)

Package Sidebar

Install

npm i jovo-plugin-auth

Weekly Downloads

1

Version

3.6.1

License

Apache-2.0

Unpacked Size

19.3 kB

Total Files

13

Last publish

Collaborators

  • jovotech