summary refs log tree commit diff
diff options
context:
space:
mode:
authorJason Robinson <jasonr@matrix.org>2020-05-27 15:52:18 +0300
committerGitHub <noreply@github.com>2020-05-27 13:52:18 +0100
commit4be968d05dde8c79b1a0f21ff2b9d7860419d9a6 (patch)
treecf819dc8aeed94f464e9599d2a588c8b2425ad96
parentFix up comments (diff)
downloadsynapse-4be968d05dde8c79b1a0f21ff2b9d7860419d9a6.tar.xz
Fix sample config docs error (#7581)
'client_auth_method' commented out value was erronously 'client_auth_basic',
when code and docstring says it should be 'client_secret_basic'.

Signed-off-by: Jason Robinson <jasonr@matrix.org>
-rw-r--r--changelog.d/7581.doc1
-rw-r--r--docs/sample_config.yaml2
-rw-r--r--synapse/config/oidc_config.py2
3 files changed, 3 insertions, 2 deletions
diff --git a/changelog.d/7581.doc b/changelog.d/7581.doc
new file mode 100644
index 0000000000..88beeb7bde
--- /dev/null
+++ b/changelog.d/7581.doc
@@ -0,0 +1 @@
+Fix OIDC client_auth_method commented out value in sample config.
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
index 0ec482719d..ce2c235994 100644
--- a/docs/sample_config.yaml
+++ b/docs/sample_config.yaml
@@ -1546,7 +1546,7 @@ oidc_config:
     # auth method to use when exchanging the token.
     # Valid values are "client_secret_basic" (default), "client_secret_post" and "none".
     #
-    #client_auth_method: "client_auth_basic"
+    #client_auth_method: "client_secret_basic"
 
     # list of scopes to ask. This should include the "openid" scope. Defaults to ["openid"].
     #
diff --git a/synapse/config/oidc_config.py b/synapse/config/oidc_config.py
index 5af110745e..586038078f 100644
--- a/synapse/config/oidc_config.py
+++ b/synapse/config/oidc_config.py
@@ -112,7 +112,7 @@ class OIDCConfig(Config):
             # auth method to use when exchanging the token.
             # Valid values are "client_secret_basic" (default), "client_secret_post" and "none".
             #
-            #client_auth_method: "client_auth_basic"
+            #client_auth_method: "client_secret_basic"
 
             # list of scopes to ask. This should include the "openid" scope. Defaults to ["openid"].
             #