Pearson
Always Learning

The Proprietary SSO has principally the same data points as the LTI Standard SSO, with the addition of Term identifiers and Node Role Identifiers. When a new Proprietary SSO integration is set up, you'll need to specify the parameters you want to include in the SSO launch.

Note: Only the data points you absolutely need should be requested. Requesting more than what is necessary is poor data security practice.

Note that Proprietary SSO integrations can also be launched from the Personal Student Home (PSH or Dashboard). When this is done, course-related data points are not available (since no course is selected). In the table below, the last two cells of each row note whether the data point is available from either/both a course or the PSH.

The flexibility of the Proprietary SSO allows for data points to be sent in any parameter name. The default parameter names are specified in the table below, but you can request alternate names during set-up.

Data Point Typical Param Name Detail Available from Course Available from PSH
CourseID coid LearningStudio Course ID – This is unique to each section and can be used in API calls. Yes No
DisplayCourseCode dcc Display course code value (not necessarily unique to all sections). Yes No
CourseCode cc Course code value (not necessarily unique to all sections). Yes No
CourseTitle ct Course title Yes No
CallNumbers can Corresponds to the course section number(s) associated to a course by an external client system (for example, an SIS system). Up to 10 course call numbers can be passed for a given course section via the outbound single sign-on framework. Call numbers will be comma-separated. Yes No
StartDate csd Term access start date (also applies to course start dates). Standard format is YYYY-MM-DD but virutally any format can be used. Yes No
EndDate ced Term access end date (also applies to course end dates). Standard format is YYYY-MM-DD but virutally any format can be used. Yes No
TermID ti Term ID for the term the course is assigned to (courses can only be one term). Yes No
TermName tn Term name for the term the course is assigned to (courses can only be one term). Yes No
CourseNode con Corresponds to the division of the campus the course resides in within the LearningStudio system. For example, if School A has a campus division called "Business," LearningStudio could pass a value of schoola.bus.. An important point to note for course node and user node values is that there is not a uniform organization for campus structures in the LearningStudio systems. There can be set-ups in which all courses reside in the same node, in which case, the user node value will provide the applicable context of where the user is originating to delineate reporting in your system Yes No
UserID uid LearningStudio user ID. This value is unique to each user across all clients. It can be used in API calls. Yes Yes
UserName or Login ID lid Public-facing LearningStudio login ID (for example, jsmith) established by the shared client during the enrollment/user creation process in LearningStudio. This value can be changed by an LearningStudio client in which case it is recommended to store it for tracking, research and escalation purposes. Yes Yes
FirstName fn User’s first name. Yes Yes
LastName ln User’s last name. Yes Yes
EmailAddress em User’s email address. Yes Yes
Role rt Course role type (STUD, PROF, etc.). Yes No
UserNode nt Corresponds to the division of the campus the course resides in within the LearningStudio system. For example, if School A has a campus division called "Business," LearningStudio could pass a value of schoola.bus.. An important point to note for course node and user node values is that there is not a uniform organization for campus structures in the LearningStudio systems. There can be set-ups in which all courses reside in the same node, in which case, the user node value will provide the applicable context of where the user is originating to delineate reporting in your system. Yes Yes
NodeRole nr Essentially, system role type for a given user on campus (STUD, PROF, TAST, etc.). This could be different from the user's course role type. Yes Yes
ClientID clid LearningStudio client ID (for example, 32344). Yes Yes
ClientString cs Identifies a specific LearningStudio campus. For example, Acme University could have a value of acme passed as a client string value. Yes Yes
LocaleCode lc Language Code for the user (for example, en-us). Yes No
LocaleName lcn Language Description (for example, English (United States)). Yes No
DateTime dts Used for a defense against replay attacks. If included in an outbound SSO, the LearningStudio system will pass the current date and time (in GMT) as a parameter (for example, 2010-09-14T16:12:30Z). Yes Yes

Static Values & Custom Parameters

In addition to the dynamic parameters that can be specified above, the SSO can be configured to send along static values and custom parameters. For example, if you need to identify the launching system, you can request a custom parameter named lms with a static value of learningstudio. Static Values set up in this fashion would apply to all customers that leverage your integration.

Link-Level Custom Parameters

When the SSO URL is put into courses, you can include additional custom parameters at the link-level (meaning they are specified and changeable from within a LearningStudio course). To add these custom parameters, they would simply be added as additional query string parameters to the URL used in the course. For example, a standard SSO launch URL may be:

http://outboundsso.next.ecollege.com/default/launchWithoutCache.ed?ssoType=YourCompany

To add link-level custom parameters, such as a chapter ID for an ebook, the URL used in courses would be something like:

http://outboundsso.next.ecollege.com/default/launchWithoutCache.ed?ssoType=YourCompany&chapter=4
1714 reads
Always Learning
Pearson