jwks_remote.createremotejwkset.md

Function: createRemoteJWKSet

jwks/remote.createRemoteJWKSet

▸ createRemoteJWKSet(url: URL, options?: RemoteJWKSetOptions): GetKeyFunction<JWSHeaderParameters, FlattenedJWSInput>

Returns a function that resolves to a key object downloaded from a remote endpoint returning a JSON Web Key Set, that is, for example, an OAuth 2.0 or OIDC jwks_uri. Only a single public key must match the selection process.

example ESM import

import { createRemoteJWKSet } from 'jose/jwks/remote'

example CJS import

const { createRemoteJWKSet } = require('jose/jwks/remote')

example Usage

import { jwtVerify } from 'jose/jwt/verify'

const JWKS = createRemoteJWKSet(new URL('https://www.googleapis.com/oauth2/v3/certs'))

const { payload, protectedHeader } = await jwtVerify(jwt, JWKS, {
  issuer: 'urn:example:issuer',
  audience: 'urn:example:audience'
})
console.log(protectedHeader)
console.log(payload)

Parameters:

Name	Type	Description
url	URL	URL to fetch the JSON Web Key Set from.
options?	RemoteJWKSetOptions	Options for the remote JSON Web Key Set.

Returns: GetKeyFunction<JWSHeaderParameters, FlattenedJWSInput>

Defined in: jwks/remote.ts:248