Skip to content

Commit 0effe17

Browse files
docs: add description of pre_authenticate option
Signed-off-by: Patrick Chin <8509935+thepatrickchin@users.noreply.github.com>
1 parent 23af716 commit 0effe17

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

docs/source/components/auth/api-authentication.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ authentication:
114114
| `token_endpoint_auth_method` | Some token provider endpoints require specific types of authentication. For example `client_secret_post`. |
115115
| `redirect_uri` | The redirect URI for OAuth 2.0 authentication. Must match the registered redirect URI with the OAuth provider.|
116116
| `scopes` | List of permissions to the API provider (e.g., `read`, `write`). |
117+
| `pre_authenticate` | Whether to trigger authentication at WebSocket connection time before the user submits their first prompt, defaults to `False`. Only applies in `nat serve` mode. When enabled, tokens are cached for the session to avoid re-authentication on reconnect. |
117118
| `use_pkce` | Whether to use PKCE (Proof Key for Code Exchange) in the OAuth 2.0 flow, defaults to `False` |
118119
| `use_redirect_auth` | Whether to use a redirect-based flow or open the OAuth consent page in a popup window, defaults to `False` (popup) |
119120
| `authorization_kwargs` | Additional keyword arguments to include in the authorization request. |

0 commit comments

Comments
 (0)