API Developer Reference

User Endpoints

user/add

IMPORTANT: The Axis Legacy API is deprecated and has been replaced with the Axis REST API

Parameters:

p1: partition username
p2: desired user’s username
p3: desired user’s password
p4: OPTIONAL name=value pairs

Return Type:

Boolean (true or false)

Description:
Adds a user into specified account. The p2 (username) and p3 (password) parameters are required parameters, but the 4th parameter (p4) of name=value pairs is optional, and worth discussing a bit further.

Each name=value should be separated by a two pipe characters (||), and each pair looks like this: name=value where name is the row name (like address, or first_name for example), and value is the value for that row.

For example, to set a user’s first name and last name, p4 will look like this: first_name=Bob||last_name=Jones

Here are the possible name values you can use for the name=value pairs along with their size limits:

first_name (100), last_name (100), email (80), middle_init (1), date_start (8), date_expire (8), company (255), address (255), city (100), state (4), zip (10), phone (20), custom1 (255), custom2 (255), custom3 (255), custom4 (255), custom5 (255), custom6 (255), custom7 (255), custom8 (255), custom9 (255), custom10 (255), custom11 (255), custom12 (255), custom13 (255), custom14 (255), custom15 (255)

Note: p2 (username) can be up to 40 characters.

 

 

Axis LMS API Overview
Overview
Getting Started
API Tools
PHP SDK
Javascript SDK
ColdFusion
Understanding Return Values
Certifications Endpoints
certifications/getuserlist
certifications/getuserinfo
certifications/getuserceus
certifications/issueofflinecert
certifications/issueonlinecert
certifications/extend
certifications/getprogramid
certifications/getprogramlist
Course Endpoints
course/getcount
course/getlist
course/getrecord
course/getuserlist
course/enrolluser
course/removeuser
Gradebook Endpoints
gradebook/getreportcard
ILT Endpoints
ilt/disenrolluser
ilt/enrolluser
ilt/getcompletedusers
ilt/getmeetings
ilt/getprograms
ilt/getsessions
ilt/getusersessions
ilt/setuserattendance
Learning Paths Endpoints
learningpaths/enrolluser
learningpaths/disenrolluser
learningpaths/getpaths
learningpaths/getusers
learningpaths/getuserstatus
learningpaths/resetuser
Manager Endpoints
manager/add
manager/demote
manager/assignemployee
manager/moveemployees
manager/getcoursekeywords
manager/setcoursekeywords
manager/getusername
manager/getlist
manager/getcount
manager/getuserlist
manager/getusercount
manager/getmanagerlist
manager/getmanagercount
Organization Endpoints
organizations/adduser
organizations/getbranches
organizations/getlist
organizations/getusercount
organizations/removeuser
Report Endpoints
report/getcourseinfo
report/getcourseactivityinfo
report/getuserinfo
report/getuserarchiveinfo
report/getusercourseinfo
report/getuserdetailedscoreinfo
report/getusertrainingsummary
System Endpoints
system/getapiversion
User Endpoints
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 Endpoints
usergroup/getcount
usergroup/getlist
usergroup/add
usergroup/remove
usergroup/getuserlist
usergroup/getusercount
usergroup/adduser
usergroup/removeuser