AppSecEngineer Enterprise API (1.0.0)

Download OpenAPI specification:

E-mail: [email protected] License: Apache 2.0 Terms of Service

This is AppsecEngineer Enterprise API server console.

Find out more about AppSecEngineer

Generating API Token and Customer ID

As an admin, follow these steps to generate an API token and retrieve your customer ID:

Navigate to "My Profile" in the "My Account" section of the app
Look for the API token generation option in your profile
Generate a new token or copy your existing token and customer ID

Get completed courses and assignments by user ID

header Parameters

X-ASE-API-Token required	string <uuid>
X-ASE-Customer-ID required	string <uuid>

Request Body schema: application/json
required

email of the user for which completed courses should be listed

user_id

string

Responses

Request samples

Payload

Content type

application/json

{"user_id": "[email protected]"
}

Response samples

200
400
500

Content type

application/json

{"success": true,
"error": true,
"data": [{"event_name": "string",
"id": "string",
"vid_duration": 0.1,
"lab_duration": 0.1
}
],
"assignments": [{"id": "string",
"end_date": "2019-08-24",
"name": "string",
"start_date": "2019-08-24"
}
]
}

Get active courses and assignments by user ID

header Parameters

X-ASE-API-Token required	string <uuid>
X-ASE-Customer-ID required	string <uuid>

Request Body schema: application/json
required

email of the user for which completed courses should be listed

user_id

string

Responses

Request samples

Payload

Content type

application/json

{"user_id": "[email protected]"
}

Response samples

200
400
500

Content type

application/json

{"success": true,
"error": true,
"data": [{"event_name": "string",
"id": "string",
"vid_duration": 0.1,
"lab_duration": 0.1
}
],
"assignments": [{"id": "string",
"end_date": "2019-08-24",
"name": "string",
"start_date": "2019-08-24"
}
]
}

Get company user statistics by user ID

header Parameters

X-ASE-API-Token required	string <uuid>
X-ASE-Customer-ID required	string <uuid>

Request Body schema: application/json
required

Company stats request body

user_id

string

Responses

Request samples

Payload

Content type

application/json

{"user_id": "[email protected]"
}

Response samples

200
400
500

Content type

application/json

{"success": true,
"data": [{"first_name": "string",
"last_name": "string",
"video_count": 0,
"lab_count": 0,
"media_count": 0,
"quiz_count": 0,
"email": "string"
}
]
}

Get team statistics

header Parameters

X-ASE-API-Token required	string <uuid>
X-ASE-Customer-ID required	string <uuid>

Request Body schema: application/json
required

Team stats request body

team_id	string
select	string Enum: "overall" "monthly"

Responses

Request samples

Payload

Content type

application/json

{"team_id": "team_062c0918-e7eb-40e0-af3b-ecdca8b91f9f",
"select": "overall"
}

Response samples

200
400
500

Content type

application/json

{"success": true,
"data": {"activity": [{"activity": 0,
"date": "2019-08-24"
}
],
"progress": [{"course": "string",
"averageProgress": 0.1,
"duration": 0.1
}
],
"assignments": [{ }
],
"assign_completed": [{"assign": {"id": "string",
"end_date": "2019-08-24",
"name": "string",
"start_date": "2019-08-24"
},
"users": ["string"
]
}
],
"stat": {"assignments_completed": 0.1,
"badges": 0,
"challenges_completed": 0.1,
"doc_type": "string",
"enrolled": 0.1,
"lab_minutes": 0.1,
"labs_completed": 0.1,
"video_minutes": 0.1,
"videos_completed": 0.1
},
"recent": [{"activity": "string",
"item": "string",
"date": "string"
}
],
"items": [{"first_name": "string",
"last_name": "string",
"lab_minutes": 0.1,
"course_minutes": 0.1,
"email": "string"
}
]
}
}

Get proficiency report

header Parameters

X-ASE-API-Token required	string <uuid>
X-ASE-Customer-ID required	string <uuid>

Responses

Response samples

200
400
500

Content type

application/json

{"message": "string",
"success": true,
"data": [{"type": "string",
"total_enroll_count": 0,
"courses": [{"event_name": "string",
"enroll_count": 0
}
]
}
]
}

Get learning path report

header Parameters

X-ASE-API-Token required	string <uuid>
X-ASE-Customer-ID required	string <uuid>

Responses

Response samples

200
400
500

Content type

application/json

{"message": "string",
"success": true,
"error": true,
"data": {"lab_duration": [{"lpId": "string",
"learning_path_name": "string",
"lab_duration": 0.1
}
],
"vid_duration": [{"lpId": "string",
"learning_path_name": "string",
"vid_duration": 0.1
}
]
}
}

Get learning path completed report

header Parameters

X-ASE-API-Token required	string <uuid>
X-ASE-Customer-ID required	string <uuid>

Responses

Response samples

200
400
500

Content type

application/json

{"message": "string",
"success": true,
"data": [{"completed_count": 0.1,
"lp": "string",
"learning_path_name": "string"
}
]
}

Get journey report

header Parameters

X-ASE-API-Token required	string <uuid>
X-ASE-Customer-ID required	string <uuid>

Request Body schema: application/json
required

Journey report request body

skip	integer Number of records to skip.
limit	integer Maximum number of records to return.

Responses

Request samples

Payload

Content type

application/json

{"skip": 0,
"limit": 0
}

Response samples

200
400
500

Content type

application/json

{"success": true,
"data": [{"journey_id": "string",
"enroll_count": 0,
"journey": {"proficiency": "string",
"id": "string",
"description": "string",
"logo": "string",
"duration": 0,
"name": "string"
}
}
]
}

Get user activity

header Parameters

X-ASE-API-Token required	string <uuid>
X-ASE-Customer-ID required	string <uuid>

Request Body schema: application/json
required

User activity request body

user_id

string

Responses

Request samples

Payload

Content type

application/json

{"user_id": "[email protected]"
}

Response samples

200
400
500

Content type

application/json

{"success": true,
"data": [{"activity": 0,
"date": "2019-08-24"
}
]
}

Get user report

header Parameters

X-ASE-API-Token required	string <uuid>
X-ASE-Customer-ID required	string <uuid>

Request Body schema: application/json
required

User report request body

user_id

string

Responses

Request samples

Payload

Content type

application/json

{"user_id": "[email protected]"
}

Response samples

200
400
500

Content type

application/json

{"success": true,
"error": true,
"data": {"challenges_completed": 0,
"labs_completed": 0,
"videos_completed": 0,
"badges": 0,
"total_enrolled": 0,
"dashboard": [{"activity": 0,
"date": "2019-08-24"
}
],
"total_course_minutes": 0,
"month_lab_minutes": 0,
"total_lab_minutes": 0
}
}

Get individual journey report

header Parameters

X-ASE-API-Token required	string <uuid>
X-ASE-Customer-ID required	string <uuid>

Request Body schema: application/json
required

Individual journey report request body

id	string Journey ID
skip	integer Number of records to skip
limit	integer Maximum number of records to return

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"skip": 0,
"limit": 0
}

Response samples

200
400
500

Content type

application/json

{"data": {"ttl": 0,
"logo": "string",
"name": "string",
"active": true,
"roles": ["string"
],
"events": ["string"
],
"proficiency": "string",
"id": "string",
"description": "string",
"type": "string",
"duration": 0,
"created_on": "2019-08-24T14:15:22Z",
"report": {"avg_user_progress": [{"email": "[email protected]",
"avg_progress": 0.1,
"first_name": "string",
"last_name": "string"
}
],
"avg_progress": 0.1,
"avg_course_progress": {"property1": 0.1,
"property2": 0.1
},
"completed": [{"email": "[email protected]",
"completed_courses": 0,
"first_name": "string",
"last_name": "string"
}
]
},
"skills": [{"date": "2019-08-24",
"topTag": "string",
"count": 0
}
]
},
"success": true,
"error": true
}

Get top users (overall or monthly)

header Parameters

X-ASE-API-Token required	string <uuid>
X-ASE-Customer-ID required	string <uuid>

Request Body schema: application/json
required

Top users report request body

select required	string Enum: "overall" "monthly"
query	string <yyyy-MM>

Responses

Request samples

Payload

Content type

application/json

{"select": "overall",
"query": "2023-05"
}

Response samples

200
400
500

Content type

application/json

{"success": true,
"data": {"data": [{"first_name": "User1",
"last_name": "User1",
"lab_minutes": 100,
"assignments_completed": 5,
"course_minutes": 200,
"email": "[email protected]",
"challenge_completed": 2
},
{"first_name": "User2",
"last_name": "User2",
"lab_minutes": 150,
"assignments_completed": 10,
"course_minutes": 250,
"email": "[email protected]",
"challenge_completed": 7
}
],
"badges": 10,
"total": 100
}
}

List all teams for a customer

header Parameters

X-ASE-API-Token required	string <uuid>
X-ASE-Customer-ID required	string <uuid>

Request Body schema: application/json

Optional pagination model for listing teams

pagination

string

Responses

Request samples

Payload

Content type

application/json

{"pagination": "string"
}

Response samples

200
400
500

Content type

application/json

{"success": true,
"error": false,
"data": {"Items": [{"stat": [{"lp": "AWS Security",
"duration": 1106,
"percentage": 19.56
},
{"lp": "Application Security",
"duration": 1025,
"percentage": 18.13
},
{"lp": "Advanced Application Security",
"duration": 1054,
"percentage": 18.64
},
{"lp": "DevSecOps",
"duration": 989,
"percentage": 17.49
},
{"lp": "Azure Security",
"duration": 219,
"percentage": 3.87
},
{"lp": "Kubernetes Security",
"duration": 1196,
"percentage": 21.15
},
{"lp": "Threat Modeling",
"duration": 66,
"percentage": 1.17
}
],
"team_name": "team Alpha",
"id": "team_2dd61b4c-46f5-487e-8ba0-ff00f69fcb15",
"search_name": "team alpha",
"type": "team#company_4923834b-81d4-4b2a-830c-d5e4382d4e89",
"created_on": "2024-09-04T07:45:07.976470",
"lab_minutes": 1940,
"video_minutes": 3711
},
{"stat": [{"lp": "AWS Security",
"duration": 1237,
"percentage": 23.31
},
{"lp": "Application Security",
"duration": 678,
"percentage": 12.78
},
{"lp": "Advanced Application Security",
"duration": 1074,
"percentage": 20.24
},
{"lp": "DevSecOps",
"duration": 706,
"percentage": 13.31
},
{"lp": "Azure Security",
"duration": 271,
"percentage": 5.11
},
{"lp": "Kubernetes Security",
"duration": 1185,
"percentage": 22.33
},
{"lp": "Threat Modeling",
"duration": 155,
"percentage": 2.92
}
],
"team_name": "Team Appsec",
"id": "team_32176c13-3fad-4925-9680-b83d8af1b6f8",
"search_name": "team appsec",
"type": "team#company_4923834b-81d4-4b2a-830c-d5e4382d4e89",
"created_on": "2024-07-29T11:16:28.388513",
"lab_minutes": 2655,
"video_minutes": 2647
}
]
}
}

List all assignments for a customer

header Parameters

X-ASE-API-Token required	string <uuid>
X-ASE-Customer-ID required	string <uuid>

Request Body schema: application/json

Optional pagination model for listing assignments

pagination

string

Responses

Request samples

Payload

Content type

application/json

{"pagination": "string"
}

Response samples

200
400
500

Content type

application/json

{"success": true,
"error": true,
"LastEvaluatedKey": "string",
"data": [{"id": "string",
"name": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"users": ["[email protected]"
]
}
]
}

Get assignment report

header Parameters

X-ASE-API-Token required	string
X-ASE-Customer-ID required	string

Request Body schema: application/json
required

Assignment report request body

id

string

Responses

Request samples

Payload

Content type

application/json

{"id": "assign_062c0918-e7eb-40e0-af3b-ecdca8b91f9f"
}

Response samples

200
400
500

Content type

application/json

{"success": true,
"error": false,
"data": {"end_date": "2025-03-05",
"pass_percentage": 100,
"search_name": "customized assignment setup",
"name": "Customized Assignment Setup",
"start_date": "2025-02-05",
"id": "assign_c03f07a4-e505-442e-88d6-8cf59fad25a9",
"is_active": true,
"users": ["[email protected]",
"[email protected]",
"[email protected]"
],
"verify_completion": true,
"created_on": "2025-02-04T14:09:18.347476+00:00",
"events": [{"id": "event_c47b1ea5-3610-4631-96d0-d20665081e07",
"event_name": "Essential AWS API Gateway Security",
"duration": 0
},
{"id": "event_7ec5e73e-306c-4bcf-aa3a-7957dd987515",
"event_name": "Essential AWS Security Monitoring with CloudWatch and CloudTrail",
"duration": 0
},
{"id": "event_fa606552-3481-4996-b874-606d21123f89",
"event_name": "AWS IAM Access Analyzer",
"duration": 0
},
{"id": "event_b83c1f03-4128-47f4-9097-9a99b525aa4b",
"event_name": "AWS IAM Roles Anywhere ",
"duration": 0
},
{"id": "event_ca5a34c0-7f4a-46a4-93b7-480258ad7b4e",
"event_name": "Auditing AWS Environments ",
"duration": 0
},
{"id": "event_9888a5a2-2d29-42a1-81e2-1e38d31d3377",
"event_name": "AWS Security Hub Essentials",
"duration": 0
},
{"id": "event_35eefb84-1ff7-4c01-a27b-86d52b7e8143",
"event_name": "Attacking AWS Serverless Applications",
"duration": 0
}
],
"teams": [{"id": "team_9351d584-cdd9-462c-bcbf-3f758277d4eb",
"name": "Content Team"
},
{"id": "team_615a6634-30e7-4804-9571-b2b1f01009ce",
"name": "Core Development"
}
],
"report": {"avg_progress": 0,
"avg_course_progress": 0,
"avg_user_progress": 0,
"completed": [{"email": "[email protected]",
"completed_courses": 1,
"duration": null,
"first_name": "John",
"last_name": "Doe"
},
{"completed_courses": 0,
"email": "[email protected]",
"duration": 0,
"first_name": "Jane",
"last_name": "Smith"
},
{"completed_courses": 0,
"email": "[email protected]",
"duration": 0,
"first_name": "Sarah",
"last_name": "Wilson"
},
{"completed_courses": 0,
"email": "[email protected]",
"duration": 0,
"first_name": "Alex",
"last_name": "Johnson"
},
{"completed_courses": 0,
"email": "[email protected]",
"duration": 0,
"first_name": "Robert",
"last_name": "Taylor"
},
{"completed_courses": 0,
"email": "[email protected]",
"duration": 0,
"first_name": "Michael",
"last_name": "Brown"
}
],
"issued_certs": [ ]
},
"skills": [{"date": "2025-02-22",
"topTag": "AWS Security",
"count": 4
},
{"date": "2025-02-26",
"topTag": "AWS Vulnerability Management",
"count": 5
}
]
}
}

List all the courses with SCORM package

header Parameters

X-ASE-API-Token required	string
X-ASE-Customer-ID required	string <uuid>

Request Body schema: application/json

Optional pagination token payload input

pagination

string

Optional pagination token

Responses

Request samples

Payload

Content type

application/json

{"pagination": "string"
}

Response samples

200
400
500

Content type

application/json

{"success": true,
"error": false,
"message": "Courses retrieved successfully",
"data": {"pagination": "eyJwYWdlIjoyLCJsaW1pdCI6MTB9",
"courses": [{"course_id": "event_582d95c9-a31d-42a0-9cf9-0b9f3b3208a7",
"proficiency": "Intermediate",
"skills": ["advanced-application-security",
"api-security"
],
"description": "something something",
"tags": ["Meta"
],
"is_active": true,
"logo": "https://img-logo",
"event_name": "API Security: Attack and Defense"
}
]
}
}

Create a new SCORM registration

header Parameters

X-ASE-API-Token required	string <uuid>
X-ASE-Customer-ID required	string <uuid>

Request Body schema: application/json
required

SCORM registration creation request

course_id required	string <uuid>
required	object (LearnerRegistration)

Responses

Request samples

Payload

Content type

application/json

{"course_id": "event_582d95c9-a31d-42a0-9cf9-0b9f3b3208a7",
"learner": {"learner_id": "194d34e2-fced-4b8e-9598-1dc77674bacf",
"email": "[email protected]",
"first_name": "john",
"last_name": "doe"
}
}

Response samples

400
500

Content type

application/json

{"success": true,
"error": true,
"message": "string"
}

List registrations for a specific course

header Parameters

X-ASE-API-Token required	string
X-ASE-Customer-ID required	string <uuid>

Request Body schema: application/json
required

Request body for listing registrations

course_id required	string ID of the course to list registrations for
pagination	string Optional pagination token

Responses

Request samples

Payload

Content type

application/json

{"course_id": "string",
"pagination": "string"
}

Response samples

200
400
500

Content type

application/json

{"message": "string",
"success": true,
"data": {"pagination": "string",
"data": [{"registration_id": "string",
"course_id": "string",
"progress": 0.1,
"learner": {"learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
"email": "[email protected]",
"first_name": "string",
"last_name": "string"
}
}
]
}
}

Launch a SCORM course registration

header Parameters

X-ASE-API-Token required	string <uuid>
X-ASE-Customer-ID required	string <uuid>

Request Body schema: application/json
required

Registration launch request

registration_id	string ID of the registration to launch
course_id	string ID of the course to launch the registration for

Responses

Request samples

Payload

Content type

application/json

{"registration_id": "string",
"course_id": "string"
}

Response samples

200
400
500

Content type

application/json

{"success": true,
"message": "string",
"data": "string"
}

AppSecEngineer Enterprise API (1.0.0)

Generating API Token and Customer ID

Get completed courses and assignments by user ID

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get active courses and assignments by user ID

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get company user statistics by user ID

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get team statistics

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get proficiency report

header Parameters

Responses

Response samples

Get learning path report

header Parameters

Responses

Response samples

Get learning path completed report

header Parameters

Responses

Response samples

Get journey report

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get user activity

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get user report

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get individual journey report

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get top users (overall or monthly)

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

List all teams for a customer

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

List all assignments for a customer

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required