Sometimes you want to pass extra user profile data when connecting users over SSO. All of our SSO methods integrate with our Profile Extender Addon. This is applicable regardless which SSO method you are using. Here is how you set it up:
Turn on Profile Extender Addon
Create a Field
Make sure that you check "Show on Registration". It will not show if you are passing all the required data to complete the SSO connection but it will receive the values you pass. If, however your connection flow is interrupted in order to prompt users to add a Username or Email address these questions will show. If you do not want users to be able to input data in these fields during SSO connection you can hide them with CSS.
.Dashboard.Entry .Connect li.form-group {
display: none;
}
Note that checking "Required for all users" is only applied when users register using our native registration page, not over SSO. That is to say, we do not validate SSO profile data for Profile Extender fields. If you pass nothing, we will not throw an error. "Show on profiles" means that this data will be displayed on the user's profile page.
Use only the TextBox type which accepts Strings.
Pass the User Profile Data
The key of the profile field being sent is simply the Label with any non-number and letters removed. The maximum of characters is 50. Important: the field is case-sensitive. So to capture user data for the above example, Player Level, you would have to send it as PlayerLevel. If you created a field with a label Top "Rate" to-date!, you would have to send it as TopRatetodate. An example of an OAuth2 response that would pass values to these profile fields:
{
"Email": "ian@example.com",
"Photo": "https://cdn.ouravatars.com/avatar/1fa90f330a58f5d.png",
"Name": "Ian",
"FullName": "Ian Devloper",
"UniqueID": "fa0e81fa65e8",
"PlayerLevel": "Noob",
"TopRatetodate": "11",
"email_verified": true,
"Provider": "oauth2"
}
Remember, it's case sensitive. If you send "playerlevel":"Noob", it will not throw an error but it will not pass the Player Level to the user's profile.
Trouble shooting
Careful. Once the field has been created it has been saved with the transformed Label as its key (i.e. "PlayerLevel"). If you change the Label the key remains the same. If you edit the "Player Level" field in the Profile Extender Addon and change its name to "Player Status", its key remains "PlayerLevel", otherwise data would be orphaned. If you want to change the key, you have to delete the field and create a new one.
If you don't know what the key is (say, if you have edited it several times, or the profile data is not being assigned to the user), one way to verify what the profile key is is to go to /entry/register and look at the source of the field you are looking for.
https://us.v-cdn.net/6030677/uploads/055/Screen Shot 2020-05-05 at 5.30.57 PM.png
Can't get to /entry/register ? That's because you are using your SSO method as the default method of connecting to the site and we won't allow users to register through our page. Go into the settings page of the SSO Addon your are using in the dashboard and temporarily un-set it as the default method. After you have verified the field name, set it back as the default.
