# @vonage/auth

> Vonage Auth Package adds the correct authentication headers to requests to Vonage API's

Latest version **1.18.1** (published 2026-09-09) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @vonage/auth
pnpm add @vonage/auth
yarn add @vonage/auth
bun add @vonage/auth
```

## Health

**Score 65/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 1.18.1 |
| Published | 2026-09-09 |
| First published | 2021-08-10 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=22 |
| Dependencies | 2 |
| Unpacked size | 97.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 396 |
| Maintainers | web-il, iceberg-team, unified_portal, vreporter-npm, vbcbe, yuri.guller, idanvon, nexmo-devrel, vvd, vonagemeetings, vonage-jenkins, adasilvacabral, sarvesh.bisht, vgai-dev, vonage_client_media_processing, or.cpc, llihovodov, daniel-sapir, aviadhouri.va, idelacruz, vonage-frontier, hilakl, saurabh.vonage, leppelin, asilvonage, gpojula, elimenko.vonage, kanav_vonage, omrizilber, molszewski_v, sailusha, rpalanisamy-vonage, vbohdan_vonage, abolles, gorka.vonage, bharath-vonage, morvonage, ilan.aradbilavsky.at.vonage.com, vonreeves, avi.dantes, mgalin, jhajduk.vonage, nitsanungerfrontier, vquezada, adidomenico, sathishr-vonage, pravallika-pamu, abagdi, anuradhlankapalli, hrosenberg, gokul-vonage, aslowe-vcc, vbc-web-cicd-bot, mserranomontes, ariel12955, franbecerra, urihaim, mvera_vonage, mike.zhylevych, mprabhuvonage, sharad-srivastava2, lucas_pilarski, manish-ranjan07, srajput0909, pvillenamontes, dsimoes2, manel_vonage, joliveraortega |

## Links

- npm: https://www.npmjs.com/package/@vonage/auth
- Repository: https://github.com/Vonage/vonage-node-sdk
- Homepage: https://github.com/vonage/vonage-node-sdk/tree/master/packages/auth#readme
- Issues: https://github.com/Vonage/vonage-node-sdk/issues
- npm.io page: https://npm.io/package/@vonage/auth

## Dependencies (2)

- [debug](https://npm.io/package/debug.md) 4.4.3
- [@vonage/jwt](https://npm.io/package/@vonage/jwt.md) 1.17.1

## Recent versions

- 1.18.1 (latest) — 2026-09-09
- 1.14.4-0 (pre) — 2026-04-22
- 1.18.0 — 2026-09-01
- 1.17.0 — 2026-07-29
- 1.15.0 — 2026-03-25
- 1.14.3 — 2026-02-24
- 1.14.2 — 2026-02-23
- 1.14.1 — 2026-02-18
- 1.14.0 — 2026-01-28
- 1.13.1 — 2025-09-22
- 1.13.0 — 2025-09-16
- 1.12.2 — 2025-09-16
- 1.13.0-alpha.1 — 2025-09-16
- 1.13.0-alpha.0 — 2025-09-16
- 1.12.2-alpha.1 — 2025-09-16
- … 37 more at https://npm.io/package/@vonage/auth/versions

## README

# Vonage Auth SDK for Node.js

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/vonage/vonage-node-sdk/ci.yml?branch=3.x) [![Codecov](https://img.shields.io/codecov/c/github/vonage/vonage-node-sdk?label=Codecov&logo=codecov&style=flat-square)](https://codecov.io/gh/Vonage/vonage-server-sdk) ![Latest Release](https://img.shields.io/npm/v/@vonage/auth?label=%40vonage%2Fauth&style=flat-square) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg?style=flat-square)](../../CODE_OF_CONDUCT.md) [![License](https://img.shields.io/npm/l/@vonage/accounts?label=License&style=flat-square)][license]

<img src="https://developer.nexmo.com/images/logos/vbc-logo.svg" height="48px" alt="Vonage" />

This is the Vonage Auth SDK for Node.js for creating authentication headers and signature for use with [Vonage APIs](https://www.vonage.com/). To use it you will need a Vonage account. Sign up [for free at vonage.com][signup].

We recommend using this package as part of the overall [`@vonage/server-sdk` package](https://github.com/vonage/vonage-node-sdk).

For full API documentation refer to [developer.vonage.com](https://developer.nexmo.com/).

* [Installation](#installation)
* [Usage](#usage)
  * [Options](#options)
* [Testing](#testing)

## Installation

We recommend using this SDK as part of the overall [`@vonage/server-sdk` package](https://github.com/vonage/vonage-node-sdk). Please see the main package for installation.

You can also use this SDK standalone if you only need access to just the Auth SDK.

### With NPM

```bash
npm install @vonage/auth
```

### With Yarn

```bash
yarn add @vonage/auth
```

## Usage

### As part of the Vonage Server SDK

If you are using this SDK as part of the Vonage Server SDK, you can access it as the `auth` property off of the client that you instantiate.

The SDK can be used standalone from the main [Vonage Server SDK for Node.js](https://github.com/vonage/vonage-node-sdk) if you only need to use the Auth API. All you need to do is `require('@vonage/auth')`, and use the returned object to create your own client.

```js
const { Auth } = require('@vonage/server-sdk');
// Or if standalone
const { Auth } = require('@vonage/auth');

const vonageAuth = new Auth({
  apiKey: API_KEY,
  apiSecret: API_SECRET,
  applicationId: APP_ID,
  privateKey: PRIVATE_KEY_PATH,
});

(async () => {
  const basicHeader = vonageAuth.createBasicHeader();
  console.log(basicHeader);
})()
```

### Options

Options is an object with the following properties:

* `apiKey` - API Key from Vonage API. If `applicationId` and `privateKey` are present, `apiKey` is optional.
* `apiSecret` - API Secret from Vonage API. If `applicationId` and `privateKey` are present, `apiSecret` is optional.
* `applicationId` - (optional) The Vonage API Application ID to be used when creating JWTs.
* `privateKey` - (optional) The Private Key to be used when creating JWTs. You can specify the key as any of the following:
    * A [Buffer](https://nodejs.org/api/buffer.html#buffer_class_method_buffer_from_string_encoding) containing the file contents.
    * A String containing the path to the key file on disk.
    * A String containing the key itself.

## Testing

Run:

```bash
npm run test
```

[signup]: https://dashboard.nexmo.com/sign-up?utm_source=DEV_REL&utm_medium=github&utm_campaign=node-server-sdk
[license]: ../../LICENSE.txt

---
_Source: https://npm.io/package/@vonage/auth · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._