Documented sending dynamic params to Strategy via authenticate()

panva · Jan 19, 2023 · daa70a5 · daa70a5
1 parent 694adf3
commit daa70a5
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -857,6 +857,16 @@ Creates a new Strategy
 
 ---
 
+The strategy automatically generates `state` and `nonce` parameters when required. To provide one for a flow where it is optional (for example the `nonce` for the Authorization Code Flow), it can be passed in the optional `options` argument to `passport.authenticate()`:
+
+```js
+app.post('/auth/openid', function(req, res, next) {
+  passport.authenticate('oidc', { nonce: crypto.randomBytes(16).toString('base64url') })(req, res, next);
+});
+```
+
+---
+
 ## generators
 
 <!-- TOC generators START -->