SSO Token Properties

Documentation → SSO Token Properties
Property Name Description Required
displayName The display named used exclusively through the application. This value represents the identity of a particular end user on your site. Yes
email The email address for the particular end user being connected. The parameter of email= needs to be in the Token, but the value can be empty. Yes
avatarFull The highest resolution copy of the users icon that you have for the user. If you don’t have a particular size just use the next highest quality image and the application will scale the image for you. Yes
avatarThumb A smaller more friendly load friendly avatar for your end users. If you don’t have a particular size just use the next highest quality image and the application will scale the image for you. Yes
avatarIcon An icon size version of the avatar for your end users. If you don’t have a particular size just use the next highest quality image and the application will scale the image for you. Yes
line1 Line data represents a piece of profile data for your particular end users. These properties are defined in either CSXML’s getDomainPreferences call or in the Userplane Dashboard* Yes
line2 Line data represents a piece of profile data for your particular end users. These properties are defined in either CSXML’s getDomainPreferences call or in the Userplane Dashboard* Yes
line3 Line data represents a piece of profile data for your particular end users. These properties are defined in either CSXML’s getDomainPreferences call or in the Userplane Dashboard* Yes
line4 Line data represents a piece of profile data for your particular end users. These properties are defined in either CSXML’s getDomainPreferences call or in the Userplane Dashboard* Yes
userID This MUST represent a unique value for your user. Anywhere you reference a user by identifier with any other widget or implementation within the application MUST match this otherwise the system will not be able to properly identify your users. This represents the primary key we used to identify your users, so any Yes
* Userplane Dashboard preferences system has not yet been launched, if you need to change these values please contact support.