summary refs log tree commit diff
path: root/docs/usage/configuration/config_documentation.md
diff options
context:
space:
mode:
authorAurélien Grimpard <aurelien@grimpard.net>2023-08-24 22:11:23 +0200
committerGitHub <noreply@github.com>2023-08-24 16:11:23 -0400
commitaeeca2a62ebfb601efa7930acae0897c8d3e43df (patch)
treeed4401902543aebd0ac8090472fe01d4a68e993f /docs/usage/configuration/config_documentation.md
parentBump anyhow from 1.0.72 to 1.0.75 (#16141) (diff)
downloadsynapse-aeeca2a62ebfb601efa7930acae0897c8d3e43df.tar.xz
Add configuration setting for CAS protocol version (#15816)
Diffstat (limited to 'docs/usage/configuration/config_documentation.md')
-rw-r--r--docs/usage/configuration/config_documentation.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md
index 743c51d76a..235f873860 100644
--- a/docs/usage/configuration/config_documentation.md
+++ b/docs/usage/configuration/config_documentation.md
@@ -3420,6 +3420,7 @@ Has the following sub-options:
    to style the login flow according to the identity provider in question.
    See the [spec](https://spec.matrix.org/latest/) for possible options here.
 * `server_url`: The URL of the CAS authorization endpoint.
+* `protocol_version`: The CAS protocol version, defaults to none (version 3 is required if you want to use "required_attributes").
 * `displayname_attribute`: The attribute of the CAS response to use as the display name.
    If no name is given here, no displayname will be set.
 * `required_attributes`:  It is possible to configure Synapse to only allow logins if CAS attributes
@@ -3433,6 +3434,7 @@ Example configuration:
 cas_config:
   enabled: true
   server_url: "https://cas-server.com"
+  protocol_version: 3
   displayname_attribute: name
   required_attributes:
     userGroup: "staff"