# mulesoft Moodle Connector - Full Documentation --- product: Moodle Connector version: 0.1 is-latest-version: true --- # Moodle Connector 0.1.0 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Moodle (Moodle Connector) enables Mule applications to access the Moodle API. > [!NOTE] Moodle Connector is a beta connector that is subject to the Beta Services Terms at > [Agreements - Salesforce.com](https://www.salesforce.com/company/legal/) or a written Unified > Pilot Agreement if executed by Customer, and the Non-GA Gen AI and Non-GA Credit Consumption terms > in the > [Product Terms Directory](https://ptd.salesforce.com/?_ga=2.247987783.1372150065.1709219475-629000709.1639001992). > Use of this beta connector with external systems or services consumes > [Mule messages](https://docs.mulesoft.com/general/usage-metrics) and is at the Customer’s sole discretion. For information about compatibility and fixed issues, refer to the Moodle Connector Release Notes. ## Before You Begin To use this connector, you must be familiar with: - The Moodle 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 Moodle 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) - [Moodle Connector Reference](https://docs.mulesoft.com/moodle-connector/latest/moodle-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: Moodle Connector version: 0.1 is-latest-version: true --- # Moodle Connector 0.1.0 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Moodle (Moodle Connector) enables Mule applications to access the Moodle 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	Moodle	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 ##### Moodle ###### Parameters

Name	Type	Description	Required
wstoken	String	Web service token for Moodle API authentication.	x
baseUri	String	The base URI for the Moodle instance.	x
TLS Configuration	TLS	Configures TLS. If using the HTTPS protocol, you must configure TLS.
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.

## Supported Operations - [Assignments Get All The Course Assignments](#AssignmentsGetAllTheCourseAssignments) - [Assignments Get Assignment Grades](#AssignmentsGetAssignmentGrades) - [Assignments Get Assignment Submissions](#AssignmentsGetAssignmentSubmissions) - [Calendar Create Calendar Events](#CalendarCreateCalendarEvents) - [Calendar Delete Calendar Events](#CalendarDeleteCalendarEvents) - [Calendar Get Calendar Event By Id](#CalendarGetCalendarEventbyId) - [Calendar Get Calendar Events](#CalendarGetCalendarEvents) - [Calendar Get Calendar Events For Students](#CalendarGetCalendarEventsForStudents) - [Cohort Add Cohort Members](#CohortAddCohortMembers) - [Cohort Create Cohort](#CohortCreateCohorts) - [Cohort Delete Cohort](#CohortDeleteCohort) - [Cohort Delete Cohort Member](#CohortDeleteCohortMember) - [Cohort Get Cohort Members](#CohortGetCohortMembers) - [Cohort Get Cohorts](#CohortGetCohorts) - [Cohort Update Cohorts](#CohortUpdateCohorts) - [Course Category Create Categories](#CourseCategoryCreateCategories) - [Course Category Delete Categories](#CourseCategoryDeleteCategories) - [Course Category Get Categories](#CourseCategoryGetCategories) - [Course Category Update Categories](#CourseCategoryUpdateCategories) - [Course Create Courses](#CourseCreateCourses) - [Course Delete Courses](#CourseDeleteCourses) - [Course Get Courses](#CourseGetCourses) - [Course Get Courses By Field](#CourseGetCoursesByField) - [Course Update Courses](#CourseUpdateCourses) - [Enrollment Enroll Users](#EnrollmentEnrollUsers) - [Enrollment Get Enrolled Users](#EnrollmentGetEnrolledUsers) - [Enrollment Get Users Courses](#EnrollmentGetUsersCourses) - [Enrollment Unenrol User](#EnrollmentUnenrolUser) - [Enrollment Unenroll Users](#EnrollmentUnenrollUsers) - [Grade Report Get Course Grades](#GradeReportGetCourseGrades) - [Grade Report Get Grade Items](#GradeReportGetGradeItems) - [Groups Assign Groupings](#GroupsAssignGroupings) - [Groups Create Group](#GroupsCreateGroup) - [Groups Create Groupings](#GroupsCreateGroupings) - [Groups Delete Group](#GroupsDeleteGroup) - [Groups Delete Groupings](#GroupsDeleteGroupings) - [Groups Get Course Groups](#GroupsGetCourseGroups) - [Groups Get Group](#GroupsGetGroup) - [Groups Get Group Members](#GroupsGetGroupMembers) - [Groups Get Groupings](#GroupsGetGroupings) - [Groups Unassign Groupings](#GroupsUnassignGroupings) - [Groups Update Groupings](#GroupsUpdateGroupings) - [Token Access Token](#TokenAccessToken) - [User Create Users](#UserCreateUsers) - [User Delete Users](#UserDeleteUsers) - [User Get Users](#UserGetUsers) - [User Get Users By Id](#UserGetUsersById) - [User Update Users](#UserUpdateUsers) ## Operations ## Assignments Get All The Course Assignments `` Returns the assignments for a course, including activity details the caller is permitted to view (Moodle assignment activity). ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Assignments Get Assignment Grades `` Returns grader and submission grades for an assignment, consistent with the Moodle gradebook and assignment activity. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Assignments Get Assignment Submissions `` Returns learner submissions for an assignment (files, text, status, and timestamps), as provided by the Moodle assignment subsystem. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Calendar Create Calendar Events `` Creates calendar events in the Moodle calendar for the allowed contexts (such as course, user, or category), as described in Moodle’s calendar documentation. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Calendar Delete Calendar Events `` Deletes one or more calendar events by ID from the Moodle calendar. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Calendar Get Calendar Event By Id `` Returns a single calendar event by its Moodle event ID. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Calendar Get Calendar Events `` Returns calendar events matching the request filters (for example, course, time window, or event type). ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Calendar Get Calendar Events For Students `` Returns calendar events for the specified student view (events visible to learners in the given courses or groups). ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Cohort Add Cohort Members `` Adds users to a site or category cohort (Moodle site-wide groups used for bulk enrollment). ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Cohort Create Cohort `` Creates one or more cohorts (named batches of users for enrollment and administration). ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Cohort Delete Cohort `` Deletes a cohort by ID when Moodle allows removal (for example, no blocking enrollment rules). ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Cohort Delete Cohort Member `` Removes selected users from a cohort. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Cohort Get Cohort Members `` Returns the list of users who belong to a cohort. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Cohort Get Cohorts `` Returns cohorts that match the supplied search and context filters. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Cohort Update Cohorts `` Updates cohort metadata (such as name, ID number, visibility, or associated category). ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 or Null
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Course Category Create Categories `` Creates course categories under a parent in the Moodle course category tree. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Course Category Delete Categories `` Deletes course categories when Moodle permits (subcategories and linked courses must be handled per Moodle rules). ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Course Category Get Categories `` Returns course categories and hierarchy for the requested filters (for example, parent, depth, or visibility). ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Course Category Update Categories `` Updates course category fields (name, parent, sort order, description, and visibility). ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Course Create Courses `` Creates new courses with the supplied settings (format, category, visibility, and other course fields). ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Course Delete Courses `` Deletes courses by ID, subject to Moodle capabilities and whether the course may be removed. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Course Get Courses `` Returns full course records for the requested course IDs (summary, format, settings, and custom fields exposed by the web service). ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Course Get Courses By Field `` Looks up courses by a single field value (for example, shortname, idnumber, or category), as supported by Moodle’s core course API. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Course Update Courses `` Updates one or more existing courses (metadata, format options, and other fields allowed by the web service). ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Enrollment Enroll Users `` Enrolls users in courses with the specified roles (manual enrollment and compatible enrollment plugins). ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Enrollment Get Enrolled Users `` Lists users enrolled in a course, including their assigned roles and group membership. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Enrollment Get Users Courses `` Returns the courses a user is enrolled in (role and status depend on the web service response). ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Enrollment Unenrol User `` Unenrolls a user from a course for a specific enrollment instance (manual or plugin instance ID in the request). ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Enrollment Unenroll Users `` Unenrolls multiple users from courses in a single call, following Moodle enrollment rules for each instance. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Grade Report Get Course Grades `` Returns course-level totals and user grades from the gradebook for the requested course and users. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Grade Report Get Grade Items `` Returns grade items (activities and categories) for a course gradebook, including weights and settings exposed by the API. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Groups Assign Groupings `` Links groups to a grouping so activities can be restricted to that grouping in a course. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Groups Create Groupings `` Creates groupings (containers used to restrict activities to sets of groups) in a course. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Groups Delete Group `` Deletes a group from a course when no Moodle rules block removal. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Groups Get Course Groups `` Returns all groups defined for a course. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Groups Get Group `` Returns details for a single course group by ID. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Groups Get Group Members `` Returns the members of a course group. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Groups Get Groupings `` Returns groupings for a course, including which groups belong to each grouping when included in the response. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Groups Unassign Groupings `` Removes groups from a grouping without deleting the groups themselves. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Groups Update Groupings `` Updates grouping name, ID number, or other fields supported by the Moodle groups API. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Token Access Token `` Returns a web service token for the given user, service, and credentials by calling the Moodle `login/token.php` endpoint relative to the site base URL (see Moodle web services documentation). ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
username	String	Moodle username.		x
password	String	Password for the account.		x
service	String	Moodle web service short name.		x
correlationId	String	An optional correlation ID for the request.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## User Create Users `` Creates new user accounts with the supplied profile fields (subject to Moodle authentication and user-creation policies). ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## User Delete Users `` Deletes users by ID when the web service user is allowed to remove those accounts. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## User Get Users `` Searches for users by criteria (for example, email, username, or custom profile fields) and returns matching user records. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## User Get Users By Id `` Returns full user records for the specified Moodle user IDs. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## User Update Users `` Updates profile and preference fields on existing user accounts allowed by the web service. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
correlationId	String	An optional correlation ID for the request.
body	Any	The request body content.	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	The 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 - MOODLE:BAD\_REQUEST - MOODLE:CLIENT\_ERROR - MOODLE:CONNECTIVITY - MOODLE:FORBIDDEN - MOODLE:INTERNAL\_SERVER\_ERROR - MOODLE:NOT\_FOUND - MOODLE:SECURITY - MOODLE:SERVER\_ERROR - MOODLE:TIMEOUT - MOODLE:UNAUTHORIZED ## Types ### TLS Configures TLS to provide secure communications for the Mule app.

Field	Type	Description
Enabled Protocols	String	Comma-separated list of protocols enabled for this context.
Enabled Cipher Suites	String	Comma-separated list of cipher suites enabled for this context.
Trust Store	Truststore	Configures the TLS truststore.
Key Store	Keystore	Configures the TLS keystore.
Revocation Check	Standard Revocation Check Custom OCSP Responder CRL File	Configures a revocation checking mechanism.

### Truststore Configures the truststore for TLS.

Field	Type	Description
Path	String	Path to the truststore. Mule resolves the path relative to the current classpath and file system.
Password	String	Password used to protect the truststore.
Type	String	Type of store.
Algorithm	String	Encryption algorithm that the truststore uses.
Insecure	Boolean	If `true`, Mule stops performing certificate validations. Setting this to `true` can make connections vulnerable to attacks.

### Keystore Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.

Field	Type	Description
Path	String	Path to the keystore. Mule resolves the path relative to the current classpath and file system.
Type	String	Type of store.
Alias	String	Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.
Key Password	String	Password used to protect the private key.
Password	String	Password used to protect the keystore.
Algorithm	String	Encryption algorithm that the keystore uses.

### Standard Revocation Check Configures standard revocation checks for TLS certificates.

Field	Type	Description
Only End Entities	Boolean	Which elements to verify in the certificate chain: `true` Verify only the last element in the certificate chain. `false` Verify all elements in the certificate chain.
Prefer Crls	Boolean	How to check certificate validity: `true` Check the Certification Revocation List (CRL) for certificate validity. `false` Use the Online Certificate Status Protocol (OCSP) to check certificate validity.
No Fallback	Boolean	Whether to use the secondary method to check certificate validity: `true` Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity. `false` Do not use the secondary method to check certificate validity.
Soft Fail	Boolean	What to do if the revocation server can’t be reached or is busy: `true` Avoid verification failure. `false` Allow the verification to fail.

### Custom OCSP Responder Configures a custom OCSP responder for certification revocation checks.

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. If specified, the alias must be in the trust store.

### CRL File Specifies the location of the certification revocation list (CRL) file.

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

### Reconnection Configures a reconnection strategy for an operation.

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 Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.

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

### Reconnect Forever Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

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

### Expiration Policy Configures an expiration policy strategy.

Field	Type	Description	Default Value	Required
Max Idle Time	Number	Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it 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	Error source type.
Target	String	Target error type.		x