# mulesoft Canvas Connector - Full Documentation --- product: Canvas Connector version: 1.0 --- # Canvas Connector 1.0 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Canvas (Canvas Connector) enables Mule applications to access the Canvas API. For information about compatibility and fixed issues, refer to the Canvas Connector Release Notes. ## Before You Begin To use this connector, you must be familiar with: - The Canvas Connector’s API - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - How to create a Mule app using Anypoint Code Builder or Anypoint Studio Before creating an app, you must have: - Credentials to access the Canvas target resource - Anypoint Platform - The latest versions of Anypoint Code Builder or Anypoint Studio ## Next Step After you complete the prerequisites, you’re ready to create an app and configure the connector using [Anypoint Studio](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio) or [Anypoint Code Builder](https://docs.mulesoft.com/connectors/introduction/intro-config-use-acb). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Canvas Connector Reference](https://docs.mulesoft.com/canvas-connector/1.0/canvas-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: Canvas Connector version: 1.0 --- # Canvas Connector 1.0 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Canvas (Canvas Connector) enables Mule applications to access the Canvas API. ## Configurations --- ### Config Default configuration. #### Parameters

Name	Type	Description	Required
Name	String	The name for this configuration. Connectors reference the configuration with this name.	x
Connection	OAuth 2.0	The connection types to provide to this configuration.	x
Name	String	The identifier of this element used to reference it in other components.	x
Expiration Policy	Expiration Policy	Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

#### Connection Types ##### OAuth 2.0 Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). ###### Parameters

Name	Type	Description	Default Value	Required
baseUri	String	Base URI for Canvas API requests.		x
TLS Configuration	TLS	TLS settings for HTTPS connections to the authorization server.
Reconnection	Reconnection	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.
Consumer Key	String	The OAuth consumer key as registered with the service provider.		x
Consumer Secret	String	The OAuth consumer secret as registered with the service provider.		x
Authorization Url	String	The service provider’s authorization endpoint URL.	`https://salesforce.instructure.com/login/oauth2/auth`
Access Token Url	String	The service provider’s access token endpoint URL.	`https://salesforce.instructure.com/login/oauth2/token`
Scopes	String	The OAuth scopes to request during the OAuth dance. If not provided, defaults to those in the annotation.	*
Resource Owner Id	String	The resource owner ID each component uses when not set otherwise.
Before	String	The name of a flow to run immediately before the OAuth dance starts.
After	String	The name of a flow to run immediately after an access token is received.
Auth Server Tls Context	TLS	TLS context for HTTP requests to the authorization server during the OAuth dance.
Auth Server Proxy Config	Any	Proxy configuration for HTTP requests during the OAuth dance.
Listener Config	String	A reference to an `http:listener-config` element used to create the listener for the access token callback.		x
Callback Path	String	Path of the access token callback endpoint.		x
Authorize Path	String	Path of the local HTTP endpoint that starts the OAuth dance.		x
External Callback Url	String	If the callback is behind a proxy or reachable only indirectly, the URL the OAuth provider should use to reach the callback.
Object Store	String	Object store for persisting each resource owner’s OAuth data. If omitted, the runtime provisions the default store.

## Supported Operations - [Account Get A Single Account](#AccountGetASingleAccount) - [Account Get The Sub Accounts Of An Account](#AccountGetTheSubAccountsOfAnAccount) - [Account List Accounts](#AccountListAccounts) - [Account List Active Courses In An Account](#AccountListActiveCoursesInAnAccount) - [Assignment Groups List Assignment Groups](#AssignmentGroupsListAssignmentGroups) - [Assignment List Assignments](#AssignmentListAssignments) - [Assignment List Assignments By Assignment Groups](#AssignmentListAssignmentsByAssignmentGroups) - [Course Create A New Course](#CourseCreateANewCourse) - [Course Delete Conclude A Course](#CourseDeleteConcludeACourse) - [Course Get A Single Course](#CourseGetASingleCourse) - [Course Get Bulk User Progress](#CourseGetBulkUserProgress) - [Course Get Single User](#CourseGetSingleUser) - [Course Get User Progress](#CourseGetUserProgress) - [Course List Courses For Users](#CourseListCoursesForUsers) - [Course List Users In Course](#CourseListUsersInCourse) - [Course Update A Course](#CourseUpdateACourse) - [Enrollment Conclude Deactivate Or Delete An Enrollment](#EnrollmentConcludeDeactivateOrDeleteAnEnrollment) - [Enrollment Enroll A User In A Section](#EnrollmentEnrollAUserInASection) - [Enrollment Enroll Multiple Users To One Or More](#EnrollmentEnrollMultipleUsersToOneOrMore) - [Enrollment Enroll User In A Course](#EnrollmentEnrollUserInACourse) - [Enrollment Get Enrollment By ID](#EnrollmentGetEnrollmentById) - [Enrollment List Course Enrollments](#EnrollmentListCourseEnrollments) - [Enrollment List Section Enrollments](#EnrollmentListSectionEnrollments) - [Enrollment List User Enrollments](#EnrollmentListUserEnrollments) - [Enrollment Reactivate An Enrollment](#EnrollmentReactivateAnEnrollment) - [Enrollment Terms Create Enrollment Term](#EnrollmentTermsCreateEnrollmentTerm) - [Enrollment Terms Delete Enrollment Term](#EnrollmentTermsDeleteEnrollmentTerm) - [Enrollment Terms List Enrollment Terms](#EnrollmentTermsListEnrollmentTerms) - [Enrollment Terms Retrieve Enrollment Term](#EnrollmentTermsRetrieveEnrollmentTerm) - [Enrollment Terms Update Enrollment Term](#EnrollmentTermsUpdateEnrollmentTerm) - [Login Create A User Login](#LoginCreateAUserLogin) - [Login Delete A User Login](#LoginDeleteAUserLogin) - [Login Edit A User Login](#LoginEditAUserLogin) - [Roles Get A Single Role](#RolesGetASingleRole) - [Roles List Roles](#RolesListRoles) - [Section Create Course Section](#SectionCreateCourseSection) - [Section Cross List A Section](#SectionCrossListASection) - [Section De Cross List A Section](#SectionDeCrossListASection) - [Section Delete A Section](#SectionDeleteASection) - [Section Edit A Section](#SectionEditASection) - [Section Get Section Information](#SectionGetSectionInformation) - [Section List Course Sections](#SectionListCourseSections) - [Submission List Submissions For Multiple Assignments](#SubmissionListSubmissionsForMultipleAssignments) - [Submission List Submissions From Course Section](#SubmissionListSubmissionsFromCourseSection) - [User Create A User](#UserCreateAUser) - [User Edit A User](#UserEditAUser) - [User List Upcoming Assignments And Calendar Events](#UserListUpcomingAssignmentsAndCalendarEvents) - [User List Users In Account](#UserListUsersInAccount) - [User Show User Details](#UserShowUserDetails) - [Users List Missing Submissions](#UsersListMissingSubmissions) ## Operations ## Account Get A Single Account `` Retrieves a single Canvas account by ID. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Account Get The Sub Accounts Of An Account `` Lists sub-accounts under a Canvas account, optionally including nested accounts. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
recursive	Boolean	Whether to include nested sub-accounts.	false
order	Enumeration, one of: id name	Sort order for sub-accounts in the response.
include[]	String	Optional associations or nested objects to include in the response.
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Account List Accounts `` Lists Canvas accounts available to the authenticated user. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
include[]	String	Optional associations or nested objects to include in the response.
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Account List Active Courses In An Account `` Lists active courses for a Canvas account. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Assignment Groups List Assignment Groups `` Lists assignment groups for a course. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Assignment List Assignments `` Lists assignments for a course. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Assignment List Assignments By Assignment Groups `` Lists assignments within a specific assignment group for a course. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
assignment_group_id	String	Canvas assignment group ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Course Create A New Course `` Creates a new course in a Canvas account. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
correlationId	String	Optional correlation ID for the request.
body	Any	Request body for the Canvas API operation.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Course Delete Conclude A Course `` Deletes or concludes a course, depending on the selected event. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
ID	String	Canvas resource ID.		x
event	Enumeration, one of: delete conclude	Whether to delete or conclude the course.
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Course Get A Single Course `` Retrieves details for a single course. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Course Get Bulk User Progress `` Retrieves progress data for multiple users in a course. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Course Get Single User `` Retrieves a single user’s course enrollment and related profile information. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Course Get User Progress `` Retrieves progress for one user in a course. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
user_id	String	Canvas user ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Course List Courses For Users `` Lists courses for one or more users. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
user_id	String	Canvas user ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Course List Users In Course `` Lists users enrolled in a course with optional search, filter, and include options. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
search_term	String	Term used to filter results.
sort	Enumeration, one of: username last_login email sis_id	Sort field for users returned from the course.
enrollment_type[]	String	Enrollment types to include when listing users.
enrollment_role	String	Enrollment role name filter.
enrollment_role_id	Number	Enrollment role ID filter.
section_ids[]	Number	Section IDs to restrict the user list.
include[]	String	Optional associations or nested objects to include in the response.
user_id	String	Canvas user ID.
user_ids[]	Number	Specific user IDs to return.
enrollment_state[]	String	Enrollment states to include when listing users.
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Course Update A Course `` Updates an existing course. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
body	Any	Request body for the Canvas API operation.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED - CANVAS:UNPROCESSABLE\_ENTITY ## Enrollment Conclude Deactivate Or Delete An Enrollment `` Concludes, deactivates, deletes, or inactivates a course enrollment based on the selected task. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
ID	String	Canvas resource ID.		x
task	Enumeration, one of: conclude deactivate delete inactivate	Enrollment action to perform on the enrollment record.
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Enrollment Enroll A User In A Section `` Enrolls a user in a course section. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
section_id	String	Canvas course section ID.		x
correlationId	String	Optional correlation ID for the request.
body	Any	Request body for the Canvas API operation.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED - CANVAS:UNPROCESSABLE\_ENTITY ## Enrollment Enroll Multiple Users To One Or More `` Enrolls multiple users in one or more courses or sections in a single request. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
correlationId	String	Optional correlation ID for the request.
body	Any	Request body for the Canvas API operation.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Enrollment Enroll User In A Course `` Enrolls a user in a course. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
correlationId	String	Optional correlation ID for the request.
body	Any	Request body for the Canvas API operation.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED - CANVAS:UNPROCESSABLE\_ENTITY ## Enrollment Get Enrollment By ID `` Retrieves a single enrollment record by ID. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Enrollment List Course Enrollments `` Lists enrollments for a course with optional filters. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
type[]	String	Enrollment types to include in the list.
role[]	String	Role filters for the enrollment list.
state[]	String	Enrollment states to include in the list.
include[]	String	Optional associations or nested objects to include in the response.
user_id	String	Canvas user ID.
grading_period_id	Number	Grading period ID filter for submissions.
enrollment_term_id	Number	Enrollment term ID filter.
sis_account_id[]	String	SIS account IDs to match.
sis_course_id[]	String	SIS course IDs to match.
sis_section_id[]	String	SIS section IDs to match.
sis_user_id[]	String	SIS user IDs to match.
created_for_sis_id[]	Boolean	Whether to limit results to users created for SIS.	false
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Enrollment List Section Enrollments `` Lists enrollments for a course section. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
section_id	String	Canvas course section ID.		x
type[]	String	Enrollment types to include in the list.
role[]	String	Role filters for the enrollment list.
state[]	String	Enrollment states to include in the list.
include[]	String	Optional associations or nested objects to include in the response.
user_id	String	Canvas user ID.
grading_period_id	Number	Grading period ID filter for submissions.
enrollment_term_id	Number	Enrollment term ID filter.
sis_account_id[]	String	SIS account IDs to match.
sis_course_id[]	String	SIS course IDs to match.
sis_section_id[]	String	SIS section IDs to match.
sis_user_id[]	String	SIS user IDs to match.
created_for_sis_id[]	Boolean	Whether to limit results to users created for SIS.	false
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED - CANVAS:UNPROCESSABLE\_ENTITY ## Enrollment List User Enrollments `` Lists course and section enrollments for a user. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
user_id	String	Canvas user ID.		x
type[]	String	Enrollment types to include in the list.
role[]	String	Role filters for the enrollment list.
state[]	String	Enrollment states to include in the list.
include[]	String	Optional associations or nested objects to include in the response.
grading_period_id	Number	Grading period ID filter for submissions.
enrollment_term_id	Number	Enrollment term ID filter.
sis_account_id[]	String	SIS account IDs to match.
sis_course_id[]	String	SIS course IDs to match.
sis_section_id[]	String	SIS section IDs to match.
sis_user_id[]	String	SIS user IDs to match.
created_for_sis_id[]	Boolean	Whether to limit results to users created for SIS.	false
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Enrollment Reactivate An Enrollment `` Reactivates a previously concluded or inactive enrollment. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Enrollment Terms Create Enrollment Term `` Creates a new enrollment term in a Canvas account. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
correlationId	String	Optional correlation ID for the request.
body	Any	Request body for the Canvas API operation.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Enrollment Terms Delete Enrollment Term `` Deletes an enrollment term. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Enrollment Terms List Enrollment Terms `` Lists enrollment terms for a Canvas account. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Enrollment Terms Retrieve Enrollment Term `` Retrieves a single enrollment term by ID. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Enrollment Terms Update Enrollment Term `` Updates an existing enrollment term. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
body	Any	Request body for the Canvas API operation.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Login Create A User Login `` Creates a login for a Canvas user. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
correlationId	String	Optional correlation ID for the request.
body	Any	Request body for the Canvas API operation.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Login Delete A User Login `` Deletes a user login. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
user_id	String	Canvas user ID.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Login Edit A User Login `` Updates an existing user login. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
body	Any	Request body for the Canvas API operation.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Roles Get A Single Role `` Retrieves a single account role by ID. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
ID	String	Canvas resource ID.		x
role_id	String	Role ID for the enrollment.
role	String	Role name for the enrollment.
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Roles List Roles `` Lists roles defined for a Canvas account. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
state[]	Array of String	Enrollment states to include in the list.
show_inherited	Boolean	Whether to include inherited enrollments.	false
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Section Create Course Section `` Creates a new section in a course. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
correlationId	String	Optional correlation ID for the request.
body	Any	Request body for the Canvas API operation.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED - CANVAS:UNPROCESSABLE\_ENTITY ## Section Cross List A Section `` Cross-lists a section into another course. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
ID	String	Canvas resource ID.		x
new_course_id	String	Target course ID for cross-listing.		x
correlationId	String	Optional correlation ID for the request.
body	Any	Request body for the Canvas API operation.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED - CANVAS:UNPROCESSABLE\_ENTITY ## Section De Cross List A Section `` Removes a cross-listed section from a target course. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
ID	String	Canvas resource ID.		x
override_sis_stickiness	Boolean	Whether to override SIS stickiness when updating the course.	false
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED - CANVAS:UNPROCESSABLE\_ENTITY ## Section Delete A Section `` Deletes a course section. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED - CANVAS:UNPROCESSABLE\_ENTITY ## Section Edit A Section `` Updates attributes of a course section. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
body	Any	Request body for the Canvas API operation.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED - CANVAS:UNPROCESSABLE\_ENTITY ## Section Get Section Information `` Retrieves details for a single course section. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
ID	String	Canvas resource ID.		x
include[]	String	Optional associations or nested objects to include in the response.
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Section List Course Sections `` Lists all sections for a course. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
include[]	String	Optional associations or nested objects to include in the response.
search_term	String	Term used to filter results.
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Submission List Submissions For Multiple Assignments `` Lists student submissions across multiple assignments in a course. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
student_ids[]	String	Student user IDs to filter submissions.
assignment_ids[]	String	Assignment IDs to filter submissions.
grouped	Boolean	Whether to group results by student.	false
post_to_sis	Boolean	Whether to include only assignments posted to SIS.	false
submitted_since	String	ISO-8601 timestamp; returns submissions submitted on or after this time.
graded_since	String	ISO-8601 timestamp; returns submissions graded on or after this time.
grading_period_id	Number	Grading period ID filter for submissions.
workflow_state	Enumeration, one of: submitted unsubmitted graded pending_review	Filters submissions by workflow state.
enrollment_state	Enumeration, one of: active concluded	Filters submissions by enrollment state.
state_based_on_date	Boolean	Whether to scope workflow state by date.	false
order	Enumeration, one of: id graded_at	Sort order for submissions in the response.
order_direction	Enumeration, one of: ascending descending	Sort direction for the ordered submission list.
include[]	String	Optional associations or nested objects to include in the response.
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Submission List Submissions From Course Section `` Lists submissions for assignments in a course section. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
section_id	String	Canvas course section ID.		x
student_ids[]	String	Student user IDs to filter submissions.
assignment_ids[]	String	Assignment IDs to filter submissions.
grouped	Boolean	Whether to group results by student.	false
post_to_sis	Boolean	Whether to include only assignments posted to SIS.	false
submitted_since	String	ISO-8601 timestamp; returns submissions submitted on or after this time.
graded_since	String	ISO-8601 timestamp; returns submissions graded on or after this time.
grading_period_id	Number	Grading period ID filter for submissions.
workflow_state	Enumeration, one of: submitted unsubmitted graded pending_review	Filters submissions by workflow state.
enrollment_state	Enumeration, one of: active concluded	Filters submissions by enrollment state.
state_based_on_date	Boolean	Whether to scope workflow state by date.	false
order	Enumeration, one of: id graded_at	Sort order for submissions in the response.
order_direction	Enumeration, one of: ascending descending	Sort direction for the ordered submission list.
include[]	String	Optional associations or nested objects to include in the response.
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED - CANVAS:UNPROCESSABLE\_ENTITY ## User Create A User `` Creates a new user in a Canvas account. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
correlationId	String	Optional correlation ID for the request.
body	Any	Request body for the Canvas API operation.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED - CANVAS:UNPROCESSABLE\_ENTITY ## User Edit A User `` Updates an existing Canvas user. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
body	Any	Request body for the Canvas API operation.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## User List Upcoming Assignments And Calendar Events `` Lists upcoming assignments and calendar events for the authenticated user. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## User List Users In Account `` Lists users in a Canvas account. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## User Show User Details `` Retrieves profile and related details for a single user. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Users List Missing Submissions `` Lists missing submissions for a student, optionally scoped by courses and filters. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
user_id	String	Canvas user ID.		x
observed_user_id	String	Observed user ID for the missing submissions query.
include[]	String	Optional associations or nested objects to include in the response.
filter[]	String	Filters to apply to missing submissions results.
course_ids[]	String	Course IDs to scope missing submissions.
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

Field	Type	Description
Enabled Protocols	String	A comma-separated list of protocols enabled for this context.
Enabled Cipher Suites	String	A comma-separated list of cipher suites enabled for this context.
Trust Store	Trust Store	Trust store configuration for validating remote certificates.
Key Store	Key Store	Key store configuration for client certificate authentication.
Revocation Check	Standard Revocation Check Custom Ocsp Responder Crl File	Certificate revocation checking configuration.

### Trust Store

Field	Type	Description
Path	String	The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.
Password	String	The password used to protect the trust store.
Type	String	The type of store used.
Algorithm	String	The algorithm used by the trust store.
Insecure	Boolean	If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

### Key Store

Field	Type	Description
Path	String	The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.
Type	String	The type of store used.
Alias	String	When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.
Key Password	String	The password used to protect the private key.
Password	String	The password used to protect the key store.
Algorithm	String	The algorithm used by the key store.

### Standard Revocation Check

Field	Type	Description
Only End Entities	Boolean	Only verify the last element of the certificate chain.
Prefer Crls	Boolean	Try CRL instead of OCSP first.
No Fallback	Boolean	Do not use the secondary checking method (the one not selected before).
Soft Fail	Boolean	Avoid verification failure when the revocation server can not be reached or is busy.

### Custom Ocsp Responder

Field	Type	Description	Default Value	Required
Url	String	The URL of the OCSP responder.
Cert Alias	String	Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

### Crl File

Field	Type	Description	Default Value	Required
Path	String	The path to the CRL file.

### Reconnection

Field	Type	Description	Default Value	Required
Fails Deployment	Boolean	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.
Reconnection Strategy	Reconnect Reconnect Forever	The reconnection strategy to use.

### Reconnect

Field	Type	Description
Frequency	Number	How often in milliseconds to reconnect.
Blocking	Boolean	If false, the reconnection strategy runs in a separate, non-blocking thread.
Count	Number	How many reconnection attempts to make.

### Reconnect Forever

Field	Type	Description	Default Value	Required
Frequency	Number	How often in milliseconds to reconnect.
Blocking	Boolean	If false, the reconnection strategy runs in a separate, non-blocking thread.

### Expiration Policy

Field	Type	Description	Default Value	Required
Max Idle Time	Number	A scalar time value for the maximum amount of time a dynamic configuration instance may remain idle before it is eligible for expiration.
Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit for the Max Idle Time field.

### Error Mapping

Field	Type	Description	Default Value	Required
Source	Enumeration, one of: ANY REDELIVERY_EXHAUSTED TRANSFORMATION EXPRESSION SECURITY CLIENT_SECURITY SERVER_SECURITY ROUTING CONNECTIVITY RETRY_EXHAUSTED TIMEOUT	Source Mule error type to map.
Target	String	Target error type identifier.		x

--- product: Canvas Connector version: 1.1 is-latest-version: true --- # Canvas Connector 1.1 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Canvas (Canvas Connector) enables Mule applications to access the Canvas API. For information about compatibility and fixed issues, refer to the Canvas Connector Release Notes. ## Before You Begin To use this connector, you must be familiar with: - The Canvas Connector’s API - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - How to create a Mule app using Anypoint Code Builder or Anypoint Studio Before creating an app, you must have: - Credentials to access the Canvas target resource - Anypoint Platform - The latest versions of Anypoint Code Builder or Anypoint Studio ## Next Step After you complete the prerequisites, you’re ready to create an app and configure the connector using [Anypoint Studio](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio) or [Anypoint Code Builder](https://docs.mulesoft.com/connectors/introduction/intro-config-use-acb). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Canvas Connector Reference](https://docs.mulesoft.com/canvas-connector/latest/canvas-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: Canvas Connector version: 1.1 is-latest-version: true --- # Canvas Connector 1.1 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Canvas (Canvas Connector) enables Mule applications to access the Canvas API. ## Configurations --- ### Config Default configuration. #### Parameters

Name	Type	Description	Required
Name	String	The name for this configuration. Connectors reference the configuration with this name.	x
Connection	OAuth 2.0	The connection types to provide to this configuration.	x
Name	String	The identifier of this element used to reference it in other components.	x
Expiration Policy	Expiration Policy	Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

Name	Type	Description	Default Value	Required
baseUri	String	Base URI for Canvas API requests.		x
TLS Configuration	TLS	TLS settings for HTTPS connections to the authorization server.
Reconnection	Reconnection	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.
Consumer Key	String	The OAuth consumer key as registered with the service provider.		x
Consumer Secret	String	The OAuth consumer secret as registered with the service provider.		x
Authorization Url	String	The service provider’s authorization endpoint URL.	`https://salesforce.instructure.com/login/oauth2/auth`
Access Token Url	String	The service provider’s access token endpoint URL.	`https://salesforce.instructure.com/login/oauth2/token`
Scopes	String	The OAuth scopes to request during the OAuth dance. If not provided, defaults to those in the annotation.	*
Resource Owner Id	String	The resource owner ID each component uses when not set otherwise.
Before	String	The name of a flow to run immediately before the OAuth dance starts.
After	String	The name of a flow to run immediately after an access token is received.
Auth Server Tls Context	TLS	TLS context for HTTP requests to the authorization server during the OAuth dance.
Auth Server Proxy Config	Any	Proxy configuration for HTTP requests during the OAuth dance.
Listener Config	String	A reference to an `http:listener-config` element used to create the listener for the access token callback.		x
Callback Path	String	Path of the access token callback endpoint.		x
Authorize Path	String	Path of the local HTTP endpoint that starts the OAuth dance.		x
External Callback Url	String	If the callback is behind a proxy or reachable only indirectly, the URL the OAuth provider should use to reach the callback.
Object Store	String	Object store for persisting each resource owner’s OAuth data. If omitted, the runtime provisions the default store.

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
recursive	Boolean	Whether to include nested sub-accounts.	false
order	Enumeration, one of: id name	Sort order for sub-accounts in the response.
include[]	String	Optional associations or nested objects to include in the response.
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Account List Accounts `` Lists Canvas accounts available to the authenticated user. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
include[]	String	Optional associations or nested objects to include in the response.
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Account List Active Courses In An Account `` Lists active courses for a Canvas account. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Assignment Groups List Assignment Groups `` Lists assignment groups for a course. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Assignment List Assignments `` Lists assignments for a course. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Assignment List Assignments By Assignment Groups `` Lists assignments within a specific assignment group for a course. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
assignment_group_id	String	Canvas assignment group ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Course Create A New Course `` Creates a new course in a Canvas account. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
correlationId	String	Optional correlation ID for the request.
body	Any	Request body for the Canvas API operation.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Course Delete Conclude A Course `` Deletes or concludes a course, depending on the selected event. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
ID	String	Canvas resource ID.		x
event	Enumeration, one of: delete conclude	Whether to delete or conclude the course.
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Course Get Bulk User Progress `` Retrieves progress data for multiple users in a course. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Course Get Single User `` Retrieves a single user’s course enrollment and related profile information. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Course Get User Progress `` Retrieves progress for one user in a course. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
user_id	String	Canvas user ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Course List Courses For Users `` Lists courses for one or more users. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
user_id	String	Canvas user ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
search_term	String	Term used to filter results.
sort	Enumeration, one of: username last_login email sis_id	Sort field for users returned from the course.
enrollment_type[]	String	Enrollment types to include when listing users.
enrollment_role	String	Enrollment role name filter.
enrollment_role_id	Number	Enrollment role ID filter.
section_ids[]	Number	Section IDs to restrict the user list.
include[]	String	Optional associations or nested objects to include in the response.
user_id	String	Canvas user ID.
user_ids[]	Number	Specific user IDs to return.
enrollment_state[]	String	Enrollment states to include when listing users.
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Course Update A Course `` Updates an existing course. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
body	Any	Request body for the Canvas API operation.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED - CANVAS:UNPROCESSABLE\_ENTITY ## Enrollment Conclude Deactivate Or Delete An Enrollment `` Concludes, deactivates, deletes, or inactivates a course enrollment based on the selected task. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
ID	String	Canvas resource ID.		x
task	Enumeration, one of: conclude deactivate delete inactivate	Enrollment action to perform on the enrollment record.
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Enrollment Enroll A User In A Section `` Enrolls a user in a course section. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
section_id	String	Canvas course section ID.		x
correlationId	String	Optional correlation ID for the request.
body	Any	Request body for the Canvas API operation.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED - CANVAS:UNPROCESSABLE\_ENTITY ## Enrollment Enroll Multiple Users To One Or More `` Enrolls multiple users in one or more courses or sections in a single request. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
correlationId	String	Optional correlation ID for the request.
body	Any	Request body for the Canvas API operation.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Enrollment Enroll User In A Course `` Enrolls a user in a course. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
correlationId	String	Optional correlation ID for the request.
body	Any	Request body for the Canvas API operation.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED - CANVAS:UNPROCESSABLE\_ENTITY ## Enrollment Get Enrollment By ID `` Retrieves a single enrollment record by ID. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Enrollment List Course Enrollments `` Lists enrollments for a course with optional filters. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
type[]	String	Enrollment types to include in the list.
role[]	String	Role filters for the enrollment list.
state[]	String	Enrollment states to include in the list.
include[]	String	Optional associations or nested objects to include in the response.
user_id	String	Canvas user ID.
grading_period_id	Number	Grading period ID filter for submissions.
enrollment_term_id	Number	Enrollment term ID filter.
sis_account_id[]	String	SIS account IDs to match.
sis_course_id[]	String	SIS course IDs to match.
sis_section_id[]	String	SIS section IDs to match.
sis_user_id[]	String	SIS user IDs to match.
created_for_sis_id[]	Boolean	Whether to limit results to users created for SIS.	false
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Enrollment List Section Enrollments `` Lists enrollments for a course section. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
section_id	String	Canvas course section ID.		x
type[]	String	Enrollment types to include in the list.
role[]	String	Role filters for the enrollment list.
state[]	String	Enrollment states to include in the list.
include[]	String	Optional associations or nested objects to include in the response.
user_id	String	Canvas user ID.
grading_period_id	Number	Grading period ID filter for submissions.
enrollment_term_id	Number	Enrollment term ID filter.
sis_account_id[]	String	SIS account IDs to match.
sis_course_id[]	String	SIS course IDs to match.
sis_section_id[]	String	SIS section IDs to match.
sis_user_id[]	String	SIS user IDs to match.
created_for_sis_id[]	Boolean	Whether to limit results to users created for SIS.	false
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED - CANVAS:UNPROCESSABLE\_ENTITY ## Enrollment List User Enrollments `` Lists course and section enrollments for a user. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
user_id	String	Canvas user ID.		x
type[]	String	Enrollment types to include in the list.
role[]	String	Role filters for the enrollment list.
state[]	String	Enrollment states to include in the list.
include[]	String	Optional associations or nested objects to include in the response.
grading_period_id	Number	Grading period ID filter for submissions.
enrollment_term_id	Number	Enrollment term ID filter.
sis_account_id[]	String	SIS account IDs to match.
sis_course_id[]	String	SIS course IDs to match.
sis_section_id[]	String	SIS section IDs to match.
sis_user_id[]	String	SIS user IDs to match.
created_for_sis_id[]	Boolean	Whether to limit results to users created for SIS.	false
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Enrollment Reactivate An Enrollment `` Reactivates a previously concluded or inactive enrollment. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Enrollment Terms Create Enrollment Term `` Creates a new enrollment term in a Canvas account. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
correlationId	String	Optional correlation ID for the request.
body	Any	Request body for the Canvas API operation.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Enrollment Terms Delete Enrollment Term `` Deletes an enrollment term. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Enrollment Terms List Enrollment Terms `` Lists enrollment terms for a Canvas account. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Enrollment Terms Retrieve Enrollment Term `` Retrieves a single enrollment term by ID. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Enrollment Terms Update Enrollment Term `` Updates an existing enrollment term. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
body	Any	Request body for the Canvas API operation.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Login Create A User Login `` Creates a login for a Canvas user. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
correlationId	String	Optional correlation ID for the request.
body	Any	Request body for the Canvas API operation.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Login Delete A User Login `` Deletes a user login. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
user_id	String	Canvas user ID.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Login Edit A User Login `` Updates an existing user login. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
body	Any	Request body for the Canvas API operation.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Roles Get A Single Role `` Retrieves a single account role by ID. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
ID	String	Canvas resource ID.		x
role_id	String	Role ID for the enrollment.
role	String	Role name for the enrollment.
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Roles List Roles `` Lists roles defined for a Canvas account. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
state[]	Array of String	Enrollment states to include in the list.
show_inherited	Boolean	Whether to include inherited enrollments.	false
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Section Create Course Section `` Creates a new section in a course. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
correlationId	String	Optional correlation ID for the request.
body	Any	Request body for the Canvas API operation.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED - CANVAS:UNPROCESSABLE\_ENTITY ## Section Cross List A Section `` Cross-lists a section into another course. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
ID	String	Canvas resource ID.		x
new_course_id	String	Target course ID for cross-listing.		x
correlationId	String	Optional correlation ID for the request.
body	Any	Request body for the Canvas API operation.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED - CANVAS:UNPROCESSABLE\_ENTITY ## Section De Cross List A Section `` Removes a cross-listed section from a target course. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
ID	String	Canvas resource ID.		x
override_sis_stickiness	Boolean	Whether to override SIS stickiness when updating the course.	false
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED - CANVAS:UNPROCESSABLE\_ENTITY ## Section Delete A Section `` Deletes a course section. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED - CANVAS:UNPROCESSABLE\_ENTITY ## Section Edit A Section `` Updates attributes of a course section. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
body	Any	Request body for the Canvas API operation.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED - CANVAS:UNPROCESSABLE\_ENTITY ## Section Get Section Information `` Retrieves details for a single course section. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
ID	String	Canvas resource ID.		x
include[]	String	Optional associations or nested objects to include in the response.
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Section List Course Sections `` Lists all sections for a course. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
include[]	String	Optional associations or nested objects to include in the response.
search_term	String	Term used to filter results.
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Submission List Submissions For Multiple Assignments `` Lists student submissions across multiple assignments in a course. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
course_id	String	Canvas course ID.		x
student_ids[]	String	Student user IDs to filter submissions.
assignment_ids[]	String	Assignment IDs to filter submissions.
grouped	Boolean	Whether to group results by student.	false
post_to_sis	Boolean	Whether to include only assignments posted to SIS.	false
submitted_since	String	ISO-8601 timestamp; returns submissions submitted on or after this time.
graded_since	String	ISO-8601 timestamp; returns submissions graded on or after this time.
grading_period_id	Number	Grading period ID filter for submissions.
workflow_state	Enumeration, one of: submitted unsubmitted graded pending_review	Filters submissions by workflow state.
enrollment_state	Enumeration, one of: active concluded	Filters submissions by enrollment state.
state_based_on_date	Boolean	Whether to scope workflow state by date.	false
order	Enumeration, one of: id graded_at	Sort order for submissions in the response.
order_direction	Enumeration, one of: ascending descending	Sort direction for the ordered submission list.
include[]	String	Optional associations or nested objects to include in the response.
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Submission List Submissions From Course Section `` Lists submissions for assignments in a course section. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
section_id	String	Canvas course section ID.		x
student_ids[]	String	Student user IDs to filter submissions.
assignment_ids[]	String	Assignment IDs to filter submissions.
grouped	Boolean	Whether to group results by student.	false
post_to_sis	Boolean	Whether to include only assignments posted to SIS.	false
submitted_since	String	ISO-8601 timestamp; returns submissions submitted on or after this time.
graded_since	String	ISO-8601 timestamp; returns submissions graded on or after this time.
grading_period_id	Number	Grading period ID filter for submissions.
workflow_state	Enumeration, one of: submitted unsubmitted graded pending_review	Filters submissions by workflow state.
enrollment_state	Enumeration, one of: active concluded	Filters submissions by enrollment state.
state_based_on_date	Boolean	Whether to scope workflow state by date.	false
order	Enumeration, one of: id graded_at	Sort order for submissions in the response.
order_direction	Enumeration, one of: ascending descending	Sort direction for the ordered submission list.
include[]	String	Optional associations or nested objects to include in the response.
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED - CANVAS:UNPROCESSABLE\_ENTITY ## User Create A User `` Creates a new user in a Canvas account. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
correlationId	String	Optional correlation ID for the request.
body	Any	Request body for the Canvas API operation.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONFLICT - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED - CANVAS:UNPROCESSABLE\_ENTITY ## User Edit A User `` Updates an existing Canvas user. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
body	Any	Request body for the Canvas API operation.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## User List Upcoming Assignments And Calendar Events `` Lists upcoming assignments and calendar events for the authenticated user. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## User List Users In Account `` Lists users in a Canvas account. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
account_id	String	Canvas account ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:BAD\_REQUEST - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## User Show User Details `` Retrieves profile and related details for a single user. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
ID	String	Canvas resource ID.		x
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Any
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - CANVAS:CLIENT\_ERROR - CANVAS:CONNECTIVITY - CANVAS:FORBIDDEN - CANVAS:INTERNAL\_SERVER\_ERROR - CANVAS:NOT\_FOUND - CANVAS:SECURITY - CANVAS:SERVER\_ERROR - CANVAS:TIMEOUT - CANVAS:UNAUTHORIZED ## Users List Missing Submissions `` Lists missing submissions for a student, optionally scoped by courses and filters. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
user_id	String	Canvas user ID.		x
observed_user_id	String	Observed user ID for the missing submissions query.
include[]	String	Optional associations or nested objects to include in the response.
filter[]	String	Filters to apply to missing submissions results.
course_ids[]	String	Course IDs to scope missing submissions.
correlationId	String	Optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable.	#[payload]
Error Mappings	Array of Error Mapping	Set of error mappings.

### Output

Type	Array of Any
Attributes Type	Any

Field	Type	Description
Enabled Protocols	String	A comma-separated list of protocols enabled for this context.
Enabled Cipher Suites	String	A comma-separated list of cipher suites enabled for this context.
Trust Store	Trust Store	Trust store configuration for validating remote certificates.
Key Store	Key Store	Key store configuration for client certificate authentication.
Revocation Check	Standard Revocation Check Custom Ocsp Responder Crl File	Certificate revocation checking configuration.

### Trust Store

Field	Type	Description
Path	String	The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.
Password	String	The password used to protect the trust store.
Type	String	The type of store used.
Algorithm	String	The algorithm used by the trust store.
Insecure	Boolean	If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

### Key Store

Field	Type	Description
Path	String	The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.
Type	String	The type of store used.
Alias	String	When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.
Key Password	String	The password used to protect the private key.
Password	String	The password used to protect the key store.
Algorithm	String	The algorithm used by the key store.

### Standard Revocation Check

Field	Type	Description
Only End Entities	Boolean	Only verify the last element of the certificate chain.
Prefer Crls	Boolean	Try CRL instead of OCSP first.
No Fallback	Boolean	Do not use the secondary checking method (the one not selected before).
Soft Fail	Boolean	Avoid verification failure when the revocation server can not be reached or is busy.

### Custom Ocsp Responder

Field	Type	Description	Default Value	Required
Url	String	The URL of the OCSP responder.
Cert Alias	String	Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

### Crl File

Field	Type	Description	Default Value	Required
Path	String	The path to the CRL file.

### Reconnection

Field	Type	Description	Default Value	Required
Fails Deployment	Boolean	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.
Reconnection Strategy	Reconnect Reconnect Forever	The reconnection strategy to use.

### Reconnect

Field	Type	Description
Frequency	Number	How often in milliseconds to reconnect.
Blocking	Boolean	If false, the reconnection strategy runs in a separate, non-blocking thread.
Count	Number	How many reconnection attempts to make.

### Reconnect Forever

Field	Type	Description	Default Value	Required
Frequency	Number	How often in milliseconds to reconnect.
Blocking	Boolean	If false, the reconnection strategy runs in a separate, non-blocking thread.

### Expiration Policy

Field	Type	Description	Default Value	Required
Max Idle Time	Number	A scalar time value for the maximum amount of time a dynamic configuration instance may remain idle before it is eligible for expiration.
Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit for the Max Idle Time field.

### Error Mapping

Field	Type	Description	Default Value	Required
Source	Enumeration, one of: ANY REDELIVERY_EXHAUSTED TRANSFORMATION EXPRESSION SECURITY CLIENT_SECURITY SERVER_SECURITY ROUTING CONNECTIVITY RETRY_EXHAUSTED TIMEOUT	Source Mule error type to map.
Target	String	Target error type identifier.		x