summary refs log tree commit diff
path: root/docs/sample_config.yaml
diff options
context:
space:
mode:
authorBBBSnowball <bbbsnowball@gmail.com>2020-10-01 19:54:35 +0200
committerGitHub <noreply@github.com>2020-10-01 13:54:35 -0400
commit05ee048f2c9ce0bb8a7d2430b21ca3682ef5858b (patch)
tree87485cf6c0e87b270db93ff00e6eeda9c2b3236c /docs/sample_config.yaml
parentMerge tag 'v1.21.0rc1' into develop (diff)
downloadsynapse-05ee048f2c9ce0bb8a7d2430b21ca3682ef5858b.tar.xz
Add config option for always using "userinfo endpoint" for OIDC (#7658)
This allows for connecting to certain IdPs, e.g. GitLab.
Diffstat (limited to 'docs/sample_config.yaml')
-rw-r--r--docs/sample_config.yaml8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
index 8a3206e845..b2c1d7a737 100644
--- a/docs/sample_config.yaml
+++ b/docs/sample_config.yaml
@@ -1714,6 +1714,14 @@ oidc_config:
   #
   #skip_verification: true
 
+  # Whether to fetch the user profile from the userinfo endpoint. Valid
+  # values are: "auto" or "userinfo_endpoint".
+  #
+  # Defaults to "auto", which fetches the userinfo endpoint if "openid" is included
+  # in `scopes`. Uncomment the following to always fetch the userinfo endpoint.
+  #
+  #user_profile_method: "userinfo_endpoint"
+
   # Uncomment to allow a user logging in via OIDC to match a pre-existing account instead
   # of failing. This could be used if switching from password logins to OIDC. Defaults to false.
   #