Document Google OpenID Connect email attribute (#14081)

matrix-org · Oct 7, 2022 · 8074430 · 8074430
1 parent dc37b68
commit 8074430
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/changelog.d/14081.doc 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
@@ -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`.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Expand Google OpenID Connect example config to map email attribute. Contributed by @ptman.