azure-ad-jwt-verifier
v1.0.4
Published
Verify JWT tokens issued by Azure Active Directory B2C.
Downloads
190
Readme
Azure AD Verifier
Verify JWT issued by Azure Active Directory B2C.
Table of Contents
Features
- 🎉 Verify JWT issued by Azure Active Directory B2C.
- 🚀 Automatically use the rotated public keys from Azure.
- 💪 Written in TypeScript.
- ♻️ Configurable cache for public keys.
Installation
npm install azure-ad-jwt-verifier --save
Usage
Verify
import { verify, VerifyOptions } from 'azure-ad-jwt-verifier';
const options: VerifyOptions = {
jwksUri: 'https://login.microsoftonline.com/common/discovery/keys',
issuer: 'https://login.microsoftonline.com/<tenant_id>/v2.0',
audience: '<client_id>',
};
verify(token, options)
.then((decoded) => {
// verified and decoded token
console.log(decoded);
})
.catch((error) => {
// invalid token
console.error(error);
});
Verify options:
| Property | Type | Description |
| ---------- | -------- | ----------------------------------------------------------- |
| jwksUri
| string
| jwk_uri
value obtained from B2C policy metadata endpoint. |
| issuer
| string
| issuer
value obtained from B2C policy metadata endpoint. |
| audience
| string
| Application ID of the application accessing the tenant. |
Example metadata endpoints:
- https://login.microsoftonline.com/common/.well-known/openid-configuration
- https://login.microsoftonline.com/common/discovery/keys
Configuration
import { setConfig } from 'azure-ad-jwt-verifier';
setConfig({
cacheLifetime: 12 * (60 * 60 * 1000), // 12 hours
});
Configuration options:
| Property | Type | Description | Default |
| --------------- | -------- | -------------------------------------------- | ------- |
| cacheLifetime
| number
| Number of milliseconds to cache public keys. | 1 hour |
References
- Overview of tokens in Azure Active Directory B2C
- Microsoft identity platform access tokens
- RSA Key Converter
Development
npm install
npm run build