summary refs log tree commit diff
path: root/docs/openid.md
diff options
context:
space:
mode:
authorPaul Tötterman <ptman@users.noreply.github.com>2022-10-07 17:22:25 +0300
committerGitHub <noreply@github.com>2022-10-07 14:22:25 +0000
commit8074430d257c27e5a4d0f6ff38a908e3a7ee91ef (patch)
treedc3643cdc7a602d1b8b46c8968ea51dc1b4650b4 /docs/openid.md
parentParse SYNAPSE_ASYNC_IO_REACTOR env variable & log the reactor on startup (#14... (diff)
downloadsynapse-8074430d257c27e5a4d0f6ff38a908e3a7ee91ef.tar.xz
Document Google OpenID Connect email attribute (#14081)
Diffstat (limited to '')
-rw-r--r--docs/openid.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/openid.md b/docs/openid.md
index 45ba1947b3..87ebea4c29 100644
--- a/docs/openid.md
+++ b/docs/openid.md
@@ -336,11 +336,12 @@ oidc_providers:
        issuer: "https://accounts.google.com/"
        client_id: "your-client-id" # TO BE FILLED
        client_secret: "your-client-secret" # TO BE FILLED
-       scopes: ["openid", "profile"]
+       scopes: ["openid", "profile", "email"] # email is optional, read below
        user_mapping_provider:
          config:
            localpart_template: "{{ user.given_name|lower }}"
            display_name_template: "{{ user.name }}"
+           email_template: "{{ user.email }}" # needs "email" in scopes above
    ```
 4. Back in the Google console, add this Authorized redirect URI: `[synapse
    public baseurl]/_synapse/client/oidc/callback`.