> For the complete documentation index, see [llms.txt](https://xoops.gitbook.io/xmf-cookbook/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://xoops.gitbook.io/xmf-cookbook/reference/jwt/jsonwebtoken.md).

# JsonWebToken

The `Xmf\Jwt\JsonWebToken` class is used to create and decode JSON Web Tokens. A full description and specification of JSON Web Tokens can be found in [RFC7519](https://tools.ietf.org/html/rfc7519).

## new JsonWebToken(*$key*, *$algorithm*)

Instantiates a new JsonWebToken object, using a [Xmf\Key\KeyAbstract](/xmf-cookbook/reference/key/keyabstract.md) object *$key*, using the specified *$algorithm* for signing and verifying. An invalid algorithm will throw \DomainException.

The default *$algorithm* is 'HS256', and the currently supplied [TokenFactory](/xmf-cookbook/reference/jwt/tokenfactory.md) and [TokenReader](/xmf-cookbook/reference/jwt/tokenreader.md) classes are locked to it. HS256 uses HMAC with SHA256 for signing and verifying.

## setAlgorithm(*$algorithm*)

Change the algorithm used for signing/verifying the token. An invalid algorithm will throw \DomainException.

## decode(*$jwtString*, *$assertClaims*)

Decode a JWT string *$jwtString*, validating signature and well defined registered claims, and optionally validate against a list of supplied claims in the *$assertClaims*.

Claims such as *'exp'*, expiration time, are automatically enforced. Application specific public or claims to be verified by specifying the required claims in *$assertClaims* array.

An example array could look like this: `array('aud' => 'myscript');`

If no application claims are to be validated, an empty array (the default) should be specified in *$assertClaims*.

Returns the payload of the decoded token as a *stdClass* object, or false if the token was invalid.

## create(*$payload*, *$expirationOffset*)

Create a signed token string for the array of claims specified in *$payload*. The integer *$expirationOffset* parameter can be used to specify an expiration time as the number of seconds from *now* that the token will expire. If specified, this will be added as an 'exp' claim to the payload.

Returns a string of the signed token with the specified payload.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://xoops.gitbook.io/xmf-cookbook/reference/jwt/jsonwebtoken.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.