Read Axis LMS users, courses, learning paths, certifications and reports; manage enrollments.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
WRITE: add a user to a usergroup (they must not already be a member). Groups can drive course or path assignments. POST /usergroups/members/{usergroup_id}/{user_id}/.
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
WRITE: add a user to a usergroup (they must not already be a member). Groups can drive course or path assignments. POST /usergroups/members/{usergroup_id}/{user_id}/.
| Argument | Type | Description |
|---|---|---|
| user_id* | integer | |
| usergroup_id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"usergroup_id",
"user_id"
],
"properties": {
"user_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"usergroup_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}Certifications issued in one certification program: user, certification number, how it was earned, issue, renewed and expire date (YYYYMMDD). Filter by users, number, method and dates. Paged (100 per page). GET /reports/certifications/{program_id}/.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1); 100 records per page. Pass the previous reply's next_page. |
| count_only | boolean | If true, return only the number of matching records (and pages) instead of the records. |
| program_id* | integer | |
| user_filter | string | Axis user search phrase: field-name + operator + value, several joined by commas (all must match). Operators: = equals, != not equal, ~ contains, !~ does not contain; for usergroup, ~ means 'is in' and !~ 'is not in'. Fields: id, manager_id, org_id, branch_id, username, first_name, last_name, email, middle_init, company, address, city, state, zip, phone, custom1..custom15, localization, role, usergroup, date_start, date_expire. Examples: state=nj | email~example.com | manager_id=12,usergroup~sales,branch_id=50 |
| method_earned | string | Contains match, e.g. course:1084. |
| max_issue_date | string | yyyy-mm-dd |
| min_issue_date | string | yyyy-mm-dd |
| max_expire_date | string | yyyy-mm-dd |
| min_expire_date | string | yyyy-mm-dd |
| max_renewed_date | string | yyyy-mm-dd |
| min_renewed_date |
Number of active online courses. GET /courses/count/.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Number of users, all or matching a search phrase. GET /users/all/count/ or /users/filtered/count/?user_filter=.
| Argument | Type | Description |
|---|---|---|
| user_filter | string | Axis user search phrase: field-name + operator + value, several joined by commas (all must match). Operators: = equals, != not equal, ~ contains, !~ does not contain; for usergroup, ~ means 'is in' and !~ 'is not in'. Fields: id, manager_id, org_id, branch_id, username, first_name, last_name, email, middle_init, company, address, city, state, zip, phone, custom1..custom15, localization, role, usergroup, date_start, date_expire. Examples: state=nj | email~example.com | manager_id=12,usergroup~sales,branch_id=50 |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"user_filter": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Axis user search phrase: field-name + operator + value, several joined by commas (all must match). Operators: = equals, != not equal, ~ contains, !~ does not contain; for usergroup, ~ means 'is in' and !~ 'is not in'. Fields: id, manager_id, org_id, branch_id, username, first_name, last_name, email, middle_init, company, address, city, state, zip, phone, custom1..custom15, localization, role, usergroup, date_start, date_expire. Examples: state=nj | email~example.com | manager_id=12,usergroup~sales,branch_id=50"
}
}
}Who is doing what in one online course: user, status, progress %, score, start and completion date (YYYYMMDD). Filter by users, status, progress, score and dates. Limited to users currently enrolled who accessed the course or have score data. Paged (100 per page). GET /reports/courses/{course_id}/.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1); 100 records per page. Pass the previous reply's next_page. |
| status | string | |
| course_id* | integer | |
| max_score | integer | |
| min_score | integer | |
| count_only | boolean | If true, return only the number of matching records (and pages) instead of the records. |
| user_filter | string | Axis user search phrase: field-name + operator + value, several joined by commas (all must match). Operators: = equals, != not equal, ~ contains, !~ does not contain; for usergroup, ~ means 'is in' and !~ 'is not in'. Fields: id, manager_id, org_id, branch_id, username, first_name, last_name, email, middle_init, company, address, city, state, zip, phone, custom1..custom15, localization, role, usergroup, date_start, date_expire. Examples: state=nj | email~example.com | manager_id=12,usergroup~sales,branch_id=50 |
WRITE: create a new LMS user. The username must be 4-40 characters (letters, numbers, @ . _ -) and not in use. Returns the new user id. The temporary password the LMS generates is never shown here: give the person access through the LMS itself (its password reset, invitation or single sign-on). Depending on the LMS settings the user may be notified. POST /users/.
| Argument | Type | Description |
|---|---|---|
| zip | string | |
| city | string | |
| role | string | |
| string | ||
| phone | string | |
| state | string | |
| address | string | |
| company | string | |
| custom1 | string | |
| custom2 | string | |
| custom3 | string |
WRITE: create a usergroup. The name must be 4-99 characters (letters, numbers, spaces and @ . _ -). Returns its id. POST /usergroups/{name}/.
| Argument | Type | Description |
|---|---|---|
| name* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"pattern": "^[A-Za-z0-9@._ -]{4,99}$"
}
}
}WRITE: enroll a user in an online course (optionally with access start and end dates). The user and the course must be active. If the user is already enrolled, send start or end to change the enrollment dates. Depending on the LMS settings the user may be notified. POST /courses/enrollments/{course_id}/{user_id}/.
| Argument | Type | Description |
|---|---|---|
| end | string | Access end date, yyyy-mm-dd; must be after the start date. |
| start | string | Access start date, yyyy-mm-dd. |
| user_id* | integer | |
| course_id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"course_id",
"user_id"
],
"properties": {
"end": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Access end date, yyyy-mm-dd; must be after the start date."
},
"start": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Access start date, yyyy-mm-dd."
},
"user_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"course_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}WRITE: enroll a user in a session of an ILT program (takes a seat; check seats_remaining with axislms_list_ilt_sessions first). POST /ilt/enrollments/{program_id}/{session_id}/{user_id}/.
| Argument | Type | Description |
|---|---|---|
| user_id* | integer | |
| program_id* | integer | |
| session_id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"program_id",
"session_id",
"user_id"
],
"properties": {
"user_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"program_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"session_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}WRITE: enroll an active user in a learning path. The user must not already be enrolled. POST /learningpaths/enrollments/{learningpath_id}/users/{user_id}/.
| Argument | Type | Description |
|---|---|---|
| user_id* | integer | |
| learningpath_id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"learningpath_id",
"user_id"
],
"properties": {
"user_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"learningpath_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}One certification program: name, prefix, description, keyword tags, webhook and status. GET /certifications/{program_id}/.
| Argument | Type | Description |
|---|---|---|
| program_id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"program_id"
],
"properties": {
"program_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}One online course: name, catalog id, description, active flag, created/updated dates, keyword tags, passing score, price and whether it is for sale, thumbnail, webhook. GET /courses/{id}/.
| Argument | Type | Description |
|---|---|---|
| course_id* | integer | Axis course id (from axislms_list_courses). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"course_id"
],
"properties": {
"course_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Axis course id (from axislms_list_courses).",
"exclusiveMinimum": 0
}
}
}One ILT program: name, catalog id, description and keyword tags. GET /ilt/{program_id}/.
| Argument | Type | Description |
|---|---|---|
| program_id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"program_id"
],
"properties": {
"program_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}One user by id with the fields you ask for: profile (name, email, address, phone, custom1-15, role, manager_id, dates), usergroups, enrolled courses, ILT classes, certifications, learning paths, badges, organizations and system variables. Contains personal data. GET /users/{id}/?fields=.
| Argument | Type | Description |
|---|---|---|
| fields | array | User fields to return (default: id and username). The first field is also the sort key. The sso login link is not available. |
| user_id* | integer | Axis user id (from axislms_list_users or axislms_search_users). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"user_id"
],
"properties": {
"fields": {
"type": "array",
"items": {
"enum": [
"id",
"username",
"first_name",
"last_name",
"email",
"middle_init",
"date_start",
"date_expire",
"company",
"address",
"city",
"state",
"zip",
"phone",
"custom1",
"custom2",
"custom3",
"custom4",
"custom5",
"custom6",
"custom7",
"custom8",
"custom9",
"custom10",
"custom11",
"custom12",
"custom13",
"custom14",
"custom15",
"localization",
"role",
"manager_id",
"usergroups",
"courses",
"iltclasses",
"certifications",
"learningpaths",
"badges",
"organizations",
"sysvars"
],
"type": "string"
},
"maxItems": 40,
"minItems": 1,
"description": "User fields to return (default: id and username). The first field is also the sort key. The sso login link is not available."
},
"user_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Axis user id (from axislms_list_users or axislms_search_users).",
"exclusiveMinimum": 0
}
}
}One usergroup: name, member counts (active, inactive, total) and owner. GET /usergroups/{id}/.
| Argument | Type | Description |
|---|---|---|
| usergroup_id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"usergroup_id"
],
"properties": {
"usergroup_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}Attendance and results of one ILT program: user, session, start and end date, meetings and meetings attended, status. Filter by users, status, session and dates. Paged (100 per page). GET /reports/ilt/{program_id}/.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1); 100 records per page. Pass the previous reply's next_page. |
| status | string | Result status as shown in the report, e.g. complete, incomplete, unavailable. |
| count_only | boolean | If true, return only the number of matching records (and pages) instead of the records. |
| program_id* | integer | |
| session_id | integer | |
| user_filter | string | Axis user search phrase: field-name + operator + value, several joined by commas (all must match). Operators: = equals, != not equal, ~ contains, !~ does not contain; for usergroup, ~ means 'is in' and !~ 'is not in'. Fields: id, manager_id, org_id, branch_id, username, first_name, last_name, email, middle_init, company, address, city, state, zip, phone, custom1..custom15, localization, role, usergroup, date_start, date_expire. Examples: state=nj | email~example.com | manager_id=12,usergroup~sales,branch_id=50 |
Learning path enrollments and results for one path: user, status (complete or incomplete), active or archived, start and completion date (YYYYMMDD). Paged (100 per page). GET /reports/learningpaths/{learningpath_id}/.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1); 100 records per page. Pass the previous reply's next_page. |
| type | string | |
| status | string | |
| count_only | boolean | If true, return only the number of matching records (and pages) instead of the records. |
| user_filter | string | Axis user search phrase: field-name + operator + value, several joined by commas (all must match). Operators: = equals, != not equal, ~ contains, !~ does not contain; for usergroup, ~ means 'is in' and !~ 'is not in'. Fields: id, manager_id, org_id, branch_id, username, first_name, last_name, email, middle_init, company, address, city, state, zip, phone, custom1..custom15, localization, role, usergroup, date_start, date_expire. Examples: state=nj | email~example.com | manager_id=12,usergroup~sales,branch_id=50 |
| max_start_date | string | yyyy-mm-dd |
| min_start_date | string |
Users certified in a certification program (id and username). GET /certifications/{program_id}/users/.
| Argument | Type | Description |
|---|---|---|
| program_id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"program_id"
],
"properties": {
"program_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}List certification programs (id and name): active, inactive or all. GET /certifications/list/{status}/.
| Argument | Type | Description |
|---|---|---|
| status | string | Default active. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"status": {
"enum": [
"active",
"inactive",
"all"
],
"type": "string",
"description": "Default active."
}
}
}Users enrolled in a course with their access start and end dates (YYYYMMDD): active, expired or all enrollments. GET /courses/{id}/users/{status}/.
| Argument | Type | Description |
|---|---|---|
| status | string | Default active. |
| course_id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"course_id"
],
"properties": {
"status": {
"enum": [
"active",
"expired",
"all"
],
"type": "string",
"description": "Default active."
},
"course_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}List the active online courses (id and name), plus the count. GET /courses/list/.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Users who completed an ILT program, or one session of it (id and username). GET /ilt/{program_id}/completions/[{session_id}/].
| Argument | Type | Description |
|---|---|---|
| program_id* | integer | |
| session_id | integer | Only this session. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"program_id"
],
"properties": {
"program_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"session_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only this session.",
"exclusiveMinimum": 0
}
}
}Meetings of one ILT session: date, time, timezone, duration, GMT start and end, facility. GET /ilt/{program_id}/meetings/{session_id}/.
| Argument | Type | Description |
|---|---|---|
| program_id* | integer | |
| session_id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"program_id",
"session_id"
],
"properties": {
"program_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"session_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}List instructor-led training (ILT) programs (id and name). GET /ilt/list/.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Sessions of an ILT program with start and end dates and seats (total, reserved, remaining): current ones or all. GET /ilt/{program_id}/sessions/{current|all}/.
| Argument | Type | Description |
|---|---|---|
| scope | string | Default current. |
| program_id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"program_id"
],
"properties": {
"scope": {
"enum": [
"current",
"all"
],
"type": "string",
"description": "Default current."
},
"program_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}Active enrolled users of a learning path (or one user), with status, start and completion time, completion method, path version, current branch and step, and progress. GET /learningpaths/{id}/users/[{user_id}/].
| Argument | Type | Description |
|---|---|---|
| user_id | integer | Only this enrolled user. |
| learningpath_id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"learningpath_id"
],
"properties": {
"user_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only this enrolled user.",
"exclusiveMinimum": 0
},
"learningpath_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}List the active learning paths (id and name). GET /learningpaths/list/.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}The branches of an organization (nested branches included). GET /organizations/branches/{organization_id}/.
| Argument | Type | Description |
|---|---|---|
| organization_id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"organization_id"
],
"properties": {
"organization_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}Users in an organization (id, username, branch id): active, inactive or all. GET /organizations/users/{organization_id}/{status}/.
| Argument | Type | Description |
|---|---|---|
| status | string | Default active. |
| organization_id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"organization_id"
],
"properties": {
"status": {
"enum": [
"active",
"inactive",
"all"
],
"type": "string",
"description": "Default active."
},
"organization_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}List organizations with owner id and user count, all or those owned by one manager (owner id 0 = the partition admin). GET /organizations/list/{all|owner_id}/.
| Argument | Type | Description |
|---|---|---|
| owner_id | integer | Only organizations owned by this manager's user id; omit for all. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"owner_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Only organizations owned by this manager's user id; omit for all."
}
}
}The certifications a user holds: program, certification number, issue, renew and expire dates (YYYYMMDD). GET /certifications/certificates/{user_id}/.
| Argument | Type | Description |
|---|---|---|
| user_id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"user_id"
],
"properties": {
"user_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}Continuing-education credits (CEUs) a user earned: type, name, credits and issue date. GET /certifications/ceus/{user_id}/.
| Argument | Type | Description |
|---|---|---|
| user_id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"user_id"
],
"properties": {
"user_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}ILT sessions a user is part of: program, session, start and end dates and percent attended. GET /ilt/users/{user_id}/sessions/.
| Argument | Type | Description |
|---|---|---|
| user_id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"user_id"
],
"properties": {
"user_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}Members of a usergroup (id and username): active, inactive or all. GET /usergroups/{id}/members/{status}/.
| Argument | Type | Description |
|---|---|---|
| status | string | Default active. |
| usergroup_id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"usergroup_id"
],
"properties": {
"status": {
"enum": [
"active",
"inactive",
"all"
],
"type": "string",
"description": "Default active."
},
"usergroup_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}List usergroups (id and name). GET /usergroups/list/.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}List the LMS users (id and username only), active, inactive or all. Not paged: a large LMS returns every user. For names, emails or filters use axislms_search_users. GET /users/list/{status}/.
| Argument | Type | Description |
|---|---|---|
| status | string | Default active. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"status": {
"enum": [
"active",
"inactive",
"all"
],
"type": "string",
"description": "Default active."
}
}
}WRITE: mark a user attended or absent for one ILT meeting. The user must already be enrolled in the meeting. Attendance can count toward completion. PUT /ilt/attendance/{program_id}/{session_id}/{meeting_id}/{user_id}/{attended|absent}/.
| Argument | Type | Description |
|---|---|---|
| user_id* | integer | |
| attendance* | string | |
| meeting_id* | integer | |
| program_id* | integer | |
| session_id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"program_id",
"session_id",
"meeting_id",
"user_id",
"attendance"
],
"properties": {
"user_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"attendance": {
"enum": [
"attended",
"absent"
],
"type": "string"
},
"meeting_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"program_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"session_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}WRITE: remove a user from a usergroup they are a member of. DELETE /usergroups/members/{usergroup_id}/{user_id}/.
| Argument | Type | Description |
|---|---|---|
| user_id* | integer | |
| usergroup_id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"usergroup_id",
"user_id"
],
"properties": {
"user_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"usergroup_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}Page through all users, or only those matching a search phrase (for example email~example.com,role=manager), returning the fields you ask for. Contains personal data. GET /users/all/ or /users/filtered/ (page{n}).
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1); 100 records per page. Pass the previous reply's next_page. |
| fields | array | User fields to return (default: id and username). The first field is also the sort key. The sso login link is not available. |
| user_filter | string | Axis user search phrase: field-name + operator + value, several joined by commas (all must match). Operators: = equals, != not equal, ~ contains, !~ does not contain; for usergroup, ~ means 'is in' and !~ 'is not in'. Fields: id, manager_id, org_id, branch_id, username, first_name, last_name, email, middle_init, company, address, city, state, zip, phone, custom1..custom15, localization, role, usergroup, date_start, date_expire. Examples: state=nj | email~example.com | manager_id=12,usergroup~sales,branch_id=50 |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1); 100 records per page. Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"fields": {
"type": "array",
"items": {
"enum": [
"id",
"username",
"first_name",
"last_name",
"email",
"middle_init",
"date_start",
"date_expire",
"company",
"address",
"city",
"state",
"zip",
"phone",
"custom1",
"custom2",
"custom3",
"custom4",
"custom5",
"custom6",
"custom7",
"custom8",
"custom9",
"custom10",
"custom11",
"custom12",
"custom13",
"custom14",
"custom15",
"localization",
"role",
"manager_id",
"usergroups",
"courses",
"iltclasses",
"certifications",
"learningpaths",
"badges",
"organizations",
"sysvars"
],
"type": "string"
},
"maxItems": 40,
"minItems": 1,
"description": "User fields to return (default: id and username). The first field is also the sort key. The sso login link is not available."
},
"user_filter": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Axis user search phrase: field-name + operator + value, several joined by commas (all must match). Operators: = equals, != not equal, ~ contains, !~ does not contain; for usergroup, ~ means 'is in' and !~ 'is not in'. Fields: id, manager_id, org_id, branch_id, username, first_name, last_name, email, middle_init, company, address, city, state, zip, phone, custom1..custom15, localization, role, usergroup, date_start, date_expire. Examples: state=nj | email~example.com | manager_id=12,usergroup~sales,branch_id=50"
}
}
}WRITE: remove a user from an online course. The user loses access to the course. DELETE /courses/enrollments/{course_id}/{user_id}/.
| Argument | Type | Description |
|---|---|---|
| user_id* | integer | |
| course_id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"course_id",
"user_id"
],
"properties": {
"user_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"course_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}WRITE: remove a user from a session of an ILT program. DELETE /ilt/enrollments/{program_id}/{session_id}/{user_id}/.
| Argument | Type | Description |
|---|---|---|
| user_id* | integer | |
| program_id* | integer | |
| session_id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"program_id",
"session_id",
"user_id"
],
"properties": {
"user_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"program_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"session_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}WRITE: remove a user from a learning path they are enrolled in. DELETE /learningpaths/enrollments/{learningpath_id}/users/{user_id}/.
| Argument | Type | Description |
|---|---|---|
| user_id* | integer | |
| learningpath_id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"learningpath_id",
"user_id"
],
"properties": {
"user_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"learningpath_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}WRITE: change profile fields of an existing user (only the fields you send are changed; an empty value is not sent, so a field cannot be cleared here). This edits personal data and can change the user's role or manager. PUT /users/{user_id}/.
| Argument | Type | Description |
|---|---|---|
| zip | string | |
| city | string | |
| role | string | |
| string | ||
| phone | string | |
| state | string | |
| address | string | |
| company | string | |
| custom1 | string | |
| custom2 | string | |
| custom3 | string |
A learner's records across the LMS, for one user, for all users, or for users matching a search phrase. kind: courses (status, progress, score, dates), archived (archived and imported course results), certifications, ilt, or learningpaths. Contains personal data; paged (100 per page). GET /reports/users/{user_id|all|filtered}/{kind}/.
| Argument | Type | Description |
|---|---|---|
| kind* | string | |
| page | integer | Page number, from 1 (default 1); 100 records per page. Pass the previous reply's next_page. |
| scope* | string | user = needs user_id; all = every user; filtered = needs user_filter. |
| user_id | integer | One user (scope 'user'). |
| count_only | boolean | If true, return only the number of matching records (and pages) instead of the records. |
| user_filter | string | Required for scope 'filtered' (syntax as described). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"kind",
"scope"
],
"properties": {
"kind": {
"enum": [
"courses",
"archived",
"certifications",
"ilt",
"learningpaths"
],
"type": "string"
},
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1); 100 records per page. Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"scope": {
"enum": [
"user",
"all",
"filtered"
],
"type": "string",
"description": "user = needs user_id; all = every user; filtered = needs user_filter."
},
"user_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "One user (scope 'user').",
"exclusiveMinimum": 0
},
"count_only": {
"type": "boolean",
"description": "If true, return only the number of matching records (and pages) instead of the records."
},
"user_filter": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Required for scope 'filtered' (syntax as described)."
}
}
}| string |
| yyyy-mm-dd |
| certification_number | string | Contains match. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"program_id"
],
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1); 100 records per page. Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"count_only": {
"type": "boolean",
"description": "If true, return only the number of matching records (and pages) instead of the records."
},
"program_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"user_filter": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Axis user search phrase: field-name + operator + value, several joined by commas (all must match). Operators: = equals, != not equal, ~ contains, !~ does not contain; for usergroup, ~ means 'is in' and !~ 'is not in'. Fields: id, manager_id, org_id, branch_id, username, first_name, last_name, email, middle_init, company, address, city, state, zip, phone, custom1..custom15, localization, role, usergroup, date_start, date_expire. Examples: state=nj | email~example.com | manager_id=12,usergroup~sales,branch_id=50"
},
"method_earned": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Contains match, e.g. course:1084."
},
"max_issue_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "yyyy-mm-dd"
},
"min_issue_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "yyyy-mm-dd"
},
"max_expire_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "yyyy-mm-dd"
},
"min_expire_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "yyyy-mm-dd"
},
"max_renewed_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "yyyy-mm-dd"
},
"min_renewed_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "yyyy-mm-dd"
},
"certification_number": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Contains match."
}
}
}| max_progress | integer |
| min_progress | integer |
| max_start_date | string | yyyy-mm-dd |
| min_start_date | string | yyyy-mm-dd |
| max_completion_date | string | yyyy-mm-dd |
| min_completion_date | string | yyyy-mm-dd |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"course_id"
],
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1); 100 records per page. Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"status": {
"enum": [
"passed",
"failed",
"complete",
"incomplete"
],
"type": "string"
},
"course_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"max_score": {
"type": "integer",
"maximum": 100,
"minimum": 0
},
"min_score": {
"type": "integer",
"maximum": 100,
"minimum": 0
},
"count_only": {
"type": "boolean",
"description": "If true, return only the number of matching records (and pages) instead of the records."
},
"user_filter": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Axis user search phrase: field-name + operator + value, several joined by commas (all must match). Operators: = equals, != not equal, ~ contains, !~ does not contain; for usergroup, ~ means 'is in' and !~ 'is not in'. Fields: id, manager_id, org_id, branch_id, username, first_name, last_name, email, middle_init, company, address, city, state, zip, phone, custom1..custom15, localization, role, usergroup, date_start, date_expire. Examples: state=nj | email~example.com | manager_id=12,usergroup~sales,branch_id=50"
},
"max_progress": {
"type": "integer",
"maximum": 100,
"minimum": 0
},
"min_progress": {
"type": "integer",
"maximum": 100,
"minimum": 0
},
"max_start_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "yyyy-mm-dd"
},
"min_start_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "yyyy-mm-dd"
},
"max_completion_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "yyyy-mm-dd"
},
"min_completion_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "yyyy-mm-dd"
}
}
}| custom4 | string |
| custom5 | string |
| custom6 | string |
| custom7 | string |
| custom8 | string |
| custom9 | string |
| custom10 | string |
| custom11 | string |
| custom12 | string |
| custom13 | string |
| custom14 | string |
| custom15 | string |
| username* | string |
| last_name | string |
| date_start | string | Account start date, yyyy-mm-dd. |
| first_name | string |
| manager_id | integer | User id of a manager. |
| date_expire | string | Account expiry date, yyyy-mm-dd. |
| middle_init | string |
| localization | string | A language pack name installed in the LMS. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"username"
],
"properties": {
"zip": {
"type": "string",
"maxLength": 10
},
"city": {
"type": "string",
"maxLength": 100
},
"role": {
"enum": [
"learner",
"manager"
],
"type": "string"
},
"email": {
"type": "string",
"maxLength": 80
},
"phone": {
"type": "string",
"maxLength": 20
},
"state": {
"type": "string",
"maxLength": 4
},
"address": {
"type": "string",
"maxLength": 255
},
"company": {
"type": "string",
"maxLength": 255
},
"custom1": {
"type": "string",
"maxLength": 255
},
"custom2": {
"type": "string",
"maxLength": 255
},
"custom3": {
"type": "string",
"maxLength": 255
},
"custom4": {
"type": "string",
"maxLength": 255
},
"custom5": {
"type": "string",
"maxLength": 255
},
"custom6": {
"type": "string",
"maxLength": 255
},
"custom7": {
"type": "string",
"maxLength": 255
},
"custom8": {
"type": "string",
"maxLength": 255
},
"custom9": {
"type": "string",
"maxLength": 255
},
"custom10": {
"type": "string",
"maxLength": 255
},
"custom11": {
"type": "string",
"maxLength": 255
},
"custom12": {
"type": "string",
"maxLength": 255
},
"custom13": {
"type": "string",
"maxLength": 255
},
"custom14": {
"type": "string",
"maxLength": 255
},
"custom15": {
"type": "string",
"maxLength": 255
},
"username": {
"type": "string",
"pattern": "^[A-Za-z0-9@._-]{4,40}$"
},
"last_name": {
"type": "string",
"maxLength": 100
},
"date_start": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Account start date, yyyy-mm-dd."
},
"first_name": {
"type": "string",
"maxLength": 100
},
"manager_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "User id of a manager.",
"exclusiveMinimum": 0
},
"date_expire": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Account expiry date, yyyy-mm-dd."
},
"middle_init": {
"type": "string",
"maxLength": 1
},
"localization": {
"type": "string",
"maxLength": 100,
"description": "A language pack name installed in the LMS."
}
}
}| max_end_date |
| string |
| yyyy-mm-dd |
| min_end_date | string | yyyy-mm-dd |
| session_name | string | Contains match. |
| method_earned | string |
| max_start_date | string | yyyy-mm-dd |
| min_start_date | string | yyyy-mm-dd |
| max_expire_date | string | yyyy-mm-dd |
| max_meetings_attended | integer |
| min_meetings_attended | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"program_id"
],
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1); 100 records per page. Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"status": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Result status as shown in the report, e.g. complete, incomplete, unavailable."
},
"count_only": {
"type": "boolean",
"description": "If true, return only the number of matching records (and pages) instead of the records."
},
"program_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"session_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"user_filter": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Axis user search phrase: field-name + operator + value, several joined by commas (all must match). Operators: = equals, != not equal, ~ contains, !~ does not contain; for usergroup, ~ means 'is in' and !~ 'is not in'. Fields: id, manager_id, org_id, branch_id, username, first_name, last_name, email, middle_init, company, address, city, state, zip, phone, custom1..custom15, localization, role, usergroup, date_start, date_expire. Examples: state=nj | email~example.com | manager_id=12,usergroup~sales,branch_id=50"
},
"max_end_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "yyyy-mm-dd"
},
"min_end_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "yyyy-mm-dd"
},
"session_name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Contains match."
},
"method_earned": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"max_start_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "yyyy-mm-dd"
},
"min_start_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "yyyy-mm-dd"
},
"max_expire_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "yyyy-mm-dd"
},
"max_meetings_attended": {
"type": "integer",
"maximum": 10000,
"minimum": 0
},
"min_meetings_attended": {
"type": "integer",
"maximum": 10000,
"minimum": 0
}
}
}| yyyy-mm-dd |
| learningpath_id* | integer |
| max_completion_date | string | yyyy-mm-dd |
| min_completion_date | string | yyyy-mm-dd |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"learningpath_id"
],
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1); 100 records per page. Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"type": {
"enum": [
"active",
"archived"
],
"type": "string"
},
"status": {
"enum": [
"complete",
"incomplete"
],
"type": "string"
},
"count_only": {
"type": "boolean",
"description": "If true, return only the number of matching records (and pages) instead of the records."
},
"user_filter": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Axis user search phrase: field-name + operator + value, several joined by commas (all must match). Operators: = equals, != not equal, ~ contains, !~ does not contain; for usergroup, ~ means 'is in' and !~ 'is not in'. Fields: id, manager_id, org_id, branch_id, username, first_name, last_name, email, middle_init, company, address, city, state, zip, phone, custom1..custom15, localization, role, usergroup, date_start, date_expire. Examples: state=nj | email~example.com | manager_id=12,usergroup~sales,branch_id=50"
},
"max_start_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "yyyy-mm-dd"
},
"min_start_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "yyyy-mm-dd"
},
"learningpath_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"max_completion_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "yyyy-mm-dd"
},
"min_completion_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "yyyy-mm-dd"
}
}
}| custom4 | string |
| custom5 | string |
| custom6 | string |
| custom7 | string |
| custom8 | string |
| custom9 | string |
| user_id* | integer |
| custom10 | string |
| custom11 | string |
| custom12 | string |
| custom13 | string |
| custom14 | string |
| custom15 | string |
| last_name | string |
| date_start | string | Account start date, yyyy-mm-dd. |
| first_name | string |
| manager_id | integer | User id of a manager. |
| date_expire | string | Account expiry date, yyyy-mm-dd. |
| middle_init | string |
| localization | string | A language pack name installed in the LMS. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"user_id"
],
"properties": {
"zip": {
"type": "string",
"maxLength": 10
},
"city": {
"type": "string",
"maxLength": 100
},
"role": {
"enum": [
"learner",
"manager"
],
"type": "string"
},
"email": {
"type": "string",
"maxLength": 80
},
"phone": {
"type": "string",
"maxLength": 20
},
"state": {
"type": "string",
"maxLength": 4
},
"address": {
"type": "string",
"maxLength": 255
},
"company": {
"type": "string",
"maxLength": 255
},
"custom1": {
"type": "string",
"maxLength": 255
},
"custom2": {
"type": "string",
"maxLength": 255
},
"custom3": {
"type": "string",
"maxLength": 255
},
"custom4": {
"type": "string",
"maxLength": 255
},
"custom5": {
"type": "string",
"maxLength": 255
},
"custom6": {
"type": "string",
"maxLength": 255
},
"custom7": {
"type": "string",
"maxLength": 255
},
"custom8": {
"type": "string",
"maxLength": 255
},
"custom9": {
"type": "string",
"maxLength": 255
},
"user_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"custom10": {
"type": "string",
"maxLength": 255
},
"custom11": {
"type": "string",
"maxLength": 255
},
"custom12": {
"type": "string",
"maxLength": 255
},
"custom13": {
"type": "string",
"maxLength": 255
},
"custom14": {
"type": "string",
"maxLength": 255
},
"custom15": {
"type": "string",
"maxLength": 255
},
"last_name": {
"type": "string",
"maxLength": 100
},
"date_start": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Account start date, yyyy-mm-dd."
},
"first_name": {
"type": "string",
"maxLength": 100
},
"manager_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "User id of a manager.",
"exclusiveMinimum": 0
},
"date_expire": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Account expiry date, yyyy-mm-dd."
},
"middle_init": {
"type": "string",
"maxLength": 1
},
"localization": {
"type": "string",
"maxLength": 100,
"description": "A language pack name installed in the LMS."
}
}
}