dandri/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2026-07-17 03:32:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: Enhance update_profile_information documentation with picture claim (#19508)

Browse Source 
Added details how synapse syncs the picture claim when
update_profile_information setting is true. Addresses #17836

---------

Co-authored-by: Michael Hlas <3398654+mhlas7@users.noreply.github.com>
This commit is contained in:
mhlas7
2026-05-15 15:29:53 +00:00
committed by GitHub
co-authored by Michael Hlas
parent c9c3fc769a
commit 0c6e0f79e5
3 changed files with 14 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
changelog.d/19508.doc
+1
View File
@@ -0,0 +1 @@
Added details about how Synapse syncs the picture claim when `update_profile_information` setting is true.
docs/usage/configuration/config_documentation.md
+4 -1
View File
@@ -3788,7 +3788,10 @@ This setting has the following sub-options:
Defaults to `null`.
* `update_profile_information` (boolean): Use this setting to keep a user's profile fields in sync with information from the identity provider. Currently only syncing the displayname is supported. Fields are checked on every SSO login, and are updated if necessary. Note that enabling this option will override user profile information, regardless of whether users have opted-out of syncing that information when first signing in. Defaults to `false`.
* `update_profile_information` (boolean): Use this setting to keep a user's profile fields in sync with information from the identity provider. Fields are checked on every SSO login, and are updated if necessary. Note that enabling this option will override user profile information, regardless of whether users have opted-out of syncing that information when first signing in. Fields that will be synced:
* displayname
* picture - only if Synapse media repository is running in the main
process (i.e. not workerized) and media is stored locally Defaults to `false`.
Example configuration:
```yaml
schema/synapse-config.schema.yaml
+9 -5
View File
@@ -4620,11 +4620,15 @@ properties:
type: boolean
description: >-
Use this setting to keep a user's profile fields in sync with
information from the identity provider. Currently only syncing the
displayname is supported. Fields are checked on every SSO login, and
are updated if necessary. Note that enabling this option will override
user profile information, regardless of whether users have opted-out
of syncing that information when first signing in.
information from the identity provider. Fields are checked on every
SSO login, and are updated if necessary. Note that enabling this
option will override user profile information, regardless of whether
users have opted-out of syncing that information when first signing
in.
Fields that will be synced:
* displayname
* picture - only if Synapse media repository is running in the main
process (i.e. not workerized) and media is stored locally
default: false
examples:
- client_whitelist: