# Updating SSO documentation

**URL:** https://meta.discourse.org/t/updating-sso-documentation/86343
**Category:** SSO
**Created:** [April 28, 2018, 12:20am UTC](https://meta.discourse.org/t/updating-sso-documentation/86343 "2018-04-28T00:20:59Z")
**Posts on this page:** 9
**Page:** 1

<div class="post-metadata">

### Author: ![edahlseng](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/edahlseng/32/95420_2.png) [@edahlseng](https://meta.discourse.org/u/edahlseng)
#### Post date: [April 28, 2018, 12:20am UTC](https://meta.discourse.org/t/updating-sso-documentation/86343/1 "2018-04-28T00:20:59Z")

</div>

I frequently refer to the [Official Single-Sign-On](https://meta.discourse.org/t/official-single-sign-on-for-discourse-sso/13045) post for SSO documentation. I just noticed, however, that the [reference implementation](https://github.com/discourse/discourse/blob/master/lib/single_sign_on.rb) has a few accessors that aren’t mentioned in that post (notably avatar\_force\_update, title, and groups). Would it be possible to update that post to include descriptions of these fields?

---

<div class="post-metadata">

### Author: ![sam](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/sam/32/102149_2.png) [@sam](https://meta.discourse.org/u/sam)
#### Post date: [April 28, 2018, 12:31am UTC](https://meta.discourse.org/t/updating-sso-documentation/86343/2 "2018-04-28T00:31:39Z")

</div>

It is a wiki 🙂 feel free to give it a shot!

---

<div class="post-metadata">

### Author: ![edahlseng](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/edahlseng/32/95420_2.png) [@edahlseng](https://meta.discourse.org/u/edahlseng)
#### Post date: [April 28, 2018, 12:43am UTC](https://meta.discourse.org/t/updating-sso-documentation/86343/3 "2018-04-28T00:43:51Z")

</div>

😮 no way! Here goes nothing!

---

<div class="post-metadata">

### Author: ![edahlseng](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/edahlseng/32/95420_2.png) [@edahlseng](https://meta.discourse.org/u/edahlseng)
#### Post date: [April 28, 2018, 12:47am UTC](https://meta.discourse.org/t/updating-sso-documentation/86343/4 "2018-04-28T00:47:52Z")

</div>

That was easy enough. Thanks @sam!

---

<div class="post-metadata">

### Author: ![consideRatio](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/consideratio/32/126623_2.png) [@consideRatio](https://meta.discourse.org/u/consideRatio)
#### Post date: [February 24, 2019, 3:56pm UTC](https://meta.discourse.org/t/updating-sso-documentation/86343/5 "2019-02-24T15:56:35Z")

</div>

I inspected discourse code base and added some notes about `groups` and the discourse option called `sso overrides groups` based on what I learned from that.

Perhaps someone could verify I got it right? [Setup DiscourseConnect - Official Single-Sign-On for Discourse (sso)](https://meta.discourse.org/t/official-single-sign-on-for-discourse-sso/13045)

---

<div class="post-metadata">

### Author: ![sam](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/sam/32/102149_2.png) [@sam](https://meta.discourse.org/u/sam)
#### Post date: [February 25, 2019, 4:08am UTC](https://meta.discourse.org/t/updating-sso-documentation/86343/6 "2019-02-25T04:08:25Z")

</div>

Edit seems fine, thanks Erik.

---

<div class="post-metadata">

### Author: ![Cardinalflyer](https://avatars.discourse-cdn.com/v4/letter/c/f14d63/32.png) [@Cardinalflyer](https://meta.discourse.org/u/Cardinalflyer)
#### Post date: [July 15, 2019, 4:33am UTC](https://meta.discourse.org/t/updating-sso-documentation/86343/7 "2019-07-15T04:33:16Z")

</div>

I have just been struggling with this implementation and would like to start by saying thanks for documenting the SSO function! Could not have done it without it!

However, the behavior I observed with a fresh test just now does not quite match this documentation. When the _sso overrides groups_ option is specified the **add\_groups** parameter does not add the listed groups. However the **groups** parameter does properly define the group memberships.

When the _sso overrides groups_ option is not specified, then **add\_groups** works but **groups** does not.

I also learned that the comma delimited list of groups is not tolerant of spaces around (or at least after) the commas. IIRC when there are spaces, only the first group gets recognized.

---

<div class="post-metadata">

### Author: ![jezra](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/jezra/32/105986_2.png) [@jezra](https://meta.discourse.org/u/jezra)
#### Post date: [August 30, 2019, 12:13am UTC](https://meta.discourse.org/t/updating-sso-documentation/86343/8 "2019-08-30T00:13:57Z")

</div>

The SSO documentation was excellent for helping me getting SSO setup. However, now I need to include custom field data with the payload and unfortunately the link in the documentation (under **Advanced Features** ) leads to an error page. If someone can point me in the direction of the directions, I will gladly update the docs.

---

<div class="post-metadata">

### Author: ![Cardinalflyer](https://avatars.discourse-cdn.com/v4/letter/c/f14d63/32.png) [@Cardinalflyer](https://meta.discourse.org/u/Cardinalflyer)
#### Post date: [September 3, 2019, 3:15am UTC](https://meta.discourse.org/t/updating-sso-documentation/86343/9 "2019-09-03T03:15:31Z")

</div>

I see a clue [on this page](https://meta.discourse.org/t/link-custom-user-field-to-external-website/41218/11)… hope that helps.
