diff options
| author | Aurélien Grimpard <aurelien@grimpard.net> | 2024-05-14 14:55:32 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-05-14 13:55:32 +0100 |
| commit | 7d82987b2765b6c203ba12941c844fb7242c6c83 (patch) | |
| tree | 69d1fe25dfe6ad3d6e029ebf6cb5ff9d5ebf85d2 /docs | |
| parent | Bump serde_json from 1.0.116 to 1.0.117 (#17182) (diff) | |
| download | synapse-7d82987b2765b6c203ba12941c844fb7242c6c83.tar.xz | |
Allows CAS SSO flow to provide user IDs composed of numbers only (#17098)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/usage/configuration/config_documentation.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index 2257318bcc..f4edbdcc3e 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -3558,6 +3558,15 @@ Has the following sub-options: 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`: set to 'true' allow numeric user IDs (default false). + 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). +* `numeric_ids_prefix`: the prefix you wish to add in front of a numeric user ID + when the "allow_numeric_ids" option is set to "true". + By default, the prefix is the letter "u" and only alphanumeric characters are allowed. *Added in Synapse 1.93.0.* @@ -3572,6 +3581,8 @@ cas_config: userGroup: "staff" department: None enable_registration: true + allow_numeric_ids: true + numeric_ids_prefix: "numericuser" ``` --- ### `sso` |