jwt_verify.jwtVerify.md

Function: jwtVerify

▸ jwtVerify(jwt, key, options?): Promise<JWTVerifyResult>

Verifies the JWT format (to be a JWS Compact format), verifies the JWS signature, validates the JWT Claims Set.

example Usage

const jwt = 'eyJhbGciOiJFUzI1NiJ9.eyJ1cm46ZXhhbXBsZTpjbGFpbSI6dHJ1ZSwiaWF0IjoxNjA0MzE1MDc0LCJpc3MiOiJ1cm46ZXhhbXBsZTppc3N1ZXIiLCJhdWQiOiJ1cm46ZXhhbXBsZTphdWRpZW5jZSJ9.hx1nOfAT5LlXuzu8O-bhjXBGpklWDt2EsHw7-MDn49NrnwvVsstNhEnkW2ddauB7eSikFtUNeumLpFI9CWDBsg'

const { payload, protectedHeader } = await jwtVerify(jwt, publicKey, {
  issuer: 'urn:example:issuer',
  audience: 'urn:example:audience'
})

console.log(protectedHeader)
console.log(payload)

example ESM import

import { jwtVerify } from 'jose'

example CJS import

const { jwtVerify } = require('jose')

example Deno import

import { jwtVerify } from 'https://deno.land/x/jose@v4.0.4/index.ts'

Parameters

Name	Type	Description
jwt	string | Uint8Array	JSON Web Token value (encoded as JWS).
key	KeyLike | Uint8Array	Key to verify the JWT with.
options?	JWTVerifyOptions	JWT Decryption and JWT Claims Set validation options.

Returns

Promise<JWTVerifyResult>

▸ jwtVerify(jwt, getKey, options?): Promise<JWTVerifyResult & ResolvedKey>

Parameters

Name	Type	Description
jwt	string | Uint8Array	JSON Web Token value (encoded as JWS).
getKey	JWTVerifyGetKey	Function resolving a key to verify the JWT with.
options?	JWTVerifyOptions	JWT Decryption and JWT Claims Set validation options.

Returns

Promise<JWTVerifyResult & ResolvedKey>