summary refs log tree commit diff
path: root/docs/usage/configuration/config_documentation.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/usage/configuration/config_documentation.md')
-rw-r--r--docs/usage/configuration/config_documentation.md47
1 files changed, 0 insertions, 47 deletions
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md

index 1e8953ae37..b72fb36439 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md
@@ -3514,53 +3514,6 @@ oidc_providers: value: synapseUsers ``` --- -### `cas_config` - -*(object)* Enable Central Authentication Service (CAS) for registration and login. - -This setting has the following sub-options: - -* `enabled` (boolean): Set this to true to enable authorization against a CAS server. Defaults to `false`. - -* `idp_name` (string): A user-facing name for this identity provider, which is used to offer the user a choice of login mechanisms. - -* `idp_icon` (string|null): An optional icon for this identity provider, which is presented by clients and Synapse's own IdP picker page. If given, must be an MXC URI of the format `mxc://<server-name>/<media-id>`. (An easy way to obtain such an MXC URI is to upload an image to an (unencrypted) room and then copy the URL from the source of the event.) Defaults to `null`. - -* `idp_brand` (string|null): An optional brand for this identity provider, allowing clients to style the login flow according to the identity provider in question. See the [spec](https://spec.matrix.org/latest/) for possible options here. Defaults to `null`. - -* `server_url` (string): The URL of the CAS authorization endpoint. - -* `protocol_version` (integer|null): The CAS protocol version. (Version 3 is required if you want to use `required_attributes`). Defaults to `null`. - -* `displayname_attribute` (string|null): The attribute of the CAS response to use as the display name. If no name is given here, no displayname will be set. Defaults to `null`. - -* `required_attributes` (object): It is possible to configure Synapse to only allow logins if CAS attributes match particular values. All of the keys given below must exist and the values must match the given value. Alternately if the given value is `None` then any value is allowed (the attribute just must exist). All of the listed attributes must match for the login to be permitted. Defaults to `{}`. - -* `enable_registration` (boolean): Set to `false` to disable automatic registration of new users. This allows the CAS SSO flow to be limited to sign in only, rather than automatically registering users that have a valid SSO login but do not have a pre-registered account. Defaults to `true`. - -* `allow_numeric_ids` (boolean): Set to `true` allow numeric user IDs. This allows CAS SSO flow to provide user IDs composed of numbers only. These identifiers will be prefixed by the letter "u" by default. The prefix can be configured using the `numeric_ids_prefix` option. Be careful to choose the prefix correctly to avoid any possible conflicts (e.g. user 1234 becomes u1234 when a user u1234 already exists). Defaults to `false`. - -* `numeric_ids_prefix` (string): The prefix you wish to add in front of a numeric user ID when the `allow_numeric_ids` option is set to `true`. Only alphanumeric characters are allowed. - - *Added in Synapse 1.93.0.* - - Defaults to `"u"`. - -Example configuration: -```yaml -cas_config: - enabled: true - server_url: https://cas-server.com - protocol_version: 3 - displayname_attribute: name - required_attributes: - userGroup: staff - department: None - enable_registration: true - allow_numeric_ids: true - numeric_ids_prefix: numericuser -``` ---- ### `sso` *(object)* Additional settings to use with single-sign on systems such as OpenID Connect, SAML2 and CAS.