Actions57
- Course Actions
- User Actions
- Assignment Actions
- Module Actions
- Page Actions
- Discussion Actions
- File Actions
- Announcement Actions
- Quiz Actions
- Submission Actions
- Enrollment Actions
- Group Actions
- Rubric Actions
Overview
This node integrates with the Canvas LMS API to manage enrollments within courses. Specifically, the "Enrollment" resource with the "Delete" operation allows users to remove an enrollment from a course by specifying the enrollment ID and the course ID.
Common scenarios where this node is beneficial include:
- Automating the removal of students or other users from a course when they no longer need access.
- Managing course rosters programmatically as part of administrative workflows.
- Cleaning up enrollments in bulk based on external triggers or conditions.
For example, an educational institution could use this node to automatically unenroll students who have dropped a course, ensuring their access is revoked promptly.
Properties
| Name | Meaning |
|---|---|
| Enrollment ID | The unique identifier of the enrollment to delete. This is required to specify which enrollment to remove. |
Output
The output JSON contains a data field that holds the response from the Canvas API after attempting to delete the enrollment. Typically, for a delete operation, this may be an empty object or confirmation of deletion depending on the API's response.
Example output structure:
{
"data": {}
}
No binary data is output by this node.
Dependencies
- Requires an API key credential for authenticating with the Canvas LMS API.
- The node expects the Canvas LMS base URL and an access token to be configured in the credentials.
- Network connectivity to the Canvas LMS API endpoint is necessary.
Troubleshooting
Error: "Error in 'enrollment' operation 'delete': ..."
This indicates a failure during the API request. Common causes include invalid enrollment ID, insufficient permissions, or network issues.
Resolution: Verify the enrollment ID is correct, ensure the API key has proper permissions, and check network connectivity.Authentication errors
If the API key or access token is invalid or expired, requests will fail.
Resolution: Reconfigure the API credentials with valid tokens.Missing required parameters
The node requires the enrollment ID and course ID to perform deletion. Omitting these will cause errors.
Resolution: Ensure all required fields are provided.