From 0c6e0f79e5fef944ceca5f74404ec4a44be310bd Mon Sep 17 00:00:00 2001 From: mhlas7 Date: Fri, 15 May 2026 08:29:53 -0700 Subject: [PATCH] doc: Enhance update_profile_information documentation with picture claim (#19508) 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> --- changelog.d/19508.doc | 1 + docs/usage/configuration/config_documentation.md | 5 ++++- schema/synapse-config.schema.yaml | 14 +++++++++----- 3 files changed, 14 insertions(+), 6 deletions(-) create mode 100644 changelog.d/19508.doc diff --git a/changelog.d/19508.doc b/changelog.d/19508.doc new file mode 100644 index 0000000000..2550116341 --- /dev/null +++ b/changelog.d/19508.doc @@ -0,0 +1 @@ +Added details about how Synapse syncs the picture claim when `update_profile_information` setting is true. diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index e58a2dcf10..d028d65fe3 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -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 diff --git a/schema/synapse-config.schema.yaml b/schema/synapse-config.schema.yaml index 8888d2c673..8b8d57b9bf 100644 --- a/schema/synapse-config.schema.yaml +++ b/schema/synapse-config.schema.yaml @@ -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: