From 8074430d257c27e5a4d0f6ff38a908e3a7ee91ef Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Paul=20T=C3=B6tterman?= <ptman@users.noreply.github.com>
Date: Fri, 7 Oct 2022 17:22:25 +0300
Subject: [PATCH] Document Google OpenID Connect email attribute (#14081)
---
changelog.d/14081.doc | 1 +
docs/openid.md | 3 ++-
2 files changed, 3 insertions(+), 1 deletion(-)
create mode 100644 changelog.d/14081.doc
diff --git a/changelog.d/14081.doc b/changelog.d/14081.doc
new file mode 100644
index 0000000000..0a6925b3bf
--- /dev/null
+++ b/changelog.d/14081.doc
@@ -0,0 +1 @@
+Expand Google OpenID Connect example config to map email attribute. Contributed by @ptman.
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`.
--
GitLab