From 4be968d05dde8c79b1a0f21ff2b9d7860419d9a6 Mon Sep 17 00:00:00 2001
From: Jason Robinson <jasonr@matrix.org>
Date: Wed, 27 May 2020 15:52:18 +0300
Subject: [PATCH] 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>
---
changelog.d/7581.doc | 1 +
docs/sample_config.yaml | 2 +-
synapse/config/oidc_config.py | 2 +-
3 files changed, 3 insertions(+), 2 deletions(-)
create mode 100644 changelog.d/7581.doc
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"].
#
--
GitLab