API Integrations

User Functions

user__getSSO

Parameters:

p1: partition username
p2: user’s username
p3: OPTIONAL Add user if not in system (true/false, default = false)
p4: OPTIONAL # Minutes Link is good for (1-999999, 0 = no limit, default = 0)

Return Type:

String (or Boolean on error)

Description:

Returns an encrypted sign-on URL for a user. Typically would be used by an external system to generate a link that can be navigated to by the user, creating a single sign-on scenario so user can seamlessly access their online content without having to login to the LMS (the url does all the work).

Optional parameter p3 can be set to true to add the user to the system if they do not yet exist (the system will generate a random strong password).

Optional parameter p4 can be set to the number of minutes the url will be good for before it no longer provides access. The default is no limit (0).

Example (using Code Kit):
// assumes partition username "anthony" exists
// assumes user username "chris" exists
$data = APICommand( "user__getSSO", "anthony", "chris" );
$xml = simplexml_load_string( $data );

echo $xml->result;

Table of Contents

Axis LMS API Overview
Overview
Getting Started
API Tools
Understanding Return Values
Partition Functions
partition__getCount
partition__getList
partition__getRecord
User Functions
user__getCount
user__getList
user__getRecord
user__getUsername
user__getImage
user__getSSO
user__add
user__update
user__elevate
user__getManager
user__assignToManager
user__enroll
user__disenroll
user__getSysVars
user__getSysVar
user__setSysVar
Usergroup Functions
usergroup__getCount
usergroup__getList
usergroup__add
usergroup__remove
usergroup__getUserList
usergroup__getUserCount
usergroup__addUser
usergroup__removeUser
Manager Functions
manager__add
manager__getUsername
manager__assignEmployee
manager__getCourseKeywords
manager__setCourseKeywords
manager__getList
manager__getCount
manager__getUserList
manager__getUserCount
manager__getManagerList
manager__getManagerCount
Organization Functions
organizations__addUser
organizations__getBranches
organizations__getList
organizations__getUserCount
organizations__removeUser
Course Functions
course__getCount
course__getList
course__getRecord
course__getUserList
course__enrollUser
course__removeUser
Report Functions
report__getCourseInfo
report__getCourseActivityInfo
report__getUserInfo
report__getUserArchiveInfo
report__getUserCourseInfo
report__getUserTrainingSummary
Gradebook Functions
gradebook__getReportCard
Certifications Functions
certifications__getUserList
certifications__getUserInfo
certifications__getUserCeus
certifications__issueOfflineCert
certifications__issueOnlineCert
certifications__extend
certifications__getProgramID
certifications__getProgramList
System Functions
system__getApiVersion