Skip to content
This repository was archived by the owner on Mar 29, 2025. It is now read-only.

Commit b88d4ab

Browse files
authored
docs: include assertion PASETO implicit assertion in v4
1 parent 827af83 commit b88d4ab

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ Serializes and signs the payload as a PASETO using the provided private key.
5050
- `key`: `<KeyObject>` The key to sign with. Alternatively a `'k4.secret.[data]'`
5151
PASERK string, any input that works for `crypto.createPrivateKey()`, or `V4.bytesToKeyObject()`.
5252
- `options`: `<Object>`
53+
- `assertion`: `<string>` &vert; `<Buffer>` PASETO Implicit Assertion
5354
- `audience`: `<string>` PASETO Audience, "aud" claim value, if provided it will replace
5455
"aud" found in the payload
5556
- `expiresIn`: `<string>` PASETO Expiration Time, "exp" claim value, specified as string which is
@@ -106,6 +107,7 @@ Verifies the claims and signature of a PASETO
106107
- `key`: `<KeyObject>` The key to verify with. Alternatively a `'k4.public.[data]'`
107108
PASERK string, any input that works for `crypto.createPublicKey()` or `V4.bytesToKeyObject()`.
108109
- `options`: `<Object>`
110+
- `assertion`: `<string>` &vert; `<Buffer>` PASETO Implicit Assertion
109111
- `audience`: `<string>` Expected audience value. An exact match must be found in the payload.
110112
- `clockTolerance`: `<string>` Clock Tolerance for comparing timestamps, provided as timespan
111113
string e.g. `120s`, `2 minutes`, etc. **Default:** no clock tolerance

0 commit comments

Comments
 (0)