- Category: education
- Auth: OAUTH2
- Composio-managed OAuth available? No
- Tools: 45
- Triggers: 0
- Slug:
D2LBRIGHTSPACE - Version: 20261101_00
Tools
Copy Role
Copy Role
D2LBRIGHTSPACE_COPY_ROLECreates a new role copied from an existing role in D2L Brightspace. Notes: - The new role will not have any capabilities upon the old role from which it was created - Some capabilities will be copied for the new role (e.g., if old role users could impersonate other old role users, new role users will be able to impersonate other new role users) - Additional capabilities must be manually created after copying Requires OAuth2 scope: - role:detail:create Available in API versions unstable (LMS v10.4.10+)Input Parameters
Output
Create Course Offering
Create Course Offering
D2LBRIGHTSPACE_CREATE_A_COURSE_OFFERINGCreates a new course offering in D2L Brightspace. Notes: - Course code limitations: max 50 chars, no special chars: \ : * ? ” < > | ’ # , % & - Path: leave empty if path enforcement is enabled - SemesterId: provide null if not using the Semester element - CanSelfRegister: required for API v1.28+, not supported before v1.28 Requires OAuth2 scope: - orgunits:course:create Available in API versions 1.46+ (LMS v20.24.3+)Input Parameters
Output
Create Course Template
Create Course Template
D2LBRIGHTSPACE_CREATE_A_COURSE_TEMPLATECreates a new course template in D2L Brightspace. Notes: - Course template code limitations: max 50 chars, no special chars: \ : * ? ” < > | ’ # , % & - Path: leave empty if path enforcement is enabled Requires OAuth2 scope: - orgunits:coursetemplate:create Available in API versions 1.46+ (LMS v20.24.3+)Input Parameters
Output
Create Grade Object
Create Grade Object
D2LBRIGHTSPACE_CREATE_GRADE_OBJECTCreates a new grade object for a particular org unit. The grade object can be one of four types: 1. Numeric: For numeric grades with max points 2. PassFail: For pass/fail assessments 3. SelectBox: For predefined grade options 4. Text: For text-only feedback Returns a GradeObject JSON block containing the created grade object’s data, including its assigned ID. Requires OAuth2 scope: - grades:gradeobjects:write Available in API versions 1.75+ (LMS v20.24.5+)Input Parameters
Output
Create Quiz
Create Quiz
D2LBRIGHTSPACE_CREATE_QUIZCreates a new quiz in D2L Brightspace. Notes: - NumberOfAttemptsAllowed must be between 1 and 10 (inclusive) or null for unlimited - Password must not be empty or whitespace if provided - NotificationEmail must be a valid email address if provided - TimeLimitValue: 0 for no limit (with IsEnforced false), or 1-9999 for enforced limit - DeductionPercentage must be between 0 and 100 if provided - As of LE API v1.71: - LateLimitMinutes is ignored - LateSubmissionOption 1 is treated as 2 (AutoSubmitAttempt) - SubmissionGracePeriod is not used - PagingTypeId added in LE API v1.78 - Date fields should be in UTC format Requires OAuth2 scopes: - quizzing:quizzes:read - quizzing:quizzes:create Available in API versions 1.75+ (LMS v20.24.5+)Input Parameters
Output
Create Quiz Category
Create Quiz Category
D2LBRIGHTSPACE_CREATE_QUIZ_CATEGORYCreates a new quiz category in D2L Brightspace. Returns a QuizCategoryReadData JSON block containing: - CategoryId: The ID of the created category - Name: The name of the category - SortOrder: The sort order value Requires OAuth2 scopes: - quizzing:quizzes:read - quizzing:quizzes:create Available in API versions 1.75+ (LMS v20.24.5+)Input Parameters
Output
Create User
Create User
D2LBRIGHTSPACE_CREATE_USERCreates a new user entity in D2L Brightspace. Requires OAuth2 scope: - users:userdata:create Available in API versions 1.46+ (LMS v20.24.3+) Notes: - FirstName and LastName are used as legal names - ExternalEmail must be null or a valid email address - OrgDefinedId must be unique across the organization if provided - Preferred names must be set separately after user creationInput Parameters
Output
Delete Course Template
Delete Course Template
Delete Course
Delete Course
D2LBRIGHTSPACE_DELETE_COURSEDeletes a course offering from D2L Brightspace. Requires OAuth2 scope: - orgunits:course:delete Available in API versions 1.46+ (LMS v20.24.3+)Input Parameters
Output
Delete Grade Object
Delete Grade Object
Delete Quiz
Delete Quiz
Delete Quiz Category
Delete Quiz Category
Delete User
Delete User
D2LBRIGHTSPACE_DELETE_USERDeletes a user entity from D2L Brightspace. Requires OAuth2 scope: - users:userdata:delete Available in API versions 1.46+ (LMS v20.24.3+)Input Parameters
Output
Delete User Demographics
Delete User Demographics
D2LBRIGHTSPACE_DELETE_USER_DEMOGRAPHICSDeletes a user’s demographics entries: a nonempty list of entry IDs selects entries, while an omitted or empty list deletes all entries. Requires OAuth2 scope demographics:user:delete; available in API versions 1.46+ (LMS v20.24.3+).Input Parameters
Output
Get Course Offering
Get Course Offering
D2LBRIGHTSPACE_GET_A_COURSE_OFFERINGRetrieves a specific course offering from D2L Brightspace. Returns a CourseOffering JSON block with the course’s information. Requires OAuth2 scope: - orgunits:course:read Available in API versions 1.46+ (LMS v20.24.3+)Input Parameters
Output
Get Course Template
Get Course Template
Get Course Schema
Get Course Schema
Get Course Template Schema
Get Course Template Schema
Get Current User Information
Get Current User Information
Get Enrolled Roles
Get Enrolled Roles
D2LBRIGHTSPACE_GET_ENROLLED_ROLESRetrieves a list of all enrolled user roles the calling user can view in an org unit. Returns a JSON array of Role data blocks containing the properties of all user roles that the calling user context has permission to view and that are currently enrolled in the provided org unit. Requires OAuth2 scope: - role:detail:read Available in API versions 1.46+ (LMS v20.24.3+)Input Parameters
Output
Get Grade Access
Get Grade Access
D2LBRIGHTSPACE_GET_GRADE_ACCESSRetrieves a list of users with access to a specified grade. Returns an ObjectListPage containing UserAccess blocks. Can optionally filter by specific user ID or role ID. Requires OAuth2 scope: - grades:access:read Available in API versions 1.75+ (LMS v20.24.5+)Input Parameters
Output
Get Grade Object
Get Grade Object
Get Grade Objects
Get Grade Objects
Get Grade Setup
Get Grade Setup
Get Grade Statistics
Get Grade Statistics
D2LBRIGHTSPACE_GET_GRADE_STATISTICSRetrieves statistics for a specified grade item. Returns a GradeStatisticsInfo JSON block containing statistical data about the grade item. Requires OAuth2 scope: - grades:gradestatistics:read Available in API versions 1.75+ (LMS v20.24.5+)Input Parameters
Output
Get Org Unit Demographics
Get Org Unit Demographics
D2LBRIGHTSPACE_GET_ORG_UNIT_DEMOGRAPHICSRetrieves all demographics entries for users enrolled in a particular org unit. Notes: - Filters are applied cumulatively (all conditions must match) - When using ID lists in filters, matching any ID in the list satisfies that filter - For example: with roleIds=[1,2], userIds=[3,4], search=“value”: * Users must have role 1 OR 2 (either role matches) * AND must have ID 3 OR 4 (either ID matches) * AND must have a field matching “value” - Results are paged; use bookmark parameter for subsequent pages Requires OAuth2 scope: - demographics:orgunit:read Available in API versions 1.46+ (LMS v20.24.3+)Input Parameters
Output
Get Quiz
Get Quiz
D2LBRIGHTSPACE_GET_QUIZRetrieves a specific quiz from an org unit. Returns a QuizReadData JSON block containing the quiz’s properties. Requires OAuth2 scope: - quizzing:quizzes:read Available in API versions 1.75+ (LMS v20.24.5+)Input Parameters
Output
Get Quiz Access
Get Quiz Access
D2LBRIGHTSPACE_GET_QUIZ_ACCESSRetrieves a list of users with access to a specified quiz. Returns an ObjectListPage JSON block containing a list of UserAccess blocks. Can filter by specific user ID or role ID. Requires OAuth2 scope: - quizzing:access:read Available in API versions 1.75+ (LMS v20.24.5+)Input Parameters
Output
Get Quiz Attempt
Get Quiz Attempt
D2LBRIGHTSPACE_GET_QUIZ_ATTEMPTRetrieves a specific quiz attempt. Returns a QuizAttemptData JSON block containing the attempt’s properties. Requires OAuth2 scope: - quizzing:attempts:read Available in API versions 1.75+ (LMS v20.24.5+)Input Parameters
Output
Get Quiz Attempts
Get Quiz Attempts
D2LBRIGHTSPACE_GET_QUIZ_ATTEMPTSRetrieves a page of quiz attempts, optionally filtered by user, in a result field. Requires OAuth2 scope quizzing:attempts:read; available in API versions 1.75+ (LMS v20.24.5+).Input Parameters
Output
Get Quiz Categories
Get Quiz Categories
D2LBRIGHTSPACE_GET_QUIZ_CATEGORIESRetrieves all quiz categories belonging to an org unit. Returns an ObjectListPage JSON block containing a list of QuizCategoryReadData blocks. Requires OAuth2 scope: - quizzing:quizzes:read Available in API versions 1.75+ (LMS v20.24.5+)Input Parameters
Output
Get Quiz Category
Get Quiz Category
Get Quiz Questions
Get Quiz Questions
D2LBRIGHTSPACE_GET_QUIZ_QUESTIONSRetrieves a page of questions in a quiz as an ObjectListPage of QuestionData blocks; use the bookmark from the next-page URL to retrieve further pages. Requires OAuth2 scope quizzing:quizzes:read; available in API versions 1.75+ (LMS v20.24.5+).Input Parameters
Output
Get Quizzes
Get Quizzes
Get Role by ID
Get Role by ID
Get Roles
Get Roles
D2LBRIGHTSPACE_GET_ROLESRetrieves a list of all known user roles in D2L Brightspace. Returns a list of Role data blocks containing the properties of all user roles that the calling user context has permission to manage. Requires OAuth2 scope: - role:detail:read Available in API versions 1.46+ (LMS v20.24.3+)Output
Get User by ID
Get User by ID
Get Users
Get Users
D2LBRIGHTSPACE_GET_USERSRetrieves user data in a result field, optionally filtered by organization-defined ID, username, or external email, and accepts a bookmark for a subsequent segment. Requires OAuth2 scope users:userdata:read; available in API versions 1.46+ (LMS v20.24.3+).Input Parameters
Output
Update Course Offering
Update Course Offering
D2LBRIGHTSPACE_UPDATE_A_COURSE_OFFERINGUpdates an existing course offering in D2L Brightspace. Notes: - Course code limitations: max 50 chars, no special chars: \ : * ? ” < > | ’ # , % & - StartDate/EndDate: null values won’t overwrite existing dates - CanSelfRegister: required for API v1.27+, not supported before v1.27 - Description: ignored in API versions 1.25 and earlier Requires OAuth2 scope: - orgunits:course:update Available in API versions 1.46+ (LMS v20.24.3+)Input Parameters
Output
Update Course Template
Update Course Template
D2LBRIGHTSPACE_UPDATE_A_COURSE_TEMPLATEUpdates an existing course template in D2L Brightspace. Notes: - This action completely replaces the template’s data with the provided values - Course template code limitations: max 50 chars, no special chars: \ : * ? ” < > | ’ # , % & Available in API versions 1.46+ (LMS v20.24.3+)Input Parameters
Output
Update Grade Object
Update Grade Object
D2LBRIGHTSPACE_UPDATE_GRADE_OBJECTUpdates a specific grade object. The grade object can be one of four types: 1. Numeric: For numeric grades with max points 2. PassFail: For pass/fail assessments 3. SelectBox: For predefined grade options 4. Text: For text-only feedback Note: The provided data completely replaces the existing grade object’s data. Returns a GradeObject JSON block containing the updated grade object’s data. Requires OAuth2 scope: - grades:gradeobjects:write Available in API versions 1.75+ (LMS v20.24.5+)Input Parameters
Output
Update Grade Setup
Update Grade Setup
D2LBRIGHTSPACE_UPDATE_GRADE_SETUPUpdates the grades configuration for an org unit. Expects a GradeSetupInfo JSON block containing: - GradingSystem: The grading system type - IsNullGradeZero: Whether null grades should be treated as zero - DefaultGradeSchemeId: ID of the default grade scheme Returns the updated GradeSetupInfo JSON block. Requires OAuth2 scope: - grades:gradesettings:write Available in API versions 1.75+ (LMS v20.24.5+)Input Parameters
Output
Update Quiz
Update Quiz
Update Quiz Category
Update Quiz Category
D2LBRIGHTSPACE_UPDATE_QUIZ_CATEGORYUpdates an existing quiz category in D2L Brightspace. Returns a QuizCategoryReadData JSON block containing: - CategoryId: The ID of the category - Name: The name of the category - SortOrder: The sort order value Requires OAuth2 scopes: - quizzing:quizzes:read - quizzing:quizzes:write Available in API versions 1.75+ (LMS v20.24.5+)Input Parameters
Output
Update User
Update User
D2LBRIGHTSPACE_UPDATE_USERUpdates an existing user entity in D2L Brightspace. Requires OAuth2 scope: - users:userdata:update Available in API versions 1.46+ (LMS v20.24.3+) Notes: - FirstName and LastName update preferred names if set, otherwise update legal names - ExternalEmail must be null or a valid email address - OrgDefinedId must be unique across the organization if provided - Pronouns: use empty string ("") to reset, null to keep existing value