Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Adobe Captivate Enrollments API

Manage learner enrollments in courses and learning programs

Adobe Captivate Enrollments API is one of 16 APIs that Adobe Captivate publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

Tagged areas include Enrollments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 6 JSON Schemas.

This API exposes 4 operations across 2 paths, and defines 8 schemas. It is described by OpenAPI 3.1.0, at version 2.

Requests are made against a single base URL, https://learningmanager.adobe.com/primeapi/v2.

4 operations 2 paths 8 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2
Base URL
https://learningmanager.adobe.com/primeapi/v2
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Adobe Captivate Enrollments API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode and clientCredentials flows, exposing 4 scopes. By default, every request must be authenticated.

  • oauth2 — OAuth 2.0 authentication via Adobe IMS. Supports authorization code flow for user-context access and client credentials flow for application-level access.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Enrollments 4

Manage learner enrollments in courses and learning programs

GET
/enrollments
Adobe Captivate List Enrollments
getEnrollments 8 params → 200401
POST
/enrollments
Adobe Captivate Enroll a User
createEnrollment body → 201400409
GET
/enrollments/{enrollmentId}
Adobe Captivate Get an Enrollment
getEnrollment 2 params → 200404
DELETE
/enrollments/{enrollmentId}
Adobe Captivate Unenroll a User
unenrollUser 1 param → 204400404

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are ErrorResponse (5 properties), Enrollment (4 properties), PaginationLinks (3 properties), EnrollmentListResponse (2 properties). Each schema is shown below with its type and property counts.

EnrollmentCreateRequest
object
Request body for creating an enrollment
1 property 1 required
Relationship
object
A JSON:API relationship object
2 properties
ErrorResponse
object
Error response following JSON:API error format
5 properties
Enrollment
object
A learner's enrollment in a learning object instance
4 properties
ResourceIdentifier
object
JSON:API resource identifier
2 properties 2 required
EnrollmentResponse
object
Single enrollment response
1 property
EnrollmentListResponse
object
Paginated list of enrollments
2 properties
PaginationLinks
object
Pagination links following JSON:API conventions
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adobe-captivate-enrollments-api-openapi.yml Raw ↑

Other APIs Adobe Captivate publishes across the network.

Adobe Captivate SCORM API
Adobe Captivate xAPI (Tin Can API)
Adobe Captivate Review API
Adobe Learning Manager Webhooks API
Adobe Captivate Account API
Adobe Captivate Badges API
Adobe Captivate Catalogs API
Adobe Captivate Certifications API
Adobe Captivate Gamification API
Adobe Captivate Jobs API
Adobe Captivate Learning Objects API
Adobe Captivate Notifications API