diff options
author | Sean Stiglitz <stigz+sr.ht@netsplit.dev> | 2022-08-21 10:10:49 -0700 |
---|---|---|
committer | Robin Jarry <robin@jarry.cc> | 2022-08-22 09:49:24 +0200 |
commit | 23639acd50d3fd996691a1b20d121db34d8ba1c6 (patch) | |
tree | 261f48cd9fe8b7158f46f6db78ef9dc365417f53 /doc | |
parent | db39ca181adf61ebb5a89fe5eb7a1e0d6836be56 (diff) | |
download | aerc-23639acd50d3fd996691a1b20d121db34d8ba1c6.tar.gz |
doc: clarify behavior of token_endpoint parameter
Add language explaining the token_endpoint parameter is actually
optional and what happens when included or omitted.
Signed-off-by: Sean Stiglitz <stigz+sr.ht@netsplit.dev>
Acked-by: Robin Jarry <robin@jarry.cc>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/aerc-imap.5.scd | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/aerc-imap.5.scd b/doc/aerc-imap.5.scd index 25833a9f..6fbf1f93 100644 --- a/doc/aerc-imap.5.scd +++ b/doc/aerc-imap.5.scd @@ -40,10 +40,12 @@ available: *oauth2_params:* - If specified, the configured password is used as an refresh token that - is exchanged with an access token + If specified and a token_endpoint is provided, the configured password + is used as a refresh token to obtain an access token. If token_endpoint + is omitted, refresh token exchange is skipped, and the password acts + like an access token instead. - - token_endpoint (required) + - token_endpoint (optional) - client_id (optional) - client_secret (optional) - scope (optional) |