Back to Jose

Function: decodeJwt()

docs/util/decode_jwt/functions/decodeJwt.md

6.2.21.3 KB
Original Source

Function: decodeJwt()

šŸ’— Help the project

Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by becoming a sponsor.

ā–ø decodeJwt<PayloadType>(jwt): PayloadType & JWTPayload

Decodes a signed JSON Web Token payload. This does not validate the JWT Claims Set types or values. This does not validate the JWS Signature. For a proper Signed JWT Claims Set validation and JWS signature verification use jose.jwtVerify(). For an encrypted JWT Claims Set validation and JWE decryption use jose.jwtDecrypt().

This function is exported (as a named export) from the main 'jose' module entry point as well as from its subpath export 'jose/jwt/decode'.

Type Parameters

Type ParameterDefault type
PayloadTypeJWTPayload

Parameters

ParameterTypeDescription
jwtstringJWT token in compact JWS serialization.

Returns

PayloadType & JWTPayload

Example

js
const claims = jose.decodeJwt(token)
console.log(claims)